@webex/internal-plugin-metrics 3.0.0-bnr.5 → 3.0.0

package/test/unit/spec/metrics.js

@@ -8,7 +8,12 @@ import {Token, Credentials} from '@webex/webex-core';
 import FakeTimers from '@sinonjs/fake-timers';
 import sinon from 'sinon';
 import Metrics, {config} from '@webex/internal-plugin-metrics';
+import {BrowserDetection} from '@webex/common';
 
+const {getOSVersion} = BrowserDetection();
+
+//@ts-ignore
+global.window = {location: {hostname: 'whatever'}};
 function promiseTick(count) {
   let promise = Promise.resolve();
 
@@ -82,6 +87,7 @@ describe('plugin-metrics', () => {
         return Promise.resolve({
           statusCode: 204,
           body: undefined,
+          waitForServiceTimeout: 30,
           options,
         });
       };
@@ -89,7 +95,7 @@ describe('plugin-metrics', () => {
       webex.credentials = new Credentials(undefined, {parent: webex});
       sinon.stub(webex.credentials, 'getClientToken').returns(Promise.resolve('token'));
 
-      webex.internal = {...webex.internal, device: {userId: 'userId'}};
+      webex.internal = {...webex.internal};
       webex.config = {
         ...webex.config,
         appName: 'appName',
@@ -102,7 +108,6 @@ describe('plugin-metrics', () => {
       sinon.spy(webex, 'request');
       sinon.spy(metrics, 'postPreLoginMetric');
       sinon.spy(metrics, 'aliasUser');
-      sinon.spy(metrics, 'submitCallDiagnosticEvents');
     });
 
     describe('#submit()', () => {
@@ -131,6 +136,67 @@ describe('plugin-metrics', () => {
       });
     });
 
+    describe('#getClientMetricsPayload()', () => {
+      it('returns the expected payload', () => {
+        webex.credentials.supertoken = new Token(
+          {
+            access_token: 'a_b_orgid',
+          },
+          {parent: webex}
+        );
+
+        const testPayload = {
+          tags: {success: true},
+          fields: {perceivedDurationInMillis: 314},
+          context: {},
+          eventPayload: {value: 'splunk business metric payload'},
+        };
+        const date = clock.now;
+
+        const result = metrics.getClientMetricsPayload('test', testPayload);
+
+        assert.deepEqual(result, {
+          context: {
+            app: {
+              version: undefined,
+            },
+            locale: 'en-US',
+            os: {
+              name: 'other',
+              version: getOSVersion(),
+            },
+          },
+          eventPayload: {
+            value: 'splunk business metric payload',
+          },
+          fields: {
+            browser_version: '',
+            client_id: 'fake',
+            os_version: getOSVersion(),
+            perceivedDurationInMillis: 314,
+            platform: 'Web',
+            sdk_version: undefined,
+            spark_user_agent: 'webex-js-sdk appName/appVersion appPlatform',
+          },
+          metricName: 'test',
+          tags: {
+            browser: '',
+            domain: 'whatever',
+            os: 'other',
+            success: true,
+          },
+          timestamp: 0,
+          type: ['operational'],
+        });
+      });
+
+      it('throws when no event name is specified', () => {
+        assert.throws(() => {
+          metrics.getClientMetricsPayload();
+        }, 'Missing behavioral metric name. Please provide one');
+      });
+    });
+
     describe('#submitClientMetrics()', () => {
       describe('before login', () => {
         it('posts pre-login metric', () => {
@@ -267,98 +333,5 @@ describe('plugin-metrics', () => {
           assert.match(params, {alias: true});
         }));
     });
-
-    describe('#submitCallDiagnosticEvents()', () => {
-      it('submits a call diagnostic event', () => {
-        const promise = metrics.submitCallDiagnosticEvents(mockCallDiagnosticEvent);
-
-        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];
-
-            assert.property(metric.eventPayload, 'origin');
-            assert.property(metric.eventPayload, 'originTime');
-            assert.property(metric.eventPayload.origin, 'buildType');
-            assert.property(metric.eventPayload.origin, 'networkType');
-            assert.property(metric.eventPayload.originTime, 'sent');
-            assert.equal(metric.eventPayload.origin.buildType, 'test');
-          });
-      });
-
-      it('submits a call diagnostic event with buildType set in the payload', () => {
-        const promise = metrics.submitCallDiagnosticEvents({
-          ...mockCallDiagnosticEvent,
-          origin: {
-            buildType: 'prod',
-          },
-        });
-
-        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];
-
-            assert.property(metric.eventPayload, 'origin');
-            assert.property(metric.eventPayload, 'originTime');
-            assert.property(metric.eventPayload.origin, 'buildType');
-            assert.property(metric.eventPayload.origin, 'networkType');
-            assert.property(metric.eventPayload.originTime, 'sent');
-            assert.equal(metric.eventPayload.origin.buildType, 'prod');
-          });
-      });
-
-      xit('submits a call diagnostic event with a test domain', () => {
-        global.window.location.hostname = 'test.webex.com';
-
-        const promise = metrics.submitCallDiagnosticEvents(mockCallDiagnosticEvent);
-
-        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];
-
-            assert.property(metric.eventPayload, 'origin');
-            assert.property(metric.eventPayload, 'originTime');
-            assert.property(metric.eventPayload.origin, 'buildType');
-            assert.property(metric.eventPayload.origin, 'networkType');
-            assert.property(metric.eventPayload.originTime, 'sent');
-            assert.equal(metric.eventPayload.origin.buildType, 'test');
-          });
-      });
-
-      // Skip because it's current unable to overwrite NODE_ENV
-      // However doing `NODE_ENV=test npm run test ...` will get this test case to pass
-      xit('submits a call diagnostic event with a NODE_ENV=production', () => {
-        process.env.NODE_ENV = 'production';
-
-        const promise = metrics.submitCallDiagnosticEvents(mockCallDiagnosticEvent);
-
-        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];
-
-            assert.property(metric.eventPayload, 'origin');
-            assert.property(metric.eventPayload, 'originTime');
-            assert.property(metric.eventPayload.origin, 'buildType');
-            assert.property(metric.eventPayload.origin, 'networkType');
-            assert.property(metric.eventPayload.originTime, 'sent');
-            assert.equal(metric.eventPayload.origin.buildType, 'prod');
-          });
-      });
-    });
   });
 });

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

