@webex/plugin-meetings 3.4.0 → 3.5.0-next.2

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

@@ -120,4 +120,35 @@ describe('RtcMetrics', () => {
     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);
+  });
 });

package/dist/networkQualityMonitor/index.js

@@ -1,227 +0,0 @@
-"use strict";
-
-var _Reflect$construct = require("@babel/runtime-corejs2/core-js/reflect/construct");
-var _Object$defineProperty = require("@babel/runtime-corejs2/core-js/object/define-property");
-var _interopRequireDefault = require("@babel/runtime-corejs2/helpers/interopRequireDefault");
-_Object$defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _freeze = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/object/freeze"));
-var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/classCallCheck"));
-var _createClass2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/createClass"));
-var _assertThisInitialized2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/assertThisInitialized"));
-var _inherits2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/inherits"));
-var _possibleConstructorReturn2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/possibleConstructorReturn"));
-var _getPrototypeOf2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/getPrototypeOf"));
-var _defineProperty2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/defineProperty"));
-var _eventsScope = _interopRequireDefault(require("../common/events/events-scope"));
-var _constants = require("../constants");
-function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = (0, _getPrototypeOf2.default)(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = (0, _getPrototypeOf2.default)(this).constructor; result = _Reflect$construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return (0, _possibleConstructorReturn2.default)(this, result); }; }
-function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !_Reflect$construct) return false; if (_Reflect$construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(_Reflect$construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
-/**
- * Meeting - network quality event
- * Emitted on each interval of retrieving stats Analyzer data
- * @event network:quality
- * @type {Object}
- * @property {string} mediaType {video|audio}
- * @property {number} networkQualityScore - value determined in determineUplinkNetworkQuality
- * @memberof NetworkQualityMonitor
- */
-/**
- * NetworkQualityMonitor class that will emit events based on detected quality
- *
- * @class NetworkQualityMonitor
- * @extends {EventsScope}
- */
-var NetworkQualityMonitor = exports.default = /*#__PURE__*/function (_EventsScope) {
-  (0, _inherits2.default)(NetworkQualityMonitor, _EventsScope);
-  var _super = _createSuper(NetworkQualityMonitor);
-  /**
-   * Creates a new instance of NetworkQualityMonitor
-   * @constructor
-   * @public
-   * @param {Object} config
-   * @property {Object} indicatorTypes - network properties used to evaluate network quality used as constants
-   * @property {Object} frequencyTypes - frequency properties used as constants {uplink|send} {downlink|receive}
-   * @property {number} networkQualityScore  - 0|1 1 is acceptable 0 is bad/unknown
-   * @property {Object} networkQualityStatus - hash object based on indicatorTypes and frequencyTypes
-   * @property {string} mediaType - audio|video
-   */
-  function NetworkQualityMonitor(config) {
-    var _this;
-    (0, _classCallCheck2.default)(this, NetworkQualityMonitor);
-    _this = _super.call(this);
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "config", void 0);
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "frequencyTypes", void 0);
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "indicatorTypes", void 0);
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "mediaType", void 0);
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "networkQualityScore", void 0);
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "networkQualityStatus", void 0);
-    _this.config = config;
-    _this.indicatorTypes = (0, _freeze.default)({
-      PACKETLOSS: 'packetLoss',
-      LATENCY: 'latency',
-      JITTER: 'jitter'
-    });
-    _this.frequencyTypes = (0, _freeze.default)({
-      UPLINK: 'uplink',
-      DOWNLINK: 'downlink'
-    });
-    _this.networkQualityScore = 1;
-    _this.networkQualityStatus = (0, _defineProperty2.default)({}, _this.frequencyTypes.UPLINK, {});
-    _this.mediaType = null;
-    return _this;
-  }
-
-  /**
-   * emits NETWORK_QUALITY event on meeting with payload of media type and uplinkNetworkQuality score
-   *
-   * @memberof NetworkQualityMonitor
-   * @returns {void}
-   */
-  (0, _createClass2.default)(NetworkQualityMonitor, [{
-    key: "emitNetworkQuality",
-    value: function emitNetworkQuality() {
-      this.emit({
-        file: 'networkQualityMonitor',
-        function: 'emitNetworkQuality'
-      }, _constants.EVENT_TRIGGERS.NETWORK_QUALITY, {
-        mediaType: this.mediaType,
-        networkQualityScore: this.networkQualityScore
-      });
-    }
-
-    /**
-     * invokes emitNetworkQuality method resets values back to default
-     * @returns {void}
-     * @memberof NetworkQualityMonitor
-     */
-  }, {
-    key: "updateNetworkQualityStatus",
-    value: function updateNetworkQualityStatus() {
-      this.emitNetworkQuality();
-
-      // reset values
-      this.networkQualityScore = 1;
-      this.mediaType = null;
-    }
-
-    /**
-     * filter data to determine uplink network quality, invoked on same interval as stats analyzer remote-inbout-rtp
-     * @param {Object} configObj
-     * @param {string} configObj.mediaType {audio|video}
-     * @param {RTCStats} configObj.remoteRtpResults RTC stats remote obj
-     * @param {Object} configObj.statsAnalyzerCurrentStats statsResults
-     * @returns {void}
-     * @public
-     * @memberof NetworkQualityMonitor
-     */
-  }, {
-    key: "determineUplinkNetworkQuality",
-    value: function determineUplinkNetworkQuality(_ref) {
-      var _this2 = this;
-      var mediaType = _ref.mediaType,
-        remoteRtpResults = _ref.remoteRtpResults,
-        statsAnalyzerCurrentStats = _ref.statsAnalyzerCurrentStats;
-      var roundTripTimeInMilliseconds = remoteRtpResults.roundTripTime * 1000;
-      var jitterInMilliseconds = remoteRtpResults.jitter * 1000;
-      var currentPacketLossRatio = statsAnalyzerCurrentStats[mediaType].send.currentPacketLossRatio;
-      this.mediaType = mediaType;
-      var _this$indicatorTypes = this.indicatorTypes,
-        JITTER = _this$indicatorTypes.JITTER,
-        PACKETLOSS = _this$indicatorTypes.PACKETLOSS,
-        LATENCY = _this$indicatorTypes.LATENCY;
-      var UPLINK = this.frequencyTypes.UPLINK;
-
-      /**
-       * determines if packetLoss ratio is over threshold set in config
-       * sets networkQualityScore to 0 if over threshold
-       * @returns {boolean}
-       */
-      var determinePacketLoss = function determinePacketLoss() {
-        if (currentPacketLossRatio > _this2.config.videoPacketLossRatioThreshold) {
-          _this2.networkQualityScore = 0;
-          return false;
-        }
-        return true;
-      };
-
-      /**
-       * determines if round trip time value is over threshold set in config
-       * sets networkQualityScore to 0 if over threshold
-       * @returns {boolean}
-       */
-      var determineLatency = function determineLatency() {
-        if (roundTripTimeInMilliseconds > _this2.config.rttThreshold) {
-          _this2.networkQualityScore = 0;
-          return false;
-        }
-        return true;
-      };
-
-      /**
-       * determines if jitter value is over threshold in config
-       * sets networkQualityScore to 0 if over threshold
-       * @returns {boolean}
-       */
-      var deterMineJitter = function deterMineJitter() {
-        if (jitterInMilliseconds > _this2.config.jitterThreshold) {
-          _this2.networkQualityScore = 0;
-          return false;
-        }
-        return true;
-      };
-
-      /**
-       * returns null if val is specifically undefined
-       * @param {(number|undefined)} value
-       * @returns {(number|null)}
-       */
-      var determineIfUndefined = function determineIfUndefined(value) {
-        return typeof value === 'undefined' ? null : value;
-      };
-      if (!this.networkQualityStatus[UPLINK][mediaType]) {
-        this.networkQualityStatus[UPLINK][mediaType] = {};
-      }
-
-      /**
-       * Values for some browsers specifically Safari will be undefined we explicitly set to null
-       * https://bugs.webkit.org/show_bug.cgi?id=206645
-       * https://bugs.webkit.org/show_bug.cgi?id=212668
-       */
-      // PACKET LOSS
-      this.networkQualityStatus[UPLINK][mediaType][PACKETLOSS] = {
-        acceptable: determinePacketLoss(),
-        value: determineIfUndefined(currentPacketLossRatio)
-      };
-
-      // LATENCY measured in Round trip time
-      this.networkQualityStatus[UPLINK][mediaType][LATENCY] = {
-        acceptable: determineLatency(),
-        value: determineIfUndefined(remoteRtpResults.roundTripTime)
-      };
-
-      // JITTER
-      this.networkQualityStatus[UPLINK][mediaType][JITTER] = {
-        acceptable: deterMineJitter(),
-        value: determineIfUndefined(remoteRtpResults.jitter)
-      };
-      this.updateNetworkQualityStatus();
-    }
-
-    /**
-     * Get the current status of network quaility object - networkQualityStatus
-     * @returns {Object}
-     * @public
-     */
-  }, {
-    key: "networkQualityStats",
-    get: function get() {
-      var UPLINK = this.frequencyTypes.UPLINK;
-      return this.networkQualityStatus[UPLINK];
-    }
-  }]);
-  return NetworkQualityMonitor;
-}(_eventsScope.default);
-//# sourceMappingURL=index.js.map

