@webex/internal-plugin-metrics 3.0.0 → 3.1.0-next.2

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

@@ -31,6 +31,7 @@ export default class CallDiagnosticLatencies extends WebexPlugin {
    */
   public clearTimestamps() {
     this.latencyTimestamps.clear();
+    this.precomputedLatencies.clear();
   }
 
   /**
@@ -57,7 +58,8 @@ export default class CallDiagnosticLatencies extends WebexPlugin {
   /**
    * Store timestamp value
    * @param key - key
-   * @param value -value
+   * @param value - value
+   * @param options - store options
    * @throws
    * @returns
    */
@@ -92,12 +94,33 @@ export default class CallDiagnosticLatencies extends WebexPlugin {
   /**
    * Store precomputed latency value
    * @param key - key
-   * @param value -value
+   * @param value - value
+   * @param accumulate - when it is true, it overwrites existing value with sum of the current value and the new measurement otherwise just store the new measurement
    * @throws
    * @returns
    */
-  public saveLatency(key: PreComputedLatencies, value: number) {
-    this.precomputedLatencies.set(key, value);
+  public saveLatency(key: PreComputedLatencies, value: number, accumulate = false) {
+    const existingValue = accumulate ? this.precomputedLatencies.get(key) || 0 : 0;
+    this.precomputedLatencies.set(key, value + existingValue);
+  }
+
+  /**
+   * Measure latency for a request
+   * @param callback - callback for which you would like to measure latency
+   * @param key - key
+   * @param accumulate - when it is true, it overwrites existing value with sum of the current value and the new measurement otherwise just store the new measurement
+   * @returns
+   */
+  public measureLatency(
+    callback: () => Promise<unknown>,
+    key: PreComputedLatencies,
+    accumulate = false
+  ) {
+    const start = performance.now();
+
+    return callback().finally(() => {
+      this.saveLatency(key, performance.now() - start, accumulate);
+    });
   }
 
   /**
@@ -158,6 +181,16 @@ export default class CallDiagnosticLatencies extends WebexPlugin {
     );
   }
 
+  /**
+   * getU2CTime
+   * @returns - latency
+   */
+  public getU2CTime() {
+    const u2cLatency = this.precomputedLatencies.get('internal.get.u2c.time');
+
+    return u2cLatency ? Math.floor(u2cLatency) : undefined;
+  }
+
   /**
    * Device Register Time
    * @returns - latency
@@ -188,15 +221,6 @@ export default class CallDiagnosticLatencies extends WebexPlugin {
     return this.getDiffBetweenTimestamps('client.locus.join.request', 'client.locus.join.response');
   }
 
-  /**
-   * Locus Join Response Sent Received
-   * @returns - latency
-   */
-  public getJoinRespSentReceived() {
-    // TODO: not clear SPARK-440554
-    return undefined;
-  }
-
   /**
    * Time taken to do turn discovery
    * @returns - latency
@@ -419,6 +443,15 @@ export default class CallDiagnosticLatencies extends WebexPlugin {
     return this.getDiffBetweenTimestamps('client.locus.join.response', 'client.media.rx.start');
   }
 
+  /**
+   * Total latency for all get cluster request.
+   */
+  public getReachabilityClustersReqResp() {
+    const reachablityClusterReqResp = this.precomputedLatencies.get('internal.get.cluster.time');
+
+    return reachablityClusterReqResp ? Math.floor(reachablityClusterReqResp) : undefined;
+  }
+
   /**
    * Audio setup delay transmit
    */
@@ -432,4 +465,47 @@ export default class CallDiagnosticLatencies extends WebexPlugin {
   public getVideoJoinRespTxStart() {
     return this.getDiffBetweenTimestamps('client.locus.join.response', 'client.media.tx.start');
   }
+
+  /**
+   * Total latency for all exchange ci token.
+   */
+  public getExchangeCITokenJMT() {
+    const exchangeCITokenJMT = this.precomputedLatencies.get('internal.exchange.ci.token.time');
+
+    return exchangeCITokenJMT ? Math.floor(exchangeCITokenJMT) : undefined;
+  }
+
+  /**
+   * Total latency for all refresh captcha requests.
+   */
+  public getRefreshCaptchaReqResp() {
+    const refreshCaptchaReqResp = this.precomputedLatencies.get('internal.refresh.captcha.time');
+
+    return refreshCaptchaReqResp ? Math.floor(refreshCaptchaReqResp) : undefined;
+  }
+
+  /**
+   * Get the latency for downloading intelligence models.
+   * @returns - latency
+   */
+  public getDownloadIntelligenceModelsReqResp() {
+    const downloadIntelligenceModelsReqResp = this.precomputedLatencies.get(
+      'internal.api.fetch.intelligence.models'
+    );
+
+    return downloadIntelligenceModelsReqResp
+      ? Math.floor(downloadIntelligenceModelsReqResp)
+      : undefined;
+  }
+
+  /**
+   * Get the total latency for all other app API requests.
+   * Excludes meeting info, because it's measured separately.
+   * @returns - latency
+   */
+  public getOtherAppApiReqResp() {
+    const otherAppApiJMT = this.precomputedLatencies.get('internal.other.app.api.time');
+
+    return otherAppApiJMT > 0 ? Math.floor(otherAppApiJMT) : undefined;
+  }
 }

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

@@ -1,11 +1,11 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
 /* eslint-disable class-methods-use-this */
 /* eslint-disable valid-jsdoc */
-import {getOSNameInternal} from '@webex/internal-plugin-metrics';
 import {BrowserDetection, getBrowserSerial} from '@webex/common';
 import uuid from 'uuid';
 import {merge} from 'lodash';
 import {StatelessWebexPlugin} from '@webex/webex-core';
+import {getOSNameInternal} from '../metrics';
 
 import {
   anonymizeIPAddress,
@@ -39,6 +39,7 @@ import {
   ClientInfo,
   ClientEventPayloadError,
   ClientSubServiceType,
+  BrowserLaunchMethodType,
 } from '../metrics.types';
 import CallDiagnosticEventsBatcher from './call-diagnostic-metrics-batcher';
 import PreLoginMetricsBatcher from '../prelogin-metrics-batcher';
@@ -65,6 +66,7 @@ type GetOriginOptions = {
   subClientType: SubClientType;
   networkType?: NetworkType;
   clientLaunchMethod?: ClientLaunchMethodType;
+  browserLaunchMethod?: BrowserLaunchMethodType;
   environment?: EnvironmentType;
   newEnvironment?: NewEnvironmentType;
 };
@@ -91,6 +93,8 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
 
   private logger: any; // to avoid adding @ts-ignore everywhere
   private hasLoggedBrowserSerial: boolean;
+  private device: any;
+
   // the default validator before piping an event to the batcher
   // this function can be overridden by the user
   public validator: (options: {
@@ -258,6 +262,10 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         origin.clientInfo.clientLaunchMethod = options.clientLaunchMethod;
       }
 
+      if (options?.browserLaunchMethod) {
+        origin.clientInfo.browserLaunchMethod = options.browserLaunchMethod;
+      }
+
       return origin;
     }
 
@@ -289,15 +297,20 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
     if (correlationId) {
       identifiers.correlationId = correlationId;
     }
-    // @ts-ignore
-    if (this.webex.internal) {
-      // @ts-ignore
-      const {device} = this.webex.internal;
-      identifiers.userId = device.userId || preLoginId;
-      identifiers.deviceId = device.url;
-      identifiers.orgId = device.orgId;
+
+    if (this.device) {
+      const {device} = this;
+      const {installationId} = device?.config || {};
+
+      identifiers.userId = device?.userId || preLoginId;
+      identifiers.deviceId = device?.url;
+      identifiers.orgId = device?.orgId;
       // @ts-ignore
       identifiers.locusUrl = this.webex.internal.services.get('locus');
+
+      if (installationId) {
+        identifiers.machineId = installationId;
+      }
     }
 
     if (meeting?.locusInfo?.fullState) {
@@ -441,6 +454,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
           webClientDomain: window.location.hostname,
         },
         intervals: payload.intervals,
+        callingServiceType: 'LOCUS',
         sourceMetadata: {
           applicationSoftwareType: CLIENT_NAME,
           // @ts-ignore
@@ -607,6 +621,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
     return this.getErrorPayloadForClientErrorCode({
       clientErrorCode: UNKNOWN_ERROR,
       serviceErrorCode: UNKNOWN_ERROR,
+      payloadOverrides: rawError.payloadOverrides,
       rawErrorMessage,
       httpStatusCode,
     });
@@ -909,4 +924,16 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
 
     return clientErrorPayload?.category === 'expected';
   }
+
+  /**
+   * This method is used to set the device information by internal-plugin-device
+   * @param {device} object The webex.internal.device object
+   * @returns {undefined}
+   */
+  public setDeviceInfo(device: any): void {
+    // This was created to fix the circular dependency between internal-plugin-device and internal-plugin-metrics
+    this.logger.log('CallDiagnosticMetrics: @setDeviceInfo called', device);
+
+    this.device = device;
+  }
 }

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

@@ -244,22 +244,29 @@ export const prepareDiagnosticMetricItem = (webex: any, item: any) => {
     case 'client.webexapp.launched':
       joinTimes.downloadTime = cdl.getDownloadTimeJMT();
       break;
+    case 'client.login.end':
+      joinTimes.otherAppApiReqResp = cdl.getOtherAppApiReqResp();
+      joinTimes.exchangeCITokenJMT = cdl.getExchangeCITokenJMT();
+      break;
     case 'client.interstitial-window.launched':
       joinTimes.meetingInfoReqResp = cdl.getMeetingInfoReqResp();
       joinTimes.clickToInterstitial = cdl.getClickToInterstitial();
+      joinTimes.refreshCaptchaServiceReqResp = cdl.getRefreshCaptchaReqResp();
+      joinTimes.downloadIntelligenceModelsReqResp = cdl.getDownloadIntelligenceModelsReqResp();
       break;
 
     case 'client.call.initiated':
       joinTimes.meetingInfoReqResp = cdl.getMeetingInfoReqResp();
       joinTimes.showInterstitialTime = cdl.getShowInterstitialTime();
       joinTimes.registerWDMDeviceJMT = cdl.getRegisterWDMDeviceJMT();
+      joinTimes.getU2CTime = cdl.getU2CTime();
+      joinTimes.getReachabilityClustersReqResp = cdl.getReachabilityClustersReqResp();
       break;
 
     case 'client.locus.join.response':
       joinTimes.meetingInfoReqResp = cdl.getMeetingInfoReqResp();
       joinTimes.callInitJoinReq = cdl.getCallInitJoinReq();
       joinTimes.joinReqResp = cdl.getJoinReqResp();
-      joinTimes.joinReqSentReceived = cdl.getJoinRespSentReceived();
       joinTimes.pageJmt = cdl.getPageJMT();
       joinTimes.clickToInterstitial = cdl.getClickToInterstitial();
       joinTimes.interstitialToJoinOK = cdl.getInterstitialToJoinOK();
@@ -376,11 +383,18 @@ export const generateClientErrorCodeForIceFailure = ({
     errorCode = MISSING_ROAP_ANSWER_CLIENT_CODE;
   }
 
-  if (signalingState === 'stable' && iceConnectionState === 'connected') {
+  if (
+    signalingState === 'stable' &&
+    (iceConnectionState === 'connected' || iceConnectionState === 'disconnected')
+  ) {
     errorCode = DTLS_HANDSHAKE_FAILED_CLIENT_CODE;
   }
 
-  if (signalingState !== 'have-local-offer' && iceConnectionState !== 'connected') {
+  if (
+    signalingState !== 'have-local-offer' &&
+    iceConnectionState !== 'connected' &&
+    iceConnectionState !== 'disconnected'
+  ) {
     if (turnServerUsed) {
       errorCode = ICE_FAILED_WITH_TURN_TLS_CLIENT_CODE;
     } else {

package/src/client-metrics-prelogin-batcher.ts

@@ -0,0 +1,26 @@
+import PreLoginMetricsBatcher from './prelogin-metrics-batcher';
+
+const ClientMetricsPreloginBatcher = PreLoginMetricsBatcher.extend({
+  namespace: 'Metrics',
+
+  /**
+   * Prepare item
+   * @param {any} item
+   * @returns {Promise<any>}
+   */
+  prepareItem(item) {
+    // Add more defaults to payload when the clientmetrics endpoint evolves to support richer payloads
+    return Promise.resolve(item);
+  },
+
+  /**
+   * Prepare request, add time sensitive date etc.
+   * @param {any[]} queue
+   * @returns {Promise<any[]>}
+   */
+  prepareRequest(queue) {
+    return Promise.resolve(queue);
+  },
+});
+
+export default ClientMetricsPreloginBatcher;

package/src/index.ts

@@ -2,8 +2,6 @@
  * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
  */
 
-import '@webex/internal-plugin-device';
-
 import {registerInternalPlugin} from '@webex/webex-core';
 
 import Metrics from './metrics';
@@ -18,6 +16,7 @@ import {
   SubmitInternalEvent,
   SubmitOperationalEvent,
   SubmitMQE,
+  PreComputedLatencies,
 } from './metrics.types';
 import * as CALL_DIAGNOSTIC_CONFIG from './call-diagnostic/config';
 import * as CallDiagnosticUtils from './call-diagnostic/call-diagnostic-metrics.util';
@@ -51,4 +50,5 @@ export type {
   SubmitInternalEvent,
   SubmitMQE,
   SubmitOperationalEvent,
+  PreComputedLatencies,
 };

package/src/metrics.js

@@ -10,6 +10,7 @@ import {OS_NAME, OSMap, CLIENT_NAME} from './config';
 
 import Batcher from './batcher';
 import ClientMetricsBatcher from './client-metrics-batcher';
+import ClientMetricsPreloginBatcher from './client-metrics-prelogin-batcher';
 
 const {getOSName, getOSVersion, getBrowserName, getBrowserVersion} = BrowserDetection();
 
@@ -37,6 +38,7 @@ const Metrics = WebexPlugin.extend({
   children: {
     batcher: Batcher,
     clientMetricsBatcher: ClientMetricsBatcher,
+    clientMetricsPreloginBatcher: ClientMetricsPreloginBatcher,
   },
 
   namespace: 'Metrics',
@@ -56,11 +58,14 @@ const Metrics = WebexPlugin.extend({
       throw Error('Missing behavioral metric name. Please provide one');
     }
     const payload = {metricName: eventName};
+    // @ts-ignore
+    const providedClientVersion = this.webex.meetings?.config?.metrics?.clientVersion;
 
     payload.tags = {
       ...props.tags,
       browser: getBrowserName(),
       os: getOSNameInternal(),
+      appVersion: providedClientVersion,
 
       // Node does not like this so we need to check if it exists or not
       // eslint-disable-next-line no-undef
@@ -114,14 +119,9 @@ const Metrics = WebexPlugin.extend({
     const payload = this.getClientMetricsPayload(eventName, props);
 
     if (preLoginId) {
-      const _payload = {
-        metrics: [payload],
-      };
-
-      // Do not batch these because pre-login events occur during onboarding, so we will be partially blind
-      // to users' progress through the reg flow if we wait to persist pre-login metrics for people who drop off because
-      // their metrics will not post from a queue flush in time
-      return this.postPreLoginMetric(_payload, preLoginId);
+      this.clientMetricsPreloginBatcher.savePreLoginId(preLoginId);
+
+      return this.clientMetricsPreloginBatcher.request(payload);
     }
 
     return this.clientMetricsBatcher.request(payload);
@@ -146,21 +146,6 @@ const Metrics = WebexPlugin.extend({
       },
     });
   },
-
-  postPreLoginMetric(payload, preLoginId) {
-    return this.webex.credentials.getClientToken().then((token) =>
-      this.request({
-        method: 'POST',
-        api: 'metrics',
-        resource: 'clientmetrics-prelogin',
-        headers: {
-          authorization: token.toString(),
-          'x-prelogin-userid': preLoginId,
-        },
-        body: payload,
-      })
-    );
-  },
 });
 
 export default Metrics;

package/src/metrics.types.ts

@@ -16,6 +16,10 @@ export type ClientLaunchMethodType = NonNullable<
   RawEvent['origin']['clientInfo']
 >['clientLaunchMethod'];
 
+export type BrowserLaunchMethodType = NonNullable<
+  RawEvent['origin']['clientInfo']
+>['browserLaunchMethod'];
+
 export type SubmitClientEventOptions = {
   meetingId?: string;
   mediaConnections?: any[];
@@ -25,6 +29,7 @@ export type SubmitClientEventOptions = {
   environment?: EnvironmentType;
   newEnvironmentType?: NewEnvironmentType;
   clientLaunchMethod?: ClientLaunchMethodType;
+  browserLaunchMethod?: BrowserLaunchMethodType;
   webexConferenceIdStr?: string;
   globalMeetingId?: string;
 };
@@ -164,5 +169,11 @@ export type BuildClientEventFetchRequestOptions = (args: {
 export type PreComputedLatencies =
   | 'internal.client.pageJMT'
   | 'internal.download.time'
+  | 'internal.get.cluster.time'
   | 'internal.click.to.interstitial'
-  | 'internal.call.init.join.req';
+  | 'internal.refresh.captcha.time'
+  | 'internal.exchange.ci.token.time'
+  | 'internal.get.u2c.time'
+  | 'internal.call.init.join.req'
+  | 'internal.other.app.api.time'
+  | 'internal.api.fetch.intelligence.models';

package/src/new-metrics.ts

@@ -43,6 +43,8 @@ class Metrics extends WebexPlugin {
   constructor(...args) {
     super(...args);
 
+    // @ts-ignore
+    this.callDiagnosticLatencies = new CallDiagnosticLatencies({}, {parent: this.webex});
     this.onReady();
   }
 
@@ -54,8 +56,6 @@ class Metrics extends WebexPlugin {
     this.webex.once('ready', () => {
       // @ts-ignore
       this.callDiagnosticMetrics = new CallDiagnosticMetrics({}, {parent: this.webex});
-      // @ts-ignore
-      this.callDiagnosticLatencies = new CallDiagnosticLatencies({}, {parent: this.webex});
     });
   }
 

package/src/prelogin-metrics-batcher.ts

@@ -48,7 +48,7 @@ const PreLoginMetricsBatcher = Batcher.extend({
    * @returns {Promise<any>}
    */
   submitHttpRequest(payload: any) {
-    const batchId = uniqueId('prelogin-ca-batch-');
+    const batchId = uniqueId('prelogin-batch-');
     if (this.preLoginId === undefined) {
       this.webex.logger.error(
         PRE_LOGIN_METRICS_IDENTIFIER,

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

@@ -103,6 +103,12 @@ describe('plugin-metrics', () => {
           webex.internal.newMetrics.callDiagnosticLatencies.getClickToInterstitial = sinon
             .stub()
             .returns(10);
+          webex.internal.newMetrics.callDiagnosticLatencies.getRefreshCaptchaReqResp = sinon
+            .stub()
+            .returns(10);
+          webex.internal.newMetrics.callDiagnosticLatencies.getDownloadIntelligenceModelsReqResp =
+            sinon.stub().returns(42);
+
           const promise = webex.internal.newMetrics.callDiagnosticMetrics.submitToCallDiagnostics(
             //@ts-ignore
             {event: {name: 'client.interstitial-window.launched'}}
@@ -119,6 +125,8 @@ describe('plugin-metrics', () => {
             joinTimes: {
               clickToInterstitial: 10,
               meetingInfoReqResp: 10,
+              refreshCaptchaServiceReqResp: 10,
+              downloadIntelligenceModelsReqResp: 42,
             },
           });
           assert.lengthOf(
@@ -131,6 +139,12 @@ describe('plugin-metrics', () => {
           webex.internal.newMetrics.callDiagnosticLatencies.getDiffBetweenTimestamps = sinon
             .stub()
             .returns(10);
+          webex.internal.newMetrics.callDiagnosticLatencies.getU2CTime = sinon
+            .stub()
+            .returns(20);
+          webex.internal.newMetrics.callDiagnosticLatencies.getReachabilityClustersReqResp = sinon
+            .stub()
+            .returns(10);
           const promise = webex.internal.newMetrics.callDiagnosticMetrics.submitToCallDiagnostics(
             //@ts-ignore
             {event: {name: 'client.call.initiated'}}
@@ -147,6 +161,8 @@ describe('plugin-metrics', () => {
               meetingInfoReqResp: 10,
               registerWDMDeviceJMT: 10,
               showInterstitialTime: 10,
+              getU2CTime: 20,
+              getReachabilityClustersReqResp: 10
             },
           });
           assert.lengthOf(
@@ -159,9 +175,6 @@ describe('plugin-metrics', () => {
           webex.internal.newMetrics.callDiagnosticLatencies.getDiffBetweenTimestamps = sinon
             .stub()
             .returns(10);
-          webex.internal.newMetrics.callDiagnosticLatencies.getJoinRespSentReceived = sinon
-            .stub()
-            .returns(20);
           webex.internal.newMetrics.callDiagnosticLatencies.getPageJMT = sinon.stub().returns(30);
           webex.internal.newMetrics.callDiagnosticLatencies.getClientJMT = sinon.stub().returns(5);
           webex.internal.newMetrics.callDiagnosticLatencies.getClickToInterstitial = sinon
@@ -191,7 +204,6 @@ describe('plugin-metrics', () => {
               clickToInterstitial: 10,
               interstitialToJoinOK: 10,
               joinReqResp: 10,
-              joinReqSentReceived: 20,
               meetingInfoReqResp: 10,
               pageJmt: 30,
               totalJmt: 20,
@@ -357,9 +369,8 @@ describe('plugin-metrics', () => {
         });
       });
 
-      //TODO: The following two skipped tests needs investigation: https://jira-eng-gpk2.cisco.com/jira/browse/SPARK-485382
       describe('when the request fails', () => {
-        it.skip('does not clear the queue', async () => {
+        it('does not clear the queue', async () => {
           // avoid setting .sent timestamp
           webex.internal.newMetrics.callDiagnosticMetrics.callDiagnosticEventsBatcher.prepareRequest =
             (q) => Promise.resolve(q);
@@ -385,18 +396,17 @@ describe('plugin-metrics', () => {
             error = e;
           });
 
-          // This is horrific, but stubbing lodash is proving difficult
-          const expectedBatchId = parseInt(uniqueId()) - 1;
-
           // check that promise was rejected with the original error of the webex.request
           assert.deepEqual(err, error);
 
-          assert.calledOnceWithExactly(
-            webex.logger.error,
-            'call-diagnostic-events -> ',
-            `CallDiagnosticEventsBatcher: @submitHttpRequest#ca-batch-${expectedBatchId}. Request failed:`,
-            `error: formattedError`
+          const calls = webex.logger.error.getCalls();
+          assert.deepEqual(calls[0].args[0], 'call-diagnostic-events -> ');
+          // This is horrific, but stubbing lodash is proving difficult
+          assert.match(
+            calls[0].args[1],
+            /CallDiagnosticEventsBatcher: @submitHttpRequest#ca-batch-\d{0,}\. Request failed:/
           );
+          assert.deepEqual(calls[0].args[2], `error: formattedError`);
           assert.lengthOf(
             webex.internal.newMetrics.callDiagnosticMetrics.callDiagnosticEventsBatcher.queue,
             0
@@ -406,7 +416,7 @@ describe('plugin-metrics', () => {
     });
 
     describe('prepareItem', () => {
-      it.skip('calls prepareDiagnosticMetricItem correctly', async () => {
+      it('calls prepareDiagnosticMetricItem correctly', async () => {
         // avoid setting .sent timestamp
         webex.internal.newMetrics.callDiagnosticMetrics.callDiagnosticEventsBatcher.prepareRequest =
           (q) => Promise.resolve(q);