@webex/internal-plugin-metrics 3.12.0-next.4 → 3.12.0-next.40

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

@@ -27,7 +27,7 @@ type GetIdentifiersOptions = {
 export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
     private callDiagnosticEventsBatcher;
     private preLoginMetricsBatcher;
-    private logger;
+    private get logger();
     private hasLoggedBrowserSerial;
     private device;
     private delayedClientEvents;
@@ -36,6 +36,8 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
     private isMercuryConnected;
     private eventLimitTracker;
     private eventLimitWarningsLogged;
+    private isTelemetryOptOutManual;
+    private isTelemetryOptOutAutomatic;
     validator: (options: {
         type: 'mqe' | 'ce';
         event: Event;
@@ -53,6 +55,29 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
      * @returns one of 'login-ci','unverified-guest', null
      */
     getCurLoginType(): "unverified-guest" | "login-ci";
+    /**
+     * 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;
+    /**
+     * Returns the telemetryOptOut value of the current user
+     * @returns one of 'manual', 'automatic', undefined
+     */
+    getTelemetryOptOut(): "manual" | "automatic";
+    /**
+     * Sets the manual telemetry opt-out status for the current user
+     * @param value - boolean value indicating manual telemetry opt-out status
+     */
+    setIsTelemetryOptOutManual(value: boolean): void;
+    /**
+     * Sets the automatic telemetry opt-out status for the current user
+     * @param value - boolean value indicating automatic telemetry opt-out status
+     */
+    setIsTelemetryOptOutAutomatic(value: boolean): void;
     /**
      * Returns if the meeting has converged architecture enabled
      * @param options.meetingId
@@ -84,6 +109,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         userAgent: string;
         buildType?: "debug" | "test" | "prod" | "tap" | "analyzer-test";
         upgradeChannel?: string;
+        upgradeSource?: string;
         instanceId?: string;
         networkType: "wifi" | "ethernet" | "cellular" | "unknown";
         localIP?: string;
@@ -106,6 +132,8 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
             urlProtocolLaunchMethod?: "manual" | "auto" | "extension-fallback";
             browser?: string;
             browserVersion?: string;
+            isSupportedBrowserFamily?: boolean;
+            isOutdatedBrowserVersion?: boolean;
             clientType?: "MEETING_CENTER" | "EVENT_CENTER" | "TRAINING_CENTER" | "TEAMS_CLIENT" | "TEAMS_DEVICE" | "TEAMS_SHARE" | "SIP" | "RECORDING" | "CLOUD_AWARE_SIP" | "TEAMS_WXC_CLIENT" | "WXC_CLIENT" | "WXC_DEVICE" | "WEBEX_JS_SDK" | "VOICEA_CLIENT" | "CISCO_SIP_GW" | "WEBEX_SDK" | "CPAAS_THIRD_PARTY_SDK" | "WXC_THIRD_PARTY" | "WXCC" | "TEAMS_PHONE" | "WEBEX_RELAY";
             subClientType?: "TEAMS_DEVICE" | "SIP" | "AUTOMOTIVE_APP" | "BROWSER_EXTENSION" | "DESKTOP_APP" | "DESKTOP_APP_VDI" | "DEVICE_CURRENT" | "DEVICE_LEGACY_2020" | "HOLOGRAM_HEADSET_APP" | "HVDI_APP" | "MIXED" | "MOBILE_APP" | "MOBILE_NETWORK" | "PAGE" | "VDI_APP" | "WEB_APP" | "PHONE_NOVUM" | "PHONE_ESPRESSO" | "PHONE_BUMBLEBEE" | "SIP_PSTN";
             schedulingClientType?: "TEAMS_CLIENT" | "GOOGLE_ADDON" | "PT" | "PUBLIC_API" | "UNIFIED_PAGE" | "WEBEX_PAGE" | "GOOGLE_NOTIFICATION_CALENDAR" | "MSFT_NOTIFICATION_ADDIN" | "MSFT_NOTIFICATION_CALENDAR" | "OUTLOOK_ADDIN";
@@ -113,6 +141,10 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
             clientVersionStatus?: "CURRENT" | "LEGACY" | "UNSUPPORTED";
             localClientVersion?: string;
             launcherVersion?: string;
+            installerVersion?: string;
+            installerMajorVersion?: number;
+            installerMinorVersion?: number;
+            installerRevision?: number;
             modelNumber?: string;
             joinFirstUpdateLater?: "ep-enabled" | "sp-enabled" | "not-enabled";
             standbyUsed?: boolean;
@@ -137,11 +169,12 @@ 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";
+            appliedLayout?: "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 +186,24 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
             vendorId?: string;
             staticPerformanceLevel?: string;
             staticPerformanceScore?: number;
-            additionalProperties?: false;
+            preInstalledTime?: string;
+            preInstalledType?: "installer" | "launcher" | "app";
+            preInstalledVersion?: string;
+            additionalProperties?: never;
+        };
+        installerInfo?: {
+            packageSuffix?: string;
+            packageArch?: string;
+            launchId?: string;
+            packageCount?: number;
+            totalSize?: number;
+            additionalProperties?: never;
         };
         emmVendorId?: string;
         isHybridMedia?: boolean;
         originData?: {};
         serviceVersion?: string;
-        additionalProperties?: false;
+        additionalProperties?: never;
     };
     /**
      * Gather identifier details for call diagnostic payload.
@@ -172,6 +216,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         participantId?: string;
         breakoutGroupId?: string;
         breakoutMoveId?: string;
+        breakoutTrackingId?: string;
         breakoutSessionId?: string;
         browserId?: string;
         ciExchangeTokenUrl?: string;
@@ -183,7 +228,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
             imiAppId: string;
             sessionId: string;
             sessionInstanceId: string;
-            additionalProperties?: false;
+            additionalProperties?: never;
         };
         csdmDeviceUrl?: string;
         destinationBreakoutSessionId?: string;
@@ -200,6 +245,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         callId?: string;
         pairCallId?: string;
         llmWebsocketUrl?: string;
+        locusCluster?: string;
         locusId?: string;
         locusJoinUrl?: string;
         locusSessionId?: string;
@@ -217,6 +263,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         msteamsTenantGuid?: string;
         msteamsConferenceId?: string;
         msteamsMeetingId?: string;
+        mtid?: string;
         oauth2ClientId?: string;
         orgId?: string;
         provisionalCorrelationId?: string;
@@ -227,7 +274,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         sipSessionId?: {
             local?: string;
             remote?: string;
-            additionalProperties?: false;
+            additionalProperties?: never;
         };
         sipUri?: string;
         subConfId?: string;
@@ -255,13 +302,14 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         idForEndpointAB?: string;
         customerOrgId?: string;
         correlationId: string;
-        additionalProperties?: false;
+        additionalProperties?: never;
     } | {
         aggregatedBreakoutMoveId?: string;
         attendeeId?: string;
         participantId?: string;
         breakoutGroupId?: string;
         breakoutMoveId?: string;
+        breakoutTrackingId?: string;
         breakoutSessionId?: string;
         browserId?: string;
         ciExchangeTokenUrl?: string;
@@ -273,7 +321,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
             imiAppId: string;
             sessionId: string;
             sessionInstanceId: string;
-            additionalProperties?: false;
+            additionalProperties?: never;
         };
         csdmDeviceUrl?: string;
         destinationBreakoutSessionId?: string;
@@ -290,6 +338,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         callId?: string;
         pairCallId?: string;
         llmWebsocketUrl?: string;
+        locusCluster?: string;
         locusId?: string;
         locusJoinUrl?: string;
         locusSessionId?: string;
@@ -307,6 +356,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         msteamsTenantGuid?: string;
         msteamsConferenceId?: string;
         msteamsMeetingId?: string;
+        mtid?: string;
         oauth2ClientId?: string;
         orgId?: string;
         provisionalCorrelationId?: string;
@@ -317,7 +367,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         sipSessionId?: {
             local?: string;
             remote?: string;
-            additionalProperties?: false;
+            additionalProperties?: never;
         };
         sipUri?: string;
         subConfId?: string;
@@ -345,13 +395,14 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         idForEndpointAB?: string;
         customerOrgId?: string;
         correlationId: string;
-        additionalProperties?: false;
+        additionalProperties?: never;
     } | {
         aggregatedBreakoutMoveId?: string;
         attendeeId?: string;
         participantId?: string;
         breakoutGroupId?: string;
         breakoutMoveId?: string;
+        breakoutTrackingId?: string;
         breakoutSessionId?: string;
         browserId?: string;
         ciExchangeTokenUrl?: string;
@@ -363,7 +414,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
             imiAppId: string;
             sessionId: string;
             sessionInstanceId: string;
-            additionalProperties?: false;
+            additionalProperties?: never;
         };
         csdmDeviceUrl?: string;
         destinationBreakoutSessionId?: string;
@@ -380,6 +431,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         callId?: string;
         pairCallId?: string;
         llmWebsocketUrl?: string;
+        locusCluster?: string;
         locusId?: string;
         locusJoinUrl?: string;
         locusSessionId?: string;
@@ -397,6 +449,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         msteamsTenantGuid?: string;
         msteamsConferenceId?: string;
         msteamsMeetingId?: string;
+        mtid?: string;
         oauth2ClientId?: string;
         orgId?: string;
         provisionalCorrelationId?: string;
@@ -407,7 +460,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         sipSessionId?: {
             local?: string;
             remote?: string;
-            additionalProperties?: false;
+            additionalProperties?: never;
         };
         sipUri?: string;
         subConfId?: string;
@@ -435,7 +488,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/call-diagnostic/config.d.ts

@@ -102,11 +102,13 @@ export declare const ERROR_DESCRIPTIONS: {
     WEBRTC_API_NOT_AVAILABLE: string;
     WDM_RESTRICTED_REGION: string;
     USER_NOT_ALLOWED_JOIN_WEBINAR: string;
+    INVALID_MEETING_INFO: string;
 };
 export declare const SERVICE_ERROR_CODES_TO_CLIENT_ERROR_CODES_MAP: {
     58400: number;
     99002: number;
     99009: number;
+    99019: number;
     58500: number;
     400001: number;
     403004: number;
@@ -134,6 +136,7 @@ export declare const SERVICE_ERROR_CODES_TO_CLIENT_ERROR_CODES_MAP: {
     423001: number;
     423005: number;
     423006: number;
+    423008: number;
     423010: number;
     423012: number;
     423013: number;
@@ -147,6 +150,7 @@ export declare const SERVICE_ERROR_CODES_TO_CLIENT_ERROR_CODES_MAP: {
     403037: number;
     403003: number;
     403030: number;
+    403106: number;
     2403001: number;
     2403002: number;
     2403003: number;

package/dist/types/config.d.ts

@@ -12,6 +12,7 @@ declare namespace _default {
         const batcherMaxCalls: number;
         const batcherMaxWait: number;
         const batcherRetryPlateau: number;
+        const batcherRetryOnNetworkError: boolean;
         const waitForServiceTimeout: number;
     }
     export { metrics_1 as metrics };

package/dist/types/index.d.ts

@@ -4,7 +4,8 @@
 import config from './config';
 import NewMetrics from './new-metrics';
 import * as Utils from './utils';
-import { ClientEvent, ClientEventLeaveReason, SubmitBehavioralEvent, SubmitClientEvent, SubmitInternalEvent, SubmitOperationalEvent, SubmitBusinessEvent, SubmitMQE, PreComputedLatencies, SubmitFeatureEvent } from './metrics.types';
+import * as AutomatedUserUtils from './automated-user';
+import { ClientEvent, ClientEventLeaveReason, SubmitBehavioralEvent, SubmitClientEvent, SubmitInternalEvent, SubmitOperationalEvent, SubmitBusinessEvent, SubmitMQE, PreComputedLatencies, SubmitFeatureEvent, LocusSyncLatencyEventName } from './metrics.types';
 import * as CALL_DIAGNOSTIC_CONFIG from './call-diagnostic/config';
 import * as CallDiagnosticUtils from './call-diagnostic/call-diagnostic-metrics.util';
 import CallDiagnosticMetrics from './call-diagnostic/call-diagnostic-metrics';
@@ -15,5 +16,6 @@ import BusinessMetrics from './business-metrics';
 import RtcMetrics from './rtcMetrics';
 import PreLoginMetrics from './prelogin-metrics';
 export { default, getOSNameInternal } from './metrics';
-export { config, CALL_DIAGNOSTIC_CONFIG, NewMetrics, Utils, CallDiagnosticUtils, CallDiagnosticLatencies, CallDiagnosticMetrics, BehavioralMetrics, OperationalMetrics, BusinessMetrics, RtcMetrics, PreLoginMetrics, };
-export type { ClientEvent, ClientEventLeaveReason, SubmitBehavioralEvent, SubmitClientEvent, SubmitInternalEvent, SubmitMQE, SubmitOperationalEvent, SubmitBusinessEvent, PreComputedLatencies, SubmitFeatureEvent, };
+export { config, CALL_DIAGNOSTIC_CONFIG, AutomatedUserUtils, NewMetrics, Utils, CallDiagnosticUtils, CallDiagnosticLatencies, CallDiagnosticMetrics, BehavioralMetrics, OperationalMetrics, BusinessMetrics, RtcMetrics, PreLoginMetrics, };
+export { isAutomatedUser, isAutomatedUserAgent } from './automated-user';
+export type { ClientEvent, ClientEventLeaveReason, SubmitBehavioralEvent, SubmitClientEvent, SubmitInternalEvent, SubmitMQE, SubmitOperationalEvent, SubmitBusinessEvent, PreComputedLatencies, SubmitFeatureEvent, LocusSyncLatencyEventName, };

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

@@ -41,8 +41,10 @@ export type SubmitMQEOptions = {
     webexConferenceIdStr?: string;
     globalMeetingId?: string;
 };
+export declare const LOCUS_SYNC_LATENCY_EVENT_NAMES: readonly ["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"];
+export type LocusSyncLatencyEventName = (typeof LOCUS_SYNC_LATENCY_EVENT_NAMES)[number];
 export type InternalEvent = {
-    name: 'internal.client.meetinginfo.request' | 'internal.client.meetinginfo.response' | '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';
+    name: 'internal.client.meetinginfo.request' | 'internal.client.meetinginfo.response' | 'internal.register.device.request' | 'internal.register.device.response' | 'internal.reset.join.latencies' | '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' | LocusSyncLatencyEventName;
     payload?: never;
     options?: never;
 };
@@ -154,7 +156,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' | 'internal.client.locus.sync.random.backoff';
 export interface IdType {
     meetingId?: string;
     callId?: string;

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

@@ -78,6 +78,10 @@ declare class Metrics extends WebexPlugin {
      * @returns true once we have the deviceId we need to submit business events
      */
     isReadyToSubmitBusinessEvents(): boolean;
+    /**
+     * @returns whether the current user agent belongs to an automated user
+     */
+    isAutomatedUser(): boolean;
     /**
      * Behavioral event
      * @param args

package/package.json

@@ -24,24 +24,25 @@
     "@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/jest-config-legacy": "0.0.0",
     "@webex/legacy-tools": "0.0.0",
-    "@webex/test-helper-chai": "3.11.0-next.1",
-    "@webex/test-helper-mocha": "3.11.0-next.1",
-    "@webex/test-helper-mock-webex": "3.11.0-next.1",
-    "@webex/test-helper-test-users": "3.11.0-next.1",
+    "@webex/test-helper-chai": "3.12.0-next.5",
+    "@webex/test-helper-mocha": "3.12.0-next.5",
+    "@webex/test-helper-mock-webex": "3.12.0-next.5",
+    "@webex/test-helper-test-users": "3.12.0-next.5",
     "eslint": "^8.24.0",
     "prettier": "^2.7.1",
     "sinon": "^9.2.4"
   },
   "dependencies": {
-    "@webex/common": "3.11.0-next.1",
-    "@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.4",
+    "@webex/common": "3.12.0-next.5",
+    "@webex/common-timers": "3.12.0-next.5",
+    "@webex/event-dictionary-ts": "^1.0.2220",
+    "@webex/test-helper-chai": "3.12.0-next.5",
+    "@webex/test-helper-mock-webex": "3.12.0-next.5",
+    "@webex/webex-core": "3.12.0-next.40",
     "ip-anonymize": "^0.1.0",
+    "isbot": "5.2.1",
     "lodash": "^4.17.21",
     "uuid": "^3.3.2"
   },
@@ -53,5 +54,5 @@
     "test:style": "eslint ./src/**/*.*",
     "test:unit": "webex-legacy-tools test --unit --runner mocha"
   },
-  "version": "3.12.0-next.4"
+  "version": "3.12.0-next.40"
 }

package/src/automated-user.ts

@@ -0,0 +1,16 @@
+import {isBot} from 'isbot';
+
+export const isAutomatedUserAgent = (userAgent?: string | null): boolean => isBot(userAgent);
+
+let automatedUser: boolean | undefined;
+
+export const isAutomatedUser = (): boolean => {
+  if (automatedUser === undefined) {
+    automatedUser =
+      typeof window !== 'undefined' &&
+      typeof navigator !== 'undefined' &&
+      (Boolean(navigator.webdriver) || isAutomatedUserAgent(navigator.userAgent));
+  }
+
+  return automatedUser;
+};

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'
       );