@webex/internal-plugin-metrics 3.4.0 → 3.5.0-next.10

package/src/new-metrics.ts

@@ -6,7 +6,9 @@
 import {WebexPlugin} from '@webex/webex-core';
 
 import CallDiagnosticMetrics from './call-diagnostic/call-diagnostic-metrics';
-import BehavioralMetrics from './behavioral/behavioral-metrics';
+import BehavioralMetrics from './behavioral-metrics';
+import OperationalMetrics from './operational-metrics';
+import BusinessMetrics from './business-metrics';
 import {
   RecursivePartial,
   MetricEventProduct,
@@ -14,11 +16,12 @@ import {
   MetricEventVerb,
   ClientEvent,
   FeatureEvent,
-  BehavioralEventPayload,
+  EventPayload,
   OperationalEvent,
   MediaQualityEvent,
   InternalEvent,
   SubmitClientEventOptions,
+  Table,
 } from './metrics.types';
 import CallDiagnosticLatencies from './call-diagnostic/call-diagnostic-metrics-latencies';
 import {setMetricTimings} from './call-diagnostic/call-diagnostic-metrics.util';
@@ -37,6 +40,9 @@ class Metrics extends WebexPlugin {
   // Helper classes to handle the different types of metrics
   callDiagnosticMetrics: CallDiagnosticMetrics;
   behavioralMetrics: BehavioralMetrics;
+  operationalMetrics: OperationalMetrics;
+  businessMetrics: BusinessMetrics;
+  isReady = false;
 
   /**
    * Constructor
@@ -61,8 +67,7 @@ class Metrics extends WebexPlugin {
     this.webex.once('ready', () => {
       // @ts-ignore
       this.callDiagnosticMetrics = new CallDiagnosticMetrics({}, {parent: this.webex});
-      // @ts-ignore
-      this.behavioralMetrics = new BehavioralMetrics({}, {parent: this.webex});
+      this.isReady = true;
     });
   }
 
@@ -86,11 +91,61 @@ class Metrics extends WebexPlugin {
     }
   }
 
+  /**
+   * if webex metrics is ready, build behavioral metric backend if not already done.
+   */
+  private lazyBuildBehavioralMetrics() {
+    if (this.isReady && !this.behavioralMetrics) {
+      // @ts-ignore
+      this.behavioralMetrics = new BehavioralMetrics({}, {parent: this.webex});
+    }
+  }
+
+  /**
+   * if webex metrics is ready, build operational metric backend if not already done.
+   */
+  private lazyBuildOperationalMetrics() {
+    if (this.isReady && !this.operationalMetrics) {
+      // @ts-ignore
+      this.operationalMetrics = new OperationalMetrics({}, {parent: this.webex});
+    }
+  }
+
+  /**
+   * if webex metrics is ready, build business metric backend if not already done.
+   */
+  private lazyBuildBusinessMetrics() {
+    if (this.isReady && !this.businessMetrics) {
+      // @ts-ignore
+      this.businessMetrics = new BusinessMetrics({}, {parent: this.webex});
+    }
+  }
+
   /**
    * @returns true once we have the deviceId we need to submit behavioral events to Amplitude
    */
   isReadyToSubmitBehavioralEvents() {
-    return this.behavioralMetrics.isReadyToSubmitBehavioralEvents();
+    this.lazyBuildBehavioralMetrics();
+
+    return this.behavioralMetrics?.isReadyToSubmitEvents() ?? false;
+  }
+
+  /**
+   * @returns true once we have the deviceId we need to submit operational events
+   */
+  isReadyToSubmitOperationalEvents() {
+    this.lazyBuildOperationalMetrics();
+
+    return this.operationalMetrics?.isReadyToSubmitEvents() ?? false;
+  }
+
+  /**
+   * @returns true once we have the deviceId we need to submit buisness events
+   */
+  isReadyToSubmitBusinessEvents() {
+    this.lazyBuildBusinessMetrics();
+
+    return this.businessMetrics?.isReadyToSubmitEvents() ?? false;
   }
 
   /**
@@ -108,9 +163,9 @@ class Metrics extends WebexPlugin {
     agent: MetricEventAgent;
     target: string;
     verb: MetricEventVerb;
-    payload?: BehavioralEventPayload;
+    payload?: EventPayload;
   }) {
-    if (!this.behavioralMetrics) {
+    if (!this.isReady) {
       // @ts-ignore
       this.webex.logger.log(
         `NewMetrics: @submitBehavioralEvent. Attempted to submit before webex.ready: ${product}.${agent}.${target}.${verb}`
@@ -119,6 +174,8 @@ class Metrics extends WebexPlugin {
       return Promise.resolve();
     }
 
+    this.lazyBuildBehavioralMetrics();
+
     return this.behavioralMetrics.submitBehavioralEvent({product, agent, target, verb, payload});
   }
 
@@ -126,16 +183,46 @@ class Metrics extends WebexPlugin {
    * Operational event
    * @param args
    */
-  submitOperationalEvent({
+  submitOperationalEvent({name, payload}: {name: string; payload?: EventPayload}) {
+    if (!this.isReady) {
+      // @ts-ignore
+      this.webex.logger.log(
+        `NewMetrics: @submitOperationalEvent. Attempted to submit before webex.ready: ${name}`
+      );
+
+      return Promise.resolve();
+    }
+
+    this.lazyBuildOperationalMetrics();
+
+    return this.operationalMetrics.submitOperationalEvent({name, payload});
+  }
+
+  /**
+   * Buisness event
+   * @param args
+   */
+  submitBusinessEvent({
     name,
     payload,
-    options,
+    table,
   }: {
-    name: OperationalEvent['name'];
-    payload?: RecursivePartial<OperationalEvent['payload']>;
-    options?: any;
+    name: string;
+    payload: EventPayload;
+    table?: Table;
   }) {
-    throw new Error('Not implemented.');
+    if (!this.isReady) {
+      // @ts-ignore
+      this.webex.logger.log(
+        `NewMetrics: @submitBusinessEvent. Attempted to submit before webex.ready: ${name}`
+      );
+
+      return Promise.resolve();
+    }
+
+    this.lazyBuildBusinessMetrics();
+
+    return this.businessMetrics.submitBusinessEvent({name, payload, table});
   }
 
   /**

package/src/operational-metrics.ts

@@ -0,0 +1,24 @@
+import GenericMetrics from './generic-metrics';
+import {EventPayload} from './metrics.types';
+
+/**
+ * @description Util class to handle Operational Metrics
+ * @export
+ * @class OperationalMetrics
+ */
+export default class OperationalMetrics extends GenericMetrics {
+  /**
+   * Submit an operational metric to our metrics endpoint.
+   * @param {string} name of the metric
+   * @param {EventPayload} user payload of the metric
+   * @returns {Promise<any>}
+   */
+  public submitOperationalEvent({name, payload}: {name: string; payload: EventPayload}) {
+    const event = this.createTaggedEventObject({
+      type: ['operational'],
+      name,
+      payload,
+    });
+    this.submitEvent({kind: 'operational-events -> ', name, event});
+  }
+}

package/src/rtcMetrics/constants.ts

@@ -0,0 +1,3 @@
+const RTC_METRICS = {APP_ID: 'FFB51ED5-4319-4C55-8303-B1F2FCCDE231'};
+
+export {RTC_METRICS as default};

package/src/rtcMetrics/index.ts

@@ -0,0 +1,186 @@
+/* eslint-disable class-methods-use-this */
+import uuid from 'uuid';
+import * as CallDiagnosticUtils from '../call-diagnostic/call-diagnostic-metrics.util';
+import RTC_METRICS from './constants';
+
+const parseJsonPayload = (payload: any[]): any | null => {
+  try {
+    if (payload && payload[0]) {
+      return JSON.parse(payload[0]);
+    }
+
+    return null;
+  } catch (_) {
+    return null;
+  }
+};
+
+/**
+ * Rtc Metrics
+ */
+export default class RtcMetrics {
+  /**
+   * Array of MetricData items to be sent to the metrics service.
+   */
+  metricsQueue = [];
+
+  intervalId: number;
+
+  webex: any;
+
+  meetingId: string;
+
+  correlationId: string;
+
+  connectionId: string;
+
+  shouldSendMetricsOnNextStatsReport: boolean;
+
+  /**
+   * Initialize the interval.
+   *
+   * @param {object} webex - The main `webex` object.
+   * @param {string} meetingId - The meeting id.
+   * @param {string} correlationId - The correlation id.
+   */
+  constructor(webex, meetingId, correlationId) {
+    // `window` is used to prevent typescript from returning a NodeJS.Timer.
+    this.intervalId = window.setInterval(this.sendMetricsInQueue.bind(this), 30 * 1000);
+    this.meetingId = meetingId;
+    this.webex = webex;
+    this.correlationId = correlationId;
+    this.resetConnection();
+  }
+
+  /**
+   * Check to see if the metrics queue has any items.
+   *
+   * @returns {void}
+   */
+  public sendMetricsInQueue() {
+    if (this.metricsQueue.length) {
+      this.sendMetrics();
+      this.metricsQueue = [];
+    }
+  }
+
+  /**
+   * Forces sending metrics when we get the next stats-report
+   *
+   * This is useful for cases when something important happens that affects the media connection,
+   * for example when we move from lobby into the meeting.
+   *
+   * @returns {void}
+   */
+  public sendNextMetrics() {
+    this.shouldSendMetricsOnNextStatsReport = true;
+  }
+
+  /**
+   * Add metrics items to the metrics queue.
+   *
+   * @param {object} data - An object with a payload array of metrics items.
+   *
+   * @returns {void}
+   */
+  addMetrics(data) {
+    if (data.payload.length) {
+      if (data.name === 'stats-report') {
+        data.payload = data.payload.map(this.anonymizeIp);
+      }
+
+      this.metricsQueue.push(data);
+
+      if (this.shouldSendMetricsOnNextStatsReport && data.name === 'stats-report') {
+        // this is the first useful set of data (WCME gives it to us after 5s), send it out immediately
+        // in case the user is unhappy and closes the browser early
+        this.sendMetricsInQueue();
+        this.shouldSendMetricsOnNextStatsReport = false;
+      }
+
+      try {
+        // If a connection fails, send the rest of the metrics in queue and get a new connection id.
+        const parsedPayload = parseJsonPayload(data.payload);
+        if (
+          data.name === 'onconnectionstatechange' &&
+          parsedPayload &&
+          parsedPayload.value === 'failed'
+        ) {
+          this.sendMetricsInQueue();
+          this.resetConnection();
+        }
+      } catch (e) {
+        console.error(e);
+      }
+    }
+  }
+
+  /**
+   * Clear the metrics interval.
+   *
+   * @returns {void}
+   */
+  closeMetrics() {
+    this.sendMetricsInQueue();
+    clearInterval(this.intervalId);
+  }
+
+  /**
+   * Anonymize IP addresses.
+   *
+   * @param {array} stats - An RTCStatsReport organized into an array of strings.
+   * @returns {string}
+   */
+  anonymizeIp(stats: string): string {
+    const data = JSON.parse(stats);
+    // on local and remote candidates, anonymize the last 4 bits.
+    if (data.type === 'local-candidate' || data.type === 'remote-candidate') {
+      data.ip = CallDiagnosticUtils.anonymizeIPAddress(data.ip) || undefined;
+      data.address = CallDiagnosticUtils.anonymizeIPAddress(data.address) || undefined;
+      data.relatedAddress =
+        CallDiagnosticUtils.anonymizeIPAddress(data.relatedAddress) || undefined;
+    }
+
+    return JSON.stringify(data);
+  }
+
+  /**
+   * Set a new connection id.
+   *
+   * @returns {void}
+   */
+  private resetConnection() {
+    this.connectionId = uuid.v4();
+    this.shouldSendMetricsOnNextStatsReport = true;
+  }
+
+  /**
+   * Send metrics to the metrics service.
+   *
+   * @returns {void}
+   */
+  private sendMetrics() {
+    this.webex.request({
+      method: 'POST',
+      service: 'unifiedTelemetry',
+      resource: 'metric/v2',
+      headers: {
+        type: 'webrtcMedia',
+        appId: RTC_METRICS.APP_ID,
+      },
+      body: {
+        metrics: [
+          {
+            type: 'webrtc',
+            version: '1.1.0',
+            userId: this.webex.internal.device.userId,
+            meetingId: this.meetingId,
+            correlationId: this.correlationId,
+            connectionId: this.connectionId,
+            data: this.metricsQueue,
+          },
+        ],
+      },
+    });
+  }
+}

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

@@ -74,6 +74,45 @@ describe('internal-plugin-metrics', () => {
       sinon.restore();
     });
 
+    describe('#sendEvent', () => {
+      it('should send correctly shaped behavioral event (check name building and internal tagged event building)', () => {
+        // For some reasons `jest` isn't available when testing form build server - so can't use `jest.fn()` here...
+        const requestCalls = [];
+        const request = function(arg) { requestCalls.push(arg) }
+
+        behavioralMetrics.clientMetricsBatcher.request = request;
+        
+        assert.equal(requestCalls.length, 0)
+        behavioralMetrics.submitBehavioralEvent({ product: "webex", agent: "user", target: "foo", verb: "get", payload: {bar:"gee"} })
+        assert.equal(requestCalls.length, 1)
+        assert.deepEqual(requestCalls[0], {
+          context: {
+            app: {version: 'webex-version'},
+            device: {id: 'deviceId'},
+            locale: 'language',
+            os: {
+              name: getOSNameInternal(),
+              version: getOSVersion(),
+            },
+          },
+          metricName: 'webex.user.foo.get',
+          tags: {
+            browser: getBrowserName(),
+            browserHeight: window.innerHeight,
+            browserVersion: getBrowserVersion(),
+            browserWidth: window.innerWidth,
+            domain: window.location.hostname,
+            inIframe: false,
+            locale: window.navigator.language,
+            os: getOSNameInternal(),
+            bar:"gee"
+          },
+          timestamp: requestCalls[0].timestamp, // This is to bypass time check, which is correctly tested below.
+          type: ['behavioral'],
+        });
+      })
+    })
+
     describe('#getContext', () => {
       it('should build context correctly', () => {
         const res = behavioralMetrics.getContext();
@@ -96,7 +135,7 @@ describe('internal-plugin-metrics', () => {
 
     describe('#getDefaultTags', () => {
       it('should build tags correctly', () => {
-        const res = behavioralMetrics.getDefaultTags();
+        const res = behavioralMetrics.getBrowserDetails();
 
         assert.deepEqual(res, {
           browser: getBrowserName(),
@@ -111,25 +150,27 @@ describe('internal-plugin-metrics', () => {
       });
     });
 
-    describe('#isReadyToSubmitBehavioralEvents', () => {
+    describe('#isReadyToSubmitEvents', () => {
       it('should return true when we have a deviceId, false when deviceId is empty or undefined', async () => {
-        assert.equal(true, behavioralMetrics.isReadyToSubmitBehavioralEvents());
+        let deviceIdUrl = webex.internal.device.url;
 
+        // testing case w/o device id url first, as the internal deviceId cache would bypass that flow.
         webex.internal.device.url = "";
-        assert.equal(false, behavioralMetrics.isReadyToSubmitBehavioralEvents());
+        assert.equal(false, behavioralMetrics.isReadyToSubmitEvents());
 
         delete webex.internal.device.url;
-        assert.equal(false, behavioralMetrics.isReadyToSubmitBehavioralEvents());
+        assert.equal(false, behavioralMetrics.isReadyToSubmitEvents());
+
+        webex.internal.device.url = deviceIdUrl;
+        assert.equal(true, behavioralMetrics.isReadyToSubmitEvents());
       });
     });
 
     describe('#createEventObject', () => {
       it('should build event object correctly', async () => {
-        const res = behavioralMetrics.createEventObject({
-          product: 'webex',
-          agent: 'user',
-          target: 'target',
-          verb: 'create',
+        const res = behavioralMetrics.createTaggedEventObject({
+          type:['behavioral'],
+          name:'webex.user.target.create',
           payload: tags,
         });
 

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

@@ -0,0 +1,182 @@
+import sinon from 'sinon';
+import {assert} from '@webex/test-helper-chai';
+import {BrowserDetection} from '@webex/common';
+import {BusinessMetrics, config, getOSNameInternal} from '@webex/internal-plugin-metrics';
+import uuid from 'uuid';
+
+//@ts-ignore
+global.window = {location: {hostname: 'whatever'}, navigator: {language: 'language'}};
+process.env.NODE_ENV = 'test';
+
+const {getOSVersion, getBrowserName, getBrowserVersion} = BrowserDetection();
+
+describe('internal-plugin-metrics', () => {
+  describe('BusinessMetrics', () => {
+    let webex;
+    let now;
+    let businessMetrics: BusinessMetrics;
+
+    const tags = {key: 'val'};
+
+    beforeEach(() => {
+      now = new Date();
+
+      webex = {
+        canAuthorize: true,
+        version: 'webex-version',
+        internal: {
+          services: {
+            get: () => 'locus-url',
+          },
+          metrics: {
+            submitClientMetrics: sinon.stub(),
+            config: {...config.metrics},
+          },
+          newMetrics: {},
+          device: {
+            userId: 'userId',
+            url: 'https://wdm-intb.ciscospark.com/wdm/api/v1/devices/deviceId',
+            orgId: 'orgId',
+          },
+        },
+        meetings: {
+          config: {
+            metrics: {
+              clientType: 'TEAMS_CLIENT',
+              subClientType: 'WEB_APP',
+              clientName: 'Cantina',
+            },
+          },
+          geoHintInfo: {
+            clientAddress: '1.3.4.5',
+            countryCode: 'UK',
+          },
+        },
+        credentials: {
+          isUnverifiedGuest: false,
+        },
+        prepareFetchOptions: sinon.stub().callsFake((opts: any) => ({...opts, foo: 'bar'})),
+        request: sinon.stub().resolves({body: {}}),
+        logger: {
+          log: sinon.stub(),
+          error: sinon.stub(),
+        },
+      };
+
+      sinon.createSandbox();
+      sinon.useFakeTimers(now.getTime());
+      businessMetrics = new BusinessMetrics({}, {parent: webex});
+      sinon.stub(uuid, 'v4').returns('my-fake-id');
+    });
+
+    afterEach(() => {
+      sinon.restore();
+    });
+
+    describe('#sendEvent', () => {
+      it('should send correctly shaped business event (check name building and internal tagged event building) and default correctly', () => {
+        // For some reasons `jest` isn't available when testing form build server - so can't use `jest.fn()` here...
+        const requestCalls = [];
+        const request = function(arg) { requestCalls.push(arg) }
+
+        businessMetrics.clientMetricsBatcher.request = request;
+        
+        assert.equal(requestCalls.length, 0)
+        businessMetrics.submitBusinessEvent({ name: "foobar", payload: {bar:"gee"} })
+        assert.equal(requestCalls.length, 1)
+        assert.deepEqual(requestCalls[0], {
+          eventPayload: {
+            appType: 'Web Client',
+            context: {
+              app: {version: 'webex-version'},
+              device: {id: 'deviceId'},
+              locale: 'language',
+              os: {
+                name: getOSNameInternal(),
+                version: getOSVersion(),
+              },
+            },
+            key: 'foobar',
+            browserDetails: {
+              browser: getBrowserName(),
+              browserHeight: window.innerHeight,
+              browserVersion: getBrowserVersion(),
+              browserWidth: window.innerWidth,
+              domain: window.location.hostname,
+              inIframe: false,
+              locale: window.navigator.language,
+              os: getOSNameInternal(),
+            },
+            client_timestamp: requestCalls[0].eventPayload.client_timestamp, // This is to bypass time check, which is checked below.
+            value: {
+              bar: "gee"
+            }
+          },
+          type: ['business'],
+        });
+        assert.isNumber(requestCalls[0].eventPayload.client_timestamp)
+      })
+
+      describe('when table is provided', () => {
+        it('should send correctly shaped business event with table: wbx_app_callend_metrics and ignore the key name', () => {
+          // For some reasons `jest` isn't available when testing form build server - so can't use `jest.fn()` here...
+          const requestCalls = [];
+          const request = function(arg) { requestCalls.push(arg) }
+
+          businessMetrics.clientMetricsBatcher.request = request;
+          
+          assert.equal(requestCalls.length, 0)
+          businessMetrics.submitBusinessEvent({ name: "foobar", payload: {bar:"gee"}, table: 'wbxapp_callend_metrics' })
+          assert.equal(requestCalls.length, 1)
+          assert.deepEqual(requestCalls[0], {
+            eventPayload: {
+              key: 'callEnd',
+              client_timestamp: requestCalls[0].eventPayload.client_timestamp, // This is to bypass time check, which is checked below.
+              appType: 'Web Client',
+              value: {
+                bar: 'gee'
+              }
+            },
+            type: ['business'],
+          });
+          assert.isNumber(requestCalls[0].eventPayload.client_timestamp)
+        });
+
+        it('should send correctly shaped business event with table: business_metrics', () => {
+          // For some reasons `jest` isn't available when testing form build server - so can't use `jest.fn()` here...
+          const requestCalls = [];
+          const request = function(arg) { requestCalls.push(arg) }
+
+          businessMetrics.clientMetricsBatcher.request = request;
+          
+          assert.equal(requestCalls.length, 0)
+          businessMetrics.submitBusinessEvent({ name: "foobar", payload: {bar:"gee"}, table: 'business_metrics' })
+          assert.equal(requestCalls.length, 1)
+          assert.deepEqual(requestCalls[0], {
+            eventPayload: {
+              key: 'foobar',
+              appType: 'Web Client',
+              client_timestamp: requestCalls[0].eventPayload.client_timestamp, // This is to bypass time check, which is checked below.
+              value: {
+                bar: "gee",
+                browser: getBrowserName(),
+                browserHeight: window.innerHeight,
+                browserVersion: getBrowserVersion(),
+                browserWidth: window.innerWidth,
+                domain: window.location.hostname,
+                inIframe: false,
+                locale: window.navigator.language,
+                os: getOSNameInternal(),
+                app: {version: 'webex-version'},
+                device: {id: 'deviceId'},
+                locale: 'language',
+              }
+            },
+            type: ['business'],
+          });
+          assert.isNumber(requestCalls[0].eventPayload.client_timestamp)
+        });
+      });
+    })
+  });
+});

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

@@ -441,7 +441,7 @@ describe('plugin-metrics', () => {
         // item also gets assigned a delay property but the key is a Symbol and haven't been able to test that..
         assert.deepEqual(calls.args[0].eventPayload, {
           event: 'my.event',
-          origin: {buildType: 'test', networkType: 'unknown'},
+          origin: {buildType: 'test', networkType: 'unknown', upgradeChannel: 'test'},
         });
 
         assert.deepEqual(calls.args[0].type, ['diagnostic-event']);
@@ -455,6 +455,7 @@ describe('plugin-metrics', () => {
           origin: {
             buildType: 'test',
             networkType: 'unknown',
+            upgradeChannel: 'test',
           },
         });
         assert.deepEqual(prepareDiagnosticMetricItemCalls[0].args[1].type, ['diagnostic-event']);