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

package/src/batcher.js

@@ -23,11 +23,13 @@ const MetricsBatcher = Batcher.extend({
   },
 
   prepareRequest(queue) {
-    return Promise.resolve(queue.map((item) => {
-      item.postTime = item.postTime || Date.now();
+    return Promise.resolve(
+      queue.map((item) => {
+        item.postTime = item.postTime || Date.now();
 
-      return item;
-    }));
+        return item;
+      })
+    );
   },
 
   submitHttpRequest(payload) {
@@ -36,8 +38,8 @@ const MetricsBatcher = Batcher.extend({
       service: 'metrics',
       resource: 'metrics',
       body: {
-        metrics: payload
-      }
+        metrics: payload,
+      },
     });
   },
 
@@ -47,38 +49,43 @@ const MetricsBatcher = Batcher.extend({
 
   handleHttpError(reason) {
     if (reason instanceof WebexHttpError.NetworkOrCORSError) {
-      this.logger.warn('metrics-batcher: received network error submitting metrics, reenqueuing payload');
-
-      return Promise.all(reason.options.body.metrics.map((item) => new Promise((resolve) => {
-        const delay = item[sym].nextDelay;
-
-        if (delay < this.config.batcherRetryPlateau) {
-          item[sym].nextDelay *= 2;
-        }
-        safeSetTimeout(() => {
-          resolve(this.rerequest(item));
-        }, delay);
-      })));
+      this.logger.warn(
+        'metrics-batcher: received network error submitting metrics, reenqueuing payload'
+      );
+
+      return Promise.all(
+        reason.options.body.metrics.map(
+          (item) =>
+            new Promise((resolve) => {
+              const delay = item[sym].nextDelay;
+
+              if (delay < this.config.batcherRetryPlateau) {
+                item[sym].nextDelay *= 2;
+              }
+              safeSetTimeout(() => {
+                resolve(this.rerequest(item));
+              }, delay);
+            })
+        )
+      );
     }
 
     return Reflect.apply(Batcher.prototype.handleHttpError, this, [reason]);
   },
 
   rerequest(item) {
-    return Promise.all([
-      this.getDeferredForRequest(item),
-      this.prepareItem(item)
-    ])
-      .then(([defer, req]) => {
+    return Promise.all([this.getDeferredForRequest(item), this.prepareItem(item)]).then(
+      ([defer, req]) => {
         this.enqueue(req)
           .then(() => this.bounce())
           .catch((reason) => defer.reject(reason));
-      });
+      }
+    );
   },
 
   fingerprintRequest(item) {
     item[sym] = item[sym] || {
-      nextDelay: 1000
+      nextDelay: 1000,
     };
 
     return Promise.resolve(item[sym]);
@@ -86,7 +93,7 @@ const MetricsBatcher = Batcher.extend({
 
   fingerprintResponse(item) {
     return Promise.resolve(item[sym]);
-  }
+  },
 });
 
 export default MetricsBatcher;

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

@@ -10,7 +10,7 @@ const CallDiagnosticEventsBatcher = Batcher.extend({
   /**
    * @param {string} webClientDomain
    * @returns {string}
-  */
+   */
   getBuildType(webClientDomain) {
     if (
       webClientDomain?.includes('teams.webex.com') ||
@@ -29,7 +29,7 @@ const CallDiagnosticEventsBatcher = Batcher.extend({
     // Browsers cannot provide such information right now. However, it is a required field.
     const origin = {
       buildType: this.getBuildType(item.event?.eventData?.webClientDomain),
-      networkType: 'unknown'
+      networkType: 'unknown',
     };
 
     item.eventPayload.origin = Object.assign(origin, item.eventPayload.origin);
@@ -53,10 +53,10 @@ const CallDiagnosticEventsBatcher = Batcher.extend({
       service: 'metrics',
       resource: 'clientmetrics',
       body: {
-        metrics: payload
-      }
+        metrics: payload,
+      },
     });
-  }
+  },
 });
 
 export default CallDiagnosticEventsBatcher;

package/src/client-metrics-batcher.js

@@ -22,11 +22,10 @@ const ClientMetricsBatcher = Batcher.extend({
       service: 'metrics',
       resource: 'clientmetrics',
       body: {
-        metrics: payload
-      }
+        metrics: payload,
+      },
     });
-  }
-
+  },
 });
 
 export default ClientMetricsBatcher;

