@webex/internal-plugin-metrics 3.8.1 → 3.9.0

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

@@ -327,6 +327,7 @@ describe('internal-plugin-metrics', () => {
         {
           joinTimes: {
             downloadTime: undefined,
+            pageJmt: undefined,
           },
         },
       ],
@@ -338,6 +339,7 @@ describe('internal-plugin-metrics', () => {
             meetingInfoReqResp: undefined,
             refreshCaptchaServiceReqResp: undefined,
             downloadIntelligenceModelsReqResp: undefined,
+            clickToInterstitialWithUserDelay: undefined,
           },
         },
       ],
@@ -366,6 +368,8 @@ describe('internal-plugin-metrics', () => {
             totalJmt: undefined,
             clientJmt: undefined,
             downloadTime: undefined,
+            clickToInterstitialWithUserDelay:   undefined,
+            totalJMTWithUserDelay: undefined,
           },
         },
       ],
@@ -402,6 +406,8 @@ describe('internal-plugin-metrics', () => {
             interstitialToMediaOKJMT: undefined,
             callInitMediaEngineReady: undefined,
             stayLobbyTime: undefined,
+            totalMediaJMTWithUserDelay: undefined,
+            totalJMTWithUserDelay: undefined,
           },
         },
       ],

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

@@ -19,7 +19,7 @@ describe('internal-plugin-metrics', () => {
     }
   });
 
