@webex/internal-plugin-metrics 3.12.0-task-refactor.1 → 3.12.0-webex-services-ready.1

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

@@ -0,0 +1,47 @@
+import GenericMetrics from './generic-metrics';
+import { EventPayload } from './metrics.types';
+import PreLoginMetricsBatcher from './prelogin-metrics-batcher';
+/**
+ * @description Util class to handle PreLogin Metrics
+ * @export
+ * @class PreLoginMetrics
+ */
+export default class PreLoginMetrics extends GenericMetrics {
+    private preLoginMetricsBatcher;
+    /**
+     * Constructor
+     * @param {PreLoginMetricsBatcher} preLoginMetricsBatcher - Pre-login metrics batcher
+     * @param {any} attrs - Attributes
+     * @param {any} options - Options
+     * @constructor
+     */
+    constructor(preLoginMetricsBatcher: typeof PreLoginMetricsBatcher, attrs?: any, options?: {
+        parent?: any;
+    });
+    /**
+     * Submit a business metric to our metrics endpoint.
+     * Routes to the correct table with the correct schema payload by table.
+     * @see https://confluence-eng-gpk2.cisco.com/conf/display/WAP/Business+metrics++-%3E+ROMA
+     * @param {Object} options - The options object
+     * @param {string} options.name - Name of the metric
+     * @param {string} options.preLoginId - ID to identify pre-login user
+     * @param {EventPayload} options.payload - User payload of the metric
+     * @param {EventPayload} [options.metadata] - Optional metadata to include outside of eventPayload.value
+     * @returns {Promise<void>} Promise that resolves when the metric is submitted
+     */
+    submitPreLoginEvent({ name, preLoginId, payload, metadata, }: {
+        name: string;
+        preLoginId: string;
+        payload: EventPayload;
+        metadata?: EventPayload;
+    }): Promise<void>;
+    /**
+     * Builds a formatted event object for metrics submission.
+     * @param {string} metricName - Metric name
+     * @param {string} preLoginId - Pre-login user identifier
+     * @param {EventPayload} payload - Metric payload data
+     * @param {EventPayload} metadata - Additional metadata to include in the event
+     * @returns {object} Formatted metrics event object with type, eventPayload, and timestamp
+     */
+    private buildEvent;
+}

package/package.json

@@ -24,23 +24,23 @@
     "@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.2191",
     "@webex/jest-config-legacy": "0.0.0",
     "@webex/legacy-tools": "0.0.0",
-    "@webex/test-helper-chai": "3.12.0-task-refactor.1",
-    "@webex/test-helper-mocha": "3.12.0-task-refactor.1",
-    "@webex/test-helper-mock-webex": "3.12.0-task-refactor.1",
-    "@webex/test-helper-test-users": "3.12.0-task-refactor.1",
+    "@webex/test-helper-chai": "3.12.0-webex-services-ready.1",
+    "@webex/test-helper-mocha": "3.12.0-webex-services-ready.1",
+    "@webex/test-helper-mock-webex": "3.12.0-webex-services-ready.1",
+    "@webex/test-helper-test-users": "3.12.0-webex-services-ready.1",
     "eslint": "^8.24.0",
     "prettier": "^2.7.1",
     "sinon": "^9.2.4"
   },
   "dependencies": {
-    "@webex/common": "3.12.0-task-refactor.1",
-    "@webex/common-timers": "3.12.0-task-refactor.1",
-    "@webex/event-dictionary-ts": "^1.0.1930",
-    "@webex/test-helper-chai": "3.12.0-task-refactor.1",
-    "@webex/test-helper-mock-webex": "3.12.0-task-refactor.1",
-    "@webex/webex-core": "3.12.0-task-refactor.1",
+    "@webex/common": "3.12.0-webex-services-ready.1",
+    "@webex/common-timers": "3.12.0-webex-services-ready.1",
+    "@webex/test-helper-chai": "3.12.0-webex-services-ready.1",
+    "@webex/test-helper-mock-webex": "3.12.0-webex-services-ready.1",
+    "@webex/webex-core": "3.12.0-webex-services-ready.1",
     "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-task-refactor.1"
+  "version": "3.12.0-webex-services-ready.1"
 }

package/src/batcher.js

