@webex/internal-plugin-metrics 3.5.0-next.4 → 3.5.0-next.5

package/dist/index.js

@@ -46,6 +46,12 @@ _Object$defineProperty(exports, "OperationalMetrics", {
     return _operationalMetrics.default;
   }
 });
+_Object$defineProperty(exports, "RtcMetrics", {
+  enumerable: true,
+  get: function get() {
+    return _rtcMetrics.default;
+  }
+});
 exports.Utils = void 0;
 _Object$defineProperty(exports, "config", {
   enumerable: true,
@@ -80,6 +86,7 @@ var _callDiagnosticMetricsLatencies = _interopRequireDefault(require("./call-dia
 var _behavioralMetrics = _interopRequireDefault(require("./behavioral-metrics"));
 var _operationalMetrics = _interopRequireDefault(require("./operational-metrics"));
 var _businessMetrics = _interopRequireDefault(require("./business-metrics"));
+var _rtcMetrics = _interopRequireDefault(require("./rtcMetrics"));
 function _getRequireWildcardCache(e) { if ("function" != typeof _WeakMap) return null; var r = new _WeakMap(), t = new _WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(e) { return e ? t : r; })(e); }
 function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = _Object$defineProperty && _Object$getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? _Object$getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? _Object$defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
 /*!

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"names":["_webexCore","require","_metrics","_interopRequireWildcard","_config","_interopRequireDefault","_newMetrics","Utils","exports","CALL_DIAGNOSTIC_CONFIG","CallDiagnosticUtils","_callDiagnosticMetrics2","_callDiagnosticMetricsLatencies","_behavioralMetrics","_operationalMetrics","_businessMetrics","_getRequireWildcardCache","e","_WeakMap","r","t","__esModule","_typeof","default","has","get","n","__proto__","a","_Object$defineProperty","_Object$getOwnPropertyDescriptor","u","Object","prototype","hasOwnProperty","call","i","set","registerInternalPlugin","Metrics","config","NewMetrics"],"sources":["index.ts"],"sourcesContent":["/*!\n * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.\n */\n\nimport {registerInternalPlugin} from '@webex/webex-core';\n\nimport Metrics from './metrics';\nimport config from './config';\nimport NewMetrics from './new-metrics';\nimport * as Utils from './utils';\nimport {\n  ClientEvent,\n  ClientEventLeaveReason,\n  SubmitBehavioralEvent,\n  SubmitClientEvent,\n  SubmitInternalEvent,\n  SubmitOperationalEvent,\n  SubmitMQE,\n  PreComputedLatencies,\n} from './metrics.types';\nimport * as CALL_DIAGNOSTIC_CONFIG from './call-diagnostic/config';\nimport * as CallDiagnosticUtils from './call-diagnostic/call-diagnostic-metrics.util';\nimport CallDiagnosticMetrics from './call-diagnostic/call-diagnostic-metrics';\nimport CallDiagnosticLatencies from './call-diagnostic/call-diagnostic-metrics-latencies';\nimport BehavioralMetrics from './behavioral-metrics';\nimport OperationalMetrics from './operational-metrics';\nimport BusinessMetrics from './business-metrics';\n\nregisterInternalPlugin('metrics', Metrics, {\n  config,\n});\n\nregisterInternalPlugin('newMetrics', NewMetrics, {\n  config,\n});\n\nexport {default, getOSNameInternal} from './metrics';\n\nexport {\n  config,\n  CALL_DIAGNOSTIC_CONFIG,\n  NewMetrics,\n  Utils,\n  CallDiagnosticUtils,\n  CallDiagnosticLatencies,\n  CallDiagnosticMetrics,\n  BehavioralMetrics,\n  OperationalMetrics,\n  BusinessMetrics,\n};\nexport type {\n  ClientEvent,\n  ClientEventLeaveReason,\n  SubmitBehavioralEvent,\n  SubmitClientEvent,\n  SubmitInternalEvent,\n  SubmitMQE,\n  SubmitOperationalEvent,\n  PreComputedLatencies,\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAIA,IAAAA,UAAA,GAAAC,OAAA;AAEA,IAAAC,QAAA,GAAAC,uBAAA,CAAAF,OAAA;AACA,IAAAG,OAAA,GAAAC,sBAAA,CAAAJ,OAAA;AACA,IAAAK,WAAA,GAAAD,sBAAA,CAAAJ,OAAA;AACA,IAAAM,KAAA,GAAAJ,uBAAA,CAAAF,OAAA;AAAiCO,OAAA,CAAAD,KAAA,GAAAA,KAAA;AAWjC,IAAAE,sBAAA,GAAAN,uBAAA,CAAAF,OAAA;AAAmEO,OAAA,CAAAC,sBAAA,GAAAA,sBAAA;AACnE,IAAAC,mBAAA,GAAAP,uBAAA,CAAAF,OAAA;AAAsFO,OAAA,CAAAE,mBAAA,GAAAA,mBAAA;AACtF,IAAAC,uBAAA,GAAAN,sBAAA,CAAAJ,OAAA;AACA,IAAAW,+BAAA,GAAAP,sBAAA,CAAAJ,OAAA;AACA,IAAAY,kBAAA,GAAAR,sBAAA,CAAAJ,OAAA;AACA,IAAAa,mBAAA,GAAAT,sBAAA,CAAAJ,OAAA;AACA,IAAAc,gBAAA,GAAAV,sBAAA,CAAAJ,OAAA;AAAiD,SAAAe,yBAAAC,CAAA,6BAAAC,QAAA,mBAAAC,CAAA,OAAAD,QAAA,IAAAE,CAAA,OAAAF,QAAA,YAAAF,wBAAA,YAAAA,yBAAAC,CAAA,WAAAA,CAAA,GAAAG,CAAA,GAAAD,CAAA,KAAAF,CAAA;AAAA,SAAAd,wBAAAc,CAAA,EAAAE,CAAA,SAAAA,CAAA,IAAAF,CAAA,IAAAA,CAAA,CAAAI,UAAA,SAAAJ,CAAA,eAAAA,CAAA,gBAAAK,OAAA,CAAAL,CAAA,0BAAAA,CAAA,WAAAM,OAAA,EAAAN,CAAA,QAAAG,CAAA,GAAAJ,wBAAA,CAAAG,CAAA,OAAAC,CAAA,IAAAA,CAAA,CAAAI,GAAA,CAAAP,CAAA,UAAAG,CAAA,CAAAK,GAAA,CAAAR,CAAA,OAAAS,CAAA,KAAAC,SAAA,UAAAC,CAAA,GAAAC,sBAAA,IAAAC,gCAAA,WAAAC,CAAA,IAAAd,CAAA,oBAAAc,CAAA,IAAAC,MAAA,CAAAC,SAAA,CAAAC,cAAA,CAAAC,IAAA,CAAAlB,CAAA,EAAAc,CAAA,SAAAK,CAAA,GAAAR,CAAA,GAAAE,gCAAA,CAAAb,CAAA,EAAAc,CAAA,UAAAK,CAAA,KAAAA,CAAA,CAAAX,GAAA,IAAAW,CAAA,CAAAC,GAAA,IAAAR,sBAAA,CAAAH,CAAA,EAAAK,CAAA,EAAAK,CAAA,IAAAV,CAAA,CAAAK,CAAA,IAAAd,CAAA,CAAAc,CAAA,YAAAL,CAAA,CAAAH,OAAA,GAAAN,CAAA,EAAAG,CAAA,IAAAA,CAAA,CAAAiB,GAAA,CAAApB,CAAA,EAAAS,CAAA,GAAAA,CAAA;AA1BjD;AACA;AACA;;AA0BA,IAAAY,iCAAsB,EAAC,SAAS,EAAEC,gBAAO,EAAE;EACzCC,MAAM,EAANA;AACF,CAAC,CAAC;AAEF,IAAAF,iCAAsB,EAAC,YAAY,EAAEG,mBAAU,EAAE;EAC/CD,MAAM,EAANA;AACF,CAAC,CAAC"}
+{"version":3,"names":["_webexCore","require","_metrics","_interopRequireWildcard","_config","_interopRequireDefault","_newMetrics","Utils","exports","CALL_DIAGNOSTIC_CONFIG","CallDiagnosticUtils","_callDiagnosticMetrics2","_callDiagnosticMetricsLatencies","_behavioralMetrics","_operationalMetrics","_businessMetrics","_rtcMetrics","_getRequireWildcardCache","e","_WeakMap","r","t","__esModule","_typeof","default","has","get","n","__proto__","a","_Object$defineProperty","_Object$getOwnPropertyDescriptor","u","Object","prototype","hasOwnProperty","call","i","set","registerInternalPlugin","Metrics","config","NewMetrics"],"sources":["index.ts"],"sourcesContent":["/*!\n * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.\n */\n\nimport {registerInternalPlugin} from '@webex/webex-core';\n\nimport Metrics from './metrics';\nimport config from './config';\nimport NewMetrics from './new-metrics';\nimport * as Utils from './utils';\nimport {\n  ClientEvent,\n  ClientEventLeaveReason,\n  SubmitBehavioralEvent,\n  SubmitClientEvent,\n  SubmitInternalEvent,\n  SubmitOperationalEvent,\n  SubmitMQE,\n  PreComputedLatencies,\n} from './metrics.types';\nimport * as CALL_DIAGNOSTIC_CONFIG from './call-diagnostic/config';\nimport * as CallDiagnosticUtils from './call-diagnostic/call-diagnostic-metrics.util';\nimport CallDiagnosticMetrics from './call-diagnostic/call-diagnostic-metrics';\nimport CallDiagnosticLatencies from './call-diagnostic/call-diagnostic-metrics-latencies';\nimport BehavioralMetrics from './behavioral-metrics';\nimport OperationalMetrics from './operational-metrics';\nimport BusinessMetrics from './business-metrics';\nimport RtcMetrics from './rtcMetrics';\n\nregisterInternalPlugin('metrics', Metrics, {\n  config,\n});\n\nregisterInternalPlugin('newMetrics', NewMetrics, {\n  config,\n});\n\nexport {default, getOSNameInternal} from './metrics';\n\nexport {\n  config,\n  CALL_DIAGNOSTIC_CONFIG,\n  NewMetrics,\n  Utils,\n  CallDiagnosticUtils,\n  CallDiagnosticLatencies,\n  CallDiagnosticMetrics,\n  BehavioralMetrics,\n  OperationalMetrics,\n  BusinessMetrics,\n  RtcMetrics,\n};\nexport type {\n  ClientEvent,\n  ClientEventLeaveReason,\n  SubmitBehavioralEvent,\n  SubmitClientEvent,\n  SubmitInternalEvent,\n  SubmitMQE,\n  SubmitOperationalEvent,\n  PreComputedLatencies,\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAIA,IAAAA,UAAA,GAAAC,OAAA;AAEA,IAAAC,QAAA,GAAAC,uBAAA,CAAAF,OAAA;AACA,IAAAG,OAAA,GAAAC,sBAAA,CAAAJ,OAAA;AACA,IAAAK,WAAA,GAAAD,sBAAA,CAAAJ,OAAA;AACA,IAAAM,KAAA,GAAAJ,uBAAA,CAAAF,OAAA;AAAiCO,OAAA,CAAAD,KAAA,GAAAA,KAAA;AAWjC,IAAAE,sBAAA,GAAAN,uBAAA,CAAAF,OAAA;AAAmEO,OAAA,CAAAC,sBAAA,GAAAA,sBAAA;AACnE,IAAAC,mBAAA,GAAAP,uBAAA,CAAAF,OAAA;AAAsFO,OAAA,CAAAE,mBAAA,GAAAA,mBAAA;AACtF,IAAAC,uBAAA,GAAAN,sBAAA,CAAAJ,OAAA;AACA,IAAAW,+BAAA,GAAAP,sBAAA,CAAAJ,OAAA;AACA,IAAAY,kBAAA,GAAAR,sBAAA,CAAAJ,OAAA;AACA,IAAAa,mBAAA,GAAAT,sBAAA,CAAAJ,OAAA;AACA,IAAAc,gBAAA,GAAAV,sBAAA,CAAAJ,OAAA;AACA,IAAAe,WAAA,GAAAX,sBAAA,CAAAJ,OAAA;AAAsC,SAAAgB,yBAAAC,CAAA,6BAAAC,QAAA,mBAAAC,CAAA,OAAAD,QAAA,IAAAE,CAAA,OAAAF,QAAA,YAAAF,wBAAA,YAAAA,yBAAAC,CAAA,WAAAA,CAAA,GAAAG,CAAA,GAAAD,CAAA,KAAAF,CAAA;AAAA,SAAAf,wBAAAe,CAAA,EAAAE,CAAA,SAAAA,CAAA,IAAAF,CAAA,IAAAA,CAAA,CAAAI,UAAA,SAAAJ,CAAA,eAAAA,CAAA,gBAAAK,OAAA,CAAAL,CAAA,0BAAAA,CAAA,WAAAM,OAAA,EAAAN,CAAA,QAAAG,CAAA,GAAAJ,wBAAA,CAAAG,CAAA,OAAAC,CAAA,IAAAA,CAAA,CAAAI,GAAA,CAAAP,CAAA,UAAAG,CAAA,CAAAK,GAAA,CAAAR,CAAA,OAAAS,CAAA,KAAAC,SAAA,UAAAC,CAAA,GAAAC,sBAAA,IAAAC,gCAAA,WAAAC,CAAA,IAAAd,CAAA,oBAAAc,CAAA,IAAAC,MAAA,CAAAC,SAAA,CAAAC,cAAA,CAAAC,IAAA,CAAAlB,CAAA,EAAAc,CAAA,SAAAK,CAAA,GAAAR,CAAA,GAAAE,gCAAA,CAAAb,CAAA,EAAAc,CAAA,UAAAK,CAAA,KAAAA,CAAA,CAAAX,GAAA,IAAAW,CAAA,CAAAC,GAAA,IAAAR,sBAAA,CAAAH,CAAA,EAAAK,CAAA,EAAAK,CAAA,IAAAV,CAAA,CAAAK,CAAA,IAAAd,CAAA,CAAAc,CAAA,YAAAL,CAAA,CAAAH,OAAA,GAAAN,CAAA,EAAAG,CAAA,IAAAA,CAAA,CAAAiB,GAAA,CAAApB,CAAA,EAAAS,CAAA,GAAAA,CAAA;AA3BtC;AACA;AACA;;AA2BA,IAAAY,iCAAsB,EAAC,SAAS,EAAEC,gBAAO,EAAE;EACzCC,MAAM,EAANA;AACF,CAAC,CAAC;AAEF,IAAAF,iCAAsB,EAAC,YAAY,EAAEG,mBAAU,EAAE;EAC/CD,MAAM,EAANA;AACF,CAAC,CAAC"}

package/dist/metrics.js

@@ -148,7 +148,7 @@ var Metrics = _webexCore.WebexPlugin.extend({
       }
     });
   },
-  version: "3.5.0-next.4"
+  version: "3.5.0-next.5"
 });
 var _default = exports.default = Metrics;
 //# sourceMappingURL=metrics.js.map

package/dist/rtcMetrics/constants.js

@@ -0,0 +1,11 @@
+"use strict";
+
+var _Object$defineProperty = require("@babel/runtime-corejs2/core-js/object/define-property");
+_Object$defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var RTC_METRICS = exports.default = {
+  APP_ID: 'FFB51ED5-4319-4C55-8303-B1F2FCCDE231'
+};
+//# sourceMappingURL=constants.js.map

package/dist/rtcMetrics/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["RTC_METRICS","exports","default","APP_ID"],"sources":["constants.ts"],"sourcesContent":["const RTC_METRICS = {APP_ID: 'FFB51ED5-4319-4C55-8303-B1F2FCCDE231'};\n\nexport {RTC_METRICS as default};\n"],"mappings":";;;;;;;AAAA,IAAMA,WAAW,GAAAC,OAAA,CAAAC,OAAA,GAAG;EAACC,MAAM,EAAE;AAAsC,CAAC"}

