@webex/internal-plugin-metrics 3.12.0-next.1 → 3.12.0-next.10

package/dist/types/call-diagnostic/call-diagnostic-metrics.d.ts

@@ -137,11 +137,11 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
                 architecture: "unknown" | "intel32" | "intel64" | "amd32" | "amd64" | "arm32" | "arm64" | "armv9" | "armv8" | "armv7" | "armv6" | "x86_64" | "x86_32";
                 staticPerformance?: string;
                 clockSpeedGigaHertz?: number;
-                additionalProperties?: false;
+                additionalProperties?: never;
             };
             shareType?: "cb-normal-share" | "ce-airplay-share" | "ce-direct-share" | "ce-gui-loopback-share" | "ce-input-source-share" | "ce-input-source-share-hdmi" | "ce-input-source-share-usbc" | "ce-jpg-share" | "ce-miracast-share" | "mcs-normal-share" | "mcs-normal-audio-share" | "mcs-hfps-share" | "mcs-hfps-audio-share";
             videoDisplayMode?: "grid-view" | "active-speaker-view";
-            videoLayoutType?: "stack" | "stackWithShare" | "sideBySide" | "sideBySideWithShare" | "grid" | "floatingActive" | "floatingThumbnail" | "floatingGrid" | "overlay" | "focus" | "prominent" | "focusWithShare" | "prominentWithShare" | "equal" | "equalWithShare" | "largeGallery";
+            videoLayoutType?: "auto" | "stack" | "stackWithShare" | "sideBySide" | "sideBySideWithShare" | "grid" | "floatingActive" | "floatingThumbnail" | "floatingGrid" | "overlay" | "focus" | "prominent" | "focusWithShare" | "prominentWithShare" | "equal" | "equalWithShare" | "largeGallery" | "autoWithShare";
             videoRenderType?: "wme" | "client_d3d" | "client_gdi";
             vdiInfo?: {};
             is64BitsClient?: boolean;
@@ -153,13 +153,16 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
             vendorId?: string;
             staticPerformanceLevel?: string;
             staticPerformanceScore?: number;
-            additionalProperties?: false;
+            preInstalledTime?: string;
+            preInstalledType?: "installer" | "launcher" | "app";
+            preInstalledVersion?: string;
+            additionalProperties?: never;
         };
         emmVendorId?: string;
         isHybridMedia?: boolean;
         originData?: {};
         serviceVersion?: string;
