@webex/internal-plugin-metrics 3.0.0-beta.40 → 3.0.0-beta.400

package/dist/new-metrics.js

@@ -0,0 +1,300 @@
+"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 _regenerator = _interopRequireDefault(require("@babel/runtime-corejs2/regenerator"));
+var _promise = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/promise"));
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/asyncToGenerator"));
+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 _defineProperty2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/defineProperty"));
+var _webexCore = require("@webex/webex-core");
+var _callDiagnosticMetrics = _interopRequireDefault(require("./call-diagnostic/call-diagnostic-metrics"));
+var _callDiagnosticMetricsLatencies = _interopRequireDefault(require("./call-diagnostic/call-diagnostic-metrics-latencies"));
+var _callDiagnosticMetrics2 = require("./call-diagnostic/call-diagnostic-metrics.util");
+var _utils = require("./utils");
+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; } }
+/**
+ * Metrics plugin to centralize all types of metrics.
+ * @class
+ */
+var Metrics = /*#__PURE__*/function (_WebexPlugin) {
+  (0, _inherits2.default)(Metrics, _WebexPlugin);
+  var _super = _createSuper(Metrics);
+  // eslint-disable-next-line no-use-before-define
+
+  // Call Diagnostic latencies
+
+  // Helper classes to handle the different types of metrics
+
+  /**
+   * Constructor
+   * @param args
+   * @constructor
+   * @private
+   * @returns
+   */
+  function Metrics() {
+    var _this;
+    (0, _classCallCheck2.default)(this, Metrics);
+    for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
+      args[_key] = arguments[_key];
+    }
+    _this = _super.call.apply(_super, [this].concat(args));
+
+    // @ts-ignore
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "callDiagnosticLatencies", void 0);
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "callDiagnosticMetrics", void 0);
+    _this.callDiagnosticLatencies = new _callDiagnosticMetricsLatencies.default({}, {
+      parent: _this.webex
+    });
+    _this.onReady();
+    return _this;
+  }
+
+  /**
+   * On Ready
+   */
+  (0, _createClass2.default)(Metrics, [{
+    key: "onReady",
+    value: function onReady() {
+      var _this2 = this;
+      // @ts-ignore
+      this.webex.once('ready', function () {
+        // @ts-ignore
+        _this2.callDiagnosticMetrics = new _callDiagnosticMetrics.default({}, {
+          parent: _this2.webex
+        });
+      });
+    }
+
+    /**
+     * Used for internal purposes only
+     * @param args
+     */
+  }, {
+    key: "submitInternalEvent",
+    value: function submitInternalEvent(_ref) {
+      var name = _ref.name,
+        payload = _ref.payload,
+        options = _ref.options;
+      if (name === 'internal.reset.join.latencies') {
+        this.callDiagnosticLatencies.clearTimestamps();
+      } else {
+        this.callDiagnosticLatencies.saveTimestamp({
+          key: name
+        });
+      }
+    }
+
+    /**
+     * Behavioral event
+     * @param args
+     */
+  }, {
+    key: "submitBehavioralEvent",
+    value: function submitBehavioralEvent(_ref2) {
+      var name = _ref2.name,
+        payload = _ref2.payload,
+        options = _ref2.options;
+      this.callDiagnosticLatencies.saveTimestamp({
+        key: name
+      });
+      throw new Error('Not implemented.');
+    }
+
+    /**
+     * Operational event
+     * @param args
+     */
+  }, {
+    key: "submitOperationalEvent",
+    value: function submitOperationalEvent(_ref3) {
+      var name = _ref3.name,
+        payload = _ref3.payload,
+        options = _ref3.options;
+      throw new Error('Not implemented.');
+    }
+
+    /**
+     * Call Analyzer: Media Quality Event
+     * @param args
+     */
+  }, {
+    key: "submitMQE",
+    value: function submitMQE(_ref4) {
+      var name = _ref4.name,
+        payload = _ref4.payload,
+        options = _ref4.options;
+      this.callDiagnosticLatencies.saveTimestamp({
+        key: name
+      });
+      this.callDiagnosticMetrics.submitMQE({
+        name: name,
+        payload: payload,
+        options: options
+      });
+    }
+
+    /**
+     * Call Analyzer: Feature Usage Event
+     * @param args
+     */
+  }, {
+    key: "submitFeatureEvent",
+    value: function submitFeatureEvent(_ref5) {
+      var name = _ref5.name,
+        payload = _ref5.payload,
+        options = _ref5.options;
+      throw new Error('Not implemented.');
+    }
+
+    /**
+     * Call Analyzer: Client Event
+     * @public
+     * @param args
+     */
+  }, {
+    key: "submitClientEvent",
+    value: function submitClientEvent(_ref6) {
+      var name = _ref6.name,
+        payload = _ref6.payload,
+        options = _ref6.options;
+      if (!this.callDiagnosticLatencies || !this.callDiagnosticMetrics) {
+        // @ts-ignore
+        this.webex.logger.log("NewMetrics: @submitClientEvent. Attempted to submit before webex.ready. Event name: ".concat(name));
+        return _promise.default.resolve();
+      }
+      this.callDiagnosticLatencies.saveTimestamp({
+        key: name,
+        options: {
+          meetingId: options === null || options === void 0 ? void 0 : options.meetingId
+        }
+      });
+      return this.callDiagnosticMetrics.submitClientEvent({
+        name: name,
+        payload: payload,
+        options: options
+      });
+    }
+
+    /**
+     * Issue request to alias a user's pre-login ID with their CI UUID
+     * @param {string} preLoginId
+     * @returns {Object} HttpResponse object
+     */
+  }, {
+    key: "clientMetricsAliasUser",
+    value: function clientMetricsAliasUser(preLoginId) {
+      var _this3 = this;
+      // @ts-ignore
+      return this.webex.request({
+        method: 'POST',
+        api: 'metrics',
+        resource: 'clientmetrics',
+        headers: {
+          'x-prelogin-userid': preLoginId
+        },
+        body: {},
+        qs: {
+          alias: true
+        }
+      }).then(function (res) {
+        // @ts-ignore
+        _this3.webex.logger.log("NewMetrics: @clientMetricsAliasUser. Request successful.");
+        return res;
+      }).catch(function (err) {
+        // @ts-ignore
+        _this3.logger.error("NewMetrics: @clientMetricsAliasUser. Request failed:", "err: ".concat((0, _utils.generateCommonErrorMetadata)(err)));
+        return _promise.default.reject(err);
+      });
+    }
+
+    /**
+     * Returns a promise that will resolve to fetch options for submitting a metric.
+     *
+     * This is to support quickly submitting metrics when the browser/tab is closing.
+     * Calling submitClientEvent will not work because there some async steps that will
+     * not complete before the browser is closed.  Instead, we pre-gather all the
+     * information/options needed for the request(s), and then simply and quickly
+     * fire the fetch(es) when beforeUnload is triggered.
+     *
+     * We must use fetch instead of request because fetch has a keepalive option that
+     * allows the request it to outlive the page.
+     *
+     * Note: the timings values will be wrong, but setMetricTimingsAndFetch() will
+     * properly adjust them before submitting.
+     *
+     * @public
+     * @param {Object} arg
+     * @param {String} arg.name - event name
+     * @param {Object} arg.payload - event payload
+     * @param {Object} arg.options - other options
+     * @returns {Promise} promise that resolves to options to be used with fetch
+     */
+  }, {
+    key: "buildClientEventFetchRequestOptions",
+    value: function () {
+      var _buildClientEventFetchRequestOptions = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(_ref7) {
+        var name, payload, options;
+        return _regenerator.default.wrap(function _callee$(_context) {
+          while (1) switch (_context.prev = _context.next) {
+            case 0:
+              name = _ref7.name, payload = _ref7.payload, options = _ref7.options;
+              return _context.abrupt("return", this.callDiagnosticMetrics.buildClientEventFetchRequestOptions({
+                name: name,
+                payload: payload,
+                options: options
+              }));
+            case 2:
+            case "end":
+              return _context.stop();
+          }
+        }, _callee, this);
+      }));
+      function buildClientEventFetchRequestOptions(_x) {
+        return _buildClientEventFetchRequestOptions.apply(this, arguments);
+      }
+      return buildClientEventFetchRequestOptions;
+    }()
+    /**
+     * Submits a metric from pre-built request options via the fetch API. Updates
+     * the "$timings" and "originTime" values to Date.now() since the existing times
+     * were set when the options were built (not submitted).
+      * @param {any} options - the pre-built request options for submitting a metric
+     * @returns {Promise} promise that resolves to the response object
+     */
+  }, {
+    key: "setMetricTimingsAndFetch",
+    value: function setMetricTimingsAndFetch(options) {
+      // @ts-ignore
+      return this.webex.setTimingsAndFetch((0, _callDiagnosticMetrics2.setMetricTimings)(options));
+    }
+
+    /**
+     * Returns true if the specified serviceErrorCode maps to an expected error.
+     * @param {number} serviceErrorCode the service error code
+     * @returns {boolean}
+     */
+  }, {
+    key: "isServiceErrorExpected",
+    value: function isServiceErrorExpected(serviceErrorCode) {
+      return this.callDiagnosticMetrics.isServiceErrorExpected(serviceErrorCode);
+    }
+  }]);
+  return Metrics;
+}(_webexCore.WebexPlugin);
+(0, _defineProperty2.default)(Metrics, "instance", void 0);
+var _default = Metrics;
+exports.default = _default;
+//# sourceMappingURL=new-metrics.js.map