package/src/config.js

@@ -8,15 +8,16 @@ export const CLIENT_NAME = 'webex-js-sdk';
 export default {
   device: {
     preDiscoveryServices: {
-      metricsServiceUrl: process.env.METRICS_SERVICE_URL || 'https://metrics-a.wbx2.com/metrics/api/v1',
-      metrics: process.env.METRICS_SERVICE_URL || 'https://metrics-a.wbx2.com/metrics/api/v1'
-    }
+      metricsServiceUrl:
+        process.env.METRICS_SERVICE_URL || 'https://metrics-a.wbx2.com/metrics/api/v1',
+      metrics: process.env.METRICS_SERVICE_URL || 'https://metrics-a.wbx2.com/metrics/api/v1',
+    },
   },
   metrics: {
     appType: inBrowser ? 'browser' : 'nodejs',
     batcherWait: 500,
     batcherMaxCalls: 50,
     batcherMaxWait: 1500,
-    batcherRetryPlateau: 32000
-  }
+    batcherRetryPlateau: 32000,
+  },
 };

package/src/index.js

@@ -10,7 +10,7 @@ import Metrics from './metrics';
 import config from './config';
 
 registerInternalPlugin('metrics', Metrics, {
-  config
+  config,
 });
 
 export {default} from './metrics';

package/src/metrics.js

@@ -1,3 +1,5 @@
+/* eslint-disable default-param-last */
+
 /*!
  * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
  */
@@ -10,19 +12,10 @@ import Batcher from './batcher';
 import ClientMetricsBatcher from './client-metrics-batcher';
 import CallDiagnosticEventsBatcher from './call-diagnostic-events-batcher';
 
