@webex/internal-plugin-metrics 3.0.0-beta.22 → 3.0.0-beta.221

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

@@ -0,0 +1,243 @@
+/*!
+ * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
+ */
+
+import {assert} from '@webex/test-helper-chai';
+import {config} from '@webex/internal-plugin-metrics';
+import MockWebex from '@webex/test-helper-mock-webex';
+import sinon from 'sinon';
+import {NewMetrics} from '@webex/internal-plugin-metrics';
+const flushPromises = () => new Promise(setImmediate);
+
+describe('plugin-metrics', () => {
+  describe('CallDiagnosticEventsBatcher', () => {
+    let webex;
+
+    beforeEach(() => {
+      //@ts-ignore
+      webex = new MockWebex({
+        children: {
+          newMetrics: NewMetrics
+        }
+      });
+
+      webex.request = (options) => Promise.resolve({body: {items: []}, options});
+      sinon.spy(webex, 'request');
+
+      webex.emit("ready");
+
+      webex.config.metrics = config.metrics;
+    });
+
+    afterEach(() => {
+      sinon.restore();
+    });
+
+    describe('#request()', () => {
+      describe('when the request completes successfully', async () => {
+        it('clears the queue', async () => {
+          await webex.internal.newMetrics.callDiagnosticMetrics.submitToCallDiagnostics(
+            //@ts-ignore
+            {event: {name: 'client.interstitial-window.launched'}}
+          );
+          await flushPromises();
+
+          //@ts-ignore
+          assert.calledOnce(webex.request);
+          assert.lengthOf(webex.internal.newMetrics.callDiagnosticMetrics.callDiagnosticEventsBatcher.queue, 0);
+        });
+
+        it('doesnt include any joinTimes for other events', async () => {
+          await webex.internal.newMetrics.callDiagnosticMetrics.submitToCallDiagnostics(
+            //@ts-ignore
+            {event: {name: 'client.alert.displayed'}}
+          );
+          await flushPromises();
+
+          //@ts-ignore
+          assert.calledOnce(webex.request);
+          assert.deepEqual(webex.request.getCalls()[0].args[0].body.metrics[0].eventPayload.event, {
+            name: 'client.alert.displayed',
+          });
+          assert.lengthOf(webex.internal.newMetrics.callDiagnosticMetrics.callDiagnosticEventsBatcher.queue, 0);
+        });
+
+        it('appends the correct join times to the request for client.interstitial-window.launched', async () => {
+          webex.internal.newMetrics.callDiagnosticLatencies.getDiffBetweenTimestamps = sinon.stub().returns(10);
+          webex.internal.newMetrics.callDiagnosticLatencies.getClickToInterstitial = sinon.stub().returns(10);
+          await webex.internal.newMetrics.callDiagnosticMetrics.submitToCallDiagnostics(
+            //@ts-ignore
+            {event: {name: 'client.interstitial-window.launched'}}
+          );
+          await flushPromises();
+
+          //@ts-ignore
+          assert.calledOnce(webex.request);
+          assert.deepEqual(webex.request.getCalls()[0].args[0].body.metrics[0].eventPayload.event, {
+            name: 'client.interstitial-window.launched',
+            joinTimes: {
+              clickToInterstitial: 10,
+              meetingInfoReqResp: 10,
+            },
+          });
+          assert.lengthOf(webex.internal.newMetrics.callDiagnosticMetrics.callDiagnosticEventsBatcher.queue, 0);
+        });
+
+        it('appends the correct join times to the request for client.call.initiated', async () => {
+          webex.internal.newMetrics.callDiagnosticLatencies.getDiffBetweenTimestamps = sinon.stub().returns(10);
+          await webex.internal.newMetrics.callDiagnosticMetrics.submitToCallDiagnostics(
+            //@ts-ignore
+            {event: {name: 'client.call.initiated'}}
+          );
+          await flushPromises();
+
+          //@ts-ignore
+          assert.calledOnce(webex.request);
+          assert.deepEqual(webex.request.getCalls()[0].args[0].body.metrics[0].eventPayload.event, {
+            name: 'client.call.initiated',
+            joinTimes: {
+              meetingInfoReqResp: 10,
+              showInterstitialTime: 10,
+            },
+          });
+          assert.lengthOf(webex.internal.newMetrics.callDiagnosticMetrics.callDiagnosticEventsBatcher.queue, 0);
+        });
+
+        it('appends the correct join times to the request for client.locus.join.response', async () => {
+          webex.internal.newMetrics.callDiagnosticLatencies.getDiffBetweenTimestamps = sinon.stub().returns(10);
+          webex.internal.newMetrics.callDiagnosticLatencies.getJoinRespSentReceived = sinon.stub().returns(20);
+          webex.internal.newMetrics.callDiagnosticLatencies.getPageJMT = sinon.stub().returns(30);
+          webex.internal.newMetrics.callDiagnosticLatencies.getClientJMT = sinon.stub().returns(5);
+          webex.internal.newMetrics.callDiagnosticLatencies.getClickToInterstitial = sinon.stub().returns(10);
+          webex.internal.newMetrics.callDiagnosticLatencies.getCallInitJoinReq = sinon.stub().returns(10);
+          await webex.internal.newMetrics.callDiagnosticMetrics.submitToCallDiagnostics(
+            //@ts-ignore
+            {event: {name: 'client.locus.join.response'}}
+          );
+          await flushPromises();
+
+          //@ts-ignore
+          assert.calledOnce(webex.request);
+          assert.deepEqual(webex.request.getCalls()[0].args[0].body.metrics[0].eventPayload.event, {
+            name: 'client.locus.join.response',
+            joinTimes: {
+              callInitJoinReq: 10,
+              clickToInterstitial: 10,
+              interstitialToJoinOK: 10,
+              joinReqResp: 10,
+              joinReqSentReceived: 20,
+              meetingInfoReqResp: 10,
+              pageJmt: 30,
+              totalJmt: 20,
+              clientJmt: 5,
+            },
+          });
+          assert.lengthOf(webex.internal.newMetrics.callDiagnosticMetrics.callDiagnosticEventsBatcher.queue, 0);
+        });
+
+        it('appends the correct join times to the request for client.ice.end', async () => {
+          webex.internal.newMetrics.callDiagnosticLatencies.getDiffBetweenTimestamps = sinon.stub().returns(10);
+          await webex.internal.newMetrics.callDiagnosticMetrics.submitToCallDiagnostics(
+            //@ts-ignore
+            {event: {name: 'client.ice.end'}}
+          );
+          await flushPromises();
+
+          //@ts-ignore
+          assert.calledOnce(webex.request);
+          assert.deepEqual(webex.request.getCalls()[0].args[0].body.metrics[0].eventPayload.event, {
+            name: 'client.ice.end',
+            joinTimes: {
+              ICESetupTime: 10,
+              audioICESetupTime: 10,
+              shareICESetupTime: 10,
+              videoICESetupTime: 10,
+            },
+          });
+          assert.lengthOf(webex.internal.newMetrics.callDiagnosticMetrics.callDiagnosticEventsBatcher.queue, 0);
+        });
+
+        it('appends the correct join times to the request for client.media.rx.start', async () => {
+          webex.internal.newMetrics.callDiagnosticLatencies.getDiffBetweenTimestamps = sinon.stub().returns(10);
+          await webex.internal.newMetrics.callDiagnosticMetrics.submitToCallDiagnostics(
+            //@ts-ignore
+            {event: {name: 'client.media.rx.start'}}
+          );
+          await flushPromises();
+
+          //@ts-ignore
+          assert.calledOnce(webex.request);
+          assert.deepEqual(webex.request.getCalls()[0].args[0].body.metrics[0].eventPayload.event, {
+            name: 'client.media.rx.start',
+            joinTimes: {
+              localSDPGenRemoteSDPRecv: 10,
+            },
+          });
+          assert.lengthOf(webex.internal.newMetrics.callDiagnosticMetrics.callDiagnosticEventsBatcher.queue, 0);
+        });
+
+        it('appends the correct join times to the request for client.media-engine.ready', async () => {
+          webex.internal.newMetrics.callDiagnosticLatencies.getDiffBetweenTimestamps = sinon.stub().returns(10);
+          webex.internal.newMetrics.callDiagnosticLatencies.getInterstitialToMediaOKJMT = sinon.stub().returns(10);
+          webex.internal.newMetrics.callDiagnosticLatencies.getClickToInterstitial = sinon.stub().returns(10);
+          await webex.internal.newMetrics.callDiagnosticMetrics.submitToCallDiagnostics(
+            //@ts-ignore
+            {event: {name: 'client.media-engine.ready'}}
+          );
+          await flushPromises();
+
+          //@ts-ignore
+          assert.calledOnce(webex.request);
+          assert.deepEqual(webex.request.getCalls()[0].args[0].body.metrics[0].eventPayload.event, {
+            name: 'client.media-engine.ready',
+            joinTimes: {
+              totalMediaJMT: 30,
+              interstitialToMediaOKJMT: 10,
+              callInitMediaEngineReady: 10,
+              stayLobbyTime: 10,
+            },
+          });
+          assert.lengthOf(webex.internal.newMetrics.callDiagnosticMetrics.callDiagnosticEventsBatcher.queue, 0);
+        });
+
+        it('appends the correct audio and video setup delays to the request for client.mediaquality.event', async () => {
+          webex.internal.newMetrics.callDiagnosticLatencies.getDiffBetweenTimestamps = sinon.stub().returns(10);
+          await  webex.internal.newMetrics.callDiagnosticMetrics.submitToCallDiagnostics(
+            //@ts-ignore
+            {event: {name: 'client.mediaquality.event'}}
+          );
+          await flushPromises();
+
+          //@ts-ignore
+          assert.calledOnce(webex.request);
+          assert.deepEqual(webex.request.getCalls()[0].args[0].body.metrics[0].eventPayload.event, {
+            name: 'client.mediaquality.event',
+            audioSetupDelay: {
+              joinRespRxStart: 10,
+              joinRespTxStart: 10,
+            },
+            videoSetupDelay: {
+              joinRespRxStart: 10,
+              joinRespTxStart: 10,
+            }
+          });
+          assert.lengthOf(webex.internal.newMetrics.callDiagnosticMetrics.callDiagnosticEventsBatcher.queue, 0);
+        });
+
+        it('doesnt include audioSetup and videoSetup delays for other events', async () => {
+          await  webex.internal.newMetrics.callDiagnosticMetrics.submitToCallDiagnostics(
+            //@ts-ignore
+            {event: {name: 'client.alert.displayed'}}
+          );
+          await flushPromises();
+
+          //@ts-ignore
+          assert.calledOnce(webex.request);
+          assert.deepEqual(webex.request.getCalls()[0].args[0].body.metrics[0].eventPayload.event.audioSetupDelay, undefined);
+          assert.deepEqual(webex.request.getCalls()[0].args[0].body.metrics[0].eventPayload.event.videoSetupDelay, undefined);
+          assert.lengthOf(webex.internal.newMetrics.callDiagnosticMetrics.callDiagnosticEventsBatcher.queue, 0);
+        })
+      });
+    });
+  });
+});