-        additionalProperties?: false;
+        additionalProperties?: never;
     };
     /**
      * Gather identifier details for call diagnostic payload.
@@ -183,7 +186,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
             imiAppId: string;
             sessionId: string;
             sessionInstanceId: string;
-            additionalProperties?: false;
+            additionalProperties?: never;
         };
         csdmDeviceUrl?: string;
         destinationBreakoutSessionId?: string;
@@ -199,6 +202,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         ivrId?: string;
         callId?: string;
         pairCallId?: string;
+        llmWebsocketUrl?: string;
         locusId?: string;
         locusJoinUrl?: string;
         locusSessionId?: string;
@@ -212,6 +216,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         meetingLookupUrl?: string;
         meetingOrgId?: string;
         metricServiceUrl?: string;
+        mercuryWebsocketUrl?: string;
         msteamsTenantGuid?: string;
         msteamsConferenceId?: string;
         msteamsMeetingId?: string;
@@ -225,7 +230,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         sipSessionId?: {
             local?: string;
             remote?: string;
-            additionalProperties?: false;
+            additionalProperties?: never;
         };
         sipUri?: string;
         subConfId?: string;
@@ -253,7 +258,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         idForEndpointAB?: string;
         customerOrgId?: string;
         correlationId: string;
-        additionalProperties?: false;
+        additionalProperties?: never;
     } | {
         aggregatedBreakoutMoveId?: string;
         attendeeId?: string;
@@ -271,7 +276,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
             imiAppId: string;
             sessionId: string;
             sessionInstanceId: string;
-            additionalProperties?: false;
+            additionalProperties?: never;
         };
         csdmDeviceUrl?: string;
         destinationBreakoutSessionId?: string;
@@ -287,6 +292,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         ivrId?: string;
         callId?: string;
         pairCallId?: string;
+        llmWebsocketUrl?: string;
         locusId?: string;
         locusJoinUrl?: string;
         locusSessionId?: string;
@@ -300,6 +306,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         meetingLookupUrl?: string;
         meetingOrgId?: string;
         metricServiceUrl?: string;
+        mercuryWebsocketUrl?: string;
         msteamsTenantGuid?: string;
         msteamsConferenceId?: string;
         msteamsMeetingId?: string;
@@ -313,7 +320,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         sipSessionId?: {
             local?: string;
             remote?: string;
-            additionalProperties?: false;
+            additionalProperties?: never;
         };
         sipUri?: string;
         subConfId?: string;
@@ -341,7 +348,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         idForEndpointAB?: string;
         customerOrgId?: string;
         correlationId: string;
-        additionalProperties?: false;
+        additionalProperties?: never;
     } | {
         aggregatedBreakoutMoveId?: string;
         attendeeId?: string;
@@ -359,7 +366,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
             imiAppId: string;
             sessionId: string;
             sessionInstanceId: string;
-            additionalProperties?: false;
+            additionalProperties?: never;
         };
         csdmDeviceUrl?: string;
         destinationBreakoutSessionId?: string;
@@ -375,6 +382,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         ivrId?: string;
         callId?: string;
         pairCallId?: string;
+        llmWebsocketUrl?: string;
         locusId?: string;
         locusJoinUrl?: string;
         locusSessionId?: string;
@@ -388,6 +396,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         meetingLookupUrl?: string;
         meetingOrgId?: string;
         metricServiceUrl?: string;
+        mercuryWebsocketUrl?: string;
         msteamsTenantGuid?: string;
         msteamsConferenceId?: string;
         msteamsMeetingId?: string;
@@ -401,7 +410,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         sipSessionId?: {
             local?: string;
             remote?: string;
-            additionalProperties?: false;
+            additionalProperties?: never;
         };
         sipUri?: string;
         subConfId?: string;
@@ -429,7 +438,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         idForEndpointAB?: string;
         customerOrgId?: string;
         correlationId: string;
-        additionalProperties?: false;
+        additionalProperties?: never;
     };
     /**
      * Create diagnostic event, which can hold client event, feature event or MQE event data.

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

@@ -154,7 +154,7 @@ export type BuildClientEventFetchRequestOptions = (args: {
     payload?: RecursivePartial<ClientEvent['payload']>;
     options?: SubmitClientEventOptions;
 }) => Promise<any>;
-export type PreComputedLatencies = 'internal.client.pageJMT' | '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' | 'internal.call.init.join.req' | 'internal.other.app.api.time' | 'internal.api.fetch.intelligence.models';
+export type PreComputedLatencies = 'internal.client.pageJMT' | 'internal.download.time' | 'internal.get.cluster.time' | 'internal.click.to.interstitial' | 'internal.click.to.interstitial.with.user.delay' | 'internal.click.to.interstitial.for.client.jmt' | 'internal.refresh.captcha.time' | 'internal.exchange.ci.token.time' | 'internal.get.u2c.time' | 'internal.call.init.join.req' | 'internal.other.app.api.time' | 'internal.api.fetch.intelligence.models';
 export interface IdType {
     meetingId?: string;
     callId?: string;

package/package.json

@@ -24,7 +24,7 @@
     "@sinonjs/fake-timers": "^6.0.1",
     "@webex/babel-config-legacy": "0.0.0",
     "@webex/eslint-config-legacy": "0.0.0",
-    "@webex/event-dictionary-ts": "^1.0.2073",
+    "@webex/event-dictionary-ts": "^1.0.2138",
     "@webex/jest-config-legacy": "0.0.0",
     "@webex/legacy-tools": "0.0.0",
     "@webex/test-helper-chai": "3.11.0-next.1",
@@ -40,7 +40,7 @@
     "@webex/common-timers": "3.11.0-next.1",
     "@webex/test-helper-chai": "3.11.0-next.1",
     "@webex/test-helper-mock-webex": "3.11.0-next.1",
-    "@webex/webex-core": "3.12.0-next.1",
+    "@webex/webex-core": "3.12.0-next.10",
     "ip-anonymize": "^0.1.0",
     "lodash": "^4.17.21",
     "uuid": "^3.3.2"
@@ -53,5 +53,5 @@
     "test:style": "eslint ./src/**/*.*",
     "test:unit": "webex-legacy-tools test --unit --runner mocha"
   },
-  "version": "3.12.0-next.1"
+  "version": "3.12.0-next.10"
 }

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

