@webex/internal-plugin-metrics 3.0.0-beta.3 → 3.0.0-beta.300

package/src/call-diagnostic-events-batcher.js

@@ -1,62 +0,0 @@
-/*!
- * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
- */
-
-import Batcher from './batcher';
-
-const CallDiagnosticEventsBatcher = Batcher.extend({
-  namespace: 'Metrics',
-
-  /**
-   * @param {string} webClientDomain
-   * @returns {string}
-  */
-  getBuildType(webClientDomain) {
-    if (
-      webClientDomain?.includes('teams.webex.com') ||
-      webClientDomain?.includes('localhost') ||
-      webClientDomain?.includes('127.0.0.1') ||
-      process.env.NODE_ENV !== 'production'
-    ) {
-      return 'test';
-    }
-
-    return process.env.NODE_ENV === 'production' ? 'prod' : 'test';
-  },
-
-  prepareItem(item) {
-    // networkType should be a enum value: `wifi`, `ethernet`, `cellular`, or `unknown`.
-    // Browsers cannot provide such information right now. However, it is a required field.
-    const origin = {
-      buildType: this.getBuildType(item.event?.eventData?.webClientDomain),
-      networkType: 'unknown'
-    };
-
-    item.eventPayload.origin = Object.assign(origin, item.eventPayload.origin);
-
-    return Promise.resolve(item);
-  },
-
-  prepareRequest(queue) {
-    // Add sent timestamp
-    queue.forEach((item) => {
-      item.eventPayload.originTime = item.eventPayload.originTime || {};
-      item.eventPayload.originTime.sent = new Date().toISOString();
-    });
-
-    return Promise.resolve(queue);
-  },
-
-  submitHttpRequest(payload) {
-    return this.webex.request({
-      method: 'POST',
-      service: 'metrics',
-      resource: 'clientmetrics',
-      body: {
-        metrics: payload
-      }
-    });
-  }
-});
-
-export default CallDiagnosticEventsBatcher;

package/src/index.js

@@ -1,17 +0,0 @@
-/*!
- * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
- */
-
-import '@webex/internal-plugin-device';
-
-import {registerInternalPlugin} from '@webex/webex-core';
-
-import Metrics from './metrics';
-import config from './config';
-
-registerInternalPlugin('metrics', Metrics, {
-  config
-});
-
-export {default} from './metrics';
-export {config};

package/test/unit/spec/call-diagnostic-events-batcher.js

