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

package/dist/socket/socket.js.map

@@ -1 +1 @@
-{"version":3,"names":["Socket","getWebSocketConstructor","WS"],"sources":["socket.js"],"sourcesContent":["/*!\n * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.\n */\n\nimport WS from 'ws';\n\nimport Socket from './socket-base';\n\nSocket.getWebSocketConstructor = function getWebSocketConstructor() {\n  return WS;\n};\n\nexport default Socket;\n"],"mappings":";;;;;;;;AAIA;AAEA;AANA;AACA;AACA;;AAMAA,mBAAM,CAACC,uBAAuB,GAAG,SAASA,uBAAuB,GAAG;EAClE,OAAOC,WAAE;AACX,CAAC;AAAC,eAEaF,mBAAM;AAAA"}
+{"version":3,"names":["_ws","_interopRequireDefault","require","_socketBase","Socket","getWebSocketConstructor","WS","_default","exports","default"],"sources":["socket.js"],"sourcesContent":["/*!\n * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.\n */\n\nimport WS from 'ws';\n\nimport Socket from './socket-base';\n\nSocket.getWebSocketConstructor = function getWebSocketConstructor() {\n  return WS;\n};\n\nexport default Socket;\n"],"mappings":";;;;;;;;AAIA,IAAAA,GAAA,GAAAC,sBAAA,CAAAC,OAAA;AAEA,IAAAC,WAAA,GAAAF,sBAAA,CAAAC,OAAA;AANA;AACA;AACA;;AAMAE,mBAAM,CAACC,uBAAuB,GAAG,SAASA,uBAAuBA,CAAA,EAAG;EAClE,OAAOC,WAAE;AACX,CAAC;AAAC,IAAAC,QAAA,GAAAC,OAAA,CAAAC,OAAA,GAEaL,mBAAM"}

package/dist/socket/socket.shim.js

@@ -32,6 +32,5 @@ _socketBase.default.getWebSocketConstructor = function getWebSocketConstructor()
   }
   return ws;
 };
-var _default = _socketBase.default;
-exports.default = _default;
+var _default = exports.default = _socketBase.default;
 //# sourceMappingURL=socket.shim.js.map

package/dist/socket/socket.shim.js.map

