@webex/internal-plugin-metrics 3.7.0-next.13 → 3.7.0-next.15

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

@@ -18,6 +18,10 @@ declare class Metrics extends WebexPlugin {
     operationalMetrics: OperationalMetrics;
     businessMetrics: BusinessMetrics;
     isReady: boolean;
+    /**
+     * Whether or not to delay the submission of client events.
+     */
+    delaySubmitClientEvents: boolean;
     /**
      * Constructor
      * @param args
@@ -170,5 +174,12 @@ declare class Metrics extends WebexPlugin {
      * @returns {boolean}
      */
     isServiceErrorExpected(serviceErrorCode: number): boolean;
+    /**
+     * Sets the value of delaySubmitClientEvents. If set to true, client events will be delayed until submitDelayedClientEvents is called. If
+     * set to false, delayed client events will be submitted.
+     *
+     * @param {boolean} shouldDelay - A boolean value indicating whether to delay the submission of client events.
+     */
+    setDelaySubmitClientEvents(shouldDelay: boolean): Promise<any[]> | Promise<void>;
 }
 export default Metrics;

package/package.json

@@ -26,22 +26,22 @@
     "@webex/eslint-config-legacy": "0.0.0",
     "@webex/jest-config-legacy": "0.0.0",
     "@webex/legacy-tools": "0.0.0",
-    "@webex/test-helper-chai": "3.7.0-next.13",
-    "@webex/test-helper-mocha": "3.7.0-next.13",
-    "@webex/test-helper-mock-webex": "3.7.0-next.13",
-    "@webex/test-helper-test-users": "3.7.0-next.13",
+    "@webex/test-helper-chai": "3.7.0-next.15",
+    "@webex/test-helper-mocha": "3.7.0-next.15",
+    "@webex/test-helper-mock-webex": "3.7.0-next.15",
+    "@webex/test-helper-test-users": "3.7.0-next.15",
     "eslint": "^8.24.0",
     "prettier": "^2.7.1",
     "sinon": "^9.2.4"
   },
   "dependencies": {
-    "@webex/common": "3.7.0-next.13",
-    "@webex/common-timers": "3.7.0-next.13",
+    "@webex/common": "3.7.0-next.15",
+    "@webex/common-timers": "3.7.0-next.15",
     "@webex/event-dictionary-ts": "^1.0.1643",
-    "@webex/internal-plugin-metrics": "3.7.0-next.13",
-    "@webex/test-helper-chai": "3.7.0-next.13",
-    "@webex/test-helper-mock-webex": "3.7.0-next.13",
-    "@webex/webex-core": "3.7.0-next.13",
+    "@webex/internal-plugin-metrics": "3.7.0-next.15",
+    "@webex/test-helper-chai": "3.7.0-next.15",
+    "@webex/test-helper-mock-webex": "3.7.0-next.15",
+    "@webex/webex-core": "3.7.0-next.15",
     "ip-anonymize": "^0.1.0",
     "lodash": "^4.17.21",
     "uuid": "^3.3.2"
@@ -54,5 +54,5 @@
     "test:style": "eslint ./src/**/*.*",
     "test:unit": "webex-legacy-tools test --unit --runner mocha"
   },
-  "version": "3.7.0-next.13"
+  "version": "3.7.0-next.15"
 }

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

