@webex/internal-plugin-metrics 3.11.0 → 3.12.0

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,6 +446,14 @@ 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');

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

@@ -0,0 +1,132 @@
+import PreLoginMetricsBatcher from '../../../src/prelogin-metrics-batcher';
+import {PreLoginMetrics} from '@webex/internal-plugin-metrics';
+import {assert} from '@webex/test-helper-chai';
+import MockWebex from '@webex/test-helper-mock-webex';
+import sinon from 'sinon';
+
+describe('internal-plugin-metrics', () => {
+  const mockedWebex: MockWebex = new MockWebex();
+  const fakedPreLoginMetricsBatcher: typeof PreLoginMetricsBatcher = new PreLoginMetricsBatcher({}, {parent: mockedWebex});
+
+  describe('prelogin-metrics', () => {
+    afterEach(() => {
+      sinon.restore();
+    });
+
+    it('Should send metrics to preloginMetricsBatcher', async () => {
+      const testEvent = 'test';
+      const testId = 'abc123';
+      const preLoginMetrics = new PreLoginMetrics(fakedPreLoginMetricsBatcher, {}, {parent: mockedWebex});
+
+      sinon.stub(fakedPreLoginMetricsBatcher, 'savePreLoginId');
+      const requestSpy = sinon.stub(fakedPreLoginMetricsBatcher, 'request');
+
+      await preLoginMetrics.submitPreLoginEvent({name: testEvent, preLoginId: testId, payload: {}});
+
+      assert.calledOnceWithMatch(requestSpy, {
+        type: ['business'],
+        eventPayload: {metricName: testEvent, value: {preLoginId: testId}},
+      });
+    });
+
+    it('Should send metadata to preloginMetricsBatcher', async () => {
+      const testEvent = 'test';
+      const testId = 'abc123';
+      const testMetadata = { 'testKey': 'test-value' };
+      const preLoginMetrics = new PreLoginMetrics(fakedPreLoginMetricsBatcher, {}, {parent: mockedWebex});
+
+      sinon.stub(fakedPreLoginMetricsBatcher, 'savePreLoginId');
+      const requestSpy = sinon.stub(fakedPreLoginMetricsBatcher, 'request');
+
+      await preLoginMetrics.submitPreLoginEvent({name: testEvent, preLoginId: testId, payload: {}, metadata: testMetadata});
+
+      assert.calledOnceWithMatch(requestSpy, {
+        type: ['business'],
+        eventPayload: {metricName: testEvent, value: {preLoginId: testId, ...testMetadata}},
+      });
+    });
+
+    it('Should send payload to preloginMetricsBatcher', async () => {
+      const testEvent = 'test';
+      const testId = 'abc123';
+      const testPayload = { 'testKey': 'test-value' };
+      const preLoginMetrics = new PreLoginMetrics(fakedPreLoginMetricsBatcher, {}, {parent: mockedWebex});
+
+      sinon.stub(fakedPreLoginMetricsBatcher, 'savePreLoginId');
+      const requestSpy = sinon.stub(fakedPreLoginMetricsBatcher, 'request');
+
+      await preLoginMetrics.submitPreLoginEvent({name: testEvent, preLoginId: testId, payload: testPayload});
+
+      assert.calledOnceWithMatch(requestSpy, {
+        type: ['business'],
+        eventPayload: {metricName: testEvent, value: {preLoginId: testId, ...testPayload}},
+      });
+    });
+
+    it('Should fill appType if not defined', async () => {
+      const testEvent = 'test';
+      const preLoginMetrics = new PreLoginMetrics(fakedPreLoginMetricsBatcher, {}, {parent: mockedWebex});
+
+      sinon.stub(fakedPreLoginMetricsBatcher, 'savePreLoginId');
+      const requestSpy = sinon.stub(fakedPreLoginMetricsBatcher, 'request');
+
+      await preLoginMetrics.submitPreLoginEvent({name: testEvent, preLoginId: 'abc123', payload: {}});
+
+      assert.calledOnceWithMatch(requestSpy, {
+        type: ['business'],
+        eventPayload: {metricName: testEvent, value: {appType: 'Web Client'}},
+      });
+    });
+
+    it('Should add browser details', async () => {
+      const testEvent = 'test';
+      const testBrowserDetails = { browser: 'Firefox', domain: 'test.example.com' };
+      const preLoginMetrics = new PreLoginMetrics(fakedPreLoginMetricsBatcher, {}, {parent: mockedWebex});
+
+      sinon.stub(preLoginMetrics, 'getBrowserDetails').returns(testBrowserDetails);
+      sinon.stub(fakedPreLoginMetricsBatcher, 'savePreLoginId');
+      const requestSpy = sinon.stub(fakedPreLoginMetricsBatcher, 'request');
+
+      await preLoginMetrics.submitPreLoginEvent({name: testEvent, preLoginId: 'abc123', payload: {}});
+
+      assert.calledOnceWithMatch(requestSpy, {
+        type: ['business'],
+        eventPayload: {browserDetails: testBrowserDetails, metricName: testEvent},
+      });
+    });
+
+    it('Should add context', async () => {
+      const testEvent = 'test';
+      const testContext = { device: { id: 'abc123' }};
+      const preLoginMetrics = new PreLoginMetrics(fakedPreLoginMetricsBatcher, {}, {parent: mockedWebex});
+
+      sinon.stub(preLoginMetrics, 'getContext').returns(testContext);
+      sinon.stub(fakedPreLoginMetricsBatcher, 'savePreLoginId');
+      const requestSpy = sinon.stub(fakedPreLoginMetricsBatcher, 'request');
+
+      await preLoginMetrics.submitPreLoginEvent({name: testEvent, preLoginId: 'abc123', payload: {}});
+
+      assert.calledOnceWithMatch(requestSpy, {
+        type: ['business'],
+        eventPayload: {context: testContext, metricName: testEvent},
+      });
+    });
+
+    it('Should add timestamp', async () => {
+      const testEvent = 'test';
+      const testTime = 1234;
+      const preLoginMetrics = new PreLoginMetrics(fakedPreLoginMetricsBatcher, {}, {parent: mockedWebex});
+
+      sinon.useFakeTimers(testTime);
+      sinon.stub(fakedPreLoginMetricsBatcher, 'savePreLoginId');
+      const requestSpy = sinon.stub(fakedPreLoginMetricsBatcher, 'request');
+
+      await preLoginMetrics.submitPreLoginEvent({name: testEvent, preLoginId: 'abc123', payload: {}});
+
+      assert.calledOnceWithMatch(requestSpy, {
+        type: ['business'],
+        eventPayload: {metricName: testEvent, timestamp: testTime},
+      });
+    });
+  });
+});