-const {
-  getOSName,
-  getOSVersion,
-  getBrowserName,
-  getBrowserVersion
-} = BrowserDetection();
+const {getOSName, getOSVersion, getBrowserName, getBrowserVersion} = BrowserDetection();
 
 function getSparkUserAgent(webex) {
-  const {
-    appName,
-    appVersion,
-    appPlatform
-  } = webex?.config ?? {};
+  const {appName, appVersion, appPlatform} = webex?.config ?? {};
 
   let sparkUserAgent = CLIENT_NAME;
 
@@ -37,21 +30,19 @@ function getSparkUserAgent(webex) {
   return sparkUserAgent;
 }
 
-
 const Metrics = WebexPlugin.extend({
   children: {
     batcher: Batcher,
     clientMetricsBatcher: ClientMetricsBatcher,
-    callDiagnosticEventsBatcher: CallDiagnosticEventsBatcher
+    callDiagnosticEventsBatcher: CallDiagnosticEventsBatcher,
   },
 
   namespace: 'Metrics',
 
   submit(key, value) {
-    return this.batcher.request(Object.assign({key}, value));
+    return this.batcher.request({key, ...value});
   },
 
-
   /**
    * This corresponds to #sendSemiStructured() in the deprecated metrics handler
    * @param {string} eventName
@@ -72,45 +63,41 @@ const Metrics = WebexPlugin.extend({
 
       // Node does not like this so we need to check if it exists or not
       // eslint-disable-next-line no-undef
-      domain: typeof window !== 'undefined' ? window.location.hostname || 'non-browser' : 'non-browser', // Check what else we could measure
+      domain:
+        typeof window !== 'undefined' ? window.location.hostname || 'non-browser' : 'non-browser', // Check what else we could measure
       client_id: this.webex.credentials.config.client_id,
-      user_id: this.webex.internal.device.userId
+      user_id: this.webex.internal.device.userId,
     };
 
     try {
       payload.tags.org_id = this.webex.credentials.getOrgId();
-    }
-    catch {
+    } catch {
       this.logger.info('metrics: unable to get orgId');
     }
 
-
     payload.fields = {
       ...props.fields,
       browser_version: getBrowserVersion(),
       os_version: getOSVersion(),
       sdk_version: this.webex.version,
       platform: 'Web',
-      spark_user_agent: getSparkUserAgent(this.webex)
+      spark_user_agent: getSparkUserAgent(this.webex),
     };
 
-
     payload.type = props.type || this.webex.config.metrics.type;
 
-
     payload.context = {
       ...props.context,
       app: {
-        version: this.webex.version
+        version: this.webex.version,
       },
       locale: 'en-US',
       os: {
         name: getOSName(),
-        version: getOSVersion()
-      }
+        version: getOSVersion(),
+      },
     };
 
-
     if (props.eventPayload) {
       payload.eventPayload = props.eventPayload;
     }
@@ -121,7 +108,7 @@ const Metrics = WebexPlugin.extend({
 
     if (preLoginId) {
       const _payload = {
-        metrics: [payload]
+        metrics: [payload],
       };
 
       // Do not batch these because pre-login events occur during onboarding, so we will be partially blind
@@ -144,12 +131,12 @@ const Metrics = WebexPlugin.extend({
       api: 'metrics',
       resource: 'clientmetrics',
       headers: {
-        'x-prelogin-userid': preLoginId
+        'x-prelogin-userid': preLoginId,
       },
       body: {},
       qs: {
-        alias: true
-      }
+        alias: true,
+      },
     });
   },
 
@@ -161,20 +148,21 @@ const Metrics = WebexPlugin.extend({
         resource: 'clientmetrics-prelogin',
         headers: {
           authorization: token.toString(),
-          'x-prelogin-userid': preLoginId
+          'x-prelogin-userid': preLoginId,
         },
-        body: payload
-      }));
+        body: payload,
+      })
+    );
   },
 
   submitCallDiagnosticEvents(payload) {
     const event = {
       type: 'diagnostic-event',
-      eventPayload: payload
+      eventPayload: payload,
     };
 
     return this.callDiagnosticEventsBatcher.request(event);
-  }
+  },
 });
 
 export default Metrics;

package/test/unit/spec/batcher.js

@@ -27,8 +27,8 @@ describe('plugin-metrics', () => {
     beforeEach(() => {
       webex = new MockWebex({
         children: {
-          metrics: Metrics
-        }
+          metrics: Metrics,
+        },
       });
 
       webex.config.metrics = config.metrics;
@@ -37,7 +37,7 @@ describe('plugin-metrics', () => {
         return Promise.resolve({
           statusCode: 204,
           body: undefined,
-          options
+          options,
         });
       };
       sinon.spy(webex, 'request');
@@ -58,9 +58,10 @@ describe('plugin-metrics', () => {
         it('clears the queue', () => {
           clock.uninstall();
 
-          return webex.internal.metrics.batcher.request({
-            key: 'testMetric'
-          })
+          return webex.internal.metrics.batcher
+            .request({
+              key: 'testMetric',
+            })
             .then(() => {
               assert.calledOnce(webex.request);
               assert.lengthOf(webex.internal.metrics.batcher.queue, 0);
@@ -80,26 +81,28 @@ describe('plugin-metrics', () => {
 
           sinon.stub(webex, 'request').callsFake((options) => {
             options.headers = {
-              trackingid: count
+              trackingid: count,
             };
 
             count += 1;
             if (count < 9) {
-              return Promise.reject(new WebexHttpError.NetworkOrCORSError({
-                statusCode: 0,
-                options
-              }));
+              return Promise.reject(
+                new WebexHttpError.NetworkOrCORSError({
+                  statusCode: 0,
+                  options,
+                })
+              );
             }
 
             return Promise.resolve({
               statusCode: 204,
               body: undefined,
-              options
+              options,
             });
           });
 
           const promise = webex.internal.metrics.batcher.request({
-            key: 'testMetric'
+            key: 'testMetric',
           });
 
           return promiseTick(50)
@@ -159,8 +162,16 @@ describe('plugin-metrics', () => {
             .then(() => assert.lengthOf(webex.internal.metrics.batcher.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.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.batcher.queue, 0);
             });
         });

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

@@ -27,8 +27,8 @@ describe('plugin-metrics', () => {
     beforeEach(() => {
       webex = new MockWebex({
         children: {
-          metrics: Metrics
-        }
+          metrics: Metrics,
+        },
       });
 
       webex.config.metrics = config.metrics;
@@ -37,7 +37,7 @@ describe('plugin-metrics', () => {
         return Promise.resolve({
           statusCode: 204,
           body: undefined,
-          options
+          options,
         });
       };
       sinon.spy(webex, 'request');
@@ -58,14 +58,15 @@ describe('plugin-metrics', () => {
         it('clears the queue', () => {
           clock.uninstall();
 
-          return webex.internal.metrics.callDiagnosticEventsBatcher.request({
-            type: 'diagnostic-event',
-            eventPayload: {
-              originTime: {
-                triggered: 'mock triggered timestamp'
-              }
-            }
-          })
+          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);
@@ -85,21 +86,23 @@ describe('plugin-metrics', () => {
 
           sinon.stub(webex, 'request').callsFake((options) => {
             options.headers = {
-              trackingid: count
+              trackingid: count,
             };
 
             count += 1;
             if (count < 9) {
-              return Promise.reject(new WebexHttpError.NetworkOrCORSError({
-                statusCode: 0,
-                options
-              }));
+              return Promise.reject(
+                new WebexHttpError.NetworkOrCORSError({
+                  statusCode: 0,
+                  options,
+                })
+              );
             }
 
             return Promise.resolve({
               statusCode: 204,
               body: undefined,
-              options
+              options,
             });
           });
 
@@ -107,13 +110,15 @@ describe('plugin-metrics', () => {
             type: 'diagnostic-event',
             eventPayload: {
               originTime: {
-                triggered: 'mock triggered timestamp'
-              }
-            }
+                triggered: 'mock triggered timestamp',
+              },
+            },
           });
 
           return promiseTick(50)
-            .then(() => assert.lengthOf(webex.internal.metrics.callDiagnosticEventsBatcher.queue, 1))
+            .then(() =>
+              assert.lengthOf(webex.internal.metrics.callDiagnosticEventsBatcher.queue, 1)
+            )
             .then(() => clock.tick(config.metrics.batcherWait))
             .then(() => assert.calledOnce(webex.request))
 
@@ -166,11 +171,21 @@ describe('plugin-metrics', () => {
             .then(() => assert.callCount(webex.request, 9))
 
             .then(() => promiseTick(50))
-            .then(() => assert.lengthOf(webex.internal.metrics.callDiagnosticEventsBatcher.queue, 0))
+            .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.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/test/unit/spec/client-metrics-batcher.js

@@ -27,8 +27,8 @@ describe('plugin-metrics', () => {
     beforeEach(() => {
       webex = new MockWebex({
         children: {
-          metrics: Metrics
-        }
+          metrics: Metrics,
+        },
       });
 
       webex.config.metrics = config.metrics;
@@ -37,7 +37,7 @@ describe('plugin-metrics', () => {
         return Promise.resolve({
           statusCode: 204,
           body: undefined,
-          options
+          options,
         });
       };
       sinon.spy(webex, 'request');
@@ -58,9 +58,10 @@ describe('plugin-metrics', () => {
         it('clears the queue', () => {
           clock.uninstall();
 
-          return webex.internal.metrics.clientMetricsBatcher.request({
-            key: 'testMetric'
-          })
+          return webex.internal.metrics.clientMetricsBatcher
+            .request({
+              key: 'testMetric',
+            })
             .then(() => {
               assert.calledOnce(webex.request);
               assert.lengthOf(webex.internal.metrics.clientMetricsBatcher.queue, 0);
@@ -80,26 +81,28 @@ describe('plugin-metrics', () => {
 
           sinon.stub(webex, 'request').callsFake((options) => {
             options.headers = {
-              trackingid: count
+              trackingid: count,
             };
 
             count += 1;
             if (count < 9) {
-              return Promise.reject(new WebexHttpError.NetworkOrCORSError({
-                statusCode: 0,
-                options
-              }));
+              return Promise.reject(
+                new WebexHttpError.NetworkOrCORSError({
+                  statusCode: 0,
+                  options,
+                })
+              );
             }
 
             return Promise.resolve({
               statusCode: 204,
               body: undefined,
-              options
+              options,
             });
           });
 
           const promise = webex.internal.metrics.clientMetricsBatcher.request({
-            key: 'testMetric'
+            key: 'testMetric',
           });
 
           return promiseTick(50)
@@ -159,8 +162,16 @@ describe('plugin-metrics', () => {
             .then(() => assert.lengthOf(webex.internal.metrics.clientMetricsBatcher.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.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.clientMetricsBatcher.queue, 0);
             });
         });