@webex/internal-plugin-metrics 3.11.0 → 3.12.0-llmrefactor.2

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

@@ -6,6 +6,7 @@ import uuid from 'uuid';
 import {merge} from 'lodash';
 import {StatelessWebexPlugin} from '@webex/webex-core';
 import {getOSNameInternal} from '../metrics';
+import * as AutomatedUserUtils from '../automated-user';
 
 import {
   anonymizeIPAddress,
@@ -99,7 +100,12 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
   // @ts-ignore
   private preLoginMetricsBatcher: PreLoginMetricsBatcher;
 
-  private logger: any; // to avoid adding @ts-ignore everywhere
+  // lazy getter to avoid @ts-ignore on every call site
+  private get logger(): any {
+    // @ts-ignore
+    return this.webex.logger;
+  }
+
   private hasLoggedBrowserSerial: boolean;
   private device: any;
   private delayedClientEvents: DelayedClientEvent[] = [];
@@ -108,6 +114,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
@@ -124,8 +132,6 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
   constructor(...args) {
     super(...args);
     // @ts-ignore
-    this.logger = this.webex.logger;
-    // @ts-ignore
     this.callDiagnosticEventsBatcher = new CallDiagnosticEventsBatcher({}, {parent: this.webex});
     // @ts-ignore
     this.preLoginMetricsBatcher = new PreLoginMetricsBatcher({}, {parent: this.webex});
@@ -145,6 +151,58 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
     return null;
   }
 
+  /**
+   * Returns the user activation state reported from the browser's navigator.userActivation API
+   * @returns object with hasBeenActive and isActive booleans, or undefined if unavailable
+   */
+  getUserActivation(): {hasBeenActive: boolean; isActive: boolean} | undefined {
+    const userActivation =
+      typeof navigator !== 'undefined'
+        ? (navigator as {userActivation?: {hasBeenActive: boolean; isActive: boolean}})
+            .userActivation
+        : undefined;
+
+    if (userActivation) {
+      return {
+        hasBeenActive: userActivation.hasBeenActive,
+        isActive: userActivation.isActive,
+      };
+    }
+
+    return undefined;
+  }
+
+  /**
+   * 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 +248,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;
@@ -213,12 +276,12 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
   getOrigin(options: GetOriginOptions, meetingId?: string) {
     const defaultClientType: ClientType =
       // @ts-ignore
-      this.webex.meetings.config?.metrics?.clientType;
+      this.webex.meetings?.config?.metrics?.clientType;
     const defaultSubClientType: SubClientType =
       // @ts-ignore
-      this.webex.meetings.config?.metrics?.subClientType;
+      this.webex.meetings?.config?.metrics?.subClientType;
     // @ts-ignore
-    const providedClientVersion: string = this.webex.meetings.config?.metrics?.clientVersion;
+    const providedClientVersion: string = this.webex.meetings?.config?.metrics?.clientVersion;
     // @ts-ignore
     const defaultSDKClientVersion = `${CLIENT_NAME}/${this.webex.version}`;
 
@@ -229,6 +292,18 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
       versionMetadata = extractVersionMetadata(providedClientVersion);
     }
 
+    // Browser details and the support verdict can all be supplied by the host client, which is able
+    // to resolve wrapper browsers (Electron, WebOS) to the engine that actually determines
+    // capability. The browser fields fall back to the SDK's own detection when not supplied, the
+    // same way clientVersion falls back to the SDK version.
+    const {
+      browser: providedBrowser,
+      browserVersion: providedBrowserVersion,
+      isSupportedBrowserFamily,
+      isOutdatedBrowserVersion,
+      // @ts-ignore
+    } = this.webex.meetings?.config?.metrics ?? {};
+
     if (!this.hasLoggedBrowserSerial) {
       this.logger.log(
         CALL_DIAGNOSTIC_LOG_IDENTIFIER,
@@ -258,25 +333,27 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
           ...versionMetadata,
           publicNetworkPrefix:
             // @ts-ignore
-            anonymizeIPAddress(this.webex.meetings.geoHintInfo?.clientAddress) || undefined,
+            anonymizeIPAddress(this.webex.meetings?.geoHintInfo?.clientAddress) || undefined,
           localNetworkPrefix:
             anonymizeIPAddress(
               // @ts-ignore
-              this.webex.meetings.meetingCollection
-                .get(meetingId)
+              this.webex.meetings?.meetingCollection
+                ?.get(meetingId)
                 ?.statsAnalyzer?.getLocalIpAddress()
             ) || undefined,
           osVersion: getOSVersion() || 'unknown',
           subClientType: options?.subClientType || defaultSubClientType,
           os: getOSNameInternal(),
-          browser: getBrowserName(),
-          browserVersion: getBrowserVersion(),
+          browser: providedBrowser || getBrowserName(),
+          browserVersion: providedBrowserVersion || getBrowserVersion(),
+          ...(isSupportedBrowserFamily === undefined ? {} : {isSupportedBrowserFamily}),
+          ...(isOutdatedBrowserVersion === undefined ? {} : {isOutdatedBrowserVersion}),
         },
       };
 
       if (meetingId) {
         // @ts-ignore
-        const meeting = this.webex.meetings.getBasicMeetingInformation(meetingId);
+        const meeting = this.webex.meetings?.getBasicMeetingInformation(meetingId);
         if (meeting?.environment) {
           origin.environment = meeting.environment;
         }
@@ -366,6 +443,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;
     }
@@ -425,7 +503,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         sent: 'not_defined_yet',
       },
       // @ts-ignore
-      senderCountryCode: this.webex.meetings.geoHintInfo?.countryCode,
+      senderCountryCode: this.webex.meetings?.geoHintInfo?.countryCode,
       event: eventData,
     };
 
@@ -601,6 +679,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 +1062,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 +1075,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 +1084,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: AutomatedUserUtils.isAutomatedUser(),
+      userActivation: this.getUserActivation(),
     };
 
     const joinFlowVersion = options.joinFlowVersion ?? meeting.callStateForMetrics?.joinFlowVersion;
@@ -1123,8 +1206,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: AutomatedUserUtils.isAutomatedUser(),
+      userActivation: this.getUserActivation(),
     };
 
     if (options.joinFlowVersion) {
@@ -1334,6 +1420,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
       eventPayload: event,
       type: ['diagnostic-event'],
     };
+
     this.preLoginMetricsBatcher.savePreLoginId(preLoginId);
 
     return this.preLoginMetricsBatcher.request(finalEvent);
@@ -1381,7 +1468,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
       },
       headers: {},
       // @ts-ignore
-      waitForServiceTimeout: this.webex.internal.metrics.config.waitForServiceTimeout,
+      waitForServiceTimeout: this.webex.internal.metrics?.config?.waitForServiceTimeout,
     };
 
     if (options.preLoginId) {

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

@@ -179,6 +179,16 @@ 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.
@@ -274,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;
@@ -351,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;
@@ -359,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)) {
@@ -375,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),

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
@@ -133,8 +134,10 @@ export const ERROR_DESCRIPTIONS = {
   MULTISTREAM_NOT_AVAILABLE: 'MultistreamNotAvailable',
   SDP_OFFER_CREATION_ERROR: 'SdpOfferCreationError',
   SDP_OFFER_CREATION_ERROR_MISSING_CODEC: 'SdpOfferCreationErrorMissingCodec',
+  WEBRTC_API_NOT_AVAILABLE: 'WebrtcApiNotAvailableError',
   WDM_RESTRICTED_REGION: 'WdmRestrictedRegion',
   USER_NOT_ALLOWED_JOIN_WEBINAR: 'UserNotAllowedJoinWebinar',
+  INVALID_MEETING_INFO: 'InvalidMeetingInfo',
 };
 
 export const SERVICE_ERROR_CODES_TO_CLIENT_ERROR_CODES_MAP = {
@@ -145,6 +148,8 @@ export const SERVICE_ERROR_CODES_TO_CLIENT_ERROR_CODES_MAP = {
   99002: 4100,
   // Cannot find the data. Unkown meeting.
   99009: 4100,
+  // The input parameters contain invalid item
+  99019: 4105,
   // Meeting is not allow to cross env
   58500: 4100,
   // Input parameters contain invalit item
@@ -200,6 +205,8 @@ export const SERVICE_ERROR_CODES_TO_CLIENT_ERROR_CODES_MAP = {
   423005: 4005,
   // Wrong password or host key with too many requests
   423006: 4005,
+  // PanelistPasswordError too many time,please input captcha code
+  423008: 4005,
   // PasswordError with right captcha, please input captcha code
   423010: 4005,
   // PasswordOrHostKeyError with right captcha, please input captcha code
@@ -226,6 +233,8 @@ export const SERVICE_ERROR_CODES_TO_CLIENT_ERROR_CODES_MAP = {
   403003: 4101,
   // Attendee email is required
   403030: 4101,
+  // webinar need login when un-invited attendee join
+  403106: 4104,
 
   // ---- Locus ------
   // FREE_USER_MAX_PARTICIPANTS_EXCEEDED
@@ -695,6 +704,12 @@ export const CLIENT_ERROR_CODE_TO_ERROR_PAYLOAD: Record<number, Partial<ClientEv
     category: 'expected',
     fatal: true,
   },
+  4105: {
+    errorDescription: ERROR_DESCRIPTIONS.INVALID_MEETING_INFO,
+    category: 'expected',
+    fatal: false,
+    shownToUser: true,
+  },
   2729: {
     errorDescription: ERROR_DESCRIPTIONS.NO_MEDIA_FOUND,
     category: 'expected',

package/src/config.js

@@ -19,6 +19,7 @@ export default {
     batcherMaxCalls: 50,
     batcherMaxWait: 1500,
     batcherRetryPlateau: 32000,
+    batcherRetryOnNetworkError: true,
     waitForServiceTimeout: 30,
   },
 };

package/src/generic-metrics.ts

@@ -79,7 +79,7 @@ export default abstract class GenericMetrics extends StatelessWebexPlugin {
       device: {
         id: this.getDeviceId(),
       },
-      locale: window.navigator.language,
+      locale: window?.navigator.language,
       os: {
         name: getOSNameInternal(),
         version: getOSVersion(),
@@ -94,12 +94,12 @@ export default abstract class GenericMetrics extends StatelessWebexPlugin {
   protected getBrowserDetails(): object {
     return {
       browser: getBrowserName(),
-      browserHeight: window.innerHeight,
+      browserHeight: window?.innerHeight,
       browserVersion: getBrowserVersion(),
-      browserWidth: window.innerWidth,
-      domain: window.location.hostname,
-      inIframe: window.self !== window.top,
-      locale: window.navigator.language,
+      browserWidth: window?.innerWidth,
+      domain: window?.location.hostname,
+      inIframe: window?.self !== window?.top,
+      locale: window?.navigator.language,
       os: getOSNameInternal(),
     };
   }

package/src/index.ts

@@ -8,6 +8,7 @@ import Metrics from './metrics';
 import config from './config';
 import NewMetrics from './new-metrics';
 import * as Utils from './utils';
+import * as AutomatedUserUtils from './automated-user';
 import {
   ClientEvent,
   ClientEventLeaveReason,
@@ -19,6 +20,8 @@ import {
   SubmitMQE,
   PreComputedLatencies,
   SubmitFeatureEvent,
+  LocusSyncLatencyEventName,
+  PrivacyAndSecurityPermission,
 } from './metrics.types';
 import * as CALL_DIAGNOSTIC_CONFIG from './call-diagnostic/config';
 import * as CallDiagnosticUtils from './call-diagnostic/call-diagnostic-metrics.util';
@@ -28,6 +31,7 @@ import BehavioralMetrics from './behavioral-metrics';
 import OperationalMetrics from './operational-metrics';
 import BusinessMetrics from './business-metrics';
 import RtcMetrics from './rtcMetrics';
+import PreLoginMetrics from './prelogin-metrics';
 
 registerInternalPlugin('metrics', Metrics, {
   config,
@@ -42,6 +46,7 @@ export {default, getOSNameInternal} from './metrics';
 export {
   config,
   CALL_DIAGNOSTIC_CONFIG,
+  AutomatedUserUtils,
   NewMetrics,
   Utils,
   CallDiagnosticUtils,
@@ -51,7 +56,9 @@ export {
   OperationalMetrics,
   BusinessMetrics,
   RtcMetrics,
+  PreLoginMetrics,
 };
+export {isAutomatedUser, isAutomatedUserAgent} from './automated-user';
 export type {
   ClientEvent,
   ClientEventLeaveReason,
@@ -63,4 +70,6 @@ export type {
   SubmitBusinessEvent,
   PreComputedLatencies,
   SubmitFeatureEvent,
+  LocusSyncLatencyEventName,
+  PrivacyAndSecurityPermission,
 };

package/src/metrics.types.ts

@@ -1,4 +1,4 @@
-import {
+import type {
   ClientEvent as RawClientEvent,
   Event as RawEvent,
   MediaQualityEvent as RawMediaQualityEvent,
@@ -23,6 +23,15 @@ export type ClientUserNameInput = NonNullable<RawClientEvent['userNameInput']>;
 
 export type ClientEmailInput = NonNullable<RawClientEvent['emailInput']>;
 
+export type PrivacyAndSecurityPermission = NonNullable<
+  RawClientEvent['privacyAndSecurityPermission']
+>;
+
+export type PrivacyAndSecurityPermissionResource = keyof PrivacyAndSecurityPermission;
+
+export type PrivacyAndSecurityPermissionState =
+  PrivacyAndSecurityPermission[PrivacyAndSecurityPermissionResource];
+
 export type BrowserLaunchMethodType = NonNullable<
   RawEvent['origin']['clientInfo']
 >['browserLaunchMethod'];
@@ -149,6 +158,17 @@ export type SubmitMQEOptions = {
   globalMeetingId?: string;
 };
 
+export const LOCUS_SYNC_LATENCY_EVENT_NAMES = [
+  'internal.client.locus.sync.start',
+  'internal.client.locus.hashtree.request',
+  'internal.client.locus.hashtree.response',
+  'internal.client.locus.sync.request',
+  'internal.client.locus.sync.response',
+  'internal.client.locus.sync.message.received',
+] as const;
+
+export type LocusSyncLatencyEventName = (typeof LOCUS_SYNC_LATENCY_EVENT_NAMES)[number];
+
 export type InternalEvent = {
   name:
     | 'internal.client.meetinginfo.request'
@@ -156,14 +176,14 @@ export type InternalEvent = {
     | 'internal.register.device.request'
     | 'internal.register.device.response'
     | 'internal.reset.join.latencies'
-    | 'internal.client.meeting.click.joinbutton'
     | 'internal.host.meeting.participant.admitted'
     | 'internal.client.meeting.interstitial-window.showed'
     | 'internal.client.interstitial-window.click.joinbutton'
     | 'internal.client.add-media.turn-discovery.start'
     | 'internal.client.add-media.turn-discovery.end'
     | 'internal.client.share.initiated'
-    | 'internal.client.share.stopped';
+    | 'internal.client.share.stopped'
+    | LocusSyncLatencyEventName;
 
   payload?: never;
   options?: never;
@@ -197,7 +217,7 @@ export interface BusinessEventPayload {
   metricName: string;
   timestamp: number;
   context: DeviceContext;
-  browserDetails: EventPayload;
+  browserDetails: object;
   value: EventPayload;
 }
 
@@ -319,12 +339,14 @@ 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'
   | 'internal.call.init.join.req'
   | 'internal.other.app.api.time'
-  | 'internal.api.fetch.intelligence.models';
+  | 'internal.api.fetch.intelligence.models'
+  | 'internal.client.locus.sync.random.backoff';
 
 export interface IdType {
   meetingId?: string;