@@ -0,0 +1,233 @@
+import {assert} from '@webex/test-helper-chai';
+import {NewMetrics} from '@webex/internal-plugin-metrics';
+import MockWebex from '@webex/test-helper-mock-webex';
+import sinon from 'sinon';
+import {Utils} from '@webex/internal-plugin-metrics';
+
+describe('internal-plugin-metrics', () => {
+
+  describe('check submitClientEvent when webex is not ready', () => {
+    let webex;
+    //@ts-ignore
+    webex = new MockWebex({
+      children: {
+        newMetrics: NewMetrics,
+      },
+      meetings: {
+        meetingCollection: {
+          get: sinon.stub(),
+        },
+      },
+      request: sinon.stub().resolves({}),
+      logger: {
+        log: sinon.stub(),
+        error: sinon.stub(),
+      }
+    });
+
+    it('checks the log', () => {
+      webex.internal.newMetrics.submitClientEvent({
+        name: 'client.alert.displayed',
+        options: {
+          meetingId: '123',
+        },
+      });
+      assert.calledWith(
+        webex.logger.log,
+        'NewMetrics: @submitClientEvent. Attempted to submit before webex.ready. Event name: client.alert.displayed'
+      );
+    });
+  });
+  describe('new-metrics', () => {
+    let webex;
+
+    beforeEach(() => {
+      //@ts-ignore
+      webex = new MockWebex({
+        children: {
+          newMetrics: NewMetrics,
+        },
+        meetings: {
+          meetingCollection: {
+            get: sinon.stub(),
+          },
+        },
+        request: sinon.stub().resolves({}),
+        logger: {
+          log: sinon.stub(),
+          error: sinon.stub(),
+        }
+      });
+
+      webex.emit('ready');
+
+      webex.internal.newMetrics.callDiagnosticLatencies.saveTimestamp = sinon.stub();
+      webex.internal.newMetrics.callDiagnosticLatencies.clearTimestamps = sinon.stub();
+      webex.internal.newMetrics.callDiagnosticMetrics.submitClientEvent = sinon.stub();
+      webex.internal.newMetrics.callDiagnosticMetrics.submitMQE = sinon.stub();
+      webex.internal.newMetrics.callDiagnosticMetrics.clientMetricsAliasUser = sinon.stub();
+      webex.internal.newMetrics.callDiagnosticMetrics.buildClientEventFetchRequestOptions =
+        sinon.stub();
+      webex.setTimingsAndFetch = sinon.stub();
+    });
+
+    afterEach(() => {
+      sinon.restore();
+    })
+
+    it('submits Client Event successfully', () => {
+      webex.internal.newMetrics.submitClientEvent({
+        name: 'client.alert.displayed',
+        options: {
+          meetingId: '123',
+        },
+      });
+
+      assert.calledWith(webex.internal.newMetrics.callDiagnosticLatencies.saveTimestamp, {
+        key: 'client.alert.displayed',
+        options: {meetingId: '123'},
+      });
+      assert.calledWith(webex.internal.newMetrics.callDiagnosticMetrics.submitClientEvent, {
+        name: 'client.alert.displayed',
+        payload: undefined,
+        options: {meetingId: '123'},
+      });
+    });
+
+
+    it('submits MQE successfully', () => {
+      webex.internal.newMetrics.submitMQE({
+        name: 'client.mediaquality.event',
+        //@ts-ignore
+        payload: {intervals: [{}]},
+        options: {
+          meetingId: '123',
+          networkType: 'wifi',
+        },
+      });
+
+      assert.calledWith(webex.internal.newMetrics.callDiagnosticLatencies.saveTimestamp, {
+        key: 'client.mediaquality.event',
+      });
+      assert.calledWith(webex.internal.newMetrics.callDiagnosticMetrics.submitMQE, {
+        name: 'client.mediaquality.event',
+        //@ts-ignore
+        payload: {intervals: [{}]},
+        options: {
+          meetingId: '123',
+          networkType: 'wifi',
+        },
+      });
+    });
+
+    it('submits Internal Event successfully', () => {
+      webex.internal.newMetrics.submitInternalEvent({
+        name: 'client.mediaquality.event',
+      });
+
+      assert.calledWith(webex.internal.newMetrics.callDiagnosticLatencies.saveTimestamp, {
+        key: 'client.mediaquality.event',
+      });
+      assert.notCalled(webex.internal.newMetrics.callDiagnosticLatencies.clearTimestamps);
+    });
+
+    it('submits Internal Event successfully for clearing the join latencies', () => {
+      webex.internal.newMetrics.submitInternalEvent({
+        name: 'internal.reset.join.latencies',
+      });
+
+      assert.notCalled(webex.internal.newMetrics.callDiagnosticLatencies.saveTimestamp);
+      assert.calledOnce(webex.internal.newMetrics.callDiagnosticLatencies.clearTimestamps);
+    });
+
+    describe('#clientMetricsAliasUser', () => {
+      it('aliases the user correctly', async () => {
+        webex.request.resolves({response: 'abc'});
+        await webex.internal.newMetrics.clientMetricsAliasUser('my-id');
+        assert.calledWith(webex.request, {
+          method: 'POST',
+          api: 'metrics',
+          resource: 'clientmetrics',
+          headers: { 'x-prelogin-userid': 'my-id' },
+          body: {},
+          qs: { alias: true },
+        });
+        assert.calledWith(
+          webex.logger.log,
+          'NewMetrics: @clientMetricsAliasUser. Request successful.'
+        );
+      });
+
+      it('handles failed request correctly', async () => {
+        webex.request.rejects(new Error("test error"));
+        sinon.stub(Utils, 'generateCommonErrorMetadata').returns('formattedError')
+        try {
+          await webex.internal.newMetrics.clientMetricsAliasUser({event: 'test'}, 'my-id');
+        } catch (err) {
+          assert.calledWith(
+            webex.logger.error,
+            'NewMetrics: @clientMetricsAliasUser. Request failed:',
+            `err: formattedError`
+          );
+        }
+      });
+    });
+
+    describe('#buildClientEventFetchRequestOptions', () => {
+      it('builds client event fetch options successfully', () => {
+        webex.internal.newMetrics.buildClientEventFetchRequestOptions({
+          name: 'client.alert.displayed',
+          options: {
+            meetingId: '123',
+          },
+        });
+
+        assert.calledWith(
+          webex.internal.newMetrics.callDiagnosticMetrics.buildClientEventFetchRequestOptions,
+          {
+            name: 'client.alert.displayed',
+            payload: undefined,
+            options: {meetingId: '123'},
+          }
+        );
+      });
+    });
+
+    describe('#setMetricTimingsAndFetch', () => {
+      beforeEach(() => {
+        global.fetch = sinon.stub();
+      });
+
+      it('calls fetch with the expected options', () => {
+        const now = new Date();
+        sinon.useFakeTimers(now.getTime());
+
+        webex.internal.newMetrics.setMetricTimingsAndFetch({
+          json: true,
+          body: JSON.stringify({metrics: [{eventPayload: {}}]}),
+        });
+
+        const expected = {
+          json: true,
+          body: JSON.stringify({
+            metrics: [
+              {
+                eventPayload: {
+                  originTime: {
+                    triggered: now.toISOString(),
+                    sent: now.toISOString(),
+                  },
+                },
+              },
+            ],
+          }),
+        };
+
+        sinon.assert.calledOnce(webex.setTimingsAndFetch);
+        sinon.assert.calledWith(webex.setTimingsAndFetch, expected);
+
+        sinon.restore();
+      });
+    });
+  });
+});

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

