@webex/internal-plugin-metrics 3.0.0-beta.17 → 3.0.0-beta.170

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

@@ -0,0 +1,235 @@
+/*!
+ * 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);
+          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);
+          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,
+            },
+          });
+          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)
+          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,
+            },
+          });
+          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);
+        })
+      });
+    });
+  });
+});

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

@@ -0,0 +1,199 @@
+import {assert} from '@webex/test-helper-chai';
+import CallDiagnosticLatencies from '../../../../src/call-diagnostic/call-diagnostic-metrics-latencies'
+import sinon from 'sinon';
+
+describe("internal-plugin-metrics", () => {
+  describe("CallDiagnosticLatencies", () => {
+    let cdl: CallDiagnosticLatencies;
+    var now = new Date();
+
+
+    beforeEach(() => {
+      sinon.createSandbox();
+      sinon.useFakeTimers(now.getTime());
+      cdl = new CallDiagnosticLatencies();
+    });
+
+    afterEach(() => {
+      sinon.restore();
+    })
+
+    it('should save timestamp correctly', () => {
+      assert.deepEqual(cdl.latencyTimestamps.size, 0);
+      cdl.saveTimestamp('client.alert.displayed');
+      assert.deepEqual(cdl.latencyTimestamps.size, 1);
+      assert.deepEqual(cdl.latencyTimestamps.get('client.alert.displayed'), now.getTime())
+    });
+
+    it('should update existing property and now add new keys', () => {
+      assert.deepEqual(cdl.latencyTimestamps.size, 0);
+      cdl.saveTimestamp('client.alert.displayed');
+      assert.deepEqual(cdl.latencyTimestamps.get('client.alert.displayed'), now.getTime());
+      cdl.saveTimestamp('client.alert.displayed', 1234);
+      assert.deepEqual(cdl.latencyTimestamps.get('client.alert.displayed'), 1234);
+      assert.deepEqual(cdl.latencyTimestamps.size, 1);
+
+    })
+
+    it('should clear all timestamps correctly', () => {
+      cdl.saveTimestamp('client.alert.displayed');
+      cdl.saveTimestamp('client.alert.removed');
+      assert.deepEqual(cdl.latencyTimestamps.size, 2);
+      cdl.clearTimestamps();
+      assert.deepEqual(cdl.latencyTimestamps.size, 0);
+    });
+
+    it('should calculate diff between timestamps correctly', () => {
+      cdl.saveTimestamp('client.alert.displayed', 10);
+      cdl.saveTimestamp('client.alert.removed', 20);
+      const res = cdl.getDiffBetweenTimestamps('client.alert.displayed', 'client.alert.removed');
+      assert.deepEqual(res, 10);
+    });
+
+    it('it returns undefined if either one is doesnt exist', () => {
+      cdl.saveTimestamp('client.alert.displayed', 10);
+      const res1 = cdl.getDiffBetweenTimestamps('client.alert.displayed', 'client.alert.removed');
+      assert.deepEqual(res1, undefined);
+      const res2 = cdl.getDiffBetweenTimestamps('client.alert.removed', 'client.alert.displayed');
+      assert.deepEqual(res2, undefined);
+    });
+
+    it('calculates getMeetingInfoReqResp correctly', () => {
+      cdl.saveTimestamp('internal.client.meetinginfo.request', 10);
+      cdl.saveTimestamp('internal.client.meetinginfo.response', 20);
+      assert.deepEqual(cdl.getMeetingInfoReqResp(), 10);
+    });
+
+    it('calculates getShowInterstitialTime correctly', () => {
+      cdl.saveTimestamp('internal.client.interstitial-window.launched', 10);
+      cdl.saveTimestamp('internal.client.interstitial-window.click.joinbutton', 20);
+      assert.deepEqual(cdl.getShowInterstitialTime(), 10);
+    });
+
+    it('calculates getCallInitJoinReq correctly', () => {
+      cdl.saveTimestamp('internal.client.meeting.click.joinbutton', 10);
+      cdl.saveTimestamp('client.locus.join.request', 20);
+      assert.deepEqual(cdl.getCallInitJoinReq(), 10);
+    });
+
+    it('calculates getJoinReqResp correctly', () => {
+      cdl.saveTimestamp('client.locus.join.request', 10);
+      cdl.saveTimestamp('client.locus.join.response', 20);
+      assert.deepEqual(cdl.getJoinReqResp(), 10);
+    });
+
+    it('calculates getLocalSDPGenRemoteSDPRecv correctly', () => {
+      cdl.saveTimestamp('client.media-engine.local-sdp-generated', 10);
+      cdl.saveTimestamp('client.media-engine.remote-sdp-received', 20);
+      assert.deepEqual(cdl.getLocalSDPGenRemoteSDPRecv(), 10);
+    });
+
+    it('calculates getICESetupTime correctly', () => {
+      cdl.saveTimestamp('client.ice.start', 10);
+      cdl.saveTimestamp('client.ice.end', 20);
+      assert.deepEqual(cdl.getICESetupTime(), 10);
+    });
+
+    it('calculates getAudioICESetupTime correctly', () => {
+      cdl.saveTimestamp('client.ice.start', 10);
+      cdl.saveTimestamp('client.ice.end', 20);
+      assert.deepEqual(cdl.getAudioICESetupTime(), 10);
+    });
+
+    it('calculates getVideoICESetupTime correctly', () => {
+      cdl.saveTimestamp('client.ice.start', 10);
+      cdl.saveTimestamp('client.ice.end', 20);
+      assert.deepEqual(cdl.getVideoICESetupTime(), 10);
+    });
+
+    it('calculates getShareICESetupTime correctly', () => {
+      cdl.saveTimestamp('client.ice.start', 10);
+      cdl.saveTimestamp('client.ice.end', 20);
+      assert.deepEqual(cdl.getShareICESetupTime(), 10);
+    });
+
+    it('calculates getStayLobbyTime correctly', () => {
+      cdl.saveTimestamp('client.locus.join.response', 10);
+      cdl.saveTimestamp('internal.host.meeting.participant.admitted', 20);
+      assert.deepEqual(cdl.getStayLobbyTime(), 10);
+    });
+
+    it('calculates getPageJMT correctly', () => {
+      cdl.saveTimestamp('internal.client.pageJMT.received', 10);
+      assert.deepEqual(cdl.getPageJMT(), 10);
+    });
+
+    it('calculates getClickToInterstitial correctly', () => {
+      cdl.saveTimestamp('internal.client.meeting.click.joinbutton', 10);
+      cdl.saveTimestamp('internal.client.meeting.interstitial-window.showed', 20);
+      assert.deepEqual(cdl.getClickToInterstitial(), 10);
+    });
+
+    it('calculates getInterstitialToJoinOK correctly', () => {
+      cdl.saveTimestamp('internal.client.meeting.click.joinbutton', 10);
+      cdl.saveTimestamp('client.locus.join.response', 20);
+      assert.deepEqual(cdl.getInterstitialToJoinOK(), 10);
+    });
+
+    it('calculates getInterstitialToMediaOK correctly', () => {
+      cdl.saveTimestamp('internal.client.meeting.click.joinbutton', 10);
+      cdl.saveTimestamp('sdk.media-flow.started', 20);
+      assert.deepEqual(cdl.getInterstitialToMediaOK(), 10);
+    });
+
+    it('calculates getTotalJMT correctly', () => {
+      cdl.saveTimestamp('internal.client.meeting.click.joinbutton', 10);
+      cdl.saveTimestamp('internal.client.meeting.interstitial-window.showed', 20);
+      cdl.saveTimestamp('client.locus.join.response', 40);
+      assert.deepEqual(cdl.getTotalJMT(), 40);
+    });
+
+    it('calculates getJoinConfJMT correctly', () => {
+      cdl.saveTimestamp('client.locus.join.request', 10);
+      cdl.saveTimestamp('client.locus.join.response', 20);
+      cdl.saveTimestamp('client.ice.start', 30);
+      cdl.saveTimestamp('client.ice.end', 40);
+      assert.deepEqual(cdl.getJoinConfJMT(), 20);
+    });
+
+    it('calculates getClientJMT correctly', () => {
+      cdl.saveTimestamp('internal.client.meeting.click.joinbutton', 5);
+      cdl.saveTimestamp('internal.client.meeting.interstitial-window.showed', 7)
+      cdl.saveTimestamp('client.locus.join.request', 10);
+      cdl.saveTimestamp('client.locus.join.response', 20);
+      cdl.saveTimestamp('client.ice.start', 30);
+      cdl.saveTimestamp('client.ice.end', 40);
+      assert.deepEqual(cdl.getClientJMT(), 35);
+    });
+
+    it('calculates getAudioJoinRespRxStart correctly', () => {
+      cdl.saveTimestamp('client.locus.join.response', 5);
+      cdl.saveTimestamp('client.media.rx.start', 7);
+      assert.deepEqual(cdl.getAudioJoinRespRxStart(), 2);
+    });
+
+    it('calculates getVideoJoinRespRxStart correctly', () => {
+      cdl.saveTimestamp('client.locus.join.response', 5);
+      cdl.saveTimestamp('client.media.rx.start', 7);
+      assert.deepEqual(cdl.getVideoJoinRespRxStart(), 2);
+    });
+
+    it('calculates getAudioJoinRespTxStart correctly', () => {
+      cdl.saveTimestamp('client.locus.join.response', 5);
+      cdl.saveTimestamp('client.media.tx.start', 7);
+      assert.deepEqual(cdl.getAudioJoinRespTxStart(), 2);
+    });
+
+    it('calculates getVideoJoinRespTxStart correctly', () => {
+      cdl.saveTimestamp('client.locus.join.response', 5);
+      cdl.saveTimestamp('client.media.tx.start', 7);
+      assert.deepEqual(cdl.getVideoJoinRespTxStart(), 2);
+    });
+
+    it('calculates getInterstitialToMediaOKJMT correctly', () => {
+      cdl.saveTimestamp('internal.client.interstitial-window.click.joinbutton', 5);
+      cdl.saveTimestamp('client.media-engine.ready', 7);
+      assert.deepEqual(cdl.getInterstitialToMediaOKJMT(), 2);
+    });
+  })
+})