package/dist/networkQualityMonitor/index.js.map

@@ -1 +0,0 @@
-{"version":3,"names":["_eventsScope","_interopRequireDefault","require","_constants","_createSuper","Derived","hasNativeReflectConstruct","_isNativeReflectConstruct","_createSuperInternal","Super","_getPrototypeOf2","default","result","NewTarget","constructor","_Reflect$construct","arguments","apply","_possibleConstructorReturn2","Reflect","sham","Proxy","Boolean","prototype","valueOf","call","e","NetworkQualityMonitor","exports","_EventsScope","_inherits2","_super","config","_this","_classCallCheck2","_defineProperty2","_assertThisInitialized2","indicatorTypes","_freeze","PACKETLOSS","LATENCY","JITTER","frequencyTypes","UPLINK","DOWNLINK","networkQualityScore","networkQualityStatus","mediaType","_createClass2","key","value","emitNetworkQuality","emit","file","function","EVENT_TRIGGERS","NETWORK_QUALITY","updateNetworkQualityStatus","determineUplinkNetworkQuality","_ref","_this2","remoteRtpResults","statsAnalyzerCurrentStats","roundTripTimeInMilliseconds","roundTripTime","jitterInMilliseconds","jitter","currentPacketLossRatio","send","_this$indicatorTypes","determinePacketLoss","videoPacketLossRatioThreshold","determineLatency","rttThreshold","deterMineJitter","jitterThreshold","determineIfUndefined","acceptable","get","EventsScope"],"sources":["index.ts"],"sourcesContent":["import EventsScope from '../common/events/events-scope';\nimport {EVENT_TRIGGERS} from '../constants';\n\n/**\n * Meeting - network quality event\n * Emitted on each interval of retrieving stats Analyzer data\n * @event network:quality\n * @type {Object}\n * @property {string} mediaType {video|audio}\n * @property {number} networkQualityScore - value determined in determineUplinkNetworkQuality\n * @memberof NetworkQualityMonitor\n */\n/**\n * NetworkQualityMonitor class that will emit events based on detected quality\n *\n * @class NetworkQualityMonitor\n * @extends {EventsScope}\n */\nexport default class NetworkQualityMonitor extends EventsScope {\n  config: any;\n  frequencyTypes: any;\n  indicatorTypes: any;\n  mediaType: any;\n  networkQualityScore: any;\n  networkQualityStatus: any;\n\n  /**\n   * Creates a new instance of NetworkQualityMonitor\n   * @constructor\n   * @public\n   * @param {Object} config\n   * @property {Object} indicatorTypes - network properties used to evaluate network quality used as constants\n   * @property {Object} frequencyTypes - frequency properties used as constants {uplink|send} {downlink|receive}\n   * @property {number} networkQualityScore  - 0|1 1 is acceptable 0 is bad/unknown\n   * @property {Object} networkQualityStatus - hash object based on indicatorTypes and frequencyTypes\n   * @property {string} mediaType - audio|video\n   */\n  constructor(config: any) {\n    super();\n    this.config = config;\n    this.indicatorTypes = Object.freeze({\n      PACKETLOSS: 'packetLoss',\n      LATENCY: 'latency',\n      JITTER: 'jitter',\n    });\n    this.frequencyTypes = Object.freeze({\n      UPLINK: 'uplink',\n      DOWNLINK: 'downlink',\n    });\n    this.networkQualityScore = 1;\n    this.networkQualityStatus = {\n      [this.frequencyTypes.UPLINK]: {},\n    };\n    this.mediaType = null;\n  }\n\n  /**\n   * emits NETWORK_QUALITY event on meeting with payload of media type and uplinkNetworkQuality score\n   *\n   * @memberof NetworkQualityMonitor\n   * @returns {void}\n   */\n  emitNetworkQuality() {\n    this.emit(\n      {\n        file: 'networkQualityMonitor',\n        function: 'emitNetworkQuality',\n      },\n      EVENT_TRIGGERS.NETWORK_QUALITY,\n      {\n        mediaType: this.mediaType,\n        networkQualityScore: this.networkQualityScore,\n      }\n    );\n  }\n\n  /**\n   * invokes emitNetworkQuality method resets values back to default\n   * @returns {void}\n   * @memberof NetworkQualityMonitor\n   */\n  updateNetworkQualityStatus() {\n    this.emitNetworkQuality();\n\n    // reset values\n    this.networkQualityScore = 1;\n    this.mediaType = null;\n  }\n\n  /**\n   * filter data to determine uplink network quality, invoked on same interval as stats analyzer remote-inbout-rtp\n   * @param {Object} configObj\n   * @param {string} configObj.mediaType {audio|video}\n   * @param {RTCStats} configObj.remoteRtpResults RTC stats remote obj\n   * @param {Object} configObj.statsAnalyzerCurrentStats statsResults\n   * @returns {void}\n   * @public\n   * @memberof NetworkQualityMonitor\n   */\n  public determineUplinkNetworkQuality({\n    mediaType,\n    remoteRtpResults,\n    statsAnalyzerCurrentStats,\n  }: {\n    mediaType: string;\n    remoteRtpResults: any;\n    statsAnalyzerCurrentStats: object;\n  }) {\n    const roundTripTimeInMilliseconds = remoteRtpResults.roundTripTime * 1000;\n    const jitterInMilliseconds = remoteRtpResults.jitter * 1000;\n    const {currentPacketLossRatio} = statsAnalyzerCurrentStats[mediaType].send;\n\n    this.mediaType = mediaType;\n\n    const {JITTER, PACKETLOSS, LATENCY} = this.indicatorTypes;\n    const {UPLINK} = this.frequencyTypes;\n\n    /**\n     * determines if packetLoss ratio is over threshold set in config\n     * sets networkQualityScore to 0 if over threshold\n     * @returns {boolean}\n     */\n    const determinePacketLoss = () => {\n      if (currentPacketLossRatio > this.config.videoPacketLossRatioThreshold) {\n        this.networkQualityScore = 0;\n\n        return false;\n      }\n\n      return true;\n    };\n\n    /**\n     * determines if round trip time value is over threshold set in config\n     * sets networkQualityScore to 0 if over threshold\n     * @returns {boolean}\n     */\n    const determineLatency = () => {\n      if (roundTripTimeInMilliseconds > this.config.rttThreshold) {\n        this.networkQualityScore = 0;\n\n        return false;\n      }\n\n      return true;\n    };\n\n    /**\n     * determines if jitter value is over threshold in config\n     * sets networkQualityScore to 0 if over threshold\n     * @returns {boolean}\n     */\n    const deterMineJitter = () => {\n      if (jitterInMilliseconds > this.config.jitterThreshold) {\n        this.networkQualityScore = 0;\n\n        return false;\n      }\n\n      return true;\n    };\n\n    /**\n     * returns null if val is specifically undefined\n     * @param {(number|undefined)} value\n     * @returns {(number|null)}\n     */\n    const determineIfUndefined = (value: number | undefined) =>\n      typeof value === 'undefined' ? null : value;\n\n    if (!this.networkQualityStatus[UPLINK][mediaType]) {\n      this.networkQualityStatus[UPLINK][mediaType] = {};\n    }\n\n    /**\n     * Values for some browsers specifically Safari will be undefined we explicitly set to null\n     * https://bugs.webkit.org/show_bug.cgi?id=206645\n     * https://bugs.webkit.org/show_bug.cgi?id=212668\n     */\n    // PACKET LOSS\n    this.networkQualityStatus[UPLINK][mediaType][PACKETLOSS] = {\n      acceptable: determinePacketLoss(),\n      value: determineIfUndefined(currentPacketLossRatio),\n    };\n\n    // LATENCY measured in Round trip time\n    this.networkQualityStatus[UPLINK][mediaType][LATENCY] = {\n      acceptable: determineLatency(),\n      value: determineIfUndefined(remoteRtpResults.roundTripTime),\n    };\n\n    // JITTER\n    this.networkQualityStatus[UPLINK][mediaType][JITTER] = {\n      acceptable: deterMineJitter(),\n      value: determineIfUndefined(remoteRtpResults.jitter),\n    };\n\n    this.updateNetworkQualityStatus();\n  }\n\n  /**\n   * Get the current status of network quaility object - networkQualityStatus\n   * @returns {Object}\n   * @public\n   */\n  get networkQualityStats() {\n    const {UPLINK} = this.frequencyTypes;\n\n    return this.networkQualityStatus[UPLINK];\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;AAAA,IAAAA,YAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,UAAA,GAAAD,OAAA;AAA4C,SAAAE,aAAAC,OAAA,QAAAC,yBAAA,GAAAC,yBAAA,oBAAAC,qBAAA,QAAAC,KAAA,OAAAC,gBAAA,CAAAC,OAAA,EAAAN,OAAA,GAAAO,MAAA,MAAAN,yBAAA,QAAAO,SAAA,OAAAH,gBAAA,CAAAC,OAAA,QAAAG,WAAA,EAAAF,MAAA,GAAAG,kBAAA,CAAAN,KAAA,EAAAO,SAAA,EAAAH,SAAA,YAAAD,MAAA,GAAAH,KAAA,CAAAQ,KAAA,OAAAD,SAAA,gBAAAE,2BAAA,CAAAP,OAAA,QAAAC,MAAA;AAAA,SAAAL,0BAAA,eAAAY,OAAA,qBAAAJ,kBAAA,oBAAAA,kBAAA,CAAAK,IAAA,2BAAAC,KAAA,oCAAAC,OAAA,CAAAC,SAAA,CAAAC,OAAA,CAAAC,IAAA,CAAAV,kBAAA,CAAAO,OAAA,8CAAAI,CAAA;AAE5C;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AALA,IAMqBC,qBAAqB,GAAAC,OAAA,CAAAjB,OAAA,0BAAAkB,YAAA;EAAA,IAAAC,UAAA,CAAAnB,OAAA,EAAAgB,qBAAA,EAAAE,YAAA;EAAA,IAAAE,MAAA,GAAA3B,YAAA,CAAAuB,qBAAA;EAQxC;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,SAAAA,sBAAYK,MAAW,EAAE;IAAA,IAAAC,KAAA;IAAA,IAAAC,gBAAA,CAAAvB,OAAA,QAAAgB,qBAAA;IACvBM,KAAA,GAAAF,MAAA,CAAAN,IAAA;IAAQ,IAAAU,gBAAA,CAAAxB,OAAA,MAAAyB,uBAAA,CAAAzB,OAAA,EAAAsB,KAAA;IAAA,IAAAE,gBAAA,CAAAxB,OAAA,MAAAyB,uBAAA,CAAAzB,OAAA,EAAAsB,KAAA;IAAA,IAAAE,gBAAA,CAAAxB,OAAA,MAAAyB,uBAAA,CAAAzB,OAAA,EAAAsB,KAAA;IAAA,IAAAE,gBAAA,CAAAxB,OAAA,MAAAyB,uBAAA,CAAAzB,OAAA,EAAAsB,KAAA;IAAA,IAAAE,gBAAA,CAAAxB,OAAA,MAAAyB,uBAAA,CAAAzB,OAAA,EAAAsB,KAAA;IAAA,IAAAE,gBAAA,CAAAxB,OAAA,MAAAyB,uBAAA,CAAAzB,OAAA,EAAAsB,KAAA;IACRA,KAAA,CAAKD,MAAM,GAAGA,MAAM;IACpBC,KAAA,CAAKI,cAAc,GAAG,IAAAC,OAAA,CAAA3B,OAAA,EAAc;MAClC4B,UAAU,EAAE,YAAY;MACxBC,OAAO,EAAE,SAAS;MAClBC,MAAM,EAAE;IACV,CAAC,CAAC;IACFR,KAAA,CAAKS,cAAc,GAAG,IAAAJ,OAAA,CAAA3B,OAAA,EAAc;MAClCgC,MAAM,EAAE,QAAQ;MAChBC,QAAQ,EAAE;IACZ,CAAC,CAAC;IACFX,KAAA,CAAKY,mBAAmB,GAAG,CAAC;IAC5BZ,KAAA,CAAKa,oBAAoB,OAAAX,gBAAA,CAAAxB,OAAA,MACtBsB,KAAA,CAAKS,cAAc,CAACC,MAAM,EAAG,CAAC,CAAC,CACjC;IACDV,KAAA,CAAKc,SAAS,GAAG,IAAI;IAAC,OAAAd,KAAA;EACxB;;EAEA;AACF;AACA;AACA;AACA;AACA;EALE,IAAAe,aAAA,CAAArC,OAAA,EAAAgB,qBAAA;IAAAsB,GAAA;IAAAC,KAAA,EAMA,SAAAC,mBAAA,EAAqB;MACnB,IAAI,CAACC,IAAI,CACP;QACEC,IAAI,EAAE,uBAAuB;QAC7BC,QAAQ,EAAE;MACZ,CAAC,EACDC,yBAAc,CAACC,eAAe,EAC9B;QACET,SAAS,EAAE,IAAI,CAACA,SAAS;QACzBF,mBAAmB,EAAE,IAAI,CAACA;MAC5B,CACF,CAAC;IACH;;IAEA;AACF;AACA;AACA;AACA;EAJE;IAAAI,GAAA;IAAAC,KAAA,EAKA,SAAAO,2BAAA,EAA6B;MAC3B,IAAI,CAACN,kBAAkB,CAAC,CAAC;;MAEzB;MACA,IAAI,CAACN,mBAAmB,GAAG,CAAC;MAC5B,IAAI,CAACE,SAAS,GAAG,IAAI;IACvB;;IAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EATE;IAAAE,GAAA;IAAAC,KAAA,EAUA,SAAAQ,8BAAAC,IAAA,EAQG;MAAA,IAAAC,MAAA;MAAA,IAPDb,SAAS,GAAAY,IAAA,CAATZ,SAAS;QACTc,gBAAgB,GAAAF,IAAA,CAAhBE,gBAAgB;QAChBC,yBAAyB,GAAAH,IAAA,CAAzBG,yBAAyB;MAMzB,IAAMC,2BAA2B,GAAGF,gBAAgB,CAACG,aAAa,GAAG,IAAI;MACzE,IAAMC,oBAAoB,GAAGJ,gBAAgB,CAACK,MAAM,GAAG,IAAI;MAC3D,IAAOC,sBAAsB,GAAIL,yBAAyB,CAACf,SAAS,CAAC,CAACqB,IAAI,CAAnED,sBAAsB;MAE7B,IAAI,CAACpB,SAAS,GAAGA,SAAS;MAE1B,IAAAsB,oBAAA,GAAsC,IAAI,CAAChC,cAAc;QAAlDI,MAAM,GAAA4B,oBAAA,CAAN5B,MAAM;QAAEF,UAAU,GAAA8B,oBAAA,CAAV9B,UAAU;QAAEC,OAAO,GAAA6B,oBAAA,CAAP7B,OAAO;MAClC,IAAOG,MAAM,GAAI,IAAI,CAACD,cAAc,CAA7BC,MAAM;;MAEb;AACJ;AACA;AACA;AACA;MACI,IAAM2B,mBAAmB,GAAG,SAAtBA,mBAAmBA,CAAA,EAAS;QAChC,IAAIH,sBAAsB,GAAGP,MAAI,CAAC5B,MAAM,CAACuC,6BAA6B,EAAE;UACtEX,MAAI,CAACf,mBAAmB,GAAG,CAAC;UAE5B,OAAO,KAAK;QACd;QAEA,OAAO,IAAI;MACb,CAAC;;MAED;AACJ;AACA;AACA;AACA;MACI,IAAM2B,gBAAgB,GAAG,SAAnBA,gBAAgBA,CAAA,EAAS;QAC7B,IAAIT,2BAA2B,GAAGH,MAAI,CAAC5B,MAAM,CAACyC,YAAY,EAAE;UAC1Db,MAAI,CAACf,mBAAmB,GAAG,CAAC;UAE5B,OAAO,KAAK;QACd;QAEA,OAAO,IAAI;MACb,CAAC;;MAED;AACJ;AACA;AACA;AACA;MACI,IAAM6B,eAAe,GAAG,SAAlBA,eAAeA,CAAA,EAAS;QAC5B,IAAIT,oBAAoB,GAAGL,MAAI,CAAC5B,MAAM,CAAC2C,eAAe,EAAE;UACtDf,MAAI,CAACf,mBAAmB,GAAG,CAAC;UAE5B,OAAO,KAAK;QACd;QAEA,OAAO,IAAI;MACb,CAAC;;MAED;AACJ;AACA;AACA;AACA;MACI,IAAM+B,oBAAoB,GAAG,SAAvBA,oBAAoBA,CAAI1B,KAAyB;QAAA,OACrD,OAAOA,KAAK,KAAK,WAAW,GAAG,IAAI,GAAGA,KAAK;MAAA;MAE7C,IAAI,CAAC,IAAI,CAACJ,oBAAoB,CAACH,MAAM,CAAC,CAACI,SAAS,CAAC,EAAE;QACjD,IAAI,CAACD,oBAAoB,CAACH,MAAM,CAAC,CAACI,SAAS,CAAC,GAAG,CAAC,CAAC;MACnD;;MAEA;AACJ;AACA;AACA;AACA;MACI;MACA,IAAI,CAACD,oBAAoB,CAACH,MAAM,CAAC,CAACI,SAAS,CAAC,CAACR,UAAU,CAAC,GAAG;QACzDsC,UAAU,EAAEP,mBAAmB,CAAC,CAAC;QACjCpB,KAAK,EAAE0B,oBAAoB,CAACT,sBAAsB;MACpD,CAAC;;MAED;MACA,IAAI,CAACrB,oBAAoB,CAACH,MAAM,CAAC,CAACI,SAAS,CAAC,CAACP,OAAO,CAAC,GAAG;QACtDqC,UAAU,EAAEL,gBAAgB,CAAC,CAAC;QAC9BtB,KAAK,EAAE0B,oBAAoB,CAACf,gBAAgB,CAACG,aAAa;MAC5D,CAAC;;MAED;MACA,IAAI,CAAClB,oBAAoB,CAACH,MAAM,CAAC,CAACI,SAAS,CAAC,CAACN,MAAM,CAAC,GAAG;QACrDoC,UAAU,EAAEH,eAAe,CAAC,CAAC;QAC7BxB,KAAK,EAAE0B,oBAAoB,CAACf,gBAAgB,CAACK,MAAM;MACrD,CAAC;MAED,IAAI,CAACT,0BAA0B,CAAC,CAAC;IACnC;;IAEA;AACF;AACA;AACA;AACA;EAJE;IAAAR,GAAA;IAAA6B,GAAA,EAKA,SAAAA,IAAA,EAA0B;MACxB,IAAOnC,MAAM,GAAI,IAAI,CAACD,cAAc,CAA7BC,MAAM;MAEb,OAAO,IAAI,CAACG,oBAAoB,CAACH,MAAM,CAAC;IAC1C;EAAC;EAAA,OAAAhB,qBAAA;AAAA,EA/LgDoD,oBAAW"}

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

@@ -1,70 +0,0 @@
-import EventsScope from '../common/events/events-scope';
-/**
- * Meeting - network quality event
- * Emitted on each interval of retrieving stats Analyzer data
- * @event network:quality
- * @type {Object}
- * @property {string} mediaType {video|audio}
- * @property {number} networkQualityScore - value determined in determineUplinkNetworkQuality
- * @memberof NetworkQualityMonitor
- */
-/**
- * NetworkQualityMonitor class that will emit events based on detected quality
- *
- * @class NetworkQualityMonitor
- * @extends {EventsScope}
- */
-export default class NetworkQualityMonitor extends EventsScope {
-    config: any;
-    frequencyTypes: any;
-    indicatorTypes: any;
-    mediaType: any;
-    networkQualityScore: any;
-    networkQualityStatus: any;
-    /**
-     * Creates a new instance of NetworkQualityMonitor
-     * @constructor
-     * @public
-     * @param {Object} config
-     * @property {Object} indicatorTypes - network properties used to evaluate network quality used as constants
-     * @property {Object} frequencyTypes - frequency properties used as constants {uplink|send} {downlink|receive}
-     * @property {number} networkQualityScore  - 0|1 1 is acceptable 0 is bad/unknown
-     * @property {Object} networkQualityStatus - hash object based on indicatorTypes and frequencyTypes
-     * @property {string} mediaType - audio|video
-     */
-    constructor(config: any);
-    /**
-     * emits NETWORK_QUALITY event on meeting with payload of media type and uplinkNetworkQuality score
-     *
-     * @memberof NetworkQualityMonitor
-     * @returns {void}
-     */
-    emitNetworkQuality(): void;
-    /**
-     * invokes emitNetworkQuality method resets values back to default
-     * @returns {void}
-     * @memberof NetworkQualityMonitor
-     */
-    updateNetworkQualityStatus(): void;
-    /**
-     * filter data to determine uplink network quality, invoked on same interval as stats analyzer remote-inbout-rtp
-     * @param {Object} configObj
-     * @param {string} configObj.mediaType {audio|video}
-     * @param {RTCStats} configObj.remoteRtpResults RTC stats remote obj
-     * @param {Object} configObj.statsAnalyzerCurrentStats statsResults
-     * @returns {void}
-     * @public
-     * @memberof NetworkQualityMonitor
-     */
-    determineUplinkNetworkQuality({ mediaType, remoteRtpResults, statsAnalyzerCurrentStats, }: {
-        mediaType: string;
-        remoteRtpResults: any;
-        statsAnalyzerCurrentStats: object;
-    }): void;
-    /**
-     * Get the current status of network quaility object - networkQualityStatus
-     * @returns {Object}
-     * @public
-     */
-    get networkQualityStats(): any;
-}

package/src/networkQualityMonitor/index.ts

@@ -1,211 +0,0 @@
-import EventsScope from '../common/events/events-scope';
-import {EVENT_TRIGGERS} from '../constants';
-
-/**
- * Meeting - network quality event
- * Emitted on each interval of retrieving stats Analyzer data
- * @event network:quality
- * @type {Object}
- * @property {string} mediaType {video|audio}
- * @property {number} networkQualityScore - value determined in determineUplinkNetworkQuality
- * @memberof NetworkQualityMonitor
- */
-/**
- * NetworkQualityMonitor class that will emit events based on detected quality
- *
- * @class NetworkQualityMonitor
- * @extends {EventsScope}
- */
-export default class NetworkQualityMonitor extends EventsScope {
-  config: any;
-  frequencyTypes: any;
-  indicatorTypes: any;
-  mediaType: any;
-  networkQualityScore: any;
-  networkQualityStatus: any;
-
-  /**
-   * Creates a new instance of NetworkQualityMonitor
-   * @constructor
-   * @public
-   * @param {Object} config
-   * @property {Object} indicatorTypes - network properties used to evaluate network quality used as constants
-   * @property {Object} frequencyTypes - frequency properties used as constants {uplink|send} {downlink|receive}
-   * @property {number} networkQualityScore  - 0|1 1 is acceptable 0 is bad/unknown
-   * @property {Object} networkQualityStatus - hash object based on indicatorTypes and frequencyTypes
-   * @property {string} mediaType - audio|video
-   */
-  constructor(config: any) {
-    super();
-    this.config = config;
-    this.indicatorTypes = Object.freeze({
-      PACKETLOSS: 'packetLoss',
-      LATENCY: 'latency',
-      JITTER: 'jitter',
-    });
-    this.frequencyTypes = Object.freeze({
-      UPLINK: 'uplink',
-      DOWNLINK: 'downlink',
-    });
-    this.networkQualityScore = 1;
-    this.networkQualityStatus = {
-      [this.frequencyTypes.UPLINK]: {},
-    };
-    this.mediaType = null;
-  }
-
-  /**
-   * emits NETWORK_QUALITY event on meeting with payload of media type and uplinkNetworkQuality score
-   *
-   * @memberof NetworkQualityMonitor
-   * @returns {void}
-   */
-  emitNetworkQuality() {
-    this.emit(
-      {
-        file: 'networkQualityMonitor',
-        function: 'emitNetworkQuality',
-      },
-      EVENT_TRIGGERS.NETWORK_QUALITY,
-      {
-        mediaType: this.mediaType,
-        networkQualityScore: this.networkQualityScore,
-      }
-    );
-  }
-
-  /**
-   * invokes emitNetworkQuality method resets values back to default
-   * @returns {void}
-   * @memberof NetworkQualityMonitor
-   */
-  updateNetworkQualityStatus() {
-    this.emitNetworkQuality();
-
-    // reset values
-    this.networkQualityScore = 1;
-    this.mediaType = null;
-  }
-
-  /**
-   * filter data to determine uplink network quality, invoked on same interval as stats analyzer remote-inbout-rtp
-   * @param {Object} configObj
-   * @param {string} configObj.mediaType {audio|video}
-   * @param {RTCStats} configObj.remoteRtpResults RTC stats remote obj
-   * @param {Object} configObj.statsAnalyzerCurrentStats statsResults
-   * @returns {void}
-   * @public
-   * @memberof NetworkQualityMonitor
-   */
-  public determineUplinkNetworkQuality({
-    mediaType,
-    remoteRtpResults,
-    statsAnalyzerCurrentStats,
-  }: {
-    mediaType: string;
-    remoteRtpResults: any;
-    statsAnalyzerCurrentStats: object;
-  }) {
-    const roundTripTimeInMilliseconds = remoteRtpResults.roundTripTime * 1000;
-    const jitterInMilliseconds = remoteRtpResults.jitter * 1000;
-    const {currentPacketLossRatio} = statsAnalyzerCurrentStats[mediaType].send;
-
-    this.mediaType = mediaType;
-
-    const {JITTER, PACKETLOSS, LATENCY} = this.indicatorTypes;
-    const {UPLINK} = this.frequencyTypes;
-
-    /**
-     * determines if packetLoss ratio is over threshold set in config
-     * sets networkQualityScore to 0 if over threshold
-     * @returns {boolean}
-     */
-    const determinePacketLoss = () => {
-      if (currentPacketLossRatio > this.config.videoPacketLossRatioThreshold) {
-        this.networkQualityScore = 0;
-
-        return false;
-      }
-
-      return true;
-    };
-
-    /**
-     * determines if round trip time value is over threshold set in config
-     * sets networkQualityScore to 0 if over threshold
-     * @returns {boolean}
-     */
-    const determineLatency = () => {
-      if (roundTripTimeInMilliseconds > this.config.rttThreshold) {
-        this.networkQualityScore = 0;
-
-        return false;
-      }
-
-      return true;
-    };
-
-    /**
-     * determines if jitter value is over threshold in config
-     * sets networkQualityScore to 0 if over threshold
-     * @returns {boolean}
-     */
-    const deterMineJitter = () => {
-      if (jitterInMilliseconds > this.config.jitterThreshold) {
-        this.networkQualityScore = 0;
-
-        return false;
-      }
-
-      return true;
-    };
-
-    /**
-     * returns null if val is specifically undefined
-     * @param {(number|undefined)} value
-     * @returns {(number|null)}
-     */
-    const determineIfUndefined = (value: number | undefined) =>
-      typeof value === 'undefined' ? null : value;
-
-    if (!this.networkQualityStatus[UPLINK][mediaType]) {
-      this.networkQualityStatus[UPLINK][mediaType] = {};
-    }
-
-    /**
-     * Values for some browsers specifically Safari will be undefined we explicitly set to null
-     * https://bugs.webkit.org/show_bug.cgi?id=206645
-     * https://bugs.webkit.org/show_bug.cgi?id=212668
-     */
-    // PACKET LOSS
-    this.networkQualityStatus[UPLINK][mediaType][PACKETLOSS] = {
-      acceptable: determinePacketLoss(),
-      value: determineIfUndefined(currentPacketLossRatio),
-    };
-
-    // LATENCY measured in Round trip time
-    this.networkQualityStatus[UPLINK][mediaType][LATENCY] = {
-      acceptable: determineLatency(),
-      value: determineIfUndefined(remoteRtpResults.roundTripTime),
-    };
-
-    // JITTER
-    this.networkQualityStatus[UPLINK][mediaType][JITTER] = {
-      acceptable: deterMineJitter(),
-      value: determineIfUndefined(remoteRtpResults.jitter),
-    };
-
-    this.updateNetworkQualityStatus();
-  }
-
-  /**
-   * Get the current status of network quaility object - networkQualityStatus
-   * @returns {Object}
-   * @public
-   */
-  get networkQualityStats() {
-    const {UPLINK} = this.frequencyTypes;
-
-    return this.networkQualityStatus[UPLINK];
-  }
-}

package/test/unit/spec/networkQualityMonitor/index.js

@@ -1,99 +0,0 @@
-import 'jsdom-global/register';
-import chai from 'chai';
-import chaiAsPromised from 'chai-as-promised';
-import sinon from 'sinon';
-
-import NetworkQualityMonitor from '../../../../src/networkQualityMonitor';
-import {EVENT_TRIGGERS} from '../../../../src/constants';
-
-const {assert} = chai;
-
-chai.use(chaiAsPromised);
-sinon.assert.expose(chai.assert, {prefix: ''});
-
-// eslint-disable-next-line mocha/no-exclusive-tests
-describe('plugin-meetings', () => {
-  describe('NetworkQualityMonitor', () => {
-    let networkQualityMonitor;
-    let sandBoxEmitSpy;
-
-    const initialConfig = {
-      videoPacketLossRatioThreshold: 9,
-      rttThreshold: 500,
-      jitterThreshold: 500,
-    };
-
-    const configObject = {
-      mediaType: 'video-send',
-      remoteRtpResults: {
-        id: 'RTCRemoteInboundRtpVideoStream_2411086660',
-        timestamp: 1624472676193.79,
-        type: 'remote-inbound-rtp',
-        ssrc: 2411086660,
-        kind: 'video',
-        transportId: 'RTCTransport_1_1',
-        codecId: 'RTCCodec_1_Outbound_102',
-        jitter: 0.004,
-        packetsLost: 8,
-        localId: 'RTCOutboundRTPVideoStream_2411086660',
-        roundTripTime: 0.648,
-        fractionLost: 0,
-        totalRoundTripTime: 3.554,
-        roundTripTimeMeasurements: 14,
-      },
-      statsAnalyzerCurrentStats: {
-        'audio-send': {
-          send: {
-            currentPacketLossRatio: 8,
-          },
-        },
-        'video-send': {
-          send: {
-            currentPacketLossRatio: 10,
-          },
-        },
-      },
-    };
-
-    const sandbox = sinon.createSandbox();
-
-    beforeEach(() => {
-      networkQualityMonitor = new NetworkQualityMonitor(initialConfig);
-      sandbox.spy(networkQualityMonitor, 'updateNetworkQualityStatus');
-      sandBoxEmitSpy = sandbox.spy(networkQualityMonitor, 'emit');
-    });
-
-    afterEach(() => {
-      sandbox.restore();
-    });
-
-    it('should trigger updateNetworkQualityStatus when determineUplinkNetworkQuality has finished', async () => {
-      await networkQualityMonitor.determineUplinkNetworkQuality(configObject);
-
-      assert.calledOnce(networkQualityMonitor.updateNetworkQualityStatus);
-    });
-
-    it('should emit a network quality judgement event with the proper payload', async () => {
-      await networkQualityMonitor.determineUplinkNetworkQuality(configObject);
-      assert(
-        sandBoxEmitSpy.calledWith(
-          sinon.match({
-            file: 'networkQualityMonitor',
-            function: 'emitNetworkQuality',
-          }),
-          sinon.match(EVENT_TRIGGERS.NETWORK_QUALITY),
-          sinon.match({
-            mediaType: 'video-send',
-            networkQualityScore: 0,
-          })
-        )
-      );
-    });
-
-    it('should reset to default values after determineUplinkNetworkQuality call stack is complete', async () => {
-      await networkQualityMonitor.determineUplinkNetworkQuality(configObject);
-      assert.isNull(networkQualityMonitor.mediaType);
-      assert.deepEqual(networkQualityMonitor.networkQualityScore, 1);
-    });
-  });
-});