@webex/plugin-meetings 2.19.1 → 2.19.3

package/dist/statsAnalyzer/index.js

@@ -10,7 +10,9 @@ _Object$defineProperty(exports, "__esModule", {
   value: true
 });
 
-exports.default = void 0;
+exports.StatsAnalyzer = exports.EVENTS = void 0;
+
+var _promise = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/promise"));
 
 var _stringify = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/json/stringify"));
 
@@ -46,16 +48,13 @@ function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflec
 
 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 High Packet Loss Event
-  * Emitted when ever there is high packet loss detected
-  * @event meeting:highPacketLoss
-  * @type {Object}
-  * @property {String} mediaType Type of media experiencing packet loss
-  * @property {Number} packetLossRatio current packet loss ratio
-  * @memberof StatsAnalyzer
-  */
-
+var EVENTS = {
+  MEDIA_QUALITY: 'MEDIA_QUALITY',
+  LOCAL_MEDIA_STARTED: 'LOCAL_MEDIA_STARTED',
+  LOCAL_MEDIA_STOPPED: 'LOCAL_MEDIA_STOPPED',
+  REMOTE_MEDIA_STARTED: 'REMOTE_MEDIA_STARTED',
+  REMOTE_MEDIA_STOPPED: 'REMOTE_MEDIA_STOPPED'
+};
 /**
  * Stats Analyzer class that will emit events based on detected quality
  *
@@ -63,6 +62,9 @@ function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !_R
  * @class StatsAnalyzer
  * @extends {EventsScope}
  */
+
+exports.EVENTS = EVENTS;
+
 var StatsAnalyzer = /*#__PURE__*/function (_EventsScope) {
   (0, _inherits2.default)(StatsAnalyzer, _EventsScope);
 
@@ -83,6 +85,39 @@ var StatsAnalyzer = /*#__PURE__*/function (_EventsScope) {
     var statsResults = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : _global.default;
     (0, _classCallCheck2.default)(this, StatsAnalyzer);
     _this = _super.call(this);
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "emitStartStopEvents", function (mediaType, previousValue, currentValue, isLocal) {
+      if (mediaType !== 'audio' && mediaType !== 'video' && mediaType !== 'share') {
+        throw new Error("Unsupported mediaType: ".concat(mediaType));
+      } // eslint-disable-next-line no-param-reassign
+
+
+      if (previousValue === undefined) previousValue = 0; // eslint-disable-next-line no-param-reassign
+
+      if (currentValue === undefined) currentValue = 0;
+      var lastEmittedEvent = isLocal ? _this.lastEmittedStartStopEvent[mediaType].local : _this.lastEmittedStartStopEvent[mediaType].remote;
+      var newEvent;
+
+      if (currentValue - previousValue > 0) {
+        newEvent = isLocal ? EVENTS.LOCAL_MEDIA_STARTED : EVENTS.REMOTE_MEDIA_STARTED;
+      } else if (currentValue === previousValue && currentValue > 0) {
+        newEvent = isLocal ? EVENTS.LOCAL_MEDIA_STOPPED : EVENTS.REMOTE_MEDIA_STOPPED;
+      }
+
+      if (newEvent && lastEmittedEvent !== newEvent) {
+        if (isLocal) {
+          _this.lastEmittedStartStopEvent[mediaType].local = newEvent;
+        } else {
+          _this.lastEmittedStartStopEvent[mediaType].remote = newEvent;
+        }
+
+        _this.emit({
+          file: 'statsAnalyzer/index',
+          function: 'compareLastStatsResult'
+        }, newEvent, {
+          type: mediaType
+        });
+      }
+    });
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "parseCandidate", function (result, type, isSender, isRemote) {
       if (!result || !result.id) {
         return;
@@ -220,6 +255,20 @@ var StatsAnalyzer = /*#__PURE__*/function (_EventsScope) {
         }
       }
     };
+    _this.lastEmittedStartStopEvent = {
+      audio: {
+        local: undefined,
+        remote: undefined
+      },
+      video: {
+        local: undefined,
+        remote: undefined
+      },
+      share: {
+        local: undefined,
+        remote: undefined
+      }
+    };
     return _this;
   }
 
