@webex/internal-plugin-metrics 3.12.0-webex-services-ready.2 → 3.12.0-webex-services-ready.4

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;
@@ -55,6 +55,14 @@ 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
@@ -131,6 +139,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;
@@ -177,6 +189,14 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
             preInstalledVersion?: string;
             additionalProperties?: never;
         };
+        installerInfo?: {
+            packageSuffix?: string;
+            packageArch?: string;
+            launchId?: string;
+            packageCount?: number;
+            totalSize?: number;
+            additionalProperties?: never;
+        };
         emmVendorId?: string;
         isHybridMedia?: boolean;
         originData?: {};
@@ -194,6 +214,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         participantId?: string;
         breakoutGroupId?: string;
         breakoutMoveId?: string;
+        breakoutTrackingId?: string;
         breakoutSessionId?: string;
         browserId?: string;
         ciExchangeTokenUrl?: string;
@@ -240,6 +261,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         msteamsTenantGuid?: string;
         msteamsConferenceId?: string;
         msteamsMeetingId?: string;
+        mtid?: string;
         oauth2ClientId?: string;
         orgId?: string;
         provisionalCorrelationId?: string;
@@ -285,6 +307,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         participantId?: string;
         breakoutGroupId?: string;
         breakoutMoveId?: string;
+        breakoutTrackingId?: string;
         breakoutSessionId?: string;
         browserId?: string;
         ciExchangeTokenUrl?: string;
@@ -331,6 +354,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         msteamsTenantGuid?: string;
         msteamsConferenceId?: string;
         msteamsMeetingId?: string;
+        mtid?: string;
         oauth2ClientId?: string;
         orgId?: string;
         provisionalCorrelationId?: string;
@@ -376,6 +400,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         participantId?: string;
         breakoutGroupId?: string;
         breakoutMoveId?: string;
+        breakoutTrackingId?: string;
         breakoutSessionId?: string;
         browserId?: string;
         ciExchangeTokenUrl?: string;
@@ -422,6 +447,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         msteamsTenantGuid?: string;
         msteamsConferenceId?: string;
         msteamsMeetingId?: string;
+        mtid?: string;
         oauth2ClientId?: string;
         orgId?: string;
         provisionalCorrelationId?: string;
@@ -631,7 +657,6 @@ 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>;

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

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/call-diagnostic/call-diagnostic-metrics-batcher.ts

@@ -55,8 +55,6 @@ const CallDiagnosticEventsBatcher = Batcher.extend({
           `CallDiagnosticEventsBatcher: @submitHttpRequest#${batchId}. Request successful.`
         );
 
-        this.handleHttpResponseStatus(res?.statusCode, payload);
-
         return res;
       })
       .catch((err) => {
@@ -66,33 +64,9 @@ 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;