@webex/internal-plugin-metrics 3.0.0-beta.373 → 3.0.0-beta.375

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","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","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    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(`NewMetrics: @postPreLoginMetric. Request successful.`);\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(`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;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,wDAAwD;QAE7E,OAAOc,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,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,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;;IAEA;AACF;AACA;AACA;AACA;EAJE;IAAA;IAAA,OAKA,gCAA8BgC,gBAAwB,EAAW;MAC/D,OAAO,IAAI,CAACvC,qBAAqB,CAACwC,sBAAsB,CAACD,gBAAgB,CAAC;IAC5E;EAAC;EAAA;AAAA,EA/RmBE,sBAAW;AAAA,8BAA3B9C,OAAO;AAAA,eAkSEA,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","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    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   * 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;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;EAJE;IAAA;IAAA,OAKA,gCAA8BW,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;QACDM,IAAI,EAAE,CAAC,CAAC;QACRC,EAAE,EAAE;UACFC,KAAK,EAAE;QACT;MACF,CAAC,CAAC,CACDC,IAAI,CAAC,UAACC,GAAG,EAAK;QACb;QACA,MAAI,CAAC9B,KAAK,CAACe,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,CAACP,qBAAqB,CAACkC,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,CAACT,KAAK,CAACqC,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,CAACrC,qBAAqB,CAACsC,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

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

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

@@ -23,6 +23,7 @@ type GetIdentifiersOptions = {
  */
 export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
     private callDiagnosticEventsBatcher;
+    private preLoginMetricsBatcher;
     private logger;
     private hasLoggedBrowserSerial;
     validator: (options: {
@@ -87,11 +88,17 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
             browserVersion?: string;
             clientType?: "MEETING_CENTER" | "EVENT_CENTER" | "TRAINING_CENTER" | "TEAMS_CLIENT" | "TEAMS_DEVICE" | "TEAMS_SHARE" | "SIP" | "RECORDING" | "CLOUD_AWARE_SIP" | "TEAMS_WXC_CLIENT" | "WXC_CLIENT" | "WXC_DEVICE" | "WEBEX_JS_SDK" | "VOICEA_CLIENT" | "CISCO_SIP_GW" | "WEBEX_SDK" | "CPAAS_THIRD_PARTY_SDK" | "WXC_THIRD_PARTY" | "WXCC";
             subClientType?: "TEAMS_DEVICE" | "DESKTOP_APP" | "DESKTOP_APP_VDI" | "DEVICE_CURRENT" | "DEVICE_LEGACY_2020" | "HOLOGRAM_HEADSET_APP" | "HVDI_APP" | "MOBILE_APP" | "MOBILE_NETWORK" | "VDI_APP" | "WEB_APP";
-            clientVersion?: string;
+            clientVersion?: string; /**
+             * Returns the login type of the current user
+             * @returns one of 'login-ci','unverified-guest', null
+             */
             clientVersionStatus?: "CURRENT" | "LEGACY" | "UNSUPPORTED";
             localClientVersion?: string;
             modelNumber?: string;
-            joinFirstUpdateLater?: "ep-enabled" | "sp-enabled" | "not-enabled";
+            joinFirstUpdateLater?: "ep-enabled" | "sp-enabled" | "not-enabled"; /**
+             * Returns if the meeting has converged architecture enabled
+             * @param options.meetingId
+             */
             standbyUsed?: boolean;
             prefetchDocShowUsed?: boolean;
             fastJoinUsed?: boolean;
@@ -388,7 +395,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
      */
     submitToCallDiagnostics(event: Event): Promise<any>;
     /**
-     * Pre login events are not batched. We make the request directly.
+     * Prepare the event and send the request to metrics-a service, pre login.
      * @param event
      * @param preLoginId
      * @returns

package/dist/types/index.d.ts

@@ -8,6 +8,8 @@ import * as Utils from './utils';
 import { ClientEvent, ClientEventLeaveReason, SubmitBehavioralEvent, SubmitClientEvent, SubmitInternalEvent, SubmitOperationalEvent, SubmitMQE } from './metrics.types';
 import * as CALL_DIAGNOSTIC_CONFIG from './call-diagnostic/config';
 import * as CallDiagnosticUtils from './call-diagnostic/call-diagnostic-metrics.util';
+import CallDiagnosticMetrics from './call-diagnostic/call-diagnostic-metrics';
+import CallDiagnosticLatencies from './call-diagnostic/call-diagnostic-metrics-latencies';
 export { default, getOSNameInternal } from './metrics';
-export { config, CALL_DIAGNOSTIC_CONFIG, NewMetrics, Utils, CallDiagnosticUtils };
+export { config, CALL_DIAGNOSTIC_CONFIG, NewMetrics, Utils, CallDiagnosticUtils, CallDiagnosticLatencies, CallDiagnosticMetrics, };
 export type { ClientEvent, ClientEventLeaveReason, SubmitBehavioralEvent, SubmitClientEvent, SubmitInternalEvent, SubmitMQE, SubmitOperationalEvent, };

package/dist/types/new-metrics.d.ts

@@ -79,14 +79,6 @@ declare class Metrics extends WebexPlugin {
         payload?: RecursivePartial<ClientEvent['payload']>;
         options?: SubmitClientEventOptions;
     }): Promise<any>;
-    /**
-     * Submit a pre-login metric to clientmetrics
-     * @public
-     * @param payload
-     * @param preLoginId - pre-login ID of user
-     * @returns
-     */
-    postPreLoginMetric(payload: any, preLoginId: string): Promise<any>;
     /**
      * Issue request to alias a user's pre-login ID with their CI UUID
      * @param {string} preLoginId

package/dist/types/prelogin-metrics-batcher.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webex/internal-plugin-metrics",
-  "version": "3.0.0-beta.373",
+  "version": "3.0.0-beta.375",
   "description": "",
   "license": "MIT",
   "main": "dist/index.js",
@@ -28,14 +28,14 @@
     "build": "yarn run -T tsc --declaration true --declarationDir ./dist/types"
   },
   "dependencies": {
-    "@webex/common": "3.0.0-beta.373",
-    "@webex/common-timers": "3.0.0-beta.373",
+    "@webex/common": "3.0.0-beta.375",
+    "@webex/common-timers": "3.0.0-beta.375",
     "@webex/event-dictionary-ts": "^1.0.1329",
-    "@webex/internal-plugin-device": "3.0.0-beta.373",
-    "@webex/internal-plugin-metrics": "3.0.0-beta.373",
-    "@webex/test-helper-chai": "3.0.0-beta.373",
-    "@webex/test-helper-mock-webex": "3.0.0-beta.373",
-    "@webex/webex-core": "3.0.0-beta.373",
+    "@webex/internal-plugin-device": "3.0.0-beta.375",
+    "@webex/internal-plugin-metrics": "3.0.0-beta.375",
+    "@webex/test-helper-chai": "3.0.0-beta.375",
+    "@webex/test-helper-mock-webex": "3.0.0-beta.375",
+    "@webex/webex-core": "3.0.0-beta.375",
     "ip-anonymize": "^0.1.0",
     "lodash": "^4.17.21",
     "uuid": "^3.3.2"

package/src/batcher.js

@@ -7,9 +7,18 @@ import {safeSetTimeout} from '@webex/common-timers';
 
 const sym = Symbol('metric id');
 
+/**
+ * @class
+ * @extends Batcher
+ * @memberof Metrics
+ */
 const MetricsBatcher = Batcher.extend({
   namespace: 'Metrics',
 
+  /**
+   * @param {any} item
+   * @returns {Promise<any>}
+   */
   prepareItem(item) {
     // Keep non-prod data out of metrics
     const env = process.env.NODE_ENV === 'production' ? null : 'TEST';
@@ -22,6 +31,10 @@ const MetricsBatcher = Batcher.extend({
     return Promise.resolve(item);
   },
 
+  /**
+   * @param {any[]} queue
+   * @returns {Promise<any[]>}
+   */
   prepareRequest(queue) {
     return Promise.resolve(
       queue.map((item) => {
@@ -32,6 +45,10 @@ const MetricsBatcher = Batcher.extend({
     );
   },
 
+  /**
+   * @param {any} payload
+   * @returns {Promise<any>}
+   */
   submitHttpRequest(payload) {
     return this.webex.request({
       method: 'POST',
@@ -44,10 +61,18 @@ const MetricsBatcher = Batcher.extend({
     });
   },
 
+  /**
+   * @param {any} res
+   * @returns {Promise<any>}
+   */
   handleHttpSuccess(res) {
     return Promise.all(res.options.body.metrics.map((item) => this.acceptItem(item)));
   },
 
+  /**
+   * @param {any} reason
+   * @returns {Promise<any>}
+   */
   handleHttpError(reason) {
     if (reason instanceof WebexHttpError.NetworkOrCORSError) {
       this.logger.warn(
@@ -74,6 +99,10 @@ const MetricsBatcher = Batcher.extend({
     return Reflect.apply(Batcher.prototype.handleHttpError, this, [reason]);
   },
 
+  /**
+   * @param {any} item
+   * @returns {Promise<any>}
+   */
   rerequest(item) {
     return Promise.all([this.getDeferredForRequest(item), this.prepareItem(item)]).then(
       ([defer, req]) => {
@@ -84,6 +113,10 @@ const MetricsBatcher = Batcher.extend({
     );
   },
 
+  /**
+   * @param {any} item
+   * @returns {Promise<any>}
+   */
   fingerprintRequest(item) {
     item[sym] = item[sym] || {
       nextDelay: 1000,
@@ -92,6 +125,10 @@ const MetricsBatcher = Batcher.extend({
     return Promise.resolve(item[sym]);
   },
 
+  /**
+   * @param {any} item
+   * @returns {Promise<any>}
+   */
   fingerprintResponse(item) {
     return Promise.resolve(item[sym]);
   },

package/src/call-diagnostic/call-diagnostic-metrics-batcher.ts

@@ -1,6 +1,3 @@
-/* eslint-disable class-methods-use-this */
-/* eslint-disable valid-jsdoc */
-
 import {uniqueId} from 'lodash';
 import Batcher from '../batcher';
 import {prepareDiagnosticMetricItem} from './call-diagnostic-metrics.util';
@@ -12,8 +9,8 @@ const CallDiagnosticEventsBatcher = Batcher.extend({
 
   /**
    * Prepare item
-   * @param item
-   * @returns
+   * @param {any} item
+   * @returns {Promise<any>}
    */
   prepareItem(item) {
     return Promise.resolve(prepareDiagnosticMetricItem(this.webex, item));
@@ -21,8 +18,8 @@ const CallDiagnosticEventsBatcher = Batcher.extend({
 
   /**
    * Prepare request, add time sensitive date etc.
-   * @param queue
-   * @returns
+   * @param {any[]} queue
+   * @returns {Promise<any[]>}
    */
   prepareRequest(queue) {
     // Add sent timestamp
@@ -36,8 +33,8 @@ const CallDiagnosticEventsBatcher = Batcher.extend({
 
   /**
    *
-   * @param payload
-   * @returns
+   * @param {any} payload
+   * @returns {Promise<any>}
    */
   submitHttpRequest(payload) {
     const batchId = uniqueId('ca-batch-');

package/src/call-diagnostic/call-diagnostic-metrics.ts

@@ -41,6 +41,8 @@ import {
   ClientSubServiceType,
 } from '../metrics.types';
 import CallDiagnosticEventsBatcher from './call-diagnostic-metrics-batcher';
+import PreLoginMetricsBatcher from '../prelogin-metrics-batcher';
+
 import {
   CLIENT_ERROR_CODE_TO_ERROR_PAYLOAD,
   CALL_DIAGNOSTIC_EVENT_FAILED_TO_SEND,
@@ -56,8 +58,6 @@ import {
   SDP_OFFER_CREATION_ERROR_MAP,
 } from './config';
 
-import {generateCommonErrorMetadata} from '../utils';
-
 const {getOSVersion, getBrowserName, getBrowserVersion} = BrowserDetection();
 
 type GetOriginOptions = {
@@ -86,6 +86,9 @@ type GetIdentifiersOptions = {
 export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
   // @ts-ignore
   private callDiagnosticEventsBatcher: CallDiagnosticEventsBatcher;
+  // @ts-ignore
+  private preLoginMetricsBatcher: PreLoginMetricsBatcher;
+
   private logger: any; // to avoid adding @ts-ignore everywhere
   private hasLoggedBrowserSerial: boolean;
   // the default validator before piping an event to the batcher
@@ -106,6 +109,8 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
     this.logger = this.webex.logger;
     // @ts-ignore
     this.callDiagnosticEventsBatcher = new CallDiagnosticEventsBatcher({}, {parent: this.webex});
+    // @ts-ignore
+    this.preLoginMetricsBatcher = new PreLoginMetricsBatcher({}, {parent: this.webex});
   }
 
   /**
@@ -807,24 +812,20 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
   }
 
   /**
-   * Pre login events are not batched. We make the request directly.
+   * Prepare the event and send the request to metrics-a service, pre login.
    * @param event
    * @param preLoginId
    * @returns
    */
-  public submitToCallDiagnosticsPreLogin = (event: Event, preLoginId?: string): Promise<any> => {
+  submitToCallDiagnosticsPreLogin = (event: Event, preLoginId?: string): Promise<any> => {
     // build metrics-a event type
-    // @ts-ignore
-    const diagnosticEvent = prepareDiagnosticMetricItem(this.webex, {
+    const finalEvent = {
       eventPayload: event,
       type: ['diagnostic-event'],
-    });
-
-    // append sent timestamp
-    diagnosticEvent.eventPayload.originTime.sent = new Date().toISOString();
+    };
+    this.preLoginMetricsBatcher.savePreLoginId(preLoginId);
 
-    // @ts-ignore
-    return this.webex.internal.newMetrics.postPreLoginMetric(diagnosticEvent, preLoginId);
+    return this.preLoginMetricsBatcher.request(finalEvent);
   };
 
   /**

package/src/index.ts

@@ -21,6 +21,8 @@ import {
 } from './metrics.types';
 import * as CALL_DIAGNOSTIC_CONFIG from './call-diagnostic/config';
 import * as CallDiagnosticUtils from './call-diagnostic/call-diagnostic-metrics.util';
+import CallDiagnosticMetrics from './call-diagnostic/call-diagnostic-metrics';
+import CallDiagnosticLatencies from './call-diagnostic/call-diagnostic-metrics-latencies';
 
 registerInternalPlugin('metrics', Metrics, {
   config,
@@ -31,7 +33,16 @@ registerInternalPlugin('newMetrics', NewMetrics, {
 });
 
 export {default, getOSNameInternal} from './metrics';
-export {config, CALL_DIAGNOSTIC_CONFIG, NewMetrics, Utils, CallDiagnosticUtils};
+
+export {
+  config,
+  CALL_DIAGNOSTIC_CONFIG,
+  NewMetrics,
+  Utils,
+  CallDiagnosticUtils,
+  CallDiagnosticLatencies,
+  CallDiagnosticMetrics,
+};
 export type {
   ClientEvent,
   ClientEventLeaveReason,

package/src/new-metrics.ts

@@ -177,45 +177,6 @@ class Metrics extends WebexPlugin {
     return this.callDiagnosticMetrics.submitClientEvent({name, payload, options});
   }
 
-  /**
-   * Submit a pre-login metric to clientmetrics
-   * @public
-   * @param payload
-   * @param preLoginId - pre-login ID of user
-   * @returns
-   */
-  public postPreLoginMetric(payload: any, preLoginId: string): Promise<any> {
-    // @ts-ignore
-    return this.webex
-      .request({
-        method: 'POST',
-        api: 'metrics',
-        resource: 'clientmetrics-prelogin',
-        headers: {
-          authorization: false,
-          'x-prelogin-userid': preLoginId,
-        },
-        body: {
-          metrics: [payload],
-        },
-      })
-      .then((res) => {
-        // @ts-ignore
-        this.webex.logger.log(`NewMetrics: @postPreLoginMetric. Request successful.`);
-
-        return res;
-      })
-      .catch((err) => {
-        // @ts-ignore
-        this.logger.error(
-          `NewMetrics: @postPreLoginMetric. Request failed:`,
-          `err: ${generateCommonErrorMetadata(err)}`
-        );
-
-        return Promise.reject(err);
-      });
-  }
-
   /**
    * Issue request to alias a user's pre-login ID with their CI UUID
    * @param {string} preLoginId

package/src/prelogin-metrics-batcher.ts

@@ -0,0 +1,95 @@
+import {uniqueId} from 'lodash';
+import Batcher from './batcher';
+import {prepareDiagnosticMetricItem} from './call-diagnostic/call-diagnostic-metrics.util';
+import {generateCommonErrorMetadata} from './utils';
+
+const PRE_LOGIN_METRICS_IDENTIFIER = 'Pre Login Metrics -->';
+
+const PreLoginMetricsBatcher = Batcher.extend({
+  namespace: 'Metrics',
+  preLoginId: undefined,
+
+  /**
+   * Save the pre-login ID.
+   * @param {string} preLoginId The pre-login ID to be saved.
+   * @returns {void}
+   */
+  savePreLoginId(preLoginId) {
+    this.preLoginId = preLoginId;
+  },
+
+  /**
+   * Prepare item
+   * @param {any} item
+   * @returns {Promise<any>}
+   */
+  prepareItem(item) {
+    return Promise.resolve(prepareDiagnosticMetricItem(this.webex, item));
+  },
+
+  /**
+   * Prepare request, add time sensitive date etc.
+   * @param {any[]} queue
+   * @returns {Promise<any[]>}
+   */
+  prepareRequest(queue) {
+    // Add sent timestamp
+    queue.forEach((item) => {
+      item.eventPayload.originTime = item.eventPayload.originTime || {};
+      item.eventPayload.originTime.sent = new Date().toISOString();
+    });
+
+    return Promise.resolve(queue);
+  },
+
+  /**
+   *
+   * @param {any} payload
+   * @returns {Promise<any>}
+   */
+  submitHttpRequest(payload: any) {
+    const batchId = uniqueId('prelogin-ca-batch-');
+    if (this.preLoginId === undefined) {
+      this.webex.logger.error(
+        PRE_LOGIN_METRICS_IDENTIFIER,
+        `PreLoginMetricsBatcher: @submitHttpRequest#${batchId}. PreLoginId is not set.`
+      );
+
+      return Promise.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((res) => {
+        this.webex.logger.log(
+          PRE_LOGIN_METRICS_IDENTIFIER,
+          `PreLoginMetricsBatcher: @submitHttpRequest#${batchId}. Request successful.`
+        );
+
+        return res;
+      })
+      .catch((err) => {
+        this.webex.logger.error(
+          PRE_LOGIN_METRICS_IDENTIFIER,
+          `PreLoginMetricsBatcher: @submitHttpRequest#${batchId}. Request failed:`,
+          `error: ${generateCommonErrorMetadata(err)}`
+        );
+
+        return Promise.reject(err);
+      });
+  },
+});
+
+export default PreLoginMetricsBatcher;