@@ -151,7 +151,8 @@ export default class CallDiagnosticLatencies extends WebexPlugin {
   public getDiffBetweenTimestamps(a: MetricEventNames, b: MetricEventNames) {
     const start = this.latencyTimestamps.get(a);
     const end = this.latencyTimestamps.get(b);
-    if (start && end) {
+
+    if (typeof start === 'number' && typeof end === 'number') {
       return end - start;
     }
 
@@ -193,7 +194,7 @@ export default class CallDiagnosticLatencies extends WebexPlugin {
   public getU2CTime() {
     const u2cLatency = this.precomputedLatencies.get('internal.get.u2c.time');
 
-    return u2cLatency ? Math.floor(u2cLatency) : undefined;
+    return typeof u2cLatency === 'number' ? Math.floor(u2cLatency) : undefined;
   }
 
   /**
@@ -296,7 +297,9 @@ export default class CallDiagnosticLatencies extends WebexPlugin {
    * @returns - latency
    */
   public getPageJMT() {
-    return this.precomputedLatencies.get('internal.client.pageJMT') || undefined;
+    const latency = this.precomputedLatencies.get('internal.client.pageJMT');
+
+    return typeof latency === 'number' ? latency : undefined;
   }
 
   /**
@@ -304,7 +307,9 @@ export default class CallDiagnosticLatencies extends WebexPlugin {
    * @returns - latency
    */
   public getDownloadTimeJMT() {
-    return this.precomputedLatencies.get('internal.download.time') || undefined;
+    const latency = this.precomputedLatencies.get('internal.download.time');
+
+    return typeof latency === 'number' ? latency : undefined;
   }
 
   /**
@@ -320,8 +325,15 @@ export default class CallDiagnosticLatencies extends WebexPlugin {
       );
     }
 
-    // for cross launch and guest flows
-    return this.precomputedLatencies.get('internal.click.to.interstitial') || undefined;
+    const clickToInterstitialLatency = this.precomputedLatencies.get(
+      'internal.click.to.interstitial'
+    );
+
+    if (typeof clickToInterstitialLatency === 'number') {
+      return clickToInterstitialLatency;
+    }
+
+    return undefined;
   }
 
   /**
@@ -358,7 +370,8 @@ export default class CallDiagnosticLatencies extends WebexPlugin {
     // get the first timestamp
     const connectedMedia = this.latencyTimestamps.get('client.ice.end');
 
-    const lobbyTime = this.getStayLobbyTime() || 0;
+    const lobbyTimeLatency = this.getStayLobbyTime();
+    const lobbyTime = typeof lobbyTimeLatency === 'number' ? lobbyTimeLatency : 0;
 
     if (interstitialJoinClickTimestamp && connectedMedia) {
       return connectedMedia - interstitialJoinClickTimestamp - lobbyTime;
@@ -375,7 +388,7 @@ export default class CallDiagnosticLatencies extends WebexPlugin {
     const clickToInterstitial = this.getClickToInterstitial();
     const interstitialToJoinOk = this.getInterstitialToJoinOK();
 
-    if (clickToInterstitial && interstitialToJoinOk) {
+    if (typeof clickToInterstitial === 'number' && typeof interstitialToJoinOk === 'number') {
       return clickToInterstitial + interstitialToJoinOk;
     }
 
@@ -427,7 +440,7 @@ export default class CallDiagnosticLatencies extends WebexPlugin {
     const interstitialToJoinOk = this.getInterstitialToJoinOK();
     const joinConfJMT = this.getJoinConfJMT();
 
-    if (interstitialToJoinOk && joinConfJMT) {
+    if (typeof interstitialToJoinOk === 'number' && typeof joinConfJMT === 'number') {
       return interstitialToJoinOk - joinConfJMT;
     }
 
@@ -454,7 +467,9 @@ export default class CallDiagnosticLatencies extends WebexPlugin {
   public getReachabilityClustersReqResp() {
     const reachablityClusterReqResp = this.precomputedLatencies.get('internal.get.cluster.time');
 
-    return reachablityClusterReqResp ? Math.floor(reachablityClusterReqResp) : undefined;
+    return typeof reachablityClusterReqResp === 'number'
+      ? Math.floor(reachablityClusterReqResp)
+      : undefined;
   }
 
   /**
@@ -477,7 +492,7 @@ export default class CallDiagnosticLatencies extends WebexPlugin {
   public getExchangeCITokenJMT() {
     const exchangeCITokenJMT = this.precomputedLatencies.get('internal.exchange.ci.token.time');
 
-    return exchangeCITokenJMT ? Math.floor(exchangeCITokenJMT) : undefined;
+    return typeof exchangeCITokenJMT === 'number' ? Math.floor(exchangeCITokenJMT) : undefined;
   }
 
   /**
@@ -486,7 +501,9 @@ export default class CallDiagnosticLatencies extends WebexPlugin {
   public getRefreshCaptchaReqResp() {
     const refreshCaptchaReqResp = this.precomputedLatencies.get('internal.refresh.captcha.time');
 
-    return refreshCaptchaReqResp ? Math.floor(refreshCaptchaReqResp) : undefined;
+    return typeof refreshCaptchaReqResp === 'number'
+      ? Math.floor(refreshCaptchaReqResp)
+      : undefined;
   }
 
   /**
@@ -498,7 +515,7 @@ export default class CallDiagnosticLatencies extends WebexPlugin {
       'internal.api.fetch.intelligence.models'
     );
 
-    return downloadIntelligenceModelsReqResp
+    return typeof downloadIntelligenceModelsReqResp === 'number'
       ? Math.floor(downloadIntelligenceModelsReqResp)
       : undefined;
   }

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

@@ -40,6 +40,7 @@ import {
   ClientEventPayloadError,
   ClientSubServiceType,
   BrowserLaunchMethodType,
+  DelayedClientEvent,
 } from '../metrics.types';
 import CallDiagnosticEventsBatcher from './call-diagnostic-metrics-batcher';
 import PreLoginMetricsBatcher from '../prelogin-metrics-batcher';
@@ -95,6 +96,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
   private logger: any; // to avoid adding @ts-ignore everywhere
   private hasLoggedBrowserSerial: boolean;
   private device: any;
+  private delayedClientEvents: DelayedClientEvent[] = [];
 
   // the default validator before piping an event to the batcher
   // this function can be overridden by the user
@@ -730,6 +732,8 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         meetingId,
       }),
       webexSubServiceType: this.getSubServiceType(meeting),
+      // @ts-ignore
+      webClientPreload: this.webex.meetings?.config?.metrics?.webClientPreload,
     };
 
     const joinFlowVersion = options.joinFlowVersion ?? meeting.callStateForMetrics?.joinFlowVersion;
@@ -782,6 +786,8 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         webClientDomain: window.location.hostname,
       },
       loginType: this.getCurLoginType(),
+      // @ts-ignore
+      webClientPreload: this.webex.meetings?.config?.metrics?.webClientPreload,
     };
 
     if (options.joinFlowVersion) {
@@ -856,17 +862,36 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
    * @param arg.event - event key
    * @param arg.payload - additional payload to be merged with default payload
    * @param arg.options - payload
+   * @param arg.delaySubmitEvent - a boolean value indicating whether to delay the submission of client events.
    * @throws
    */
   public submitClientEvent({
     name,
     payload,
     options,
+    delaySubmitEvent,
   }: {
     name: ClientEvent['name'];
     payload?: ClientEventPayload;
     options?: SubmitClientEventOptions;
+    delaySubmitEvent?: boolean;
   }) {
+    if (delaySubmitEvent) {
+      // Preserve the time when the event was triggered if delaying the submission to Call Diagnostics
+      const delayedOptions = {
+        ...options,
+        triggeredTime: new Date().toISOString(),
+      };
+
+      this.delayedClientEvents.push({
+        name,
+        payload,
+        options: delayedOptions,
+      });
+
+      return Promise.resolve();
+    }
+
     this.logger.log(
       CALL_DIAGNOSTIC_LOG_IDENTIFIER,
       'CallDiagnosticMetrics: @submitClientEvent. Submit Client Event CA event.',
@@ -883,6 +908,28 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
     return this.submitToCallDiagnostics(diagnosticEvent);
   }
 
+  /**
+   * Submit Delayed Client Event CA events. Clears delayedClientEvents array after submission.
+   */
+  public submitDelayedClientEvents() {
+    this.logger.log(
+      CALL_DIAGNOSTIC_LOG_IDENTIFIER,
+      'CallDiagnosticMetrics: @submitDelayedClientEvents. Submitting delayed client events.'
+    );
+
+    if (this.delayedClientEvents.length === 0) {
+      return Promise.resolve();
+    }
+
+    const promises = this.delayedClientEvents.map((delayedSubmitClientEventParams) => {
+      return this.submitClientEvent(delayedSubmitClientEventParams);
+    });
+
+    this.delayedClientEvents = [];
+
+    return Promise.all(promises);
+  }
+
   /**
    * Prepare the event and send the request to metrics-a service.
    * @param event

package/src/metrics.types.ts

@@ -320,3 +320,9 @@ export interface IMetricsAttributes {
   meetingId?: string;
   callId?: string;
 }
+
+export interface DelayedClientEvent {
+  name: ClientEvent['name'];
+  payload?: RecursivePartial<ClientEvent['payload']>;
+  options?: SubmitClientEventOptions;
+}

package/src/new-metrics.ts

@@ -45,6 +45,11 @@ class Metrics extends WebexPlugin {
   businessMetrics: BusinessMetrics;
   isReady = false;
 
+  /**
+   * Whether or not to delay the submission of client events.
+   */
+  delaySubmitClientEvents = false;
+
   /**
    * Constructor
    * @param args
@@ -290,7 +295,12 @@ class Metrics extends WebexPlugin {
       options: {meetingId: options?.meetingId},
     });
 
-    return this.callDiagnosticMetrics.submitClientEvent({name, payload, options});
+    return this.callDiagnosticMetrics.submitClientEvent({
+      name,
+      payload,
+      options,
+      delaySubmitEvent: this.delaySubmitClientEvents,
+    });
   }
 
   /**
@@ -389,6 +399,22 @@ class Metrics extends WebexPlugin {
   public isServiceErrorExpected(serviceErrorCode: number): boolean {
     return this.callDiagnosticMetrics.isServiceErrorExpected(serviceErrorCode);
   }
+
+  /**
+   * Sets the value of delaySubmitClientEvents. If set to true, client events will be delayed until submitDelayedClientEvents is called. If
+   * set to false, delayed client events will be submitted.
+   *
+   * @param {boolean} shouldDelay - A boolean value indicating whether to delay the submission of client events.
+   */
+  public setDelaySubmitClientEvents(shouldDelay: boolean) {
+    this.delaySubmitClientEvents = shouldDelay;
+
+    if (!shouldDelay) {
+      return this.callDiagnosticMetrics.submitDelayedClientEvents();
+    }
+
+    return Promise.resolve();
+  }
 }
 
 export default Metrics;

package/test/unit/spec/call-diagnostic/call-diagnostic-metrics-latencies.ts

@@ -437,6 +437,15 @@ describe('internal-plugin-metrics', () => {
       assert.deepEqual(cdl.getClickToInterstitial(), 5);
     });
 
+    it('calculates getClickToInterstitial without join button timestamp when it is 0', () => {
+      cdl.saveLatency('internal.click.to.interstitial', 0);
+      cdl.saveTimestamp({
+        key: 'internal.client.meeting.interstitial-window.showed',
+        value: 20,
+      });
+      assert.deepEqual(cdl.getClickToInterstitial(), 0);
+    });
+
     it('calculates getInterstitialToJoinOK correctly', () => {
       cdl.saveTimestamp({
         key: 'internal.client.interstitial-window.click.joinbutton',
@@ -449,6 +458,18 @@ describe('internal-plugin-metrics', () => {
       assert.deepEqual(cdl.getInterstitialToJoinOK(), 10);
     });
 
+    it('calculates getInterstitialToJoinOK correctly when one value is not a number', () => {
+      cdl.saveTimestamp({
+        key: 'internal.client.interstitial-window.click.joinbutton',
+        value: 'ten' as unknown as number,
+      });
+      cdl.saveTimestamp({
+        key: 'client.locus.join.response',
+        value: 20,
+      });
+      assert.deepEqual(cdl.getInterstitialToJoinOK(), undefined);
+    });
+
     it('calculates getCallInitMediaEngineReady correctly', () => {
       cdl.saveTimestamp({
         key: 'internal.client.interstitial-window.click.joinbutton',
@@ -481,6 +502,58 @@ describe('internal-plugin-metrics', () => {
       assert.deepEqual(cdl.getTotalJMT(), 45);
     });
 
+    it('calculates getTotalJMT correctly when clickToInterstitial is 0', () => {
+        cdl.saveLatency('internal.click.to.interstitial', 0);
+        cdl.saveTimestamp({
+          key: 'internal.client.interstitial-window.click.joinbutton',
+          value: 20,
+        });
+        cdl.saveTimestamp({
+          key: 'client.locus.join.response',
+          value: 40,
+        });
+        assert.deepEqual(cdl.getTotalJMT(), 20);
+      });
+
+      it('calculates getTotalJMT correctly when interstitialToJoinOk is 0', () => {
+        cdl.saveTimestamp({
+          key: 'internal.client.interstitial-window.click.joinbutton',
+          value: 40,
+        });
+        cdl.saveLatency('internal.click.to.interstitial', 12);
+        cdl.saveTimestamp({
+          key: 'client.locus.join.response',
+          value: 40,
+        });
+        assert.deepEqual(cdl.getTotalJMT(), 12);
+      });
+
+      it('calculates getTotalJMT correctly when both clickToInterstitial and interstitialToJoinOk are 0', () => {
+        cdl.saveTimestamp({
+          key: 'internal.client.interstitial-window.click.joinbutton',
+          value: 40,
+        });
+        cdl.saveLatency('internal.click.to.interstitial', 0);
+        cdl.saveTimestamp({
+          key: 'client.locus.join.response',
+          value: 40,
+        });
+        assert.deepEqual(cdl.getTotalJMT(), 0);
+      });
+
+      it('calculates getTotalJMT correctly when both clickToInterstitial is not a number', () => {
+        cdl.saveTimestamp({
+          key: 'internal.client.interstitial-window.click.joinbutton',
+          value: 40,
+        });
+        cdl.saveLatency('internal.click.to.interstitial', 'eleven' as unknown as number);
+        cdl.saveTimestamp({
+          key: 'client.locus.join.response',
+          value: 40,
+        });
+        assert.deepEqual(cdl.getTotalJMT(), undefined);
+      });
+
     it('calculates getTotalMediaJMT correctly', () => {
       cdl.saveTimestamp({
         key: 'internal.client.meeting.click.joinbutton',