@@ -365,7 +414,7 @@ var StatsAnalyzer = /*#__PURE__*/function (_EventsScope) {
       this.emit({
         file: 'statsAnalyzer',
         function: 'sendMqaData'
-      }, _constants.EVENT_TRIGGERS.MEDIA_QUALITY, {
+      }, EVENTS.MEDIA_QUALITY, {
         data: _config.default.intervals[0],
         networkType: _config.default.networkType
       });
@@ -390,7 +439,7 @@ var StatsAnalyzer = /*#__PURE__*/function (_EventsScope) {
      * @public
      * @memberof StatsAnalyzer
      * @param {PeerConnection} peerConnection
-     * @returns {void}
+     * @returns {Promise}
      */
 
   }, {
@@ -401,16 +450,20 @@ var StatsAnalyzer = /*#__PURE__*/function (_EventsScope) {
       if (!this.statsStarted) {
         this.statsStarted = true;
         this.peerConnection = peerConnection;
-        this.getStatsAndParse();
-        this.statsInterval = setInterval(function () {
-          _this2.getStatsAndParse();
-        }, this.config.analyzerInterval); // Trigger initial fetch
+        return this.getStatsAndParse().then(function () {
+          _this2.statsInterval = setInterval(function () {
+            _this2.getStatsAndParse();
+          }, _this2.config.analyzerInterval); // Trigger initial fetch
 
-        this.sendMqaData();
-        this.mqaInterval = setInterval(function () {
           _this2.sendMqaData();
-        }, _constants.MQA_INTEVAL);
+
+          _this2.mqaInterval = setInterval(function () {
+            _this2.sendMqaData();
+          }, _constants.MQA_INTEVAL);
+        });
       }
+
+      return _promise.default.resolve();
     }
     /**
      * Cleans up the analyzer when done
@@ -423,19 +476,30 @@ var StatsAnalyzer = /*#__PURE__*/function (_EventsScope) {
   }, {
     key: "stopAnalyzer",
     value: function stopAnalyzer() {
+      var _this3 = this;
+
+      var sendOneLastMqa = this.mqaInterval && this.statsInterval;
+
       if (this.statsInterval) {
-        this.getStatsAndParse();
         clearInterval(this.statsInterval);
-        this.statsInterva = undefined;
+        this.statsInterval = undefined;
       }
 
       if (this.mqaInterval) {
-        this.sendMqaData();
         clearInterval(this.mqaInterval);
-        this.statsInterva = undefined;
+        this.mqaInterval = undefined;
+      }
+
+      if (sendOneLastMqa) {
+        return this.getStatsAndParse().then(function () {
+          _this3.sendMqaData();
+
+          _this3.peerConnection = null;
+        });
       }
 
       this.peerConnection = null;
+      return _promise.default.resolve();
     }
     /**
      * Parse a single result of get stats
@@ -502,12 +566,12 @@ var StatsAnalyzer = /*#__PURE__*/function (_EventsScope) {
   }, {
     key: "filterAndParseGetStatsResults",
     value: function filterAndParseGetStatsResults(getStatsResults, type, isSender) {
-      var _this3 = this;
+      var _this4 = this;
 
       var types = _constants.DEFAULT_GET_STATS_FILTER.types;
       getStatsResults.forEach(function (result) {
         if (types.includes(result.type)) {
-          _this3.parseGetStatsResult(result, type, isSender);
+          _this4.parseGetStatsResult(result, type, isSender);
         }
       });
     }
@@ -531,16 +595,31 @@ var StatsAnalyzer = /*#__PURE__*/function (_EventsScope) {
       }
     }
     /**
-     * compares current and previous stats to check if packets are not sent
+     * emits started/stopped events for local/remote media by checking
+     * if given values are increasing or not. The previousValue, currentValue
+     * params can be any numerical value like number of receive packets or
+     * decoded frames, etc.
      *
      * @private
+     * @param {string} mediaType
+     * @param {number} previousValue - value to compare
+     * @param {number} currentValue - value to compare (must be same type of value as previousValue)
+     * @param {boolean} isLocal - true if stats are for local media being sent out, false for remote media being received
      * @memberof StatsAnalyzer
      * @returns {void}
      */
 
   }, {
     key: "compareLastStatsResult",
-    value: function compareLastStatsResult() {
+    value:
+    /**
+     * compares current and previous stats to check if packets are not sent
+     *
+     * @private
+     * @memberof StatsAnalyzer
+     * @returns {void}
+     */
+    function compareLastStatsResult() {
       if (this.lastStatsResults !== null && this.meetingMediaStatus) {
         // compare audio stats sent
         var mediaType = _constants.STATS.AUDIO_CORRELATE;
@@ -563,14 +642,7 @@ var StatsAnalyzer = /*#__PURE__*/function (_EventsScope) {
             }
           }
 
-          if (previousStats.totalPacketsSent === 0 && currentStats.totalPacketsSent > 0) {
-            this.emit({
-              file: 'statsAnalyzer/index',
-              function: 'compareLastStatsResult'
-            }, _constants.EVENT_TRIGGERS.MEETING_MEDIA_LOCAL_STARTED, {
-              type: mediaType.AUDIO
-            });
-          }
+          this.emitStartStopEvents(mediaType, previousStats.totalPacketsSent, currentStats.totalPacketsSent, true);
         }
 
         if (this.meetingMediaStatus.expected.receiveAudio) {
@@ -583,6 +655,8 @@ var StatsAnalyzer = /*#__PURE__*/function (_EventsScope) {
           } else if (currentStats.totalSamplesReceived === previousStats.totalSamplesReceived || currentStats.totalSamplesReceived === 0) {
             _loggerProxy.default.logger.info("StatsAnalyzer:index#compareLastStatsResult --> No ".concat(mediaType, " samples received"));
           }
+
+          this.emitStartStopEvents(mediaType, previousStats.totalPacketsReceived, currentStats.totalPacketsReceived, false);
         }
 
         mediaType = _constants.STATS.VIDEO_CORRELATE;
@@ -604,14 +678,7 @@ var StatsAnalyzer = /*#__PURE__*/function (_EventsScope) {
             }
           }
 
-          if (previousStats.framesSent === 0 && currentStats.framesSent > 0) {
-            this.emit({
-              file: 'statsAnalyzer/index',
-              function: 'compareLastStatsResult'
-            }, _constants.EVENT_TRIGGERS.MEETING_MEDIA_LOCAL_STARTED, {
-              type: mediaType.VIDEO
-            });
-          }
+          this.emitStartStopEvents(mediaType, previousStats.framesSent, currentStats.framesSent, true);
         }
 
         if (this.meetingMediaStatus.expected.receiveVideo) {
@@ -626,7 +693,7 @@ var StatsAnalyzer = /*#__PURE__*/function (_EventsScope) {
               _loggerProxy.default.logger.info("StatsAnalyzer:index#compareLastStatsResult --> No ".concat(mediaType, " frames received"));
             }
 
-            if (this.statsResults.resolutions[mediaType].recv.framesDecoded === this.lastStatsResults.resolutions[mediaType].recv.framesDecoded || this.statsResults.resolutions[mediaType].send.framesDecoded === 0) {
+            if (this.statsResults[mediaType].recv.framesDecoded === this.lastStatsResults[mediaType].recv.framesDecoded || this.statsResults.resolutions[mediaType].send.framesDecoded === 0) {
               _loggerProxy.default.logger.info("StatsAnalyzer:index#compareLastStatsResult --> No ".concat(mediaType, " frames decoded"));
             }
 
@@ -634,6 +701,8 @@ var StatsAnalyzer = /*#__PURE__*/function (_EventsScope) {
               _loggerProxy.default.logger.info("StatsAnalyzer:index#compareLastStatsResult --> ".concat(mediaType, " frames are getting dropped"));
             }
           }
+
+          this.emitStartStopEvents(mediaType, previousStats.framesDecoded, currentStats.framesDecoded, false);
         }
 
         mediaType = _constants.STATS.SHARE_CORRELATE;
@@ -653,15 +722,6 @@ var StatsAnalyzer = /*#__PURE__*/function (_EventsScope) {
             if (this.statsResults.resolutions[mediaType].send.framesSent === this.lastStatsResults.resolutions[mediaType].send.framesSent || this.statsResults.resolutions[mediaType].send.framesSent === 0) {
               _loggerProxy.default.logger.info("StatsAnalyzer:index#compareLastStatsResult --> No ".concat(mediaType, " frames sent"));
             }
-          }
-
-          if (previousStats.framesSent === 0 && currentStats.framesSent > 0) {
-            this.emit({
-              file: 'statsAnalyzer/index',
-              function: 'compareLastStatsResult'
-            }, _constants.EVENT_TRIGGERS.MEETING_MEDIA_LOCAL_STARTED, {
-              type: mediaType.VIDEO
-            });
           } // TODO:need to check receive share value
           // compare share stats reveived
 
@@ -676,14 +736,17 @@ var StatsAnalyzer = /*#__PURE__*/function (_EventsScope) {
               _loggerProxy.default.logger.info("StatsAnalyzer:index#compareLastStatsResult --> No ".concat(mediaType, " frames received"));
             }
 
-            if (this.statsResults.resolutions[mediaType].recv.framesDecoded === this.lastStatsResults.resolutions[mediaType].recv.framesDecoded || this.statsResults.resolutions[mediaType].send.framesDecoded === 0) {
+            if (this.statsResults[mediaType].recv.framesDecoded === this.lastStatsResults[mediaType].recv.framesDecoded || this.statsResults.resolutions[mediaType].send.framesDecoded === 0) {
               _loggerProxy.default.logger.info("StatsAnalyzer:index#compareLastStatsResult --> No ".concat(mediaType, " frames decoded"));
             }
 
             if (this.statsResults.resolutions[mediaType].recv.framesDropped - this.lastStatsResults.resolutions[mediaType].recv.framesDropped > 10) {
               _loggerProxy.default.logger.info("StatsAnalyzer:index#compareLastStatsResult --> ".concat(mediaType, " frames are getting dropped"));
             }
-          }
+          } // we are not calling emitStartStopEvents() for sending or receiving share because sharing is often started and stopped
+          // in meetings and this.meetingMediaStatus.expected values can be out of sync with the actual packet flow
+          // so we would send "sharing stopped" events incorrectly
+
         }
       }
     }
