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

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')
+    });
+  });
+})

package/tsconfig.json

@@ -0,0 +1,6 @@
+{
+    "extends": "../../../tsconfig.json",
+    "include": [
+        "src"
+    ],
+}

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

@@ -1,60 +0,0 @@
-"use strict";
-
-var _Object$defineProperty = require("@babel/runtime-corejs2/core-js/object/define-property");
-var _interopRequireDefault = require("@babel/runtime-corejs2/helpers/interopRequireDefault");
-_Object$defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _assign = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/object/assign"));
-var _promise = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/promise"));
-var _batcher = _interopRequireDefault(require("./batcher"));
-/*!
- * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
- */
-
-var CallDiagnosticEventsBatcher = _batcher.default.extend({
-  namespace: 'Metrics',
-  /**
-   * @param {string} webClientDomain
-   * @returns {string}
-   */
-  getBuildType: function getBuildType(webClientDomain) {
-    if (webClientDomain !== null && webClientDomain !== void 0 && webClientDomain.includes('teams.webex.com') || webClientDomain !== null && webClientDomain !== void 0 && webClientDomain.includes('localhost') || webClientDomain !== null && webClientDomain !== void 0 && webClientDomain.includes('127.0.0.1') || process.env.NODE_ENV !== 'production') {
-      return 'test';
-    }
-    return process.env.NODE_ENV === 'production' ? 'prod' : 'test';
-  },
-  prepareItem: function prepareItem(item) {
-    var _item$event, _item$event$eventData;
-    // networkType should be a enum value: `wifi`, `ethernet`, `cellular`, or `unknown`.
-    // Browsers cannot provide such information right now. However, it is a required field.
-    var origin = {
-      buildType: this.getBuildType((_item$event = item.event) === null || _item$event === void 0 ? void 0 : (_item$event$eventData = _item$event.eventData) === null || _item$event$eventData === void 0 ? void 0 : _item$event$eventData.webClientDomain),
-      networkType: 'unknown'
-    };
-    item.eventPayload.origin = (0, _assign.default)(origin, item.eventPayload.origin);
-    return _promise.default.resolve(item);
-  },
-  prepareRequest: function prepareRequest(queue) {
-    // Add sent timestamp
-    queue.forEach(function (item) {
-      item.eventPayload.originTime = item.eventPayload.originTime || {};
-      item.eventPayload.originTime.sent = new Date().toISOString();
-    });
-    return _promise.default.resolve(queue);
-  },
-  submitHttpRequest: function submitHttpRequest(payload) {
-    return this.webex.request({
-      method: 'POST',
-      service: 'metrics',
-      resource: 'clientmetrics',
-      body: {
-        metrics: payload
-      }
-    });
-  }
-});
-var _default = CallDiagnosticEventsBatcher;
-exports.default = _default;
-//# sourceMappingURL=call-diagnostic-events-batcher.js.map

package/dist/call-diagnostic-events-batcher.js.map

