@webex/internal-plugin-mercury 3.0.0-bnr.5 → 3.0.0-next.10

package/src/socket/socket-base.js

@@ -30,6 +30,7 @@ export default class Socket extends EventEmitter {
    */
   constructor() {
     super();
+    this._domain = 'unknown-domain';
     this.onmessage = this.onmessage.bind(this);
     this.onclose = this.onclose.bind(this);
   }
@@ -111,10 +112,10 @@ export default class Socket extends EventEmitter {
         return;
       }
       // logger is defined once open is called
-      this.logger.info('socket: closing');
+      this.logger.info(`socket,${this._domain}: closing`);
 
       if (socket.readyState === 2 || socket.readyState === 3) {
-        this.logger.info('socket: already closed');
+        this.logger.info(`socket,${this._domain}: already closed`);
         resolve();
 
         return;
@@ -134,7 +135,7 @@ export default class Socket extends EventEmitter {
 
       const closeTimer = safeSetTimeout(() => {
         try {
-          this.logger.info('socket: no close event received, forcing closure');
+          this.logger.info(`socket,${this._domain}: no close event received, forcing closure`);
           resolve(
             this.onclose({
               code: 1000,
@@ -142,12 +143,12 @@ export default class Socket extends EventEmitter {
             })
           );
         } catch (error) {
-          this.logger.warn('socket: force-close failed', error);
+          this.logger.warn(`socket,${this._domain}: force-close failed`, error);
         }
       }, this.forceCloseDelay);
 
       socket.onclose = (event) => {
-        this.logger.info('socket: close event fired', event.code, event.reason);
+        this.logger.info(`socket,${this._domain}: close event fired`, event.code, event.reason);
         clearTimeout(closeTimer);
         this.onclose(event);
         resolve(event);
@@ -171,6 +172,12 @@ export default class Socket extends EventEmitter {
    * @returns {Promise}
    */
   open(url, options) {
+    try {
+      this._domain = new URL(url).hostname;
+    } catch {
+      this._domain = url;
+    }
+
     return new Promise((resolve, reject) => {
       /* eslint complexity: [0] */
       if (!url) {
@@ -201,7 +208,7 @@ export default class Socket extends EventEmitter {
 
       const WebSocket = Socket.getWebSocketConstructor();
 
-      this.logger.info('socket: creating WebSocket');
+      this.logger.info(`socket,${this._domain}: creating WebSocket`);
       const socket = new WebSocket(url, [], options);
 
       socket.binaryType = 'arraybuffer';
@@ -209,7 +216,7 @@ export default class Socket extends EventEmitter {
 
       socket.onclose = (event) => {
         event = this._fixCloseCode(event);
-        this.logger.info('socket: closed before open', event.code, event.reason);
+        this.logger.info(`socket,${this._domain}: closed before open`, event.code, event.reason);
         switch (event.code) {
           case 1005:
             // IE 11 doesn't seem to allow 4XXX codes, so if we get a 1005, assume
@@ -231,10 +238,10 @@ export default class Socket extends EventEmitter {
       };
 
       socket.onopen = () => {
-        this.logger.info('socket: connected');
+        this.logger.info(`socket,${this._domain}: connected`);
         this._authorize()
           .then(() => {
-            this.logger.info('socket: authorized');
+            this.logger.info(`socket,${this._domain}: authorized`);
             socket.onclose = this.onclose;
             resolve();
           })
@@ -242,11 +249,11 @@ export default class Socket extends EventEmitter {
       };
 
       socket.onerror = (event) => {
-        this.logger.warn('socket: error event fired', event);
+        this.logger.warn(`socket,${this._domain}: error event fired`, event);
       };
 
       sockets.set(this, socket);
-      this.logger.info('socket: waiting for server');
+      this.logger.info(`socket,${this._domain}: waiting for server`);
     });
   }
 
@@ -256,7 +263,7 @@ export default class Socket extends EventEmitter {
    * @returns {undefined}
    */
   onclose(event) {
-    this.logger.info('socket: closed', event.code, event.reason);
+    this.logger.info(`socket,${this._domain}: closed`, event.code, event.reason);
     clearTimeout(this.pongTimer);
     clearTimeout(this.pingTimer);
 
@@ -278,10 +285,10 @@ export default class Socket extends EventEmitter {
       const data = JSON.parse(event.data);
       const sequenceNumber = parseInt(data.sequenceNumber, 10);
 
-      this.logger.debug('socket: sequence number: ', sequenceNumber);
+      this.logger.debug(`socket,${this._domain}: sequence number: `, sequenceNumber);
       if (this.expectedSequenceNumber && sequenceNumber !== this.expectedSequenceNumber) {
         this.logger.debug(
-          `socket: sequence number mismatch indicates lost mercury message. expected: ${this.expectedSequenceNumber}, actual: ${sequenceNumber}`
+          `socket,${this._domain}: sequence number mismatch indicates lost mercury message. expected: ${this.expectedSequenceNumber}, actual: ${sequenceNumber}`
         );
         this.emit('sequence-mismatch', sequenceNumber, this.expectedSequenceNumber);
       }
@@ -303,7 +310,7 @@ export default class Socket extends EventEmitter {
       // message from Mercury. At this time, the only action we have is to
       // ignore it and move on.
       /* istanbul ignore next */
-      this.logger.warn('socket: error while receiving WebSocket message', error);
+      this.logger.warn(`socket,${this._domain}: error while receiving WebSocket message`, error);
     }
   }
 
@@ -357,7 +364,7 @@ export default class Socket extends EventEmitter {
    */
   _authorize() {
     return new Promise((resolve) => {
-      this.logger.info('socket: authorizing');
+      this.logger.info(`socket,${this._domain}: authorizing`);
       this.send({
         id: uuid.v4(),
         type: 'authorization',
@@ -395,12 +402,18 @@ export default class Socket extends EventEmitter {
     if (event.code === 1005 && event.reason) {
       switch (event.reason.toLowerCase()) {
         case 'replaced':
-          this.logger.info('socket: fixing CloseEvent code for reason: ', event.reason);
+          this.logger.info(
+            `socket,${this._domain}: fixing CloseEvent code for reason: `,
+            event.reason
+          );
           event.code = 4000;
           break;
         case 'authentication failed':
         case 'authentication did not happen within the timeout window of 30000 seconds.':
-          this.logger.info('socket: fixing CloseEvent code for reason: ', event.reason);
+          this.logger.info(
+            `socket,${this._domain}: fixing CloseEvent code for reason: `,
+            event.reason
+          );
           event.code = 1008;
           break;
         default:
@@ -420,10 +433,12 @@ export default class Socket extends EventEmitter {
   _ping(id) {
     const confirmPongId = (event) => {
       try {
-        this.logger.debug('socket: pong', event.data.id);
+        this.logger.debug(`socket,${this._domain}: pong`, event.data.id);
         if (event.data && event.data.id !== id) {
-          this.logger.info('socket: received pong for wrong ping id, closing socket');
-          this.logger.debug('socket: expected', id, 'received', event.data.id);
+          this.logger.info(
+            `socket,${this._domain}: received pong for wrong ping id, closing socket`
+          );
+          this.logger.debug(`socket,${this._domain}: expected`, id, 'received', event.data.id);
           this.close({
             code: 1000,
             reason: 'Pong mismatch',
@@ -433,24 +448,29 @@ export default class Socket extends EventEmitter {
         // This try/catch block was added as a debugging step; to the best of my
         // knowledge, the above can never throw.
         /* istanbul ignore next */
-        this.logger.error('socket: error occurred in confirmPongId', error);
+        this.logger.error(`socket,${this._domain}: error occurred in confirmPongId`, error);
       }
     };
 
     const onPongNotReceived = () => {
       try {
-        this.logger.info('socket: pong not receive in expected period, closing socket');
+        this.logger.info(
+          `socket,${this._domain}: pong not receive in expected period, closing socket`
+        );
         this.close({
           code: 1000,
           reason: 'Pong not received',
         }).catch((reason) => {
-          this.logger.warn('socket: failed to close socket after missed pong', reason);
+          this.logger.warn(
+            `socket,${this._domain}: failed to close socket after missed pong`,
+            reason
+          );
         });
       } catch (error) {
         // This try/catch block was added as a debugging step; to the best of my
         // knowledge, the above can never throw.
         /* istanbul ignore next */
-        this.logger.error('socket: error occurred in onPongNotReceived', error);
+        this.logger.error(`socket,${this._domain}: error occurred in onPongNotReceived`, error);
       }
     };
 
@@ -462,16 +482,29 @@ export default class Socket extends EventEmitter {
         // This try/catch block was added as a debugging step; to the best of my
         // knowledge, the above can never throw.
         /* istanbul ignore next */
-        this.logger.error('socket: error occurred in scheduleNextPingAndCancelPongTimer', error);
+        this.logger.error(
+          `socket,${this._domain}: error occurred in scheduleNextPingAndCancelPongTimer`,
+          error
+        );
       }
     };
 
+    const calculateLatency = (pingTimestamp) => {
+      const now = performance.now();
+      const latency = now - pingTimestamp;
+
+      this.logger.debug(`socket,${this._domain}: latency: `, latency);
+      this.emit('ping-pong-latency', latency);
+    };
+
     id = id || uuid.v4();
+    const pingTimestamp = performance.now();
+
     this.pongTimer = safeSetTimeout(onPongNotReceived, this.pongTimeout);
     this.once('pong', scheduleNextPingAndCancelPongTimer);
     this.once('pong', confirmPongId);
-
-    this.logger.debug(`socket: ping ${id}`);
+    this.once('pong', () => calculateLatency(pingTimestamp));
+    this.logger.debug(`socket,${this._domain}: ping ${id}`);
 
     return this.send({
       id,

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

@@ -152,9 +152,8 @@ describe('plugin-mercury', () => {
       });
 
       describe('when `maxRetries` is set', () => {
-        // skipping due to apparent bug with lolex in all browsers but Chrome.
-        skipInBrowser(it)('fails after `maxRetries` attempts', () => {
-          mercury.config.maxRetries = 2;
+
+        const check = () => {
           socketOpenStub.restore();
           socketOpenStub = sinon.stub(Socket.prototype, 'open');
           socketOpenStub.returns(Promise.reject(new ConnectionError()));
@@ -182,12 +181,42 @@ describe('plugin-mercury', () => {
             .then(() => {
               assert.calledThrice(Socket.prototype.open);
               clock.tick(5 * mercury.config.backoffTimeReset);
-
               return assert.isRejected(promise);
             })
             .then(() => {
               assert.calledThrice(Socket.prototype.open);
             });
+        }
+
+        // skipping due to apparent bug with lolex in all browsers but Chrome.
+        // if initial retries is zero and mercury has never connected max retries is used
+        skipInBrowser(it)('fails after `maxRetries` attempts', () => {
+          mercury.config.maxRetries = 2;
+          mercury.config.initialConnectionMaxRetries = 0;
+
+          return check();
+        });
+
+        // initial retries is non-zero so takes precedence over maxRetries when mercury has never connected
+        skipInBrowser(it)('fails after `initialConnectionMaxRetries` attempts', () => {
+          mercury.config.maxRetries = 0;
+          mercury.config.initialConnectionMaxRetries = 2;
+          return check();
+        });
+
+        // initial retries is non-zero so takes precedence over maxRetries when mercury has never connected
+        skipInBrowser(it)('fails after `initialConnectionMaxRetries` attempts', () => {
+          mercury.config.initialConnectionMaxRetries = 2;
+          mercury.config.maxRetries = 5;
+          return check();
+        });
+
+        // when mercury has connected maxRetries is used and the initialConnectionMaxRetries is ignored
+        skipInBrowser(it)('fails after `initialConnectionMaxRetries` attempts', () => {
+          mercury.config.initialConnectionMaxRetries = 5;
+          mercury.config.maxRetries = 2;
+          mercury.hasEverConnected = true;
+          return check();
         });
       });
 
@@ -541,7 +570,10 @@ describe('plugin-mercury', () => {
             // The socket will never be unset (which seems bad)
             assert.isDefined(mercury.socket, 'Mercury socket is not defined');
 
-            return assert.isRejected(promise);
+            return assert.isRejected(promise).then((error) => {
+              // connection did not fail, so no last error
+              assert.isUndefined(mercury.getLastError());
+            });
           });
         });
 
@@ -560,20 +592,53 @@ 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'
             );
           });
         });
+
+        it('sets lastError when retrying', () => {
+          const realError = new Error('FORCED');
+
+          socketOpenStub.restore();
+          socketOpenStub = sinon.stub(Socket.prototype, 'open');
+          socketOpenStub.onCall(0).returns(Promise.reject(realError));
+          const promise = mercury.connect();
+
+          // Wait for the connect call to setup
+          return promiseTick(webex.internal.mercury.config.backoffTimeReset).then(() => {
+            // Calling disconnect will abort the backoffCall, close the socket, and
+            // reject the connect
+            mercury.disconnect();
+
+            return assert.isRejected(promise).then((error) => {
+              const lastError = mercury.getLastError();
+
+              assert.equal(error.message, "Mercury Connection Aborted");
+              assert.isDefined(lastError);
+              assert.equal(lastError, realError);
+            });
+          });
+        });
       });
     });
 
     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;
+        });
       });
     });
 
@@ -707,5 +772,18 @@ describe('plugin-mercury', () => {
             .then((wsUrl) => assert.match(wsUrl, /multipleConnections/)));
       });
     });
+
+    describe('ping pong latency event is forwarded', () => {
+      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,7 +39,7 @@ describe('plugin-mercury', () => {
       clock.uninstall();
     });
 
-    beforeEach('mock WebSocket and open a Socket', () => {
+    beforeEach(() => {
       sinon.stub(Socket, 'getWebSocketConstructor').callsFake(
         () =>
           function (...args) {
@@ -809,6 +809,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;