@webex/internal-plugin-metrics 3.8.1 → 3.9.0-multipleLLM.1

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-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

@@ -130,6 +130,82 @@ describe('internal-plugin-metrics', () => {
       assert.deepEqual(res2, undefined);
     });
 
+    describe('getDiffBetweenTimestamps with clamping', () => {
+      it('should return diff without clamping when no clampValues provided', () => {
+        cdl.saveTimestamp({key: 'client.alert.displayed', value: 10});
+        cdl.saveTimestamp({key: 'client.alert.removed', value: 50});
+        const res = cdl.getDiffBetweenTimestamps('client.alert.displayed', 'client.alert.removed');
+        assert.deepEqual(res, 40);
+      });
+
+      it('should return diff without clamping when value is within range', () => {
+        cdl.saveTimestamp({key: 'client.alert.displayed', value: 10});
+        cdl.saveTimestamp({key: 'client.alert.removed', value: 50});
+        const res = cdl.getDiffBetweenTimestamps('client.alert.displayed', 'client.alert.removed', {
+          minimum: 0,
+          maximum: 100
+        });
+        assert.deepEqual(res, 40);
+      });
+
+      it('should clamp to minimum when diff is below minimum', () => {
+        cdl.saveTimestamp({key: 'client.alert.displayed', value: 50});
+        cdl.saveTimestamp({key: 'client.alert.removed', value: 45});
+        const res = cdl.getDiffBetweenTimestamps('client.alert.displayed', 'client.alert.removed', {
+          minimum: 10,
+          maximum: 100
+        });
+        assert.deepEqual(res, 10);
+      });
+
+      it('should clamp to maximum when diff is above maximum', () => {
+        cdl.saveTimestamp({key: 'client.alert.displayed', value: 10});
+        cdl.saveTimestamp({key: 'client.alert.removed', value: 210});
+        const res = cdl.getDiffBetweenTimestamps('client.alert.displayed', 'client.alert.removed', {
+          minimum: 0,
+          maximum: 100
+        });
+        assert.deepEqual(res, 100);
+      });
+
+      it('should use default minimum of 0 when only maximum is specified', () => {
+        cdl.saveTimestamp({key: 'client.alert.displayed', value: 50});
+        cdl.saveTimestamp({key: 'client.alert.removed', value: 45});
+        const res = cdl.getDiffBetweenTimestamps('client.alert.displayed', 'client.alert.removed', {
+          maximum: 100
+        });
+        assert.deepEqual(res, 0);
+      });
+
+      it('should not clamp maximum when maximum is undefined', () => {
+        cdl.saveTimestamp({key: 'client.alert.displayed', value: 10});
+        cdl.saveTimestamp({key: 'client.alert.removed', value: 2000});
+        const res = cdl.getDiffBetweenTimestamps('client.alert.displayed', 'client.alert.removed', {
+          minimum: 5
+        });
+        assert.deepEqual(res, 1990);
+      });
+
+      it('should handle negative differences correctly with clamping', () => {
+        cdl.saveTimestamp({key: 'client.alert.displayed', value: 100});
+        cdl.saveTimestamp({key: 'client.alert.removed', value: 50});
+        const res = cdl.getDiffBetweenTimestamps('client.alert.displayed', 'client.alert.removed', {
+          minimum: 10,
+          maximum: 1000
+        });
+        assert.deepEqual(res, 10);
+      });
+
+      it('should return undefined when timestamps are missing even with clamping', () => {
+        cdl.saveTimestamp({key: 'client.alert.displayed', value: 10});
+        const res = cdl.getDiffBetweenTimestamps('client.alert.displayed', 'client.alert.removed', {
+          minimum: 0,
+          maximum: 100
+        });
+        assert.deepEqual(res, undefined);
+      });
+    });
+
     it('calculates getMeetingInfoReqResp correctly', () => {
       cdl.saveTimestamp({key: 'internal.client.meetinginfo.request', value: 10});
       cdl.saveTimestamp({key: 'internal.client.meetinginfo.response', value: 20});
@@ -446,6 +522,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 +660,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 +805,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',
@@ -751,6 +994,18 @@ describe('internal-plugin-metrics', () => {
       assert.deepEqual(cdl.getInterstitialToMediaOKJMT(), 10);
     });
 
+    it('calculates getShareDuration correctly', () => {
+      cdl.saveTimestamp({
+        key: 'internal.client.share.initiated',
+        value: 5,
+      });
+      cdl.saveTimestamp({
+        key: 'internal.client.share.stopped',
+        value: 7,
+      });
+      assert.deepEqual(cdl.getShareDuration(), 2);
+    });
+
     describe('calculates getU2CTime correctly', () => {
       it('returns undefined when no precomputed value available', () => {
         assert.deepEqual(cdl.getU2CTime(), undefined);