@webex/internal-plugin-mercury 2.60.0 → 2.60.1-next.10

package/test/integration/spec/webex.js

@@ -32,12 +32,13 @@ describe('plugin-mercury', function () {
   );
 
   describe('onBeforeLogout()', () => {
-    it('disconnects the web socket', () =>
+    it('disconnects the web socket', () => {
       webex.logout({noRedirect: true}).then(() => {
         assert.called(webex.internal.mercury.disconnect);
         assert.isFalse(webex.internal.mercury.connected);
         assert.called(webex.internal.device.unregister);
         assert.isFalse(webex.internal.device.registered);
-      }));
+      });
+    });
   });
 });

package/test/unit/spec/mercury.js

@@ -452,11 +452,13 @@ describe('plugin-mercury', () => {
     });
 
     describe.skip('#disconnect()', () => {
-      it('disconnects the WebSocket', () => mercury.connect()
-        .then(() => {
-          assert.isTrue(mercury.connected, 'Mercury is connected');
-          assert.isFalse(mercury.connecting, 'Mercury is not connecting');
-          const promise = mercury.disconnect();
+      it('disconnects the WebSocket', () =>
+        mercury
+          .connect()
+          .then(() => {
+            assert.isTrue(mercury.connected, 'Mercury is connected');
+            assert.isFalse(mercury.connecting, 'Mercury is not connecting');
+            const promise = mercury.disconnect();
 
             mockWebSocket.emit('close', {
               code: 1000,
@@ -558,7 +560,7 @@ describe('plugin-mercury', () => {
           return promiseTick(webex.internal.mercury.config.backoffTimeReset).then(() => {
             assert.equal(
               reason.message,
-              'mercury: prevent socket open when backoffCall no longer defined'
+              'Mercury: prevent socket open when backoffCall no longer defined'
             );
           });
         });
@@ -566,12 +568,21 @@ describe('plugin-mercury', () => {
     });
 
     describe('#_emit()', () => {
-      it('emits Error-safe events', () => {
+      it('emits Error-safe events and log the error with the call parameters', () => {
+        const error = 'error';
+        const event = {data: 'some data'};
         mercury.on('break', () => {
-          throw new Error();
+          throw error;
         });
+        sinon.stub(mercury.logger, 'error');
 
-        return Promise.resolve(mercury._emit('break'));
+        return Promise.resolve(mercury._emit('break', event)).then((res) => {
+          assert.calledWith(mercury.logger.error, 'Mercury: error occurred in event handler', {
+            error,
+            arguments: ['break', event],
+          });
+          return res;
+        });
       });
     });
 
@@ -706,4 +717,99 @@ describe('plugin-mercury', () => {
       });
     });
   });
+  describe('ping pong latency event is forwarded', () => {
+    let clock, mercury, mockWebSocket, socketOpenStub, webex;
+
+    const statusStartTypingMessage = JSON.stringify({
+      id: uuid.v4(),
+      data: {
+        eventType: 'status.start_typing',
+        actor: {
+          id: 'actorId',
+        },
+        conversationId: uuid.v4(),
+      },
+      timestamp: Date.now(),
+      trackingId: `suffix_${uuid.v4()}_${Date.now()}`,
+    });
+
+    beforeEach(() => {
+      clock = FakeTimers.install({now: Date.now()});
+    });
+
+    afterEach(() => {
+      clock.uninstall();
+    });
+
+    beforeEach(() => {
+      webex = new MockWebex({
+        children: {
+          mercury: Mercury,
+        },
+      });
+      webex.credentials = {
+        refresh: sinon.stub().returns(Promise.resolve()),
+        getUserToken: sinon.stub().returns(
+          Promise.resolve({
+            toString() {
+              return 'Bearer FAKE';
+            },
+          })
+        ),
+      };
+      webex.internal.device = {
+        register: sinon.stub().returns(Promise.resolve()),
+        refresh: sinon.stub().returns(Promise.resolve()),
+        webSocketUrl: 'ws://example.com',
+        getWebSocketUrl: sinon.stub().returns(Promise.resolve('ws://example-2.com')),
+        useServiceCatalogUrl: sinon
+          .stub()
+          .returns(Promise.resolve('https://service-catalog-url.com')),
+      };
+      webex.internal.services = {
+        convertUrlToPriorityHostUrl: sinon.stub().returns(Promise.resolve('ws://example-2.com')),
+        markFailedUrl: sinon.stub().returns(Promise.resolve()),
+      };
+      webex.internal.metrics.submitClientMetrics = sinon.stub();
+      webex.trackingId = 'fakeTrackingId';
+      webex.config.mercury = mercuryConfig.mercury;
+
+      webex.logger = console;
+
+      mockWebSocket = new MockWebSocket();
+      sinon.stub(Socket, 'getWebSocketConstructor').returns(() => mockWebSocket);
+
+      const origOpen = Socket.prototype.open;
+
+      socketOpenStub = sinon.stub(Socket.prototype, 'open').callsFake(function (...args) {
+        const promise = Reflect.apply(origOpen, this, args);
+
+        process.nextTick(() => mockWebSocket.open());
+
+        return promise;
+      });
+
+      mercury = webex.internal.mercury;
+    });
+
+    afterEach(() => {
+      if (socketOpenStub) {
+        socketOpenStub.restore();
+      }
+
+      if (Socket.getWebSocketConstructor.restore) {
+        Socket.getWebSocketConstructor.restore();
+      }
+    });
+    it('should forward ping pong latency event', () => {
+      const spy = sinon.spy();
+
+      mercury.on('ping-pong-latency', spy);
+
+      return mercury.connect().then(() => {
+        assert.calledWith(spy, 0);
+        assert.calledOnce(spy);
+      });
+    });
+  });
 });

package/test/unit/spec/socket.js

@@ -807,6 +807,23 @@ describe('plugin-mercury', () => {
           reason: 'Pong mismatch',
         });
       });
+
+      it('emits ping pong latency correctly', () => {
+        const spy = sinon.spy();
+
+        socket.on('ping-pong-latency', spy);
+
+        socket._ping(123);
+        mockWebSocket.emit('message', {
+          data: JSON.stringify({
+            type: 'pong',
+            id: 123,
+          }),
+        });
+
+        assert.calledWith(spy, 0);
+        assert.calledOnce(spy);
+      });
     });
   });
 });