@@ -692,56 +755,51 @@ var StatsAnalyzer = /*#__PURE__*/function (_EventsScope) {
      *
      * @private
      * @memberof StatsAnalyzer
-     * @returns {void}
+     * @returns {Promise}
      */
 
   }, {
     key: "getStatsAndParse",
     value: function getStatsAndParse() {
-      var _this4 = this;
+      var _this5 = this;
 
       if (!this.peerConnection) {
-        return;
+        return _promise.default.resolve();
       }
 
       if (this.peerConnection && this.peerConnection.connectionState === _constants.CONNECTION_STATE.FAILED) {
         _loggerProxy.default.logger.trace('StatsAnalyzer:index#getStatsAndParse --> PeerConnection is in failed state');
 
-        return;
+        return _promise.default.resolve();
       }
 
       _loggerProxy.default.logger.trace('StatsAnalyzer:index#getStatsAndParse --> Collecting Stats');
 
-      this.peerConnection.videoTransceiver.sender.getStats().then(function (res) {
-        _this4.filterAndParseGetStatsResults(res, _constants.STATS.VIDEO_CORRELATE, true);
-      });
-      this.peerConnection.videoTransceiver.receiver.getStats().then(function (res) {
-        _this4.filterAndParseGetStatsResults(res, _constants.STATS.VIDEO_CORRELATE, false);
-      });
-      this.peerConnection.audioTransceiver.sender.getStats().then(function (res) {
-        _this4.filterAndParseGetStatsResults(res, _constants.STATS.AUDIO_CORRELATE, true);
-      });
-      this.peerConnection.audioTransceiver.receiver.getStats().then(function (res) {
-        _this4.filterAndParseGetStatsResults(res, _constants.STATS.AUDIO_CORRELATE, false);
-      }); // TODO: add checks for screen share
-
+      return _promise.default.all([this.peerConnection.videoTransceiver.sender.getStats().then(function (res) {
+        _this5.filterAndParseGetStatsResults(res, _constants.STATS.VIDEO_CORRELATE, true);
+      }), this.peerConnection.videoTransceiver.receiver.getStats().then(function (res) {
+        _this5.filterAndParseGetStatsResults(res, _constants.STATS.VIDEO_CORRELATE, false);
+      }), this.peerConnection.audioTransceiver.sender.getStats().then(function (res) {
+        _this5.filterAndParseGetStatsResults(res, _constants.STATS.AUDIO_CORRELATE, true);
+      }), this.peerConnection.audioTransceiver.receiver.getStats().then(function (res) {
+        _this5.filterAndParseGetStatsResults(res, _constants.STATS.AUDIO_CORRELATE, false);
+      }), // TODO: add checks for screen share
       this.peerConnection.shareTransceiver.sender.getStats().then(function (res) {
-        _this4.filterAndParseGetStatsResults(res, _constants.STATS.SHARE_CORRELATE, true);
-      });
-      this.peerConnection.shareTransceiver.receiver.getStats().then(function (res) {
-        _this4.filterAndParseGetStatsResults(res, _constants.STATS.SHARE_CORRELATE, false);
-      }); // updates the current direction of media
+        _this5.filterAndParseGetStatsResults(res, _constants.STATS.SHARE_CORRELATE, true);
+      }), this.peerConnection.shareTransceiver.receiver.getStats().then(function (res) {
+        _this5.filterAndParseGetStatsResults(res, _constants.STATS.SHARE_CORRELATE, false);
+      })]).then(function () {
+        _this5.statsResults[_constants.STATS.AUDIO_CORRELATE].direction = _this5.peerConnection.audioTransceiver.currentDirection;
+        _this5.statsResults[_constants.STATS.VIDEO_CORRELATE].direction = _this5.peerConnection.videoTransceiver.currentDirection;
+        _this5.statsResults[_constants.STATS.SHARE_CORRELATE].direction = _this5.peerConnection.shareTransceiver.currentDirection; // Process Stats results every 5 seconds
 
-      this.statsResults[_constants.STATS.AUDIO_CORRELATE].direction = this.peerConnection.audioTransceiver.currentDirection;
-      this.statsResults[_constants.STATS.VIDEO_CORRELATE].direction = this.peerConnection.videoTransceiver.currentDirection;
-      this.statsResults[_constants.STATS.SHARE_CORRELATE].direction = this.peerConnection.shareTransceiver.currentDirection; // Process Stats results every 5 seconds
+        _this5.compareLastStatsResult(); // Save the last results to compare with the current
 
-      this.compareLastStatsResult(); // Save the last results to compare with the current
-      // DO Deep copy, for some reason it takes the reference all the time rather then old value set
 
-      this.lastStatsResults = JSON.parse((0, _stringify.default)(this.statsResults));
+        _this5.lastStatsResults = JSON.parse((0, _stringify.default)(_this5.statsResults));
 
-      _loggerProxy.default.logger.trace('StatsAnalyzer:index#getStatsAndParse --> Finished Collecting Stats');
+        _loggerProxy.default.logger.trace('StatsAnalyzer:index#getStatsAndParse --> Finished Collecting Stats');
+      });
     }
     /**
      * Processes OutboundRTP stats result and stores
@@ -793,6 +851,7 @@ var StatsAnalyzer = /*#__PURE__*/function (_EventsScope) {
         this.statsResults[mediaType][sendrecvType].totalPliCount = result.pliCount;
         this.statsResults[mediaType][sendrecvType].totalPacketsSent = result.packetsSent;
         this.statsResults[mediaType][sendrecvType].totalFirCount = result.firCount;
+        this.statsResults[mediaType][sendrecvType].framesSent = result.framesSent;
         this.statsResults[mediaType][sendrecvType].framesEncoded = result.framesEncoded;
         this.statsResults[mediaType][sendrecvType].encoderImplementation = result.encoderImplementation;
         this.statsResults[mediaType][sendrecvType].qualityLimitationReason = result.qualityLimitationReason;
@@ -999,5 +1058,5 @@ var StatsAnalyzer = /*#__PURE__*/function (_EventsScope) {
   return StatsAnalyzer;
 }(_eventsScope.default);
 
-exports.default = StatsAnalyzer;
+exports.StatsAnalyzer = StatsAnalyzer;
 //# sourceMappingURL=index.js.map