@@ -1 +1 @@
-{"version":3,"names":["Socket","getWebSocketConstructor","ws","WebSocket","MozWebSocket","global","window","self"],"sources":["socket.shim.js"],"sourcesContent":["/* eslint-disable no-restricted-globals */\n\n/*!\n * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.\n */\n\n/* eslint-env browser */\n\nimport Socket from './socket-base';\n\nSocket.getWebSocketConstructor = function getWebSocketConstructor() {\n  // Grabed from https://github.com/heineiuo/isomorphic-ws/blob/9b977394ac875638c045fd9cf774ed418484b394/browser.js\n  let ws;\n\n  if (typeof WebSocket !== 'undefined') {\n    ws = WebSocket;\n  } else if (typeof MozWebSocket !== 'undefined') {\n    // eslint-disable-next-line no-undef\n    ws = MozWebSocket;\n  } else if (typeof global !== 'undefined') {\n    ws = global.WebSocket || global.MozWebSocket;\n  } else if (typeof window !== 'undefined') {\n    ws = window.WebSocket || window.MozWebSocket;\n  } else if (typeof self !== 'undefined') {\n    ws = self.WebSocket || self.MozWebSocket;\n  }\n\n  return ws;\n};\n\nexport default Socket;\n"],"mappings":";;;;;;;;AAQA;AARA;;AAEA;AACA;AACA;;AAEA;;AAIAA,mBAAM,CAACC,uBAAuB,GAAG,SAASA,uBAAuB,GAAG;EAClE;EACA,IAAIC,EAAE;EAEN,IAAI,OAAOC,SAAS,KAAK,WAAW,EAAE;IACpCD,EAAE,GAAGC,SAAS;EAChB,CAAC,MAAM,IAAI,OAAOC,YAAY,KAAK,WAAW,EAAE;IAC9C;IACAF,EAAE,GAAGE,YAAY;EACnB,CAAC,MAAM,IAAI,OAAOC,MAAM,KAAK,WAAW,EAAE;IACxCH,EAAE,GAAGG,MAAM,CAACF,SAAS,IAAIE,MAAM,CAACD,YAAY;EAC9C,CAAC,MAAM,IAAI,OAAOE,MAAM,KAAK,WAAW,EAAE;IACxCJ,EAAE,GAAGI,MAAM,CAACH,SAAS,IAAIG,MAAM,CAACF,YAAY;EAC9C,CAAC,MAAM,IAAI,OAAOG,IAAI,KAAK,WAAW,EAAE;IACtCL,EAAE,GAAGK,IAAI,CAACJ,SAAS,IAAII,IAAI,CAACH,YAAY;EAC1C;EAEA,OAAOF,EAAE;AACX,CAAC;AAAC,eAEaF,mBAAM;AAAA"}
+{"version":3,"names":["_socketBase","_interopRequireDefault","require","Socket","getWebSocketConstructor","ws","WebSocket","MozWebSocket","global","window","self","_default","exports","default"],"sources":["socket.shim.js"],"sourcesContent":["/* eslint-disable no-restricted-globals */\n\n/*!\n * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.\n */\n\n/* eslint-env browser */\n\nimport Socket from './socket-base';\n\nSocket.getWebSocketConstructor = function getWebSocketConstructor() {\n  // Grabed from https://github.com/heineiuo/isomorphic-ws/blob/9b977394ac875638c045fd9cf774ed418484b394/browser.js\n  let ws;\n\n  if (typeof WebSocket !== 'undefined') {\n    ws = WebSocket;\n  } else if (typeof MozWebSocket !== 'undefined') {\n    // eslint-disable-next-line no-undef\n    ws = MozWebSocket;\n  } else if (typeof global !== 'undefined') {\n    ws = global.WebSocket || global.MozWebSocket;\n  } else if (typeof window !== 'undefined') {\n    ws = window.WebSocket || window.MozWebSocket;\n  } else if (typeof self !== 'undefined') {\n    ws = self.WebSocket || self.MozWebSocket;\n  }\n\n  return ws;\n};\n\nexport default Socket;\n"],"mappings":";;;;;;;;AAQA,IAAAA,WAAA,GAAAC,sBAAA,CAAAC,OAAA;AARA;;AAEA;AACA;AACA;;AAEA;;AAIAC,mBAAM,CAACC,uBAAuB,GAAG,SAASA,uBAAuBA,CAAA,EAAG;EAClE;EACA,IAAIC,EAAE;EAEN,IAAI,OAAOC,SAAS,KAAK,WAAW,EAAE;IACpCD,EAAE,GAAGC,SAAS;EAChB,CAAC,MAAM,IAAI,OAAOC,YAAY,KAAK,WAAW,EAAE;IAC9C;IACAF,EAAE,GAAGE,YAAY;EACnB,CAAC,MAAM,IAAI,OAAOC,MAAM,KAAK,WAAW,EAAE;IACxCH,EAAE,GAAGG,MAAM,CAACF,SAAS,IAAIE,MAAM,CAACD,YAAY;EAC9C,CAAC,MAAM,IAAI,OAAOE,MAAM,KAAK,WAAW,EAAE;IACxCJ,EAAE,GAAGI,MAAM,CAACH,SAAS,IAAIG,MAAM,CAACF,YAAY;EAC9C,CAAC,MAAM,IAAI,OAAOG,IAAI,KAAK,WAAW,EAAE;IACtCL,EAAE,GAAGK,IAAI,CAACJ,SAAS,IAAII,IAAI,CAACH,YAAY;EAC1C;EAEA,OAAOF,EAAE;AACX,CAAC;AAAC,IAAAM,QAAA,GAAAC,OAAA,CAAAC,OAAA,GAEaV,mBAAM"}

