@webex/internal-plugin-metrics 3.11.0 → 3.12.0

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

@@ -0,0 +1,47 @@
+import GenericMetrics from './generic-metrics';
+import { EventPayload } from './metrics.types';
+import PreLoginMetricsBatcher from './prelogin-metrics-batcher';
+/**
+ * @description Util class to handle PreLogin Metrics
+ * @export
+ * @class PreLoginMetrics
+ */
+export default class PreLoginMetrics extends GenericMetrics {
+    private preLoginMetricsBatcher;
+    /**
+     * Constructor
+     * @param {PreLoginMetricsBatcher} preLoginMetricsBatcher - Pre-login metrics batcher
+     * @param {any} attrs - Attributes
+     * @param {any} options - Options
+     * @constructor
+     */
+    constructor(preLoginMetricsBatcher: typeof PreLoginMetricsBatcher, attrs?: any, options?: {
+        parent?: any;
+    });
+    /**
+     * Submit a business metric to our metrics endpoint.
+     * Routes to the correct table with the correct schema payload by table.
+     * @see https://confluence-eng-gpk2.cisco.com/conf/display/WAP/Business+metrics++-%3E+ROMA
+     * @param {Object} options - The options object
+     * @param {string} options.name - Name of the metric
+     * @param {string} options.preLoginId - ID to identify pre-login user
+     * @param {EventPayload} options.payload - User payload of the metric
+     * @param {EventPayload} [options.metadata] - Optional metadata to include outside of eventPayload.value
+     * @returns {Promise<void>} Promise that resolves when the metric is submitted
+     */
+    submitPreLoginEvent({ name, preLoginId, payload, metadata, }: {
+        name: string;
+        preLoginId: string;
+        payload: EventPayload;
+        metadata?: EventPayload;
+    }): Promise<void>;
+    /**
+     * Builds a formatted event object for metrics submission.
+     * @param {string} metricName - Metric name
+     * @param {string} preLoginId - Pre-login user identifier
+     * @param {EventPayload} payload - Metric payload data
+     * @param {EventPayload} metadata - Additional metadata to include in the event
+     * @returns {object} Formatted metrics event object with type, eventPayload, and timestamp
+     */
+    private buildEvent;
+}

package/package.json

@@ -24,23 +24,23 @@
     "@sinonjs/fake-timers": "^6.0.1",
     "@webex/babel-config-legacy": "0.0.0",
     "@webex/eslint-config-legacy": "0.0.0",
+    "@webex/event-dictionary-ts": "^1.0.2073",
     "@webex/jest-config-legacy": "0.0.0",
     "@webex/legacy-tools": "0.0.0",
-    "@webex/test-helper-chai": "3.11.0",
-    "@webex/test-helper-mocha": "3.11.0",
-    "@webex/test-helper-mock-webex": "3.11.0",
-    "@webex/test-helper-test-users": "3.11.0",
+    "@webex/test-helper-chai": "3.12.0",
+    "@webex/test-helper-mocha": "3.12.0",
+    "@webex/test-helper-mock-webex": "3.12.0",
+    "@webex/test-helper-test-users": "3.12.0",
     "eslint": "^8.24.0",
     "prettier": "^2.7.1",
     "sinon": "^9.2.4"
   },
   "dependencies": {
-    "@webex/common": "3.11.0",
-    "@webex/common-timers": "3.11.0",
-    "@webex/event-dictionary-ts": "^1.0.1930",
-    "@webex/test-helper-chai": "3.11.0",
-    "@webex/test-helper-mock-webex": "3.11.0",
-    "@webex/webex-core": "3.11.0",
+    "@webex/common": "3.12.0",
+    "@webex/common-timers": "3.12.0",
+    "@webex/test-helper-chai": "3.12.0",
+    "@webex/test-helper-mock-webex": "3.12.0",
+    "@webex/webex-core": "3.12.0",
     "ip-anonymize": "^0.1.0",
     "lodash": "^4.17.21",
     "uuid": "^3.3.2"
@@ -53,5 +53,5 @@
     "test:style": "eslint ./src/**/*.*",
     "test:unit": "webex-legacy-tools test --unit --runner mocha"
   },
