@webex/internal-plugin-metrics 3.0.0-beta.24 → 3.0.0-beta.241

package/dist/new-metrics.js.map

@@ -0,0 +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","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/dist/types/batcher.d.ts

@@ -0,0 +1,2 @@
+export default MetricsBatcher;
+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,189 @@
+import { WebexPlugin } from '@webex/webex-core';
+import { MetricEventNames } 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<string, 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
+     * @throws
+     * @returns
+     */
+    saveLatency(key: string, value: number): void;
+    /**
+     * 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;
+    /**
+     * Call Init Join Request
+     * @returns - latency
+     */
+    getCallInitJoinReq(): number;
+    /**
+     * Locus Join Request
+     * @returns - latency
+     */
+    getJoinReqResp(): number;
+    /**
+     * Locus Join Response Sent Received
+     * @returns - latency
+     */
+    getJoinRespSentReceived(): any;
+    /**
+     * 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;
+    /**
+     * 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;
+}

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

@@ -0,0 +1,385 @@
+import { StatelessWebexPlugin } from '@webex/webex-core';
+import { Event, ClientType, SubClientType, NetworkType, EnvironmentType, NewEnvironmentType, ClientEvent, SubmitClientEventOptions, MediaQualityEvent, SubmitMQEOptions, SubmitMQEPayload, ClientLaunchMethodType, ClientEventError, ClientEventPayload } from '../metrics.types';
+type GetOriginOptions = {
+    clientType: ClientType;
+    subClientType: SubClientType;
+    networkType?: NetworkType;
+    clientLaunchMethod?: ClientLaunchMethodType;
+    environment?: EnvironmentType;
+    newEnvironment?: NewEnvironmentType;
+};
+type GetIdentifiersOptions = {
+    meeting?: any;
+    mediaConnections?: any[];
+    correlationId?: string;
+};
+/**
+ * @description Util class to handle Call Analyzer Metrics
+ * @export
+ * @class CallDiagnosticMetrics
+ */
+export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
+    private callDiagnosticEventsBatcher;
+    private logger;
+    /**
+     * Constructor
+     * @param args
+     */
+    constructor(...args: any[]);
+    /**
+     * Returns the login type of the current user
+     * @returns one of 'login-ci','unverified-guest', null
+     */
+    getCurLoginType(): "unverified-guest" | "login-ci";
+    /**
+     * Returns if the meeting has converged architecture enabled
+     * @param options.meetingId
+     */
+    getIsConvergedArchitectureEnabled({ meetingId }: {
+        meetingId?: string;
+    }): boolean;
+    /**
+     * Get origin object for Call Diagnostic Event payload.
+     * @param options
+     * @param meetingId
+     * @returns
+     */
+    getOrigin(options: GetOriginOptions, meetingId?: string): {
+        name: "endpoint" | "antares" | "beech" | "breakout" | "cb" | "cloudproxy" | "edonus" | "givr" | "hecate" | "hedge" | "hesiod" | "homer" | "superhomer" | "l2sip" | "linus" | "locus" | "mcc" | "mcs" | "mercury" | "mes" | "mjs" | "mmp" | "mygdon" | "orpheus" | "page" | "poros" | "rhesos" | "terminus" | "tpgw" | "ucc" | "wdm" | "webexivr";
+        userAgent: string;
+        buildType?: "debug" | "test" | "prod" | "tap" | "analyzer-test";
+        upgradeChannel?: string;
+        instanceId?: string;
+        networkType: "wifi" | "ethernet" | "cellular" | "unknown";
+        localIP?: string;
+        usingProxy?: boolean;
+        mediaEngineSoftwareVersion?: string;
+        environment?: string;
+        newEnvironment?: string;
+        clientInfo?: {
+            os?: "windows" | "mac" | "ios" | "android" | "chrome" | "linux" | "other" | "android-x64" | "uwp-arm64";
+            osVersion?: string;
+            localIP?: string;
+            gatewayIP?: string;
+            macAddress?: string;
+            localNetworkPrefix?: string;
+            publicNetworkPrefix?: string;
+            browserLaunchMethod?: "url-handler" | "activex" | "npapi" | "extension" | "cwsapi" | "java" | "tfs" | "webacd" | "thinclient";
+            clientLaunchMethod?: "url-handler" | "universal-link" | "voice-command" | "notification" | "manual" | "teams-cross-launch" | "mc-cross-launch";
+            browser?: string;
+            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"; /**
+             * Returns if the meeting has converged architecture enabled
+             * @param options.meetingId
+             */
+            subClientType?: "DESKTOP_APP" | "DESKTOP_APP_VDI" | "DEVICE_CURRENT" | "DEVICE_LEGACY_2020" | "HVDI_APP" | "MOBILE_APP" | "VDI_APP" | "WEB_APP" | "MOBILE_NETWORK" | "HOLOGRAM_HEADSET_APP";
+            clientVersion?: string;
+            localClientVersion?: string;
+            modelNumber?: string;
+            joinFirstUpdateLater?: "ep-enabled" | "sp-enabled" | "not-enabled";
+            standbyUsed?: boolean;
+            prefetchDocShowUsed?: boolean;
+            fastJoinUsed?: boolean;
+            clientDownloadSize?: number;
+            clientDownloadFileCount?: number;
+            nodeId?: number;
+            machineInfo?: string;
+            parentAppName?: string;
+            parentAppInPermitList?: boolean;
+            meetingSiteType?: "train" | "webex-11" | "orion";
+            CDNEnabled?: boolean;
+            clientMajorVersion?: string;
+            majorVersion?: number;
+            minorVersion?: number;
+            revision?: number;
+            isValidClientVersion?: boolean;
+            cpuInfo?: {
+                description: string;
+                clockSpeedGigaHertz: number;
+                numberOfCores: number;
+                architecture: "unknown" | "intel32" | "intel64" | "amd32" | "amd64" | "arm32" | "arm64";
+                staticPerformance?: string;
+                additionalProperties?: false;
+            };
+            shareType?: "cb-normal-share" | "ce-airplay-share" | "ce-direct-share" | "ce-gui-loopback-share" | "ce-input-source-share" | "ce-input-source-share-hdmi" | "ce-input-source-share-usbc" | "ce-jpg-share" | "ce-miracast-share" | "mcs-normal-share" | "mcs-normal-audio-share" | "mcs-hfps-share" | "mcs-hfps-audio-share";
+            videoDisplayMode?: "grid-view" | "active-speaker-view";
+            videoLayoutType?: "stack" | "stackWithShare" | "sideBySide" | "sideBySideWithShare" | "grid" | "floatingActive" | "floatingThumbnail" | "floatingGrid" | "overlay" | "focus" | "prominent" | "focusWithShare" | "prominentWithShare" | "equal" | "equalWithShare";
+            videoRenderType?: "wme" | "client_d3d" | "client_gdi";
+            vdiInfo?: {};
+            is64BitsClient?: boolean;
+            webexAppVersion?: string;
+            launch32BitsReason?: "forcewin32" | "disablewin64" | "platform_win32" | "platform_arm" | "platform_unknown" | "version_below_41.11";
+            inMeetingUpdate?: boolean;
+            mtaVersion?: string;
+            isWarholOpening?: boolean;
+            additionalProperties?: false;
+        };
+        emmVendorId?: string;
+        isHybridMedia?: boolean;
+        originData?: {};
+        additionalProperties?: false;
+    };
+    /**
+     * Gather identifier details for call diagnostic payload.
+     * @throws Error if initialization fails.
+     * @param options
+     */
+    getIdentifiers(options: GetIdentifiersOptions): {
+        attendeeId?: string;
+        breakoutGroupId?: string;
+        breakoutMoveId?: string;
+        breakoutSessionId?: string;
+        confluenceId?: string;
+        cpaasIdentifiers?: {
+            imiTenantId: string;
+            devClientId: string;
+            imiServiceId: string;
+            imiAppId: string;
+            sessionId: string;
+            sessionInstanceId: string;
+            additionalProperties?: false;
+        };
+        csdmDeviceUrl?: string;
+        destinationBreakoutSessionId?: string;
+        destinationLocusSessionId?: string;
+        destinationLocusUrl?: string;
+        destinationVenueId?: string;
+        deviceId?: string;
+        ivrCallId?: string;
+        ivrDialogId?: string;
+        ivrId?: string;
+        callId?: string;
+        locusId?: string;
+        locusSessionId?: string;
+        locusStartTime?: string;
+        locusUrl?: string;
+        mediaAgentAlias?: string;
+        mediaAgentGroupId?: string;
+        meetClusterName?: string;
+        meetingLookupUrl?: string;
+        meetingOrgId?: string;
+        msteamsTenantGuid?: string;
+        msteamsConferenceId?: string;
+        oauth2ClientId?: string;
+        orgId?: string;
+        provisionalCorrelationId?: string;
+        roomId?: string;
+        sipCallId?: string;
+        sipSessionId?: {
+            local?: string;
+            remote?: string;
+            additionalProperties?: false;
+        };
+        sipUri?: string;
+        subConfId?: string;
+        tenantId?: string;
+        trackingId?: string;
+        userId?: string;
+        venueId?: string;
+        venueUrl?: string;
+        whiteboardUrl?: string;
+        webexConferenceId?: number;
+        webexClusterName?: string;
+        webexConferenceIdStr?: string;
+        webexDataCenter?: string;
+        webexGuestId?: number;
+        webexMeetingId?: number;
+        webexNodeId?: number;
+        webexSiteId?: number;
+        webexSiteName?: string;
+        webexUserId?: number;
+        webexWebDomain?: string;
+        correlationId: string;
+        additionalProperties?: false;
+    } | {
+        attendeeId?: string;
+        breakoutGroupId?: string;
+        breakoutMoveId?: string;
+        breakoutSessionId?: string;
+        confluenceId?: string;
+        cpaasIdentifiers?: {
+            imiTenantId: string;
+            devClientId: string;
+            imiServiceId: string;
+            imiAppId: string;
+            sessionId: string;
+            sessionInstanceId: string;
+            additionalProperties?: false;
+        };
+        csdmDeviceUrl?: string;
+        destinationBreakoutSessionId?: string;
+        destinationLocusSessionId?: string;
+        destinationLocusUrl?: string;
+        destinationVenueId?: string;
+        deviceId?: string;
+        ivrCallId?: string;
+        ivrDialogId?: string;
+        ivrId?: string;
+        callId?: string;
+        locusId?: string;
+        locusSessionId?: string;
+        locusStartTime?: string;
+        locusUrl?: string;
+        mediaAgentAlias?: string;
+        mediaAgentGroupId?: string;
+        meetClusterName?: string;
+        meetingLookupUrl?: string;
+        meetingOrgId?: string;
+        msteamsTenantGuid?: string;
+        msteamsConferenceId?: string;
+        oauth2ClientId?: string;
+        orgId?: string;
+        provisionalCorrelationId?: string;
+        roomId?: string;
+        sipCallId?: string;
+        sipSessionId?: {
+            local?: string;
+            remote?: string;
+            additionalProperties?: false;
+        };
+        sipUri?: string;
+        subConfId?: string;
+        tenantId?: string;
+        trackingId?: string;
+        userId?: string;
+        venueId?: string;
+        venueUrl?: string;
+        whiteboardUrl?: string;
+        webexConferenceId?: number;
+        webexClusterName?: string;
+        webexConferenceIdStr?: string;
+        webexDataCenter?: string;
+        webexGuestId?: number;
+        webexMeetingId?: number;
+        webexNodeId?: number;
+        webexSiteId?: number;
+        webexSiteName?: string;
+        webexUserId?: number;
+        webexWebDomain?: string;
+        correlationId: string;
+        additionalProperties?: false;
+    };
+    /**
+     * Create diagnostic event, which can hold client event, feature event or MQE event data.
+     * This just initiates the shared properties that are required for all the 3 event categories.
+     * @param eventData
+     * @param options
+     * @returns
+     */
+    prepareDiagnosticEvent(eventData: Event['event'], options: any): Event;
+    /**
+     * TODO: NOT IMPLEMENTED
+     * Submit Feature Event
+     * @returns
+     */
+    submitFeatureEvent(): void;
+    /**
+     * Submit Media Quality Event
+     * @param args - submit params
+     * @param arg.name - event key
+     * @param arg.payload - additional payload to be merge with the default payload
+     * @param arg.options - options
+     */
+    submitMQE({ name, payload, options, }: {
+        name: MediaQualityEvent['name'];
+        payload: SubmitMQEPayload;
+        options: SubmitMQEOptions;
+    }): void;
+    /**
+     * Return Client Event payload by client error code
+     * @param arg - get error arg
+     * @param arg.clientErrorCode
+     * @param arg.serviceErrorCode
+     * @returns
+     */
+    getErrorPayloadForClientErrorCode({ clientErrorCode, serviceErrorCode, serviceErrorName, }: {
+        clientErrorCode: number;
+        serviceErrorCode: any;
+        serviceErrorName?: any;
+    }): ClientEventError;
+    /**
+     * Generate error payload for Client Event
+     * @param rawError
+     */
+    generateClientEventErrorPayload(rawError: any): {
+        fatal: boolean;
+        category: "other" | "signaling" | "media" | "expected";
+        errorDescription?: string;
+        errorCode?: number;
+        errorCodeStr?: string;
+        httpCode?: number;
+        errorCodeExt1?: number;
+        errorData?: {};
+        shownToUser: boolean;
+        serviceErrorCode?: number;
+        name: "other" | "locus.response" | "media-engine" | "ice.failed" | "locus.leave" | "client.leave" | "media-device" | "media-sca" | "wxc";
+        additionalProperties?: false;
+    };
+    /**
+     * Create client event object for in meeting events
+     * @param arg - create args
+     * @param arg.event - event key
+     * @param arg.options - options
+     * @returns object
+     */
+    private createClientEventObjectInMeeting;
+    /**
+     * Create client event object for pre meeting events
+     * @param arg - create args
+     * @param arg.event - event key
+     * @param arg.options - payload
+     * @returns object
+     */
+    private createClientEventObjectPreMeeting;
+    /**
+     * Prepare Client Event CA event.
+     * @param arg - submit params
+     * @param arg.event - event key
+     * @param arg.payload - additional payload to be merged with default payload
+     * @param arg.options - payload
+     * @returns {any} options to be with fetch
+     * @throws
+     */
+    private prepareClientEvent;
+    /**
+     * Submit Client Event CA event.
+     * @param arg - submit params
+     * @param arg.event - event key
+     * @param arg.payload - additional payload to be merged with default payload
+     * @param arg.options - payload
+     * @throws
+     */
+    submitClientEvent({ name, payload, options, }: {
+        name: ClientEvent['name'];
+        payload?: ClientEventPayload;
+        options?: SubmitClientEventOptions;
+    }): Promise<any>;
+    /**
+     * Prepare the event and send the request to metrics-a service.
+     * @param event
+     * @returns promise
+     */
+    submitToCallDiagnostics(event: Event): Promise<any>;
+    /**
+     * Pre login events are not batched. We make the request directly.
+     * @param event
+     * @param preLoginId
+     * @returns
+     */
+    submitToCallDiagnosticsPreLogin: (event: Event, preLoginId?: string) => Promise<any>;
+    /**
+     * Builds a request options object to later be passed to fetch().
+     * @param arg - submit params
+     * @param arg.event - event key
+     * @param arg.payload - additional payload to be merged with default payload
+     * @param arg.options - client event options
+     * @returns {Promise<any>}
+     * @throws
+     */
+    buildClientEventFetchRequestOptions({ name, payload, options, }: {
+        name: ClientEvent['name'];
+        payload?: ClientEventPayload;
+        options?: SubmitClientEventOptions;
+    }): Promise<any>;
+}
+export {};

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