package/dist/rtcMetrics/index.js

@@ -0,0 +1,202 @@
+"use strict";
+
+var _typeof = require("@babel/runtime-corejs2/helpers/typeof");
+var _WeakMap = require("@babel/runtime-corejs2/core-js/weak-map");
+var _Object$defineProperty = require("@babel/runtime-corejs2/core-js/object/define-property");
+var _Object$getOwnPropertyDescriptor = require("@babel/runtime-corejs2/core-js/object/get-own-property-descriptor");
+var _interopRequireDefault = require("@babel/runtime-corejs2/helpers/interopRequireDefault");
+_Object$defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _stringify = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/json/stringify"));
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/classCallCheck"));
+var _createClass2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/createClass"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/defineProperty"));
+var _uuid = _interopRequireDefault(require("uuid"));
+var CallDiagnosticUtils = _interopRequireWildcard(require("../call-diagnostic/call-diagnostic-metrics.util"));
+var _constants = _interopRequireDefault(require("./constants"));
+function _getRequireWildcardCache(e) { if ("function" != typeof _WeakMap) return null; var r = new _WeakMap(), t = new _WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = _Object$defineProperty && _Object$getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? _Object$getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? _Object$defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+/* eslint-disable class-methods-use-this */
+
+var parseJsonPayload = function parseJsonPayload(payload) {
+  try {
+    if (payload && payload[0]) {
+      return JSON.parse(payload[0]);
+    }
+    return null;
+  } catch (_) {
+    return null;
+  }
+};
+
+/**
+ * Rtc Metrics
+ */
+var RtcMetrics = exports.default = /*#__PURE__*/function () {
+  /**
+   * Initialize the interval.
+   *
+   * @param {object} webex - The main `webex` object.
+   * @param {string} meetingId - The meeting id.
+   * @param {string} correlationId - The correlation id.
+   */
+  function RtcMetrics(webex, meetingId, correlationId) {
+    (0, _classCallCheck2.default)(this, RtcMetrics);
+    /**
+     * Array of MetricData items to be sent to the metrics service.
+     */
+    (0, _defineProperty2.default)(this, "metricsQueue", []);
+    (0, _defineProperty2.default)(this, "intervalId", void 0);
+    (0, _defineProperty2.default)(this, "webex", void 0);
+    (0, _defineProperty2.default)(this, "meetingId", void 0);
+    (0, _defineProperty2.default)(this, "correlationId", void 0);
+    (0, _defineProperty2.default)(this, "connectionId", void 0);
+    (0, _defineProperty2.default)(this, "shouldSendMetricsOnNextStatsReport", void 0);
+    // `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}
+   */
+  (0, _createClass2.default)(RtcMetrics, [{
+    key: "sendMetricsInQueue",
+    value: function 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}
+     */
+  }, {
+    key: "sendNextMetrics",
+    value: function 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}
+     */
+  }, {
+    key: "addMetrics",
+    value: function 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.
+          var 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}
+     */
+  }, {
+    key: "closeMetrics",
+    value: function closeMetrics() {
+      this.sendMetricsInQueue();
+      clearInterval(this.intervalId);
+    }
+
+    /**
+     * Anonymize IP addresses.
+     *
+     * @param {array} stats - An RTCStatsReport organized into an array of strings.
+     * @returns {string}
+     */
+  }, {
+    key: "anonymizeIp",
+    value: function anonymizeIp(stats) {
+      var 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 (0, _stringify.default)(data);
+    }
+
+    /**
+     * Set a new connection id.
+     *
+     * @returns {void}
+     */
+  }, {
+    key: "resetConnection",
+    value: function resetConnection() {
+      this.connectionId = _uuid.default.v4();
+      this.shouldSendMetricsOnNextStatsReport = true;
+    }
+
+    /**
+     * Send metrics to the metrics service.
+     *
+     * @returns {void}
+     */
+  }, {
+    key: "sendMetrics",
+    value: function sendMetrics() {
+      this.webex.request({
+        method: 'POST',
+        service: 'unifiedTelemetry',
+        resource: 'metric/v2',
+        headers: {
+          type: 'webrtcMedia',
+          appId: _constants.default.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
+          }]
+        }
+      });
+    }
+  }]);
+  return RtcMetrics;
+}();
+//# sourceMappingURL=index.js.map