-  describe('check submitClientEvent when webex is not ready', () => {
+  describe('check submitClientEvent, submitFeatureEvent when webex is not ready', () => {
     let webex;
     //@ts-ignore
     webex = mockWebex();
@@ -36,6 +36,30 @@ describe('internal-plugin-metrics', () => {
         'NewMetrics: @submitClientEvent. Attempted to submit before webex.ready. Event name: client.alert.displayed'
       );
     });
+
+    it('checks the log', () => {
+      webex.internal.newMetrics.submitFeatureEvent({
+        name: 'client.feature.meeting.summary',
+        options: {
+          meetingId: '123',
+        },
+        payload: {
+          meetingSummaryInfo: {
+            featureName: 'syncSystemMuteStatus',
+            featureActions: [{
+              actionName: 'syncMeetingMicUnmuteStatusToSystem',
+              actionId: '14200',
+              isInitialValue: false,
+              clickCount: '1'
+            }]
+          },
+        },
+      });
+      assert.calledWith(
+        webex.logger.log,
+        'NewMetrics: @submitFeatureEvent. Attempted to submit before webex.ready. Event name: client.feature.meeting.summary'
+      );
+    });
   });
 
   describe('new-metrics contstructor', () => {
@@ -65,6 +89,7 @@ describe('internal-plugin-metrics', () => {
       webex.internal.newMetrics.callDiagnosticMetrics.buildClientEventFetchRequestOptions =
         sinon.stub();
       webex.setTimingsAndFetch = sinon.stub();
+      webex.internal.newMetrics.callDiagnosticMetrics.submitFeatureEvent = sinon.stub();
     });
 
     afterEach(() => {
@@ -104,7 +129,7 @@ describe('internal-plugin-metrics', () => {
         metadata: { foo: 'bar' },
       });
     });
-  
+
     it('submits Client Event successfully', () => {
       webex.internal.newMetrics.submitClientEvent({
         name: 'client.alert.displayed',
@@ -125,6 +150,46 @@ describe('internal-plugin-metrics', () => {
       });
     });
 
+    it('submits feature Event successfully', () => {
+      webex.internal.newMetrics.submitFeatureEvent({
+        name: 'client.feature.meeting.summary',
+        options: {
+          meetingId: '123',
+        },
+        payload: {
+          meetingSummaryInfo: {
+            featureName: 'syncSystemMuteStatus',
+            featureActions: [{
+              actionName: 'syncMeetingMicUnmuteStatusToSystem',
+              actionId: '14200',
+              isInitialValue: false,
+              clickCount: '1'
+            }]
+          },
+        },
+      });
+
+      assert.calledWith(webex.internal.newMetrics.callDiagnosticLatencies.saveTimestamp, {
+        key: 'client.feature.meeting.summary',
+        options: {meetingId: '123'},
+      });
+      assert.calledWith(webex.internal.newMetrics.callDiagnosticMetrics.submitFeatureEvent, {
+        name: 'client.feature.meeting.summary',
+        payload: {
+          meetingSummaryInfo: {
+            featureName: 'syncSystemMuteStatus',
+            featureActions: [{
+              actionName: 'syncMeetingMicUnmuteStatusToSystem',
+              actionId: '14200',
+              isInitialValue: false,
+              clickCount: '1'
+            }]
+          },
+        },
+        options: {meetingId: '123'},
+        delaySubmitEvent: false,
+      });
+    });
 
     it('submits MQE successfully', () => {
       webex.internal.newMetrics.submitMQE({

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

@@ -17,7 +17,7 @@ describe('internal-plugin-metrics', () => {
     let webex;
     let clock;
     let now;
-
+    const deviceManagerStub = {getPairedDevice: sinon.stub()};
     const preLoginId = 'my_prelogin_id';
 
     beforeEach(() => {
@@ -30,6 +30,7 @@ describe('internal-plugin-metrics', () => {
           newMetrics: NewMetrics,
         },
       });
+      webex.devicemanager = deviceManagerStub;
 
       webex.request = (options) =>
         Promise.resolve({body: {items: []}, waitForServiceTimeout: 15, options});
@@ -76,6 +77,7 @@ describe('internal-plugin-metrics', () => {
                       clickToInterstitial: undefined,
                       refreshCaptchaServiceReqResp: undefined,
                       downloadIntelligenceModelsReqResp: undefined,
+                      clickToInterstitialWithUserDelay: undefined,
                     },
                     name: 'client.interstitial-window.launched',
                   },
@@ -216,9 +218,7 @@ describe('internal-plugin-metrics', () => {
         });
 
         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, {
@@ -231,6 +231,75 @@ describe('internal-plugin-metrics', () => {
         });
         assert.deepEqual(prepareDiagnosticMetricItemCalls[0].args[1].type, ['diagnostic-event']);
       });
+      it('adds the paired device to the metric payload if paired', async () => {
+        webex.internal.newMetrics.callDiagnosticMetrics.preLoginMetricsBatcher.prepareRequest = (
+          q
+        ) => Promise.resolve(q);
+        webex.devicemanager.getPairedDevice = sinon.stub().returns({
+          deviceInfo: {
+            id: 'my_device_id',
+          },
+          url: 'my_url',
+          mode: 'personal',
+          devices: [{productName: 'my_product_name'}],
+        });
+        webex.devicemanager.getPairedMethod = sinon.stub().returns("Manual");
+
+        const prepareItemSpy = sinon.spy(
+          webex.internal.newMetrics.callDiagnosticMetrics.preLoginMetricsBatcher,
+          'prepareItem'
+        );
+        const prepareDiagnosticMetricItemSpy = sinon.spy(
+          CallDiagnosticUtils,
+          'prepareDiagnosticMetricItem'
+        );
+
+        const promise =
+          webex.internal.newMetrics.callDiagnosticMetrics.submitToCallDiagnosticsPreLogin(
+            {
+              event: {name: 'client.interstitial-window.launched'},
+            },
+            preLoginId
+          );
+
+        await flushPromises();
+
+        clock.tick(config.metrics.batcherWait);
+
+        await promise;
+
+        const calls = prepareItemSpy.getCalls()[0];
+
+        assert.deepEqual(calls.args[0].eventPayload, {
+            event: {
+              joinTimes: {
+                meetingInfoReqResp: undefined,
+                clickToInterstitial: undefined,
+                clickToInterstitialWithUserDelay: undefined,
+                refreshCaptchaServiceReqResp: undefined,
+                downloadIntelligenceModelsReqResp: undefined,
+              },
+              name: 'client.interstitial-window.launched',
+              pairedDevice: {
+                deviceId: 'my_device_id',
+                deviceURL: 'my_url',
+                devicePairingType: 'Manual',
+                productName: 'my_product_name',
+                isPersonalDevice: true,
+              },
+              pairingState: 'paired',
+            },
+            origin: {
+              buildType: 'test',
+              networkType: 'unknown',
+              upgradeChannel: 'test',
+            },
+        });
+
+        assert.deepEqual(calls.args[0].type, ['diagnostic-event']);
+        assert.calledOnce(webex.devicemanager.getPairedDevice);
+       
+      });
     });
 
     describe('savePreLoginId', () => {

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":["_batcher","_interopRequireDefault","require","CallDiagnosticEventsBatcher","Batcher","extend","namespace","getBuildType","webClientDomain","includes","process","env","NODE_ENV","prepareItem","item","_item$event","_item$event$eventData","origin","buildType","event","eventData","networkType","eventPayload","_assign","default","_promise","resolve","prepareRequest","queue","forEach","originTime","sent","Date","toISOString","submitHttpRequest","payload","webex","request","method","service","resource","body","metrics","_default","exports"],"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,IAAAA,QAAA,GAAAC,sBAAA,CAAAC,OAAA;AAJA;AACA;AACA;;AAIA,IAAMC,2BAA2B,GAAGC,gBAAO,CAACC,MAAM,CAAC;EACjDC,SAAS,EAAE,SAAS;EAEpB;AACF;AACA;AACA;EACEC,YAAY,WAAAA,aAACC,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,WAAAA,YAACC,IAAI,EAAE;IAAA,IAAAC,WAAA,EAAAC,qBAAA;IAChB;IACA;IACA,IAAMC,MAAM,GAAG;MACbC,SAAS,EAAE,IAAI,CAACX,YAAY,EAAAQ,WAAA,GAACD,IAAI,CAACK,KAAK,cAAAJ,WAAA,wBAAAC,qBAAA,GAAVD,WAAA,CAAYK,SAAS,cAAAJ,qBAAA,uBAArBA,qBAAA,CAAuBR,eAAe,CAAC;MACpEa,WAAW,EAAE;IACf,CAAC;IAEDP,IAAI,CAACQ,YAAY,CAACL,MAAM,GAAG,IAAAM,OAAA,CAAAC,OAAA,EAAcP,MAAM,EAAEH,IAAI,CAACQ,YAAY,CAACL,MAAM,CAAC;IAE1E,OAAOQ,QAAA,CAAAD,OAAA,CAAQE,OAAO,CAACZ,IAAI,CAAC;EAC9B,CAAC;EAEDa,cAAc,WAAAA,eAACC,KAAK,EAAE;IACpB;IACAA,KAAK,CAACC,OAAO,CAAC,UAACf,IAAI,EAAK;MACtBA,IAAI,CAACQ,YAAY,CAACQ,UAAU,GAAGhB,IAAI,CAACQ,YAAY,CAACQ,UAAU,IAAI,CAAC,CAAC;MACjEhB,IAAI,CAACQ,YAAY,CAACQ,UAAU,CAACC,IAAI,GAAG,IAAIC,IAAI,EAAE,CAACC,WAAW,EAAE;IAC9D,CAAC,CAAC;IAEF,OAAOR,QAAA,CAAAD,OAAA,CAAQE,OAAO,CAACE,KAAK,CAAC;EAC/B,CAAC;EAEDM,iBAAiB,WAAAA,kBAACC,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,IAAAQ,QAAA,GAEYxC,2BAA2B;AAAAyC,OAAA,CAAApB,OAAA,GAAAmB,QAAA"}