@webex/internal-plugin-metrics 3.12.0-next.30 → 3.12.0-next.32

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

@@ -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,9 +139,17 @@ 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;
+            /**
+             * Sets the manual telemetry opt-out status for the current user
+             * @param value - boolean value indicating manual telemetry opt-out status
+             */
             prefetchDocShowUsed?: boolean;
             fastJoinUsed?: boolean;
             clientDownloadSize?: number;
@@ -177,6 +193,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 +218,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         participantId?: string;
         breakoutGroupId?: string;
         breakoutMoveId?: string;
+        breakoutTrackingId?: string;
         breakoutSessionId?: string;
         browserId?: string;
         ciExchangeTokenUrl?: string;
@@ -240,6 +265,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         msteamsTenantGuid?: string;
         msteamsConferenceId?: string;
         msteamsMeetingId?: string;
+        mtid?: string;
         oauth2ClientId?: string;
         orgId?: string;
         provisionalCorrelationId?: string;
@@ -285,6 +311,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         participantId?: string;
         breakoutGroupId?: string;
         breakoutMoveId?: string;
+        breakoutTrackingId?: string;
         breakoutSessionId?: string;
         browserId?: string;
         ciExchangeTokenUrl?: string;
@@ -331,6 +358,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         msteamsTenantGuid?: string;
         msteamsConferenceId?: string;
         msteamsMeetingId?: string;
+        mtid?: string;
         oauth2ClientId?: string;
         orgId?: string;
         provisionalCorrelationId?: string;
@@ -376,6 +404,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         participantId?: string;
         breakoutGroupId?: string;
         breakoutMoveId?: string;
+        breakoutTrackingId?: string;
         breakoutSessionId?: string;
         browserId?: string;
         ciExchangeTokenUrl?: string;
@@ -422,6 +451,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         msteamsTenantGuid?: string;
         msteamsConferenceId?: string;
         msteamsMeetingId?: string;
+        mtid?: string;
         oauth2ClientId?: string;
         orgId?: string;
         provisionalCorrelationId?: string;
@@ -631,7 +661,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/package.json

@@ -37,10 +37,10 @@
   "dependencies": {
     "@webex/common": "3.12.0-next.5",
     "@webex/common-timers": "3.12.0-next.5",
-    "@webex/event-dictionary-ts": "^1.0.2191",
+    "@webex/event-dictionary-ts": "^1.0.2215",
     "@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.30",
+    "@webex/webex-core": "3.12.0-next.32",
     "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-next.30"
+  "version": "3.12.0-next.32"
 }

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;

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

@@ -147,6 +147,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
@@ -1048,6 +1069,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
       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
+      userActivation: this.getUserActivation(),
     };
 
     const joinFlowVersion = options.joinFlowVersion ?? meeting.callStateForMetrics?.joinFlowVersion;
@@ -1172,6 +1194,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
       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
+      userActivation: this.getUserActivation(),
     };
 
     if (options.joinFlowVersion) {
@@ -1364,7 +1387,6 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
     const finalEvent = {
       eventPayload: event,
       type: ['diagnostic-event'],
-      markTelemetryOptOutOnResponse: true,
     };
 
     return this.callDiagnosticEventsBatcher.request(finalEvent);
@@ -1374,7 +1396,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 +1403,6 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
     const finalEvent = {
       eventPayload: event,
       type: ['diagnostic-event'],
-      markTelemetryOptOutOnResponse: true,
     };
 
     this.preLoginMetricsBatcher.savePreLoginId(preLoginId);

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/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);
-      });
-    });
   });
 });