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

package/src/metrics.types.ts

@@ -2,9 +2,12 @@ import {
   ClientEvent as RawClientEvent,
   Event as RawEvent,
   MediaQualityEvent as RawMediaQualityEvent,
+  FeatureEvent as RawFeatureEvent,
 } from '@webex/event-dictionary-ts';
 
-export type Event = Omit<RawEvent, 'event'> & {event: RawClientEvent | RawMediaQualityEvent};
+export type Event = Omit<RawEvent, 'event'> & {
+  event: RawClientEvent | RawMediaQualityEvent | RawFeatureEvent;
+};
 
 export type ClientEventError = NonNullable<RawClientEvent['errors']>[0];
 
@@ -16,11 +19,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' | 'wxcc_crm';
+export type MetricEventProduct = 'webex' | 'wxcc_desktop' | 'wxcc_crm' | 'wxcc_sdk';
 
 export type MetricEventAgent = 'user' | 'browser' | 'system' | 'sdk' | 'redux' | 'service' | 'api';
 
@@ -129,6 +136,8 @@ export type SubmitClientEventOptions = {
   joinFlowVersion?: MetricEventJoinFlowVersion;
   meetingJoinPhase?: MetricEventMeetingJoinPhase;
   triggeredTime?: string;
+  emailInput?: ClientEmailInput;
+  userNameInput?: ClientUserNameInput;
 };
 
 export type SubmitMQEOptions = {
@@ -206,10 +215,9 @@ export type BehavioralEvent = TaggedEvent;
 export type OperationalEvent = TaggedEvent;
 
 export interface FeatureEvent {
-  // TODO: not implemented
-  name: never;
-  payload?: never;
-  options?: never;
+  name: RawFeatureEvent['name'];
+  payload?: RawFeatureEvent;
+  options?: SubmitClientEventOptions;
 }
 
 export interface MediaQualityEvent {
@@ -245,6 +253,8 @@ export type ClientEventPayload = RecursivePartial<ClientEvent['payload']>;
 export type ClientEventLeaveReason = ClientEvent['payload']['leaveReason'];
 export type ClientEventPayloadError = ClientEvent['payload']['errors'];
 
+export type ClientFeatureEventPayload = RecursivePartial<FeatureEvent['payload']>;
+
 export type MediaQualityEventAudioSetupDelayPayload = NonNullable<
   MediaQualityEvent['payload']
 >['audioSetupDelay'];
@@ -281,6 +291,13 @@ export type SubmitOperationalEvent = (args: {
   payload: EventPayload;
 }) => void;
 
+export type SubmitBusinessEvent = (args: {
+  name: OperationalEvent['metricName'];
+  payload: EventPayload;
+  metadata?: EventPayload;
+  table?: Table;
+}) => void;
+
 export type SubmitMQE = (args: {
   name: MediaQualityEvent['name'];
   payload: SubmitMQEPayload;
@@ -298,6 +315,7 @@ export type PreComputedLatencies =
   | 'internal.download.time'
   | 'internal.get.cluster.time'
   | 'internal.click.to.interstitial'
+  | 'internal.click.to.interstitial.with.user.delay'
   | 'internal.refresh.captcha.time'
   | 'internal.exchange.ci.token.time'
   | 'internal.get.u2c.time'
@@ -326,3 +344,15 @@ export interface DelayedClientEvent {
   payload?: RecursivePartial<ClientEvent['payload']>;
   options?: SubmitClientEventOptions;
 }
+
+export type SubmitFeatureEvent = (args: {
+  name: FeatureEvent['name'];
+  payload?: RecursivePartial<FeatureEvent['payload']>;
+  options?: SubmitClientEventOptions;
+}) => Promise<any>;
+
+export interface DelayedClientFeatureEvent {
+  name: FeatureEvent['name'];
+  payload?: RecursivePartial<FeatureEvent['payload']>;
+  options?: SubmitClientEventOptions;
+}

package/src/new-metrics.ts

@@ -22,6 +22,8 @@ import {
   InternalEvent,
   SubmitClientEventOptions,
   Table,
+  DelayedClientEvent,
+  DelayedClientFeatureEvent,
 } from './metrics.types';
 import CallDiagnosticLatencies from './call-diagnostic/call-diagnostic-metrics-latencies';
 import {setMetricTimings} from './call-diagnostic/call-diagnostic-metrics.util';
@@ -50,6 +52,18 @@ class Metrics extends WebexPlugin {
    */
   delaySubmitClientEvents = false;
 
+  /**
+   * Whether or not to delay the submission of feature events.
+   */
+  delaySubmitClientFeatureEvents = false;
+
+  /**
+   * Overrides for delayed client events. E.g. if you want to override the correlationId for all delayed client events, you can set this to { correlationId: 'newCorrelationId' }
+   */
+  delayedClientEventsOverrides: Partial<DelayedClientEvent['options']> = {};
+
+  delayedClientFeatureEventsOverrides: Partial<DelayedClientFeatureEvent['options']> = {};
+
   /**
    * Constructor
    * @param args
@@ -74,6 +88,10 @@ class Metrics extends WebexPlugin {
       // @ts-ignore
       this.callDiagnosticMetrics = new CallDiagnosticMetrics({}, {parent: this.webex});
       this.isReady = true;
+      this.setDelaySubmitClientEvents({
+        shouldDelay: this.delaySubmitClientEvents,
+        overrides: this.delayedClientEventsOverrides,
+      });
     });
   }
 
@@ -265,7 +283,25 @@ class Metrics extends WebexPlugin {
     payload?: RecursivePartial<FeatureEvent['payload']>;
     options: any;
   }) {
-    throw new Error('Not implemented.');
+    if (!this.callDiagnosticLatencies || !this.callDiagnosticMetrics) {
+      // @ts-ignore
+      this.webex.logger.log(
+        `NewMetrics: @submitFeatureEvent. Attempted to submit before webex.ready. Event name: ${name}`
+      );
+
+      return Promise.resolve();
+    }
+    this.callDiagnosticLatencies.saveTimestamp({
+      key: name,
+      options: {meetingId: options?.meetingId},
+    });
+
+    return this.callDiagnosticMetrics.submitFeatureEvent({
+      name,
+      payload,
+      options,
+      delaySubmitEvent: this.delaySubmitClientFeatureEvents,
+    });
   }
 
   /**
@@ -404,13 +440,45 @@ class Metrics extends WebexPlugin {
    * 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.
+   * @param {object} options - {shouldDelay: A boolean value indicating whether to delay the submission of client events, overrides: An object containing overrides for the client events}
    */
-  public setDelaySubmitClientEvents(shouldDelay: boolean) {
+  public setDelaySubmitClientEvents({
+    shouldDelay,
+    overrides,
+  }: {
+    shouldDelay: boolean;
+    overrides?: Partial<DelayedClientEvent['options']>;
+  }) {
     this.delaySubmitClientEvents = shouldDelay;
+    this.delayedClientEventsOverrides = overrides || {};
+
+    if (this.isReady && !shouldDelay) {
+      return this.callDiagnosticMetrics.submitDelayedClientEvents(overrides);
+    }
+
+    return Promise.resolve();
+  }
+
+  /**
+   * Sets the value of setDelaySubmitClientFeatureEvents.
+   * If set to true, feature events will be delayed until submitDelayedClientFeatureEvents is called.
+   * If set to false, delayed feature events will be submitted.
+   *
+   * @param {object} options - {shouldDelay: A boolean value indicating whether to delay the submission of feature events,
+   * overrides: An object containing overrides for the feature events}
+   */
+  public setDelaySubmitClientFeatureEvents({
+    shouldDelay,
+    overrides,
+  }: {
+    shouldDelay: boolean;
+    overrides?: Partial<DelayedClientFeatureEvent['options']>;
+  }) {
+    this.delaySubmitClientFeatureEvents = shouldDelay;
+    this.delayedClientFeatureEventsOverrides = overrides || {};
 
-    if (!shouldDelay) {
-      return this.callDiagnosticMetrics.submitDelayedClientEvents();
+    if (this.isReady && !shouldDelay) {
+      return this.callDiagnosticMetrics.submitDelayedClientFeatureEvents(overrides);
     }
 
     return Promise.resolve();

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

@@ -108,6 +108,8 @@ describe('plugin-metrics', () => {
             .returns(10);
           webex.internal.newMetrics.callDiagnosticLatencies.getDownloadIntelligenceModelsReqResp =
             sinon.stub().returns(42);
+          webex.internal.newMetrics.callDiagnosticLatencies.getClickToInterstitialWithUserDelay =
+            sinon.stub().returns(12);
 
           const promise = webex.internal.newMetrics.callDiagnosticMetrics.submitToCallDiagnostics(
             //@ts-ignore
@@ -127,6 +129,7 @@ describe('plugin-metrics', () => {
               meetingInfoReqResp: 10,
               refreshCaptchaServiceReqResp: 10,
               downloadIntelligenceModelsReqResp: 42,
+              clickToInterstitialWithUserDelay: 12,
             },
           });
           assert.lengthOf(
@@ -183,9 +186,15 @@ describe('plugin-metrics', () => {
           webex.internal.newMetrics.callDiagnosticLatencies.getCallInitJoinReq = sinon
             .stub()
             .returns(10);
-            webex.internal.newMetrics.callDiagnosticLatencies.getDownloadTimeJMT = sinon
+          webex.internal.newMetrics.callDiagnosticLatencies.getDownloadTimeJMT = sinon
             .stub()
             .returns(100);
+          webex.internal.newMetrics.callDiagnosticLatencies.getClickToInterstitialWithUserDelay = sinon
+            .stub()
+            .returns(43);
+          webex.internal.newMetrics.callDiagnosticLatencies.getTotalJMTWithUserDelay = sinon
+            .stub()
+            .returns(64);
           const promise = webex.internal.newMetrics.callDiagnosticMetrics.submitToCallDiagnostics(
             //@ts-ignore
             {event: {name: 'client.locus.join.response'}}
@@ -209,6 +218,8 @@ describe('plugin-metrics', () => {
               totalJmt: 20,
               clientJmt: 5,
               downloadTime: 100,
+              clickToInterstitialWithUserDelay: 43,
+              totalJMTWithUserDelay: 64,
             },
           });
           assert.lengthOf(
@@ -338,6 +349,12 @@ describe('plugin-metrics', () => {
             webex.internal.newMetrics.callDiagnosticLatencies.getStayLobbyTime = sinon
             .stub()
             .returns(1);
+          webex.internal.newMetrics.callDiagnosticLatencies.getTotalMediaJMTWithUserDelay = sinon
+            .stub()
+            .returns(43);
+          webex.internal.newMetrics.callDiagnosticLatencies.getTotalJMTWithUserDelay = sinon
+            .stub()
+            .returns(64);
           const promise = webex.internal.newMetrics.callDiagnosticMetrics.submitToCallDiagnostics(
             //@ts-ignore
             {event: {name: 'client.media-engine.ready'}}
@@ -356,6 +373,8 @@ describe('plugin-metrics', () => {
               interstitialToMediaOKJMT: 22,
               callInitMediaEngineReady: 10,
               stayLobbyTime: 1,
+              totalMediaJMTWithUserDelay: 43,
+              totalJMTWithUserDelay: 64,
             },
           });
           assert.lengthOf(

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

@@ -446,6 +446,36 @@ describe('internal-plugin-metrics', () => {
       assert.deepEqual(cdl.getClickToInterstitial(), 0);
     });
 
+    it('calculates getClickToInterstitialWithUserDelay correctly', () => {
+      cdl.saveTimestamp({
+        key: 'internal.client.meeting.click.joinbutton',
+        value: 10,
+      });
+      cdl.saveTimestamp({
+        key: 'internal.client.meeting.interstitial-window.showed',
+        value: 20,
+      });
+      assert.deepEqual(cdl.getClickToInterstitialWithUserDelay(), 10);
+    });
+
+    it('calculates getClickToInterstitialWithUserDelay without join button timestamp', () => {
+      cdl.saveLatency('internal.click.to.interstitial.with.user.delay', 5);
+      cdl.saveTimestamp({
+        key: 'internal.client.meeting.interstitial-window.showed',
+        value: 20,
+      });
+      assert.deepEqual(cdl.getClickToInterstitialWithUserDelay(), 5);
+    });
+
+    it('calculates getClickToInterstitialWithUserDelay without join button timestamp when it is 0', () => {
+      cdl.saveLatency('internal.click.to.interstitial.with.user.delay', 0);
+      cdl.saveTimestamp({
+        key: 'internal.client.meeting.interstitial-window.showed',
+        value: 20,
+      });
+      assert.deepEqual(cdl.getClickToInterstitialWithUserDelay(), 0);
+    });
+
     it('calculates getInterstitialToJoinOK correctly', () => {
       cdl.saveTimestamp({
         key: 'internal.client.interstitial-window.click.joinbutton',
@@ -554,6 +584,78 @@ describe('internal-plugin-metrics', () => {
         assert.deepEqual(cdl.getTotalJMT(), undefined);
       });
 
+    it('calculates getTotalJMTWithUserDelay correctly', () => {
+      cdl.saveTimestamp({
+        key: 'internal.client.interstitial-window.click.joinbutton',
+        value: 5,
+      });
+      cdl.saveTimestamp({
+        key: 'internal.client.meeting.click.joinbutton',
+        value: 10,
+      });
+      cdl.saveTimestamp({
+        key: 'internal.client.meeting.interstitial-window.showed',
+        value: 20,
+      });
+      cdl.saveTimestamp({
+        key: 'client.locus.join.response',
+        value: 40,
+      });
+      assert.deepEqual(cdl.getTotalJMTWithUserDelay(), 45);
+    });
+
+      it('calculates getTotalJMTWithUserDelay correctly when clickToInterstitialWithUserDelay is 0', () => {
+        cdl.saveLatency('internal.click.to.interstitial.with.user.delay', 0);
+        cdl.saveTimestamp({
+          key: 'internal.client.interstitial-window.click.joinbutton',
+          value: 20,
+        });
+        cdl.saveTimestamp({
+          key: 'client.locus.join.response',
+          value: 40,
+        });
+        assert.deepEqual(cdl.getTotalJMTWithUserDelay(), 20);
+      });
+
+      it('calculates getTotalJMTWithUserDelay correctly when interstitialToJoinOk is 0', () => {
+        cdl.saveTimestamp({
+          key: 'internal.client.interstitial-window.click.joinbutton',
+          value: 40,
+        });
+        cdl.saveLatency('internal.click.to.interstitial.with.user.delay', 12);
+        cdl.saveTimestamp({
+          key: 'client.locus.join.response',
+          value: 40,
+        });
+        assert.deepEqual(cdl.getTotalJMTWithUserDelay(), 12);
+      });
+
+      it('calculates getTotalJMTWithUserDelay correctly when both clickToInterstitialWithUserDelay and interstitialToJoinOk are 0', () => {
+        cdl.saveTimestamp({
+          key: 'internal.client.interstitial-window.click.joinbutton',
+          value: 40,
+        });
+        cdl.saveLatency('internal.click.to.interstitial.with.user.delay', 0);
+        cdl.saveTimestamp({
+          key: 'client.locus.join.response',
+          value: 40,
+        });
+        assert.deepEqual(cdl.getTotalJMTWithUserDelay(), 0);
+      });
+
+      it('calculates getTotalJMTWithUserDelay correctly when both clickToInterstitialWithUserDelay is not a number', () => {
+        cdl.saveTimestamp({
+          key: 'internal.client.interstitial-window.click.joinbutton',
+          value: 40,
+        });
+        cdl.saveLatency('internal.click.to.interstitial.with.user.delay', 'eleven' as unknown as number);
+        cdl.saveTimestamp({
+          key: 'client.locus.join.response',
+          value: 40,
+        });
+        assert.deepEqual(cdl.getTotalJMTWithUserDelay(), undefined);
+      });
+
     it('calculates getTotalMediaJMT correctly', () => {
       cdl.saveTimestamp({
         key: 'internal.client.meeting.click.joinbutton',
@@ -627,6 +729,71 @@ describe('internal-plugin-metrics', () => {
       assert.deepEqual(cdl.getTotalMediaJMT(), 31);
     });
 
+    it('calculates getTotalMediaJMTWithUserDelay correctly', () => {
+      cdl.saveLatency('internal.click.to.interstitial.with.user.delay', 7);
+      cdl.saveTimestamp({
+        key: 'internal.client.interstitial-window.click.joinbutton',
+        value: 10,
+      });
+      cdl.saveTimestamp({
+        key: 'client.locus.join.request',
+        value: 12,
+      });
+      cdl.saveTimestamp({
+        key: 'client.locus.join.response',
+        value: 20,
+      });
+      cdl.saveTimestamp({
+        key: 'internal.host.meeting.participant.admitted',
+        value: 24,
+      });
+      cdl.saveTimestamp({
+        key: 'client.ice.start',
+        value: 30,
+      });
+      cdl.saveTimestamp({
+        key: 'client.ice.end',
+        value: 40,
+      });
+      assert.deepEqual(cdl.getTotalMediaJMTWithUserDelay(), 35);
+    });
+
+    it('calculates getTotalMediaJMTWithUserDelay correctly for guest join', () => {
+      cdl.saveTimestamp({
+        key: 'internal.client.meeting.click.joinbutton',
+        value: 5,
+      });
+      cdl.saveTimestamp({
+        key: 'internal.client.meeting.interstitial-window.showed',
+        value: 8,
+      });
+      cdl.saveTimestamp({
+        key: 'internal.client.interstitial-window.click.joinbutton',
+        value: 10,
+      });
+      cdl.saveTimestamp({
+        key: 'client.locus.join.request',
+        value: 12,
+      });
+      cdl.saveTimestamp({
+        key: 'client.locus.join.response',
+        value: 20,
+      });
+      cdl.saveTimestamp({
+        key: 'internal.host.meeting.participant.admitted',
+        value: 24,
+      });
+      cdl.saveTimestamp({
+        key: 'client.ice.start',
+        value: 30,
+      });
+      cdl.saveTimestamp({
+        key: 'client.ice.end',
+        value: 40,
+      });
+      assert.deepEqual(cdl.getTotalMediaJMTWithUserDelay(), 31);
+    });
+
     it('calculates getJoinConfJMT correctly', () => {
       cdl.saveTimestamp({
         key: 'client.locus.join.request',