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

package/dist/socket/socket-base.js

@@ -1,151 +1,121 @@
 "use strict";
 
 var _Reflect$construct = require("@babel/runtime-corejs2/core-js/reflect/construct");
-
 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 _weakMap = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/weak-map"));
-
 var _promise = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/promise"));
-
 var _keys = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/object/keys"));
-
 var _defineProperty = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/reflect/define-property"));
-
 var _parseInt2 = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/parse-int"));
-
 var _stringify = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/json/stringify"));
-
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/classCallCheck"));
-
 var _createClass2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/createClass"));
-
 var _assertThisInitialized2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/assertThisInitialized"));
-
 var _inherits2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/inherits"));
-
 var _possibleConstructorReturn2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/possibleConstructorReturn"));
-
 var _getPrototypeOf2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/getPrototypeOf"));
-
 var _isObject2 = _interopRequireDefault(require("lodash/isObject"));
-
 var _has2 = _interopRequireDefault(require("lodash/has"));
-
 var _defaults2 = _interopRequireDefault(require("lodash/defaults"));
-
 var _events = require("events");
-
 var _common = require("@webex/common");
-
 var _commonTimers = require("@webex/common-timers");
-
 var _uuid = _interopRequireDefault(require("uuid"));
-
 var _errors = require("../errors");
-
 function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = (0, _getPrototypeOf2.default)(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = (0, _getPrototypeOf2.default)(this).constructor; result = _Reflect$construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return (0, _possibleConstructorReturn2.default)(this, result); }; }
