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

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[] = [];
@@ -126,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});
@@ -147,6 +151,27 @@ 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
@@ -251,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}`;
 
@@ -296,12 +321,12 @@ 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',
@@ -464,7 +489,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,
     };
 
@@ -1046,8 +1071,8 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
       // @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
+      isAutomatedUser: AutomatedUserUtils.isAutomatedUser(),
+      userActivation: this.getUserActivation(),
     };
 
     const joinFlowVersion = options.joinFlowVersion ?? meeting.callStateForMetrics?.joinFlowVersion;
@@ -1170,8 +1195,8 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
       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
+      isAutomatedUser: AutomatedUserUtils.isAutomatedUser(),
+      userActivation: this.getUserActivation(),
     };
 
     if (options.joinFlowVersion) {
@@ -1364,7 +1389,6 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
     const finalEvent = {
       eventPayload: event,
       type: ['diagnostic-event'],
-      markTelemetryOptOutOnResponse: true,
     };
 
     return this.callDiagnosticEventsBatcher.request(finalEvent);
@@ -1374,7 +1398,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> => {
@@ -1382,7 +1405,6 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
     const finalEvent = {
       eventPayload: event,
       type: ['diagnostic-event'],
-      markTelemetryOptOutOnResponse: true,
     };
 
     this.preLoginMetricsBatcher.savePreLoginId(preLoginId);
@@ -1432,7 +1454,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/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,7 @@ import {
   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';
@@ -43,6 +45,7 @@ export {default, getOSNameInternal} from './metrics';
 export {
   config,
   CALL_DIAGNOSTIC_CONFIG,
+  AutomatedUserUtils,
   NewMetrics,
   Utils,
   CallDiagnosticUtils,
@@ -54,6 +57,7 @@ export {
   RtcMetrics,
   PreLoginMetrics,
 };
+export {isAutomatedUser, isAutomatedUserAgent} from './automated-user';
 export type {
   ClientEvent,
   ClientEventLeaveReason,
@@ -65,4 +69,5 @@ export type {
   SubmitBusinessEvent,
   PreComputedLatencies,
   SubmitFeatureEvent,
+  LocusSyncLatencyEventName,
 };

package/src/metrics.types.ts

@@ -149,6 +149,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'
@@ -162,7 +173,8 @@ export type InternalEvent = {
     | '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;
@@ -324,7 +336,8 @@ export type PreComputedLatencies =
   | '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;

package/src/new-metrics.ts

@@ -30,6 +30,7 @@ import {
 import CallDiagnosticLatencies from './call-diagnostic/call-diagnostic-metrics-latencies';
 import {setMetricTimings} from './call-diagnostic/call-diagnostic-metrics.util';
 import {generateCommonErrorMetadata} from './utils';
+import {isAutomatedUser as detectAutomatedUser} from './automated-user';
 
 /**
  * Metrics plugin to centralize all types of metrics.
@@ -79,6 +80,8 @@ class Metrics extends WebexPlugin {
 
     // @ts-ignore
     this.callDiagnosticLatencies = new CallDiagnosticLatencies({}, {parent: this.webex});
+    // @ts-ignore
+    this.callDiagnosticMetrics = new CallDiagnosticMetrics({}, {parent: this.webex});
     this.onReady();
   }
 
@@ -88,8 +91,6 @@ class Metrics extends WebexPlugin {
   private onReady() {
     // @ts-ignore
     this.webex.once('ready', () => {
-      // @ts-ignore
-      this.callDiagnosticMetrics = new CallDiagnosticMetrics({}, {parent: this.webex});
       this.preLoginMetrics = new PreLoginMetrics(
         // @ts-ignore
         new PreLoginMetricsBatcher({}, {parent: this.webex}),
@@ -182,6 +183,13 @@ class Metrics extends WebexPlugin {
     return this.businessMetrics?.isReadyToSubmitEvents() ?? false;
   }
 
+  /**
+   * @returns whether the current user agent belongs to an automated user
+   */
+  isAutomatedUser() {
+    return detectAutomatedUser();
+  }
+
   /**
    * Behavioral event
    * @param args
@@ -325,7 +333,7 @@ class Metrics extends WebexPlugin {
     payload?: RecursivePartial<FeatureEvent['payload']>;
     options: any;
   }) {
-    if (!this.callDiagnosticLatencies || !this.callDiagnosticMetrics) {
+    if (!this.isReady) {
       // @ts-ignore
       this.webex.logger.log(
         `NewMetrics: @submitFeatureEvent. Attempted to submit before webex.ready. Event name: ${name}`
@@ -360,7 +368,7 @@ class Metrics extends WebexPlugin {
     payload?: RecursivePartial<ClientEvent['payload']>;
     options?: SubmitClientEventOptions;
   }): Promise<any> {
-    if (!this.callDiagnosticLatencies || !this.callDiagnosticMetrics) {
+    if (!this.isReady) {
       // @ts-ignore
       this.webex.logger.log(
         `NewMetrics: @submitClientEvent. Attempted to submit before webex.ready. Event name: ${name}`

package/src/prelogin-metrics-batcher.ts

@@ -78,8 +78,6 @@ const PreLoginMetricsBatcher = Batcher.extend({
           `PreLoginMetricsBatcher: @submitHttpRequest#${batchId}. Request successful.`
         );
 
