@webex/internal-plugin-metrics 1.144.2 → 1.146.1

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

@@ -21,11 +21,25 @@ var _batcher = _interopRequireDefault(require("./batcher"));
  */
 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: process.env.NODE_ENV === 'production' ? 'prod' : 'test',
+      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);

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

@@ -1 +1 @@
-{"version":3,"sources":["call-diagnostic-events-batcher.js"],"names":["CallDiagnosticEventsBatcher","Batcher","extend","namespace","prepareItem","item","origin","buildType","process","env","NODE_ENV","networkType","eventPayload","resolve","prepareRequest","queue","forEach","originTime","sent","Date","toISOString","submitHttpRequest","payload","webex","request","method","service","resource","body","metrics"],"mappings":";;;;;;;;;;;;;;;;AAIA;;AAJA;AACA;AACA;AAIA,IAAMA,2BAA2B,GAAGC,iBAAQC,MAAR,CAAe;AACjDC,EAAAA,SAAS,EAAE,SADsC;AAGjDC,EAAAA,WAHiD,uBAGrCC,IAHqC,EAG/B;AAChB;AACA;AACA,QAAMC,MAAM,GAAG;AACbC,MAAAA,SAAS,EAAEC,OAAO,CAACC,GAAR,CAAYC,QAAZ,KAAyB,YAAzB,GAAwC,MAAxC,GAAiD,MAD/C;AAEbC,MAAAA,WAAW,EAAE;AAFA,KAAf;AAKAN,IAAAA,IAAI,CAACO,YAAL,CAAkBN,MAAlB,GAA2B,qBAAcA,MAAd,EAAsBD,IAAI,CAACO,YAAL,CAAkBN,MAAxC,CAA3B;AAEA,WAAO,iBAAQO,OAAR,CAAgBR,IAAhB,CAAP;AACD,GAdgD;AAgBjDS,EAAAA,cAhBiD,0BAgBlCC,KAhBkC,EAgB3B;AACpB;AACAA,IAAAA,KAAK,CAACC,OAAN,CAAc,UAACX,IAAD,EAAU;AACtBA,MAAAA,IAAI,CAACO,YAAL,CAAkBK,UAAlB,GAA+BZ,IAAI,CAACO,YAAL,CAAkBK,UAAlB,IAAgC,EAA/D;AACAZ,MAAAA,IAAI,CAACO,YAAL,CAAkBK,UAAlB,CAA6BC,IAA7B,GAAoC,IAAIC,IAAJ,GAAWC,WAAX,EAApC;AACD,KAHD;AAKA,WAAO,iBAAQP,OAAR,CAAgBE,KAAhB,CAAP;AACD,GAxBgD;AA0BjDM,EAAAA,iBA1BiD,6BA0B/BC,OA1B+B,EA0BtB;AACzB,WAAO,KAAKC,KAAL,CAAWC,OAAX,CAAmB;AACxBC,MAAAA,MAAM,EAAE,MADgB;AAExBC,MAAAA,OAAO,EAAE,SAFe;AAGxBC,MAAAA,QAAQ,EAAE,eAHc;AAIxBC,MAAAA,IAAI,EAAE;AACJC,QAAAA,OAAO,EAAEP;AADL;AAJkB,KAAnB,CAAP;AAQD;AAnCgD,CAAf,CAApC;;eAsCetB,2B","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  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: process.env.NODE_ENV === 'production' ? 'prod' : 'test',\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"]}
+{"version":3,"sources":["call-diagnostic-events-batcher.js"],"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"],"mappings":";;;;;;;;;;;;;;;;AAIA;;AAJA;AACA;AACA;AAIA,IAAMA,2BAA2B,GAAGC,iBAAQC,MAAR,CAAe;AACjDC,EAAAA,SAAS,EAAE,SADsC;;AAGjD;AACF;AACA;AACA;AACEC,EAAAA,YAPiD,wBAOpCC,eAPoC,EAOnB;AAC5B,QACEA,eAAe,SAAf,IAAAA,eAAe,WAAf,IAAAA,eAAe,CAAEC,QAAjB,CAA0B,iBAA1B,KACAD,eADA,aACAA,eADA,eACAA,eAAe,CAAEC,QAAjB,CAA0B,WAA1B,CADA,IAEAD,eAFA,aAEAA,eAFA,eAEAA,eAAe,CAAEC,QAAjB,CAA0B,WAA1B,CAFA,IAGAC,OAAO,CAACC,GAAR,CAAYC,QAAZ,KAAyB,YAJ3B,EAKE;AACA,aAAO,MAAP;AACD;;AAED,WAAOF,OAAO,CAACC,GAAR,CAAYC,QAAZ,KAAyB,YAAzB,GAAwC,MAAxC,GAAiD,MAAxD;AACD,GAlBgD;AAoBjDC,EAAAA,WApBiD,uBAoBrCC,IApBqC,EAoB/B;AAAA;;AAChB;AACA;AACA,QAAMC,MAAM,GAAG;AACbC,MAAAA,SAAS,EAAE,KAAKT,YAAL,gBAAkBO,IAAI,CAACG,KAAvB,yEAAkB,YAAYC,SAA9B,0DAAkB,sBAAuBV,eAAzC,CADE;AAEbW,MAAAA,WAAW,EAAE;AAFA,KAAf;AAKAL,IAAAA,IAAI,CAACM,YAAL,CAAkBL,MAAlB,GAA2B,qBAAcA,MAAd,EAAsBD,IAAI,CAACM,YAAL,CAAkBL,MAAxC,CAA3B;AAEA,WAAO,iBAAQM,OAAR,CAAgBP,IAAhB,CAAP;AACD,GA/BgD;AAiCjDQ,EAAAA,cAjCiD,0BAiClCC,KAjCkC,EAiC3B;AACpB;AACAA,IAAAA,KAAK,CAACC,OAAN,CAAc,UAACV,IAAD,EAAU;AACtBA,MAAAA,IAAI,CAACM,YAAL,CAAkBK,UAAlB,GAA+BX,IAAI,CAACM,YAAL,CAAkBK,UAAlB,IAAgC,EAA/D;AACAX,MAAAA,IAAI,CAACM,YAAL,CAAkBK,UAAlB,CAA6BC,IAA7B,GAAoC,IAAIC,IAAJ,GAAWC,WAAX,EAApC;AACD,KAHD;AAKA,WAAO,iBAAQP,OAAR,CAAgBE,KAAhB,CAAP;AACD,GAzCgD;AA2CjDM,EAAAA,iBA3CiD,6BA2C/BC,OA3C+B,EA2CtB;AACzB,WAAO,KAAKC,KAAL,CAAWC,OAAX,CAAmB;AACxBC,MAAAA,MAAM,EAAE,MADgB;AAExBC,MAAAA,OAAO,EAAE,SAFe;AAGxBC,MAAAA,QAAQ,EAAE,eAHc;AAIxBC,MAAAA,IAAI,EAAE;AACJC,QAAAA,OAAO,EAAEP;AADL;AAJkB,KAAnB,CAAP;AAQD;AApDgD,CAAf,CAApC;;eAuDe3B,2B","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"]}

