DX-1204: add v1 callback runtime tests

Author: umair-ably

test/realtime/auth.test.js

@@ -1643,5 +1643,41 @@ define(['ably', 'shared_helper', 'async', 'chai'], function (Ably, Helper, async
         });
       };
     });
+
+    /**
+     * v1-style trailing-callback shape on Auth.{authorize, requestToken,
+     * createTokenRequest} throws synchronously with a steering ErrorInfo.
+     */
+    [
+      { method: 'authorize', invoke: (auth) => auth.authorize(null, null, () => {}) },
+      { method: 'requestToken', invoke: (auth) => auth.requestToken(null, null, () => {}) },
+      { method: 'createTokenRequest', invoke: (auth) => auth.createTokenRequest(null, null, () => {}) },
+    ].forEach(function (testCase) {
+      it('v1_callback_auth_' + testCase.method + '_throws_synchronously', function (done) {
+        var helper = this.test.helper,
+          realtime = helper.AblyRealtime();
+
+        try {
+          testCase.invoke(realtime.auth);
+          helper.closeAndFinish(
+            done,
+            realtime,
+            new Error('expected auth.' + testCase.method + '() to throw on v1 callback shape'),
+          );
+        } catch (err) {
+          try {
+            expect(err.code).to.equal(40000);
+            expect(err.message).to.contain('v1 callback signature');
+            expect(err.message).to.contain('no longer supported');
+            expect(err.hint).to.be.a('string');
+            expect(err.hint).to.contain('Remove the trailing callback');
+            expect(err.hint).to.contain('https://github.com/ably/ably-js/blob/main/docs/migration-guides/v2/lib.md');
+            helper.closeAndFinish(done, realtime);
+          } catch (assertionErr) {
+            helper.closeAndFinish(done, realtime, assertionErr);
+          }
+        }
+      });
+    });
   });
 });

test/realtime/channel.test.js

@@ -1449,6 +1449,62 @@ define(['ably', 'shared_helper', 'async', 'chai'], function (Ably, Helper, async
       });
     });
 
+    /**
+     * v1-style trailing-callback shape on RealtimeChannel.{publish, subscribe,
+     * unsubscribe, history} throws synchronously with a steering ErrorInfo whose
+     * message diagnoses *what* went wrong and whose hint prescribes the v2
+     * replacement call.
+     */
+    [
+      { method: 'publish', invoke: (ch) => ch.publish('event', { hello: 'world' }, () => {}) },
+      {
+        method: 'subscribe',
+        invoke: (ch) =>
+          ch.subscribe(
+            'event',
+            () => {},
+            () => {},
+          ),
+      },
+      {
+        method: 'unsubscribe',
+        invoke: (ch) =>
+          ch.unsubscribe(
+            'event',
+            () => {},
+            () => {},
+          ),
+      },
+      { method: 'history', invoke: (ch) => ch.history(null, () => {}) },
+    ].forEach(function (testCase) {
+      it('v1_callback_' + testCase.method + '_throws_synchronously', function (done) {
+        var helper = this.test.helper,
+          realtime = helper.AblyRealtime(),
+          channel = realtime.channels.get('v1cb_channel_' + testCase.method);
+
+        try {
+          testCase.invoke(channel);
+          helper.closeAndFinish(
+            done,
+            realtime,
+            new Error('expected ' + testCase.method + '() to throw on v1 callback shape'),
+          );
+        } catch (err) {
+          try {
+            expect(err.code).to.equal(40000);
+            expect(err.message).to.contain('v1 callback signature');
+            expect(err.message).to.contain('no longer supported');
+            expect(err.hint).to.be.a('string');
+            expect(err.hint).to.contain('Remove the trailing callback');
+            expect(err.hint).to.contain('https://github.com/ably/ably-js/blob/main/docs/migration-guides/v2/lib.md');
+            helper.closeAndFinish(done, realtime);
+          } catch (assertionErr) {
+            helper.closeAndFinish(done, realtime, assertionErr);
+          }
+        }
+      });
+    });
+
     /**
      * A channel attach that times out should be retried
      *

test/realtime/connection.test.js

@@ -473,5 +473,32 @@ define(['ably', 'shared_helper', 'async', 'chai'], function (Ably, Helper, async
 
       await helper.closeAndFinishAsync(realtime);
     });
+
+    /**
+     * v1-style trailing-callback shape on Connection.ping throws synchronously
+     * with a steering ErrorInfo.
+     */
+    it('v1_callback_ping_throws_synchronously', function (done) {
+      const helper = this.test.helper;
+      const realtime = helper.AblyRealtime();
+      try {
+        realtime.connection.ping(function noopCallback(err) {
+          void err;
+        });
+        helper.closeAndFinish(done, realtime, new Error('expected ping() to throw on v1 callback shape'));
+      } catch (err) {
+        try {
+          expect(err.code).to.equal(40000);
+          expect(err.message).to.contain('v1 callback signature');
+          expect(err.message).to.contain('no longer supported');
+          expect(err.hint).to.be.a('string');
+          expect(err.hint).to.contain('Remove the trailing callback');
+          expect(err.hint).to.contain('https://github.com/ably/ably-js/blob/main/docs/migration-guides/v2/lib.md');
+          helper.closeAndFinish(done, realtime);
+        } catch (assertionErr) {
+          helper.closeAndFinish(done, realtime, assertionErr);
+        }
+      }
+    });
   });
 });

test/realtime/presence.test.js

@@ -2309,5 +2309,53 @@ define(['ably', 'shared_helper', 'async', 'chai'], function (Ably, Helper, async
         );
       });
     });
+
+    /**
+     * v1-style trailing-callback shape on RealtimePresence.{enter, update, leave,
+     * get, history, subscribe} throws synchronously with a steering ErrorInfo.
+     */
+    [
+      { method: 'enter', invoke: (presence) => presence.enter({ data: 'x' }, () => {}) },
+      { method: 'update', invoke: (presence) => presence.update({ data: 'x' }, () => {}) },
+      { method: 'leave', invoke: (presence) => presence.leave({ data: 'x' }, () => {}) },
+      { method: 'get', invoke: (presence) => presence.get(null, () => {}) },
+      { method: 'history', invoke: (presence) => presence.history(null, () => {}) },
+      {
+        method: 'subscribe',
+        invoke: (presence) =>
+          presence.subscribe(
+            'enter',
+            () => {},
+            () => {},
+          ),
+      },
+    ].forEach(function (testCase) {
+      it('v1_callback_presence_' + testCase.method + '_throws_synchronously', function (done) {
+        var helper = this.test.helper,
+          realtime = helper.AblyRealtime({ clientId: testClientId }),
+          channel = realtime.channels.get('v1cb_presence_' + testCase.method);
+
+        try {
+          testCase.invoke(channel.presence);
+          helper.closeAndFinish(
+            done,
+            realtime,
+            new Error('expected presence.' + testCase.method + '() to throw on v1 callback shape'),
+          );
+        } catch (err) {
+          try {
+            expect(err.code).to.equal(40000);
+            expect(err.message).to.contain('v1 callback signature');
+            expect(err.message).to.contain('no longer supported');
+            expect(err.hint).to.be.a('string');
+            expect(err.hint).to.contain('Remove the trailing callback');
+            expect(err.hint).to.contain('https://github.com/ably/ably-js/blob/main/docs/migration-guides/v2/lib.md');
+            helper.closeAndFinish(done, realtime);
+          } catch (assertionErr) {
+            helper.closeAndFinish(done, realtime, assertionErr);
+          }
+        }
+      });
+    });
   });
 });