package/dist/new-metrics.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["Metrics","args","callDiagnosticLatencies","CallDiagnosticLatencies","parent","webex","onReady","once","callDiagnosticMetrics","CallDiagnosticMetrics","name","payload","options","clearTimestamps","saveTimestamp","key","Error","submitMQE","logger","log","resolve","meetingId","submitClientEvent","preLoginId","request","method","api","resource","headers","body","qs","alias","then","res","catch","err","error","generateCommonErrorMetadata","reject","buildClientEventFetchRequestOptions","setTimingsAndFetch","setMetricTimings","serviceErrorCode","isServiceErrorExpected","WebexPlugin"],"sources":["new-metrics.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/no-unused-vars */\n/* eslint-disable class-methods-use-this */\n/* eslint-disable valid-jsdoc */\n\n// @ts-ignore\nimport {WebexPlugin} from '@webex/webex-core';\n\nimport CallDiagnosticMetrics from './call-diagnostic/call-diagnostic-metrics';\nimport {\n  RecursivePartial,\n  ClientEvent,\n  FeatureEvent,\n  BehavioralEvent,\n  OperationalEvent,\n  MediaQualityEvent,\n  InternalEvent,\n  SubmitClientEventOptions,\n} from './metrics.types';\nimport CallDiagnosticLatencies from './call-diagnostic/call-diagnostic-metrics-latencies';\nimport {setMetricTimings} from './call-diagnostic/call-diagnostic-metrics.util';\nimport {generateCommonErrorMetadata} from './utils';\n\n/**\n * Metrics plugin to centralize all types of metrics.\n * @class\n */\nclass Metrics extends WebexPlugin {\n  // eslint-disable-next-line no-use-before-define\n  static instance: Metrics;\n\n  // Call Diagnostic latencies\n  callDiagnosticLatencies: CallDiagnosticLatencies;\n  // Helper classes to handle the different types of metrics\n  callDiagnosticMetrics: CallDiagnosticMetrics;\n\n  /**\n   * Constructor\n   * @param args\n   * @constructor\n   * @private\n   * @returns\n   */\n  constructor(...args) {\n    super(...args);\n\n    // @ts-ignore\n    this.callDiagnosticLatencies = new CallDiagnosticLatencies({}, {parent: this.webex});\n    this.onReady();\n  }\n\n  /**\n   * On Ready\n   */\n  private onReady() {\n    // @ts-ignore\n    this.webex.once('ready', () => {\n      // @ts-ignore\n      this.callDiagnosticMetrics = new CallDiagnosticMetrics({}, {parent: this.webex});\n    });\n  }\n\n  /**\n   * Used for internal purposes only\n   * @param args\n   */\n  submitInternalEvent({\n    name,\n    payload,\n    options,\n  }: {\n    name: InternalEvent['name'];\n    payload?: RecursivePartial<InternalEvent['payload']>;\n    options?: any;\n  }) {\n    if (name === 'internal.reset.join.latencies') {\n      this.callDiagnosticLatencies.clearTimestamps();\n    } else {\n      this.callDiagnosticLatencies.saveTimestamp({key: name});\n    }\n  }\n\n  /**\n   * Behavioral event\n   * @param args\n   */\n  submitBehavioralEvent({\n    name,\n    payload,\n    options,\n  }: {\n    name: BehavioralEvent['name'];\n    payload?: RecursivePartial<BehavioralEvent['payload']>;\n    options?: any;\n  }) {\n    this.callDiagnosticLatencies.saveTimestamp({key: name});\n    throw new Error('Not implemented.');\n  }\n\n  /**\n   * Operational event\n   * @param args\n   */\n  submitOperationalEvent({\n    name,\n    payload,\n    options,\n  }: {\n    name: OperationalEvent['name'];\n    payload?: RecursivePartial<OperationalEvent['payload']>;\n    options?: any;\n  }) {\n    throw new Error('Not implemented.');\n  }\n\n  /**\n   * Call Analyzer: Media Quality Event\n   * @param args\n   */\n  submitMQE({\n    name,\n    payload,\n    options,\n  }: {\n    name: MediaQualityEvent['name'];\n    payload: RecursivePartial<MediaQualityEvent['payload']> & {\n      intervals: MediaQualityEvent['payload']['intervals'];\n    };\n    options: any;\n  }) {\n    this.callDiagnosticLatencies.saveTimestamp({key: name});\n    this.callDiagnosticMetrics.submitMQE({name, payload, options});\n  }\n\n  /**\n   * Call Analyzer: Feature Usage Event\n   * @param args\n   */\n  submitFeatureEvent({\n    name,\n    payload,\n    options,\n  }: {\n    name: FeatureEvent['name'];\n    payload?: RecursivePartial<FeatureEvent['payload']>;\n    options: any;\n  }) {\n    throw new Error('Not implemented.');\n  }\n\n  /**\n   * Call Analyzer: Client Event\n   * @public\n   * @param args\n   */\n  public submitClientEvent({\n    name,\n    payload,\n    options,\n  }: {\n    name: ClientEvent['name'];\n    payload?: RecursivePartial<ClientEvent['payload']>;\n    options?: SubmitClientEventOptions;\n  }): Promise<any> {\n    if (!this.callDiagnosticLatencies || !this.callDiagnosticMetrics) {\n      // @ts-ignore\n      this.webex.logger.log(\n        `NewMetrics: @submitClientEvent. Attempted to submit before webex.ready. Event name: ${name}`\n      );\n\n      return Promise.resolve();\n    }\n    this.callDiagnosticLatencies.saveTimestamp({\n      key: name,\n      options: {meetingId: options?.meetingId},\n    });\n\n    return this.callDiagnosticMetrics.submitClientEvent({name, payload, options});\n  }\n\n  /**\n   * Issue request to alias a user's pre-login ID with their CI UUID\n   * @param {string} preLoginId\n   * @returns {Object} HttpResponse object\n   */\n  public clientMetricsAliasUser(preLoginId: string) {\n    // @ts-ignore\n    return this.webex\n      .request({\n        method: 'POST',\n        api: 'metrics',\n        resource: 'clientmetrics',\n        headers: {\n          'x-prelogin-userid': preLoginId,\n        },\n        body: {},\n        qs: {\n          alias: true,\n        },\n      })\n      .then((res) => {\n        // @ts-ignore\n        this.webex.logger.log(`NewMetrics: @clientMetricsAliasUser. Request successful.`);\n\n        return res;\n      })\n      .catch((err) => {\n        // @ts-ignore\n        this.logger.error(\n          `NewMetrics: @clientMetricsAliasUser. Request failed:`,\n          `err: ${generateCommonErrorMetadata(err)}`\n        );\n\n        return Promise.reject(err);\n      });\n  }\n\n  /**\n   * Returns a promise that will resolve to fetch options for submitting a metric.\n   *\n   * This is to support quickly submitting metrics when the browser/tab is closing.\n   * Calling submitClientEvent will not work because there some async steps that will\n   * not complete before the browser is closed.  Instead, we pre-gather all the\n   * information/options needed for the request(s), and then simply and quickly\n   * fire the fetch(es) when beforeUnload is triggered.\n   *\n   * We must use fetch instead of request because fetch has a keepalive option that\n   * allows the request it to outlive the page.\n   *\n   * Note: the timings values will be wrong, but setMetricTimingsAndFetch() will\n   * properly adjust them before submitting.\n   *\n   * @public\n   * @param {Object} arg\n   * @param {String} arg.name - event name\n   * @param {Object} arg.payload - event payload\n   * @param {Object} arg.options - other options\n   * @returns {Promise} promise that resolves to options to be used with fetch\n   */\n  public async buildClientEventFetchRequestOptions({\n    name,\n    payload,\n    options,\n  }: {\n    name: ClientEvent['name'];\n    payload?: RecursivePartial<ClientEvent['payload']>;\n    options?: SubmitClientEventOptions;\n  }): Promise<any> {\n    return this.callDiagnosticMetrics.buildClientEventFetchRequestOptions({\n      name,\n      payload,\n      options,\n    });\n  }\n\n  /**\n   * Submits a metric from pre-built request options via the fetch API. Updates\n   * the \"$timings\" and \"originTime\" values to Date.now() since the existing times\n   * were set when the options were built (not submitted).\n\n   * @param {any} options - the pre-built request options for submitting a metric\n   * @returns {Promise} promise that resolves to the response object\n   */\n  public setMetricTimingsAndFetch(options: any): Promise<any> {\n    // @ts-ignore\n    return this.webex.setTimingsAndFetch(setMetricTimings(options));\n  }\n\n  /**\n   * Returns true if the specified serviceErrorCode maps to an expected error.\n   * @param {number} serviceErrorCode the service error code\n   * @returns {boolean}\n   */\n  public isServiceErrorExpected(serviceErrorCode: number): boolean {\n    return this.callDiagnosticMetrics.isServiceErrorExpected(serviceErrorCode);\n  }\n}\n\nexport default Metrics;\n"],"mappings":";;;;;;;;;;;;;;;;;;;AAKA;AAEA;AAWA;AACA;AACA;AAAoD;AAAA;AAEpD;AACA;AACA;AACA;AAHA,IAIMA,OAAO;EAAA;EAAA;EACX;;EAGA;;EAEA;;EAGA;AACF;AACA;AACA;AACA;AACA;AACA;EACE,mBAAqB;IAAA;IAAA;IAAA,kCAANC,IAAI;MAAJA,IAAI;IAAA;IACjB,gDAASA,IAAI;;IAEb;IAAA;IAAA;IACA,MAAKC,uBAAuB,GAAG,IAAIC,uCAAuB,CAAC,CAAC,CAAC,EAAE;MAACC,MAAM,EAAE,MAAKC;IAAK,CAAC,CAAC;IACpF,MAAKC,OAAO,EAAE;IAAC;EACjB;;EAEA;AACF;AACA;EAFE;IAAA;IAAA,OAGA,mBAAkB;MAAA;MAChB;MACA,IAAI,CAACD,KAAK,CAACE,IAAI,CAAC,OAAO,EAAE,YAAM;QAC7B;QACA,MAAI,CAACC,qBAAqB,GAAG,IAAIC,8BAAqB,CAAC,CAAC,CAAC,EAAE;UAACL,MAAM,EAAE,MAAI,CAACC;QAAK,CAAC,CAAC;MAClF,CAAC,CAAC;IACJ;;IAEA;AACF;AACA;AACA;EAHE;IAAA;IAAA,OAIA,mCAQG;MAAA,IAPDK,IAAI,QAAJA,IAAI;QACJC,OAAO,QAAPA,OAAO;QACPC,OAAO,QAAPA,OAAO;MAMP,IAAIF,IAAI,KAAK,+BAA+B,EAAE;QAC5C,IAAI,CAACR,uBAAuB,CAACW,eAAe,EAAE;MAChD,CAAC,MAAM;QACL,IAAI,CAACX,uBAAuB,CAACY,aAAa,CAAC;UAACC,GAAG,EAAEL;QAAI,CAAC,CAAC;MACzD;IACF;;IAEA;AACF;AACA;AACA;EAHE;IAAA;IAAA,OAIA,sCAQG;MAAA,IAPDA,IAAI,SAAJA,IAAI;QACJC,OAAO,SAAPA,OAAO;QACPC,OAAO,SAAPA,OAAO;MAMP,IAAI,CAACV,uBAAuB,CAACY,aAAa,CAAC;QAACC,GAAG,EAAEL;MAAI,CAAC,CAAC;MACvD,MAAM,IAAIM,KAAK,CAAC,kBAAkB,CAAC;IACrC;;IAEA;AACF;AACA;AACA;EAHE;IAAA;IAAA,OAIA,uCAQG;MAAA,IAPDN,IAAI,SAAJA,IAAI;QACJC,OAAO,SAAPA,OAAO;QACPC,OAAO,SAAPA,OAAO;MAMP,MAAM,IAAII,KAAK,CAAC,kBAAkB,CAAC;IACrC;;IAEA;AACF;AACA;AACA;EAHE;IAAA;IAAA,OAIA,0BAUG;MAAA,IATDN,IAAI,SAAJA,IAAI;QACJC,OAAO,SAAPA,OAAO;QACPC,OAAO,SAAPA,OAAO;MAQP,IAAI,CAACV,uBAAuB,CAACY,aAAa,CAAC;QAACC,GAAG,EAAEL;MAAI,CAAC,CAAC;MACvD,IAAI,CAACF,qBAAqB,CAACS,SAAS,CAAC;QAACP,IAAI,EAAJA,IAAI;QAAEC,OAAO,EAAPA,OAAO;QAAEC,OAAO,EAAPA;MAAO,CAAC,CAAC;IAChE;;IAEA;AACF;AACA;AACA;EAHE;IAAA;IAAA,OAIA,mCAQG;MAAA,IAPDF,IAAI,SAAJA,IAAI;QACJC,OAAO,SAAPA,OAAO;QACPC,OAAO,SAAPA,OAAO;MAMP,MAAM,IAAII,KAAK,CAAC,kBAAkB,CAAC;IACrC;;IAEA;AACF;AACA;AACA;AACA;EAJE;IAAA;IAAA,OAKA,kCAQiB;MAAA,IAPfN,IAAI,SAAJA,IAAI;QACJC,OAAO,SAAPA,OAAO;QACPC,OAAO,SAAPA,OAAO;MAMP,IAAI,CAAC,IAAI,CAACV,uBAAuB,IAAI,CAAC,IAAI,CAACM,qBAAqB,EAAE;QAChE;QACA,IAAI,CAACH,KAAK,CAACa,MAAM,CAACC,GAAG,+FACoET,IAAI,EAC5F;QAED,OAAO,iBAAQU,OAAO,EAAE;MAC1B;MACA,IAAI,CAAClB,uBAAuB,CAACY,aAAa,CAAC;QACzCC,GAAG,EAAEL,IAAI;QACTE,OAAO,EAAE;UAACS,SAAS,EAAET,OAAO,aAAPA,OAAO,uBAAPA,OAAO,CAAES;QAAS;MACzC,CAAC,CAAC;MAEF,OAAO,IAAI,CAACb,qBAAqB,CAACc,iBAAiB,CAAC;QAACZ,IAAI,EAAJA,IAAI;QAAEC,OAAO,EAAPA,OAAO;QAAEC,OAAO,EAAPA;MAAO,CAAC,CAAC;IAC/E;;IAEA;AACF;AACA;AACA;AACA;EAJE;IAAA;IAAA,OAKA,gCAA8BW,UAAkB,EAAE;MAAA;MAChD;MACA,OAAO,IAAI,CAAClB,KAAK,CACdmB,OAAO,CAAC;QACPC,MAAM,EAAE,MAAM;QACdC,GAAG,EAAE,SAAS;QACdC,QAAQ,EAAE,eAAe;QACzBC,OAAO,EAAE;UACP,mBAAmB,EAAEL;QACvB,CAAC;QACDM,IAAI,EAAE,CAAC,CAAC;QACRC,EAAE,EAAE;UACFC,KAAK,EAAE;QACT;MACF,CAAC,CAAC,CACDC,IAAI,CAAC,UAACC,GAAG,EAAK;QACb;QACA,MAAI,CAAC5B,KAAK,CAACa,MAAM,CAACC,GAAG,4DAA4D;QAEjF,OAAOc,GAAG;MACZ,CAAC,CAAC,CACDC,KAAK,CAAC,UAACC,GAAG,EAAK;QACd;QACA,MAAI,CAACjB,MAAM,CAACkB,KAAK,wEAEP,IAAAC,kCAA2B,EAACF,GAAG,CAAC,EACzC;QAED,OAAO,iBAAQG,MAAM,CAACH,GAAG,CAAC;MAC5B,CAAC,CAAC;IACN;;IAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EArBE;IAAA;IAAA;MAAA,mHAsBA;QAAA;QAAA;UAAA;YAAA;cACEzB,IAAI,SAAJA,IAAI,EACJC,OAAO,SAAPA,OAAO,EACPC,OAAO,SAAPA,OAAO;cAAA,iCAMA,IAAI,CAACJ,qBAAqB,CAAC+B,mCAAmC,CAAC;gBACpE7B,IAAI,EAAJA,IAAI;gBACJC,OAAO,EAAPA,OAAO;gBACPC,OAAO,EAAPA;cACF,CAAC,CAAC;YAAA;YAAA;cAAA;UAAA;QAAA;MAAA,CACH;MAAA;QAAA;MAAA;MAAA;IAAA;IAED;AACF;AACA;AACA;AACA;AACA;AACA;EANE;IAAA;IAAA,OAQA,kCAAgCA,OAAY,EAAgB;MAC1D;MACA,OAAO,IAAI,CAACP,KAAK,CAACmC,kBAAkB,CAAC,IAAAC,wCAAgB,EAAC7B,OAAO,CAAC,CAAC;IACjE;;IAEA;AACF;AACA;AACA;AACA;EAJE;IAAA;IAAA,OAKA,gCAA8B8B,gBAAwB,EAAW;MAC/D,OAAO,IAAI,CAAClC,qBAAqB,CAACmC,sBAAsB,CAACD,gBAAgB,CAAC;IAC5E;EAAC;EAAA;AAAA,EAxPmBE,sBAAW;AAAA,8BAA3B5C,OAAO;AAAA,eA2PEA,OAAO;AAAA"}