package/dist/metrics.js

@@ -135,7 +135,7 @@ var Metrics = _webexCore.WebexPlugin.extend((_dec = (0, _common.deprecated)('Met
     };
     return this.callDiagnosticEventsBatcher.request(event);
   },
-  version: "1.144.2"
+  version: "1.146.1"
 }, ((0, _applyDecoratedDescriptor2.default)(_obj, "sendUnstructured", [_dec], (0, _getOwnPropertyDescriptor.default)(_obj, "sendUnstructured"), _obj)), _obj)));
 
 var _default = Metrics;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webex/internal-plugin-metrics",
-  "version": "1.144.2",
+  "version": "1.146.1",
   "description": "",
   "license": "MIT",
   "author": "Ian W. Remmel <iremmel@cisco.com>",
@@ -17,10 +17,10 @@
   },
   "dependencies": {
     "@babel/runtime-corejs2": "^7.14.8",
-    "@webex/internal-plugin-device": "1.144.2",
-    "@webex/webex-core": "1.144.2",
-    "@webex/common": "1.144.2",
-    "@webex/common-timers": "1.144.2",
+    "@webex/internal-plugin-device": "1.146.1",
+    "@webex/webex-core": "1.146.1",
+    "@webex/common": "1.146.1",
+    "@webex/common-timers": "1.146.1",
     "envify": "^4.1.0"
   }
 }

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

@@ -7,11 +7,28 @@ 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: process.env.NODE_ENV === 'production' ? 'prod' : 'test',
+      buildType: this.getBuildType(item.event?.eventData?.webClientDomain),
       networkType: 'unknown'
     };
 

package/test/unit/spec/metrics.js

@@ -239,6 +239,78 @@ describe('plugin-metrics', () => {
             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');
           });
       });
     });