@@ -75,6 +75,10 @@ const MetricsBatcher = Batcher.extend({
    */
   handleHttpError(reason) {
     if (reason instanceof WebexHttpError.NetworkOrCORSError) {
+      if (!this.config.batcherRetryOnNetworkError) {
+        return Reflect.apply(Batcher.prototype.handleHttpError, this, [reason]);
+      }
+
       this.logger.warn(
         'metrics-batcher: received network error submitting metrics, reenqueuing payload'
       );

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

@@ -55,6 +55,8 @@ const CallDiagnosticEventsBatcher = Batcher.extend({
           `CallDiagnosticEventsBatcher: @submitHttpRequest#${batchId}. Request successful.`
         );
 
+        this.handleHttpResponseStatus(res?.statusCode, payload);
+
         return res;
       })
       .catch((err) => {
@@ -64,9 +66,33 @@ const CallDiagnosticEventsBatcher = Batcher.extend({
           `error: ${generateCommonErrorMetadata(err)}`
         );
 
+        this.handleHttpResponseStatus(err?.statusCode, payload);
+
         return Promise.reject(err);
       });
   },
+
+  /**
+   * React to the HTTP status code returned by the metrics endpoint.
+   * Only items submitted with `markTelemetryOptOutOnResponse: true` opt into
+   * this behavior.
+   * @param {number | undefined} statusCode
+   * @param {any[]} payload Items flushed in this HTTP batch.
+   * @returns {void}
+   */
+  handleHttpResponseStatus(statusCode: number | undefined, payload: any[]) {
+    const shouldMark =
+      Array.isArray(payload) &&
+      payload.some((item) => item?.markTelemetryOptOutOnResponse === true);
+
+    if (!shouldMark) {
+      return;
+    }
+
+    if (statusCode === 200) {
+      this.webex.internal.newMetrics?.callDiagnosticMetrics?.setIsTelemetryOptOutAutomatic(true);
+    }
+  },
 });
 
 export default CallDiagnosticEventsBatcher;

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'
     );
   }
