Add proxy integration tests and missing UTS test coverage

package.json

@@ -161,6 +161,7 @@
     "test:react": "vitest run",
     "test:package": "grunt test:package",
     "test:uts": "npm run build:node && mocha --no-config --require tsx/cjs 'test/uts/**/*.test.ts'",
+    "test:uts:unit": "npm run build:node && mocha --no-config --require tsx/cjs --ignore 'test/uts/**/proxy/**' --ignore 'test/uts/**/integration/**' 'test/uts/**/*.test.ts'",
     "concat": "grunt concat",
     "build": "grunt build:all && npm run build:react",
     "build:node": "grunt build:node",

test/uts/helpers.ts

@@ -14,6 +14,7 @@ import { DefaultRest } from '../../src/common/lib/client/defaultrest';
 import { DefaultRealtime } from '../../src/common/lib/client/defaultrealtime';
 import ErrorInfo from '../../src/common/lib/types/errorinfo';
 import { makeFromDeserializedWithDependencies as makeProtocolMessageFromDeserialized } from '../../src/common/lib/types/protocolmessage';
+import { populateFieldsFromParent } from '../../src/common/lib/types/basemessage';
 
 const Ably = {
   Rest: DefaultRest,
@@ -280,4 +281,5 @@ export {
   trackClient,
   restoreAll,
   flushAsync,
+  populateFieldsFromParent,
 };

test/uts/helpers/protocol_variants.ts

@@ -0,0 +1,32 @@
+/**
+ * Protocol variant helpers for G1 compliance.
+ *
+ * Data-path integration tests should use describeEachProtocol() to run
+ * once per supported protocol (JSON and MessagePack).
+ */
+
+export type Protocol = 'json' | 'msgpack';
+
+const PROTOCOLS: Protocol[] = ['json', 'msgpack'];
+
+/**
+ * Wraps a describe block to run once per protocol variant.
+ * Produces test output like:
+ *   suite name [json]
+ *     ✓ test
+ *   suite name [msgpack]
+ *     ✓ test
+ *
+ * The callback receives mocha's Suite `this` context via `.call()`,
+ * so `this.timeout()` works inside the callback when using `function()` syntax.
+ */
+export function describeEachProtocol(
+  name: string,
+  fn: (this: Mocha.Suite, protocol: Protocol) => void,
+): void {
+  for (const protocol of PROTOCOLS) {
+    describe(`${name} [${protocol}]`, function (this: Mocha.Suite) {
+      fn.call(this, protocol);
+    });
+  }
+}

test/uts/mock_http.ts

@@ -127,7 +127,7 @@ class PendingRequest {
   /** Request times out after connection established */
   respond_with_timeout(): void {
     this._resolve!({
-      error: { code: 408, statusCode: 408, message: 'Request timed out' } as any,
+      error: { code: 'ETIMEDOUT', statusCode: 408, message: 'Request timed out' } as any,
       body: null,
       headers: {},
       unpacked: false,
@@ -320,6 +320,10 @@ class MockHttpClient {
         ) {
           return true;
         }
+        // RSC15l2: request timeout (HTTP 408)
+        if (statusCode === 408) {
+          return true;
+        }
         return statusCode >= 500 && statusCode <= 504;
       }
     }

test/uts/realtime/integration/auth/auth.test.ts

@@ -34,6 +34,7 @@ describe('uts/realtime/integration/auth/auth', function () {
   /**
    * RSA8 - Token auth on realtime connection
    */
+  // UTS: realtime/integration/RSA8/token-auth-connect-0
   it('RSA8 - JWT token auth connects successfully', async function () {
     const { keyName, keySecret } = getKeyParts(getApiKey());
 
@@ -59,6 +60,7 @@ describe('uts/realtime/integration/auth/auth', function () {
   /**
    * RTC8a - In-band reauthorization on CONNECTED client
    */
+  // UTS: realtime/integration/RTC8a/in-band-reauth-connected-0
   it('RTC8a - authorize on connected client does not disconnect', async function () {
     const { keyName, keySecret } = getKeyParts(getApiKey());
 
@@ -93,6 +95,7 @@ describe('uts/realtime/integration/auth/auth', function () {
   /**
    * RTC8c - authorize() from INITIALIZED initiates connection
    */
+  // UTS: realtime/integration/RTC8c/authorize-initiates-connection-0
   it('RTC8c - authorize from initialized state initiates connection', async function () {
     const { keyName, keySecret } = getKeyParts(getApiKey());
 
@@ -120,6 +123,7 @@ describe('uts/realtime/integration/auth/auth', function () {
   /**
    * RSA7 - Matching clientId succeeds
    */
+  // UTS: realtime/integration/RSA7/matching-clientid-succeeds-0
   it('RSA7 - matching clientId in JWT and options succeeds', async function () {
     const { keyName, keySecret } = getKeyParts(getApiKey());
     const testClientId = `test-client-${Math.random().toString(36).substring(2, 8)}`;
@@ -142,4 +146,43 @@ describe('uts/realtime/integration/auth/auth', function () {
 
     await closeAndWait(client);
   });
+
+  /**
+   * RSA7 - Mismatched clientId in JWT and options fails
+   *
+   * When the clientId in the JWT token differs from the clientId in
+   * ClientOptions, the server rejects the connection.
+   */
+  // UTS: realtime/integration/RSA7/mismatched-clientid-fails-1
+  it('RSA7 - mismatched clientId fails', async function () {
+    const { keyName, keySecret } = getKeyParts(getApiKey());
+
+    const client = new Ably.Realtime({
+      authCallback: (_params: any, cb: any) => {
+        cb(null, generateJWT({ keyName, keySecret, clientId: 'token-client-id', ttl: 3600000 }));
+      },
+      clientId: 'wrong-client-id',
+      endpoint: SANDBOX_ENDPOINT,
+      autoConnect: false,
+      useBinaryProtocol: false,
+    });
+    trackClient(client);
+
+    try {
+      await connectAndWait(client);
+      expect.fail('Expected connection to fail');
+    } catch (error: any) {
+      expect(error.message).to.include('failed');
+    }
+
+    expect(client.connection.state).to.equal('failed');
+    expect(client.connection.errorReason).to.not.be.null;
+    expect(client.connection.errorReason.code).to.equal(40102);
+
+    try {
+      await closeAndWait(client);
+    } catch (e) {
+      /* ok — already failed */
+    }
+  });
 });

test/uts/realtime/integration/auth/token_renewal.test.ts

@@ -21,7 +21,7 @@ import {
 } from '../sandbox';
 
 describe('uts/realtime/integration/auth/token_renewal', function () {
-  this.timeout(60000);
+  this.timeout(120000);
 
   before(async function () {
     await setupSandbox();
@@ -34,6 +34,7 @@ describe('uts/realtime/integration/auth/token_renewal', function () {
   /**
    * RSA4b, RTN14b - Token renewal on expiry
    */
+  // UTS: realtime/integration/RSA4b/token-renewal-on-expiry-0
   it('RSA4b/RTN14b - token renewal on expiry', async function () {
     const { keyName, keySecret } = getKeyParts(getApiKey());
     let callbackCount = 0;

test/uts/realtime/integration/auth/token_request.test.ts

@@ -31,6 +31,7 @@ describe('uts/realtime/integration/auth/token_request', function () {
   /**
    * RSA9a, RSA9g - createTokenRequest produces server-accepted token
    */
+  // UTS: realtime/integration/RSA9a/token-request-server-accepted-0
   it('RSA9a/RSA9g - createTokenRequest produces server-accepted token', async function () {
     const creator = new Ably.Rest({
       key: getApiKey(),
@@ -64,6 +65,7 @@ describe('uts/realtime/integration/auth/token_request', function () {
   /**
    * RSA9 - createTokenRequest with clientId
    */
+  // UTS: realtime/integration/RSA9/token-request-with-clientid-0
   it('RSA9 - createTokenRequest with clientId', async function () {
     const testClientId = `token-request-client-${Math.random().toString(36).substring(2, 10)}`;
 

test/uts/realtime/integration/channels/channel_attach.test.ts

@@ -32,6 +32,7 @@ describe('uts/realtime/integration/channels/channel_attach', function () {
   /**
    * RTL4c - Attach succeeds
    */
+  // UTS: realtime/integration/RTL4c/attach-succeeds-0
   it('RTL4c - attach succeeds', async function () {
     const channelName = uniqueChannelName('attach-RTL4c');
 
@@ -59,6 +60,7 @@ describe('uts/realtime/integration/channels/channel_attach', function () {
   /**
    * RTL5d - Detach succeeds
    */
+  // UTS: realtime/integration/RTL5d/detach-succeeds-0
   it('RTL5d - detach succeeds', async function () {
     const channelName = uniqueChannelName('detach-RTL5d');
 
@@ -86,6 +88,7 @@ describe('uts/realtime/integration/channels/channel_attach', function () {
   /**
    * RTL14 - Insufficient capability causes publish failure
    */
+  // UTS: realtime/integration/RTL14/insufficient-capability-failed-0
   it('RTL14 - publish with subscribe-only key fails with 40160', async function () {
     const channelName = uniqueChannelName('publish-not-allowed');
 

test/uts/realtime/integration/channels/channel_history.test.ts

@@ -18,8 +18,9 @@ import {
   uniqueChannelName,
   pollUntil,
 } from '../sandbox';
+import { describeEachProtocol } from '../../../helpers/protocol_variants';
 
-describe('uts/realtime/integration/channels/channel_history', function () {
+describeEachProtocol('uts/realtime/integration/channels/channel_history', function (protocol) {
   this.timeout(30000);
 
   before(async function () {
@@ -33,22 +34,23 @@ describe('uts/realtime/integration/channels/channel_history', function () {
   /**
    * RTL10d - History contains messages published by another client
    */
+  // UTS: realtime/integration/RTL10d/history-cross-client-0
   it('RTL10d - history contains messages from another client', async function () {
     const channelName = uniqueChannelName('history-RTL10d');
 
     const publisher = new Ably.Realtime({
       key: getApiKey(),
       endpoint: SANDBOX_ENDPOINT,
       autoConnect: false,
-      useBinaryProtocol: false,
+      useBinaryProtocol: protocol === 'msgpack',
     });
     trackClient(publisher);
 
     const subscriber = new Ably.Realtime({
       key: getApiKey(),
       endpoint: SANDBOX_ENDPOINT,
       autoConnect: false,
-      useBinaryProtocol: false,
+      useBinaryProtocol: protocol === 'msgpack',
     });
     trackClient(subscriber);
 

test/uts/realtime/integration/channels/channel_publish.test.ts

@@ -18,8 +18,9 @@ import {
   uniqueChannelName,
   pollUntil,
 } from '../sandbox';
+import { describeEachProtocol } from '../../../helpers/protocol_variants';
 
-describe('uts/realtime/integration/channels/channel_publish', function () {
+describeEachProtocol('uts/realtime/integration/channels/channel_publish', function (protocol) {
   this.timeout(30000);
 
   before(async function () {
@@ -33,22 +34,23 @@ describe('uts/realtime/integration/channels/channel_publish', function () {
   /**
    * RTL6, RSL4d2 - String data round-trip
    */
+  // UTS: realtime/integration/RTL6/string-data-roundtrip-0
   it('RTL6/RSL4d2 - string data round-trip', async function () {
     const channelName = uniqueChannelName('publish-string');
 
     const publisher = new Ably.Realtime({
       key: getApiKey(),
       endpoint: SANDBOX_ENDPOINT,
       autoConnect: false,
-      useBinaryProtocol: false,
+      useBinaryProtocol: protocol === 'msgpack',
     });
     trackClient(publisher);
 
     const subscriber = new Ably.Realtime({
       key: getApiKey(),
       endpoint: SANDBOX_ENDPOINT,
       autoConnect: false,
-      useBinaryProtocol: false,
+      useBinaryProtocol: protocol === 'msgpack',
     });
     trackClient(subscriber);
 
@@ -81,22 +83,23 @@ describe('uts/realtime/integration/channels/channel_publish', function () {
   /**
    * RTL6, RSL4d3 - JSON object data round-trip
    */
+  // UTS: realtime/integration/RTL6/json-data-roundtrip-1
   it('RTL6/RSL4d3 - JSON object data round-trip', async function () {
     const channelName = uniqueChannelName('publish-json');
 
     const publisher = new Ably.Realtime({
       key: getApiKey(),
       endpoint: SANDBOX_ENDPOINT,
       autoConnect: false,
-      useBinaryProtocol: false,
+      useBinaryProtocol: protocol === 'msgpack',
     });
     trackClient(publisher);
 
     const subscriber = new Ably.Realtime({
       key: getApiKey(),
       endpoint: SANDBOX_ENDPOINT,
       autoConnect: false,
-      useBinaryProtocol: false,
+      useBinaryProtocol: protocol === 'msgpack',
     });
     trackClient(subscriber);
 
@@ -132,22 +135,23 @@ describe('uts/realtime/integration/channels/channel_publish', function () {
   /**
    * RTL6, RSL4d1 - Binary data round-trip
    */
+  // UTS: realtime/integration/RTL6/binary-data-roundtrip-2
   it('RTL6/RSL4d1 - binary data round-trip', async function () {
     const channelName = uniqueChannelName('publish-binary');
 
     const publisher = new Ably.Realtime({
       key: getApiKey(),
       endpoint: SANDBOX_ENDPOINT,
       autoConnect: false,
-      useBinaryProtocol: false,
+      useBinaryProtocol: protocol === 'msgpack',
     });
     trackClient(publisher);
 
     const subscriber = new Ably.Realtime({
       key: getApiKey(),
       endpoint: SANDBOX_ENDPOINT,
       autoConnect: false,
-      useBinaryProtocol: false,
+      useBinaryProtocol: protocol === 'msgpack',
     });
     trackClient(subscriber);
 
@@ -182,22 +186,23 @@ describe('uts/realtime/integration/channels/channel_publish', function () {
   /**
    * RTL6f - connectionId matches publisher
    */
+  // UTS: realtime/integration/RTL6f/connectionid-matches-publisher-0
   it('RTL6f - connectionId matches publisher', async function () {
     const channelName = uniqueChannelName('publish-connid');
 
     const publisher = new Ably.Realtime({
       key: getApiKey(),
       endpoint: SANDBOX_ENDPOINT,
       autoConnect: false,
-      useBinaryProtocol: false,
+      useBinaryProtocol: protocol === 'msgpack',
     });
     trackClient(publisher);
 
     const subscriber = new Ably.Realtime({
       key: getApiKey(),
       endpoint: SANDBOX_ENDPOINT,
       autoConnect: false,
-      useBinaryProtocol: false,
+      useBinaryProtocol: protocol === 'msgpack',
     });
     trackClient(subscriber);
 
@@ -230,22 +235,23 @@ describe('uts/realtime/integration/channels/channel_publish', function () {
   /**
    * RSL6a2 - Message extras round-trip
    */
+  // UTS: realtime/integration/RSL6a2/message-extras-roundtrip-0
   it('RSL6a2 - message extras round-trip', async function () {
     const channelName = uniqueChannelName('pushenabled:publish-extras');
 
     const publisher = new Ably.Realtime({
       key: getApiKey(),
       endpoint: SANDBOX_ENDPOINT,
       autoConnect: false,
-      useBinaryProtocol: false,
+      useBinaryProtocol: protocol === 'msgpack',
     });
     trackClient(publisher);
 
     const subscriber = new Ably.Realtime({
       key: getApiKey(),
       endpoint: SANDBOX_ENDPOINT,
       autoConnect: false,
-      useBinaryProtocol: false,
+      useBinaryProtocol: protocol === 'msgpack',
     });
     trackClient(subscriber);