package/dist/prelogin-metrics-batcher.js

@@ -0,0 +1,82 @@
+"use strict";
+
+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 _uniqueId2 = _interopRequireDefault(require("lodash/uniqueId"));
+var _batcher = _interopRequireDefault(require("./batcher"));
+var _callDiagnosticMetrics = require("./call-diagnostic/call-diagnostic-metrics.util");
+var _utils = require("./utils");
+var PRE_LOGIN_METRICS_IDENTIFIER = 'Pre Login Metrics -->';
+var PreLoginMetricsBatcher = _batcher.default.extend({
+  namespace: 'Metrics',
+  preLoginId: undefined,
+  /**
+   * Save the pre-login ID.
+   * @param {string} preLoginId The pre-login ID to be saved.
+   * @returns {void}
+   */
+  savePreLoginId: function savePreLoginId(preLoginId) {
+    this.preLoginId = preLoginId;
+  },
+  /**
+   * Prepare item
+   * @param {any} item
+   * @returns {Promise<any>}
+   */
+  prepareItem: function prepareItem(item) {
+    return _promise.default.resolve((0, _callDiagnosticMetrics.prepareDiagnosticMetricItem)(this.webex, item));
+  },
+  /**
+   * Prepare request, add time sensitive date etc.
+   * @param {any[]} queue
+   * @returns {Promise<any[]>}
+   */
+  prepareRequest: function prepareRequest(queue) {
+    // Add sent timestamp
+    queue.forEach(function (item) {
+      item.eventPayload.originTime = item.eventPayload.originTime || {};
+      item.eventPayload.originTime.sent = new Date().toISOString();
+    });
+    return _promise.default.resolve(queue);
+  },
+  /**
+   *
+   * @param {any} payload
+   * @returns {Promise<any>}
+   */
+  submitHttpRequest: function submitHttpRequest(payload) {
+    var _this = this;
+    var batchId = (0, _uniqueId2.default)('prelogin-ca-batch-');
+    if (this.preLoginId === undefined) {
+      this.webex.logger.error(PRE_LOGIN_METRICS_IDENTIFIER, "PreLoginMetricsBatcher: @submitHttpRequest#".concat(batchId, ". PreLoginId is not set."));
+      return _promise.default.reject(new Error('PreLoginId is not set.'));
+    }
+    return this.webex.request({
+      method: 'POST',
+      service: 'metrics',
+      resource: 'clientmetrics-prelogin',
+      headers: {
+        authorization: false,
+        'x-prelogin-userid': this.preLoginId
+      },
+      body: {
+        metrics: payload
+      },
+      waitForServiceTimeout: this.webex.config.metrics.waitForServiceTimeout
+    }).then(function (res) {
+      _this.webex.logger.log(PRE_LOGIN_METRICS_IDENTIFIER, "PreLoginMetricsBatcher: @submitHttpRequest#".concat(batchId, ". Request successful."));
+      return res;
+    }).catch(function (err) {
+      _this.webex.logger.error(PRE_LOGIN_METRICS_IDENTIFIER, "PreLoginMetricsBatcher: @submitHttpRequest#".concat(batchId, ". Request failed:"), "error: ".concat((0, _utils.generateCommonErrorMetadata)(err)));
+      return _promise.default.reject(err);
+    });
+  }
+});
+var _default = PreLoginMetricsBatcher;
+exports.default = _default;
+//# sourceMappingURL=prelogin-metrics-batcher.js.map

