@webex/internal-plugin-mercury 3.0.0-beta.4 → 3.0.0-beta.400

package/dist/mercury.js

@@ -1,69 +1,38 @@
 "use strict";
 
 var _Object$keys2 = require("@babel/runtime-corejs2/core-js/object/keys");
-
 var _Object$getOwnPropertySymbols = require("@babel/runtime-corejs2/core-js/object/get-own-property-symbols");
-
 var _Object$getOwnPropertyDescriptor2 = require("@babel/runtime-corejs2/core-js/object/get-own-property-descriptor");
-
 var _Object$getOwnPropertyDescriptors = require("@babel/runtime-corejs2/core-js/object/get-own-property-descriptors");
-
 var _Object$defineProperties = require("@babel/runtime-corejs2/core-js/object/define-properties");
-
 var _Object$defineProperty = require("@babel/runtime-corejs2/core-js/object/define-property");
-
 var _interopRequireDefault = require("@babel/runtime-corejs2/helpers/interopRequireDefault");
-
 _Object$defineProperty(exports, "__esModule", {
   value: true
 });
-
 exports.default = void 0;
-
 var _promise = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/promise"));
-
 var _keys = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/object/keys"));
-
 var _assign = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/object/assign"));
-
 var _deleteProperty = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/reflect/delete-property"));
-
 var _now = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/date/now"));
-
 var _getOwnPropertyDescriptor = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/object/get-own-property-descriptor"));
-
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/defineProperty"));
-
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/slicedToArray"));
-
 var _applyDecoratedDescriptor2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/applyDecoratedDescriptor"));
-
 var _set2 = _interopRequireDefault(require("lodash/set"));
-
 var _get2 = _interopRequireDefault(require("lodash/get"));
-
 var _camelCase2 = _interopRequireDefault(require("lodash/camelCase"));
-
 var _url = _interopRequireDefault(require("url"));
-
 var _webexCore = require("@webex/webex-core");
-
 var _common = require("@webex/common");
-
 var _backoff = _interopRequireDefault(require("backoff"));
-
 var _socket = _interopRequireDefault(require("./socket"));
-
 var _errors = require("./errors");
-
 var _dec, _dec2, _obj;
-
 function ownKeys(object, enumerableOnly) { var keys = _Object$keys2(object); if (_Object$getOwnPropertySymbols) { var symbols = _Object$getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return _Object$getOwnPropertyDescriptor2(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
-
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }) : _Object$getOwnPropertyDescriptors ? _Object$defineProperties(target, _Object$getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { _Object$defineProperty(target, key, _Object$getOwnPropertyDescriptor2(source, key)); }); } return target; }
-
 var normalReconnectReasons = ['idle', 'done (forced)', 'pong not received', 'pong mismatch'];