@@ -0,0 +1,250 @@
+/*!
+ * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
+ */
+
+import {assert} from '@webex/test-helper-chai';
+import {config, Utils} from '@webex/internal-plugin-metrics';
+import {CallDiagnosticUtils} from '@webex/internal-plugin-metrics';
+import MockWebex from '@webex/test-helper-mock-webex';
+import sinon from 'sinon';
+import FakeTimers from '@sinonjs/fake-timers';
+import {NewMetrics} from '@webex/internal-plugin-metrics';
+import {uniqueId} from 'lodash';
+
+const flushPromises = () => new Promise(setImmediate);
+
+describe('internal-plugin-metrics', () => {
+  describe('PreLoginMetricsBatcher', () => {
+    let webex;
+    let clock;
+    let now;
+
+    const preLoginId = 'my_prelogin_id';
+
+    beforeEach(() => {
+      now = new Date();
+      clock = FakeTimers.install({now});
+
+      //@ts-ignore
+      webex = new MockWebex({
+        children: {
+          newMetrics: NewMetrics,
+        },
+      });
+
+      webex.request = (options) =>
+        Promise.resolve({body: {items: []}, waitForServiceTimeout: 15, options});
+
+      sinon.spy(webex, 'request');
+      webex.emit('ready');
+      webex.config.metrics = config.metrics;
+    });
+
+    afterEach(() => {
+      sinon.restore();
+      clock.uninstall();
+    });
+
+    describe('#request()', () => {
+      it('when the request completes successfully, clears the queue', async () => {
+        const promise =
+          webex.internal.newMetrics.callDiagnosticMetrics.submitToCallDiagnosticsPreLogin(
+            //@ts-ignore
+            {event: {name: 'client.interstitial-window.launched'}},
+            preLoginId
+          );
+        await flushPromises();
+        clock.tick(config.metrics.batcherWait);
+
+        await promise;
+
+        const webexRequestArgs = webex.request.args[0][0];
+
+        const dateAfterBatcherWait = new Date(now.getTime() + config.metrics.batcherWait);
+        //@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, {
+          body: {
+            metrics: [
+              {
+                eventPayload: {
+                  event: {
+                    joinTimes: {
+                      meetingInfoReqResp: undefined,
+                      clickToInterstitial: undefined,
+                    },
+                    name: 'client.interstitial-window.launched',
+                  },
+                  origin: {
+                    buildType: 'test',
+                    networkType: 'unknown',
+                  },
+                  originTime: {
+                    sent: dateAfterBatcherWait.toISOString(),
+                  },
+                },
+                type: ['diagnostic-event'],
+              },
+            ],
+          },
+          headers: {
+            authorization: false,
+            'x-prelogin-userid': preLoginId,
+          },
+          method: 'POST',
+          resource: 'clientmetrics-prelogin',
+          service: 'metrics',
+          waitForServiceTimeout: 30,
+        });
+        assert.lengthOf(
+          webex.internal.newMetrics.callDiagnosticMetrics.preLoginMetricsBatcher.queue,
+          0
+        );
+      });
+
+      it('when the request fails, does not clear the queue', async () => {
+        webex.request = sinon.stub().rejects(new Error('my_error'));
+
+        webex.logger.error = sinon.stub();
+        webex.logger.log = sinon.stub();
+        sinon.stub(Utils, 'generateCommonErrorMetadata').returns('formattedError');
+
+        const promise =
+          webex.internal.newMetrics.callDiagnosticMetrics.submitToCallDiagnosticsPreLogin(
+            {
+              event: 'my.event',
+            },
+            preLoginId
+          );
+
+        await flushPromises();
+        clock.tick(config.metrics.batcherWait);
+
+        let error;
+
+        // catch the expected error and store it
+        try {
+          await promise;
+        } catch (err) {
+          error = err;
+        }
+
+        // This is horrific, but stubbing lodash is proving difficult
+        const expectedBatchId = parseInt(uniqueId()) - 1;
+
+        assert.equal(error.message, 'my_error');
+        assert.calledOnceWithExactly(
+          webex.logger.error,
+          'Pre Login Metrics -->',
+          `PreLoginMetricsBatcher: @submitHttpRequest#prelogin-ca-batch-${expectedBatchId}. Request failed:`,
+          `error: formattedError`
+        );
+        assert.lengthOf(
+          webex.internal.newMetrics.callDiagnosticMetrics.preLoginMetricsBatcher.queue,
+          0
+        );
+      });
+
+      it('fails if preLoinId is not set', async () => {
+        webex.internal.newMetrics.callDiagnosticMetrics.preLoginMetricsBatcher.preLoginId = undefined;
+
+        const promise =
+          webex.internal.newMetrics.callDiagnosticMetrics.submitToCallDiagnosticsPreLogin(
+            {
+              event: 'my.event',
+            },
+            undefined
+          );
+
+        await flushPromises();
+        clock.tick(config.metrics.batcherWait);
+
+        let error;
+
+        // catch the expected error and store it
+        try {
+          await promise;
+        } catch (err) {
+          error = err;
+        }
+
+        assert.equal(error.message, 'PreLoginId is not set.');
+      });
+    });
+
+    describe('prepareItem', () => {
+      it('calls prepareDiagnosticMetricItem correctly', async () => {
+         // avoid setting .sent timestamp
+        webex.internal.newMetrics.callDiagnosticMetrics.preLoginMetricsBatcher.prepareRequest = (q) =>
+          Promise.resolve(q);
+
+        const prepareItemSpy = sinon.spy(
+          webex.internal.newMetrics.callDiagnosticMetrics.preLoginMetricsBatcher,
+          'prepareItem'
+        );
+        const prepareDiagnosticMetricItemSpy = sinon.spy(
+          CallDiagnosticUtils,
+          'prepareDiagnosticMetricItem'
+        );
+
+        const promise =
+          webex.internal.newMetrics.callDiagnosticMetrics.submitToCallDiagnosticsPreLogin(
+            {
+              event: 'my.event',
+            },
+            preLoginId
+          );
+
+        await flushPromises();
+
+        clock.tick(config.metrics.batcherWait);
+
+        await promise;
+
+        const calls = prepareItemSpy.getCalls()[0];
+
+        // item also gets assigned a delay property but the key is a Symbol and haven't been able to test that..
+        assert.deepEqual(calls.args[0].eventPayload, {
+          event: 'my.event',
+          origin: {buildType: 'test', networkType: 'unknown'},
+        });
+
+        assert.deepEqual(calls.args[0].type, ['diagnostic-event']);
+
+        const prepareDiagnosticMetricItemCalls = prepareDiagnosticMetricItemSpy.getCalls();
+
+        // second argument (item) also gets assigned a delay property but the key is a Symbol and haven't been able to test that..
+        assert.deepEqual(prepareDiagnosticMetricItemCalls[0].args[0], webex);
+        assert.deepEqual(prepareDiagnosticMetricItemCalls[0].args[1].eventPayload, {
+          event: 'my.event',
+          origin: {
+            buildType: 'test',
+            networkType: 'unknown',
+          },
+        });
+        assert.deepEqual(prepareDiagnosticMetricItemCalls[0].args[1].type, ['diagnostic-event']);
+      });
+    });
+
+    describe('savePreLoginId', () => {
+      it('saves the preLoginId', () => {
+        const preLoginId = 'my_prelogin_id';
+
+        assert.isUndefined(
+          webex.internal.newMetrics.callDiagnosticMetrics.preLoginMetricsBatcher.preLoginId
+        );
+
+        webex.internal.newMetrics.callDiagnosticMetrics.preLoginMetricsBatcher.savePreLoginId(
+          preLoginId
+        );
+
+        assert.equal(
+          webex.internal.newMetrics.callDiagnosticMetrics.preLoginMetricsBatcher.preLoginId,
+          preLoginId
+        );
+      });
+    });
+  });
+});

package/test/unit/spec/utils.ts

@@ -0,0 +1,22 @@
+import {assert} from '@webex/test-helper-chai';
+import {Utils} from '@webex/internal-plugin-metrics';
+
+describe('internal-plugin-metrics', () => {
+  describe('generateCommonErrorMetadata', () => {
+    it('should return JSON stringified error object', () => {
+      const error = new Error('test error');
+      const result = Utils.generateCommonErrorMetadata(error);
+      assert.deepEqual(result, JSON.stringify({
+        message: 'test error',
+        name: 'Error',
+        stack: error.stack
+      }))
+    });
+
+    it('should return error if not instanceof Error', () => {
+      const error = 'test error';
+      const result = Utils.generateCommonErrorMetadata(error);
+     assert.deepEqual(result, 'test error')
+    });
+  });
+})