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

package/dist/rtcMetrics/index.js

@@ -0,0 +1,223 @@
+"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 {IdType} Ids - Meeting or Calling id.
+   * @param {string} correlationId - The correlation id.
+   */
+  function RtcMetrics(webex, _ref, correlationId) {
+    var meetingId = _ref.meetingId,
+      callId = _ref.callId;
+    (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, "callId", 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.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}
+   */
+  (0, _createClass2.default)(RtcMetrics, [{
+    key: "updateCallId",
+    value: function updateCallId(callId) {
+      this.callId = callId;
+    }
+
+    /**
+     * Check to see if the metrics queue has any items.
+     *
+     * @returns {void}
+     */
+  }, {
+    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() {
+      var metricsAttributes = {
+        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: _constants.default.APP_ID
+        },
+        body: {
+          metrics: [metricsAttributes]
+        }
+      });
+    }
+  }]);
+  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","_ref","correlationId","meetingId","callId","_classCallCheck2","_defineProperty2","intervalId","window","setInterval","sendMetricsInQueue","bind","resetConnection","_createClass2","key","value","updateCallId","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","metricsAttributes","version","userId","internal","device","request","method","service","resource","headers","appId","RTC_METRICS","APP_ID","body","metrics"],"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';\nimport {IdType, IMetricsAttributes} from '../metrics.types';\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  callId?: 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 {IdType} Ids - Meeting or Calling id.\n   * @param {string} correlationId - The correlation id.\n   */\n  constructor(webex, {meetingId, callId}: IdType, 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.callId = callId;\n    this.webex = webex;\n    this.correlationId = correlationId;\n    this.resetConnection();\n  }\n\n  /**\n   * Updates the call identifier with the provided value.\n   *\n   * @param {string} callId - The new call identifier to set.\n   * @returns {void}\n   */\n  public updateCallId(callId: string) {\n    this.callId = callId;\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    const metricsAttributes: IMetricsAttributes = {\n      type: 'webrtc',\n      version: '1.1.0',\n      userId: this.webex.internal.device.userId,\n      correlationId: this.correlationId,\n      connectionId: this.connectionId,\n      data: this.metricsQueue,\n    };\n\n    if (this.meetingId) {\n      metricsAttributes.meetingId = this.meetingId;\n    } else if (this.callId) {\n      metricsAttributes.callId = this.callId;\n    }\n\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: [metricsAttributes],\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;;AAMA,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;EAoB7B;AACF;AACA;AACA;AACA;AACA;AACA;EACE,SAAAoB,WAAYE,KAAK,EAAAC,IAAA,EAA+BC,aAAa,EAAE;IAAA,IAA3CC,SAAS,GAAAF,IAAA,CAATE,SAAS;MAAEC,MAAM,GAAAH,IAAA,CAANG,MAAM;IAAA,IAAAC,gBAAA,CAAA3B,OAAA,QAAAoB,UAAA;IA1BrC;AACF;AACA;IAFE,IAAAQ,gBAAA,CAAA5B,OAAA,wBAGe,EAAE;IAAA,IAAA4B,gBAAA,CAAA5B,OAAA;IAAA,IAAA4B,gBAAA,CAAA5B,OAAA;IAAA,IAAA4B,gBAAA,CAAA5B,OAAA;IAAA,IAAA4B,gBAAA,CAAA5B,OAAA;IAAA,IAAA4B,gBAAA,CAAA5B,OAAA;IAAA,IAAA4B,gBAAA,CAAA5B,OAAA;IAAA,IAAA4B,gBAAA,CAAA5B,OAAA;IAwBf;IACA,IAAI,CAAC6B,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,CAACC,MAAM,GAAGA,MAAM;IACpB,IAAI,CAACJ,KAAK,GAAGA,KAAK;IAClB,IAAI,CAACE,aAAa,GAAGA,aAAa;IAClC,IAAI,CAACU,eAAe,CAAC,CAAC;EACxB;;EAEA;AACF;AACA;AACA;AACA;AACA;EALE,IAAAC,aAAA,CAAAnC,OAAA,EAAAoB,UAAA;IAAAgB,GAAA;IAAAC,KAAA,EAMA,SAAAC,aAAoBZ,MAAc,EAAE;MAClC,IAAI,CAACA,MAAM,GAAGA,MAAM;IACtB;;IAEA;AACF;AACA;AACA;AACA;EAJE;IAAAU,GAAA;IAAAC,KAAA,EAKA,SAAAL,mBAAA,EAA4B;MAC1B,IAAI,IAAI,CAACO,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;IAAAH,GAAA;IAAAC,KAAA,EAQA,SAAAK,gBAAA,EAAyB;MACvB,IAAI,CAACC,kCAAkC,GAAG,IAAI;IAChD;;IAEA;AACF;AACA;AACA;AACA;AACA;AACA;EANE;IAAAP,GAAA;IAAAC,KAAA,EAOA,SAAAO,WAAWC,IAAI,EAAE;MACf,IAAIA,IAAI,CAAC7B,OAAO,CAACwB,MAAM,EAAE;QACvB,IAAIK,IAAI,CAACC,IAAI,KAAK,cAAc,EAAE;UAChCD,IAAI,CAAC7B,OAAO,GAAG6B,IAAI,CAAC7B,OAAO,CAAC+B,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,CAACd,kBAAkB,CAAC,CAAC;UACzB,IAAI,CAACW,kCAAkC,GAAG,KAAK;QACjD;QAEA,IAAI;UACF;UACA,IAAMO,aAAa,GAAGnC,gBAAgB,CAAC8B,IAAI,CAAC7B,OAAO,CAAC;UACpD,IACE6B,IAAI,CAACC,IAAI,KAAK,yBAAyB,IACvCI,aAAa,IACbA,aAAa,CAACb,KAAK,KAAK,QAAQ,EAChC;YACA,IAAI,CAACL,kBAAkB,CAAC,CAAC;YACzB,IAAI,CAACE,eAAe,CAAC,CAAC;UACxB;QACF,CAAC,CAAC,OAAOxC,CAAC,EAAE;UACVyD,OAAO,CAACC,KAAK,CAAC1D,CAAC,CAAC;QAClB;MACF;IACF;;IAEA;AACF;AACA;AACA;AACA;EAJE;IAAA0C,GAAA;IAAAC,KAAA,EAKA,SAAAgB,aAAA,EAAe;MACb,IAAI,CAACrB,kBAAkB,CAAC,CAAC;MACzBsB,aAAa,CAAC,IAAI,CAACzB,UAAU,CAAC;IAChC;;IAEA;AACF;AACA;AACA;AACA;AACA;EALE;IAAAO,GAAA;IAAAC,KAAA,EAMA,SAAAW,YAAYO,KAAa,EAAU;MACjC,IAAMV,IAAI,GAAG5B,IAAI,CAACC,KAAK,CAACqC,KAAK,CAAC;MAC9B;MACA,IAAIV,IAAI,CAACW,IAAI,KAAK,iBAAiB,IAAIX,IAAI,CAACW,IAAI,KAAK,kBAAkB,EAAE;QACvEX,IAAI,CAACY,EAAE,GAAGnE,mBAAmB,CAACoE,kBAAkB,CAACb,IAAI,CAACY,EAAE,CAAC,IAAIE,SAAS;QACtEd,IAAI,CAACe,OAAO,GAAGtE,mBAAmB,CAACoE,kBAAkB,CAACb,IAAI,CAACe,OAAO,CAAC,IAAID,SAAS;QAChFd,IAAI,CAACgB,cAAc,GACjBvE,mBAAmB,CAACoE,kBAAkB,CAACb,IAAI,CAACgB,cAAc,CAAC,IAAIF,SAAS;MAC5E;MAEA,OAAO,IAAAG,UAAA,CAAA9D,OAAA,EAAe6C,IAAI,CAAC;IAC7B;;IAEA;AACF;AACA;AACA;AACA;EAJE;IAAAT,GAAA;IAAAC,KAAA,EAKA,SAAAH,gBAAA,EAA0B;MACxB,IAAI,CAAC6B,YAAY,GAAGC,aAAI,CAACC,EAAE,CAAC,CAAC;MAC7B,IAAI,CAACtB,kCAAkC,GAAG,IAAI;IAChD;;IAEA;AACF;AACA;AACA;AACA;EAJE;IAAAP,GAAA;IAAAC,KAAA,EAKA,SAAAI,YAAA,EAAsB;MACpB,IAAMyB,iBAAqC,GAAG;QAC5CV,IAAI,EAAE,QAAQ;QACdW,OAAO,EAAE,OAAO;QAChBC,MAAM,EAAE,IAAI,CAAC9C,KAAK,CAAC+C,QAAQ,CAACC,MAAM,CAACF,MAAM;QACzC5C,aAAa,EAAE,IAAI,CAACA,aAAa;QACjCuC,YAAY,EAAE,IAAI,CAACA,YAAY;QAC/BlB,IAAI,EAAE,IAAI,CAACN;MACb,CAAC;MAED,IAAI,IAAI,CAACd,SAAS,EAAE;QAClByC,iBAAiB,CAACzC,SAAS,GAAG,IAAI,CAACA,SAAS;MAC9C,CAAC,MAAM,IAAI,IAAI,CAACC,MAAM,EAAE;QACtBwC,iBAAiB,CAACxC,MAAM,GAAG,IAAI,CAACA,MAAM;MACxC;MAEA,IAAI,CAACJ,KAAK,CAACiD,OAAO,CAAC;QACjBC,MAAM,EAAE,MAAM;QACdC,OAAO,EAAE,kBAAkB;QAC3BC,QAAQ,EAAE,WAAW;QACrBC,OAAO,EAAE;UACPnB,IAAI,EAAE,aAAa;UACnBoB,KAAK,EAAEC,kBAAW,CAACC;QACrB,CAAC;QACDC,IAAI,EAAE;UACJC,OAAO,EAAE,CAACd,iBAAiB;QAC7B;MACF,CAAC,CAAC;IACJ;EAAC;EAAA,OAAA9C,UAAA;AAAA"}

