@webex/internal-plugin-metrics 3.11.0 → 3.12.0-auth-prejoin-fetch.1

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

@@ -27,6 +27,7 @@ const {
   isUnauthorizedError,
   generateClientErrorCodeForIceFailure,
   isSdpOfferCreationError,
+  isWebrtcApiNotAvailableError,
 } = CallDiagnosticUtils;
 
 describe('internal-plugin-metrics', () => {
@@ -206,6 +207,29 @@ describe('internal-plugin-metrics', () => {
     });
   });
 
+  describe('isWebrtcApiNotAvailableError', () => {
+    type TestWebrtcApiNotAvailableError = {
+      code: number;
+      message: string;
+      name: string;
+    };
+
+    const error: TestWebrtcApiNotAvailableError = {
+      code: 30007,
+      name: 'WebrtcApiNotAvailableError',
+      message: 'RTCPeerConnection API is not available in this environment',
+    };
+
+    [
+      ['WebrtcApiNotAvailableError', error, true],
+      ['generic error', new Error('this is an error'), false],
+    ].forEach(([errorType, rawError, expected]) => {
+      it(`for ${errorType} rawError returns the correct result`, () => {
+        assert.strictEqual(isWebrtcApiNotAvailableError(rawError), expected);
+      });
+    });
+  });
+
   describe('isBrowserMediaErrorName', () => {
     [
       ['PermissionDeniedError', true],
@@ -287,7 +311,7 @@ describe('internal-plugin-metrics', () => {
           origin: {
             buildType: 'prod',
             networkType: 'unknown',
-            upgradeChannel: expectedUpgradeChannel
+            upgradeChannel: expectedUpgradeChannel,
           },
           event: {name: eventName, ...expectedEvent},
         },
@@ -369,7 +393,7 @@ describe('internal-plugin-metrics', () => {
             totalJmt: undefined,
             clientJmt: undefined,
             downloadTime: undefined,
-            clickToInterstitialWithUserDelay:   undefined,
+            clickToInterstitialWithUserDelay: undefined,
             totalJMTWithUserDelay: undefined,
           },
         },
@@ -406,7 +430,6 @@ describe('internal-plugin-metrics', () => {
             totalMediaJMT: undefined,
             interstitialToMediaOKJMT: undefined,
             callInitMediaEngineReady: undefined,
-            stayLobbyTime: undefined,
             totalMediaJMTWithUserDelay: undefined,
             totalJMTWithUserDelay: undefined,
           },
@@ -423,12 +446,47 @@ describe('internal-plugin-metrics', () => {
           },
         },
       ],
+      [
+        'client.lobby.exited',
+        {
+          joinTimes: {
+            stayLobbyTime: undefined,
+          },
+        },
+      ],
     ].forEach(([eventName, expectedEvent]) => {
       it(`returns expected result for ${eventName}`, () => {
         check(eventName as string, expectedEvent, 'gold');
       });
     });
 
+    it('logs a Milestone entry when event name is present', () => {
+      const logSpy = sinon.spy(webex.logger, 'log');
+      const eventName = 'client.call.initiated';
+      const eventPayload = {event: {name: eventName}};
+
+      prepareDiagnosticMetricItem(webex, {eventPayload, type: ['diagnostic-event']});
+
+      assert.isTrue(
+        logSpy.calledWith('Milestone,CallDiagnostic', eventName),
+        'expected logger.log to be called with Milestone,CallDiagnostic and the event name'
+      );
+      sinon.restore();
+    });
+
+    it('does not log a Milestone entry when event name is absent', () => {
+      const logSpy = sinon.spy(webex.logger, 'log');
+      const eventPayload = {event: {}};
+
+      prepareDiagnosticMetricItem(webex, {eventPayload, type: ['diagnostic-event']});
+
+      assert.isFalse(
+        logSpy.calledWith('Milestone,CallDiagnostic', sinon.match.any),
+        'expected logger.log not to be called with Milestone,CallDiagnostic when event name is absent'
+      );
+      sinon.restore();
+    });
+
     it('sets buildType and upgradeChannel correctly', () => {
       const item: any = {
         eventPayload: {

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

@@ -1,23 +1,34 @@
 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', () => {
+import SourceNewMetrics from '@webex/internal-plugin-metrics/src/new-metrics';
+import * as Telemetry from '@webex/internal-plugin-metrics/src/unhandled-exception-telemetry';
 
-  const mockWebex = () => new MockWebex({
-    children: {
-      newMetrics: NewMetrics,
-    },
-    meetings: {
-    },
-    request: sinon.stub().resolves({}),
-    logger: {
-      log: sinon.stub(),
-      error: sinon.stub(),
-    }
-  });
+describe('internal-plugin-metrics', () => {
+  const mockWebex = (NewMetricsPlugin = NewMetrics) =>
+    new MockWebex({
+      children: {
+        newMetrics: NewMetricsPlugin,
+      },
+      meetings: {
+        getBasicMeetingInformation: sinon.stub().callsFake((meetingId) => ({
+          id: meetingId,
+          correlationId: `correlation-${meetingId}`,
+        })),
+      },
+      request: sinon.stub().resolves({}),
+      logger: {
+        log: sinon.stub(),
+        error: sinon.stub(),
+      },
+    });
 
   describe('check submitClientEvent, submitFeatureEvent when webex is not ready', () => {
     let webex;
@@ -46,12 +57,14 @@ describe('internal-plugin-metrics', () => {
         payload: {
           meetingSummaryInfo: {
             featureName: 'syncSystemMuteStatus',
-            featureActions: [{
-              actionName: 'syncMeetingMicUnmuteStatusToSystem',
-              actionId: '14200',
-              isInitialValue: false,
-              clickCount: '1'
-            }]
+            featureActions: [
+              {
+                actionName: 'syncMeetingMicUnmuteStatusToSystem',
+                actionId: '14200',
+                isInitialValue: false,
+                clickCount: '1',
+              },
+            ],
           },
         },
       });
@@ -63,12 +76,54 @@ describe('internal-plugin-metrics', () => {
   });
 
   describe('new-metrics contstructor', () => {
-    it('checks callDiagnosticLatencies is defined before ready emit', () => {
+    afterEach(() => {
+      sinon.restore();
+    });
 
+    it('checks callDiagnosticLatencies is defined before ready emit', () => {
       const webex = mockWebex();
 
       assert.instanceOf(webex.internal.newMetrics.callDiagnosticLatencies, CallDiagnosticLatencies);
     });
+
+    it('checks callDiagnosticMetrics is defined before ready emit', () => {
+      const webex = mockWebex();
+
+      assert.isDefined(webex.internal.newMetrics.callDiagnosticMetrics);
+    });
+
+    it('can call buildClientEventFetchRequestOptions before ready', async () => {
+      const webex = mockWebex();
+      const stub = sinon
+        .stub(
+          webex.internal.newMetrics.callDiagnosticMetrics,
+          'buildClientEventFetchRequestOptions'
+        )
+        .resolves({url: 'https://metrics.example.com'});
+
+      const result = await webex.internal.newMetrics.buildClientEventFetchRequestOptions({
+        name: 'client.alert.displayed',
+        options: {correlationId: 'test-id'},
+      });
+
+      assert.calledOnceWithExactly(stub, {
+        name: 'client.alert.displayed',
+        payload: undefined,
+        options: {correlationId: 'test-id'},
+      });
+      assert.deepEqual(result, {url: 'https://metrics.example.com'});
+    });
+
+    it('starts unhandled exception telemetry when webex is ready', () => {
+      const start = sinon.stub(Telemetry, 'startUnhandledExceptionTelemetry');
+      const webex = mockWebex(SourceNewMetrics);
+
+      assert.notCalled(start);
+
+      webex.emit('ready');
+
+      assert.calledOnceWithExactly(start, webex);
+    });
   });
 
   describe('new-metrics', () => {
@@ -94,7 +149,7 @@ describe('internal-plugin-metrics', () => {
 
     afterEach(() => {
       sinon.restore();
-    })
+    });
 
     it('lazy metrics backend initialization when checking if backend ready', () => {
       assert.isUndefined(webex.internal.newMetrics.behavioralMetrics);
@@ -105,13 +160,20 @@ describe('internal-plugin-metrics', () => {
       webex.internal.newMetrics.isReadyToSubmitOperationalEvents();
       assert.isDefined(webex.internal.newMetrics.operationalMetrics);
 
-      assert.isUndefined(webex.internal.newMetrics.businessMetrics)
+      assert.isUndefined(webex.internal.newMetrics.businessMetrics);
       webex.internal.newMetrics.isReadyToSubmitBusinessEvents();
       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)
+      assert.isUndefined(webex.internal.newMetrics.businessMetrics);
       webex.internal.newMetrics.isReadyToSubmitBusinessEvents();
       assert.isDefined(webex.internal.newMetrics.businessMetrics);
       webex.internal.newMetrics.businessMetrics.submitBusinessEvent = sinon.stub();
@@ -119,14 +181,14 @@ describe('internal-plugin-metrics', () => {
         name: 'foobar',
         payload: {},
         table: 'test',
-        metadata: { foo: 'bar' },
+        metadata: {foo: 'bar'},
       });
 
       assert.calledWith(webex.internal.newMetrics.businessMetrics.submitBusinessEvent, {
         name: 'foobar',
         payload: {},
         table: 'test',
-        metadata: { foo: 'bar' },
+        metadata: {foo: 'bar'},
       });
     });
 
@@ -150,6 +212,87 @@ describe('internal-plugin-metrics', () => {
       });
     });
 
+    describe('privacy and security permission enrichment', () => {
+      const permission = {
+        camera: {status: 'GRANTED' as const},
+        microphone: {status: 'DENIED' as const, reason: 'DENIED_BY_USER' as const},
+        contentShare: {status: 'REQUESTING' as const},
+      };
+
+      it('enriches an eligible client event through the public metrics API', () => {
+        webex.internal.newMetrics.setPrivacyAndSecurityPermission(permission);
+        webex.internal.newMetrics.submitClientEvent({name: 'client.call.initiated'});
+
+        const submittedPayload =
+          webex.internal.newMetrics.callDiagnosticMetrics.submitClientEvent.firstCall.args[0]
+            .payload;
+
+        assert.deepEqual(submittedPayload.privacyAndSecurityPermission, {
+          camera: permission.camera,
+          microphone: permission.microphone,
+        });
+      });
+
+      it('uses the meeting correlation id to preserve history across identifier transitions', () => {
+        webex.meetings.getBasicMeetingInformation
+          .withArgs('meeting-1')
+          .returns({id: 'meeting-1', correlationId: 'correlation-1'});
+        webex.internal.newMetrics.setPrivacyAndSecurityPermission(permission);
+
+        webex.internal.newMetrics.submitClientEvent({
+          name: 'client.call.initiated',
+          options: {correlationId: 'correlation-1'},
+        });
+        webex.internal.newMetrics.submitClientEvent({
+          name: 'client.ice.end',
+          payload: {},
+          options: {meetingId: 'meeting-1'},
+        });
+
+        const submissions = webex.internal.newMetrics.callDiagnosticMetrics.submitClientEvent.args;
+
+        assert.property(submissions[0][0].payload, 'privacyAndSecurityPermission');
+        assert.notProperty(submissions[1][0].payload, 'privacyAndSecurityPermission');
+      });
+
+      it('uses the default scope when no correlation id can be resolved', () => {
+        webex.internal.newMetrics.setPrivacyAndSecurityPermission(permission);
+
+        webex.internal.newMetrics.submitClientEvent({
+          name: 'client.call.initiated',
+          options: {sessionCorrelationId: 'session-1'},
+        });
+        webex.internal.newMetrics.submitClientEvent({
+          name: 'client.ice.end',
+          payload: {},
+          options: {sessionCorrelationId: 'session-2'},
+        });
+
+        const submissions = webex.internal.newMetrics.callDiagnosticMetrics.submitClientEvent.args;
+
+        assert.property(submissions[0][0].payload, 'privacyAndSecurityPermission');
+        assert.notProperty(submissions[1][0].payload, 'privacyAndSecurityPermission');
+      });
+
+      it('captures the permission snapshot before a delayed event is queued', () => {
+        webex.internal.newMetrics.setPrivacyAndSecurityPermission(permission);
+        webex.internal.newMetrics.setDelaySubmitClientEvents({shouldDelay: true});
+        webex.internal.newMetrics.submitClientEvent({name: 'client.call.initiated'});
+        webex.internal.newMetrics.setPrivacyAndSecurityPermission({
+          camera: {status: 'DENIED' as const},
+        });
+
+        const submission =
+          webex.internal.newMetrics.callDiagnosticMetrics.submitClientEvent.firstCall.args[0];
+
+        assert.isTrue(submission.delaySubmitEvent);
+        assert.deepEqual(submission.payload.privacyAndSecurityPermission, {
+          camera: permission.camera,
+          microphone: permission.microphone,
+        });
+      });
+    });
+
     it('submits feature Event successfully', () => {
       webex.internal.newMetrics.submitFeatureEvent({
         name: 'client.feature.meeting.summary',
@@ -159,12 +302,14 @@ describe('internal-plugin-metrics', () => {
         payload: {
           meetingSummaryInfo: {
             featureName: 'syncSystemMuteStatus',
-            featureActions: [{
-              actionName: 'syncMeetingMicUnmuteStatusToSystem',
-              actionId: '14200',
-              isInitialValue: false,
-              clickCount: '1'
-            }]
+            featureActions: [
+              {
+                actionName: 'syncMeetingMicUnmuteStatusToSystem',
+                actionId: '14200',
+                isInitialValue: false,
+                clickCount: '1',
+              },
+            ],
           },
         },
       });
@@ -178,12 +323,14 @@ describe('internal-plugin-metrics', () => {
         payload: {
           meetingSummaryInfo: {
             featureName: 'syncSystemMuteStatus',
-            featureActions: [{
-              actionName: 'syncMeetingMicUnmuteStatusToSystem',
-              actionId: '14200',
-              isInitialValue: false,
-              clickCount: '1'
-            }]
+            featureActions: [
+              {
+                actionName: 'syncMeetingMicUnmuteStatusToSystem',
+                actionId: '14200',
+                isInitialValue: false,
+                clickCount: '1',
+              },
+            ],
           },
         },
         options: {meetingId: '123'},
@@ -244,9 +391,9 @@ describe('internal-plugin-metrics', () => {
           method: 'POST',
           api: 'metrics',
           resource: 'clientmetrics',
-          headers: { 'x-prelogin-userid': 'my-id' },
+          headers: {'x-prelogin-userid': 'my-id'},
           body: {},
-          qs: { alias: true },
+          qs: {alias: true},
         });
         assert.calledWith(
           webex.logger.log,
@@ -255,8 +402,8 @@ describe('internal-plugin-metrics', () => {
       });
 
       it('handles failed request correctly', async () => {
-        webex.request.rejects(new Error("test error"));
-        sinon.stub(Utils, 'generateCommonErrorMetadata').returns('formattedError')
+        webex.request.rejects(new Error('test error'));
+        sinon.stub(Utils, 'generateCommonErrorMetadata').returns('formattedError');
         try {
           await webex.internal.newMetrics.clientMetricsAliasUser({event: 'test'}, 'my-id');
         } catch (err) {
@@ -338,19 +485,26 @@ describe('internal-plugin-metrics', () => {
         sinon.assert.match(webex.internal.newMetrics.delaySubmitClientEvents, true);
         sinon.assert.match(webex.internal.newMetrics.delayedClientEventsOverrides, {});
 
-        webex.internal.newMetrics.setDelaySubmitClientEvents({shouldDelay: false, overrides: {foo: 'bar'}});
+        webex.internal.newMetrics.setDelaySubmitClientEvents({
+          shouldDelay: false,
+          overrides: {foo: 'bar'},
+        });
 
-        assert.calledOnce(webex.internal.newMetrics.callDiagnosticMetrics.submitDelayedClientEvents);
-        assert.calledWith(webex.internal.newMetrics.callDiagnosticMetrics.submitDelayedClientEvents, {foo: 'bar'});
+        assert.calledOnce(
+          webex.internal.newMetrics.callDiagnosticMetrics.submitDelayedClientEvents
+        );
+        assert.calledWith(
+          webex.internal.newMetrics.callDiagnosticMetrics.submitDelayedClientEvents,
+          {foo: 'bar'}
+        );
 
         sinon.assert.match(webex.internal.newMetrics.delaySubmitClientEvents, false);
         sinon.assert.match(webex.internal.newMetrics.delayedClientEventsOverrides, {foo: 'bar'});
       });
 
       it('should not fail when called before webex is ready', () => {
-
         // Create mock
-        webex = mockWebex()
+        webex = mockWebex();
 
         webex.internal.newMetrics.callDiagnosticLatencies.saveTimestamp = sinon.stub();
         webex.internal.newMetrics.callDiagnosticLatencies.clearTimestamps = sinon.stub();
@@ -365,7 +519,6 @@ describe('internal-plugin-metrics', () => {
         webex.internal.newMetrics.setDelaySubmitClientEvents({shouldDelay: false});
         // Webex is ready
         webex.emit('ready');
-
       });
     });
   });

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

@@ -64,45 +64,36 @@ describe('internal-plugin-metrics', () => {
         //@ts-ignore
         assert.calledOnce(webex.request);
 
-        // matching because the request includes a symbol key: value pair and sinon cannot handle to compare it..
-        assert.match(webexRequestArgs, {
-          //@ts-ignore
-          body: {
-            metrics: [
-              {
-                eventPayload: {
-                  event: {
-                    joinTimes: {
-                      meetingInfoReqResp: undefined,
-                      clickToInterstitial: undefined,
-                      refreshCaptchaServiceReqResp: undefined,
-                      downloadIntelligenceModelsReqResp: undefined,
-                      clickToInterstitialWithUserDelay: undefined,
-                    },
-                    name: 'client.interstitial-window.launched',
-                  },
-                  origin: {
-                    buildType: 'test',
-                    networkType: 'unknown',
-                    upgradeChannel: 'test',
-                  },
-                  originTime: {
-                    sent: dateAfterBatcherWait.toISOString(),
-                  },
-                },
-                type: ['diagnostic-event'],
-              },
-            ],
+        assert.deepEqual(webexRequestArgs.headers, {
+          authorization: false,
+          'x-prelogin-userid': preLoginId,
+        });
+        assert.equal(webexRequestArgs.method, 'POST');
+        assert.equal(webexRequestArgs.resource, 'clientmetrics-prelogin');
+        assert.equal(webexRequestArgs.service, 'metrics');
+        assert.equal(webexRequestArgs.waitForServiceTimeout, 30);
+
+        assert.deepEqual(webexRequestArgs.body.metrics[0].eventPayload, {
+          event: {
+            joinTimes: {
+              meetingInfoReqResp: undefined,
+              clickToInterstitial: undefined,
+              refreshCaptchaServiceReqResp: undefined,
+              downloadIntelligenceModelsReqResp: undefined,
+              clickToInterstitialWithUserDelay: undefined,
+            },
+            name: 'client.interstitial-window.launched',
           },
-          headers: {
-            authorization: false,
-            'x-prelogin-userid': preLoginId,
+          origin: {
+            buildType: 'test',
+            networkType: 'unknown',
+            upgradeChannel: 'test',
+          },
+          originTime: {
+            sent: dateAfterBatcherWait.toISOString(),
           },
-          method: 'POST',
-          resource: 'clientmetrics-prelogin',
-          service: 'metrics',
-          waitForServiceTimeout: 30,
         });
+        assert.deepEqual(webexRequestArgs.body.metrics[0].type, ['diagnostic-event']);
         assert.lengthOf(
           webex.internal.newMetrics.callDiagnosticMetrics.preLoginMetricsBatcher.queue,
           0
@@ -320,5 +311,49 @@ describe('internal-plugin-metrics', () => {
         );
       });
     });
+
+    describe('#submitHttpRequest', () => {
+      it('calls webex.request with the correct parameters', async () => {
+        const payload = [
+          {
+            eventPayload: {event: 'my.event'},
+            type: ['diagnostic-event'],
+          },
+        ];
+
+        webex.internal.newMetrics.callDiagnosticMetrics.preLoginMetricsBatcher.savePreLoginId(
+          preLoginId
+        );
+        webex.request = sinon.stub().resolves({statusCode: 200});
+
+        const promise =
+          webex.internal.newMetrics.callDiagnosticMetrics.preLoginMetricsBatcher.submitHttpRequest(
+            payload
+          );
+
+        await flushPromises();
+
+        clock.tick(config.metrics.batcherWait);
+
+        await promise;
+
+        const webexRequestArgs = webex.request.args[0][0];
+
+        assert.match(webexRequestArgs, {
+          //@ts-ignore
+          body: {
+            metrics: payload,
+          },
+          headers: {
+            authorization: false,
+            'x-prelogin-userid': preLoginId,
+          },
+          method: 'POST',
+          resource: 'clientmetrics-prelogin',
+          service: 'metrics',
+          waitForServiceTimeout: 30,
+        });
+      });
+    });
   });
 });