@@ -193,7 +193,7 @@ export default class CallDiagnosticLatencies extends WebexPlugin {
    */
   public getShowInterstitialTime() {
     return this.getDiffBetweenTimestamps(
-      'client.interstitial-window.start-launch',
+      'internal.client.meeting.interstitial-window.showed',
       'internal.client.interstitial-window.click.joinbutton'
     );
   }
@@ -303,7 +303,39 @@ export default class CallDiagnosticLatencies extends WebexPlugin {
    * @returns - latency
    */
   public getStayLobbyTime() {
-    return this.getDiffBetweenTimestamps('client.locus.join.response', 'client.lobby.exited');
+    return this.getDiffBetweenTimestamps('client.lobby.entered', 'client.lobby.exited');
+  }
+
+  /**
+   * Stay lobby time capped by a certain timestamp.
+   * This is to handle the case where the target end timestamp could happen before the lobby is exited,
+   * for example media-engine.ready or client.ice.end
+   * This is supposed to be called AFTER the end timestamp happens
+   * @param endTimestampKey name of the target end event
+   * @returns - latency
+   */
+  public getStayLobbyTimeCappedBy(endTimestampKey: MetricEventNames) {
+    const lobbyStartTimestamp = this.latencyTimestamps.get('client.lobby.entered'); // might not exist (some meetings don't have lobby)
+
+    if (typeof lobbyStartTimestamp !== 'number') {
+      // no lobby in the meeting, stayLobbyTime is 0
+      return 0;
+    }
+
+    const lobbyEndTimestamp = this.latencyTimestamps.get('client.lobby.exited'); // might not exist (if user still in lobby at the time of measurement)
+    const maximumEndTimestamp = this.latencyTimestamps.get(endTimestampKey); // must exist
+
+    if (typeof maximumEndTimestamp !== 'number') {
+      // the provided timestamp to be used as a cap should exist, return undefined if it doesn't
+      return undefined;
+    }
+
+    const endTimestamp =
+      typeof lobbyEndTimestamp === 'number'
+        ? Math.min(lobbyEndTimestamp, maximumEndTimestamp)
+        : maximumEndTimestamp;
+
+    return clamp(endTimestamp - lobbyStartTimestamp, 0, this.MAX_INTEGER);
   }
 
   /**
@@ -390,11 +422,7 @@ export default class CallDiagnosticLatencies extends WebexPlugin {
    * @returns - latency
    */
   public getCallInitMediaEngineReady() {
-    return this.getDiffBetweenTimestamps(
-      'internal.client.interstitial-window.click.joinbutton',
-      'client.media-engine.ready',
-      {maximum: 1200000}
-    );
+    return this.getInterstitialToMediaOKJMT();
   }
 
   /**
@@ -402,20 +430,21 @@ export default class CallDiagnosticLatencies extends WebexPlugin {
    * @returns - latency
    */
   public getInterstitialToMediaOKJMT() {
-    const interstitialJoinClickTimestamp = this.latencyTimestamps.get(
-      'internal.client.interstitial-window.click.joinbutton'
+    const interstitialClickJoinToIceEnd = this.getDiffBetweenTimestamps(
+      'internal.client.interstitial-window.click.joinbutton',
+      'client.ice.end'
     );
+    const stayLobbyTimeCappedByIceEnd = this.getStayLobbyTimeCappedBy('client.ice.end');
 
-    // get the first timestamp
-    const connectedMedia = this.latencyTimestamps.get('client.ice.end');
-
-    const lobbyTimeLatency = this.getStayLobbyTime();
-    const lobbyTime = typeof lobbyTimeLatency === 'number' ? lobbyTimeLatency : 0;
-
-    if (interstitialJoinClickTimestamp && connectedMedia) {
-      const interstitialToMediaOKJmt = connectedMedia - interstitialJoinClickTimestamp - lobbyTime;
-
-      return clamp(interstitialToMediaOKJmt, 0, this.MAX_INTEGER);
+    if (
+      typeof interstitialClickJoinToIceEnd === 'number' &&
+      typeof stayLobbyTimeCappedByIceEnd === 'number'
+    ) {
+      return clamp(
+        interstitialClickJoinToIceEnd - stayLobbyTimeCappedByIceEnd,
+        0,
+        this.MAX_INTEGER
+      );
     }
 
     return undefined;
@@ -427,10 +456,20 @@ export default class CallDiagnosticLatencies extends WebexPlugin {
    */
   public getTotalJMT() {
     const clickToInterstitial = this.getClickToInterstitial();
-    const interstitialToJoinOk = this.getInterstitialToJoinOK();
+    const interstitialClickJoinToJoinLocusResponse = this.getDiffBetweenTimestamps(
+      'internal.client.interstitial-window.click.joinbutton',
+      'client.locus.join.response'
+    );
 
-    if (typeof clickToInterstitial === 'number' && typeof interstitialToJoinOk === 'number') {
-      return clamp(clickToInterstitial + interstitialToJoinOk, 0, this.MAX_INTEGER);
+    if (
+      typeof clickToInterstitial === 'number' &&
+      typeof interstitialClickJoinToJoinLocusResponse === 'number'
+    ) {
+      return clamp(
+        clickToInterstitial + interstitialClickJoinToJoinLocusResponse,
+        0,
+        this.MAX_INTEGER
+      );
     }
 
     return undefined;
@@ -442,13 +481,20 @@ export default class CallDiagnosticLatencies extends WebexPlugin {
    */
   public getTotalJMTWithUserDelay() {
     const clickToInterstitialWithUserDelay = this.getClickToInterstitialWithUserDelay();
-    const interstitialToJoinOk = this.getInterstitialToJoinOK();
+    const interstitialShowedToJoinLocusResponse = this.getDiffBetweenTimestamps(
+      'internal.client.meeting.interstitial-window.showed',
+      'client.locus.join.response'
+    );
 
     if (
       typeof clickToInterstitialWithUserDelay === 'number' &&
-      typeof interstitialToJoinOk === 'number'
+      typeof interstitialShowedToJoinLocusResponse === 'number'
     ) {
-      return clamp(clickToInterstitialWithUserDelay + interstitialToJoinOk, 0, this.MAX_INTEGER);
+      return clamp(
+        clickToInterstitialWithUserDelay + interstitialShowedToJoinLocusResponse,
+        0,
+        this.MAX_INTEGER
+      );
     }
 
     return undefined;
@@ -475,22 +521,26 @@ export default class CallDiagnosticLatencies extends WebexPlugin {
    */
   public getTotalMediaJMT() {
     const clickToInterstitial = this.getClickToInterstitial();
-    const interstitialToJoinOk = this.getInterstitialToJoinOK();
-    const joinConfJMT = this.getJoinConfJMT();
-    const lobbyTimeLatency = this.getStayLobbyTime();
-    const lobbyTime = typeof lobbyTimeLatency === 'number' ? lobbyTimeLatency : 0;
-
-    if (clickToInterstitial && interstitialToJoinOk && joinConfJMT) {
-      const totalMediaJMT = clamp(
-        clickToInterstitial + interstitialToJoinOk + joinConfJMT,
+    const interstitialClickJoinToMediaEngineReady = this.getDiffBetweenTimestamps(
+      'internal.client.interstitial-window.click.joinbutton',
+      'client.media-engine.ready'
+    );
+    const stayLobbyTimeCappedByMediaEngineReady = this.getStayLobbyTimeCappedBy(
+      'client.media-engine.ready'
+    );
+
+    if (
+      typeof clickToInterstitial === 'number' &&
+      typeof interstitialClickJoinToMediaEngineReady === 'number' &&
+      typeof stayLobbyTimeCappedByMediaEngineReady === 'number'
+    ) {
+      return clamp(
+        clickToInterstitial +
+          interstitialClickJoinToMediaEngineReady -
+          stayLobbyTimeCappedByMediaEngineReady,
         0,
-        Infinity
+        this.MAX_INTEGER
       );
-      if (this.getMeeting()?.allowMediaInLobby) {
-        return clamp(totalMediaJMT, 0, this.MAX_INTEGER);
-      }
-
-      return clamp(totalMediaJMT - lobbyTime, 0, this.MAX_INTEGER);
     }
 
     return undefined;
@@ -502,12 +552,17 @@ export default class CallDiagnosticLatencies extends WebexPlugin {
    */
   public getTotalMediaJMTWithUserDelay() {
     const clickToInterstitialWithUserDelay = this.getClickToInterstitialWithUserDelay();
-    const interstitialToJoinOk = this.getInterstitialToJoinOK();
-    const joinConfJMT = this.getJoinConfJMT();
+    const interstitialShowedToMediaEngineReady = this.getDiffBetweenTimestamps(
+      'internal.client.meeting.interstitial-window.showed',
+      'client.media-engine.ready'
+    );
 
-    if (clickToInterstitialWithUserDelay && interstitialToJoinOk && joinConfJMT) {
+    if (
+      typeof clickToInterstitialWithUserDelay === 'number' &&
+      typeof interstitialShowedToMediaEngineReady === 'number'
+    ) {
       return clamp(
-        clickToInterstitialWithUserDelay + interstitialToJoinOk + joinConfJMT,
+        clickToInterstitialWithUserDelay + interstitialShowedToMediaEngineReady,
         0,
         this.MAX_INTEGER
       );
@@ -521,11 +576,23 @@ export default class CallDiagnosticLatencies extends WebexPlugin {
    * @returns - latency
    */
   public getClientJMT() {
-    const interstitialToJoinOk = this.getInterstitialToJoinOK();
-    const joinConfJMT = this.getJoinConfJMT();
+    const clickToInterstitialForClientJmt = this.precomputedLatencies.get(
+      'internal.click.to.interstitial.for.client.jmt'
+    );
+    const interstitialJoinToLocusJoinRequest = this.getDiffBetweenTimestamps(
+      'internal.client.interstitial-window.click.joinbutton',
+      'client.locus.join.request'
+    );
 
-    if (typeof interstitialToJoinOk === 'number' && typeof joinConfJMT === 'number') {
-      return clamp(interstitialToJoinOk - joinConfJMT, 0, this.MAX_INTEGER);
+    if (
+      typeof clickToInterstitialForClientJmt === 'number' &&
+      typeof interstitialJoinToLocusJoinRequest === 'number'
+    ) {
+      return clamp(
+        clickToInterstitialForClientJmt + interstitialJoinToLocusJoinRequest,
+        0,
+        this.MAX_INTEGER
+      );
     }
 
     return undefined;

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

@@ -190,6 +190,11 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
 
       // if ConvergedArchitecture enable and isConvergedWebinarWebcast -- then webcast
       if (meetingInfo?.enableConvergedArchitecture && meetingInfo?.enableEvent) {
+        // if enableConvergedWebinarLargeScale - then large scale webinar
+        if (meetingInfo?.enableConvergedWebinarLargeScale) {
+          return WEBEX_SUB_SERVICE_TYPES.LARGE_SCALE_WEBINAR;
+        }
+
         return meetingInfo?.isConvergedWebinarWebcast
           ? WEBEX_SUB_SERVICE_TYPES.WEBCAST
           : WEBEX_SUB_SERVICE_TYPES.WEBINAR;

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

@@ -284,7 +284,8 @@ export const prepareDiagnosticMetricItem = (webex: any, item: any) => {
         devicePairingType: webex.devicemanager.getPairedMethod(),
         deviceURL: pairedDevice.url,
         isPersonalDevice: pairedDevice.mode === 'personal',
-        productName: pairedDevice.devices[0]?.productName,
+        productName:
+          pairedDevice.devices?.length > 0 ? pairedDevice.devices[0]?.productName : undefined,
       };
       item.eventPayload.event.pairingState = 'paired';
       item.eventPayload.event.pairedDevice = devicePayload;

package/src/call-diagnostic/config.ts

@@ -26,6 +26,7 @@ export const WEBEX_SUB_SERVICE_TYPES: Record<string, ClientSubServiceType> = {
   SCHEDULED_MEETING: 'ScheduledMeeting',
   WEBINAR: 'Webinar',
   WEBCAST: 'Webcast',
+  LARGE_SCALE_WEBINAR: 'LargeScaleWebinar',
 };
 
 // Found in https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia

package/src/metrics.types.ts

@@ -319,6 +319,7 @@ export type PreComputedLatencies =
   | 'internal.get.cluster.time'
   | 'internal.click.to.interstitial'
   | 'internal.click.to.interstitial.with.user.delay'
+  | 'internal.click.to.interstitial.for.client.jmt'
   | 'internal.refresh.captcha.time'
   | 'internal.exchange.ci.token.time'
   | 'internal.get.u2c.time'

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

@@ -346,6 +346,9 @@ describe('plugin-metrics', () => {
           webex.internal.newMetrics.callDiagnosticLatencies.getStayLobbyTime = sinon
             .stub()
             .returns(1);
+          webex.internal.newMetrics.callDiagnosticLatencies.getStayLobbyTimeCappedBy = sinon
+            .stub()
+            .returns(1);
           webex.internal.newMetrics.callDiagnosticLatencies.getTotalMediaJMTWithUserDelay = sinon
             .stub()
             .returns(43);
@@ -366,9 +369,9 @@ describe('plugin-metrics', () => {
           assert.deepEqual(webex.request.getCalls()[0].args[0].body.metrics[0].eventPayload.event, {
             name: 'client.media-engine.ready',
             joinTimes: {
-              totalMediaJMT: 61,
+              totalMediaJMT: 44,
               interstitialToMediaOKJMT: 22,
-              callInitMediaEngineReady: 10,
+              callInitMediaEngineReady: 22,
               totalMediaJMTWithUserDelay: 43,
               totalJMTWithUserDelay: 64,
             },