package/dist/prelogin-metrics-batcher.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["PRE_LOGIN_METRICS_IDENTIFIER","PreLoginMetricsBatcher","Batcher","extend","namespace","preLoginId","undefined","savePreLoginId","prepareItem","item","resolve","prepareDiagnosticMetricItem","webex","prepareRequest","queue","forEach","eventPayload","originTime","sent","Date","toISOString","submitHttpRequest","payload","batchId","logger","error","reject","Error","request","method","service","resource","headers","authorization","body","metrics","waitForServiceTimeout","config","then","res","log","catch","err","generateCommonErrorMetadata"],"sources":["prelogin-metrics-batcher.ts"],"sourcesContent":["import {uniqueId} from 'lodash';\nimport Batcher from './batcher';\nimport {prepareDiagnosticMetricItem} from './call-diagnostic/call-diagnostic-metrics.util';\nimport {generateCommonErrorMetadata} from './utils';\n\nconst PRE_LOGIN_METRICS_IDENTIFIER = 'Pre Login Metrics -->';\n\nconst PreLoginMetricsBatcher = Batcher.extend({\n  namespace: 'Metrics',\n  preLoginId: undefined,\n\n  /**\n   * Save the pre-login ID.\n   * @param {string} preLoginId The pre-login ID to be saved.\n   * @returns {void}\n   */\n  savePreLoginId(preLoginId) {\n    this.preLoginId = preLoginId;\n  },\n\n  /**\n   * Prepare item\n   * @param {any} item\n   * @returns {Promise<any>}\n   */\n  prepareItem(item) {\n    return Promise.resolve(prepareDiagnosticMetricItem(this.webex, item));\n  },\n\n  /**\n   * Prepare request, add time sensitive date etc.\n   * @param {any[]} queue\n   * @returns {Promise<any[]>}\n   */\n  prepareRequest(queue) {\n    // Add sent timestamp\n    queue.forEach((item) => {\n      item.eventPayload.originTime = item.eventPayload.originTime || {};\n      item.eventPayload.originTime.sent = new Date().toISOString();\n    });\n\n    return Promise.resolve(queue);\n  },\n\n  /**\n   *\n   * @param {any} payload\n   * @returns {Promise<any>}\n   */\n  submitHttpRequest(payload: any) {\n    const batchId = uniqueId('prelogin-ca-batch-');\n    if (this.preLoginId === undefined) {\n      this.webex.logger.error(\n        PRE_LOGIN_METRICS_IDENTIFIER,\n        `PreLoginMetricsBatcher: @submitHttpRequest#${batchId}. PreLoginId is not set.`\n      );\n\n      return Promise.reject(new Error('PreLoginId is not set.'));\n    }\n\n    return this.webex\n      .request({\n        method: 'POST',\n        service: 'metrics',\n        resource: 'clientmetrics-prelogin',\n        headers: {\n          authorization: false,\n          'x-prelogin-userid': this.preLoginId,\n        },\n        body: {\n          metrics: payload,\n        },\n        waitForServiceTimeout: this.webex.config.metrics.waitForServiceTimeout,\n      })\n      .then((res) => {\n        this.webex.logger.log(\n          PRE_LOGIN_METRICS_IDENTIFIER,\n          `PreLoginMetricsBatcher: @submitHttpRequest#${batchId}. Request successful.`\n        );\n\n        return res;\n      })\n      .catch((err) => {\n        this.webex.logger.error(\n          PRE_LOGIN_METRICS_IDENTIFIER,\n          `PreLoginMetricsBatcher: @submitHttpRequest#${batchId}. Request failed:`,\n          `error: ${generateCommonErrorMetadata(err)}`\n        );\n\n        return Promise.reject(err);\n      });\n  },\n});\n\nexport default PreLoginMetricsBatcher;\n"],"mappings":";;;;;;;;;;AACA;AACA;AACA;AAEA,IAAMA,4BAA4B,GAAG,uBAAuB;AAE5D,IAAMC,sBAAsB,GAAGC,gBAAO,CAACC,MAAM,CAAC;EAC5CC,SAAS,EAAE,SAAS;EACpBC,UAAU,EAAEC,SAAS;EAErB;AACF;AACA;AACA;AACA;EACEC,cAAc,0BAACF,UAAU,EAAE;IACzB,IAAI,CAACA,UAAU,GAAGA,UAAU;EAC9B,CAAC;EAED;AACF;AACA;AACA;AACA;EACEG,WAAW,uBAACC,IAAI,EAAE;IAChB,OAAO,iBAAQC,OAAO,CAAC,IAAAC,kDAA2B,EAAC,IAAI,CAACC,KAAK,EAAEH,IAAI,CAAC,CAAC;EACvE,CAAC;EAED;AACF;AACA;AACA;AACA;EACEI,cAAc,0BAACC,KAAK,EAAE;IACpB;IACAA,KAAK,CAACC,OAAO,CAAC,UAACN,IAAI,EAAK;MACtBA,IAAI,CAACO,YAAY,CAACC,UAAU,GAAGR,IAAI,CAACO,YAAY,CAACC,UAAU,IAAI,CAAC,CAAC;MACjER,IAAI,CAACO,YAAY,CAACC,UAAU,CAACC,IAAI,GAAG,IAAIC,IAAI,EAAE,CAACC,WAAW,EAAE;IAC9D,CAAC,CAAC;IAEF,OAAO,iBAAQV,OAAO,CAACI,KAAK,CAAC;EAC/B,CAAC;EAED;AACF;AACA;AACA;AACA;EACEO,iBAAiB,6BAACC,OAAY,EAAE;IAAA;IAC9B,IAAMC,OAAO,GAAG,wBAAS,oBAAoB,CAAC;IAC9C,IAAI,IAAI,CAAClB,UAAU,KAAKC,SAAS,EAAE;MACjC,IAAI,CAACM,KAAK,CAACY,MAAM,CAACC,KAAK,CACrBzB,4BAA4B,uDACkBuB,OAAO,8BACtD;MAED,OAAO,iBAAQG,MAAM,CAAC,IAAIC,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAC5D;IAEA,OAAO,IAAI,CAACf,KAAK,CACdgB,OAAO,CAAC;MACPC,MAAM,EAAE,MAAM;MACdC,OAAO,EAAE,SAAS;MAClBC,QAAQ,EAAE,wBAAwB;MAClCC,OAAO,EAAE;QACPC,aAAa,EAAE,KAAK;QACpB,mBAAmB,EAAE,IAAI,CAAC5B;MAC5B,CAAC;MACD6B,IAAI,EAAE;QACJC,OAAO,EAAEb;MACX,CAAC;MACDc,qBAAqB,EAAE,IAAI,CAACxB,KAAK,CAACyB,MAAM,CAACF,OAAO,CAACC;IACnD,CAAC,CAAC,CACDE,IAAI,CAAC,UAACC,GAAG,EAAK;MACb,KAAI,CAAC3B,KAAK,CAACY,MAAM,CAACgB,GAAG,CACnBxC,4BAA4B,uDACkBuB,OAAO,2BACtD;MAED,OAAOgB,GAAG;IACZ,CAAC,CAAC,CACDE,KAAK,CAAC,UAACC,GAAG,EAAK;MACd,KAAI,CAAC9B,KAAK,CAACY,MAAM,CAACC,KAAK,CACrBzB,4BAA4B,uDACkBuB,OAAO,yCAC3C,IAAAoB,kCAA2B,EAACD,GAAG,CAAC,EAC3C;MAED,OAAO,iBAAQhB,MAAM,CAACgB,GAAG,CAAC;IAC5B,CAAC,CAAC;EACN;AACF,CAAC,CAAC;AAAC,eAEYzC,sBAAsB;AAAA"}