-  "version": "3.11.0"
+  "version": "3.12.0"
 }

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

@@ -303,10 +303,7 @@ export default class CallDiagnosticLatencies extends WebexPlugin {
    * @returns - latency
    */
   public getStayLobbyTime() {
-    return this.getDiffBetweenTimestamps(
-      'client.locus.join.response',
-      'internal.host.meeting.participant.admitted'
-    );
+    return this.getDiffBetweenTimestamps('client.locus.join.response', 'client.lobby.exited');
   }
 
   /**
@@ -480,7 +477,8 @@ export default class CallDiagnosticLatencies extends WebexPlugin {
     const clickToInterstitial = this.getClickToInterstitial();
     const interstitialToJoinOk = this.getInterstitialToJoinOK();
     const joinConfJMT = this.getJoinConfJMT();
-    const lobbyTime = this.getStayLobbyTime();
+    const lobbyTimeLatency = this.getStayLobbyTime();
+    const lobbyTime = typeof lobbyTimeLatency === 'number' ? lobbyTimeLatency : 0;
 
     if (clickToInterstitial && interstitialToJoinOk && joinConfJMT) {
       const totalMediaJMT = clamp(

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

@@ -366,6 +366,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
     if (meeting?.locusInfo?.fullState) {
       identifiers.locusUrl = meeting.locusUrl;
       identifiers.locusId = meeting.locusUrl && meeting.locusUrl.split('/').pop();
+      identifiers.locusSessionId = meeting.locusInfo.fullState.sessionId;
       identifiers.locusStartTime =
         meeting.locusInfo.fullState && meeting.locusInfo.fullState.lastActive;
     }

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

@@ -179,6 +179,16 @@ export const isSdpOfferCreationError = (rawError: any) => {
   return false;
 };
 
+export const isWebrtcApiNotAvailableError = (
+  rawError: {code: number; message: string; name: string} | unknown
+) => {
+  if ((rawError as {name: string}).name === ERROR_DESCRIPTIONS.WEBRTC_API_NOT_AVAILABLE) {
+    return true;
+  }
+
+  return false;
+};
+
 /**
  * Checks if the given error is a browser media error by its name.
  * Returns true if the error name matches any known browser media error name in the mapping.
@@ -351,7 +361,6 @@ export const prepareDiagnosticMetricItem = (webex: any, item: any) => {
       joinTimes.totalMediaJMT = cdl.getTotalMediaJMT();
       joinTimes.interstitialToMediaOKJMT = cdl.getInterstitialToMediaOKJMT();
       joinTimes.callInitMediaEngineReady = cdl.getCallInitMediaEngineReady();
-      joinTimes.stayLobbyTime = cdl.getStayLobbyTime();
       joinTimes.totalMediaJMTWithUserDelay = cdl.getTotalMediaJMTWithUserDelay();
       joinTimes.totalJMTWithUserDelay = cdl.getTotalJMTWithUserDelay();
       break;
@@ -359,6 +368,11 @@ export const prepareDiagnosticMetricItem = (webex: any, item: any) => {
     case 'client.media.tx.start':
       audioSetupDelay.joinRespTxStart = cdl.getAudioJoinRespTxStart();
       videoSetupDelay.joinRespTxStart = cdl.getVideoJoinRespTxStart();
+      break;
+
+    case 'client.lobby.exited':
+      joinTimes.stayLobbyTime = cdl.getStayLobbyTime();
+      break;
   }
 
   if (!isEmpty(joinTimes)) {

package/src/call-diagnostic/config.ts

@@ -133,6 +133,7 @@ export const ERROR_DESCRIPTIONS = {
   MULTISTREAM_NOT_AVAILABLE: 'MultistreamNotAvailable',
   SDP_OFFER_CREATION_ERROR: 'SdpOfferCreationError',
   SDP_OFFER_CREATION_ERROR_MISSING_CODEC: 'SdpOfferCreationErrorMissingCodec',
+  WEBRTC_API_NOT_AVAILABLE: 'WebrtcApiNotAvailableError',
   WDM_RESTRICTED_REGION: 'WdmRestrictedRegion',
   USER_NOT_ALLOWED_JOIN_WEBINAR: 'UserNotAllowedJoinWebinar',
 };

package/src/generic-metrics.ts

@@ -79,7 +79,7 @@ export default abstract class GenericMetrics extends StatelessWebexPlugin {
       device: {
         id: this.getDeviceId(),
       },
-      locale: window.navigator.language,
+      locale: window?.navigator.language,
       os: {
         name: getOSNameInternal(),
         version: getOSVersion(),
@@ -94,12 +94,12 @@ export default abstract class GenericMetrics extends StatelessWebexPlugin {
   protected getBrowserDetails(): object {
     return {
       browser: getBrowserName(),
-      browserHeight: window.innerHeight,
+      browserHeight: window?.innerHeight,
       browserVersion: getBrowserVersion(),
-      browserWidth: window.innerWidth,
-      domain: window.location.hostname,
-      inIframe: window.self !== window.top,
-      locale: window.navigator.language,
+      browserWidth: window?.innerWidth,
+      domain: window?.location.hostname,
+      inIframe: window?.self !== window?.top,
+      locale: window?.navigator.language,
       os: getOSNameInternal(),
     };
   }

package/src/index.ts

@@ -28,6 +28,7 @@ import BehavioralMetrics from './behavioral-metrics';
 import OperationalMetrics from './operational-metrics';
 import BusinessMetrics from './business-metrics';
 import RtcMetrics from './rtcMetrics';
+import PreLoginMetrics from './prelogin-metrics';
 
 registerInternalPlugin('metrics', Metrics, {
   config,
@@ -51,6 +52,7 @@ export {
   OperationalMetrics,
   BusinessMetrics,
   RtcMetrics,
+  PreLoginMetrics,
 };
 export type {
   ClientEvent,

package/src/metrics.types.ts

@@ -1,4 +1,4 @@
-import {
+import type {
   ClientEvent as RawClientEvent,
   Event as RawEvent,
   MediaQualityEvent as RawMediaQualityEvent,
@@ -197,7 +197,7 @@ export interface BusinessEventPayload {
   metricName: string;
   timestamp: number;
   context: DeviceContext;
-  browserDetails: EventPayload;
+  browserDetails: object;
   value: EventPayload;
 }
 

package/src/new-metrics.ts

@@ -9,6 +9,8 @@ import CallDiagnosticMetrics from './call-diagnostic/call-diagnostic-metrics';
 import BehavioralMetrics from './behavioral-metrics';
 import OperationalMetrics from './operational-metrics';
 import BusinessMetrics from './business-metrics';
+import PreLoginMetrics from './prelogin-metrics';
+import PreLoginMetricsBatcher from './prelogin-metrics-batcher';
 import {
   RecursivePartial,
   MetricEventProduct,
@@ -45,6 +47,7 @@ class Metrics extends WebexPlugin {
   behavioralMetrics: BehavioralMetrics;
   operationalMetrics: OperationalMetrics;
   businessMetrics: BusinessMetrics;
+  preLoginMetrics: PreLoginMetrics;
   isReady = false;
 
   /**
@@ -87,6 +90,13 @@ class Metrics extends WebexPlugin {
     this.webex.once('ready', () => {
       // @ts-ignore
       this.callDiagnosticMetrics = new CallDiagnosticMetrics({}, {parent: this.webex});
+      this.preLoginMetrics = new PreLoginMetrics(
+        // @ts-ignore
+        new PreLoginMetricsBatcher({}, {parent: this.webex}),
+        {},
+        // @ts-ignore
+        {parent: this.webex}
+      );
       this.isReady = true;
       this.setDelaySubmitClientEvents({
         shouldDelay: this.delaySubmitClientEvents,
@@ -251,6 +261,38 @@ class Metrics extends WebexPlugin {
     return this.businessMetrics.submitBusinessEvent({name, payload, table, metadata});
   }
 
+  /**
+   * Call Analyzer: Pre-Login Event
+   * @param args
+   */
+  submitPreLoginEvent({
+    name,
+    preLoginId,
+    payload,
+    metadata,
+  }: {
+    name: string;
+    preLoginId: string;
+    payload: EventPayload;
+    metadata?: EventPayload;
+  }): Promise<void> {
+    if (!this.isReady) {
+      // @ts-ignore
+      this.webex.logger.log(
+        `NewMetrics: @submitPreLoginEvent. Attempted to submit before webex.ready: ${name}`
+      );
+
+      return Promise.resolve();
+    }
+
+    return this.preLoginMetrics.submitPreLoginEvent({
+      name,
+      preLoginId,
+      payload,
+      metadata,
+    });
+  }
+
   /**
    * Call Analyzer: Media Quality Event
    * @param args

package/src/prelogin-metrics.ts

@@ -0,0 +1,94 @@
+import GenericMetrics from './generic-metrics';
+import {BusinessEvent, EventPayload} from './metrics.types';
+import PreLoginMetricsBatcher from './prelogin-metrics-batcher';
+
+/**
+ * @description Util class to handle PreLogin Metrics
+ * @export
+ * @class PreLoginMetrics
+ */
+export default class PreLoginMetrics extends GenericMetrics {
+  private preLoginMetricsBatcher: typeof PreLoginMetricsBatcher;
+
+  /**
+   * Constructor
+   * @param {PreLoginMetricsBatcher} preLoginMetricsBatcher - Pre-login metrics batcher
+   * @param {any} attrs - Attributes
+   * @param {any} options - Options
+   * @constructor
+   */
+  constructor(
+    preLoginMetricsBatcher: typeof PreLoginMetricsBatcher,
+    attrs: any = {},
+    options: {parent?: any} = {}
+  ) {
+    super(attrs, options);
+    this.preLoginMetricsBatcher = preLoginMetricsBatcher;
+  }
+
+  /**
+   * Submit a business metric to our metrics endpoint.
+   * Routes to the correct table with the correct schema payload by table.
+   * @see https://confluence-eng-gpk2.cisco.com/conf/display/WAP/Business+metrics++-%3E+ROMA
+   * @param {Object} options - The options object
+   * @param {string} options.name - Name of the metric
+   * @param {string} options.preLoginId - ID to identify pre-login user
+   * @param {EventPayload} options.payload - User payload of the metric
+   * @param {EventPayload} [options.metadata] - Optional metadata to include outside of eventPayload.value
+   * @returns {Promise<void>} Promise that resolves when the metric is submitted
+   */
+  public submitPreLoginEvent({
+    name,
+    preLoginId,
+    payload,
+    metadata,
+  }: {
+    name: string;
+    preLoginId: string;
+    payload: EventPayload;
+    metadata?: EventPayload;
+  }): Promise<void> {
+    if (!metadata) {
+      metadata = {};
+    }
+    if (!metadata.appType) {
+      metadata.appType = 'Web Client';
+    }
+
+    const finalEvent = this.buildEvent(name, preLoginId, payload, metadata);
+
+    this.preLoginMetricsBatcher.savePreLoginId(preLoginId);
+
+    return this.preLoginMetricsBatcher.request(finalEvent);
+  }
+
+  /**
+   * Builds a formatted event object for metrics submission.
+   * @param {string} metricName - Metric name
+   * @param {string} preLoginId - Pre-login user identifier
+   * @param {EventPayload} payload - Metric payload data
+   * @param {EventPayload} metadata - Additional metadata to include in the event
+   * @returns {object} Formatted metrics event object with type, eventPayload, and timestamp
+   */
+  private buildEvent(
+    metricName: string,
+    preLoginId: string,
+    payload: EventPayload,
+    metadata: EventPayload
+  ): BusinessEvent {
+    return {
+      type: ['business'],
+      eventPayload: {
+        metricName,
+        browserDetails: this.getBrowserDetails(),
+        context: this.getContext(),
+        timestamp: new Date().getTime(),
+        value: {
+          preLoginId,
+          ...metadata,
+          ...payload,
+        },
+      },
+    };
+  }
+}

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

@@ -142,9 +142,7 @@ 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.getU2CTime = sinon.stub().returns(20);
           webex.internal.newMetrics.callDiagnosticLatencies.getReachabilityClustersReqResp = sinon
             .stub()
             .returns(10);
@@ -165,7 +163,7 @@ describe('plugin-metrics', () => {
               registerWDMDeviceJMT: 10,
               showInterstitialTime: 10,
               getU2CTime: 20,
-              getReachabilityClustersReqResp: 10
+              getReachabilityClustersReqResp: 10,
             },
           });
           assert.lengthOf(
@@ -189,9 +187,8 @@ describe('plugin-metrics', () => {
           webex.internal.newMetrics.callDiagnosticLatencies.getDownloadTimeJMT = sinon
             .stub()
             .returns(100);
-          webex.internal.newMetrics.callDiagnosticLatencies.getClickToInterstitialWithUserDelay = sinon
-            .stub()
-            .returns(43);
+          webex.internal.newMetrics.callDiagnosticLatencies.getClickToInterstitialWithUserDelay =
+            sinon.stub().returns(43);
           webex.internal.newMetrics.callDiagnosticLatencies.getTotalJMTWithUserDelay = sinon
             .stub()
             .returns(64);
@@ -346,7 +343,7 @@ describe('plugin-metrics', () => {
           webex.internal.newMetrics.callDiagnosticLatencies.getInterstitialToJoinOK = sinon
             .stub()
             .returns(7);
-            webex.internal.newMetrics.callDiagnosticLatencies.getStayLobbyTime = sinon
+          webex.internal.newMetrics.callDiagnosticLatencies.getStayLobbyTime = sinon
             .stub()
             .returns(1);
           webex.internal.newMetrics.callDiagnosticLatencies.getTotalMediaJMTWithUserDelay = sinon
@@ -372,7 +369,6 @@ describe('plugin-metrics', () => {
               totalMediaJMT: 61,
               interstitialToMediaOKJMT: 22,
               callInitMediaEngineReady: 10,
-              stayLobbyTime: 1,
               totalMediaJMTWithUserDelay: 43,
               totalJMTWithUserDelay: 64,
             },
@@ -382,6 +378,34 @@ describe('plugin-metrics', () => {
             0
           );
         });
+
+        it('appends the correct join times to the request for client.lobby.exited', async () => {
+          webex.internal.newMetrics.callDiagnosticLatencies.getStayLobbyTime = sinon
+            .stub()
+            .returns(10);
+
+          const promise = webex.internal.newMetrics.callDiagnosticMetrics.submitToCallDiagnostics(
+            //@ts-ignore
+            {event: {name: 'client.lobby.exited'}}
+          );
+          await flushPromises();
+          clock.tick(config.metrics.batcherWait);
+
+          await promise;
+
+          //@ts-ignore
+          assert.calledOnce(webex.request);
+          assert.deepEqual(webex.request.getCalls()[0].args[0].body.metrics[0].eventPayload.event, {
+            name: 'client.lobby.exited',
+            joinTimes: {
+              stayLobbyTime: 10,
+            },
+          });
+          assert.lengthOf(
+            webex.internal.newMetrics.callDiagnosticMetrics.callDiagnosticEventsBatcher.queue,
+            0
+          );
+        });
       });
 
       describe('when the request fails', () => {