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

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

@@ -3,7 +3,7 @@ import CallDiagnosticMetrics from './call-diagnostic/call-diagnostic-metrics';
 import BehavioralMetrics from './behavioral-metrics';
 import OperationalMetrics from './operational-metrics';
 import BusinessMetrics from './business-metrics';
-import { RecursivePartial, MetricEventProduct, MetricEventAgent, MetricEventVerb, ClientEvent, FeatureEvent, EventPayload, MediaQualityEvent, InternalEvent, SubmitClientEventOptions, Table } from './metrics.types';
+import { RecursivePartial, MetricEventProduct, MetricEventAgent, MetricEventVerb, ClientEvent, FeatureEvent, EventPayload, MediaQualityEvent, InternalEvent, SubmitClientEventOptions, Table, DelayedClientEvent, DelayedClientFeatureEvent } from './metrics.types';
 import CallDiagnosticLatencies from './call-diagnostic/call-diagnostic-metrics-latencies';
 /**
  * Metrics plugin to centralize all types of metrics.
@@ -22,6 +22,15 @@ declare class Metrics extends WebexPlugin {
      * Whether or not to delay the submission of client events.
      */
     delaySubmitClientEvents: boolean;
+    /**
+     * Whether or not to delay the submission of feature events.
+     */
+    delaySubmitClientFeatureEvents: boolean;
+    /**
+     * 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
@@ -115,7 +124,7 @@ declare class Metrics extends WebexPlugin {
         name: FeatureEvent['name'];
         payload?: RecursivePartial<FeatureEvent['payload']>;
         options: any;
-    }): void;
+    }): Promise<any>;
     /**
      * Call Analyzer: Client Event
      * @public
@@ -178,8 +187,23 @@ declare 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}
+     */
+    setDelaySubmitClientEvents({ shouldDelay, overrides, }: {
+        shouldDelay: boolean;
+        overrides?: Partial<DelayedClientEvent['options']>;
+    }): Promise<any[]> | Promise<void>;
+    /**
+     * 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}
      */
-    setDelaySubmitClientEvents(shouldDelay: boolean): Promise<any[]> | Promise<void>;
+    setDelaySubmitClientFeatureEvents({ shouldDelay, overrides, }: {
+        shouldDelay: boolean;
+        overrides?: Partial<DelayedClientFeatureEvent['options']>;
+    }): Promise<any[]> | Promise<void>;
 }
 export default Metrics;

package/package.json

@@ -26,22 +26,22 @@
     "@webex/eslint-config-legacy": "0.0.0",
     "@webex/jest-config-legacy": "0.0.0",
     "@webex/legacy-tools": "0.0.0",
-    "@webex/test-helper-chai": "3.8.0",
-    "@webex/test-helper-mocha": "3.8.0",
-    "@webex/test-helper-mock-webex": "3.8.0",
-    "@webex/test-helper-test-users": "3.8.0",
+    "@webex/test-helper-chai": "3.8.1-next.10",
+    "@webex/test-helper-mocha": "3.8.1-next.10",
+    "@webex/test-helper-mock-webex": "3.8.1-next.10",
+    "@webex/test-helper-test-users": "3.8.1-next.10",
     "eslint": "^8.24.0",
     "prettier": "^2.7.1",
     "sinon": "^9.2.4"
   },
   "dependencies": {
-    "@webex/common": "3.8.0",
-    "@webex/common-timers": "3.8.0",
-    "@webex/event-dictionary-ts": "^1.0.1688",
-    "@webex/internal-plugin-metrics": "3.8.0",
-    "@webex/test-helper-chai": "3.8.0",
-    "@webex/test-helper-mock-webex": "3.8.0",
-    "@webex/webex-core": "3.8.0",
+    "@webex/common": "3.8.1-next.10",
+    "@webex/common-timers": "3.8.1-next.10",
+    "@webex/event-dictionary-ts": "^1.0.1819",
+    "@webex/internal-plugin-metrics": "3.8.1-next.10",
+    "@webex/test-helper-chai": "3.8.1-next.10",
+    "@webex/test-helper-mock-webex": "3.8.1-next.10",
+    "@webex/webex-core": "3.8.1-next.10",
     "ip-anonymize": "^0.1.0",
     "lodash": "^4.17.21",
     "uuid": "^3.3.2"
@@ -54,5 +54,5 @@
     "test:style": "eslint ./src/**/*.*",
     "test:unit": "webex-legacy-tools test --unit --runner mocha"
   },
-  "version": "3.8.0"
+  "version": "3.8.1-next.10"
 }

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

@@ -336,6 +336,30 @@ export default class CallDiagnosticLatencies extends WebexPlugin {
     return undefined;
   }
 
+  /**
+   * Click To Interstitial With User Delay
+   * @returns - latency
+   */
+  public getClickToInterstitialWithUserDelay() {
+    // for normal join (where green join button exists before interstitial, i.e reminder, space list etc)
+    if (this.latencyTimestamps.get('internal.client.meeting.click.joinbutton')) {
+      return this.getDiffBetweenTimestamps(
+        'internal.client.meeting.click.joinbutton',
+        'internal.client.meeting.interstitial-window.showed'
+      );
+    }
+
+    const clickToInterstitialWithUserDelayLatency = this.precomputedLatencies.get(
+      'internal.click.to.interstitial.with.user.delay'
+    );
+
+    if (typeof clickToInterstitialWithUserDelayLatency === 'number') {
+      return clickToInterstitialWithUserDelayLatency;
+    }
+
+    return undefined;
+  }
+
   /**
    * Interstitial To Join Ok
    * @returns - latency
@@ -395,6 +419,24 @@ export default class CallDiagnosticLatencies extends WebexPlugin {
     return undefined;
   }
 
+  /**
+   * Total JMT With User Delay
+   * @returns - latency
+   */
+  public getTotalJMTWithUserDelay() {
+    const clickToInterstitialWithUserDelay = this.getClickToInterstitialWithUserDelay();
+    const interstitialToJoinOk = this.getInterstitialToJoinOK();
+
+    if (
+      typeof clickToInterstitialWithUserDelay === 'number' &&
+      typeof interstitialToJoinOk === 'number'
+    ) {
+      return clickToInterstitialWithUserDelay + interstitialToJoinOk;
+    }
+
+    return undefined;
+  }
+
   /**
    * Join Conf JMT
    * @returns - latency
@@ -432,6 +474,22 @@ export default class CallDiagnosticLatencies extends WebexPlugin {
     return undefined;
   }
 
+  /**
+   * Total Media JMT With User Delay
+   * @returns - latency
+   */
+  public getTotalMediaJMTWithUserDelay() {
+    const clickToInterstitialWithUserDelay = this.getClickToInterstitialWithUserDelay();
+    const interstitialToJoinOk = this.getInterstitialToJoinOK();
+    const joinConfJMT = this.getJoinConfJMT();
+
+    if (clickToInterstitialWithUserDelay && interstitialToJoinOk && joinConfJMT) {
+      return clickToInterstitialWithUserDelay + interstitialToJoinOk + joinConfJMT;
+    }
+
+    return undefined;
+  }
+
   /**
    * Client JMT
    * @returns - latency