package/dist/types/business-metrics.d.ts

@@ -1,5 +1,5 @@
 import GenericMetrics from './generic-metrics';
-import { EventPayload } from './metrics.types';
+import { EventPayload, Table } from './metrics.types';
 /**
  * @description Util class to handle Buisness Metrics
  * @export
@@ -7,13 +7,45 @@ import { EventPayload } from './metrics.types';
  */
 export default class BusinessMetrics extends GenericMetrics {
     /**
-     * Submit a buisness metric to our metrics endpoint.
+     * unfortunately, the pinot team does not allow changes to the schema of wbxapp_callend_metrics
+     * so we have to shim this layer specifically for this
+     * https://confluence-eng-gpk2.cisco.com/conf/display/WAP/Table+wbxapp_callend_metrics
+     * @param {EventPayload} payload payload of the metric
+     * @returns {Promise<any>}
+     */
+    private submitCallEndEvent;
+    /**
+     * Submit a buisness metric to our metrics endpoint, going to the default business_ucf table
+     * all event payload keys are converted into a hex string value
+     * unfortunately, the pinot team does not allow changes to the schema of business_metrics
+     * so we have to shim this layer specifically for this
+     * https://confluence-eng-gpk2.cisco.com/conf/display/WAP/Table%3A+business_metrics
+     * @param {string} name of the metric
+     * @param {EventPayload} payload payload of the metric
+     * @returns {Promise<any>}
+     */
+    private submitBusinessMetricsEvent;
+    /**
+     * Submit a buisness metric to our metrics endpoint, going to the default business_ucf table
+     * all event payload keys are converted into a hex string value
+     * https://confluence-eng-gpk2.cisco.com/conf/display/WAP/Business+metrics++-%3E+ROMA
      * @param {string} name of the metric
      * @param {EventPayload} user payload of the metric
      * @returns {Promise<any>}
      */
-    submitBusinessEvent({ name, payload }: {
+    private submitDefaultEvent;
+    /**
+     * Submit a buisness metric to our metrics endpoint.
+     * routes to the correct table with the correct schema payload by table
+     * https://confluence-eng-gpk2.cisco.com/conf/display/WAP/Business+metrics++-%3E+ROMA
+     * @param {string} name of the metric, ignored if going to wbxapp_callend_metrics
+     * @param {EventPayload} payload user payload of the metric
+     * @param {Table} table optional - to submit the metric to and adapt the sent schema
+     * @returns {Promise<any>}
+     */
+    submitBusinessEvent({ name, payload, table, }: {
         name: string;
         payload: EventPayload;
-    }): void;
+        table?: Table;
+    }): Promise<void>;
 }