-        this.handleHttpResponseStatus(res?.statusCode, payload);
-
         return res;
       })
       .catch((err) => {
@@ -89,33 +87,9 @@ const PreLoginMetricsBatcher = Batcher.extend({
           `error: ${generateCommonErrorMetadata(err)}`
         );
 
-        this.handleHttpResponseStatus(err?.statusCode, payload);
-
         return Promise.reject(err);
       });
   },
-
-  /**
-   * React to the HTTP status code returned by the prelogin 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 PreLoginMetricsBatcher;

package/test/unit/spec/automated-user.ts

@@ -0,0 +1,43 @@
+import {assert} from '@webex/test-helper-chai';
+
+import {isAutomatedUser, isAutomatedUserAgent} from '../../../src/automated-user';
+
+describe('automated user detection', () => {
+  [
+    {userAgent: 'SkypeUriPreview', expected: true},
+    {userAgent: 'skypeuripreview', expected: true},
+    {userAgent: 'Mozilla/5.0 (compatible; SkypeUriPreview/0.1)', expected: true},
+    {userAgent: 'Googlebot/2.1 (+http://www.google.com/bot.html)', expected: true},
+    {
+      userAgent:
+        'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 Chrome/126.0.0.0 Safari/537.36',
+      expected: false,
+    },
+    {userAgent: undefined, expected: false},
+  ].forEach(({userAgent, expected}) => {
+    it(`returns ${expected} for ${userAgent || 'an undefined user agent'}`, () => {
+      assert.equal(isAutomatedUserAgent(userAgent), expected);
+    });
+  });
+
+  it('returns the cached classification when navigator changes', () => {
+    const cachedResult = isAutomatedUser();
+    const originalDescriptor = Object.getOwnPropertyDescriptor(global, 'navigator');
+
+    Object.defineProperty(global, 'navigator', {
+      value: cachedResult
+        ? {userAgent: 'Mozilla/5.0', webdriver: false}
+        : {userAgent: 'SkypeUriPreview', webdriver: true},
+      configurable: true,
+      writable: true,
+    });
+
+    assert.equal(isAutomatedUser(), cachedResult);
+
+    if (originalDescriptor) {
+      Object.defineProperty(global, 'navigator', originalDescriptor);
+    } else {
+      delete (global as any).navigator;
+    }
+  });
+});

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

@@ -516,141 +516,5 @@ describe('plugin-metrics', () => {
         assert.deepEqual(prepareDiagnosticMetricItemCalls[0].args[1].type, ['diagnostic-event']);
       });
     });
-
-    describe('#submitHttpRequest', () => {
-      it('calls handleHttpResponseStatus with response status on success', async () => {
-        const payload = [
-          {
-            eventPayload: {event: 'my.event'},
-            type: ['diagnostic-event'],
-          },
-        ];
-
-        webex.request = sinon.stub().resolves({statusCode: 200});
-
-        const handleHttpResponseStatusSpy = sinon.spy(
-          webex.internal.newMetrics.callDiagnosticMetrics.callDiagnosticEventsBatcher,
-          'handleHttpResponseStatus'
-        );
-
-        const promise =
-          webex.internal.newMetrics.callDiagnosticMetrics.callDiagnosticEventsBatcher.submitHttpRequest(
-            payload
-          );
-
-        assert.deepEqual(handleHttpResponseStatusSpy.getCalls().length, 0);
-
-        await flushPromises();
-        clock.tick(config.metrics.batcherWait);
-
-        await promise;
-
-        assert.calledOnce(webex.request);
-        assert.deepEqual(handleHttpResponseStatusSpy.getCalls().length, 1);
-        assert.deepEqual(handleHttpResponseStatusSpy.args[0][0], 200);
-        assert.deepEqual(handleHttpResponseStatusSpy.args[0][1], payload);
-      });
-
-      it('calls handleHttpResponseStatus with error status on failure', async () => {
-        const payload = [
-          {
-            eventPayload: {event: 'my.event'},
-            type: ['diagnostic-event'],
-          },
-        ];
-
-        webex.request = sinon.stub().rejects({statusCode: 503});
-
-        const handleHttpResponseStatusSpy = sinon.spy(
-          webex.internal.newMetrics.callDiagnosticMetrics.callDiagnosticEventsBatcher,
-          'handleHttpResponseStatus'
-        );
-
-        const promise =
-          webex.internal.newMetrics.callDiagnosticMetrics.callDiagnosticEventsBatcher.submitHttpRequest(
-            payload
-          );
-
-        assert.deepEqual(handleHttpResponseStatusSpy.getCalls().length, 0);
-
-        await flushPromises();
-        clock.tick(config.metrics.batcherWait);
-
-        let error: any;
-
-        try {
-          await promise;
-        } catch (err) {
-          error = err;
-        }
-
-        assert.deepEqual(error.statusCode, 503);
-        assert.calledOnce(webex.request);
-        assert.deepEqual(handleHttpResponseStatusSpy.getCalls().length, 1);
-        assert.deepEqual(handleHttpResponseStatusSpy.args[0][0], 503);
-        assert.deepEqual(handleHttpResponseStatusSpy.args[0][1], payload);
-      });
-    });
-
-    describe('#handleHttpResponseStatus', () => {
-      let setIsTelemetryOptOutAutomaticStub;
-
-      beforeEach(() => {
-        setIsTelemetryOptOutAutomaticStub = sinon.stub(
-          webex.internal.newMetrics.callDiagnosticMetrics,
-          'setIsTelemetryOptOutAutomatic'
-        );
-      });
-
-      [201, 400, 503, undefined].forEach((statusCode) => {
-        it(`does not call setIsTelemetryOptOutAutomatic() when statusCode is ${statusCode} and markTelemetryOptOutOnResponse is true`, () => {
-          webex.internal.newMetrics.callDiagnosticMetrics.callDiagnosticEventsBatcher.handleHttpResponseStatus(
-            statusCode,
-            [{markTelemetryOptOutOnResponse: true}]
-          );
-
-          assert.notCalled(setIsTelemetryOptOutAutomaticStub);
-        });
-      });
-
-      it('calls setIsTelemetryOptOutAutomatic(true) when statusCode is 200 and markTelemetryOptOutOnResponse is true', () => {
-        webex.internal.newMetrics.callDiagnosticMetrics.callDiagnosticEventsBatcher.handleHttpResponseStatus(
-          200,
-          [{markTelemetryOptOutOnResponse: true}]
-        );
-
-        assert.calledOnce(setIsTelemetryOptOutAutomaticStub);
-        assert.calledWithExactly(setIsTelemetryOptOutAutomaticStub, true);
-      });
-
-      [200, 201, 400, 503, undefined].forEach((statusCode) => {
-        it(`does not call setIsTelemetryOptOutAutomatic when shouldMark is false (statusCode: ${statusCode})`, () => {
-          webex.internal.newMetrics.callDiagnosticMetrics.callDiagnosticEventsBatcher.handleHttpResponseStatus(
-            statusCode,
-            [{markTelemetryOptOutOnResponse: false}]
-          );
-
-          assert.notCalled(setIsTelemetryOptOutAutomaticStub);
-        });
-      });
-
-      it('does not call setIsTelemetryOptOutAutomatic when payload is empty', () => {
-        webex.internal.newMetrics.callDiagnosticMetrics.callDiagnosticEventsBatcher.handleHttpResponseStatus(
-          200,
-          []
-        );
-
-        assert.notCalled(setIsTelemetryOptOutAutomaticStub);
-      });
-
-      it('does not call setIsTelemetryOptOutAutomatic when payload is not an array', () => {
-        webex.internal.newMetrics.callDiagnosticMetrics.callDiagnosticEventsBatcher.handleHttpResponseStatus(
-          200,
-          null
-        );
-
-        assert.notCalled(setIsTelemetryOptOutAutomaticStub);
-      });
-    });
   });
 });