@webex/internal-plugin-metrics 3.5.0 → 3.6.0-next.2

package/src/rtcMetrics/index.ts

@@ -0,0 +1,205 @@
+/* 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';
+import {IdType, IMetricsAttributes} from '../metrics.types';
+
+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;
+
+  callId?: string;
+
+  correlationId: string;
+
+  connectionId: string;
+
+  shouldSendMetricsOnNextStatsReport: boolean;
+
+  /**
+   * Initialize the interval.
+   *
+   * @param {object} webex - The main `webex` object.
+   * @param {IdType} Ids - Meeting or Calling id.
+   * @param {string} correlationId - The correlation id.
+   */
+  constructor(webex, {meetingId, callId}: IdType, 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.callId = callId;
+    this.webex = webex;
+    this.correlationId = correlationId;
+    this.resetConnection();
+  }
+
+  /**
+   * Updates the call identifier with the provided value.
+   *
+   * @param {string} callId - The new call identifier to set.
+   * @returns {void}
+   */
+  public updateCallId(callId: string) {
+    this.callId = callId;
+  }
+
+  /**
+   * 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() {
+    const metricsAttributes: IMetricsAttributes = {
+      type: 'webrtc',
+      version: '1.1.0',
+      userId: this.webex.internal.device.userId,
+      correlationId: this.correlationId,
+      connectionId: this.connectionId,
+      data: this.metricsQueue,
+    };
+
+    if (this.meetingId) {
+      metricsAttributes.meetingId = this.meetingId;
+    } else if (this.callId) {
+      metricsAttributes.callId = this.callId;
+    }
+
+    this.webex.request({
+      method: 'POST',
+      service: 'unifiedTelemetry',
+      resource: 'metric/v2',
+      headers: {
+        type: 'webrtcMedia',
+        appId: RTC_METRICS.APP_ID,
+      },
+      body: {
+        metrics: [metricsAttributes],
+      },
+    });
+  }
+}

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

@@ -20,6 +20,8 @@ describe('internal-plugin-metrics', () => {
 
     beforeEach(() => {
       now = new Date();
+      sinon.createSandbox();
+      sinon.useFakeTimers(now.getTime());
 
       webex = {
         canAuthorize: true,
@@ -74,7 +76,7 @@ describe('internal-plugin-metrics', () => {
     });
 
     describe('#sendEvent', () => {
-      it('should send correctly shaped business event (check name building and internal tagged event building)', () => {
+      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) }
@@ -86,6 +88,7 @@ describe('internal-plugin-metrics', () => {
         assert.equal(requestCalls.length, 1)
         assert.deepEqual(requestCalls[0], {
           eventPayload: {
+            appType: 'Web Client',
             context: {
               app: {version: 'webex-version'},
               device: {id: 'deviceId'},
@@ -113,8 +116,72 @@ describe('internal-plugin-metrics', () => {
           },
           type: ['business'],
         });
-        assert.isNumber(requestCalls[0].eventPayload.client_timestamp)
+        assert.isString(requestCalls[0].eventPayload.client_timestamp)
+        assert.equal(requestCalls[0].eventPayload.client_timestamp, now.toISOString())
       })
+
+      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.isString(requestCalls[0].eventPayload.client_timestamp)
+          assert.equal(requestCalls[0].eventPayload.client_timestamp, now.toISOString())
+        });
+
+        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.isString(requestCalls[0].eventPayload.client_timestamp)
+          assert.equal(requestCalls[0].eventPayload.client_timestamp, now.toISOString())
+        });
+      });
     })
   });
 });

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']);

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

@@ -12,12 +12,10 @@ describe('internal-plugin-metrics', () => {
       sinon.useFakeTimers(now.getTime());
       const webex = {
         meetings: {
-          meetingCollection: {
-            get: (id: string) => {
-              if (id === 'meeting-id') {
-                return {id: 'meeting-id', allowMediaInLobby: true};
-              }
-            },
+          getBasicMeetingInformation: (id: string) => {
+            if (id === 'meeting-id') {
+              return {id: 'meeting-id', allowMediaInLobby: true};
+            }
           },
         },
       };