@webex/internal-plugin-metrics 3.12.0-next.9 → 3.12.0-webex-services-ready.1

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

@@ -460,6 +460,33 @@ describe('internal-plugin-metrics', () => {
       });
     });
 
+    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/prelogin-metrics-batcher.ts

@@ -64,45 +64,37 @@ 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.equal(webexRequestArgs.body.metrics[0].markTelemetryOptOutOnResponse, true);
         assert.lengthOf(
           webex.internal.newMetrics.callDiagnosticMetrics.preLoginMetricsBatcher.queue,
           0
@@ -320,5 +312,167 @@ describe('internal-plugin-metrics', () => {
         );
       });
     });
+
+    describe('#submitHttpRequest', () => {
+      it('calls webex.request with the correct parameters and then it calls handleHttpResponseStatus on success', 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 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);
+
+        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,
+        });
+
+        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);
+      });
+    });
   });
 });