-
 function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !_Reflect$construct) return false; if (_Reflect$construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(_Reflect$construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
-
 var sockets = new _weakMap.default();
+
 /**
  * Generalized socket abstraction
  */
-
 var Socket = /*#__PURE__*/function (_EventEmitter) {
   (0, _inherits2.default)(Socket, _EventEmitter);
-
   var _super = _createSuper(Socket);
-
   /**
    * constructor
    * @returns {Socket}
    */
   function Socket() {
     var _this;
-
     (0, _classCallCheck2.default)(this, Socket);
     _this = _super.call(this);
+    _this._domain = 'unknown-domain';
     _this.onmessage = _this.onmessage.bind((0, _assertThisInitialized2.default)(_this));
     _this.onclose = _this.onclose.bind((0, _assertThisInitialized2.default)(_this));
     return _this;
   }
+
   /**
    * @see https://developer.mozilla.org/en-US/docs/Web/API/WebSocket
    * @returns {string}
    */
-
-
   (0, _createClass2.default)(Socket, [{
     key: "binaryType",
     get: function get() {
       return sockets.get(this).binaryType;
     }
+
     /**
      * @see https://developer.mozilla.org/en-US/docs/Web/API/WebSocket
      * @returns {number}
      */
-
   }, {
     key: "bufferedAmount",
     get: function get() {
       return sockets.get(this).bufferedAmount;
     }
+
     /**
      * @see https://developer.mozilla.org/en-US/docs/Web/API/WebSocket
      * @returns {string}
      */
-
   }, {
     key: "extensions",
     get: function get() {
       return sockets.get(this).extensions;
     }
+
     /**
      * @see https://developer.mozilla.org/en-US/docs/Web/API/WebSocket
      * @returns {string}
      */
-
   }, {
     key: "protocol",
     get: function get() {
       return sockets.get(this).protocol;
     }
+
     /**
      * @see https://developer.mozilla.org/en-US/docs/Web/API/WebSocket
      * @returns {number}
      */
-
   }, {
     key: "readyState",
     get: function get() {
       return sockets.get(this).readyState;
     }
+
     /**
      * @see https://developer.mozilla.org/en-US/docs/Web/API/WebSocket
      * @returns {string}
      */
-
   }, {
     key: "url",
     get: function get() {
       return sockets.get(this).url;
     }
+
     /**
      * Provides the environmentally appropriate constructor (ws in NodeJS,
      * WebSocket in browsers)
      * @returns {WebSocket}
      */
-
   }, {
     key: "close",
     value:
@@ -158,63 +128,50 @@ var Socket = /*#__PURE__*/function (_EventEmitter) {
      */
     function close(options) {
       var _this2 = this;
-
       return new _promise.default(function (resolve, reject) {
         var socket = sockets.get(_this2);
-
         if (!socket) {
           // Open has not been called yet so there is no socket to close
           resolve();
           return;
-        } // logger is defined once open is called
-
-
-        _this2.logger.info('socket: closing');
-
+        }
+        // logger is defined once open is called
+        _this2.logger.info("socket,".concat(_this2._domain, ": closing"));
         if (socket.readyState === 2 || socket.readyState === 3) {
-          _this2.logger.info('socket: already closed');
-
+          _this2.logger.info("socket,".concat(_this2._domain, ": already closed"));
           resolve();
           return;
         }
-
         options = options || {};
-
         if (options.code && options.code !== 1000 && (options.code < 3000 || options.code > 4999)) {
           reject(new Error('`options.code` must be 1000 or between 3000 and 4999 (inclusive)'));
           return;
         }
-
         options = (0, _defaults2.default)(options, {
           code: 1000,
           reason: 'Done'
         });
         var closeTimer = (0, _commonTimers.safeSetTimeout)(function () {
           try {
-            _this2.logger.info('socket: no close event received, forcing closure');
-
+            _this2.logger.info("socket,".concat(_this2._domain, ": no close event received, forcing closure"));
             resolve(_this2.onclose({
               code: 1000,
               reason: 'Done (forced)'
             }));
           } catch (error) {
-            _this2.logger.warn('socket: force-close failed', error);
+            _this2.logger.warn("socket,".concat(_this2._domain, ": force-close failed"), error);
           }
         }, _this2.forceCloseDelay);
-
         socket.onclose = function (event) {
-          _this2.logger.info('socket: close event fired', event.code, event.reason);
-
+          _this2.logger.info("socket,".concat(_this2._domain, ": close event fired"), event.code, event.reason);
           clearTimeout(closeTimer);
-
           _this2.onclose(event);
-
           resolve(event);
         };
-
         socket.close(options.code, options.reason);
       });
     }
+
     /**
      * Opens a WebSocket
      * @param {string} url
@@ -228,24 +185,25 @@ var Socket = /*#__PURE__*/function (_EventEmitter) {
      * @param {string} options.logLevelToken
      * @returns {Promise}
      */
-
   }, {
     key: "open",
     value: function open(url, options) {
       var _this3 = this;
-
+      try {
+        this._domain = new URL(url).hostname;
+      } catch (_unused) {
+        this._domain = url;
+      }
       return new _promise.default(function (resolve, reject) {
         /* eslint complexity: [0] */
         if (!url) {
           reject(new Error('`url` is required'));
           return;
         }
-
         if (sockets.get(_this3)) {
           reject(new Error('Socket#open() can only be called once per instance'));
           return;
         }
-
         options = options || {};
         (0, _common.checkRequired)(['forceCloseDelay', 'pingInterval', 'pongTimeout', 'token', 'trackingId', 'logger'], options);
         (0, _keys.default)(options).forEach(function (key) {
@@ -255,18 +213,13 @@ var Socket = /*#__PURE__*/function (_EventEmitter) {
           });
         });
         var WebSocket = Socket.getWebSocketConstructor();
-
-        _this3.logger.info('socket: creating WebSocket');
-
+        _this3.logger.info("socket,".concat(_this3._domain, ": creating WebSocket"));
         var socket = new WebSocket(url, [], options);
         socket.binaryType = 'arraybuffer';
         socket.onmessage = _this3.onmessage;
-
         socket.onclose = function (event) {
           event = _this3._fixCloseCode(event);
-
-          _this3.logger.info('socket: closed before open', event.code, event.reason);
-
+          _this3.logger.info("socket,".concat(_this3._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
@@ -274,90 +227,78 @@ var Socket = /*#__PURE__*/function (_EventEmitter) {
               // turns out we had a bad token, the device refresh should 401 and
               // trigger a token refresh.
               return reject(new _errors.UnknownResponse(event));
-
             case 4400:
               return reject(new _errors.BadRequest(event));
-
             case 4401:
               return reject(new _errors.NotAuthorized(event));
-
             case 4403:
               return reject(new _errors.Forbidden(event));
             // case 4404:
             //   return reject(new NotFound(event));
-
             default:
               return reject(new _errors.ConnectionError(event));
           }
         };
-
         socket.onopen = function () {
-          _this3.logger.info('socket: connected');
-
+          _this3.logger.info("socket,".concat(_this3._domain, ": connected"));
           _this3._authorize().then(function () {
-            _this3.logger.info('socket: authorized');
-
+            _this3.logger.info("socket,".concat(_this3._domain, ": authorized"));
             socket.onclose = _this3.onclose;
             resolve();
           }).catch(reject);
         };
-
         socket.onerror = function (event) {
-          _this3.logger.warn('socket: error event fired', event);
+          _this3.logger.warn("socket,".concat(_this3._domain, ": error event fired"), event);
         };
-
         sockets.set(_this3, socket);
-
-        _this3.logger.info('socket: waiting for server');
+        _this3.logger.info("socket,".concat(_this3._domain, ": waiting for server"));
       });
     }
+
     /**
      * Handles incoming CloseEvents
      * @param {CloseEvent} event
      * @returns {undefined}
      */
-
   }, {
     key: "onclose",
     value: function onclose(event) {
-      this.logger.info('socket: closed', event.code, event.reason);
+      this.logger.info("socket,".concat(this._domain, ": closed"), event.code, event.reason);
       clearTimeout(this.pongTimer);
       clearTimeout(this.pingTimer);
       event = this._fixCloseCode(event);
-      this.emit('close', event); // Remove all listeners to (a) avoid reacting to late pongs and (b) ensure
-      // we don't have a retain cycle.
+      this.emit('close', event);
 
+      // Remove all listeners to (a) avoid reacting to late pongs and (b) ensure
+      // we don't have a retain cycle.
       this.removeAllListeners();
     }
+
     /**
      * Handles incoming message events
      * @param {MessageEvent} event
      * @returns {undefined}
      */
-
   }, {
     key: "onmessage",
     value: function onmessage(event) {
       try {
         var data = JSON.parse(event.data);
         var sequenceNumber = (0, _parseInt2.default)(data.sequenceNumber, 10);
-        this.logger.debug('socket: sequence number: ', sequenceNumber);
-
+        this.logger.debug("socket,".concat(this._domain, ": sequence number: "), sequenceNumber);
         if (this.expectedSequenceNumber && sequenceNumber !== this.expectedSequenceNumber) {
-          this.logger.debug("socket: sequence number mismatch indicates lost mercury message. expected: ".concat(this.expectedSequenceNumber, ", actual: ").concat(sequenceNumber));
+          this.logger.debug("socket,".concat(this._domain, ": sequence number mismatch indicates lost mercury message. expected: ").concat(this.expectedSequenceNumber, ", actual: ").concat(sequenceNumber));
           this.emit('sequence-mismatch', sequenceNumber, this.expectedSequenceNumber);
         }
+        this.expectedSequenceNumber = sequenceNumber + 1;
 
-        this.expectedSequenceNumber = sequenceNumber + 1; // Yes, it's a little weird looking; we want to emit message events that
+        // Yes, it's a little weird looking; we want to emit message events that
         // look like normal socket message events, but event.data cannot be
         // modified and we don't actually care about anything but the data property
-
         var processedEvent = {
           data: data
         };
-
         this._acknowledge(processedEvent);
-
         if (data.type === 'pong') {
           this.emit('pong', processedEvent);
         } else {
@@ -367,72 +308,64 @@ var Socket = /*#__PURE__*/function (_EventEmitter) {
         // The above code should only be able to throw if we receive an unparsable
         // 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,".concat(this._domain, ": error while receiving WebSocket message"), error);
       }
     }
+
     /**
      * Sends a message up the socket
      * @param {mixed} data
      * @returns {Promise}
      */
-
   }, {
     key: "send",
     value: function send(data) {
       var _this4 = this;
-
       return new _promise.default(function (resolve, reject) {
         if (_this4.readyState !== 1) {
           return reject(new Error('INVALID_STATE_ERROR'));
         }
-
         if ((0, _isObject2.default)(data)) {
           data = (0, _stringify.default)(data);
         }
-
         var socket = sockets.get(_this4);
         socket.send(data);
         return resolve();
       });
     }
+
     /**
      * Sends an acknowledgment for a specific event
      * @param {MessageEvent} event
      * @returns {Promise}
      */
-
   }, {
     key: "_acknowledge",
     value: function _acknowledge(event) {
       if (!event) {
         return _promise.default.reject(new Error('`event` is required'));
       }
-
       if (!(0, _has2.default)(event, 'data.id')) {
         return _promise.default.reject(new Error('`event.data.id` is required'));
       }
-
       return this.send({
         messageId: event.data.id,
         type: 'ack'
       });
     }
+
     /**
      * Sends an auth message up the socket
      * @private
      * @returns {Promise}
      */
-
   }, {
     key: "_authorize",
     value: function _authorize() {
       var _this5 = this;
-
       return new _promise.default(function (resolve) {
-        _this5.logger.info('socket: authorizing');
-
+        _this5.logger.info("socket,".concat(_this5._domain, ": authorizing"));
         _this5.send({
           id: _uuid.default.v4(),
           type: 'authorization',
@@ -442,20 +375,17 @@ var Socket = /*#__PURE__*/function (_EventEmitter) {
           trackingId: _this5.trackingId,
           logLevelToken: _this5.logLevelToken
         });
-
         var waitForBufferState = function waitForBufferState(event) {
           if (!event.data.type && (event.data.data.eventType === 'mercury.buffer_state' || event.data.data.eventType === 'mercury.registration_status')) {
             _this5.removeListener('message', waitForBufferState);
-
             _this5._ping();
-
             resolve();
           }
         };
-
         _this5.once('message', waitForBufferState);
       });
     }
+
     /**
      * Deals with the fact that some browsers drop some close codes (but not
      * close reasons).
@@ -463,51 +393,44 @@ var Socket = /*#__PURE__*/function (_EventEmitter) {
      * @private
      * @returns {CloseEvent}
      */
-
   }, {
     key: "_fixCloseCode",
     value: function _fixCloseCode(event) {
       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,".concat(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,".concat(this._domain, ": fixing CloseEvent code for reason: "), event.reason);
             event.code = 1008;
             break;
-
-          default: // do nothing
-
+          default:
+          // do nothing
         }
       }
 
       return event;
     }
+
     /**
      * Sends a ping up the socket and confirms we get it back
      * @param {[type]} id
      * @private
      * @returns {[type]}
      */
-
   }, {
     key: "_ping",
     value: function _ping(id) {
       var _this6 = this;
-
       var confirmPongId = function confirmPongId(event) {
         try {
-          _this6.logger.debug('socket: pong', event.data.id);
-
+          _this6.logger.debug("socket,".concat(_this6._domain, ": pong"), event.data.id);
           if (event.data && event.data.id !== id) {
-            _this6.logger.info('socket: received pong for wrong ping id, closing socket');
-
-            _this6.logger.debug('socket: expected', id, 'received', event.data.id);
-
+            _this6.logger.info("socket,".concat(_this6._domain, ": received pong for wrong ping id, closing socket"));
+            _this6.logger.debug("socket,".concat(_this6._domain, ": expected"), id, 'received', event.data.id);
             _this6.close({
               code: 1000,
               reason: 'Pong mismatch'
@@ -516,31 +439,26 @@ var Socket = /*#__PURE__*/function (_EventEmitter) {
         } 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 */
-          _this6.logger.error('socket: error occurred in confirmPongId', error);
+          _this6.logger.error("socket,".concat(_this6._domain, ": error occurred in confirmPongId"), error);
         }
       };
-
       var onPongNotReceived = function onPongNotReceived() {
         try {
-          _this6.logger.info('socket: pong not receive in expected period, closing socket');
-
+          _this6.logger.info("socket,".concat(_this6._domain, ": pong not receive in expected period, closing socket"));
           _this6.close({
             code: 1000,
             reason: 'Pong not received'
           }).catch(function (reason) {
-            _this6.logger.warn('socket: failed to close socket after missed pong', reason);
+            _this6.logger.warn("socket,".concat(_this6._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 */
-          _this6.logger.error('socket: error occurred in onPongNotReceived', error);
+          _this6.logger.error("socket,".concat(_this6._domain, ": error occurred in onPongNotReceived"), error);
         }
       };
-
       var scheduleNextPingAndCancelPongTimer = function scheduleNextPingAndCancelPongTimer() {
         try {
           clearTimeout(_this6.pongTimer);
@@ -550,17 +468,25 @@ var Socket = /*#__PURE__*/function (_EventEmitter) {
         } 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 */
-          _this6.logger.error('socket: error occurred in scheduleNextPingAndCancelPongTimer', error);
+          _this6.logger.error("socket,".concat(_this6._domain, ": error occurred in scheduleNextPingAndCancelPongTimer"), error);
         }
       };
-
+      var calculateLatency = function calculateLatency(pingTimestamp) {
+        var now = performance.now();
+        var latency = now - pingTimestamp;
+        _this6.logger.debug("socket,".concat(_this6._domain, ": latency: "), latency);
+        _this6.emit('ping-pong-latency', latency);
+      };
       id = id || _uuid.default.v4();
+      var pingTimestamp = performance.now();
       this.pongTimer = (0, _commonTimers.safeSetTimeout)(onPongNotReceived, this.pongTimeout);
       this.once('pong', scheduleNextPingAndCancelPongTimer);
       this.once('pong', confirmPongId);
-      this.logger.debug("socket: ping ".concat(id));
+      this.once('pong', function () {
+        return calculateLatency(pingTimestamp);
+      });
+      this.logger.debug("socket,".concat(this._domain, ": ping ").concat(id));
       return this.send({
         id: id,
         type: 'ping'
@@ -574,6 +500,5 @@ var Socket = /*#__PURE__*/function (_EventEmitter) {
   }]);
   return Socket;
 }(_events.EventEmitter);
-
 exports.default = Socket;
 //# sourceMappingURL=socket-base.js.map