@webex/internal-plugin-metrics 3.8.1-next.4 → 3.8.1-next.5

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];
 
@@ -212,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 {
@@ -251,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'];
@@ -340,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

@@ -23,6 +23,7 @@ import {
   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';
@@ -51,11 +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
@@ -275,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,
+    });
   }
 
   /**
@@ -432,6 +458,31 @@ class Metrics extends WebexPlugin {
 
     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 (this.isReady && !shouldDelay) {
+      return this.callDiagnosticMetrics.submitDelayedClientFeatureEvents(overrides);
+    }
+
+    return Promise.resolve();
+  }
 }
 
 export default Metrics;

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

@@ -185,7 +185,7 @@ describe('internal-plugin-metrics', () => {
             publicNetworkPrefix: '1.1.1.1',
             localNetworkPrefix: '1.1.1.1',
             os: getOSNameInternal(),
-            osVersion: getOSVersion(),
+            osVersion: getOSVersion() || 'unknown',
             subClientType: 'WEB_APP',
           },
           environment: 'meeting_evn',
@@ -218,7 +218,7 @@ describe('internal-plugin-metrics', () => {
             publicNetworkPrefix: '1.1.1.1',
             localNetworkPrefix: '1.1.1.1',
             os: getOSNameInternal(),
-            osVersion: getOSVersion(),
+            osVersion: getOSVersion() || 'unknown',
             subClientType: 'WEB_APP',
             clientLaunchMethod: 'url-handler',
           },
@@ -253,7 +253,7 @@ describe('internal-plugin-metrics', () => {
             publicNetworkPrefix: '1.1.1.1',
             localNetworkPrefix: '1.1.1.1',
             os: getOSNameInternal(),
-            osVersion: getOSVersion(),
+            osVersion: getOSVersion() || 'unknown',
             subClientType: 'WEB_APP',
             clientLaunchMethod: 'url-handler',
           },
@@ -288,7 +288,7 @@ describe('internal-plugin-metrics', () => {
             publicNetworkPrefix: '1.1.1.1',
             localNetworkPrefix: '1.1.1.1',
             os: getOSNameInternal(),
-            osVersion: getOSVersion(),
+            osVersion: getOSVersion() || 'unknown',
             subClientType: 'WEB_APP',
             clientLaunchMethod: 'url-handler',
             browserLaunchMethod: 'thinclient',
@@ -316,7 +316,7 @@ describe('internal-plugin-metrics', () => {
             publicNetworkPrefix: '1.1.1.1',
             localNetworkPrefix: '1.1.1.1',
             os: getOSNameInternal(),
-            osVersion: getOSVersion(),
+            osVersion: getOSVersion() || 'unknown',
             subClientType: 'WEB_APP',
           },
           name: 'endpoint',
@@ -345,7 +345,7 @@ describe('internal-plugin-metrics', () => {
             majorVersion: 43,
             minorVersion: 9,
             os: getOSNameInternal(),
-            osVersion: getOSVersion(),
+            osVersion: getOSVersion() || 'unknown',
             subClientType: 'WEB_APP',
           },
           environment: 'meeting_evn',
@@ -368,7 +368,7 @@ describe('internal-plugin-metrics', () => {
             publicNetworkPrefix: '1.3.4.0',
             localNetworkPrefix: undefined,
             os: getOSNameInternal(),
-            osVersion: getOSVersion(),
+            osVersion: getOSVersion() || 'unknown',
             subClientType: 'WEB_APP',
           },
           name: 'endpoint',
@@ -2539,7 +2539,7 @@ describe('internal-plugin-metrics', () => {
               applicationSoftwareType: 'webex-js-sdk',
               applicationSoftwareVersion: 'webex-version',
               mediaEngineSoftwareType: 'browser',
-              mediaEngineSoftwareVersion: getOSVersion(),
+              mediaEngineSoftwareVersion: getOSVersion() || 'unknown',
               startTime: now.toISOString(),
             },
           },
@@ -2578,7 +2578,7 @@ describe('internal-plugin-metrics', () => {
                 applicationSoftwareType: 'webex-js-sdk',
                 applicationSoftwareVersion: 'webex-version',
                 mediaEngineSoftwareType: 'browser',
-                mediaEngineSoftwareVersion: getOSVersion(),
+                mediaEngineSoftwareVersion: getOSVersion() || 'unknown',
                 startTime: now.toISOString(),
               },
             },
@@ -2615,7 +2615,7 @@ describe('internal-plugin-metrics', () => {
               applicationSoftwareType: 'webex-js-sdk',
               applicationSoftwareVersion: 'webex-version',
               mediaEngineSoftwareType: 'browser',
-              mediaEngineSoftwareVersion: getOSVersion(),
+              mediaEngineSoftwareVersion: getOSVersion() || 'unknown',
               startTime: now.toISOString(),
             },
           },
@@ -3466,7 +3466,7 @@ describe('internal-plugin-metrics', () => {
                       localNetworkPrefix: '192.168.1.80',
                       publicNetworkPrefix: '1.3.4.0',
                       os: getOSNameInternal() || 'unknown',
-                      osVersion: getOSVersion(),
+                      osVersion: getOSVersion() || 'unknown',
                       subClientType: 'WEB_APP',
                     },
                     environment: 'meeting_evn',
@@ -3807,5 +3807,220 @@ describe('internal-plugin-metrics', () => {
         assert.notCalled(submitClientEventSpy);
       });
     });
+
+    describe('#submitFeatureEvent', () => {
+      it('should submit feature event successfully with meetingId', () => {
+        const prepareDiagnosticEventSpy = sinon.spy(cd, 'prepareDiagnosticEvent');
+        const submitToCallFeaturesSpy = sinon.spy(cd, 'submitToCallFeatures');
+        sinon.stub(cd, 'getOrigin').returns({origin: 'fake-origin'});
+
+        const options = {
+          meetingId: fakeMeeting.id,
+        };
+        cd.setMercuryConnectedStatus(true);
+
+        cd.submitFeatureEvent({
+          name: 'client.feature.meeting.summary',
+          payload: {
+            meetingSummaryInfo: {
+              featureName: 'syncSystemMuteStatus',
+              featureActions: [{
+                actionName: 'syncMeetingMicUnmuteStatusToSystem',
+                actionId: '14200',
+                isInitialValue: false,
+                clickCount: '1'
+              }]
+            },
+          },
+          options,
+        });
+
+        assert.calledWith(
+          prepareDiagnosticEventSpy,
+          {
+            name: 'client.feature.meeting.summary',
+            canProceed: true,
+            identifiers: {
+              correlationId: 'correlationId',
+              userId: 'userId',
+              deviceId: 'deviceUrl',
+              orgId: 'orgId',
+              locusUrl: 'locus/url',
+              locusId: 'url',
+              locusStartTime: 'lastActive',
+            },
+            eventData: { webClientDomain: 'whatever'},
+            userType: 'host',
+            loginType: 'login-ci',
+            isConvergedArchitectureEnabled: undefined,
+            webexSubServiceType: undefined,
+            webClientPreload: undefined,
+            meetingSummaryInfo: {
+              featureName: 'syncSystemMuteStatus',
+              featureActions: [{
+                actionName: 'syncMeetingMicUnmuteStatusToSystem',
+                actionId: '14200',
+                isInitialValue: false,
+                clickCount: '1'
+              }]
+            },
+            key: "UcfFeatureUsage",
+          },
+          options
+        );
+
+        assert.calledWith(submitToCallFeaturesSpy, {
+          eventId: 'my-fake-id',
+          version: 1,
+          origin: {
+            origin: 'fake-origin',
+          },
+          event: {
+            canProceed: true,
+            eventData: { webClientDomain: 'whatever'},
+            identifiers: {
+              correlationId: 'correlationId',
+              deviceId: 'deviceUrl',
+              locusId: 'url',
+              locusStartTime: 'lastActive',
+              locusUrl: 'locus/url',
+              orgId: 'orgId',
+              userId: 'userId',
+            },
+            loginType: 'login-ci',
+            name: 'client.feature.meeting.summary',
+            userType: 'host',
+            isConvergedArchitectureEnabled: undefined,
+            webexSubServiceType: undefined,
+            webClientPreload: undefined,
+            meetingSummaryInfo: {
+              featureName: 'syncSystemMuteStatus',
+              featureActions: [{
+                actionName: 'syncMeetingMicUnmuteStatusToSystem',
+                actionId: '14200',
+                isInitialValue: false,
+                clickCount: '1'
+              }]
+            },
+            key: "UcfFeatureUsage",
+          },
+          originTime: {
+            sent: 'not_defined_yet',
+            triggered: now.toISOString(),
+          },
+          senderCountryCode: 'UK',
+        });
+
+        const webexLoggerLogCalls = webex.logger.log.getCalls();
+        assert.deepEqual(webexLoggerLogCalls[1].args, [
+          'call-diagnostic-events-feature -> ',
+          'CallFeatureMetrics: @submitFeatureEvent. Submit Client Feature Event CA event.',
+          `name: client.feature.meeting.summary`,
+        ]);
+      });
+    });
+
+    describe('#submitDelayedClientFeatureEvents', () => {
+      it('does not call submitFeatureEvent if there were no delayed events', () => {
+        const submitFeatureEventSpy = sinon.spy(cd, 'submitFeatureEvent');
+
+        cd.submitDelayedClientFeatureEvents();
+
+        assert.notCalled(submitFeatureEventSpy);
+      });
+
+      it('calls submitFeatureEvent for every delayed event and clears delayedClientFeatureEvents array', () => {
+        const submitFeatureEventSpy = sinon.spy(cd, 'submitFeatureEvent');
+        const submitToCallFeaturesSpy = sinon.spy(cd, 'submitToCallFeatures');
+
+        const options = {
+          meetingId: 'meetingId',
+        };
+
+        cd.submitFeatureEvent({
+          name: 'client.feature.meeting.summary',
+          options,
+          payload: {
+            meetingSummaryInfo: {
+              featureName: 'syncSystemMuteStatus',
+              featureActions: [{
+                actionName: 'syncMeetingMicUnmuteStatusToSystem',
+                actionId: '14200',
+                isInitialValue: false,
+                clickCount: '1'
+              }]
+            },
+          },
+          delaySubmitEvent: true,
+        });
+
+        cd.submitFeatureEvent({
+          name: 'client.feature.meeting.summary',
+          options,
+          payload: {
+            meetingSummaryInfo: {
+              featureName: 'syncSystemVideoStatus',
+              featureActions: [{
+                actionName: 'syncMeetingVideoUnmuteStatusToSystem',
+                actionId: '13400',
+                isInitialValue: false,
+                clickCount: '1'
+              }]
+            },
+          },
+          delaySubmitEvent: true,
+        });
+
+        assert.notCalled(submitToCallFeaturesSpy);
+        assert.calledTwice(submitFeatureEventSpy);
+        submitFeatureEventSpy.resetHistory();
+
+        cd.submitDelayedClientFeatureEvents();
+
+        assert.calledTwice(submitFeatureEventSpy);
+        assert.calledWith(submitFeatureEventSpy.firstCall, {
+          name: 'client.feature.meeting.summary',
+          payload: {
+            meetingSummaryInfo: {
+              featureName: 'syncSystemMuteStatus',
+              featureActions: [{
+                actionName: 'syncMeetingMicUnmuteStatusToSystem',
+                actionId: '14200',
+                isInitialValue: false,
+                clickCount: '1'
+              }]
+            },
+          },
+          options: {
+            meetingId: 'meetingId',
+            triggeredTime: now.toISOString(),
+          },
+        });
+        assert.calledWith(submitFeatureEventSpy.secondCall, {
+          name: 'client.feature.meeting.summary',
+          payload: {
+            meetingSummaryInfo: {
+              featureName: 'syncSystemVideoStatus',
+              featureActions: [{
+                actionName: 'syncMeetingVideoUnmuteStatusToSystem',
+                actionId: '13400',
+                isInitialValue: false,
+                clickCount: '1'
+              }]
+            },
+          },
+          options: {
+            meetingId: 'meetingId',
+            triggeredTime: now.toISOString(),
+          },
+        });
+        submitFeatureEventSpy.resetHistory();
+
+        cd.submitDelayedClientFeatureEvents();
+
+        // should not call submitFeatureEventSpy again if delayedClientFeatureEvents was cleared
+        assert.notCalled(submitFeatureEventSpy);
+      });
+    });
   });
 });

package/test/unit/spec/new-metrics.ts

@@ -19,7 +19,7 @@ describe('internal-plugin-metrics', () => {
     }
   });
 
-  describe('check submitClientEvent when webex is not ready', () => {
+  describe('check submitClientEvent, submitFeatureEvent when webex is not ready', () => {
     let webex;
     //@ts-ignore
     webex = mockWebex();
@@ -36,6 +36,30 @@ describe('internal-plugin-metrics', () => {
         'NewMetrics: @submitClientEvent. Attempted to submit before webex.ready. Event name: client.alert.displayed'
       );
     });
+
+    it('checks the log', () => {
+      webex.internal.newMetrics.submitFeatureEvent({
+        name: 'client.feature.meeting.summary',
+        options: {
+          meetingId: '123',
+        },
+        payload: {
+          meetingSummaryInfo: {
+            featureName: 'syncSystemMuteStatus',
+            featureActions: [{
+              actionName: 'syncMeetingMicUnmuteStatusToSystem',
+              actionId: '14200',
+              isInitialValue: false,
+              clickCount: '1'
+            }]
+          },
+        },
+      });
+      assert.calledWith(
+        webex.logger.log,
+        'NewMetrics: @submitFeatureEvent. Attempted to submit before webex.ready. Event name: client.feature.meeting.summary'
+      );
+    });
   });
 
   describe('new-metrics contstructor', () => {
@@ -65,6 +89,7 @@ describe('internal-plugin-metrics', () => {
       webex.internal.newMetrics.callDiagnosticMetrics.buildClientEventFetchRequestOptions =
         sinon.stub();
       webex.setTimingsAndFetch = sinon.stub();
+      webex.internal.newMetrics.callDiagnosticMetrics.submitFeatureEvent = sinon.stub();
     });
 
     afterEach(() => {
@@ -104,7 +129,7 @@ describe('internal-plugin-metrics', () => {
         metadata: { foo: 'bar' },
       });
     });
-  
+
     it('submits Client Event successfully', () => {
       webex.internal.newMetrics.submitClientEvent({
         name: 'client.alert.displayed',
@@ -125,6 +150,46 @@ describe('internal-plugin-metrics', () => {
       });
     });
 
+    it('submits feature Event successfully', () => {
+      webex.internal.newMetrics.submitFeatureEvent({
+        name: 'client.feature.meeting.summary',
+        options: {
+          meetingId: '123',
+        },
+        payload: {
+          meetingSummaryInfo: {
+            featureName: 'syncSystemMuteStatus',
+            featureActions: [{
+              actionName: 'syncMeetingMicUnmuteStatusToSystem',
+              actionId: '14200',
+              isInitialValue: false,
+              clickCount: '1'
+            }]
+          },
+        },
+      });
+
+      assert.calledWith(webex.internal.newMetrics.callDiagnosticLatencies.saveTimestamp, {
+        key: 'client.feature.meeting.summary',
+        options: {meetingId: '123'},
+      });
+      assert.calledWith(webex.internal.newMetrics.callDiagnosticMetrics.submitFeatureEvent, {
+        name: 'client.feature.meeting.summary',
+        payload: {
+          meetingSummaryInfo: {
+            featureName: 'syncSystemMuteStatus',
+            featureActions: [{
+              actionName: 'syncMeetingMicUnmuteStatusToSystem',
+              actionId: '14200',
+              isInitialValue: false,
+              clickCount: '1'
+            }]
+          },
+        },
+        options: {meetingId: '123'},
+        delaySubmitEvent: false,
+      });
+    });
 
     it('submits MQE successfully', () => {
       webex.internal.newMetrics.submitMQE({