@@ -1 +0,0 @@
-{"version":3,"names":["CallDiagnosticEventsBatcher","Batcher","extend","namespace","getBuildType","webClientDomain","includes","process","env","NODE_ENV","prepareItem","item","origin","buildType","event","eventData","networkType","eventPayload","resolve","prepareRequest","queue","forEach","originTime","sent","Date","toISOString","submitHttpRequest","payload","webex","request","method","service","resource","body","metrics"],"sources":["call-diagnostic-events-batcher.js"],"sourcesContent":["/*!\n * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.\n */\n\nimport Batcher from './batcher';\n\nconst CallDiagnosticEventsBatcher = Batcher.extend({\n  namespace: 'Metrics',\n\n  /**\n   * @param {string} webClientDomain\n   * @returns {string}\n   */\n  getBuildType(webClientDomain) {\n    if (\n      webClientDomain?.includes('teams.webex.com') ||\n      webClientDomain?.includes('localhost') ||\n      webClientDomain?.includes('127.0.0.1') ||\n      process.env.NODE_ENV !== 'production'\n    ) {\n      return 'test';\n    }\n\n    return process.env.NODE_ENV === 'production' ? 'prod' : 'test';\n  },\n\n  prepareItem(item) {\n    // networkType should be a enum value: `wifi`, `ethernet`, `cellular`, or `unknown`.\n    // Browsers cannot provide such information right now. However, it is a required field.\n    const origin = {\n      buildType: this.getBuildType(item.event?.eventData?.webClientDomain),\n      networkType: 'unknown',\n    };\n\n    item.eventPayload.origin = Object.assign(origin, item.eventPayload.origin);\n\n    return Promise.resolve(item);\n  },\n\n  prepareRequest(queue) {\n    // Add sent timestamp\n    queue.forEach((item) => {\n      item.eventPayload.originTime = item.eventPayload.originTime || {};\n      item.eventPayload.originTime.sent = new Date().toISOString();\n    });\n\n    return Promise.resolve(queue);\n  },\n\n  submitHttpRequest(payload) {\n    return this.webex.request({\n      method: 'POST',\n      service: 'metrics',\n      resource: 'clientmetrics',\n      body: {\n        metrics: payload,\n      },\n    });\n  },\n});\n\nexport default CallDiagnosticEventsBatcher;\n"],"mappings":";;;;;;;;;;AAIA;AAJA;AACA;AACA;;AAIA,IAAMA,2BAA2B,GAAGC,gBAAO,CAACC,MAAM,CAAC;EACjDC,SAAS,EAAE,SAAS;EAEpB;AACF;AACA;AACA;EACEC,YAAY,wBAACC,eAAe,EAAE;IAC5B,IACEA,eAAe,aAAfA,eAAe,eAAfA,eAAe,CAAEC,QAAQ,CAAC,iBAAiB,CAAC,IAC5CD,eAAe,aAAfA,eAAe,eAAfA,eAAe,CAAEC,QAAQ,CAAC,WAAW,CAAC,IACtCD,eAAe,aAAfA,eAAe,eAAfA,eAAe,CAAEC,QAAQ,CAAC,WAAW,CAAC,IACtCC,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,EACrC;MACA,OAAO,MAAM;IACf;IAEA,OAAOF,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,GAAG,MAAM,GAAG,MAAM;EAChE,CAAC;EAEDC,WAAW,uBAACC,IAAI,EAAE;IAAA;IAChB;IACA;IACA,IAAMC,MAAM,GAAG;MACbC,SAAS,EAAE,IAAI,CAACT,YAAY,gBAACO,IAAI,CAACG,KAAK,yEAAV,YAAYC,SAAS,0DAArB,sBAAuBV,eAAe,CAAC;MACpEW,WAAW,EAAE;IACf,CAAC;IAEDL,IAAI,CAACM,YAAY,CAACL,MAAM,GAAG,qBAAcA,MAAM,EAAED,IAAI,CAACM,YAAY,CAACL,MAAM,CAAC;IAE1E,OAAO,iBAAQM,OAAO,CAACP,IAAI,CAAC;EAC9B,CAAC;EAEDQ,cAAc,0BAACC,KAAK,EAAE;IACpB;IACAA,KAAK,CAACC,OAAO,CAAC,UAACV,IAAI,EAAK;MACtBA,IAAI,CAACM,YAAY,CAACK,UAAU,GAAGX,IAAI,CAACM,YAAY,CAACK,UAAU,IAAI,CAAC,CAAC;MACjEX,IAAI,CAACM,YAAY,CAACK,UAAU,CAACC,IAAI,GAAG,IAAIC,IAAI,EAAE,CAACC,WAAW,EAAE;IAC9D,CAAC,CAAC;IAEF,OAAO,iBAAQP,OAAO,CAACE,KAAK,CAAC;EAC/B,CAAC;EAEDM,iBAAiB,6BAACC,OAAO,EAAE;IACzB,OAAO,IAAI,CAACC,KAAK,CAACC,OAAO,CAAC;MACxBC,MAAM,EAAE,MAAM;MACdC,OAAO,EAAE,SAAS;MAClBC,QAAQ,EAAE,eAAe;MACzBC,IAAI,EAAE;QACJC,OAAO,EAAEP;MACX;IACF,CAAC,CAAC;EACJ;AACF,CAAC,CAAC;AAAC,eAEY3B,2BAA2B;AAAA"}

package/dist/internal-plugin-metrics.d.ts

@@ -1,21 +0,0 @@
-export declare namespace config {
-    export namespace device {
-        export namespace preDiscoveryServices {
-            const metricsServiceUrl: string;
-            const metrics: string;
-        }
-    }
-    export namespace metrics_1 {
-        const appType: string;
-        const batcherWait: number;
-        const batcherMaxCalls: number;
-        const batcherMaxWait: number;
-        const batcherRetryPlateau: number;
-    }
-        { metrics_1 as metrics };
-}
-
-declare const Metrics: any;
-export default Metrics;
-
-export { }

package/dist/tsdoc-metadata.json

@@ -1,11 +0,0 @@
-// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
-// It should be published with your NPM package.  It should not be tracked by Git.
-{
-  "tsdocVersion": "0.12",
-  "toolPackages": [
-    {
-      "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.34.4"
-    }
-  ]
-}

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, getOSNameInternal} from './metrics';
-export {config};

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

@@ -1,195 +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);
-            });
-        });
-      });
-    });
-  });
-});

package/dist/types/{call-diagnostic-events-batcher.d.ts → call-diagnostic/call-diagnostic-metrics-batcher.d.ts}

@@ -1,2 +1,2 @@
-export default CallDiagnosticEventsBatcher;
 declare const CallDiagnosticEventsBatcher: any;
+export default CallDiagnosticEventsBatcher;