package/dist/types/batcher.d.ts

@@ -0,0 +1,7 @@
+export default MetricsBatcher;
+/**
+ * @class
+ * @extends Batcher
+ * @memberof Metrics
+ */
+declare const MetricsBatcher: any;

package/dist/types/call-diagnostic/call-diagnostic-metrics-batcher.d.ts

@@ -0,0 +1,2 @@
+declare const CallDiagnosticEventsBatcher: any;
+export default CallDiagnosticEventsBatcher;

package/dist/types/call-diagnostic/call-diagnostic-metrics-latencies.d.ts

@@ -0,0 +1,218 @@
+import { WebexPlugin } from '@webex/webex-core';
+import { MetricEventNames, PreComputedLatencies } from '../metrics.types';
+/**
+ * @description Helper class to store latencies timestamp and to calculate various latencies for CA.
+ * @exports
+ * @class CallDiagnosticLatencies
+ */
+export default class CallDiagnosticLatencies extends WebexPlugin {
+    latencyTimestamps: Map<MetricEventNames, number>;
+    precomputedLatencies: Map<PreComputedLatencies, number>;
+    private meetingId?;
+    /**
+     * @constructor
+     */
+    constructor(...args: any[]);
+    /**
+     * Clear timestamps
+     */
+    clearTimestamps(): void;
+    /**
+     * Associate current latencies with a meeting id
+     * @param meetingId
+     */
+    private setMeetingId;
+    /**
+     * Returns the meeting object associated with current latencies
+     * @returns meeting object
+     */
+    private getMeeting;
+    /**
+     * Store timestamp value
+     * @param key - key
+     * @param value -value
+     * @throws
+     * @returns
+     */
+    saveTimestamp({ key, value, options, }: {
+        key: MetricEventNames;
+        value?: number;
+        options?: {
+            meetingId?: string;
+        };
+    }): void;
+    /**
+     * Store precomputed latency value
+     * @param key - key
+     * @param value - value
+     * @param overwrite - overwrite existing value or add it
+     * @throws
+     * @returns
+     */
+    saveLatency(key: PreComputedLatencies, value: number, overwrite?: boolean): void;
+    /**
+     * Measure latency for a request
+     * @param key - key
+     * @param callback - callback for which you would like to measure latency
+     * @param overwrite - overwite existing value or add to it
+     * @returns
+     */
+    measureLatency(callback: () => Promise<any>, key: PreComputedLatencies, overwrite?: boolean): Promise<any>;
+    /**
+     * Store only the first timestamp value for the given key
+     * @param key - key
+     * @param  value -value
+     * @throws
+     * @returns
+     */
+    saveFirstTimestampOnly(key: MetricEventNames, value?: number): void;
+    /**
+     * Helper to calculate end - start
+     * @param a start
+     * @param b end
+     * @returns latency
+     */
+    getDiffBetweenTimestamps(a: MetricEventNames, b: MetricEventNames): number;
+    /**
+     * Meeting Info Request
+     * @note Meeting Info request happen not just in the join phase. CA requires
+     * metrics around meeting info request that are only part of join phase.
+     * This internal.* event is used to track the real timestamps
+     * (when the actual request/response happen). This is because the actual CA event is
+     * sent inside the join method on the meeting object based on some logic, but that's not exactly when
+     * those events are actually fired. The logic only confirms that they have happened, and we send them over.
+     * @returns - latency
+     */
+    getMeetingInfoReqResp(): number;
+    /**
+     * Interstitial Time
+     * @returns - latency
+     */
+    getShowInterstitialTime(): number;
+    /**
+     * getU2CTime
+     * @returns - latency
+     */
+    getU2CTime(): number;
+    /**
+     * Device Register Time
+     * @returns - latency
+     */
+    getRegisterWDMDeviceJMT(): number;
+    /**
+     * Call Init Join Request
+     * @returns - latency
+     */
+    getCallInitJoinReq(): number;
+    /**
+     * Locus Join Request
+     * @returns - latency
+     */
+    getJoinReqResp(): number;
+    /**
+     * Time taken to do turn discovery
+     * @returns - latency
+     */
+    getTurnDiscoveryTime(): number;
+    /**
+     * Local SDP Generated Remote SDP REceived
+     * @returns - latency
+     */
+    getLocalSDPGenRemoteSDPRecv(): number;
+    /**
+     * ICE Setup Time
+     * @returns - latency
+     */
+    getICESetupTime(): number;
+    /**
+     * Audio ICE time
+     * @returns - latency
+     */
+    getAudioICESetupTime(): number;
+    /**
+     * Video ICE Time
+     * @returns - latency
+     */
+    getVideoICESetupTime(): number;
+    /**
+     * Share ICE Time
+     * @returns - latency
+     */
+    getShareICESetupTime(): number;
+    /**
+     * Stay Lobby Time
+     * @returns - latency
+     */
+    getStayLobbyTime(): number;
+    /**
+     * Page JMT
+     * @returns - latency
+     */
+    getPageJMT(): number;
+    /**
+     * Download Time JMT
+     * @returns - latency
+     */
+    getDownloadTimeJMT(): number;
+    /**
+     * Click To Interstitial
+     * @returns - latency
+     */
+    getClickToInterstitial(): number;
+    /**
+     * Interstitial To Join Ok
+     * @returns - latency
+     */
+    getInterstitialToJoinOK(): number;
+    /**
+     * Call Init To MediaEngineReady
+     * @returns - latency
+     */
+    getCallInitMediaEngineReady(): number;
+    /**
+     * Interstitial To Media Ok
+     * @returns - latency
+     */
+    getInterstitialToMediaOKJMT(): number;
+    /**
+     * Total JMT
+     * @returns - latency
+     */
+    getTotalJMT(): number;
+    /**
+     * Join Conf JMT
+     * @returns - latency
+     */
+    getJoinConfJMT(): number;
+    /**
+     * Total Media JMT
+     * @returns - latency
+     */
+    getTotalMediaJMT(): number;
+    /**
+     * Client JMT
+     * @returns - latency
+     */
+    getClientJMT(): number;
+    /**
+     * Audio setup delay receive
+     */
+    getAudioJoinRespRxStart(): number;
+    /**
+     * Video setup delay receive
+     */
+    getVideoJoinRespRxStart(): number;
+    /**
+     * Audio setup delay transmit
+     */
+    getAudioJoinRespTxStart(): number;
+    /**
+     * Video setup delay transmit
+     */
+    getVideoJoinRespTxStart(): number;
+    /**
+     * Total latency for all other app api requests.
+     * Excludes meeting info, because it's measured separately.
+     */
+    getOtherAppApiReqResp(): number;
+}