@webex/internal-plugin-metrics 3.0.0-next.9 → 3.1.0

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

@@ -541,7 +541,10 @@ describe('internal-plugin-metrics', () => {
     it('should prepare diagnostic event successfully', () => {
       const options = {meetingId: fakeMeeting.id};
       const getOriginStub = sinon.stub(cd, 'getOrigin').returns({origin: 'fake-origin'});
-      const clearEmptyKeysRecursivelyStub = sinon.stub(CallDiagnosticUtils, 'clearEmptyKeysRecursively');
+      const clearEmptyKeysRecursivelyStub = sinon.stub(
+        CallDiagnosticUtils,
+        'clearEmptyKeysRecursively'
+      );
 
       const res = cd.prepareDiagnosticEvent(
         {
@@ -896,11 +899,13 @@ describe('internal-plugin-metrics', () => {
           options
         );
         assert.notCalled(submitToCallDiagnosticsSpy);
-        assert.calledWith(submitToCallDiagnosticsPreLoginSpy, {
+        assert.calledWith(
+          submitToCallDiagnosticsPreLoginSpy,
+          {
             eventId: 'my-fake-id',
             version: 1,
-            origin: { origin: 'fake-origin' },
-            originTime: { triggered: now.toISOString(), sent: 'not_defined_yet' },
+            origin: {origin: 'fake-origin'},
+            originTime: {triggered: now.toISOString(), sent: 'not_defined_yet'},
             senderCountryCode: 'UK',
             event: {
               name: 'client.alert.displayed',
@@ -912,12 +917,14 @@ describe('internal-plugin-metrics', () => {
                 orgId: 'orgId',
                 locusUrl: 'locus-url',
                 webexConferenceIdStr: 'webexConferenceIdStr1',
-                globalMeetingId: 'globalMeetingId1'
+                globalMeetingId: 'globalMeetingId1',
               },
-              eventData: { webClientDomain: 'whatever' },
-              loginType: 'login-ci'
+              eventData: {webClientDomain: 'whatever'},
+              loginType: 'login-ci',
             },
-        }, options.preLoginId);
+          },
+          options.preLoginId
+        );
       });
 
       it('should use meeting loginType if present and meetingId provided', () => {
@@ -1382,7 +1389,7 @@ describe('internal-plugin-metrics', () => {
       });
     });
 
-    describe("#submitToCallDiagnostics", () => {
+    describe('#submitToCallDiagnostics', () => {
       it('should send request to call diagnostic batcher', () => {
         const requestStub = sinon.stub();
         //@ts-ignore
@@ -1391,7 +1398,7 @@ describe('internal-plugin-metrics', () => {
         cd.submitToCallDiagnostics({event: 'test'});
         assert.calledWith(requestStub, {eventPayload: {event: 'test'}, type: ['diagnostic-event']});
       });
-    })
+    });
 
     describe('#submitMQE', () => {
       it('submits the event correctly', () => {
@@ -2006,12 +2013,16 @@ describe('internal-plugin-metrics', () => {
 
       describe('httpStatusCode', () => {
         it('should include httpStatusCode for browser media errors', () => {
-          const res = cd.generateClientEventErrorPayload({name: 'PermissionDeniedError', message: 'bad times', statusCode: 401});
+          const res = cd.generateClientEventErrorPayload({
+            name: 'PermissionDeniedError',
+            message: 'bad times',
+            statusCode: 401,
+          });
           assert.deepEqual(res, {
             category: 'expected',
             errorCode: 4032,
             errorData: {
-              errorName: 'PermissionDeniedError'
+              errorName: 'PermissionDeniedError',
             },
             errorDescription: 'CameraPermissionDenied',
             fatal: true,
@@ -2024,12 +2035,16 @@ describe('internal-plugin-metrics', () => {
         });
 
         it('should include httpStatusCode for SdpOfferCreationErrors', () => {
-          const res = cd.generateClientEventErrorPayload({name: 'SdpOfferCreationError', message: 'bad times', statusCode: 404});
+          const res = cd.generateClientEventErrorPayload({
+            name: 'SdpOfferCreationError',
+            message: 'bad times',
+            statusCode: 404,
+          });
           assert.deepEqual(res, {
             category: 'media',
             errorCode: 2050,
             errorData: {
-              errorName: 'SdpOfferCreationError'
+              errorName: 'SdpOfferCreationError',
             },
             errorDescription: 'SdpOfferCreationError',
             fatal: true,
@@ -2042,7 +2057,11 @@ describe('internal-plugin-metrics', () => {
         });
 
         it('should include httpStatusCode for service error codes', () => {
-          const res = cd.generateClientEventErrorPayload({body: {errorCode: 58400}, message: 'bad times', statusCode: 400});
+          const res = cd.generateClientEventErrorPayload({
+            body: {errorCode: 58400},
+            message: 'bad times',
+            statusCode: 400,
+          });
           assert.deepEqual(res, {
             category: 'signaling',
             errorCode: 4100,
@@ -2057,7 +2076,11 @@ describe('internal-plugin-metrics', () => {
         });
 
         it('should include httpStatusCode for locus service error codes', () => {
-          const res = cd.generateClientEventErrorPayload({body: {errorCode: 2403001}, message: 'bad times', statusCode: 400});
+          const res = cd.generateClientEventErrorPayload({
+            body: {errorCode: 2403001},
+            message: 'bad times',
+            statusCode: 400,
+          });
           assert.deepEqual(res, {
             category: 'expected',
             errorCode: 3007,
@@ -2072,7 +2095,11 @@ describe('internal-plugin-metrics', () => {
         });
 
         it('should include httpStatusCode for meetingInfo service error codes', () => {
-          const res = cd.generateClientEventErrorPayload({body: {data: {meetingInfo: {}}}, message: 'bad times', statusCode: 400});
+          const res = cd.generateClientEventErrorPayload({
+            body: {data: {meetingInfo: {}}},
+            message: 'bad times',
+            statusCode: 400,
+          });
           assert.deepEqual(res, {
             category: 'signaling',
             errorCode: 4100,
@@ -2087,8 +2114,10 @@ describe('internal-plugin-metrics', () => {
         });
 
         it('should include httpStatusCode for network errors', () => {
-          const error = new WebexHttpError.NetworkOrCORSError(
-            {statusCode: 400, options: {service: '', headers: {}}});
+          const error = new WebexHttpError.NetworkOrCORSError({
+            statusCode: 400,
+            options: {service: '', headers: {}},
+          });
           const res = cd.generateClientEventErrorPayload(error);
           assert.deepEqual(res, {
             category: 'network',
@@ -2104,8 +2133,10 @@ describe('internal-plugin-metrics', () => {
         });
 
         it('should include httpStatusCode for unauthorized errors', () => {
-          const error = new WebexHttpError.Unauthorized(
-            {statusCode: 401, options: {service: '', headers: {}}});
+          const error = new WebexHttpError.Unauthorized({
+            statusCode: 401,
+            options: {service: '', headers: {}},
+          });
           const res = cd.generateClientEventErrorPayload(error);
           assert.deepEqual(res, {
             category: 'network',
@@ -2308,7 +2339,7 @@ describe('internal-plugin-metrics', () => {
       });
     });
 
-    describe("#submitToCallDiagnosticsPreLogin", () => {
+    describe('#submitToCallDiagnosticsPreLogin', () => {
       it('should send request to call diagnostic batcher and saves preLoginId', () => {
         const requestStub = sinon.stub();
         //@ts-ignore
@@ -2321,7 +2352,7 @@ describe('internal-plugin-metrics', () => {
         assert.calledWith(cd.preLoginMetricsBatcher.savePreLoginId, preLoginId);
         assert.calledWith(requestStub, {eventPayload: {event: 'test'}, type: ['diagnostic-event']});
       });
-    })
+    });
 
     describe('#isServiceErrorExpected', () => {
       it('returns true for code mapped to "expected"', () => {

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

@@ -301,17 +301,23 @@ describe('internal-plugin-metrics', () => {
 
     [
       ['client.exit.app', {}],
-      ['client.login.end', {
-        joinTimes: {
-          otherAppApiReqResp: undefined,
-          exchangeCITokenJMT: undefined,
-        }
-      }],
-      ['client.webexapp.launched', {
-        joinTimes: {
-          downloadTime: undefined,
-        }
-      }],
+      [
+        'client.login.end',
+        {
+          joinTimes: {
+            otherAppApiReqResp: undefined,
+            exchangeCITokenJMT: undefined,
+          },
+        },
+      ],
+      [
+        'client.webexapp.launched',
+        {
+          joinTimes: {
+            downloadTime: undefined,
+          },
+        },
+      ],
       [
         'client.interstitial-window.launched',
         {
@@ -319,6 +325,7 @@ describe('internal-plugin-metrics', () => {
             clickToInterstitial: undefined,
             meetingInfoReqResp: undefined,
             refreshCaptchaServiceReqResp: undefined,
+            downloadIntelligenceModelsReqResp: undefined,
           },
         },
       ],
@@ -329,7 +336,8 @@ describe('internal-plugin-metrics', () => {
             showInterstitialTime: undefined,
             meetingInfoReqResp: undefined,
             registerWDMDeviceJMT: undefined,
-            getU2CTime: undefined
+            getU2CTime: undefined,
+            getReachabilityClustersReqResp: undefined,
           },
         },
       ],
@@ -345,7 +353,7 @@ describe('internal-plugin-metrics', () => {
             interstitialToJoinOK: undefined,
             totalJmt: undefined,
             clientJmt: undefined,
-            downloadTime: undefined
+            downloadTime: undefined,
           },
         },
       ],
@@ -607,6 +615,12 @@ describe('internal-plugin-metrics', () => {
         turnServerUsed: true,
         errorCode: DTLS_HANDSHAKE_FAILED_CLIENT_CODE,
       },
+      {
+        signalingState: 'stable',
+        iceConnectionState: 'disconnected',
+        turnServerUsed: true,
+        errorCode: DTLS_HANDSHAKE_FAILED_CLIENT_CODE,
+      },
       {
         signalingState: 'stable',
         iceConnectionState: 'failed',

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

@@ -0,0 +1,54 @@
+/*!
+ * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
+ */
+
+import {assert} from '@webex/test-helper-chai';
+import MockWebex from '@webex/test-helper-mock-webex';
+import sinon from 'sinon';
+import Metrics from '@webex/internal-plugin-metrics';
+import PreLoginMetricsBatcher from '@webex/internal-plugin-metrics';
+import ClientMetricsPreloginBatcher from '@webex/internal-plugin-metrics';
+
+
+describe('internal-plugin-metrics', () => {
+  describe('ClientMetricsPreloginBatcher', () => {
+    let webex;
+
+    beforeEach(() => {
+      //@ts-ignore
+      webex = new MockWebex({
+        children: {
+            metrics: Metrics,
+        },
+      });
+
+      webex.request = (options) =>
+        Promise.resolve({body: {items: []}, waitForServiceTimeout: 15, options});
+
+      sinon.spy(webex, 'request');
+    });
+
+    afterEach(() => {
+      sinon.restore();
+    });
+
+    it('should be an instance of PreLoginMetricsBatcher', () => {
+      const clientMetricsPreloginBatcher = new ClientMetricsPreloginBatcher();
+      assert.instanceOf(clientMetricsPreloginBatcher, PreLoginMetricsBatcher);
+    });
+
+
+    it('checks prepareItem', async () => {
+        const testItem = {id: 1};
+        const resultPromise = await webex.internal.metrics.clientMetricsPreloginBatcher.prepareItem(testItem);
+        assert.strictEqual(resultPromise, testItem);
+    });
+
+    it('checks prepareRequest', async () => {
+        const testQueue = [];
+
+        const resultPromise = await webex.internal.metrics.clientMetricsPreloginBatcher.prepareRequest(testQueue);
+        assert.strictEqual(resultPromise, testQueue);
+    });
+  });
+});

package/test/unit/spec/metrics.js

@@ -113,7 +113,6 @@ describe('plugin-metrics', () => {
       }
 
       sinon.spy(webex, 'request');
-      sinon.spy(metrics, 'postPreLoginMetric');
       sinon.spy(metrics, 'aliasUser');
     });
 
@@ -207,7 +206,7 @@ describe('plugin-metrics', () => {
 
     describe('#submitClientMetrics()', () => {
       describe('before login', () => {
-        it('posts pre-login metric', () => {
+        it('clientMetricsPreloginBatcher pre-login metric', () => {
           const date = clock.now;
           const promise = metrics.submitClientMetrics(eventName, mockPayload, preLoginId);
 
@@ -215,8 +214,6 @@ describe('plugin-metrics', () => {
             .then(() => clock.tick(config.metrics.batcherWait))
             .then(() => promise)
             .then(() => {
-              assert.called(metrics.postPreLoginMetric);
-              assert.calledOnce(webex.credentials.getClientToken);
               assert.calledOnce(webex.request);
               const req = webex.request.args[0][0];
               const metric = req.body.metrics[0];
@@ -304,33 +301,6 @@ describe('plugin-metrics', () => {
       });
     });
 
-    describe('#postPreLoginMetric()', () => {
-      it('returns an HttpResponse object', () => {
-        const promise = metrics.postPreLoginMetric(preLoginProps, preLoginId);
-
-        return promiseTick(50)
-          .then(() => clock.tick(config.metrics.batcherWait))
-          .then(() => promise)
-          .then(() => {
-            assert.calledOnce(webex.request);
-            const req = webex.request.args[0][0];
-            const metric = req.body.metrics[0];
-            const {headers} = req;
-
-            assert.property(headers, 'x-prelogin-userid');
-            assert.property(metric, 'metricName');
-            assert.property(metric, 'tags');
-            assert.property(metric, 'fields');
-            assert.property(metric, 'timestamp');
-
-            assert.equal(metric.timestamp, transformedProps.timestamp);
-            assert.equal(metric.metricName, eventName);
-            assert.equal(metric.tags.testTag, 'tag value');
-            assert.equal(metric.fields.testField, 123);
-          });
-      });
-    });
-
     describe('#aliasUser()', () => {
       it('returns an HttpResponse object', () =>
         metrics.aliasUser(preLoginId).then(() => {

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

@@ -75,6 +75,7 @@ describe('internal-plugin-metrics', () => {
                       meetingInfoReqResp: undefined,
                       clickToInterstitial: undefined,
                       refreshCaptchaServiceReqResp: undefined,
+                      downloadIntelligenceModelsReqResp: undefined,
                     },
                     name: 'client.interstitial-window.launched',
                   },
@@ -139,7 +140,7 @@ describe('internal-plugin-metrics', () => {
         assert.calledOnceWithExactly(
           webex.logger.error,
           'Pre Login Metrics -->',
-          `PreLoginMetricsBatcher: @submitHttpRequest#prelogin-ca-batch-${expectedBatchId}. Request failed:`,
+          `PreLoginMetricsBatcher: @submitHttpRequest#prelogin-batch-${expectedBatchId}. Request failed:`,
           `error: formattedError`
         );
         assert.lengthOf(
@@ -149,7 +150,8 @@ describe('internal-plugin-metrics', () => {
       });
 
       it('fails if preLoinId is not set', async () => {
-        webex.internal.newMetrics.callDiagnosticMetrics.preLoginMetricsBatcher.preLoginId = undefined;
+        webex.internal.newMetrics.callDiagnosticMetrics.preLoginMetricsBatcher.preLoginId =
+          undefined;
 
         const promise =
           webex.internal.newMetrics.callDiagnosticMetrics.submitToCallDiagnosticsPreLogin(
@@ -177,7 +179,7 @@ describe('internal-plugin-metrics', () => {
 
     describe('prepareItem', () => {
       it('calls prepareDiagnosticMetricItem correctly', async () => {
-         // avoid setting .sent timestamp
+        // avoid setting .sent timestamp
         webex.internal.newMetrics.callDiagnosticMetrics.preLoginMetricsBatcher.prepareRequest = (q) =>
           Promise.resolve(q);