package/dist/rtcMetrics/index.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_uuid","_interopRequireDefault","require","CallDiagnosticUtils","_interopRequireWildcard","_constants","_getRequireWildcardCache","e","_WeakMap","r","t","__esModule","_typeof","default","has","get","n","__proto__","a","_Object$defineProperty","_Object$getOwnPropertyDescriptor","u","Object","prototype","hasOwnProperty","call","i","set","parseJsonPayload","payload","JSON","parse","_","RtcMetrics","exports","webex","meetingId","correlationId","_classCallCheck2","_defineProperty2","intervalId","window","setInterval","sendMetricsInQueue","bind","resetConnection","_createClass2","key","value","metricsQueue","length","sendMetrics","sendNextMetrics","shouldSendMetricsOnNextStatsReport","addMetrics","data","name","map","anonymizeIp","push","parsedPayload","console","error","closeMetrics","clearInterval","stats","type","ip","anonymizeIPAddress","undefined","address","relatedAddress","_stringify","connectionId","uuid","v4","request","method","service","resource","headers","appId","RTC_METRICS","APP_ID","body","metrics","version","userId","internal","device"],"sources":["index.ts"],"sourcesContent":["/* eslint-disable class-methods-use-this */\nimport uuid from 'uuid';\nimport * as CallDiagnosticUtils from '../call-diagnostic/call-diagnostic-metrics.util';\nimport RTC_METRICS from './constants';\n\nconst parseJsonPayload = (payload: any[]): any | null => {\n  try {\n    if (payload && payload[0]) {\n      return JSON.parse(payload[0]);\n    }\n\n    return null;\n  } catch (_) {\n    return null;\n  }\n};\n\n/**\n * Rtc Metrics\n */\nexport default class RtcMetrics {\n  /**\n   * Array of MetricData items to be sent to the metrics service.\n   */\n  metricsQueue = [];\n\n  intervalId: number;\n\n  webex: any;\n\n  meetingId: string;\n\n  correlationId: string;\n\n  connectionId: string;\n\n  shouldSendMetricsOnNextStatsReport: boolean;\n\n  /**\n   * Initialize the interval.\n   *\n   * @param {object} webex - The main `webex` object.\n   * @param {string} meetingId - The meeting id.\n   * @param {string} correlationId - The correlation id.\n   */\n  constructor(webex, meetingId, correlationId) {\n    // `window` is used to prevent typescript from returning a NodeJS.Timer.\n    this.intervalId = window.setInterval(this.sendMetricsInQueue.bind(this), 30 * 1000);\n    this.meetingId = meetingId;\n    this.webex = webex;\n    this.correlationId = correlationId;\n    this.resetConnection();\n  }\n\n  /**\n   * Check to see if the metrics queue has any items.\n   *\n   * @returns {void}\n   */\n  public sendMetricsInQueue() {\n    if (this.metricsQueue.length) {\n      this.sendMetrics();\n      this.metricsQueue = [];\n    }\n  }\n\n  /**\n   * Forces sending metrics when we get the next stats-report\n   *\n   * This is useful for cases when something important happens that affects the media connection,\n   * for example when we move from lobby into the meeting.\n   *\n   * @returns {void}\n   */\n  public sendNextMetrics() {\n    this.shouldSendMetricsOnNextStatsReport = true;\n  }\n\n  /**\n   * Add metrics items to the metrics queue.\n   *\n   * @param {object} data - An object with a payload array of metrics items.\n   *\n   * @returns {void}\n   */\n  addMetrics(data) {\n    if (data.payload.length) {\n      if (data.name === 'stats-report') {\n        data.payload = data.payload.map(this.anonymizeIp);\n      }\n\n      this.metricsQueue.push(data);\n\n      if (this.shouldSendMetricsOnNextStatsReport && data.name === 'stats-report') {\n        // this is the first useful set of data (WCME gives it to us after 5s), send it out immediately\n        // in case the user is unhappy and closes the browser early\n        this.sendMetricsInQueue();\n        this.shouldSendMetricsOnNextStatsReport = false;\n      }\n\n      try {\n        // If a connection fails, send the rest of the metrics in queue and get a new connection id.\n        const parsedPayload = parseJsonPayload(data.payload);\n        if (\n          data.name === 'onconnectionstatechange' &&\n          parsedPayload &&\n          parsedPayload.value === 'failed'\n        ) {\n          this.sendMetricsInQueue();\n          this.resetConnection();\n        }\n      } catch (e) {\n        console.error(e);\n      }\n    }\n  }\n\n  /**\n   * Clear the metrics interval.\n   *\n   * @returns {void}\n   */\n  closeMetrics() {\n    this.sendMetricsInQueue();\n    clearInterval(this.intervalId);\n  }\n\n  /**\n   * Anonymize IP addresses.\n   *\n   * @param {array} stats - An RTCStatsReport organized into an array of strings.\n   * @returns {string}\n   */\n  anonymizeIp(stats: string): string {\n    const data = JSON.parse(stats);\n    // on local and remote candidates, anonymize the last 4 bits.\n    if (data.type === 'local-candidate' || data.type === 'remote-candidate') {\n      data.ip = CallDiagnosticUtils.anonymizeIPAddress(data.ip) || undefined;\n      data.address = CallDiagnosticUtils.anonymizeIPAddress(data.address) || undefined;\n      data.relatedAddress =\n        CallDiagnosticUtils.anonymizeIPAddress(data.relatedAddress) || undefined;\n    }\n\n    return JSON.stringify(data);\n  }\n\n  /**\n   * Set a new connection id.\n   *\n   * @returns {void}\n   */\n  private resetConnection() {\n    this.connectionId = uuid.v4();\n    this.shouldSendMetricsOnNextStatsReport = true;\n  }\n\n  /**\n   * Send metrics to the metrics service.\n   *\n   * @returns {void}\n   */\n  private sendMetrics() {\n    this.webex.request({\n      method: 'POST',\n      service: 'unifiedTelemetry',\n      resource: 'metric/v2',\n      headers: {\n        type: 'webrtcMedia',\n        appId: RTC_METRICS.APP_ID,\n      },\n      body: {\n        metrics: [\n          {\n            type: 'webrtc',\n            version: '1.1.0',\n            userId: this.webex.internal.device.userId,\n            meetingId: this.meetingId,\n            correlationId: this.correlationId,\n            connectionId: this.connectionId,\n            data: this.metricsQueue,\n          },\n        ],\n      },\n    });\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;AACA,IAAAA,KAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,mBAAA,GAAAC,uBAAA,CAAAF,OAAA;AACA,IAAAG,UAAA,GAAAJ,sBAAA,CAAAC,OAAA;AAAsC,SAAAI,yBAAAC,CAAA,6BAAAC,QAAA,mBAAAC,CAAA,OAAAD,QAAA,IAAAE,CAAA,OAAAF,QAAA,YAAAF,wBAAA,YAAAA,yBAAAC,CAAA,WAAAA,CAAA,GAAAG,CAAA,GAAAD,CAAA,KAAAF,CAAA;AAAA,SAAAH,wBAAAG,CAAA,EAAAE,CAAA,SAAAA,CAAA,IAAAF,CAAA,IAAAA,CAAA,CAAAI,UAAA,SAAAJ,CAAA,eAAAA,CAAA,gBAAAK,OAAA,CAAAL,CAAA,0BAAAA,CAAA,WAAAM,OAAA,EAAAN,CAAA,QAAAG,CAAA,GAAAJ,wBAAA,CAAAG,CAAA,OAAAC,CAAA,IAAAA,CAAA,CAAAI,GAAA,CAAAP,CAAA,UAAAG,CAAA,CAAAK,GAAA,CAAAR,CAAA,OAAAS,CAAA,KAAAC,SAAA,UAAAC,CAAA,GAAAC,sBAAA,IAAAC,gCAAA,WAAAC,CAAA,IAAAd,CAAA,oBAAAc,CAAA,IAAAC,MAAA,CAAAC,SAAA,CAAAC,cAAA,CAAAC,IAAA,CAAAlB,CAAA,EAAAc,CAAA,SAAAK,CAAA,GAAAR,CAAA,GAAAE,gCAAA,CAAAb,CAAA,EAAAc,CAAA,UAAAK,CAAA,KAAAA,CAAA,CAAAX,GAAA,IAAAW,CAAA,CAAAC,GAAA,IAAAR,sBAAA,CAAAH,CAAA,EAAAK,CAAA,EAAAK,CAAA,IAAAV,CAAA,CAAAK,CAAA,IAAAd,CAAA,CAAAc,CAAA,YAAAL,CAAA,CAAAH,OAAA,GAAAN,CAAA,EAAAG,CAAA,IAAAA,CAAA,CAAAiB,GAAA,CAAApB,CAAA,EAAAS,CAAA,GAAAA,CAAA;AAHtC;;AAKA,IAAMY,gBAAgB,GAAG,SAAnBA,gBAAgBA,CAAIC,OAAc,EAAiB;EACvD,IAAI;IACF,IAAIA,OAAO,IAAIA,OAAO,CAAC,CAAC,CAAC,EAAE;MACzB,OAAOC,IAAI,CAACC,KAAK,CAACF,OAAO,CAAC,CAAC,CAAC,CAAC;IAC/B;IAEA,OAAO,IAAI;EACb,CAAC,CAAC,OAAOG,CAAC,EAAE;IACV,OAAO,IAAI;EACb;AACF,CAAC;;AAED;AACA;AACA;AAFA,IAGqBC,UAAU,GAAAC,OAAA,CAAArB,OAAA;EAkB7B;AACF;AACA;AACA;AACA;AACA;AACA;EACE,SAAAoB,WAAYE,KAAK,EAAEC,SAAS,EAAEC,aAAa,EAAE;IAAA,IAAAC,gBAAA,CAAAzB,OAAA,QAAAoB,UAAA;IAxB7C;AACF;AACA;IAFE,IAAAM,gBAAA,CAAA1B,OAAA,wBAGe,EAAE;IAAA,IAAA0B,gBAAA,CAAA1B,OAAA;IAAA,IAAA0B,gBAAA,CAAA1B,OAAA;IAAA,IAAA0B,gBAAA,CAAA1B,OAAA;IAAA,IAAA0B,gBAAA,CAAA1B,OAAA;IAAA,IAAA0B,gBAAA,CAAA1B,OAAA;IAAA,IAAA0B,gBAAA,CAAA1B,OAAA;IAsBf;IACA,IAAI,CAAC2B,UAAU,GAAGC,MAAM,CAACC,WAAW,CAAC,IAAI,CAACC,kBAAkB,CAACC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,IAAI,CAAC;IACnF,IAAI,CAACR,SAAS,GAAGA,SAAS;IAC1B,IAAI,CAACD,KAAK,GAAGA,KAAK;IAClB,IAAI,CAACE,aAAa,GAAGA,aAAa;IAClC,IAAI,CAACQ,eAAe,CAAC,CAAC;EACxB;;EAEA;AACF;AACA;AACA;AACA;EAJE,IAAAC,aAAA,CAAAjC,OAAA,EAAAoB,UAAA;IAAAc,GAAA;IAAAC,KAAA,EAKA,SAAAL,mBAAA,EAA4B;MAC1B,IAAI,IAAI,CAACM,YAAY,CAACC,MAAM,EAAE;QAC5B,IAAI,CAACC,WAAW,CAAC,CAAC;QAClB,IAAI,CAACF,YAAY,GAAG,EAAE;MACxB;IACF;;IAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EAPE;IAAAF,GAAA;IAAAC,KAAA,EAQA,SAAAI,gBAAA,EAAyB;MACvB,IAAI,CAACC,kCAAkC,GAAG,IAAI;IAChD;;IAEA;AACF;AACA;AACA;AACA;AACA;AACA;EANE;IAAAN,GAAA;IAAAC,KAAA,EAOA,SAAAM,WAAWC,IAAI,EAAE;MACf,IAAIA,IAAI,CAAC1B,OAAO,CAACqB,MAAM,EAAE;QACvB,IAAIK,IAAI,CAACC,IAAI,KAAK,cAAc,EAAE;UAChCD,IAAI,CAAC1B,OAAO,GAAG0B,IAAI,CAAC1B,OAAO,CAAC4B,GAAG,CAAC,IAAI,CAACC,WAAW,CAAC;QACnD;QAEA,IAAI,CAACT,YAAY,CAACU,IAAI,CAACJ,IAAI,CAAC;QAE5B,IAAI,IAAI,CAACF,kCAAkC,IAAIE,IAAI,CAACC,IAAI,KAAK,cAAc,EAAE;UAC3E;UACA;UACA,IAAI,CAACb,kBAAkB,CAAC,CAAC;UACzB,IAAI,CAACU,kCAAkC,GAAG,KAAK;QACjD;QAEA,IAAI;UACF;UACA,IAAMO,aAAa,GAAGhC,gBAAgB,CAAC2B,IAAI,CAAC1B,OAAO,CAAC;UACpD,IACE0B,IAAI,CAACC,IAAI,KAAK,yBAAyB,IACvCI,aAAa,IACbA,aAAa,CAACZ,KAAK,KAAK,QAAQ,EAChC;YACA,IAAI,CAACL,kBAAkB,CAAC,CAAC;YACzB,IAAI,CAACE,eAAe,CAAC,CAAC;UACxB;QACF,CAAC,CAAC,OAAOtC,CAAC,EAAE;UACVsD,OAAO,CAACC,KAAK,CAACvD,CAAC,CAAC;QAClB;MACF;IACF;;IAEA;AACF;AACA;AACA;AACA;EAJE;IAAAwC,GAAA;IAAAC,KAAA,EAKA,SAAAe,aAAA,EAAe;MACb,IAAI,CAACpB,kBAAkB,CAAC,CAAC;MACzBqB,aAAa,CAAC,IAAI,CAACxB,UAAU,CAAC;IAChC;;IAEA;AACF;AACA;AACA;AACA;AACA;EALE;IAAAO,GAAA;IAAAC,KAAA,EAMA,SAAAU,YAAYO,KAAa,EAAU;MACjC,IAAMV,IAAI,GAAGzB,IAAI,CAACC,KAAK,CAACkC,KAAK,CAAC;MAC9B;MACA,IAAIV,IAAI,CAACW,IAAI,KAAK,iBAAiB,IAAIX,IAAI,CAACW,IAAI,KAAK,kBAAkB,EAAE;QACvEX,IAAI,CAACY,EAAE,GAAGhE,mBAAmB,CAACiE,kBAAkB,CAACb,IAAI,CAACY,EAAE,CAAC,IAAIE,SAAS;QACtEd,IAAI,CAACe,OAAO,GAAGnE,mBAAmB,CAACiE,kBAAkB,CAACb,IAAI,CAACe,OAAO,CAAC,IAAID,SAAS;QAChFd,IAAI,CAACgB,cAAc,GACjBpE,mBAAmB,CAACiE,kBAAkB,CAACb,IAAI,CAACgB,cAAc,CAAC,IAAIF,SAAS;MAC5E;MAEA,OAAO,IAAAG,UAAA,CAAA3D,OAAA,EAAe0C,IAAI,CAAC;IAC7B;;IAEA;AACF;AACA;AACA;AACA;EAJE;IAAAR,GAAA;IAAAC,KAAA,EAKA,SAAAH,gBAAA,EAA0B;MACxB,IAAI,CAAC4B,YAAY,GAAGC,aAAI,CAACC,EAAE,CAAC,CAAC;MAC7B,IAAI,CAACtB,kCAAkC,GAAG,IAAI;IAChD;;IAEA;AACF;AACA;AACA;AACA;EAJE;IAAAN,GAAA;IAAAC,KAAA,EAKA,SAAAG,YAAA,EAAsB;MACpB,IAAI,CAAChB,KAAK,CAACyC,OAAO,CAAC;QACjBC,MAAM,EAAE,MAAM;QACdC,OAAO,EAAE,kBAAkB;QAC3BC,QAAQ,EAAE,WAAW;QACrBC,OAAO,EAAE;UACPd,IAAI,EAAE,aAAa;UACnBe,KAAK,EAAEC,kBAAW,CAACC;QACrB,CAAC;QACDC,IAAI,EAAE;UACJC,OAAO,EAAE,CACP;YACEnB,IAAI,EAAE,QAAQ;YACdoB,OAAO,EAAE,OAAO;YAChBC,MAAM,EAAE,IAAI,CAACpD,KAAK,CAACqD,QAAQ,CAACC,MAAM,CAACF,MAAM;YACzCnD,SAAS,EAAE,IAAI,CAACA,SAAS;YACzBC,aAAa,EAAE,IAAI,CAACA,aAAa;YACjCoC,YAAY,EAAE,IAAI,CAACA,YAAY;YAC/BlB,IAAI,EAAE,IAAI,CAACN;UACb,CAAC;QAEL;MACF,CAAC,CAAC;IACJ;EAAC;EAAA,OAAAhB,UAAA;AAAA"}

package/dist/types/index.d.ts

@@ -12,6 +12,7 @@ import CallDiagnosticLatencies from './call-diagnostic/call-diagnostic-metrics-l
 import BehavioralMetrics from './behavioral-metrics';
 import OperationalMetrics from './operational-metrics';
 import BusinessMetrics from './business-metrics';
+import RtcMetrics from './rtcMetrics';
 export { default, getOSNameInternal } from './metrics';
-export { config, CALL_DIAGNOSTIC_CONFIG, NewMetrics, Utils, CallDiagnosticUtils, CallDiagnosticLatencies, CallDiagnosticMetrics, BehavioralMetrics, OperationalMetrics, BusinessMetrics, };
+export { config, CALL_DIAGNOSTIC_CONFIG, NewMetrics, Utils, CallDiagnosticUtils, CallDiagnosticLatencies, CallDiagnosticMetrics, BehavioralMetrics, OperationalMetrics, BusinessMetrics, RtcMetrics, };
 export type { ClientEvent, ClientEventLeaveReason, SubmitBehavioralEvent, SubmitClientEvent, SubmitInternalEvent, SubmitMQE, SubmitOperationalEvent, PreComputedLatencies, };

package/dist/types/rtcMetrics/constants.d.ts

@@ -0,0 +1,4 @@
+declare const RTC_METRICS: {
+    APP_ID: string;
+};
+export { RTC_METRICS as default };

package/dist/types/rtcMetrics/index.d.ts

@@ -0,0 +1,71 @@
+/**
+ * Rtc Metrics
+ */
+export default class RtcMetrics {
+    /**
+     * Array of MetricData items to be sent to the metrics service.
+     */
+    metricsQueue: any[];
+    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: any, meetingId: any, correlationId: any);
+    /**
+     * Check to see if the metrics queue has any items.
+     *
+     * @returns {void}
+     */
+    sendMetricsInQueue(): void;
+    /**
+     * 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}
+     */
+    sendNextMetrics(): void;
+    /**
+     * Add metrics items to the metrics queue.
+     *
+     * @param {object} data - An object with a payload array of metrics items.
+     *
+     * @returns {void}
+     */
+    addMetrics(data: any): void;
+    /**
+     * Clear the metrics interval.
+     *
+     * @returns {void}
+     */
+    closeMetrics(): void;
+    /**
+     * Anonymize IP addresses.
+     *
+     * @param {array} stats - An RTCStatsReport organized into an array of strings.
+     * @returns {string}
+     */
+    anonymizeIp(stats: string): string;
+    /**
+     * Set a new connection id.
+     *
+     * @returns {void}
+     */
+    private resetConnection;
+    /**
+     * Send metrics to the metrics service.
+     *
+     * @returns {void}
+     */
+    private sendMetrics;
+}

package/package.json

@@ -26,22 +26,22 @@
     "@webex/eslint-config-legacy": "0.0.0",
     "@webex/jest-config-legacy": "0.0.0",
     "@webex/legacy-tools": "0.0.0",
-    "@webex/test-helper-chai": "3.5.0-next.4",
-    "@webex/test-helper-mocha": "3.5.0-next.4",
-    "@webex/test-helper-mock-webex": "3.5.0-next.4",
-    "@webex/test-helper-test-users": "3.5.0-next.4",
+    "@webex/test-helper-chai": "3.5.0-next.5",
+    "@webex/test-helper-mocha": "3.5.0-next.5",
+    "@webex/test-helper-mock-webex": "3.5.0-next.5",
+    "@webex/test-helper-test-users": "3.5.0-next.5",
     "eslint": "^8.24.0",
     "prettier": "^2.7.1",
     "sinon": "^9.2.4"
   },
   "dependencies": {
-    "@webex/common": "3.5.0-next.4",
-    "@webex/common-timers": "3.5.0-next.4",
+    "@webex/common": "3.5.0-next.5",
+    "@webex/common-timers": "3.5.0-next.5",
     "@webex/event-dictionary-ts": "^1.0.1546",
-    "@webex/internal-plugin-metrics": "3.5.0-next.4",
-    "@webex/test-helper-chai": "3.5.0-next.4",
-    "@webex/test-helper-mock-webex": "3.5.0-next.4",
-    "@webex/webex-core": "3.5.0-next.4",
+    "@webex/internal-plugin-metrics": "3.5.0-next.5",
+    "@webex/test-helper-chai": "3.5.0-next.5",
+    "@webex/test-helper-mock-webex": "3.5.0-next.5",
+    "@webex/webex-core": "3.5.0-next.5",
     "ip-anonymize": "^0.1.0",
     "lodash": "^4.17.21",
     "uuid": "^3.3.2"
@@ -54,5 +54,5 @@
     "test:style": "eslint ./src/**/*.*",
     "test:unit": "webex-legacy-tools test --unit --runner mocha"
   },
