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

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

@@ -9,6 +9,7 @@ import {
   CallDiagnosticMetrics,
   getOSNameInternal,
   CallDiagnosticUtils,
+  AutomatedUserUtils,
   config,
 } from '@webex/internal-plugin-metrics';
 import uuid from 'uuid';
@@ -34,6 +35,7 @@ describe('internal-plugin-metrics', () => {
     var now = new Date();
 
     let cd: CallDiagnosticMetrics;
+    let isAutomatedUserStub: sinon.SinonStub;
 
     const fakeMeeting = {
       id: '1',
@@ -155,6 +157,7 @@ describe('internal-plugin-metrics', () => {
       sinon.useFakeTimers(now.getTime());
       cd = new CallDiagnosticMetrics({}, {parent: webex});
       sinon.stub(uuid, 'v4').returns('my-fake-id');
+      isAutomatedUserStub = sinon.stub(AutomatedUserUtils, 'isAutomatedUser').returns(false);
       cd.setDeviceInfo(webex.internal.device);
     });
 
@@ -868,6 +871,7 @@ describe('internal-plugin-metrics', () => {
             identifiers: {correlationId: 'test-id'},
             name: 'client.alert.displayed',
             isAutomatedUser: false,
+            userActivation: undefined,
           },
           options
         );
@@ -889,6 +893,7 @@ describe('internal-plugin-metrics', () => {
             identifiers: {correlationId: 'test-id'},
             name: 'client.alert.displayed',
             isAutomatedUser: false,
+            userActivation: undefined,
           },
           options
         );
@@ -898,14 +903,8 @@ describe('internal-plugin-metrics', () => {
         assert.isBoolean(res.event.isAutomatedUser, 'isAutomatedUser should be a boolean');
       });
 
-      it('should set isAutomatedUser to true when navigator.webdriver is true', () => {
-        const originalDescriptor = Object.getOwnPropertyDescriptor(global, 'navigator');
-        Object.defineProperty(global, 'navigator', {
-          value: {webdriver: true},
-          configurable: true,
-          writable: true,
-        });
-
+      it('should set isAutomatedUser to true when the user is automated', () => {
+        isAutomatedUserStub.returns(true);
         const prepareDiagnosticEventSpy = sinon.spy(cd, 'prepareDiagnosticEvent');
         sinon.stub(cd, 'getOrigin').returns({origin: 'fake-origin'});
         cd.setMercuryConnectedStatus(true);
@@ -917,15 +916,45 @@ describe('internal-plugin-metrics', () => {
 
         assert.isTrue(
           prepareDiagnosticEventSpy.firstCall.args[0].isAutomatedUser,
-          'isAutomatedUser should be true when navigator.webdriver is set'
+          'isAutomatedUser should be true for an automated user'
         );
+      });
+    });
 
+    describe('#getUserActivation', () => {
+      let originalDescriptor;
+
+      beforeEach(() => {
+        originalDescriptor = Object.getOwnPropertyDescriptor(global, 'navigator');
+      });
+
+      afterEach(() => {
         if (originalDescriptor) {
           Object.defineProperty(global, 'navigator', originalDescriptor);
         } else {
           delete (global as any).navigator;
         }
       });
+
+      it('should return the userActivation state when navigator.userActivation is available', () => {
+        Object.defineProperty(global, 'navigator', {
+          value: {userActivation: {hasBeenActive: true, isActive: false}},
+          configurable: true,
+          writable: true,
+        });
+
+        assert.deepEqual(cd.getUserActivation(), {hasBeenActive: true, isActive: false});
+      });
+
+      it('should return undefined when navigator.userActivation is not available', () => {
+        Object.defineProperty(global, 'navigator', {
+          value: {},
+          configurable: true,
+          writable: true,
+        });
+
+        assert.isUndefined(cd.getUserActivation());
+      });
     });
 
     describe('#submitClientEvent', () => {
@@ -986,6 +1015,7 @@ describe('internal-plugin-metrics', () => {
             webClientPreload: undefined,
             isVipMeeting: false,
             isAutomatedUser: false,
+            userActivation: undefined,
           },
           options
         );
@@ -1017,6 +1047,7 @@ describe('internal-plugin-metrics', () => {
             webClientPreload: undefined,
             isVipMeeting: false,
             isAutomatedUser: false,
+            userActivation: undefined,
           },
           eventId: 'my-fake-id',
           origin: {
@@ -1059,6 +1090,7 @@ describe('internal-plugin-metrics', () => {
               webClientPreload: undefined,
               isVipMeeting: false,
               isAutomatedUser: false,
+              userActivation: undefined,
             },
             eventId: 'my-fake-id',
             origin: {
@@ -1137,6 +1169,7 @@ describe('internal-plugin-metrics', () => {
             webClientPreload: undefined,
             isVipMeeting: false,
             isAutomatedUser: false,
+            userActivation: undefined,
           },
           options
         );
@@ -1168,6 +1201,7 @@ describe('internal-plugin-metrics', () => {
             webClientPreload: undefined,
             isVipMeeting: false,
             isAutomatedUser: false,
+            userActivation: undefined,
           },
           eventId: 'my-fake-id',
           origin: {
@@ -1210,6 +1244,7 @@ describe('internal-plugin-metrics', () => {
               webClientPreload: undefined,
               isVipMeeting: false,
               isAutomatedUser: false,
+              userActivation: undefined,
             },
             eventId: 'my-fake-id',
             origin: {
@@ -1289,6 +1324,7 @@ describe('internal-plugin-metrics', () => {
             webClientPreload: undefined,
             isVipMeeting: false,
             isAutomatedUser: false,
+            userActivation: undefined,
           },
           options
         );
@@ -1321,6 +1357,7 @@ describe('internal-plugin-metrics', () => {
             webClientPreload: undefined,
             isVipMeeting: false,
             isAutomatedUser: false,
+            userActivation: undefined,
           },
           eventId: 'my-fake-id',
           origin: {
@@ -1364,6 +1401,7 @@ describe('internal-plugin-metrics', () => {
               webClientPreload: undefined,
               isVipMeeting: false,
               isAutomatedUser: false,
+              userActivation: undefined,
             },
             eventId: 'my-fake-id',
             origin: {
@@ -1442,6 +1480,7 @@ describe('internal-plugin-metrics', () => {
             webexSubServiceType: undefined,
             isVipMeeting: false,
             isAutomatedUser: false,
+            userActivation: undefined,
           },
           options
         );
@@ -1474,6 +1513,7 @@ describe('internal-plugin-metrics', () => {
             webexSubServiceType: undefined,
             isVipMeeting: false,
             isAutomatedUser: false,
+            userActivation: undefined,
           },
           eventId: 'my-fake-id',
           origin: {
@@ -1517,6 +1557,7 @@ describe('internal-plugin-metrics', () => {
               webexSubServiceType: undefined,
               isVipMeeting: false,
               isAutomatedUser: false,
+              userActivation: undefined,
             },
             eventId: 'my-fake-id',
             origin: {
@@ -1597,6 +1638,7 @@ describe('internal-plugin-metrics', () => {
             webClientPreload: undefined,
             isVipMeeting: false,
             isAutomatedUser: false,
+            userActivation: undefined,
           },
           options
         );
@@ -1631,6 +1673,7 @@ describe('internal-plugin-metrics', () => {
             webClientPreload: undefined,
             isVipMeeting: false,
             isAutomatedUser: false,
+            userActivation: undefined,
           },
           eventId: 'my-fake-id',
           origin: {
@@ -1676,6 +1719,7 @@ describe('internal-plugin-metrics', () => {
               webClientPreload: undefined,
               isVipMeeting: false,
               isAutomatedUser: false,
+              userActivation: undefined,
             },
             eventId: 'my-fake-id',
             origin: {
@@ -1804,6 +1848,7 @@ describe('internal-plugin-metrics', () => {
             name: 'client.alert.displayed',
             webClientPreload: undefined,
             isAutomatedUser: false,
+            userActivation: undefined,
           },
           options
         );
@@ -1829,6 +1874,7 @@ describe('internal-plugin-metrics', () => {
             name: 'client.alert.displayed',
             webClientPreload: undefined,
             isAutomatedUser: false,
+            userActivation: undefined,
           },
           eventId: 'my-fake-id',
           origin: {
@@ -1906,6 +1952,7 @@ describe('internal-plugin-metrics', () => {
             name: 'client.alert.displayed',
             webClientPreload: undefined,
             isAutomatedUser: false,
+            userActivation: undefined,
           },
           options
         );
@@ -1936,6 +1983,7 @@ describe('internal-plugin-metrics', () => {
               telemetryOptOut: undefined,
               webClientPreload: undefined,
               isAutomatedUser: false,
+              userActivation: undefined,
             },
           },
           options.preLoginId
@@ -2001,6 +2049,7 @@ describe('internal-plugin-metrics', () => {
             name: 'client.alert.displayed',
             webClientPreload: undefined,
             isAutomatedUser: false,
+            userActivation: undefined,
           },
           options
         );
@@ -2033,6 +2082,7 @@ describe('internal-plugin-metrics', () => {
               emailInput: 'current',
               webClientPreload: undefined,
               isAutomatedUser: false,
+              userActivation: undefined,
             },
           },
           options.preLoginId
@@ -2081,6 +2131,7 @@ describe('internal-plugin-metrics', () => {
             webClientPreload: undefined,
             isVipMeeting: false,
             isAutomatedUser: false,
+            userActivation: undefined,
           },
           eventId: 'my-fake-id',
           origin: {
@@ -2139,6 +2190,7 @@ describe('internal-plugin-metrics', () => {
             webClientPreload: undefined,
             isVipMeeting: false,
             isAutomatedUser: false,
+            userActivation: undefined,
           },
           eventId: 'my-fake-id',
           origin: {
@@ -2197,6 +2249,7 @@ describe('internal-plugin-metrics', () => {
             name: 'client.alert.displayed',
             webClientPreload: true,
             isAutomatedUser: false,
+            userActivation: undefined,
           },
           options
         );
@@ -2222,6 +2275,7 @@ describe('internal-plugin-metrics', () => {
             name: 'client.alert.displayed',
             webClientPreload: true,
             isAutomatedUser: false,
+            userActivation: undefined,
           },
           eventId: 'my-fake-id',
           origin: {
@@ -2293,6 +2347,7 @@ describe('internal-plugin-metrics', () => {
             webClientPreload: undefined,
             isVipMeeting: false,
             isAutomatedUser: false,
+            userActivation: undefined,
           },
           options
         );
@@ -2325,6 +2380,7 @@ describe('internal-plugin-metrics', () => {
             webClientPreload: undefined,
             isVipMeeting: false,
             isAutomatedUser: false,
+            userActivation: undefined,
           },
           eventId: 'my-fake-id',
           origin: {
@@ -2396,6 +2452,7 @@ describe('internal-plugin-metrics', () => {
             webClientPreload: undefined,
             isVipMeeting: true,
             isAutomatedUser: false,
+            userActivation: undefined,
           },
           options
         );
@@ -2428,6 +2485,7 @@ describe('internal-plugin-metrics', () => {
             webClientPreload: undefined,
             isVipMeeting: true,
             isAutomatedUser: false,
+            userActivation: undefined,
           },
           eventId: 'my-fake-id',
           origin: {
@@ -2505,6 +2563,7 @@ describe('internal-plugin-metrics', () => {
             webClientPreload: undefined,
             isVipMeeting: false,
             isAutomatedUser: false,
+            userActivation: undefined,
           },
           eventId: 'my-fake-id',
           origin: {
@@ -2590,6 +2649,7 @@ describe('internal-plugin-metrics', () => {
             webClientPreload: undefined,
             isVipMeeting: false,
             isAutomatedUser: false,
+            userActivation: undefined,
           },
           eventId: 'my-fake-id',
           origin: {
@@ -2665,6 +2725,7 @@ describe('internal-plugin-metrics', () => {
             name: 'client.alert.displayed',
             webClientPreload: undefined,
             isAutomatedUser: false,
+            userActivation: undefined,
           },
           eventId: 'my-fake-id',
           origin: {
@@ -2742,6 +2803,7 @@ describe('internal-plugin-metrics', () => {
             name: 'client.alert.displayed',
             webClientPreload: undefined,
             isAutomatedUser: false,
+            userActivation: undefined,
           },
           eventId: 'my-fake-id',
           origin: {
@@ -2830,6 +2892,7 @@ describe('internal-plugin-metrics', () => {
             webClientPreload: undefined,
             isVipMeeting: false,
             isAutomatedUser: false,
+            userActivation: undefined,
           },
           eventId: 'my-fake-id',
           origin: {
@@ -3122,7 +3185,6 @@ describe('internal-plugin-metrics', () => {
         assert.calledWith(requestStub, {
           eventPayload: {event: 'test'},
           type: ['diagnostic-event'],
-          markTelemetryOptOutOnResponse: true,
         });
       });
     });
@@ -4252,6 +4314,7 @@ describe('internal-plugin-metrics', () => {
                     webClientPreload: undefined,
                     isVipMeeting: false,
                     isAutomatedUser: false,
+                    userActivation: undefined,
                   },
                   eventId: 'my-fake-id',
                   origin: {
@@ -4422,7 +4485,6 @@ describe('internal-plugin-metrics', () => {
         assert.calledWith(requestStub, {
           eventPayload: {event: 'test'},
           type: ['diagnostic-event'],
-          markTelemetryOptOutOnResponse: true,
         });
       });
     });
@@ -4661,6 +4723,7 @@ describe('internal-plugin-metrics', () => {
             webClientPreload: undefined,
             isVipMeeting: false,
             isAutomatedUser: false,
+            userActivation: undefined,
             meetingSummaryInfo: {
               featureName: 'syncSystemMuteStatus',
               featureActions: [
@@ -4705,6 +4768,7 @@ describe('internal-plugin-metrics', () => {
             webClientPreload: undefined,
             isVipMeeting: false,
             isAutomatedUser: false,
+            userActivation: undefined,
             meetingSummaryInfo: {
               featureName: 'syncSystemMuteStatus',
               featureActions: [

package/test/unit/spec/new-metrics.ts

@@ -1,8 +1,12 @@
 import {assert} from '@webex/test-helper-chai';
-import {NewMetrics, CallDiagnosticLatencies} from '@webex/internal-plugin-metrics';
+import {
+  NewMetrics,
+  CallDiagnosticLatencies,
+  AutomatedUserUtils,
+  Utils,
+} from '@webex/internal-plugin-metrics';
 import MockWebex from '@webex/test-helper-mock-webex';
 import sinon from 'sinon';
-import {Utils} from '@webex/internal-plugin-metrics';
 
 describe('internal-plugin-metrics', () => {
 
@@ -110,6 +114,13 @@ describe('internal-plugin-metrics', () => {
       assert.isDefined(webex.internal.newMetrics.businessMetrics);
     })
 
+    it('returns the automated user classification', () => {
+      assert.strictEqual(
+        webex.internal.newMetrics.isAutomatedUser(),
+        AutomatedUserUtils.isAutomatedUser()
+      );
+    });
+
     it('passes the table through to the business metrics', () => {
       assert.isUndefined(webex.internal.newMetrics.businessMetrics)
       webex.internal.newMetrics.isReadyToSubmitBusinessEvents();

package/test/unit/spec/prelogin-metrics-batcher.ts

@@ -94,7 +94,6 @@ describe('internal-plugin-metrics', () => {
           },
         });
         assert.deepEqual(webexRequestArgs.body.metrics[0].type, ['diagnostic-event']);
-        assert.equal(webexRequestArgs.body.metrics[0].markTelemetryOptOutOnResponse, true);
         assert.lengthOf(
           webex.internal.newMetrics.callDiagnosticMetrics.preLoginMetricsBatcher.queue,
           0
@@ -314,7 +313,7 @@ describe('internal-plugin-metrics', () => {
     });
 
     describe('#submitHttpRequest', () => {
-      it('calls webex.request with the correct parameters and then it calls handleHttpResponseStatus on success', async () => {
+      it('calls webex.request with the correct parameters', async () => {
         const payload = [
           {
             eventPayload: {event: 'my.event'},
@@ -327,18 +326,11 @@ describe('internal-plugin-metrics', () => {
         );
         webex.request = sinon.stub().resolves({statusCode: 200});
 
-        const handleHttpResponseStatusSpy = sinon.spy(
-          webex.internal.newMetrics.callDiagnosticMetrics.preLoginMetricsBatcher,
-          'handleHttpResponseStatus'
-        );
-
         const promise =
           webex.internal.newMetrics.callDiagnosticMetrics.preLoginMetricsBatcher.submitHttpRequest(
             payload
           );
 
-        assert.deepEqual(handleHttpResponseStatusSpy.getCalls().length, 0);
-
         await flushPromises();
 
         clock.tick(config.metrics.batcherWait);
@@ -361,117 +353,6 @@ describe('internal-plugin-metrics', () => {
           service: 'metrics',
           waitForServiceTimeout: 30,
         });
-
-        assert.deepEqual(handleHttpResponseStatusSpy.getCalls().length, 1);
-
-        assert.deepEqual(handleHttpResponseStatusSpy.args[0][0], 200);
-        assert.deepEqual(handleHttpResponseStatusSpy.args[0][1], payload);
-      });
-
-      it('it calls handleHttpResponseStatus on failure', async () => {
-        const payload = [
-          {
-            eventPayload: {event: 'my.event'},
-            type: ['diagnostic-event'],
-          },
-        ];
-
-        webex.internal.newMetrics.callDiagnosticMetrics.preLoginMetricsBatcher.savePreLoginId(
-          preLoginId
-        );
-        webex.request = sinon.stub().rejects({statusCode: 503});
-
-        const handleHttpResponseStatusSpy = sinon.spy(
-          webex.internal.newMetrics.callDiagnosticMetrics.preLoginMetricsBatcher,
-          'handleHttpResponseStatus'
-        );
-
-        const promise =
-          webex.internal.newMetrics.callDiagnosticMetrics.preLoginMetricsBatcher.submitHttpRequest(
-            payload
-          );
-
-        assert.deepEqual(handleHttpResponseStatusSpy.getCalls().length, 0);
-
-        await flushPromises();
-
-        clock.tick(config.metrics.batcherWait);
-
-        let error;
-
-        try {
-          await promise;
-        } catch (err) {
-          error = err;
-        }
-
-        assert.deepEqual(error.statusCode, 503);
-
-        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 shouldMark is true and statusCode is ${statusCode}`, () => {
-          webex.internal.newMetrics.callDiagnosticMetrics.preLoginMetricsBatcher.handleHttpResponseStatus(
-            statusCode,
-            [{markTelemetryOptOutOnResponse: true}]
-          );
-
-          assert.notCalled(setIsTelemetryOptOutAutomaticStub);
-        });
-      });
-
-      it('calls setIsTelemetryOptOutAutomatic(true) when statusCode is 200 and markTelemetryOptOutOnResponse is true', () => {
-        webex.internal.newMetrics.callDiagnosticMetrics.preLoginMetricsBatcher.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.preLoginMetricsBatcher.handleHttpResponseStatus(
-            statusCode,
-            [{markTelemetryOptOutOnResponse: false}]
-          );
-
-          assert.notCalled(setIsTelemetryOptOutAutomaticStub);
-        });
-      });
-
-      it('does not call setIsTelemetryOptOutAutomatic when payload is empty', () => {
-        webex.internal.newMetrics.callDiagnosticMetrics.preLoginMetricsBatcher.handleHttpResponseStatus(
-          200,
-          []
-        );
-
-        assert.notCalled(setIsTelemetryOptOutAutomaticStub);
-      });
-
-      it('does not call setIsTelemetryOptOutAutomatic when payload is not an array', () => {
-        webex.internal.newMetrics.callDiagnosticMetrics.preLoginMetricsBatcher.handleHttpResponseStatus(
-          200,
-          null
-        );
-
-        assert.notCalled(setIsTelemetryOptOutAutomaticStub);
       });
     });
   });