@webex/internal-plugin-mercury 3.0.0-bnr.4 → 3.0.0

package/test/unit/spec/mercury.js

@@ -381,7 +381,7 @@ describe('plugin-mercury', () => {
         });
       });
 
-      describe('when webSocketUrl is provided', () => {
+      describe.skip('when webSocketUrl is provided', () => {
         it('connects to Mercury with provided url', () => {
           const webSocketUrl = 'ws://providedurl.com';
           const promise = mercury.connect(webSocketUrl);
@@ -403,7 +403,7 @@ describe('plugin-mercury', () => {
       });
     });
 
-    describe('Websocket proxy agent', () => {
+    describe.skip('Websocket proxy agent', () => {
       afterEach(() => {
         delete webex.config.defaultMercuryOptions;
       });
@@ -451,7 +451,7 @@ describe('plugin-mercury', () => {
       });
     });
 
-    describe('#disconnect()', () => {
+    describe.skip('#disconnect()', () => {
       it('disconnects the WebSocket', () =>
         mercury
           .connect()
@@ -560,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'
             );
           });
         });
@@ -568,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;
+        });
       });
     });
 
@@ -708,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

@@ -39,11 +39,9 @@ describe('plugin-mercury', () => {
       clock.uninstall();
     });
 
-    beforeEach('mock WebSocket and open a Socket', () => {
-      sinon.stub(Socket, 'getWebSocketConstructor').callsFake(
-        () =>
-          function (...args) {
-            mockWebSocket = new MockWebSocket(...args);
+    beforeEach(() => {
+      sinon.stub(Socket, 'getWebSocketConstructor').callsFake(() => function (...args) {
+        mockWebSocket = new MockWebSocket(...args);
 
             return mockWebSocket;
           }
@@ -71,7 +69,7 @@ describe('plugin-mercury', () => {
       });
     });
 
-    describe('#open()', () => {
+    describe.skip('#open()', () => {
       let socket;
 
       beforeEach(() => {
@@ -215,7 +213,7 @@ describe('plugin-mercury', () => {
       });
     });
 
-    describe('#open()', () => {
+    describe.skip('#open()', () => {
       it('requires a url parameter', () => {
         const s = new Socket();
 
@@ -568,7 +566,7 @@ describe('plugin-mercury', () => {
       });
     });
 
-    describe('#onclose()', () => {
+    describe.skip('#onclose()', () => {
       it('stops further ping checks', () => {
         socket._ping.resetHistory();
         assert.notCalled(socket._ping);
@@ -752,7 +750,7 @@ describe('plugin-mercury', () => {
       });
     });
 
-    describe('#_ping()', () => {
+    describe.skip('#_ping()', () => {
       let id;
 
       beforeEach(() => {
@@ -809,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);
+      });
     });
   });
 });

package/dist/types/config.d.ts

@@ -1,10 +0,0 @@
-declare namespace _default {
-    namespace mercury {
-        const pingInterval: number;
-        const pongTimeout: number;
-        const backoffTimeMax: number;
-        const backoffTimeReset: number;
-        const forceCloseDelay: [type];
-    }
-}
-export default _default;

package/dist/types/errors.d.ts

@@ -1,31 +0,0 @@
-/**
- * Exception thrown when a websocket gets closed
- */
-export class ConnectionError {
-    static defaultMessage: string;
-    /**
-     * @param {CloseEvent} event
-     * @returns {string}
-     */
-    parse(event?: CloseEvent): string;
-}
-/**
- * thrown for CloseCode 4400
- */
-export class UnknownResponse extends ConnectionError {
-}
-/**
- * thrown for CloseCode 4400
- */
-export class BadRequest extends ConnectionError {
-}
-/**
- * thrown for CloseCode 4401
- */
-export class NotAuthorized extends ConnectionError {
-}
-/**
- * thrown for CloseCode 4403
- */
-export class Forbidden extends ConnectionError {
-}

package/dist/types/index.d.ts

@@ -1,4 +0,0 @@
-export { default as Socket } from "./socket";
-export { default as config } from "./config";
-export { default, default as Mercury } from "./mercury";
-export { BadRequest, ConnectionError, Forbidden, NotAuthorized, UnknownResponse } from "./errors";

package/dist/types/mercury.d.ts

@@ -1,2 +0,0 @@
-export default Mercury;
-declare const Mercury: any;

package/dist/types/socket/index.d.ts

@@ -1 +0,0 @@
-export { default } from "./socket";

package/dist/types/socket/socket-base.d.ts

@@ -1,120 +0,0 @@
-/**
- * Generalized socket abstraction
- */
-export default class Socket extends EventEmitter {
-    /**
-     * Provides the environmentally appropriate constructor (ws in NodeJS,
-     * WebSocket in browsers)
-     * @returns {WebSocket}
-     */
-    static getWebSocketConstructor(): WebSocket;
-    /**
-     * constructor
-     * @returns {Socket}
-     */
-    constructor();
-    /**
-     * Handles incoming message events
-     * @param {MessageEvent} event
-     * @returns {undefined}
-     */
-    onmessage(event: MessageEvent): undefined;
-    /**
-     * Handles incoming CloseEvents
-     * @param {CloseEvent} event
-     * @returns {undefined}
-     */
-    onclose(event: CloseEvent): undefined;
-    /**
-     * @see https://developer.mozilla.org/en-US/docs/Web/API/WebSocket
-     * @returns {string}
-     */
-    get binaryType(): string;
-    /**
-     * @see https://developer.mozilla.org/en-US/docs/Web/API/WebSocket
-     * @returns {number}
-     */
-    get bufferedAmount(): number;
-    /**
-     * @see https://developer.mozilla.org/en-US/docs/Web/API/WebSocket
-     * @returns {string}
-     */
-    get extensions(): string;
-    /**
-     * @see https://developer.mozilla.org/en-US/docs/Web/API/WebSocket
-     * @returns {string}
-     */
-    get protocol(): string;
-    /**
-     * @see https://developer.mozilla.org/en-US/docs/Web/API/WebSocket
-     * @returns {number}
-     */
-    get readyState(): number;
-    /**
-     * @see https://developer.mozilla.org/en-US/docs/Web/API/WebSocket
-     * @returns {string}
-     */
-    get url(): string;
-    /**
-     * Closes the socket
-     * @param {Object} options
-     * @param {string} options.reason
-     * @param {number} options.code
-     * @returns {Promise}
-     */
-    close(options: {
-        reason: string;
-        code: number;
-    }): Promise<any>;
-    /**
-     * Opens a WebSocket
-     * @param {string} url
-     * @param {options} options
-     * @param {number} options.forceCloseDelay (required)
-     * @param {number} options.pingInterval (required)
-     * @param {number} options.pongTimeout (required)
-     * @param {string} options.token (required)
-     * @param {string} options.trackingId (required)
-     * @param {Logger} options.logger (required)
-     * @param {string} options.logLevelToken
-     * @returns {Promise}
-     */
-    open(url: string, options: any): Promise<any>;
-    expectedSequenceNumber: any;
-    /**
-     * Sends a message up the socket
-     * @param {mixed} data
-     * @returns {Promise}
-     */
-    send(data: mixed): Promise<any>;
-    /**
-     * Sends an acknowledgment for a specific event
-     * @param {MessageEvent} event
-     * @returns {Promise}
-     */
-    _acknowledge(event: MessageEvent): Promise<any>;
-    /**
-     * Sends an auth message up the socket
-     * @private
-     * @returns {Promise}
-     */
-    private _authorize;
-    /**
-     * Deals with the fact that some browsers drop some close codes (but not
-     * close reasons).
-     * @param {CloseEvent} event
-     * @private
-     * @returns {CloseEvent}
-     */
-    private _fixCloseCode;
-    /**
-     * Sends a ping up the socket and confirms we get it back
-     * @param {[type]} id
-     * @private
-     * @returns {[type]}
-     */
-    private _ping;
-    pingTimer: any;
-    pongTimer: any;
-}
-import { EventEmitter } from "events";

package/dist/types/socket/socket.d.ts

@@ -1,2 +0,0 @@
-export default Socket;
-import Socket from "./socket-base";

package/dist/types/socket/socket.shim.d.ts

@@ -1,2 +0,0 @@
-export default Socket;
-import Socket from "./socket-base";

package/test/unit/spec/_setup.js

@@ -1,5 +0,0 @@
-/*!
- * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
- */
-
-console.debug = console.debug || console.info;