@webex/internal-plugin-metrics 3.0.0-beta.8 → 3.0.0-bnr.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);
             });
         });

package/test/unit/spec/metrics.js

@@ -29,35 +29,35 @@ describe('plugin-metrics', () => {
     const eventName = 'test_event';
     const mockPayload = {
       fields: {
-        testField: 123
+        testField: 123,
       },
       tags: {
-        testTag: 'tag value'
+        testTag: 'tag value',
       },
       metricName: eventName,
       test: 'this field should not be included in final payload',
       type: 'behavioral',
-      eventPayload: {value: 'splunk business metric payload'}
+      eventPayload: {value: 'splunk business metric payload'},
     };
     const transformedProps = {
       fields: {
-        testField: 123
+        testField: 123,
       },
       tags: {
-        testTag: 'tag value'
+        testTag: 'tag value',
       },
       metricName: eventName,
       type: 'behavioral',
-      timestamp: Date.now()
+      timestamp: Date.now(),
     };
     const preLoginId = '1b90cf5e-27a6-41aa-a208-1f6eb6b9e6b6';
     const preLoginProps = {
-      metrics: [transformedProps]
+      metrics: [transformedProps],
     };
     const mockCallDiagnosticEvent = {
       originTime: {
-        triggered: 'mock triggered timestamp'
-      }
+        triggered: 'mock triggered timestamp',
+      },
     };
 
     beforeEach(() => {
@@ -71,8 +71,8 @@ describe('plugin-metrics', () => {
     beforeEach(() => {
       webex = new MockWebex({
         children: {
-          metrics: Metrics
-        }
+          metrics: Metrics,
+        },
       });
 
       webex.config.metrics = config.metrics;
@@ -82,7 +82,7 @@ describe('plugin-metrics', () => {
         return Promise.resolve({
           statusCode: 204,
           body: undefined,
-          options
+          options,
         });
       };
 
@@ -94,8 +94,7 @@ describe('plugin-metrics', () => {
         ...webex.config,
         appName: 'appName',
         appPlatform: 'appPlatform',
-        appVersion: 'appVersion'
-
+        appVersion: 'appVersion',
       };
       webex.config.metrics.type = ['operational'];
       webex.config.metrics.appType = 'sdk';
@@ -167,15 +166,18 @@ describe('plugin-metrics', () => {
       });
       describe('after login', () => {
         it('submits a metric to clientmetrics', () => {
-          webex.credentials.supertoken = new Token({
-            access_token: 'a_b_orgid'
-          }, {parent: webex});
+          webex.credentials.supertoken = new Token(
+            {
+              access_token: 'a_b_orgid',
+            },
+            {parent: webex}
+          );
 
           const testPayload = {
             tags: {success: true},
             fields: {perceivedDurationInMillis: 314},
             context: {},
-            eventPayload: {value: 'splunk business metric payload'}
+            eventPayload: {value: 'splunk business metric payload'},
           };
           const date = clock.now;
 
@@ -197,23 +199,20 @@ describe('plugin-metrics', () => {
               assert.property(metric, 'eventPayload');
 
               assert.property(metric.tags, 'browser');
-              assert.property(metric.tags, 'org_id');
               assert.property(metric.tags, 'os');
               assert.property(metric.tags, 'domain');
-              assert.property(metric.tags, 'client_id');
-              assert.property(metric.tags, 'user_id');
 
               assert.property(metric.fields, 'browser_version');
               assert.property(metric.fields, 'os_version');
               assert.property(metric.fields, 'sdk_version');
               assert.property(metric.fields, 'platform');
               assert.property(metric.fields, 'spark_user_agent');
+              assert.property(metric.fields, 'client_id');
 
               assert.property(metric.context, 'app');
               assert.property(metric.context, 'locale');
               assert.property(metric.context, 'os');
 
-
               assert.equal(metric.timestamp, date);
               assert.equal(metric.metricName, 'test');
               assert.equal(metric.tags.success, true);
@@ -294,8 +293,8 @@ describe('plugin-metrics', () => {
         const promise = metrics.submitCallDiagnosticEvents({
           ...mockCallDiagnosticEvent,
           origin: {
-            buildType: 'prod'
-          }
+            buildType: 'prod',
+          },
         });
 
         return promiseTick(50)