@webex/plugin-meetings 3.0.0-stream-classes.5 → 3.0.0

package/dist/rtcMetrics/index.js

@@ -6,18 +6,30 @@ _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 _internalPluginMetrics = require("@webex/internal-plugin-metrics");
+var _uuid = _interopRequireDefault(require("uuid"));
 var _constants = _interopRequireDefault(require("./constants"));
+/* 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 = /*#__PURE__*/function () {
-  /**
-   * Array of MetricData items to be sent to the metrics service.
-   */
-
+var RtcMetrics = exports.default = /*#__PURE__*/function () {
   /**
    * Initialize the interval.
    *
@@ -27,18 +39,23 @@ var RtcMetrics = /*#__PURE__*/function () {
    */
   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);
     // `window` is used to prevent typescript from returning a NodeJS.Timer.
-    this.intervalId = window.setInterval(this.checkMetrics.bind(this), 30 * 1000);
+    this.intervalId = window.setInterval(this.sendMetricsInQueue.bind(this), 30 * 1000);
     this.meetingId = meetingId;
     this.webex = webex;
     this.correlationId = correlationId;
+    this.setNewConnectionId();
     // Send the first set of metrics at 5 seconds in the case of a user leaving the call shortly after joining.
-    setTimeout(this.checkMetrics.bind(this), 5 * 1000);
+    setTimeout(this.sendMetricsInQueue.bind(this), 5 * 1000);
   }
 
   /**
@@ -47,8 +64,8 @@ var RtcMetrics = /*#__PURE__*/function () {
    * @returns {void}
    */
   (0, _createClass2.default)(RtcMetrics, [{
-    key: "checkMetrics",
-    value: function checkMetrics() {
+    key: "sendMetricsInQueue",
+    value: function sendMetricsInQueue() {
       if (this.metricsQueue.length) {
         this.sendMetrics();
         this.metricsQueue = [];
@@ -66,7 +83,20 @@ var RtcMetrics = /*#__PURE__*/function () {
     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);
+        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.setNewConnectionId();
+          }
+        } catch (e) {
+          console.error(e);
+        }
       }
     }
 
@@ -78,10 +108,40 @@ var RtcMetrics = /*#__PURE__*/function () {
   }, {
     key: "closeMetrics",
     value: function closeMetrics() {
-      this.checkMetrics();
+      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 = _internalPluginMetrics.CallDiagnosticUtils.anonymizeIPAddress(data.ip) || undefined;
+        data.address = _internalPluginMetrics.CallDiagnosticUtils.anonymizeIPAddress(data.address) || undefined;
+        data.relatedAddress = _internalPluginMetrics.CallDiagnosticUtils.anonymizeIPAddress(data.relatedAddress) || undefined;
+      }
+      return (0, _stringify.default)(data);
+    }
+
+    /**
+     * Set a new connection id.
+     *
+     * @returns {void}
+     */
+  }, {
+    key: "setNewConnectionId",
+    value: function setNewConnectionId() {
+      this.connectionId = _uuid.default.v4();
+    }
+
     /**
      * Send metrics to the metrics service.
      *
@@ -101,10 +161,11 @@ var RtcMetrics = /*#__PURE__*/function () {
         body: {
           metrics: [{
             type: 'webrtc',
-            version: '1.0.1',
+            version: '1.1.0',
             userId: this.webex.internal.device.userId,
             meetingId: this.meetingId,
             correlationId: this.correlationId,
+            connectionId: this.connectionId,
             data: this.metricsQueue
           }]
         }
@@ -113,5 +174,4 @@ var RtcMetrics = /*#__PURE__*/function () {
   }]);
   return RtcMetrics;
 }();
-exports.default = RtcMetrics;
 //# sourceMappingURL=index.js.map

package/dist/rtcMetrics/index.js.map

@@ -1 +1 @@
-{"version":3,"names":["RtcMetrics","webex","meetingId","correlationId","intervalId","window","setInterval","checkMetrics","bind","setTimeout","metricsQueue","length","sendMetrics","data","payload","push","clearInterval","request","method","service","resource","headers","type","appId","RTC_METRICS","APP_ID","body","metrics","version","userId","internal","device"],"sources":["index.ts"],"sourcesContent":["import RTC_METRICS from './constants';\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  /**\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.checkMetrics.bind(this), 30 * 1000);\n    this.meetingId = meetingId;\n    this.webex = webex;\n    this.correlationId = correlationId;\n    // Send the first set of metrics at 5 seconds in the case of a user leaving the call shortly after joining.\n    setTimeout(this.checkMetrics.bind(this), 5 * 1000);\n  }\n\n  /**\n   * Check to see if the metrics queue has any items.\n   *\n   * @returns {void}\n   */\n  private checkMetrics() {\n    if (this.metricsQueue.length) {\n      this.sendMetrics();\n      this.metricsQueue = [];\n    }\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      this.metricsQueue.push(data);\n    }\n  }\n\n  /**\n   * Clear the metrics interval.\n   *\n   * @returns {void}\n   */\n  closeMetrics() {\n    this.checkMetrics();\n    clearInterval(this.intervalId);\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.0.1',\n            userId: this.webex.internal.device.userId,\n            meetingId: this.meetingId,\n            correlationId: this.correlationId,\n            data: this.metricsQueue,\n          },\n        ],\n      },\n    });\n  }\n}\n"],"mappings":";;;;;;;;;;;AAAA;AAEA;AACA;AACA;AAFA,IAGqBA,UAAU;EAC7B;AACF;AACA;;EAWE;AACF;AACA;AACA;AACA;AACA;AACA;EACE,oBAAYC,KAAK,EAAEC,SAAS,EAAEC,aAAa,EAAE;IAAA;IAAA,oDAjB9B,EAAE;IAAA;IAAA;IAAA;IAAA;IAkBf;IACA,IAAI,CAACC,UAAU,GAAGC,MAAM,CAACC,WAAW,CAAC,IAAI,CAACC,YAAY,CAACC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,IAAI,CAAC;IAC7E,IAAI,CAACN,SAAS,GAAGA,SAAS;IAC1B,IAAI,CAACD,KAAK,GAAGA,KAAK;IAClB,IAAI,CAACE,aAAa,GAAGA,aAAa;IAClC;IACAM,UAAU,CAAC,IAAI,CAACF,YAAY,CAACC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC;EACpD;;EAEA;AACF;AACA;AACA;AACA;EAJE;IAAA;IAAA,OAKA,wBAAuB;MACrB,IAAI,IAAI,CAACE,YAAY,CAACC,MAAM,EAAE;QAC5B,IAAI,CAACC,WAAW,EAAE;QAClB,IAAI,CAACF,YAAY,GAAG,EAAE;MACxB;IACF;;IAEA;AACF;AACA;AACA;AACA;AACA;AACA;EANE;IAAA;IAAA,OAOA,oBAAWG,IAAI,EAAE;MACf,IAAIA,IAAI,CAACC,OAAO,CAACH,MAAM,EAAE;QACvB,IAAI,CAACD,YAAY,CAACK,IAAI,CAACF,IAAI,CAAC;MAC9B;IACF;;IAEA;AACF;AACA;AACA;AACA;EAJE;IAAA;IAAA,OAKA,wBAAe;MACb,IAAI,CAACN,YAAY,EAAE;MACnBS,aAAa,CAAC,IAAI,CAACZ,UAAU,CAAC;IAChC;;IAEA;AACF;AACA;AACA;AACA;EAJE;IAAA;IAAA,OAKA,uBAAsB;MACpB,IAAI,CAACH,KAAK,CAACgB,OAAO,CAAC;QACjBC,MAAM,EAAE,MAAM;QACdC,OAAO,EAAE,kBAAkB;QAC3BC,QAAQ,EAAE,WAAW;QACrBC,OAAO,EAAE;UACPC,IAAI,EAAE,aAAa;UACnBC,KAAK,EAAEC,kBAAW,CAACC;QACrB,CAAC;QACDC,IAAI,EAAE;UACJC,OAAO,EAAE,CACP;YACEL,IAAI,EAAE,QAAQ;YACdM,OAAO,EAAE,OAAO;YAChBC,MAAM,EAAE,IAAI,CAAC5B,KAAK,CAAC6B,QAAQ,CAACC,MAAM,CAACF,MAAM;YACzC3B,SAAS,EAAE,IAAI,CAACA,SAAS;YACzBC,aAAa,EAAE,IAAI,CAACA,aAAa;YACjCU,IAAI,EAAE,IAAI,CAACH;UACb,CAAC;QAEL;MACF,CAAC,CAAC;IACJ;EAAC;EAAA;AAAA;AAAA"}
+{"version":3,"names":["_internalPluginMetrics","require","_uuid","_interopRequireDefault","_constants","parseJsonPayload","payload","JSON","parse","_","RtcMetrics","exports","default","webex","meetingId","correlationId","_classCallCheck2","_defineProperty2","intervalId","window","setInterval","sendMetricsInQueue","bind","setNewConnectionId","setTimeout","_createClass2","key","value","metricsQueue","length","sendMetrics","addMetrics","data","name","map","anonymizeIp","push","parsedPayload","e","console","error","closeMetrics","clearInterval","stats","type","ip","CallDiagnosticUtils","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 {CallDiagnosticUtils} from '@webex/internal-plugin-metrics';\nimport uuid from 'uuid';\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  /**\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.setNewConnectionId();\n    // Send the first set of metrics at 5 seconds in the case of a user leaving the call shortly after joining.\n    setTimeout(this.sendMetricsInQueue.bind(this), 5 * 1000);\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   * 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      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.setNewConnectionId();\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 setNewConnectionId() {\n    this.connectionId = uuid.v4();\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,sBAAA,GAAAC,OAAA;AACA,IAAAC,KAAA,GAAAC,sBAAA,CAAAF,OAAA;AACA,IAAAG,UAAA,GAAAD,sBAAA,CAAAF,OAAA;AAHA;;AAKA,IAAMI,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,CAAAC,OAAA;EAgB7B;AACF;AACA;AACA;AACA;AACA;AACA;EACE,SAAAF,WAAYG,KAAK,EAAEC,SAAS,EAAEC,aAAa,EAAE;IAAA,IAAAC,gBAAA,CAAAJ,OAAA,QAAAF,UAAA;IAtB7C;AACF;AACA;IAFE,IAAAO,gBAAA,CAAAL,OAAA,wBAGe,EAAE;IAAA,IAAAK,gBAAA,CAAAL,OAAA;IAAA,IAAAK,gBAAA,CAAAL,OAAA;IAAA,IAAAK,gBAAA,CAAAL,OAAA;IAAA,IAAAK,gBAAA,CAAAL,OAAA;IAAA,IAAAK,gBAAA,CAAAL,OAAA;IAoBf;IACA,IAAI,CAACM,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,kBAAkB,CAAC,CAAC;IACzB;IACAC,UAAU,CAAC,IAAI,CAACH,kBAAkB,CAACC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC;EAC1D;;EAEA;AACF;AACA;AACA;AACA;EAJE,IAAAG,aAAA,CAAAb,OAAA,EAAAF,UAAA;IAAAgB,GAAA;IAAAC,KAAA,EAKA,SAAAN,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;EANE;IAAAF,GAAA;IAAAC,KAAA,EAOA,SAAAI,WAAWC,IAAI,EAAE;MACf,IAAIA,IAAI,CAAC1B,OAAO,CAACuB,MAAM,EAAE;QACvB,IAAIG,IAAI,CAACC,IAAI,KAAK,cAAc,EAAE;UAChCD,IAAI,CAAC1B,OAAO,GAAG0B,IAAI,CAAC1B,OAAO,CAAC4B,GAAG,CAAC,IAAI,CAACC,WAAW,CAAC;QACnD;QAEA,IAAI,CAACP,YAAY,CAACQ,IAAI,CAACJ,IAAI,CAAC;QAE5B,IAAI;UACF;UACA,IAAMK,aAAa,GAAGhC,gBAAgB,CAAC2B,IAAI,CAAC1B,OAAO,CAAC;UACpD,IACE0B,IAAI,CAACC,IAAI,KAAK,yBAAyB,IACvCI,aAAa,IACbA,aAAa,CAACV,KAAK,KAAK,QAAQ,EAChC;YACA,IAAI,CAACN,kBAAkB,CAAC,CAAC;YACzB,IAAI,CAACE,kBAAkB,CAAC,CAAC;UAC3B;QACF,CAAC,CAAC,OAAOe,CAAC,EAAE;UACVC,OAAO,CAACC,KAAK,CAACF,CAAC,CAAC;QAClB;MACF;IACF;;IAEA;AACF;AACA;AACA;AACA;EAJE;IAAAZ,GAAA;IAAAC,KAAA,EAKA,SAAAc,aAAA,EAAe;MACb,IAAI,CAACpB,kBAAkB,CAAC,CAAC;MACzBqB,aAAa,CAAC,IAAI,CAACxB,UAAU,CAAC;IAChC;;IAEA;AACF;AACA;AACA;AACA;AACA;EALE;IAAAQ,GAAA;IAAAC,KAAA,EAMA,SAAAQ,YAAYQ,KAAa,EAAU;MACjC,IAAMX,IAAI,GAAGzB,IAAI,CAACC,KAAK,CAACmC,KAAK,CAAC;MAC9B;MACA,IAAIX,IAAI,CAACY,IAAI,KAAK,iBAAiB,IAAIZ,IAAI,CAACY,IAAI,KAAK,kBAAkB,EAAE;QACvEZ,IAAI,CAACa,EAAE,GAAGC,0CAAmB,CAACC,kBAAkB,CAACf,IAAI,CAACa,EAAE,CAAC,IAAIG,SAAS;QACtEhB,IAAI,CAACiB,OAAO,GAAGH,0CAAmB,CAACC,kBAAkB,CAACf,IAAI,CAACiB,OAAO,CAAC,IAAID,SAAS;QAChFhB,IAAI,CAACkB,cAAc,GACjBJ,0CAAmB,CAACC,kBAAkB,CAACf,IAAI,CAACkB,cAAc,CAAC,IAAIF,SAAS;MAC5E;MAEA,OAAO,IAAAG,UAAA,CAAAvC,OAAA,EAAeoB,IAAI,CAAC;IAC7B;;IAEA;AACF;AACA;AACA;AACA;EAJE;IAAAN,GAAA;IAAAC,KAAA,EAKA,SAAAJ,mBAAA,EAA6B;MAC3B,IAAI,CAAC6B,YAAY,GAAGC,aAAI,CAACC,EAAE,CAAC,CAAC;IAC/B;;IAEA;AACF;AACA;AACA;AACA;EAJE;IAAA5B,GAAA;IAAAC,KAAA,EAKA,SAAAG,YAAA,EAAsB;MACpB,IAAI,CAACjB,KAAK,CAAC0C,OAAO,CAAC;QACjBC,MAAM,EAAE,MAAM;QACdC,OAAO,EAAE,kBAAkB;QAC3BC,QAAQ,EAAE,WAAW;QACrBC,OAAO,EAAE;UACPf,IAAI,EAAE,aAAa;UACnBgB,KAAK,EAAEC,kBAAW,CAACC;QACrB,CAAC;QACDC,IAAI,EAAE;UACJC,OAAO,EAAE,CACP;YACEpB,IAAI,EAAE,QAAQ;YACdqB,OAAO,EAAE,OAAO;YAChBC,MAAM,EAAE,IAAI,CAACrD,KAAK,CAACsD,QAAQ,CAACC,MAAM,CAACF,MAAM;YACzCpD,SAAS,EAAE,IAAI,CAACA,SAAS;YACzBC,aAAa,EAAE,IAAI,CAACA,aAAa;YACjCqC,YAAY,EAAE,IAAI,CAACA,YAAY;YAC/BpB,IAAI,EAAE,IAAI,CAACJ;UACb,CAAC;QAEL;MACF,CAAC,CAAC;IACJ;EAAC;EAAA,OAAAlB,UAAA;AAAA"}

package/dist/statsAnalyzer/global.js

@@ -40,6 +40,5 @@ var STATS_DEFAULT = {
     candidates: {}
   }
 };
-var _default = STATS_DEFAULT;
-exports.default = _default;
+var _default = exports.default = STATS_DEFAULT;
 //# sourceMappingURL=global.js.map

package/dist/statsAnalyzer/global.js.map

@@ -1 +1 @@
-{"version":3,"names":["STATS_DEFAULT","encryption","bandwidth","systemBandwidth","sentPerSecond","encodedPerSecond","helper","audioBytesSent","videoBytestSent","speed","results","connectionType","systemNetworkType","systemIpAddress","local","candidateType","transport","ipAddress","networkType","remote","resolutions","internal","candidates"],"sources":["global.ts"],"sourcesContent":["const STATS_DEFAULT = {\n  encryption: 'sha-256',\n  bandwidth: {\n    systemBandwidth: 0,\n    sentPerSecond: 0,\n    encodedPerSecond: 0,\n    helper: {\n      audioBytesSent: 0,\n      videoBytestSent: 0,\n    },\n    speed: 0,\n  },\n  results: {},\n  connectionType: {\n    systemNetworkType: 'unknown',\n    systemIpAddress: '0.0.0.0',\n    local: {\n      candidateType: [],\n      transport: [],\n      ipAddress: [],\n      networkType: [],\n    },\n    remote: {\n      candidateType: [],\n      transport: [],\n      ipAddress: [],\n      networkType: [],\n    },\n  },\n  resolutions: {},\n  internal: {\n    remote: {},\n    candidates: {},\n  },\n};\n\nexport default STATS_DEFAULT;\n"],"mappings":";;;;;;;AAAA,IAAMA,aAAa,GAAG;EACpBC,UAAU,EAAE,SAAS;EACrBC,SAAS,EAAE;IACTC,eAAe,EAAE,CAAC;IAClBC,aAAa,EAAE,CAAC;IAChBC,gBAAgB,EAAE,CAAC;IACnBC,MAAM,EAAE;MACNC,cAAc,EAAE,CAAC;MACjBC,eAAe,EAAE;IACnB,CAAC;IACDC,KAAK,EAAE;EACT,CAAC;EACDC,OAAO,EAAE,CAAC,CAAC;EACXC,cAAc,EAAE;IACdC,iBAAiB,EAAE,SAAS;IAC5BC,eAAe,EAAE,SAAS;IAC1BC,KAAK,EAAE;MACLC,aAAa,EAAE,EAAE;MACjBC,SAAS,EAAE,EAAE;MACbC,SAAS,EAAE,EAAE;MACbC,WAAW,EAAE;IACf,CAAC;IACDC,MAAM,EAAE;MACNJ,aAAa,EAAE,EAAE;MACjBC,SAAS,EAAE,EAAE;MACbC,SAAS,EAAE,EAAE;MACbC,WAAW,EAAE;IACf;EACF,CAAC;EACDE,WAAW,EAAE,CAAC,CAAC;EACfC,QAAQ,EAAE;IACRF,MAAM,EAAE,CAAC,CAAC;IACVG,UAAU,EAAE,CAAC;EACf;AACF,CAAC;AAAC,eAEatB,aAAa;AAAA"}
+{"version":3,"names":["STATS_DEFAULT","encryption","bandwidth","systemBandwidth","sentPerSecond","encodedPerSecond","helper","audioBytesSent","videoBytestSent","speed","results","connectionType","systemNetworkType","systemIpAddress","local","candidateType","transport","ipAddress","networkType","remote","resolutions","internal","candidates","_default","exports","default"],"sources":["global.ts"],"sourcesContent":["const STATS_DEFAULT = {\n  encryption: 'sha-256',\n  bandwidth: {\n    systemBandwidth: 0,\n    sentPerSecond: 0,\n    encodedPerSecond: 0,\n    helper: {\n      audioBytesSent: 0,\n      videoBytestSent: 0,\n    },\n    speed: 0,\n  },\n  results: {},\n  connectionType: {\n    systemNetworkType: 'unknown',\n    systemIpAddress: '0.0.0.0',\n    local: {\n      candidateType: [],\n      transport: [],\n      ipAddress: [],\n      networkType: [],\n    },\n    remote: {\n      candidateType: [],\n      transport: [],\n      ipAddress: [],\n      networkType: [],\n    },\n  },\n  resolutions: {},\n  internal: {\n    remote: {},\n    candidates: {},\n  },\n};\n\nexport default STATS_DEFAULT;\n"],"mappings":";;;;;;;AAAA,IAAMA,aAAa,GAAG;EACpBC,UAAU,EAAE,SAAS;EACrBC,SAAS,EAAE;IACTC,eAAe,EAAE,CAAC;IAClBC,aAAa,EAAE,CAAC;IAChBC,gBAAgB,EAAE,CAAC;IACnBC,MAAM,EAAE;MACNC,cAAc,EAAE,CAAC;MACjBC,eAAe,EAAE;IACnB,CAAC;IACDC,KAAK,EAAE;EACT,CAAC;EACDC,OAAO,EAAE,CAAC,CAAC;EACXC,cAAc,EAAE;IACdC,iBAAiB,EAAE,SAAS;IAC5BC,eAAe,EAAE,SAAS;IAC1BC,KAAK,EAAE;MACLC,aAAa,EAAE,EAAE;MACjBC,SAAS,EAAE,EAAE;MACbC,SAAS,EAAE,EAAE;MACbC,WAAW,EAAE;IACf,CAAC;IACDC,MAAM,EAAE;MACNJ,aAAa,EAAE,EAAE;MACjBC,SAAS,EAAE,EAAE;MACbC,SAAS,EAAE,EAAE;MACbC,WAAW,EAAE;IACf;EACF,CAAC;EACDE,WAAW,EAAE,CAAC,CAAC;EACfC,QAAQ,EAAE;IACRF,MAAM,EAAE,CAAC,CAAC;IACVG,UAAU,EAAE,CAAC;EACf;AACF,CAAC;AAAC,IAAAC,QAAA,GAAAC,OAAA,CAAAC,OAAA,GAEazB,aAAa"}

package/dist/{types/statsAnalyzer → statsAnalyzer}/index.d.ts

@@ -9,6 +9,10 @@ export declare const EVENTS: {
     REMOTE_MEDIA_STOPPED: string;
 };
 type ReceiveSlotCallback = (csi: number) => ReceiveSlot | undefined;
+type MediaStatus = {
+    actual?: any;
+    expected?: any;
+};
 /**
  * Stats Analyzer class that will emit events based on detected quality
  *
@@ -30,6 +34,8 @@ export declare class StatsAnalyzer extends EventsScope {
     statsInterval: NodeJS.Timeout;
     statsResults: any;
     statsStarted: any;
+    successfulCandidatePair: any;
+    localIpAddress: string;
     receiveSlotCallback: ReceiveSlotCallback;
     /**
      * Creates a new instance of StatsAnalyzer
@@ -57,7 +63,7 @@ export declare class StatsAnalyzer extends EventsScope {
      * @memberof StatsAnalyzer
      * @returns {void}
      */
-    updateMediaStatus(status: object): void;
+    updateMediaStatus(status: MediaStatus): void;
     /**
      * captures MQA data from media connection
      *
@@ -75,6 +81,13 @@ export declare class StatsAnalyzer extends EventsScope {
      * @returns {void}
      */
     updateMediaConnection(mediaConnection: any): void;
+    /**
+     * Returns the local IP address for diagnostics.
+     * this is the local IP of the interface used for the current media connection
+     * a host can have many local Ip Addresses
+     * @returns {string | undefined} The local IP address.
+     */
+    getLocalIpAddress(): string;
     /**
      * Starts the stats analyzer on interval
      *
@@ -166,6 +179,20 @@ export declare class StatsAnalyzer extends EventsScope {
      * @returns {void}
      */
     private processInboundRTPResult;
+    /**
+     * extracts the local Ip address from the statsResult object by looking at stats results candidates
+     * and matches that ID with the successful candidate pair. It looks at the type of local candidate it is
+     * and then extracts the IP address from the relatedAddress or address property based on conditions known in webrtc
+     * note, there are known incompatibilities and it is possible for this to set undefined, or for the IP address to be the public IP address
+     * for example, firefox does not set the relayProtocol, and if the user is behind a NAT it might be the public IP
+     * @private
+     * @param {string} successfulCandidatePairId - The ID of the successful candidate pair.
+     * @param {Object} candidates - the stats result candidates
+     * @returns {void}
+     */
+    extractAndSetLocalIpAddressInfoForDiagnostics: (successfulCandidatePairId: string, candidates: {
+        [key: string]: Record<string, unknown>;
+    }) => void;
     /**
      * Processes remote and local candidate result and stores
      * @private
@@ -177,16 +204,6 @@ export declare class StatsAnalyzer extends EventsScope {
      * @returns {void}
      */
     parseCandidate: (result: any, type: any, isSender: boolean, isRemote: boolean) => void;
-    /**
-     * Process Track results
-     *
-     * @private
-     * @param {*} result
-     * @param {*} mediaType
-     * @returns {void}
-     * @memberof StatsAnalyzer
-     */
-    private processTrackResult;
     /**
      *
      * @private