package/jest.config.js

@@ -0,0 +1,3 @@
+const config = require('@webex/jest-config-legacy');
+
+module.exports = config;

package/package.json

@@ -1,6 +1,5 @@
 {
   "name": "@webex/internal-plugin-mercury",
-  "version": "3.0.0-bnr.5",
   "description": "",
   "license": "MIT",
   "main": "dist/index.js",
@@ -24,26 +23,46 @@
     ]
   },
   "devDependencies": {
+    "@babel/core": "^7.17.10",
     "@sinonjs/fake-timers": "^6.0.1",
+    "@webex/babel-config-legacy": "0.0.0",
+    "@webex/eslint-config-legacy": "0.0.0",
+    "@webex/jest-config-legacy": "0.0.0",
+    "@webex/legacy-tools": "0.0.0",
+    "@webex/test-helper-chai": "3.0.0-next.8",
+    "@webex/test-helper-mocha": "3.0.0-next.8",
+    "@webex/test-helper-mock-webex": "3.0.0-next.8",
+    "@webex/test-helper-test-users": "3.0.0-next.8",
+    "eslint": "^8.24.0",
+    "prettier": "^2.7.1",
     "sinon": "^9.2.4"
   },
   "dependencies": {
-    "@webex/common": "3.0.0-bnr.5",
-    "@webex/common-timers": "3.0.0-bnr.5",
-    "@webex/internal-plugin-device": "3.0.0-bnr.5",
-    "@webex/internal-plugin-feature": "3.0.0-bnr.5",
-    "@webex/internal-plugin-mercury": "3.0.0-bnr.5",
-    "@webex/internal-plugin-metrics": "3.0.0-bnr.5",
-    "@webex/test-helper-chai": "3.0.0-bnr.5",
-    "@webex/test-helper-mocha": "3.0.0-bnr.5",
-    "@webex/test-helper-mock-web-socket": "3.0.0-bnr.5",
-    "@webex/test-helper-mock-webex": "3.0.0-bnr.5",
-    "@webex/test-helper-refresh-callback": "3.0.0-bnr.5",
-    "@webex/test-helper-test-users": "3.0.0-bnr.5",
-    "@webex/webex-core": "3.0.0-bnr.5",
+    "@webex/common": "3.0.0-next.8",
+    "@webex/common-timers": "3.0.0-next.8",
+    "@webex/internal-plugin-device": "3.0.0-next.8",
+    "@webex/internal-plugin-feature": "3.0.0-next.10",
+    "@webex/internal-plugin-metrics": "3.0.0-next.8",
+    "@webex/test-helper-chai": "3.0.0-next.8",
+    "@webex/test-helper-mocha": "3.0.0-next.8",
+    "@webex/test-helper-mock-web-socket": "3.0.0-next.8",
+    "@webex/test-helper-mock-webex": "3.0.0-next.8",
+    "@webex/test-helper-refresh-callback": "3.0.0-next.8",
+    "@webex/test-helper-test-users": "3.0.0-next.8",
+    "@webex/webex-core": "3.0.0-next.8",
     "backoff": "^2.5.0",
     "lodash": "^4.17.21",
     "uuid": "^3.3.2",
     "ws": "^8.2.2"
-  }
-}
+  },
+  "scripts": {
+    "build": "yarn build:src",
+    "build:src": "webex-legacy-tools build -dest \"./dist\" -src \"./src\" -js -ts -maps",
+    "deploy:npm": "yarn npm publish",
+    "test": "yarn test:style && yarn test:unit && yarn test:integration && yarn test:browser",
+    "test:browser": "webex-legacy-tools test --integration --unit --runner karma",
+    "test:style": "eslint ./src/**/*.*",
+    "test:unit": "webex-legacy-tools test --unit --runner mocha"
+  },
+  "version": "3.0.0-next.10"
+}

package/process

@@ -0,0 +1 @@
+module.exports = {browser: true};

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