@webex/internal-plugin-mercury 3.0.0-beta.41 → 3.0.0-beta.411

package/src/mercury.js

@@ -1,3 +1,4 @@
+/* eslint-disable require-jsdoc */
 /*!
  * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
  */
@@ -23,6 +24,7 @@ const normalReconnectReasons = ['idle', 'done (forced)', 'pong not received', 'p
 
 const Mercury = WebexPlugin.extend({
   namespace: 'Mercury',
+  lastError: undefined,
 
   session: {
     connected: {
@@ -33,6 +35,10 @@ const Mercury = WebexPlugin.extend({
       default: false,
       type: 'boolean',
     },
+    hasEverConnected: {
+      default: false,
+      type: 'boolean',
+    },
     socket: 'object',
     localClusterServiceUrls: 'object',
   },
@@ -46,10 +52,18 @@ const Mercury = WebexPlugin.extend({
     },
   },
 
+  /**
+   * Get the last error.
+   * @returns {any} The last error.
+   */
+  getLastError() {
+    return this.lastError;
+  },
+
   @oneFlight
   connect(webSocketUrl) {
     if (this.connected) {
-      this.logger.info('mercury: already connected, will not connect again');
+      this.logger.info(`${this.namespace}: already connected, will not connect again`);
 
       return Promise.resolve();
     }
@@ -59,7 +73,7 @@ const Mercury = WebexPlugin.extend({
     return Promise.resolve(
       this.webex.internal.device.registered || this.webex.internal.device.register()
     ).then(() => {
-      this.logger.info('mercury: connecting');
+      this.logger.info(`${this.namespace}: connecting`);
 
       return this._connectWithBackoff(webSocketUrl);
     });
@@ -69,16 +83,14 @@ const Mercury = WebexPlugin.extend({
   disconnect() {
     return new Promise((resolve) => {
       if (this.backoffCall) {
-        this.logger.info('mercury: aborting connection');
+        this.logger.info(`${this.namespace}: aborting connection`);
         this.backoffCall.abort();
       }
 
       if (this.socket) {
         this.socket.removeAllListeners('message');
         this.once('offline', resolve);
-        this.socket.close();
-
-        return;
+        resolve(this.socket.close());
       }
 
       resolve();
@@ -161,11 +173,12 @@ const Mercury = WebexPlugin.extend({
     socket.on('close', (...args) => this._onclose(...args));
     socket.on('message', (...args) => this._onmessage(...args));
     socket.on('sequence-mismatch', (...args) => this._emit('sequence-mismatch', ...args));
+    socket.on('ping-pong-latency', (...args) => this._emit('ping-pong-latency', ...args));
 
     Promise.all([this._prepareUrl(socketUrl), this.webex.credentials.getUserToken()])
       .then(([webSocketUrl, token]) => {
         if (!this.backoffCall) {
-          const msg = 'mercury: prevent socket open when backoffCall no longer defined';
+          const msg = `${this.namespace}: prevent socket open when backoffCall no longer defined`;
 
           this.logger.info(msg);
 
@@ -185,7 +198,7 @@ const Mercury = WebexPlugin.extend({
 
         // if the consumer has supplied request options use them
         if (this.webex.config.defaultMercuryOptions) {
-          this.logger.info('mercury: setting custom options');
+          this.logger.info(`${this.namespace}: setting custom options`);
           options = {...options, ...this.webex.config.defaultMercuryOptions};
         }
 
@@ -193,18 +206,14 @@ const Mercury = WebexPlugin.extend({
         // the socket if it is in the process of being opened.
         this.socket = socket;
 
+        this.logger.info(`${this.namespace} connection url: ${webSocketUrl}`);
+
         return socket.open(webSocketUrl, options);
       })
       .then(() => {
-        this.webex.internal.metrics.submitClientMetrics('web-ha-mercury', {
-          fields: {
-            success: true,
-          },
-          tags: {
-            action: 'connected',
-            url: attemptWSUrl,
-          },
-        });
+        this.logger.info(
+          `${this.namespace}: connected to mercury, success, action: connected, url: ${attemptWSUrl}`
+        );
         callback();
 
         return this.webex.internal.feature
@@ -218,6 +227,8 @@ const Mercury = WebexPlugin.extend({
           });
       })
       .catch((reason) => {
+        this.lastError = reason; // remember the last error
+
         // Suppress connection errors that appear to be network related. This
         // may end up suppressing metrics during outages, but we might not care
         // (especially since many of our outages happen in a way that client
@@ -225,19 +236,19 @@ const Mercury = WebexPlugin.extend({
         if (reason.code !== 1006 && this.backoffCall && this.backoffCall.getNumRetries() > 0) {
           this._emit('connection_failed', reason, {retries: this.backoffCall.getNumRetries()});
         }
-        this.logger.info('mercury: connection attempt failed', reason);
+        this.logger.info(`${this.namespace}: connection attempt failed`, reason);
         // UnknownResponse is produced by IE for any 4XXX; treated it like a bad
         // web socket url and let WDM handle the token checking
         if (reason instanceof UnknownResponse) {
           this.logger.info(
-            'mercury: received unknown response code, refreshing device registration'
+            `${this.namespace}: received unknown response code, refreshing device registration`
           );
 
           return this.webex.internal.device.refresh().then(() => callback(reason));
         }
         // NotAuthorized implies expired token
         if (reason instanceof NotAuthorized) {
-          this.logger.info('mercury: received authorization error, reauthorizing');
+          this.logger.info(`${this.namespace}: received authorization error, reauthorizing`);
 
           return this.webex.credentials.refresh({force: true}).then(() => callback(reason));
         }
@@ -250,7 +261,7 @@ const Mercury = WebexPlugin.extend({
         // BadRequest implies current credentials are for a Service Account
         // Forbidden implies current user is not entitle for Webex
         if (reason instanceof BadRequest || reason instanceof Forbidden) {
-          this.logger.warn('mercury: received unrecoverable response from mercury');
+          this.logger.warn(`${this.namespace}: received unrecoverable response from mercury`);
           this.backoffCall.abort();
 
           return callback(reason);
@@ -261,18 +272,8 @@ const Mercury = WebexPlugin.extend({
             .then((haMessagingEnabled) => {
               if (haMessagingEnabled) {
                 this.logger.info(
-                  'mercury: received a generic connection error, will try to connect to another datacenter'
+                  `${this.namespace}: received a generic connection error, will try to connect to another datacenter. failed, action: 'failed', url: ${attemptWSUrl} error: ${reason.message}`
                 );
-                this.webex.internal.metrics.submitClientMetrics('web-ha-mercury', {
-                  fields: {
-                    success: false,
-                  },
-                  tags: {
-                    action: 'failed',
-                    error: reason.message,
-                    url: attemptWSUrl,
-                  },
-                });
 
                 return this.webex.internal.services.markFailedUrl(attemptWSUrl);
               }
@@ -285,7 +286,7 @@ const Mercury = WebexPlugin.extend({
         return callback(reason);
       })
       .catch((reason) => {
-        this.logger.error('mercury: failed to handle connection failure', reason);
+        this.logger.error(`${this.namespace}: failed to handle connection failure`, reason);
         callback(reason);
       });
   },
@@ -301,12 +302,15 @@ const Mercury = WebexPlugin.extend({
         this.backoffCall = undefined;
         if (err) {
           this.logger.info(
-            `mercury: failed to connect after ${call.getNumRetries()} retries; log statement about next retry was inaccurate; ${err}`
+            `${
+              this.namespace
+            }: failed to connect after ${call.getNumRetries()} retries; log statement about next retry was inaccurate; ${err}`
           );
 
           return reject(err);
         }
         this.connected = true;
+        this.hasEverConnected = true;
         this._emit('online');
 
         return resolve();
@@ -314,7 +318,7 @@ const Mercury = WebexPlugin.extend({
 
       // eslint-disable-next-line prefer-reflect
       call = backoff.call((callback) => {
-        this.logger.info(`mercury: executing connection attempt ${call.getNumRetries()}`);
+        this.logger.info(`${this.namespace}: executing connection attempt ${call.getNumRetries()}`);
         this._attemptConnection(webSocketUrl, callback);
       }, onComplete);
 
@@ -325,12 +329,14 @@ const Mercury = WebexPlugin.extend({
         })
       );
 
-      if (this.config.maxRetries) {
+      if (this.config.initialConnectionMaxRetries && !this.hasEverConnected) {
+        call.failAfter(this.config.initialConnectionMaxRetries);
+      } else if (this.config.maxRetries) {
         call.failAfter(this.config.maxRetries);
       }
 
       call.on('abort', () => {
-        this.logger.info('mercury: connection aborted');
+        this.logger.info(`${this.namespace}: connection aborted`);
         reject(new Error('Mercury Connection Aborted'));
       });
 
@@ -340,16 +346,16 @@ const Mercury = WebexPlugin.extend({
           const delay = Math.min(call.strategy_.nextBackoffDelay_, this.config.backoffTimeMax);
 
           this.logger.info(
-            `mercury: failed to connect; attempting retry ${number + 1} in ${delay} ms`
+            `${this.namespace}: failed to connect; attempting retry ${number + 1} in ${delay} ms`
           );
           /* istanbul ignore if */
           if (process.env.NODE_ENV === 'development') {
-            this.logger.debug('mercury: ', err, err.stack);
+            this.logger.debug(`${this.namespace}: `, err, err.stack);
           }
 
           return;
         }
-        this.logger.info('mercury: connected');
+        this.logger.info(`${this.namespace}: connected`);
       });
 
       call.start();
@@ -362,7 +368,10 @@ const Mercury = WebexPlugin.extend({
     try {
       this.trigger(...args);
     } catch (error) {
-      this.logger.error('mercury: error occurred in event handler', error);
+      this.logger.error(`${this.namespace}: error occurred in event handler`, {
+        error,
+        arguments: args,
+      });
     }
   },
 
@@ -403,20 +412,20 @@ const Mercury = WebexPlugin.extend({
         case 1003:
           // metric: disconnect
           this.logger.info(
-            `mercury: Mercury service rejected last message; will not reconnect: ${event.reason}`
+            `${this.namespace}: Mercury service rejected last message; will not reconnect: ${event.reason}`
           );
           this._emit('offline.permanent', event);
           break;
         case 4000:
           // metric: disconnect
-          this.logger.info('mercury: socket replaced; will not reconnect');
+          this.logger.info(`${this.namespace}: socket replaced; will not reconnect`);
           this._emit('offline.replaced', event);
           break;
         case 1001:
         case 1005:
         case 1006:
         case 1011:
-          this.logger.info('mercury: socket disconnected; reconnecting');
+          this.logger.info(`${this.namespace}: socket disconnected; reconnecting`);
           this._emit('offline.transient', event);
           this._reconnect(socketUrl);
           // metric: disconnect
@@ -424,23 +433,25 @@ const Mercury = WebexPlugin.extend({
           break;
         case 1000:
           if (normalReconnectReasons.includes(reason)) {
-            this.logger.info('mercury: socket disconnected; reconnecting');
+            this.logger.info(`${this.namespace}: socket disconnected; reconnecting`);
             this._emit('offline.transient', event);
             this._reconnect(socketUrl);
             // metric: disconnect
             // if (reason === done forced) metric: force closure
           } else {
-            this.logger.info('mercury: socket disconnected; will not reconnect');
+            this.logger.info(`${this.namespace}: socket disconnected; will not reconnect`);
             this._emit('offline.permanent', event);
           }
           break;
         default:
-          this.logger.info('mercury: socket disconnected unexpectedly; will not reconnect');
+          this.logger.info(
+            `${this.namespace}: socket disconnected unexpectedly; will not reconnect`
+          );
           // unexpected disconnect
           this._emit('offline.permanent', event);
       }
     } catch (error) {
-      this.logger.error('mercury: error occurred in close handler', error);
+      this.logger.error(`${this.namespace}: error occurred in close handler`, error);
     }
   },
 
@@ -448,7 +459,7 @@ const Mercury = WebexPlugin.extend({
     const envelope = event.data;
 
     if (process.env.ENABLE_MERCURY_LOGGING) {
-      this.logger.debug('mercury: message envelope: ', envelope);
+      this.logger.debug(`${this.namespace}: message envelope: `, envelope);
     }
 
     const {data} = envelope;
@@ -465,7 +476,7 @@ const Mercury = WebexPlugin.extend({
               resolve((this.webex[namespace] || this.webex.internal[namespace])[name](data))
             ).catch((reason) =>
               this.logger.error(
-                `mercury: error occurred in autowired event handler for ${data.eventType}`,
+                `${this.namespace}: error occurred in autowired event handler for ${data.eventType}`,
                 reason
               )
             );
@@ -484,12 +495,12 @@ const Mercury = WebexPlugin.extend({
         }
       })
       .catch((reason) => {
-        this.logger.error('mercury: error occurred processing socket message', reason);
+        this.logger.error(`${this.namespace}: error occurred processing socket message`, reason);
       });
   },
 
   _reconnect(webSocketUrl) {
-    this.logger.info('mercury: reconnecting');
+    this.logger.info(`${this.namespace}: reconnecting`);
 
     return this.connect(webSocketUrl);
   },

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);
-      }));
+      });
+    });
   });
 });