@@ -1,180 +0,0 @@
-/*!
- * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
- */
-
-import {assert} from '@webex/test-helper-chai';
-import FakeTimers from '@sinonjs/fake-timers';
-import Metrics, {config} from '@webex/internal-plugin-metrics';
-import MockWebex from '@webex/test-helper-mock-webex';
-import sinon from 'sinon';
-import {WebexHttpError} from '@webex/webex-core';
-
-function promiseTick(count) {
-  let promise = Promise.resolve();
-
-  while (count > 1) {
-    promise = promise.then(() => promiseTick(1));
-    count -= 1;
-  }
-
-  return promise;
-}
-
-describe('plugin-metrics', () => {
-  describe('callDiagnosticEventsBatcher', () => {
-    let webex;
-
-    beforeEach(() => {
-      webex = new MockWebex({
-        children: {
-          metrics: Metrics
-        }
-      });
-
-      webex.config.metrics = config.metrics;
-
-      webex.request = function (options) {
-        return Promise.resolve({
-          statusCode: 204,
-          body: undefined,
-          options
-        });
-      };
-      sinon.spy(webex, 'request');
-    });
-
-    let clock;
-
-    beforeEach(() => {
-      clock = FakeTimers.install();
-    });
-
-    afterEach(() => {
-      clock.uninstall();
-    });
-
-    describe('#request()', () => {
-      describe('when the request completes successfully', () => {
-        it('clears the queue', () => {
-          clock.uninstall();
-
-          return webex.internal.metrics.callDiagnosticEventsBatcher.request({
-            type: 'diagnostic-event',
-            eventPayload: {
-              originTime: {
-                triggered: 'mock triggered timestamp'
-              }
-            }
-          })
-            .then(() => {
-              assert.calledOnce(webex.request);
-              assert.lengthOf(webex.internal.metrics.callDiagnosticEventsBatcher.queue, 0);
-            });
-        });
-      });
-
-      describe('when the request fails due to network disconnect', () => {
-        it('reenqueues the payload', () => {
-          // sinon appears to have gap in its api where stub.onCall(n) doesn't
-          // accept a function, so the following is more verbose than one might
-          // desire
-          webex.request = function () {
-            // noop
-          };
-          let count = 0;
-
-          sinon.stub(webex, 'request').callsFake((options) => {
-            options.headers = {
-              trackingid: count
-            };
-
-            count += 1;
-            if (count < 9) {
-              return Promise.reject(new WebexHttpError.NetworkOrCORSError({
-                statusCode: 0,
-                options
-              }));
-            }
-
-            return Promise.resolve({
-              statusCode: 204,
-              body: undefined,
-              options
-            });
-          });
-
-          const promise = webex.internal.metrics.callDiagnosticEventsBatcher.request({
-            type: 'diagnostic-event',
-            eventPayload: {
-              originTime: {
-                triggered: 'mock triggered timestamp'
-              }
-            }
-          });
-
-          return promiseTick(50)
-            .then(() => assert.lengthOf(webex.internal.metrics.callDiagnosticEventsBatcher.queue, 1))
-            .then(() => clock.tick(config.metrics.batcherWait))
-            .then(() => assert.calledOnce(webex.request))
-
-            .then(() => promiseTick(50))
-            .then(() => clock.tick(1000))
-            .then(() => promiseTick(50))
-            .then(() => clock.tick(config.metrics.batcherWait))
-            .then(() => assert.calledTwice(webex.request))
-
-            .then(() => promiseTick(50))
-            .then(() => clock.tick(2000))
-            .then(() => promiseTick(50))
-            .then(() => clock.tick(config.metrics.batcherWait))
-            .then(() => assert.calledThrice(webex.request))
-
-            .then(() => promiseTick(50))
-            .then(() => clock.tick(4000))
-            .then(() => promiseTick(50))
-            .then(() => clock.tick(config.metrics.batcherWait))
-            .then(() => assert.callCount(webex.request, 4))
-
-            .then(() => promiseTick(50))
-            .then(() => clock.tick(8000))
-            .then(() => promiseTick(50))
-            .then(() => clock.tick(config.metrics.batcherWait))
-            .then(() => assert.callCount(webex.request, 5))
-
-            .then(() => promiseTick(50))
-            .then(() => clock.tick(16000))
-            .then(() => promiseTick(50))
-            .then(() => clock.tick(config.metrics.batcherWait))
-            .then(() => assert.callCount(webex.request, 6))
-
-            .then(() => promiseTick(50))
-            .then(() => clock.tick(32000))
-            .then(() => promiseTick(50))
-            .then(() => clock.tick(config.metrics.batcherWait))
-            .then(() => assert.callCount(webex.request, 7))
-
-            .then(() => promiseTick(50))
-            .then(() => clock.tick(32000))
-            .then(() => promiseTick(50))
-            .then(() => clock.tick(config.metrics.batcherWait))
-            .then(() => assert.callCount(webex.request, 8))
-
-            .then(() => promiseTick(50))
-            .then(() => clock.tick(32000))
-            .then(() => promiseTick(50))
-            .then(() => clock.tick(config.metrics.batcherWait))
-            .then(() => assert.callCount(webex.request, 9))
-
-            .then(() => promiseTick(50))
-            .then(() => assert.lengthOf(webex.internal.metrics.callDiagnosticEventsBatcher.queue, 0))
-            .then(() => promise)
-            .then(() => {
-              assert.lengthOf(webex.request.args[1][0].body.metrics, 1, 'Reenqueuing the metric once did not increase the number of metrics to be submitted');
-              assert.lengthOf(webex.request.args[2][0].body.metrics, 1, 'Reenqueuing the metric twice did not increase the number of metrics to be submitted');
-              assert.lengthOf(webex.internal.metrics.callDiagnosticEventsBatcher.queue, 0);
-            });
-        });
-      });
-    });
-  });
-});