@webex/internal-plugin-metrics 3.7.0 → 3.8.0-next.10

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
@@ -164,7 +166,15 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
       if (meetingInfo?.webexScheduled && !meetingInfo?.enableEvent && !meetingInfo?.pmr) {
         return WEBEX_SUB_SERVICE_TYPES.SCHEDULED_MEETING;
       }
-      // if Scheduled, Webinar, not pmr - then Webinar
+
+      // if ConvergedArchitecture enable and isConvergedWebinarWebcast -- then webcast
+      if (meetingInfo?.enableConvergedArchitecture && meetingInfo?.enableEvent) {
+        return meetingInfo?.isConvergedWebinarWebcast
+          ? WEBEX_SUB_SERVICE_TYPES.WEBCAST
+          : WEBEX_SUB_SERVICE_TYPES.WEBINAR;
+      }
+
+      // if Scheduled, enable event, not pmr - then Webinar
       if (meetingInfo?.webexScheduled && meetingInfo?.enableEvent && !meetingInfo?.pmr) {
         return WEBEX_SUB_SERVICE_TYPES.WEBINAR;
       }
@@ -377,7 +387,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
    * @returns
    */
   prepareDiagnosticEvent(eventData: Event['event'], options: any) {
-    const {meetingId} = options;
+    const {meetingId, triggeredTime} = options;
     const origin = this.getOrigin(options, meetingId);
 
     const event: Event = {
@@ -385,7 +395,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
       version: 1,
       origin,
       originTime: {
-        triggered: new Date().toISOString(),
+        triggered: triggeredTime || new Date().toISOString(),
         // is overridden in prepareRequest batcher
         sent: 'not_defined_yet',
       },
@@ -715,13 +725,25 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
       isConvergedArchitectureEnabled: this.getIsConvergedArchitectureEnabled({
         meetingId,
       }),
+      ...(meeting.userNameInput && {userNameInput: meeting.userNameInput}),
+      ...(meeting.emailInput && {emailInput: meeting.emailInput}),
       webexSubServiceType: this.getSubServiceType(meeting),
+      // @ts-ignore
+      webClientPreload: this.webex.meetings?.config?.metrics?.webClientPreload,
     };
 
     const joinFlowVersion = options.joinFlowVersion ?? meeting.callStateForMetrics?.joinFlowVersion;
     if (joinFlowVersion) {
       clientEventObject.joinFlowVersion = joinFlowVersion;
     }
+    const meetingJoinedTime = meeting.isoLocalClientMeetingJoinTime;
+    if (meetingJoinedTime) {
+      clientEventObject.meetingJoinedTime = meetingJoinedTime;
+    }
+
+    if (options.meetingJoinPhase) {
+      clientEventObject.meetingJoinPhase = options.meetingJoinPhase;
+    }
 
     return clientEventObject;
   }
@@ -764,12 +786,26 @@ 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) {
       clientEventObject.joinFlowVersion = options.joinFlowVersion;
     }
 
+    if (options.meetingJoinPhase) {
+      clientEventObject.meetingJoinPhase = options.meetingJoinPhase;
+    }
+
+    if (options.userNameInput) {
+      clientEventObject.userNameInput = options.userNameInput;
+    }
+
+    if (options.emailInput) {
+      clientEventObject.emailInput = options.emailInput;
+    }
+
     return clientEventObject;
   }
 
@@ -834,17 +870,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.',
@@ -861,6 +916,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/call-diagnostic/config.ts

@@ -17,12 +17,14 @@ export const DTLS_HANDSHAKE_FAILED_CLIENT_CODE = 2008;
 export const ICE_FAILED_WITH_TURN_TLS_CLIENT_CODE = 2010;
 export const ICE_FAILED_WITHOUT_TURN_TLS_CLIENT_CODE = 2009;
 export const ICE_AND_REACHABILITY_FAILED_CLIENT_CODE = 2011;
+export const MULTISTREAM_NOT_AVAILABLE_CLIENT_CODE = 2012;
 export const WBX_APP_API_URL = 'wbxappapi'; // MeetingInfo WebexAppApi response object normally contains a body.url that includes the string 'wbxappapi'
 
 export const WEBEX_SUB_SERVICE_TYPES: Record<string, ClientSubServiceType> = {
   PMR: 'PMR',
   SCHEDULED_MEETING: 'ScheduledMeeting',
   WEBINAR: 'Webinar',
+  WEBCAST: 'Webcast',
 };
 
 // Found in https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia
@@ -127,6 +129,7 @@ export const ERROR_DESCRIPTIONS = {
   ICE_FAILED_WITHOUT_TURN_TLS: 'ICEFailedWithoutTURN_TLS',
   ICE_FAILED_WITH_TURN_TLS: 'ICEFailedWithTURN_TLS',
   ICE_AND_REACHABILITY_FAILED: 'ICEAndReachabilityFailed',
+  MULTISTREAM_NOT_AVAILABLE: 'MultistreamNotAvailable',
   SDP_OFFER_CREATION_ERROR: 'SdpOfferCreationError',
   SDP_OFFER_CREATION_ERROR_MISSING_CODEC: 'SdpOfferCreationErrorMissingCodec',
   WDM_RESTRICTED_REGION: 'WdmRestrictedRegion',
@@ -409,6 +412,11 @@ export const CLIENT_ERROR_CODE_TO_ERROR_PAYLOAD: Record<number, Partial<ClientEv
     category: 'expected',
     fatal: true,
   },
+  [MULTISTREAM_NOT_AVAILABLE_CLIENT_CODE]: {
+    errorDescription: ERROR_DESCRIPTIONS.MULTISTREAM_NOT_AVAILABLE,
+    category: 'expected',
+    fatal: false,
+  },
   2050: {
     errorDescription: ERROR_DESCRIPTIONS.SDP_OFFER_CREATION_ERROR,
     category: 'media',

package/src/generic-metrics.ts

@@ -37,7 +37,7 @@ export default abstract class GenericMetrics extends StatelessWebexPlugin {
   }
 
   /**
-   * Submit a buisness metric to our metrics endpoint.
+   * Submit a business metric to our metrics endpoint.
    * @param {string} kind of metric for logging
    * @param {string} name of the metric
    * @param {object} event
@@ -105,7 +105,7 @@ export default abstract class GenericMetrics extends StatelessWebexPlugin {
   }
 
   /**
-   * Returns true once we have the deviceId we need to submit behavioral/operational/buisness events
+   * Returns true once we have the deviceId we need to submit behavioral/operational/business events
    * @returns {boolean}
    */
   public isReadyToSubmitEvents(): boolean {

package/src/index.ts

@@ -15,6 +15,7 @@ import {
   SubmitClientEvent,
   SubmitInternalEvent,
   SubmitOperationalEvent,
+  SubmitBusinessEvent,
   SubmitMQE,
   PreComputedLatencies,
 } from './metrics.types';
@@ -58,5 +59,6 @@ export type {
   SubmitInternalEvent,
   SubmitMQE,
   SubmitOperationalEvent,
+  SubmitBusinessEvent,
   PreComputedLatencies,
 };

package/src/metrics.types.ts

@@ -16,11 +16,15 @@ export type ClientLaunchMethodType = NonNullable<
   RawEvent['origin']['clientInfo']
 >['clientLaunchMethod'];
 
+export type ClientUserNameInput = NonNullable<RawClientEvent['userNameInput']>;
+
+export type ClientEmailInput = NonNullable<RawClientEvent['emailInput']>;
+
 export type BrowserLaunchMethodType = NonNullable<
   RawEvent['origin']['clientInfo']
 >['browserLaunchMethod'];
 
-export type MetricEventProduct = 'webex' | 'wxcc_desktop';
+export type MetricEventProduct = 'webex' | 'wxcc_desktop' | 'wxcc_crm' | 'wxcc_sdk';
 
 export type MetricEventAgent = 'user' | 'browser' | 'system' | 'sdk' | 'redux' | 'service' | 'api';
 
@@ -111,6 +115,7 @@ export type MetricEventVerb =
   | 'exit';
 
 export type MetricEventJoinFlowVersion = 'Other' | 'NewFTE';
+export type MetricEventMeetingJoinPhase = 'pre-join' | 'join' | 'in-meeting';
 
 export type SubmitClientEventOptions = {
   meetingId?: string;
@@ -126,6 +131,10 @@ export type SubmitClientEventOptions = {
   webexConferenceIdStr?: string;
   globalMeetingId?: string;
   joinFlowVersion?: MetricEventJoinFlowVersion;
+  meetingJoinPhase?: MetricEventMeetingJoinPhase;
+  triggeredTime?: string;
+  emailInput?: ClientEmailInput;
+  userNameInput?: ClientUserNameInput;
 };
 
 export type SubmitMQEOptions = {
@@ -278,6 +287,11 @@ export type SubmitOperationalEvent = (args: {
   payload: EventPayload;
 }) => void;
 
+export type SubmitBusinessEvent = (args: {
+  name: OperationalEvent['metricName'];
+  payload: EventPayload;
+}) => void;
+
 export type SubmitMQE = (args: {
   name: MediaQualityEvent['name'];
   payload: SubmitMQEPayload;
@@ -317,3 +331,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
@@ -141,7 +146,7 @@ class Metrics extends WebexPlugin {
   }
 
   /**
-   * @returns true once we have the deviceId we need to submit buisness events
+   * @returns true once we have the deviceId we need to submit business events
    */
   isReadyToSubmitBusinessEvents() {
     this.lazyBuildBusinessMetrics();
@@ -200,17 +205,19 @@ class Metrics extends WebexPlugin {
   }
 
   /**
-   * Buisness event
+   * Business event
    * @param args
    */
   submitBusinessEvent({
     name,
     payload,
     table,
+    metadata,
   }: {
     name: string;
     payload: EventPayload;
     table?: Table;
+    metadata?: EventPayload;
   }) {
     if (!this.isReady) {
       // @ts-ignore
@@ -223,7 +230,7 @@ class Metrics extends WebexPlugin {
 
     this.lazyBuildBusinessMetrics();
 
-    return this.businessMetrics.submitBusinessEvent({name, payload, table});
+    return this.businessMetrics.submitBusinessEvent({name, payload, table, metadata});
   }
 
   /**
@@ -288,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,
+    });
   }
 
   /**
@@ -387,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/business/business-metrics.ts

@@ -154,11 +154,12 @@ describe('internal-plugin-metrics', () => {
           businessMetrics.clientMetricsBatcher.request = request;
           
           assert.equal(requestCalls.length, 0)
-          businessMetrics.submitBusinessEvent({ name: "foobar", payload: {bar:"gee"}, table: 'business_metrics' })
+          businessMetrics.submitBusinessEvent({ name: "foobar", payload: {bar: "gee"}, table: 'business_metrics', metadata: {asdf: 'hjkl'} })
           assert.equal(requestCalls.length, 1)
           assert.deepEqual(requestCalls[0], {
             eventPayload: {
               key: 'foobar',
+              asdf: 'hjkl',
               appType: 'Web Client',
               client_timestamp: requestCalls[0].eventPayload.client_timestamp, // This is to bypass time check, which is checked below.
               value: {
@@ -173,7 +174,6 @@ describe('internal-plugin-metrics', () => {
                 os: getOSNameInternal(),
                 app: {version: 'webex-version'},
                 device: {id: 'deviceId'},
-                locale: 'language',
               }
             },
             type: ['business'],

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

@@ -283,6 +283,18 @@ describe('internal-plugin-metrics', () => {
         cdl.saveTimestamp({key: 'internal.client.meetinginfo.response', value: 20});
         assert.deepEqual(saveFirstTimestamp.callCount, 1);
       });
+
+      it('calls saveFirstTimestamp for remote SDP received', () => {
+        const saveFirstTimestamp = sinon.stub(cdl, 'saveFirstTimestampOnly');
+        cdl.saveTimestamp({key: 'client.media-engine.remote-sdp-received', value: 10});
+        assert.deepEqual(saveFirstTimestamp.callCount, 1);
+      });
+
+      it('clears timestamp for remote SDP received when local SDP generated', () => {
+        cdl.saveTimestamp({key: 'client.media-engine.remote-sdp-received', value: 10});
+        cdl.saveTimestamp({key: 'client.media-engine.local-sdp-generated', value: 20});
+        assert.isUndefined(cdl.latencyTimestamps.get('client.media-engine.remote-sdp-received'));
+      });
     });
 
     it('calculates getShowInterstitialTime correctly', () => {
@@ -425,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',
@@ -437,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',
@@ -469,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',