@webex/internal-plugin-metrics 3.0.0-beta.233 → 3.0.0-beta.234

package/dist/metrics.js

@@ -161,7 +161,7 @@ var Metrics = _webexCore.WebexPlugin.extend({
       });
     });
   },
-  version: "3.0.0-beta.233"
+  version: "3.0.0-beta.234"
 });
 var _default = Metrics;
 exports.default = _default;

package/dist/new-metrics.js

@@ -8,8 +8,8 @@ _Object$defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 var _regenerator = _interopRequireDefault(require("@babel/runtime-corejs2/regenerator"));
-var _stringify = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/json/stringify"));
 var _promise = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/promise"));
+var _stringify = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/json/stringify"));
 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"));
@@ -170,6 +170,11 @@ var Metrics = /*#__PURE__*/function (_WebexPlugin) {
       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: {

package/dist/new-metrics.js.map

@@ -1 +1 @@
-{"version":3,"names":["Metrics","args","onReady","webex","once","callDiagnosticMetrics","CallDiagnosticMetrics","parent","callDiagnosticLatencies","CallDiagnosticLatencies","name","payload","options","clearTimestamps","saveTimestamp","key","Error","submitMQE","meetingId","submitClientEvent","preLoginId","request","method","api","resource","headers","authorization","body","metrics","then","res","logger","log","catch","err","error","generateCommonErrorMetadata","reject","qs","alias","buildClientEventFetchRequestOptions","setTimingsAndFetch","setMetricTimings","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    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      // @ts-ignore\n      this.callDiagnosticLatencies = new CallDiagnosticLatencies({}, {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    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   * Submit a pre-login metric to clientmetrics\n   * @public\n   * @param payload\n   * @param preLoginId - pre-login ID of user\n   * @returns\n   */\n  public postPreLoginMetric(payload: any, preLoginId: string): Promise<any> {\n    // @ts-ignore\n    return this.webex\n      .request({\n        method: 'POST',\n        api: 'metrics',\n        resource: 'clientmetrics-prelogin',\n        headers: {\n          authorization: false,\n          'x-prelogin-userid': preLoginId,\n        },\n        body: {\n          metrics: [payload],\n        },\n      })\n      .then((res) => {\n        // @ts-ignore\n        this.webex.logger.log(\n          `NewMetrics: @postPreLoginMetric. Request successful:`,\n          `res: ${JSON.stringify(res)}`\n        );\n\n        return res;\n      })\n      .catch((err) => {\n        // @ts-ignore\n        this.logger.error(\n          `NewMetrics: @postPreLoginMetric. Request failed:`,\n          `err: ${generateCommonErrorMetadata(err)}`\n        );\n\n        return Promise.reject(err);\n      });\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(\n          `NewMetrics: @clientMetricsAliasUser. Request successful:`,\n          `res: ${JSON.stringify(res)}`\n        );\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\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;IAAE;IAAA;IAEf,MAAKC,OAAO,EAAE;IAAC;EACjB;;EAEA;AACF;AACA;EAFE;IAAA;IAAA,OAGA,mBAAkB;MAAA;MAChB;MACA,IAAI,CAACC,KAAK,CAACC,IAAI,CAAC,OAAO,EAAE,YAAM;QAC7B;QACA,MAAI,CAACC,qBAAqB,GAAG,IAAIC,8BAAqB,CAAC,CAAC,CAAC,EAAE;UAACC,MAAM,EAAE,MAAI,CAACJ;QAAK,CAAC,CAAC;QAChF;QACA,MAAI,CAACK,uBAAuB,GAAG,IAAIC,uCAAuB,CAAC,CAAC,CAAC,EAAE;UAACF,MAAM,EAAE,MAAI,CAACJ;QAAK,CAAC,CAAC;MACtF,CAAC,CAAC;IACJ;;IAEA;AACF;AACA;AACA;EAHE;IAAA;IAAA,OAIA,mCAQG;MAAA,IAPDO,IAAI,QAAJA,IAAI;QACJC,OAAO,QAAPA,OAAO;QACPC,OAAO,QAAPA,OAAO;MAMP,IAAIF,IAAI,KAAK,+BAA+B,EAAE;QAC5C,IAAI,CAACF,uBAAuB,CAACK,eAAe,EAAE;MAChD,CAAC,MAAM;QACL,IAAI,CAACL,uBAAuB,CAACM,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,CAACJ,uBAAuB,CAACM,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,CAACJ,uBAAuB,CAACM,aAAa,CAAC;QAACC,GAAG,EAAEL;MAAI,CAAC,CAAC;MACvD,IAAI,CAACL,qBAAqB,CAACY,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,CAACJ,uBAAuB,CAACM,aAAa,CAAC;QACzCC,GAAG,EAAEL,IAAI;QACTE,OAAO,EAAE;UAACM,SAAS,EAAEN,OAAO,aAAPA,OAAO,uBAAPA,OAAO,CAAEM;QAAS;MACzC,CAAC,CAAC;MAEF,OAAO,IAAI,CAACb,qBAAqB,CAACc,iBAAiB,CAAC;QAACT,IAAI,EAAJA,IAAI;QAAEC,OAAO,EAAPA,OAAO;QAAEC,OAAO,EAAPA;MAAO,CAAC,CAAC;IAC/E;;IAEA;AACF;AACA;AACA;AACA;AACA;AACA;EANE;IAAA;IAAA,OAOA,4BAA0BD,OAAY,EAAES,UAAkB,EAAgB;MAAA;MACxE;MACA,OAAO,IAAI,CAACjB,KAAK,CACdkB,OAAO,CAAC;QACPC,MAAM,EAAE,MAAM;QACdC,GAAG,EAAE,SAAS;QACdC,QAAQ,EAAE,wBAAwB;QAClCC,OAAO,EAAE;UACPC,aAAa,EAAE,KAAK;UACpB,mBAAmB,EAAEN;QACvB,CAAC;QACDO,IAAI,EAAE;UACJC,OAAO,EAAE,CAACjB,OAAO;QACnB;MACF,CAAC,CAAC,CACDkB,IAAI,CAAC,UAACC,GAAG,EAAK;QACb;QACA,MAAI,CAAC3B,KAAK,CAAC4B,MAAM,CAACC,GAAG,wEAEX,wBAAeF,GAAG,CAAC,EAC5B;QAED,OAAOA,GAAG;MACZ,CAAC,CAAC,CACDG,KAAK,CAAC,UAACC,GAAG,EAAK;QACd;QACA,MAAI,CAACH,MAAM,CAACI,KAAK,oEAEP,IAAAC,kCAA2B,EAACF,GAAG,CAAC,EACzC;QAED,OAAO,iBAAQG,MAAM,CAACH,GAAG,CAAC;MAC5B,CAAC,CAAC;IACN;;IAEA;AACF;AACA;AACA;AACA;EAJE;IAAA;IAAA,OAKA,gCAA8Bd,UAAkB,EAAE;MAAA;MAChD;MACA,OAAO,IAAI,CAACjB,KAAK,CACdkB,OAAO,CAAC;QACPC,MAAM,EAAE,MAAM;QACdC,GAAG,EAAE,SAAS;QACdC,QAAQ,EAAE,eAAe;QACzBC,OAAO,EAAE;UACP,mBAAmB,EAAEL;QACvB,CAAC;QACDO,IAAI,EAAE,CAAC,CAAC;QACRW,EAAE,EAAE;UACFC,KAAK,EAAE;QACT;MACF,CAAC,CAAC,CACDV,IAAI,CAAC,UAACC,GAAG,EAAK;QACb;QACA,MAAI,CAAC3B,KAAK,CAAC4B,MAAM,CAACC,GAAG,4EAEX,wBAAeF,GAAG,CAAC,EAC5B;QAED,OAAOA,GAAG;MACZ,CAAC,CAAC,CACDG,KAAK,CAAC,UAACC,GAAG,EAAK;QACd;QACA,MAAI,CAACH,MAAM,CAACI,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;cACExB,IAAI,SAAJA,IAAI,EACJC,OAAO,SAAPA,OAAO,EACPC,OAAO,SAAPA,OAAO;cAAA,iCAMA,IAAI,CAACP,qBAAqB,CAACmC,mCAAmC,CAAC;gBACpE9B,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,CAACT,KAAK,CAACsC,kBAAkB,CAAC,IAAAC,wCAAgB,EAAC9B,OAAO,CAAC,CAAC;IACjE;EAAC;EAAA;AAAA,EApRmB+B,sBAAW;AAAA,8BAA3B3C,OAAO;AAAA,eAuREA,OAAO;AAAA"}
+{"version":3,"names":["Metrics","args","onReady","webex","once","callDiagnosticMetrics","CallDiagnosticMetrics","parent","callDiagnosticLatencies","CallDiagnosticLatencies","name","payload","options","clearTimestamps","saveTimestamp","key","Error","submitMQE","logger","log","resolve","meetingId","submitClientEvent","preLoginId","request","method","api","resource","headers","authorization","body","metrics","then","res","catch","err","error","generateCommonErrorMetadata","reject","qs","alias","buildClientEventFetchRequestOptions","setTimingsAndFetch","setMetricTimings","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    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      // @ts-ignore\n      this.callDiagnosticLatencies = new CallDiagnosticLatencies({}, {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   * Submit a pre-login metric to clientmetrics\n   * @public\n   * @param payload\n   * @param preLoginId - pre-login ID of user\n   * @returns\n   */\n  public postPreLoginMetric(payload: any, preLoginId: string): Promise<any> {\n    // @ts-ignore\n    return this.webex\n      .request({\n        method: 'POST',\n        api: 'metrics',\n        resource: 'clientmetrics-prelogin',\n        headers: {\n          authorization: false,\n          'x-prelogin-userid': preLoginId,\n        },\n        body: {\n          metrics: [payload],\n        },\n      })\n      .then((res) => {\n        // @ts-ignore\n        this.webex.logger.log(\n          `NewMetrics: @postPreLoginMetric. Request successful:`,\n          `res: ${JSON.stringify(res)}`\n        );\n\n        return res;\n      })\n      .catch((err) => {\n        // @ts-ignore\n        this.logger.error(\n          `NewMetrics: @postPreLoginMetric. Request failed:`,\n          `err: ${generateCommonErrorMetadata(err)}`\n        );\n\n        return Promise.reject(err);\n      });\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(\n          `NewMetrics: @clientMetricsAliasUser. Request successful:`,\n          `res: ${JSON.stringify(res)}`\n        );\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\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;IAAE;IAAA;IAEf,MAAKC,OAAO,EAAE;IAAC;EACjB;;EAEA;AACF;AACA;EAFE;IAAA;IAAA,OAGA,mBAAkB;MAAA;MAChB;MACA,IAAI,CAACC,KAAK,CAACC,IAAI,CAAC,OAAO,EAAE,YAAM;QAC7B;QACA,MAAI,CAACC,qBAAqB,GAAG,IAAIC,8BAAqB,CAAC,CAAC,CAAC,EAAE;UAACC,MAAM,EAAE,MAAI,CAACJ;QAAK,CAAC,CAAC;QAChF;QACA,MAAI,CAACK,uBAAuB,GAAG,IAAIC,uCAAuB,CAAC,CAAC,CAAC,EAAE;UAACF,MAAM,EAAE,MAAI,CAACJ;QAAK,CAAC,CAAC;MACtF,CAAC,CAAC;IACJ;;IAEA;AACF;AACA;AACA;EAHE;IAAA;IAAA,OAIA,mCAQG;MAAA,IAPDO,IAAI,QAAJA,IAAI;QACJC,OAAO,QAAPA,OAAO;QACPC,OAAO,QAAPA,OAAO;MAMP,IAAIF,IAAI,KAAK,+BAA+B,EAAE;QAC5C,IAAI,CAACF,uBAAuB,CAACK,eAAe,EAAE;MAChD,CAAC,MAAM;QACL,IAAI,CAACL,uBAAuB,CAACM,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,CAACJ,uBAAuB,CAACM,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,CAACJ,uBAAuB,CAACM,aAAa,CAAC;QAACC,GAAG,EAAEL;MAAI,CAAC,CAAC;MACvD,IAAI,CAACL,qBAAqB,CAACY,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,CAACJ,uBAAuB,IAAI,CAAC,IAAI,CAACH,qBAAqB,EAAE;QAChE;QACA,IAAI,CAACF,KAAK,CAACe,MAAM,CAACC,GAAG,+FACoET,IAAI,EAC5F;QAED,OAAO,iBAAQU,OAAO,EAAE;MAC1B;MACA,IAAI,CAACZ,uBAAuB,CAACM,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,CAAChB,qBAAqB,CAACiB,iBAAiB,CAAC;QAACZ,IAAI,EAAJA,IAAI;QAAEC,OAAO,EAAPA,OAAO;QAAEC,OAAO,EAAPA;MAAO,CAAC,CAAC;IAC/E;;IAEA;AACF;AACA;AACA;AACA;AACA;AACA;EANE;IAAA;IAAA,OAOA,4BAA0BD,OAAY,EAAEY,UAAkB,EAAgB;MAAA;MACxE;MACA,OAAO,IAAI,CAACpB,KAAK,CACdqB,OAAO,CAAC;QACPC,MAAM,EAAE,MAAM;QACdC,GAAG,EAAE,SAAS;QACdC,QAAQ,EAAE,wBAAwB;QAClCC,OAAO,EAAE;UACPC,aAAa,EAAE,KAAK;UACpB,mBAAmB,EAAEN;QACvB,CAAC;QACDO,IAAI,EAAE;UACJC,OAAO,EAAE,CAACpB,OAAO;QACnB;MACF,CAAC,CAAC,CACDqB,IAAI,CAAC,UAACC,GAAG,EAAK;QACb;QACA,MAAI,CAAC9B,KAAK,CAACe,MAAM,CAACC,GAAG,wEAEX,wBAAec,GAAG,CAAC,EAC5B;QAED,OAAOA,GAAG;MACZ,CAAC,CAAC,CACDC,KAAK,CAAC,UAACC,GAAG,EAAK;QACd;QACA,MAAI,CAACjB,MAAM,CAACkB,KAAK,oEAEP,IAAAC,kCAA2B,EAACF,GAAG,CAAC,EACzC;QAED,OAAO,iBAAQG,MAAM,CAACH,GAAG,CAAC;MAC5B,CAAC,CAAC;IACN;;IAEA;AACF;AACA;AACA;AACA;EAJE;IAAA;IAAA,OAKA,gCAA8BZ,UAAkB,EAAE;MAAA;MAChD;MACA,OAAO,IAAI,CAACpB,KAAK,CACdqB,OAAO,CAAC;QACPC,MAAM,EAAE,MAAM;QACdC,GAAG,EAAE,SAAS;QACdC,QAAQ,EAAE,eAAe;QACzBC,OAAO,EAAE;UACP,mBAAmB,EAAEL;QACvB,CAAC;QACDO,IAAI,EAAE,CAAC,CAAC;QACRS,EAAE,EAAE;UACFC,KAAK,EAAE;QACT;MACF,CAAC,CAAC,CACDR,IAAI,CAAC,UAACC,GAAG,EAAK;QACb;QACA,MAAI,CAAC9B,KAAK,CAACe,MAAM,CAACC,GAAG,4EAEX,wBAAec,GAAG,CAAC,EAC5B;QAED,OAAOA,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,CAACP,qBAAqB,CAACoC,mCAAmC,CAAC;gBACpE/B,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,CAACT,KAAK,CAACuC,kBAAkB,CAAC,IAAAC,wCAAgB,EAAC/B,OAAO,CAAC,CAAC;IACjE;EAAC;EAAA;AAAA,EA5RmBgC,sBAAW;AAAA,8BAA3B5C,OAAO;AAAA,eA+REA,OAAO;AAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webex/internal-plugin-metrics",
-  "version": "3.0.0-beta.233",
+  "version": "3.0.0-beta.234",
   "description": "",
   "license": "MIT",
   "main": "dist/index.js",
@@ -29,12 +29,12 @@
     "build": "yarn run -T tsc --declaration true --declarationDir ./dist/types"
   },
   "dependencies": {
-    "@webex/common": "3.0.0-beta.233",
-    "@webex/common-timers": "3.0.0-beta.233",
-    "@webex/internal-plugin-device": "3.0.0-beta.233",
-    "@webex/internal-plugin-metrics": "3.0.0-beta.233",
-    "@webex/test-helper-chai": "3.0.0-beta.233",
-    "@webex/test-helper-mock-webex": "3.0.0-beta.233",
-    "@webex/webex-core": "3.0.0-beta.233"
+    "@webex/common": "3.0.0-beta.234",
+    "@webex/common-timers": "3.0.0-beta.234",
+    "@webex/internal-plugin-device": "3.0.0-beta.234",
+    "@webex/internal-plugin-metrics": "3.0.0-beta.234",
+    "@webex/test-helper-chai": "3.0.0-beta.234",
+    "@webex/test-helper-mock-webex": "3.0.0-beta.234",
+    "@webex/webex-core": "3.0.0-beta.234"
   }
 }

package/src/new-metrics.ts

@@ -161,6 +161,14 @@ class Metrics extends WebexPlugin {
     payload?: RecursivePartial<ClientEvent['payload']>;
     options?: SubmitClientEventOptions;
   }): Promise<any> {
+    if (!this.callDiagnosticLatencies || !this.callDiagnosticMetrics) {
+      // @ts-ignore
+      this.webex.logger.log(
+        `NewMetrics: @submitClientEvent. Attempted to submit before webex.ready. Event name: ${name}`
+      );
+
+      return Promise.resolve();
+    }
     this.callDiagnosticLatencies.saveTimestamp({
       key: name,
       options: {meetingId: options?.meetingId},

package/test/unit/spec/new-metrics.ts

@@ -5,6 +5,40 @@ import sinon from 'sinon';
 import {Utils} from '@webex/internal-plugin-metrics';
 
 describe('internal-plugin-metrics', () => {
+
+  describe('check submitClientEvent when webex is not ready', () => {
+    let webex;
+    //@ts-ignore
+    webex = new MockWebex({
+      children: {
+        newMetrics: NewMetrics,
+      },
+      meetings: {
+        meetingCollection: {
+          get: sinon.stub(),
+        },
+      },
+      request: sinon.stub().resolves({}),
+      logger: {
+        log: sinon.stub(),
+        error: sinon.stub(),
+      }
+    });
+
+    it('checks the log', () => {
+      webex.internal.newMetrics.submitClientEvent({
+        name: 'client.alert.displayed',
+        options: {
+          meetingId: '123',
+        },
+      });
+      assert.calledWith(
+        webex.logger.log,
+        'NewMetrics: @submitClientEvent. Attempted to submit before webex.ready. Event name: client.alert.displayed'
+      );
+    });
+  });
+  
   describe('new-metrics', () => {
     let webex;
 
@@ -62,6 +96,7 @@ describe('internal-plugin-metrics', () => {
       });
     });
 
+
     it('submits MQE successfully', () => {
       webex.internal.newMetrics.submitMQE({
         name: 'client.mediaquality.event',