-  "version": "3.5.0-next.4"
+  "version": "3.5.0-next.5"
 }

package/src/index.ts

@@ -25,6 +25,7 @@ import CallDiagnosticLatencies from './call-diagnostic/call-diagnostic-metrics-l
 import BehavioralMetrics from './behavioral-metrics';
 import OperationalMetrics from './operational-metrics';
 import BusinessMetrics from './business-metrics';
+import RtcMetrics from './rtcMetrics';
 
 registerInternalPlugin('metrics', Metrics, {
   config,
@@ -47,6 +48,7 @@ export {
   BehavioralMetrics,
   OperationalMetrics,
   BusinessMetrics,
+  RtcMetrics,
 };
 export type {
   ClientEvent,

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/call-diagnostic/call-diagnostic-metrics.ts

@@ -1,7 +1,9 @@
 import sinon from 'sinon';
+import bowser from 'bowser';
 import {assert} from '@webex/test-helper-chai';
 import {WebexHttpError} from '@webex/webex-core';
 import {BrowserDetection} from '@webex/common';
+import window from 'global/window';
 import {
   CallDiagnosticLatencies,
   CallDiagnosticMetrics,
@@ -1012,6 +1014,9 @@ describe('internal-plugin-metrics', () => {
         const getIdentifiersSpy = sinon.spy(cd, 'getIdentifiers');
         const getSubServiceTypeSpy = sinon.spy(cd, 'getSubServiceType');
         const validatorSpy = sinon.spy(cd, 'validator');
+        sinon.stub(window.navigator, 'userAgent').get(() => userAgent);
+        sinon.stub(bowser, 'getParser').returns(userAgent);
+
         const options = {
           meetingId: fakeMeeting.id,
           mediaConnections: [{mediaAgentAlias: 'alias', mediaAgentGroupId: '1'}],
@@ -1040,7 +1045,7 @@ describe('internal-plugin-metrics', () => {
         assert.deepEqual(webexLoggerLogCalls[2].args, [
           'call-diagnostic-events -> ',
           'CallDiagnosticMetrics: @createClientEventObjectInMeeting => collected browser data',
-          '{"error":"unable to access window.navigator.userAgent"}',
+          `${JSON.stringify(userAgent)}`,
         ]);
 
         assert.deepEqual(webexLoggerLogCalls[3].args, [
@@ -2768,11 +2773,11 @@ describe('internal-plugin-metrics', () => {
       // The method is called in beforeEach itself. We are just testing it here
       it('sets the received deviceInfo to call-diagnostics', () => {
         const webexLoggerLogCalls = webex.logger.log.getCalls();
-        const device = { userId: 'userId', url: 'deviceUrl', orgId: 'orgId' };
+        const device = {userId: 'userId', url: 'deviceUrl', orgId: 'orgId'};
 
         assert.deepEqual(webexLoggerLogCalls[0].args, [
           'CallDiagnosticMetrics: @setDeviceInfo called',
-          device
+          device,
         ]);
 
         assert.deepEqual(cd.device, device);

package/test/unit/spec/rtcMetrics/index.ts

@@ -0,0 +1,155 @@
+import 'jsdom-global/register';
+import RtcMetrics from '../../../../src/rtcMetrics';
+import MockWebex from '@webex/test-helper-mock-webex';
+import {assert} from '@webex/test-helper-chai';
+import sinon from 'sinon';
+import RTC_METRICS from '../../../../src/rtcMetrics/constants';
+
+const FAKE_METRICS_ITEM = {payload: ['{"type":"string","value":"fake-metrics","id":""}']};
+const FAILURE_METRICS_ITEM = {
+  name: "onconnectionstatechange",
+  payload: ['{"type":"string","value":"failed","id":""}'],
+  timestamp: 1707929986667
+};
+
+const STATS_WITH_IP = '{"id":"RTCIceCandidate_/kQs0ZNU","type":"remote-candidate","transportId":"RTCTransport_0_1","isRemote":true,"ip":"11.22.111.255","address":"11.22.111.255","port":5004,"protocol":"udp","candidateType":"host","priority":2130706431}';
+const STATS_WITH_IP_RESULT = '{"id":"RTCIceCandidate_/kQs0ZNU","type":"remote-candidate","transportId":"RTCTransport_0_1","isRemote":true,"ip":"11.22.111.240","address":"11.22.111.240","port":5004,"protocol":"udp","candidateType":"host","priority":2130706431}';
+
+describe('RtcMetrics', () => {
+  let metrics: RtcMetrics;
+  let webex: MockWebex;
+  let clock;
+  let anonymizeIpSpy;
+
+  const sandbox = sinon.createSandbox();
+
+  beforeEach(() => {
+    clock = sinon.useFakeTimers();
+    window.setInterval = setInterval;
+    webex = new MockWebex();
+    metrics = new RtcMetrics(webex, 'mock-meeting-id', 'mock-correlation-id');
+    anonymizeIpSpy = sandbox.spy(metrics, 'anonymizeIp');
+  });
+
+  afterEach(() => {
+    sandbox.restore();
+  });
+
+  it('sendMetrics should send a webex request', () => {
+    assert.notCalled(webex.request);
+
+    metrics.addMetrics(FAKE_METRICS_ITEM);
+    (metrics as any).sendMetrics();
+
+    assert.callCount(webex.request, 1);
+    assert.calledWithMatch(webex.request, sinon.match.has('headers', {
+      type: 'webrtcMedia',
+      appId: RTC_METRICS.APP_ID,
+    }));
+    assert.calledWithMatch(webex.request, sinon.match.hasNested('body.metrics[0].data[0].payload', FAKE_METRICS_ITEM.payload));
+    assert.calledWithMatch(webex.request, sinon.match.hasNested('body.metrics[0].meetingId', 'mock-meeting-id'));
+    assert.calledWithMatch(webex.request, sinon.match.hasNested('body.metrics[0].correlationId', 'mock-correlation-id'));
+  });
+
+  it('should have a defined sendMetricsInQueue function which is public', () => {
+    assert.isDefined(metrics.sendMetricsInQueue);
+    assert.isFunction(metrics.sendMetricsInQueue);
+  });
+
+  it('should send metrics requests over time', () => {
+    assert.notCalled(webex.request);
+
+    metrics.addMetrics(FAKE_METRICS_ITEM);
+    assert.deepEqual(metrics.metricsQueue, [FAKE_METRICS_ITEM]);
+    clock.tick(60 * 1000);
+
+    assert.callCount(webex.request, 1);
+  });
+
+  it('should not send requests with no items in the queue', () => {
+    clock.tick(60 * 1000);
+    assert.notCalled(webex.request);
+  });
+
+  it('sendMetricsInQueue should send metrics if any exist in the queue', () => {
+    assert.notCalled(webex.request);
+
+    metrics.addMetrics(FAKE_METRICS_ITEM);
+    (metrics as any).sendMetricsInQueue();
+
+    assert.callCount(webex.request, 1);
+  });
+
+  it('should clear out metrics on close', () => {
+    assert.notCalled(webex.request);
+
+    metrics.addMetrics(FAKE_METRICS_ITEM);
+    metrics.closeMetrics();
+
+    assert.callCount(webex.request, 1);
+  });
+
+  it('should clear out metrics on failure', () => {
+    assert.notCalled(webex.request);
+
+    metrics.addMetrics(FAILURE_METRICS_ITEM);
+
+    assert.callCount(webex.request, 1);
+  });
+
+  it('should have the same connectionId on success', () => {
+    const originalId = metrics.connectionId;
+
+    metrics.addMetrics(FAKE_METRICS_ITEM);
+
+    assert.strictEqual(originalId, metrics.connectionId);
+  });
+
+  it('should have a new connectionId on failure', () => {
+    const originalId = metrics.connectionId;
+
+    metrics.addMetrics(FAILURE_METRICS_ITEM);
+
+    assert.notEqual(originalId, metrics.connectionId);
+  });
+
+  it('should anonymize IP addresses', () => {
+    assert.strictEqual(metrics.anonymizeIp(STATS_WITH_IP), STATS_WITH_IP_RESULT);
+  });
+
+  it('should call anonymizeIp', () => {
+    metrics.addMetrics({ name: 'stats-report', payload: [STATS_WITH_IP] });
+    assert.calledOnce(anonymizeIpSpy);
+  })
+
+  it('should send metrics on first stats-report', () => {
+    assert.callCount(webex.request, 0);
+
+    metrics.addMetrics(FAKE_METRICS_ITEM);
+    assert.callCount(webex.request, 0);
+
+    // first stats-report should trigger a call to webex.request
+    metrics.addMetrics({ name: 'stats-report', payload: [STATS_WITH_IP] });
+    assert.callCount(webex.request, 1);
+  });
+
+  it('should send metrics on first stats-report after a new connection', () => {
+    assert.callCount(webex.request, 0);
+
+    // first stats-report should trigger a call to webex.request
+    metrics.addMetrics({ name: 'stats-report', payload: [STATS_WITH_IP] });
+    assert.callCount(webex.request, 1);
+
+    // subsequent stats-report doesn't trigger it
+    metrics.addMetrics({ name: 'stats-report', payload: [STATS_WITH_IP] });
+    assert.callCount(webex.request, 1);
+
+    // now, simulate a failure - that triggers a new connection and upload of the metrics
+    metrics.addMetrics(FAILURE_METRICS_ITEM);
+    assert.callCount(webex.request, 2);
+
+    // and another stats-report should trigger another upload of the metrics
+    metrics.addMetrics({ name: 'stats-report', payload: [STATS_WITH_IP] });
+    assert.callCount(webex.request, 3);
+  });
+});