@@ -0,0 +1,73 @@
+import { Event } from '../metrics.types';
+export declare const anonymizeIPAddress: (localIp: any) => string;
+/**
+ * Returns a formated string of the user agent.
+ *
+ * @returns {string} formatted user agent information
+ */
+export declare const userAgentToString: ({ clientName, webexVersion }: {
+    clientName: any;
+    webexVersion: any;
+}) => string;
+/**
+ * Iterates object recursively and removes any
+ * property that returns isEmpty for it's associated value
+ * isEmpty = implementation from Lodash.
+ *
+ * It modifies the object in place (mutable)
+ *
+ * @param obj - input
+ * @returns
+ */
+export declare const clearEmptyKeysRecursively: (obj: any) => void;
+/**
+ * Locus error codes start with 2. The next three digits are the
+ * HTTP status code related to the error code (like 400, 403, 502, etc.)
+ * The remaining three digits are just an increasing integer.
+ * If it is 7 digits and starts with a 2, it is locus.
+ *
+ * @param errorCode
+ * @returns {boolean}
+ */
+export declare const isLocusServiceErrorCode: (errorCode: string | number) => boolean;
+/**
+ * MeetingInfo errors sometimes has body.data.meetingInfo object
+ * MeetingInfo errors come with a wbxappapi url
+ *
+ * @param {Object} rawError
+ * @returns {boolean}
+ */
+export declare const isMeetingInfoServiceError: (rawError: any) => boolean;
+/**
+ * MDN Media Devices getUserMedia() method returns a name if it errs
+ * Documentation can be found here: https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia
+ *
+ * @param errorCode
+ * @returns
+ */
+export declare const isBrowserMediaErrorName: (errorName: any) => boolean;
+/**
+ * @param webClientDomain
+ * @returns
+ */
+export declare const getBuildType: (webClientDomain: any, markAsTestEvent?: boolean) => Event['origin']['buildType'];
+/**
+ * Prepare metric item for submission.
+ * @param {Object} webex sdk instance
+ * @param {Object} item
+ * @returns {Object} prepared item
+ */
+export declare const prepareDiagnosticMetricItem: (webex: any, item: any) => any;
+/**
+ * Sets the originTime value(s) before the request/fetch.
+ * This function is only useful if you are about to submit a metrics
+ * request using pre-built fetch options;
+ *
+ * @param {any} options
+ * @returns {any} the updated options object
+ */
+export declare const setMetricTimings: (options: any) => any;
+export declare const extractVersionMetadata: (version: string) => {
+    majorVersion: number;
+    minorVersion: number;
+};