@@ -224,11 +224,17 @@ export default class CallDiagnosticLatencies extends WebexPlugin {
    * @returns - latency
    */
   public getCallInitJoinReq() {
-    return this.getDiffBetweenTimestamps(
-      'internal.client.interstitial-window.click.joinbutton',
-      'client.locus.join.request',
-      {maximum: 1200000}
+    const interstitialShowedToJoinReq = this.getDiffBetweenTimestamps(
+      'internal.client.meeting.interstitial-window.showed',
+      'client.locus.join.request'
     );
+    const showInterstitialTime = this.getShowInterstitialTime() || 0;
+
+    if (typeof interstitialShowedToJoinReq !== 'number') {
+      return undefined;
+    }
+
+    return clamp(interstitialShowedToJoinReq - showInterstitialTime, 0, 1200000);
   }
 
   /**
@@ -303,10 +309,39 @@ export default class CallDiagnosticLatencies extends WebexPlugin {
    * @returns - latency
    */
   public getStayLobbyTime() {
-    return this.getDiffBetweenTimestamps(
-      'client.locus.join.response',
-      'internal.host.meeting.participant.admitted'
-    );
+    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);
   }
 
   /**
@@ -334,14 +369,6 @@ export default class CallDiagnosticLatencies extends WebexPlugin {
    * @returns - latency
    */
   public getClickToInterstitial() {
-    // 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 clickToInterstitialLatency = this.precomputedLatencies.get(
       'internal.click.to.interstitial'
     );
@@ -358,14 +385,6 @@ export default class CallDiagnosticLatencies extends WebexPlugin {
    * @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'
     );
@@ -382,10 +401,17 @@ export default class CallDiagnosticLatencies extends WebexPlugin {
    * @returns - latency
    */
   public getInterstitialToJoinOK() {
-    return this.getDiffBetweenTimestamps(
-      'internal.client.interstitial-window.click.joinbutton',
+    const interstitialShowedToJoinResp = this.getDiffBetweenTimestamps(
+      'internal.client.meeting.interstitial-window.showed',
       'client.locus.join.response'
     );
+    const showInterstitialTime = this.getShowInterstitialTime() || 0;
+
+    if (typeof interstitialShowedToJoinResp !== 'number') {
+      return undefined;
+    }
+
+    return clamp(interstitialShowedToJoinResp - showInterstitialTime, 0, this.MAX_INTEGER);
   }
 
   /**
@@ -393,11 +419,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();
   }
 
   /**
@@ -405,20 +427,22 @@ export default class CallDiagnosticLatencies extends WebexPlugin {
    * @returns - latency
    */
   public getInterstitialToMediaOKJMT() {
-    const interstitialJoinClickTimestamp = this.latencyTimestamps.get(
-      'internal.client.interstitial-window.click.joinbutton'
+    const interstitialShowedToIceEnd = this.getDiffBetweenTimestamps(
+      'internal.client.meeting.interstitial-window.showed',
+      'client.ice.end'
     );
+    const showInterstitialTime = this.getShowInterstitialTime() || 0;
+    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 interstitialShowedToIceEnd === 'number' &&
+      typeof stayLobbyTimeCappedByIceEnd === 'number'
+    ) {
+      return clamp(
+        interstitialShowedToIceEnd - showInterstitialTime - stayLobbyTimeCappedByIceEnd,
+        0,
+        this.MAX_INTEGER
+      );
     }
 
     return undefined;
@@ -430,10 +454,21 @@ export default class CallDiagnosticLatencies extends WebexPlugin {
    */
   public getTotalJMT() {
     const clickToInterstitial = this.getClickToInterstitial();
-    const interstitialToJoinOk = this.getInterstitialToJoinOK();
+    const interstitialShowedToJoinLocusResponse = this.getDiffBetweenTimestamps(
+      'internal.client.meeting.interstitial-window.showed',
+      'client.locus.join.response'
+    );
+    const showInterstitialTime = this.getShowInterstitialTime() || 0;
 
-    if (typeof clickToInterstitial === 'number' && typeof interstitialToJoinOk === 'number') {
-      return clamp(clickToInterstitial + interstitialToJoinOk, 0, this.MAX_INTEGER);
+    if (
+      typeof clickToInterstitial === 'number' &&
+      typeof interstitialShowedToJoinLocusResponse === 'number'
+    ) {
+      return clamp(
+        clickToInterstitial + interstitialShowedToJoinLocusResponse - showInterstitialTime,
+        0,
+        this.MAX_INTEGER
+      );
     }
 
     return undefined;
@@ -445,13 +480,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;
@@ -478,21 +520,28 @@ export default class CallDiagnosticLatencies extends WebexPlugin {
    */
   public getTotalMediaJMT() {
     const clickToInterstitial = this.getClickToInterstitial();
-    const interstitialToJoinOk = this.getInterstitialToJoinOK();
-    const joinConfJMT = this.getJoinConfJMT();
-    const lobbyTime = this.getStayLobbyTime();
+    const interstitialShowedToMediaEngineReady = this.getDiffBetweenTimestamps(
+      'internal.client.meeting.interstitial-window.showed',
+      'client.media-engine.ready'
+    );
+    const showInterstitialTime = this.getShowInterstitialTime() || 0;
+    const stayLobbyTimeCappedByMediaEngineReady = this.getStayLobbyTimeCappedBy(
+      'client.media-engine.ready'
+    );
 
-    if (clickToInterstitial && interstitialToJoinOk && joinConfJMT) {
-      const totalMediaJMT = clamp(
-        clickToInterstitial + interstitialToJoinOk + joinConfJMT,
+    if (
+      typeof clickToInterstitial === 'number' &&
+      typeof interstitialShowedToMediaEngineReady === 'number' &&
+      typeof stayLobbyTimeCappedByMediaEngineReady === 'number'
+    ) {
+      return clamp(
+        clickToInterstitial +
+          interstitialShowedToMediaEngineReady -
+          showInterstitialTime -
+          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;
@@ -504,12 +553,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
       );
@@ -523,11 +577,26 @@ 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 interstitialShowedToLocusJoinRequest = this.getDiffBetweenTimestamps(
+      'internal.client.meeting.interstitial-window.showed',
+      'client.locus.join.request'
+    );
+    const showInterstitialTime = this.getShowInterstitialTime() || 0;
 
-    if (typeof interstitialToJoinOk === 'number' && typeof joinConfJMT === 'number') {
-      return clamp(interstitialToJoinOk - joinConfJMT, 0, this.MAX_INTEGER);
+    if (
+      typeof clickToInterstitialForClientJmt === 'number' &&
+      typeof interstitialShowedToLocusJoinRequest === 'number'
+    ) {
+      return clamp(
+        clickToInterstitialForClientJmt +
+          interstitialShowedToLocusJoinRequest -
+          showInterstitialTime,
+        0,
+        this.MAX_INTEGER
+      );
     }
 
     return undefined;

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

@@ -108,6 +108,8 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
   private isMercuryConnected = false;
   private eventLimitTracker: Map<string, number> = new Map();
   private eventLimitWarningsLogged: Set<string> = new Set();
+  private isTelemetryOptOutManual = false;
+  private isTelemetryOptOutAutomatic = false;
 
   // the default validator before piping an event to the batcher
   // this function can be overridden by the user
@@ -145,6 +147,37 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
     return null;
   }
 
+  /**
+   * Returns the telemetryOptOut value of the current user
+   * @returns one of 'manual', 'automatic', undefined
+   */
+  public getTelemetryOptOut() {
+    if (this.isTelemetryOptOutManual) {
+      return 'manual';
+    }
+    if (this.isTelemetryOptOutAutomatic) {
+      return 'automatic';
+    }
+
+    return undefined;
+  }
+
+  /**
+   * Sets the manual telemetry opt-out status for the current user
+   * @param value - boolean value indicating manual telemetry opt-out status
+   */
+  public setIsTelemetryOptOutManual(value: boolean) {
+    this.isTelemetryOptOutManual = value;
+  }
+
+  /**
+   * Sets the automatic telemetry opt-out status for the current user
+   * @param value - boolean value indicating automatic telemetry opt-out status
+   */
+  public setIsTelemetryOptOutAutomatic(value: boolean) {
+    this.isTelemetryOptOutAutomatic = value;
+  }
+
   /**
    * Returns if the meeting has converged architecture enabled
    * @param options.meetingId
@@ -190,6 +223,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;
@@ -366,6 +404,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
     if (meeting?.locusInfo?.fullState) {
       identifiers.locusUrl = meeting.locusUrl;
       identifiers.locusId = meeting.locusUrl && meeting.locusUrl.split('/').pop();
+      identifiers.locusSessionId = meeting.locusInfo.fullState.sessionId;
       identifiers.locusStartTime =
         meeting.locusInfo.fullState && meeting.locusInfo.fullState.lastActive;
     }
@@ -601,6 +640,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
           mediaEngineSoftwareVersion: getOSVersion() || 'unknown',
           startTime: new Date().toISOString(),
         },
+        webexSubServiceType: this.getSubServiceType(meeting),
       };
 
       // merge any new properties, or override existing ones
@@ -983,7 +1023,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
       sessionCorrelationId,
     });
 
-    // create common event object structur
+    // create common event object structure
     const commonEventObject = {
       name,
       canProceed: true,
@@ -996,6 +1036,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         'loginType' in meeting.callStateForMetrics
           ? meeting.callStateForMetrics.loginType
           : this.getCurLoginType(),
+      telemetryOptOut: this.getTelemetryOptOut(),
       isConvergedArchitectureEnabled: this.getIsConvergedArchitectureEnabled({
         meetingId,
       }),
@@ -1004,6 +1045,9 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
       webexSubServiceType: this.getSubServiceType(meeting),
       // @ts-ignore
       webClientPreload: this.webex.meetings?.config?.metrics?.webClientPreload,
+      isVipMeeting: meeting?.meetingInfo?.vipmeeting || false,
+      isAutomatedUser:
+        typeof window !== 'undefined' && typeof navigator !== 'undefined' && !!navigator?.webdriver, // if webdriver is true, it's most likely in a test environment
     };
 
     const joinFlowVersion = options.joinFlowVersion ?? meeting.callStateForMetrics?.joinFlowVersion;
@@ -1123,8 +1167,11 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         isMercuryConnected: this.isMercuryConnected,
       },
       loginType: this.getCurLoginType(),
+      telemetryOptOut: this.getTelemetryOptOut(),
       // @ts-ignore
       webClientPreload: this.webex.meetings?.config?.metrics?.webClientPreload,
+      isAutomatedUser:
+        typeof window !== 'undefined' && typeof navigator !== 'undefined' && !!navigator?.webdriver, // if webdriver is true, it's most likely in a test environment
     };
 
     if (options.joinFlowVersion) {
@@ -1317,6 +1364,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
     const finalEvent = {
       eventPayload: event,
       type: ['diagnostic-event'],
+      markTelemetryOptOutOnResponse: true,
     };
 
     return this.callDiagnosticEventsBatcher.request(finalEvent);
@@ -1326,6 +1374,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
    * Prepare the event and send the request to metrics-a service, pre login.
    * @param event
    * @param preLoginId
+   * @param markTelemetryOptOutOnResponse
    * @returns
    */
   submitToCallDiagnosticsPreLogin = (event: Event, preLoginId?: string): Promise<any> => {
@@ -1333,7 +1382,9 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
     const finalEvent = {
       eventPayload: event,
       type: ['diagnostic-event'],
+      markTelemetryOptOutOnResponse: true,
     };
+
     this.preLoginMetricsBatcher.savePreLoginId(preLoginId);
 
     return this.preLoginMetricsBatcher.request(finalEvent);

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

@@ -179,6 +179,43 @@ export const isSdpOfferCreationError = (rawError: any) => {
   return false;
 };
 
+export const isWebrtcApiNotAvailableError = (
+  rawError: {code: number; message: string; name: string} | unknown
+) => {
+  if ((rawError as {name: string}).name === ERROR_DESCRIPTIONS.WEBRTC_API_NOT_AVAILABLE) {
+    return true;
+  }
+
+  return false;
+};
+
+/**
+ * Checks if the given error is a browser media error by its name.
+ * Returns true if the error name matches any known browser media error name in the mapping.
+ *
+ * @param {Object} rawError - The error object to check.
+ * @returns {boolean} True if the error is a browser media error, false otherwise.
+ */
+export const isBrowserMediaError = (rawError) => {
+  // eslint-disable-next-line no-use-before-define
+  if (isBrowserMediaErrorName(rawError.name)) {
+    return true;
+  }
+
+  return false;
+};
+
+/**
+ * Returns the client error code mapped to the given browser media error name.
+ * If the error name is not found in the mapping, returns undefined.
+ *
+ * @param {Object} rawError - The error object containing the error name.
+ * @returns {string|undefined} The mapped client error code, or undefined if not found.
+ */
+export const getBrowserMediaErrorCode = (rawError) => {
+  return BROWSER_MEDIA_ERROR_NAME_TO_CLIENT_ERROR_CODES_MAP[rawError.name];
+};
+
 /**
  * MDN Media Devices getUserMedia() method returns a name if it errs
  * Documentation can be found here: https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia
@@ -247,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;
@@ -324,7 +362,6 @@ export const prepareDiagnosticMetricItem = (webex: any, item: any) => {
       joinTimes.totalMediaJMT = cdl.getTotalMediaJMT();
       joinTimes.interstitialToMediaOKJMT = cdl.getInterstitialToMediaOKJMT();
       joinTimes.callInitMediaEngineReady = cdl.getCallInitMediaEngineReady();
-      joinTimes.stayLobbyTime = cdl.getStayLobbyTime();
       joinTimes.totalMediaJMTWithUserDelay = cdl.getTotalMediaJMTWithUserDelay();
       joinTimes.totalJMTWithUserDelay = cdl.getTotalJMTWithUserDelay();
       break;
@@ -332,6 +369,11 @@ export const prepareDiagnosticMetricItem = (webex: any, item: any) => {
     case 'client.media.tx.start':
       audioSetupDelay.joinRespTxStart = cdl.getAudioJoinRespTxStart();
       videoSetupDelay.joinRespTxStart = cdl.getVideoJoinRespTxStart();
+      break;
+
+    case 'client.lobby.exited':
+      joinTimes.stayLobbyTime = cdl.getStayLobbyTime();
+      break;
   }
 
   if (!isEmpty(joinTimes)) {
@@ -348,6 +390,11 @@ export const prepareDiagnosticMetricItem = (webex: any, item: any) => {
 
   item.eventPayload.origin = Object.assign(origin, item.eventPayload.origin);
 
+  // Mark call milestones in logs for easier filtering and analysis
+  if (eventName) {
+    webex.logger.log('Milestone,CallDiagnostic', eventName);
+  }
+
   webex.logger.log(
     `CallDiagnosticLatencies,prepareDiagnosticMetricItem: ${JSON.stringify({
       latencies: Object.fromEntries(cdl.latencyTimestamps),