package/dist/types/call-diagnostic/call-diagnostic-metrics.d.ts

@@ -66,7 +66,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
      * @returns
      */
     getOrigin(options: GetOriginOptions, meetingId?: string): {
-        name: "endpoint" | "addin" | "antares" | "appapi" | "beech" | "breakout" | "calendar" | "cb" | "cca" | "ccc" | "cloudproxy" | "edonus" | "givr" | "hecate" | "hedge" | "hesiod" | "homer" | "superhomer" | "l2sip" | "linus" | "locus" | "mbs" | "mcc" | "mcs" | "mercury" | "mes" | "mjs" | "mmp" | "mygdon" | "ngservice" | "orpheus" | "page" | "poros" | "publicapi" | "rhesos" | "terminus" | "tpgw" | "ucc" | "wdm" | "webexivr";
+        name: "endpoint" | "addin" | "antares" | "appapi" | "beech" | "breakout" | "calendar" | "cb" | "cca" | "ccc" | "cloudproxy" | "crc" | "edonus" | "givr" | "hecate" | "hedge" | "hesiod" | "homer" | "superhomer" | "l2sip" | "linus" | "locus" | "mbs" | "mcc" | "mcs" | "mercury" | "mes" | "mjs" | "mmp" | "mygdon" | "ngservice" | "orpheus" | "page" | "poros" | "publicapi" | "rhesos" | "terminus" | "tpgw" | "ucc" | "wdm" | "webexivr" | "meetingcontainer";
         userAgent: string;
         buildType?: "debug" | "test" | "prod" | "tap" | "analyzer-test";
         upgradeChannel?: string;
@@ -137,6 +137,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         emmVendorId?: string;
         isHybridMedia?: boolean;
         originData?: {};
+        serviceVersion?: string;
         additionalProperties?: false;
     };
     /**
@@ -146,6 +147,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
      */
     getIdentifiers(options: GetIdentifiersOptions): {
         attendeeId?: string;
+        participantId?: string;
         breakoutGroupId?: string;
         breakoutMoveId?: string;
         breakoutSessionId?: string;
@@ -225,6 +227,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         additionalProperties?: false;
     } | {
         attendeeId?: string;
+        participantId?: string;
         breakoutGroupId?: string;
         breakoutMoveId?: string;
         breakoutSessionId?: string;

package/dist/types/call-diagnostic/config.d.ts

@@ -96,6 +96,7 @@ export declare const ERROR_DESCRIPTIONS: {
     ICE_AND_REACHABILITY_FAILED: string;
     SDP_OFFER_CREATION_ERROR: string;
     SDP_OFFER_CREATION_ERROR_MISSING_CODEC: string;
+    WDM_RESTRICTED_REGION: string;
 };
 export declare const SERVICE_ERROR_CODES_TO_CLIENT_ERROR_CODES_MAP: {
     58400: number;
@@ -175,6 +176,8 @@ export declare const SERVICE_ERROR_CODES_TO_CLIENT_ERROR_CODES_MAP: {
     100006: number;
     100005: number;
     100004: number;
+    4404002: number;
+    4404003: number;
 };
 export declare const CLIENT_ERROR_CODE_TO_ERROR_PAYLOAD: Record<number, Partial<ClientEventError>>;
 export declare const CALL_DIAGNOSTIC_EVENT_FAILED_TO_SEND = "js_sdk_call_diagnostic_event_failed_to_send";

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/metrics.types.d.ts

@@ -8,8 +8,9 @@ export type NewEnvironmentType = NonNullable<RawEvent['origin']['newEnvironment'
 export type ClientLaunchMethodType = NonNullable<RawEvent['origin']['clientInfo']>['clientLaunchMethod'];
 export type BrowserLaunchMethodType = NonNullable<RawEvent['origin']['clientInfo']>['browserLaunchMethod'];
 export type MetricEventProduct = 'webex' | 'wxcc_desktop';
-export type MetricEventAgent = 'user' | 'browser' | 'system' | 'sdk' | 'redux' | 'service';
-export type MetricEventVerb = 'create' | 'get' | 'fetch' | 'update' | 'list' | 'delete' | 'select' | 'view' | 'set' | 'toggle' | 'load' | 'reload' | 'click' | 'hover' | 'register' | 'unregister' | 'enable' | 'disable' | 'use' | 'complete' | 'submit' | 'apply' | 'cancel' | 'abort' | 'sync' | 'login' | 'logout' | 'answer' | 'activate' | 'deactivate';
+export type MetricEventAgent = 'user' | 'browser' | 'system' | 'sdk' | 'redux' | 'service' | 'api';
+export type MetricEventVerb = 'abort' | 'accept' | 'activate' | 'apply' | 'answer' | 'authorize' | 'build' | 'cancel' | 'change' | 'click' | 'close' | 'complete' | 'connect' | 'create' | 'deactivate' | 'decrypt' | 'delete' | 'deliver' | 'destroy' | 'disable' | 'disconnect' | 'dismiss' | 'display' | 'download' | 'edit' | 'enable' | 'encrypt' | 'end' | 'expire' | 'fail' | 'fetch' | 'fire' | 'generate' | 'get' | 'hide' | 'hover' | 'ignore' | 'initialize' | 'initiate' | 'invalidate' | 'join' | 'list' | 'load' | 'login' | 'logout' | 'notify' | 'offer' | 'open' | 'press' | 'receive' | 'refer' | 'refresh' | 'register' | 'release' | 'reload' | 'reject' | 'request' | 'reset' | 'resize' | 'respond' | 'retry' | 'revoke' | 'save' | 'search' | 'select' | 'send' | 'set' | 'sign' | 'start' | 'submit' | 'switch' | 'sync' | 'toggle' | 'transfer' | 'unregister' | 'update' | 'upload' | 'use' | 'validate' | 'view' | 'visit' | 'wait' | 'warn' | 'exit';
+export type MetricEventJoinFlowVersion = 'Other' | 'NewFTE';
 export type SubmitClientEventOptions = {
     meetingId?: string;
     mediaConnections?: any[];
@@ -23,6 +24,7 @@ export type SubmitClientEventOptions = {
     browserLaunchMethod?: BrowserLaunchMethodType;
     webexConferenceIdStr?: string;
     globalMeetingId?: string;
+    joinFlowVersion?: MetricEventJoinFlowVersion;
 };
 export type SubmitMQEOptions = {
     meetingId: string;
@@ -55,6 +57,7 @@ export interface DeviceContext {
     };
 }
 export type MetricType = 'behavioral' | 'operational' | 'business';
+export type Table = 'wbxapp_callend_metrics' | 'business_metrics' | 'business_ucf' | 'default';
 type InternalEventPayload = string | number | boolean;
 export type EventPayload = Record<string, InternalEventPayload>;
 export type BehavioralEventPayload = EventPayload;
@@ -137,4 +140,18 @@ export type BuildClientEventFetchRequestOptions = (args: {
     options?: SubmitClientEventOptions;
 }) => Promise<any>;
 export type PreComputedLatencies = 'internal.client.pageJMT' | 'internal.download.time' | 'internal.get.cluster.time' | 'internal.click.to.interstitial' | 'internal.refresh.captcha.time' | 'internal.exchange.ci.token.time' | 'internal.get.u2c.time' | 'internal.call.init.join.req' | 'internal.other.app.api.time' | 'internal.api.fetch.intelligence.models';
+export interface IdType {
+    meetingId?: string;
+    callId?: string;
+}
+export interface IMetricsAttributes {
+    type: string;
+    version: string;
+    userId: string;
+    correlationId: string;
+    connectionId: string;
+    data: any[];
+    meetingId?: string;
+    callId?: string;
+}
 export {};

package/dist/types/new-metrics.d.ts

@@ -3,10 +3,11 @@ import CallDiagnosticMetrics from './call-diagnostic/call-diagnostic-metrics';
 import BehavioralMetrics from './behavioral-metrics';
 import OperationalMetrics from './operational-metrics';
 import BusinessMetrics from './business-metrics';
-import { RecursivePartial, MetricEventProduct, MetricEventAgent, MetricEventVerb, ClientEvent, FeatureEvent, EventPayload, MediaQualityEvent, InternalEvent, SubmitClientEventOptions } from './metrics.types';
+import { RecursivePartial, MetricEventProduct, MetricEventAgent, MetricEventVerb, ClientEvent, FeatureEvent, EventPayload, MediaQualityEvent, InternalEvent, SubmitClientEventOptions, Table } from './metrics.types';
 import CallDiagnosticLatencies from './call-diagnostic/call-diagnostic-metrics-latencies';
 /**
  * Metrics plugin to centralize all types of metrics.
+ * https://confluence-eng-gpk2.cisco.com/conf/pages/viewpage.action?pageId=231011379
  * @class
  */
 declare class Metrics extends WebexPlugin {
@@ -85,10 +86,11 @@ declare class Metrics extends WebexPlugin {
      * Buisness event
      * @param args
      */
-    submitBusinessEvent({ name, payload }: {
+    submitBusinessEvent({ name, payload, table, }: {
         name: string;
         payload: EventPayload;
-    }): void | Promise<void>;
+        table?: Table;
+    }): Promise<void>;
     /**
      * Call Analyzer: Media Quality Event
      * @param args

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,80 @@
+import { IdType } from '../metrics.types';
+/**
+ * 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;
+    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: any, { meetingId, callId }: IdType, correlationId: any);
+    /**
+     * Updates the call identifier with the provided value.
+     *
+     * @param {string} callId - The new call identifier to set.
+     * @returns {void}
+     */
+    updateCallId(callId: string): void;
+    /**
+     * 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",
-    "@webex/test-helper-mocha": "3.5.0",
-    "@webex/test-helper-mock-webex": "3.5.0",
-    "@webex/test-helper-test-users": "3.5.0",
+    "@webex/test-helper-chai": "3.6.0-next.1",
+    "@webex/test-helper-mocha": "3.6.0-next.1",
+    "@webex/test-helper-mock-webex": "3.6.0-next.1",
+    "@webex/test-helper-test-users": "3.6.0-next.1",
     "eslint": "^8.24.0",
     "prettier": "^2.7.1",
     "sinon": "^9.2.4"
   },
   "dependencies": {
-    "@webex/common": "3.5.0",
-    "@webex/common-timers": "3.5.0",
-    "@webex/event-dictionary-ts": "^1.0.1546",
-    "@webex/internal-plugin-metrics": "3.5.0",
-    "@webex/test-helper-chai": "3.5.0",
-    "@webex/test-helper-mock-webex": "3.5.0",
-    "@webex/webex-core": "3.5.0",
+    "@webex/common": "3.6.0-next.1",
+    "@webex/common-timers": "3.6.0-next.1",
+    "@webex/event-dictionary-ts": "^1.0.1594",
+    "@webex/internal-plugin-metrics": "3.6.0-next.1",
+    "@webex/test-helper-chai": "3.6.0-next.1",
+    "@webex/test-helper-mock-webex": "3.6.0-next.1",
+    "@webex/webex-core": "3.6.0-next.1",
     "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"
+  "version": "3.6.0-next.1"
 }