-
 var Mercury = _webexCore.WebexPlugin.extend((_dec = (0, _common.deprecated)('Mercury#listen(): Use Mercury#connect() instead'), _dec2 = (0, _common.deprecated)('Mercury#stopListening(): Use Mercury#disconnect() instead'), (_obj = {
   namespace: 'Mercury',
   session: {
@@ -75,6 +44,10 @@ var Mercury = _webexCore.WebexPlugin.extend((_dec = (0, _common.deprecated)('Mer
       default: false,
       type: 'boolean'
     },
+    hasEverConnected: {
+      default: false,
+      type: 'boolean'
+    },
     socket: 'object',
     localClusterServiceUrls: 'object'
   },
@@ -88,39 +61,28 @@ var Mercury = _webexCore.WebexPlugin.extend((_dec = (0, _common.deprecated)('Mer
   },
   connect: function connect(webSocketUrl) {
     var _this = this;
-
     if (this.connected) {
-      this.logger.info('mercury: already connected, will not connect again');
+      this.logger.info("".concat(this.namespace, ": already connected, will not connect again"));
       return _promise.default.resolve();
     }
-
     this.connecting = true;
     return _promise.default.resolve(this.webex.internal.device.registered || this.webex.internal.device.register()).then(function () {
-      _this.logger.info('mercury: connecting');
-
+      _this.logger.info("".concat(_this.namespace, ": connecting"));
       return _this._connectWithBackoff(webSocketUrl);
     });
   },
   disconnect: function disconnect() {
     var _this2 = this;
-
     return new _promise.default(function (resolve) {
       if (_this2.backoffCall) {
-        _this2.logger.info('mercury: aborting connection');
-
+        _this2.logger.info("".concat(_this2.namespace, ": aborting connection"));
         _this2.backoffCall.abort();
       }
-
       if (_this2.socket) {
         _this2.socket.removeAllListeners('message');
-
         _this2.once('offline', resolve);
-
-        _this2.socket.close();
-
-        return;
+        resolve(_this2.socket.close());
       }
-
       resolve();
     });
   },
@@ -139,7 +101,6 @@ var Mercury = _webexCore.WebexPlugin.extend((_dec = (0, _common.deprecated)('Mer
     if (!event || !event.headers) {
       return;
     }
-
     var headerKeys = (0, _keys.default)(event.headers);
     headerKeys.forEach(function (keyPath) {
       (0, _set2.default)(event, keyPath, event.headers[keyPath]);
@@ -147,16 +108,13 @@ var Mercury = _webexCore.WebexPlugin.extend((_dec = (0, _common.deprecated)('Mer
   },
   _prepareUrl: function _prepareUrl(webSocketUrl) {
     var _this3 = this;
-
     if (!webSocketUrl) {
       webSocketUrl = this.webex.internal.device.webSocketUrl;
     }
-
     return this.webex.internal.feature.getFeature('developer', 'web-high-availability').then(function (haMessagingEnabled) {
       if (haMessagingEnabled) {
         return _this3.webex.internal.services.convertUrlToPriorityHostUrl(webSocketUrl);
       }
-
       return webSocketUrl;
     }).then(function (wsUrl) {
       webSocketUrl = wsUrl;
@@ -169,7 +127,6 @@ var Mercury = _webexCore.WebexPlugin.extend((_dec = (0, _common.deprecated)('Mer
         bufferStates: true,
         aliasHttpStatus: true
       });
-
       if (webSharedMercury) {
         (0, _assign.default)(webSocketUrl.query, {
           mercuryRegistrationStatus: true,
@@ -177,17 +134,14 @@ var Mercury = _webexCore.WebexPlugin.extend((_dec = (0, _common.deprecated)('Mer
         });
         (0, _deleteProperty.default)(webSocketUrl.query, 'bufferStates');
       }
-
       if ((0, _get2.default)(_this3, 'webex.config.device.ephemeral', false)) {
         webSocketUrl.query.multipleConnections = true;
       }
-
       return _url.default.format(webSocketUrl);
     });
   },
   _attemptConnection: function _attemptConnection(socketUrl, callback) {
     var _this4 = this;
-
     var socket = new _socket.default();
     var attemptWSUrl;
     socket.on('close', function () {
@@ -200,23 +154,23 @@ var Mercury = _webexCore.WebexPlugin.extend((_dec = (0, _common.deprecated)('Mer
       for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
         args[_key] = arguments[_key];
       }
-
       return _this4._emit.apply(_this4, ['sequence-mismatch'].concat(args));
     });
-
+    socket.on('ping-pong-latency', function () {
+      for (var _len2 = arguments.length, args = new Array(_len2), _key2 = 0; _key2 < _len2; _key2++) {
+        args[_key2] = arguments[_key2];
+      }
+      return _this4._emit.apply(_this4, ['ping-pong-latency'].concat(args));
+    });
     _promise.default.all([this._prepareUrl(socketUrl), this.webex.credentials.getUserToken()]).then(function (_ref) {
       var _ref2 = (0, _slicedToArray2.default)(_ref, 2),
-          webSocketUrl = _ref2[0],
-          token = _ref2[1];
-
+        webSocketUrl = _ref2[0],
+        token = _ref2[1];
       if (!_this4.backoffCall) {
-        var msg = 'mercury: prevent socket open when backoffCall no longer defined';
-
+        var msg = "".concat(_this4.namespace, ": prevent socket open when backoffCall no longer defined");
         _this4.logger.info(msg);
-
         return _promise.default.reject(new Error(msg));
       }
-
       attemptWSUrl = webSocketUrl;
       var options = {
         forceCloseDelay: _this4.config.forceCloseDelay,
@@ -225,35 +179,26 @@ var Mercury = _webexCore.WebexPlugin.extend((_dec = (0, _common.deprecated)('Mer
         token: token.toString(),
         trackingId: "".concat(_this4.webex.sessionId, "_").concat((0, _now.default)()),
         logger: _this4.logger
-      }; // if the consumer has supplied request options use them
+      };
 
+      // if the consumer has supplied request options use them
       if (_this4.webex.config.defaultMercuryOptions) {
-        _this4.logger.info('mercury: setting custom options');
-
+        _this4.logger.info("".concat(_this4.namespace, ": setting custom options"));
         options = _objectSpread(_objectSpread({}, options), _this4.webex.config.defaultMercuryOptions);
-      } // Set the socket before opening it. This allows a disconnect() to close
-      // the socket if it is in the process of being opened.
-
+      }
 
+      // Set the socket before opening it. This allows a disconnect() to close
+      // the socket if it is in the process of being opened.
       _this4.socket = socket;
+      _this4.logger.info("".concat(_this4.namespace, " connection url: ").concat(webSocketUrl));
       return socket.open(webSocketUrl, options);
     }).then(function () {
-      _this4.webex.internal.metrics.submitClientMetrics('web-ha-mercury', {
-        fields: {
-          success: true
-        },
-        tags: {
-          action: 'connected',
-          url: attemptWSUrl
-        }
-      });
-
+      _this4.logger.info("".concat(_this4.namespace, ": connected to mercury, success, action: connected, url: ").concat(attemptWSUrl));
       callback();
       return _this4.webex.internal.feature.getFeature('developer', 'web-high-availability').then(function (haMessagingEnabled) {
         if (haMessagingEnabled) {
           return _this4.webex.internal.device.refresh();
         }
-
         return _promise.default.resolve();
       });
     }).catch(function (reason) {
@@ -266,29 +211,25 @@ var Mercury = _webexCore.WebexPlugin.extend((_dec = (0, _common.deprecated)('Mer
           retries: _this4.backoffCall.getNumRetries()
         });
       }
-
-      _this4.logger.info('mercury: connection attempt failed', reason); // UnknownResponse is produced by IE for any 4XXX; treated it like a bad
+      _this4.logger.info("".concat(_this4.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 _errors.UnknownResponse) {
-        _this4.logger.info('mercury: received unknown response code, refreshing device registration');
-
+        _this4.logger.info("".concat(_this4.namespace, ": received unknown response code, refreshing device registration"));
         return _this4.webex.internal.device.refresh().then(function () {
           return callback(reason);
         });
-      } // NotAuthorized implies expired token
-
-
+      }
+      // NotAuthorized implies expired token
       if (reason instanceof _errors.NotAuthorized) {
-        _this4.logger.info('mercury: received authorization error, reauthorizing');
-
+        _this4.logger.info("".concat(_this4.namespace, ": received authorization error, reauthorizing"));
         return _this4.webex.credentials.refresh({
           force: true
         }).then(function () {
           return callback(reason);
         });
-      } // // NotFound implies expired web socket url
+      }
+      // // NotFound implies expired web socket url
       // else if (reason instanceof NotFound) {
       //   this.logger.info(`mercury: received not found error, refreshing device registration`);
       //   return this.webex.internal.device.refresh()
@@ -296,264 +237,205 @@ var Mercury = _webexCore.WebexPlugin.extend((_dec = (0, _common.deprecated)('Mer
       // }
       // BadRequest implies current credentials are for a Service Account
       // Forbidden implies current user is not entitle for Webex
-
-
       if (reason instanceof _errors.BadRequest || reason instanceof _errors.Forbidden) {
-        _this4.logger.warn('mercury: received unrecoverable response from mercury');
-
+        _this4.logger.warn("".concat(_this4.namespace, ": received unrecoverable response from mercury"));
         _this4.backoffCall.abort();
-
         return callback(reason);
       }
-
       if (reason instanceof _errors.ConnectionError) {
         return _this4.webex.internal.feature.getFeature('developer', 'web-high-availability').then(function (haMessagingEnabled) {
           if (haMessagingEnabled) {
-            _this4.logger.info('mercury: received a generic connection error, will try to connect to another datacenter');
-
-            _this4.webex.internal.metrics.submitClientMetrics('web-ha-mercury', {
-              fields: {
-                success: false
-              },
-              tags: {
-                action: 'failed',
-                error: reason.message,
-                url: attemptWSUrl
-              }
-            });
-
+            _this4.logger.info("".concat(_this4.namespace, ": received a generic connection error, will try to connect to another datacenter. failed, action: 'failed', url: ").concat(attemptWSUrl, " error: ").concat(reason.message));
             return _this4.webex.internal.services.markFailedUrl(attemptWSUrl);
           }
-
           return null;
         }).then(function () {
           return callback(reason);
         });
       }
-
       return callback(reason);
     }).catch(function (reason) {
-      _this4.logger.error('mercury: failed to handle connection failure', reason);
-
+      _this4.logger.error("".concat(_this4.namespace, ": failed to handle connection failure"), reason);
       callback(reason);
     });
   },
   _connectWithBackoff: function _connectWithBackoff(webSocketUrl) {
     var _this5 = this;
-
     return new _promise.default(function (resolve, reject) {
       // eslint gets confused about whether or not call is actually used
       // eslint-disable-next-line prefer-const
       var call;
-
       var onComplete = function onComplete(err) {
         _this5.connecting = false;
         _this5.backoffCall = undefined;
-
         if (err) {
-          _this5.logger.info("mercury: failed to connect after ".concat(call.getNumRetries(), " retries; log statement about next retry was inaccurate; ").concat(err));
-
+          _this5.logger.info("".concat(_this5.namespace, ": failed to connect after ").concat(call.getNumRetries(), " retries; log statement about next retry was inaccurate; ").concat(err));
           return reject(err);
         }
-
         _this5.connected = true;
-
+        _this5.hasEverConnected = true;
         _this5._emit('online');
-
         return resolve();
-      }; // eslint-disable-next-line prefer-reflect
-
+      };
 
+      // eslint-disable-next-line prefer-reflect
       call = _backoff.default.call(function (callback) {
-        _this5.logger.info("mercury: executing connection attempt ".concat(call.getNumRetries()));
-
+        _this5.logger.info("".concat(_this5.namespace, ": executing connection attempt ").concat(call.getNumRetries()));
         _this5._attemptConnection(webSocketUrl, callback);
       }, onComplete);
       call.setStrategy(new _backoff.default.ExponentialStrategy({
         initialDelay: _this5.config.backoffTimeReset,
         maxDelay: _this5.config.backoffTimeMax
       }));
-
-      if (_this5.config.maxRetries) {
+      if (_this5.config.initialConnectionMaxRetries && !_this5.hasEverConnected) {
+        call.failAfter(_this5.config.initialConnectionMaxRetries);
+      } else if (_this5.config.maxRetries) {
         call.failAfter(_this5.config.maxRetries);
       }
-
       call.on('abort', function () {
-        _this5.logger.info('mercury: connection aborted');
-
+        _this5.logger.info("".concat(_this5.namespace, ": connection aborted"));
         reject(new Error('Mercury Connection Aborted'));
       });
       call.on('callback', function (err) {
         if (err) {
           var number = call.getNumRetries();
           var delay = Math.min(call.strategy_.nextBackoffDelay_, _this5.config.backoffTimeMax);
-
-          _this5.logger.info("mercury: failed to connect; attempting retry ".concat(number + 1, " in ").concat(delay, " ms"));
+          _this5.logger.info("".concat(_this5.namespace, ": failed to connect; attempting retry ").concat(number + 1, " in ").concat(delay, " ms"));
           /* istanbul ignore if */
-
-
           if (process.env.NODE_ENV === 'development') {
-            _this5.logger.debug('mercury: ', err, err.stack);
+            _this5.logger.debug("".concat(_this5.namespace, ": "), err, err.stack);
           }
-
           return;
         }
-
-        _this5.logger.info('mercury: connected');
+        _this5.logger.info("".concat(_this5.namespace, ": connected"));
       });
       call.start();
       _this5.backoffCall = call;
     });
   },
   _emit: function _emit() {
+    for (var _len3 = arguments.length, args = new Array(_len3), _key3 = 0; _key3 < _len3; _key3++) {
+      args[_key3] = arguments[_key3];
+    }
     try {
-      this.trigger.apply(this, arguments);
+      this.trigger.apply(this, args);
     } catch (error) {
-      this.logger.error('mercury: error occurred in event handler', error);
+      this.logger.error("".concat(this.namespace, ": error occurred in event handler"), {
+        error: error,
+        arguments: args
+      });
     }
   },
   _getEventHandlers: function _getEventHandlers(eventType) {
     var _eventType$split = eventType.split('.'),
-        _eventType$split2 = (0, _slicedToArray2.default)(_eventType$split, 2),
-        namespace = _eventType$split2[0],
-        name = _eventType$split2[1];
-
+      _eventType$split2 = (0, _slicedToArray2.default)(_eventType$split, 2),
+      namespace = _eventType$split2[0],
+      name = _eventType$split2[1];
     var handlers = [];
-
     if (!this.webex[namespace] && !this.webex.internal[namespace]) {
       return handlers;
     }
-
     var handlerName = (0, _camelCase2.default)("process_".concat(name, "_event"));
-
     if ((this.webex[namespace] || this.webex.internal[namespace])[handlerName]) {
       handlers.push({
         name: handlerName,
         namespace: namespace
       });
     }
-
     return handlers;
   },
   _onclose: function _onclose(event) {
     // I don't see any way to avoid the complexity or statement count in here.
-
     /* eslint complexity: [0] */
+
     try {
       var reason = event.reason && event.reason.toLowerCase();
       var socketUrl = this.socket.url;
       this.socket.removeAllListeners();
       this.unset('socket');
       this.connected = false;
-
       this._emit('offline', event);
-
       switch (event.code) {
         case 1003:
           // metric: disconnect
-          this.logger.info("mercury: Mercury service rejected last message; will not reconnect: ".concat(event.reason));
-
+          this.logger.info("".concat(this.namespace, ": Mercury service rejected last message; will not reconnect: ").concat(event.reason));
           this._emit('offline.permanent', event);
-
           break;
-
         case 4000:
           // metric: disconnect
-          this.logger.info('mercury: socket replaced; will not reconnect');
-
+          this.logger.info("".concat(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("".concat(this.namespace, ": socket disconnected; reconnecting"));
           this._emit('offline.transient', event);
-
-          this._reconnect(socketUrl); // metric: disconnect
+          this._reconnect(socketUrl);
+          // metric: disconnect
           // if (code == 1011 && reason !== ping error) metric: unexpected disconnect
-
-
           break;
-
         case 1000:
           if (normalReconnectReasons.includes(reason)) {
-            this.logger.info('mercury: socket disconnected; reconnecting');
-
+            this.logger.info("".concat(this.namespace, ": socket disconnected; reconnecting"));
             this._emit('offline.transient', event);
-
-            this._reconnect(socketUrl); // metric: disconnect
+            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("".concat(this.namespace, ": socket disconnected; will not reconnect"));
             this._emit('offline.permanent', event);
           }
-
           break;
-
         default:
-          this.logger.info('mercury: socket disconnected unexpectedly; will not reconnect'); // unexpected disconnect
-
+          this.logger.info("".concat(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("".concat(this.namespace, ": error occurred in close handler"), error);
     }
   },
   _onmessage: function _onmessage(event) {
     var _this6 = this;
-
     var envelope = event.data;
-
     if (process.env.ENABLE_MERCURY_LOGGING) {
-      this.logger.debug('mercury: message envelope: ', envelope);
+      this.logger.debug("".concat(this.namespace, ": message envelope: "), envelope);
     }
-
     var data = envelope.data;
-
     this._applyOverrides(data);
-
     return this._getEventHandlers(data.eventType).reduce(function (promise, handler) {
       return promise.then(function () {
         var namespace = handler.namespace,
-            name = handler.name;
+          name = handler.name;
         return new _promise.default(function (resolve) {
           return resolve((_this6.webex[namespace] || _this6.webex.internal[namespace])[name](data));
         }).catch(function (reason) {
-          return _this6.logger.error("mercury: error occurred in autowired event handler for ".concat(data.eventType), reason);
+          return _this6.logger.error("".concat(_this6.namespace, ": error occurred in autowired event handler for ").concat(data.eventType), reason);
         });
       });
     }, _promise.default.resolve()).then(function () {
       _this6._emit('event', event.data);
-
       var _data$eventType$split = data.eventType.split('.'),
-          _data$eventType$split2 = (0, _slicedToArray2.default)(_data$eventType$split, 1),
-          namespace = _data$eventType$split2[0];
-
+        _data$eventType$split2 = (0, _slicedToArray2.default)(_data$eventType$split, 1),
+        namespace = _data$eventType$split2[0];
       if (namespace === data.eventType) {
         _this6._emit("event:".concat(namespace), envelope);
       } else {
         _this6._emit("event:".concat(namespace), envelope);
-
         _this6._emit("event:".concat(data.eventType), envelope);
       }
     }).catch(function (reason) {
-      _this6.logger.error('mercury: error occurred processing socket message', reason);
+      _this6.logger.error("".concat(_this6.namespace, ": error occurred processing socket message"), reason);
     });
   },
   _reconnect: function _reconnect(webSocketUrl) {
-    this.logger.info('mercury: reconnecting');
+    this.logger.info("".concat(this.namespace, ": reconnecting"));
     return this.connect(webSocketUrl);
   },
-  version: "3.0.0-beta.4"
+  version: "3.0.0-beta.400"
 }, ((0, _applyDecoratedDescriptor2.default)(_obj, "connect", [_common.oneFlight], (0, _getOwnPropertyDescriptor.default)(_obj, "connect"), _obj), (0, _applyDecoratedDescriptor2.default)(_obj, "disconnect", [_common.oneFlight], (0, _getOwnPropertyDescriptor.default)(_obj, "disconnect"), _obj), (0, _applyDecoratedDescriptor2.default)(_obj, "listen", [_dec], (0, _getOwnPropertyDescriptor.default)(_obj, "listen"), _obj), (0, _applyDecoratedDescriptor2.default)(_obj, "stopListening", [_dec2], (0, _getOwnPropertyDescriptor.default)(_obj, "stopListening"), _obj)), _obj)));
-
 var _default = Mercury;
 exports.default = _default;
 //# sourceMappingURL=mercury.js.map