@flashphoner/websdk 2.0.262 → 2.0.264

package/docTemplate/README.md

@@ -1,4 +1,4 @@
-Web SDK - 2.0.262
+Web SDK - 2.0.264
 
 [Download builds](https://docs.flashphoner.com/display/WEBSDK2EN/Web+SDK+release+notes)
 

package/flashphoner-no-flash.js

@@ -11885,6 +11885,7 @@ var StreamStatsCollector = function StreamStatsCollector(description, id, mediaC
     metricsBatch: null,
     timer: null,
     batchCount: 0,
+    timerBusy: false,
     start: function () {
       var _start = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee() {
         var error;
@@ -11967,7 +11968,7 @@ var StreamStatsCollector = function StreamStatsCollector(description, id, mediaC
                 _context2.n = 1;
                 break;
               }
-              statCollector.logger.error(LOG_PREFIX, "Can't update WebRTC metrics sending: no parameters passed");
+              statCollector.logger.error(LOG_PREFIX + "-" + statCollector.id, "Can't update WebRTC metrics sending: no parameters passed");
               return _context2.a(2);
             case 1:
               if (!(description.types || description.compression)) {
@@ -12027,14 +12028,26 @@ var StreamStatsCollector = function StreamStatsCollector(description, id, mediaC
     }(),
     updateHeaders: function () {
       var _updateHeaders = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee3() {
-        var stats;
+        var stats,
+          currentHeaders,
+          headersChanged,
+          newMetrics,
+          _args3 = arguments;
         return _regenerator().w(function (_context3) {
           while (1) switch (_context3.n) {
             case 0:
+              stats = _args3.length > 0 && _args3[0] !== undefined ? _args3[0] : null;
+              currentHeaders = "";
+              headersChanged = false;
+              if (stats) {
+                _context3.n = 2;
+                break;
+              }
               _context3.n = 1;
               return statCollector.mediaConnection.getWebRTCStats();
             case 1:
               stats = _context3.v;
+            case 2:
               Object.keys(statCollector.description.types).forEach(function (type) {
                 var typeDescriptor = statCollector.description.types[type];
                 var metricsString = "";
@@ -12047,11 +12060,11 @@ var StreamStatsCollector = function StreamStatsCollector(description, id, mediaC
                 }
                 if (stats[type]) {
                   stats[type].forEach(function (report) {
-                    statCollector.logger.debug(LOG_PREFIX, type + " report: " + JSON.stringify(report));
+                    statCollector.logger.debug(LOG_PREFIX + "-" + statCollector.id, type + " report: " + JSON.stringify(report));
                     if (contentFilters) {
                       var filtersMatched = true;
                       for (var filter in contentFilters) {
-                        statCollector.logger.debug(LOG_PREFIX, type + " filter by " + filter + ": " + JSON.stringify(contentFilters[filter]));
+                        statCollector.logger.debug(LOG_PREFIX + "-" + statCollector.id, type + " filter by " + filter + ": " + JSON.stringify(contentFilters[filter]));
                         var filterMatched = false;
                         if (report[filter]) {
                           var _iterator = _createForOfIteratorHelper(contentFilters[filter]),
@@ -12059,7 +12072,7 @@ var StreamStatsCollector = function StreamStatsCollector(description, id, mediaC
                           try {
                             for (_iterator.s(); !(_step = _iterator.n()).done;) {
                               var value = _step.value;
-                              statCollector.logger.debug(LOG_PREFIX, filter + ": " + value + " <>  " + report[filter]);
+                              statCollector.logger.debug(LOG_PREFIX + "-" + statCollector.id, filter + ": " + value + " <>  " + report[filter]);
                               if (report[filter] === value) {
                                 filterMatched = true;
                                 break;
@@ -12077,18 +12090,30 @@ var StreamStatsCollector = function StreamStatsCollector(description, id, mediaC
                         }
                       }
                       if (filtersMatched) {
-                        statCollector.addHeaders(report, metricsString);
+                        currentHeaders = statCollector.addHeaders(currentHeaders, report, metricsString);
                       }
                     } else {
-                      statCollector.addHeaders(report, metricsString);
+                      currentHeaders = statCollector.addHeaders(currentHeaders, report, metricsString);
                     }
                   });
                 } else {
-                  statCollector.logger.warn(LOG_PREFIX, "No report type found in RTC stats: '" + type + "'");
+                  statCollector.logger.debug(LOG_PREFIX + "-" + statCollector.id, "No report type found in RTC stats: '" + type + "'");
                 }
               });
-            case 2:
-              return _context3.a(2);
+              if (currentHeaders !== statCollector.headers) {
+                headersChanged = true;
+                newMetrics = [];
+                currentHeaders.split(",").forEach(function (header) {
+                  if (statCollector.headers.indexOf(header) === -1) {
+                    newMetrics.push(header);
+                  }
+                });
+                if (newMetrics.length) {
+                  statCollector.logger.info(LOG_PREFIX + "-" + statCollector.id, "RTC metrics to be collected: " + newMetrics.toString());
+                }
+                statCollector.headers = currentHeaders;
+              }
+              return _context3.a(2, headersChanged);
           }
         }, _callee3);
       }));
@@ -12097,24 +12122,20 @@ var StreamStatsCollector = function StreamStatsCollector(description, id, mediaC
       }
       return updateHeaders;
     }(),
-    addHeaders: function addHeaders(report, metricsString) {
+    addHeaders: function addHeaders(currentHeaders, report, metricsString) {
       if (metricsString) {
         var metrics = metricsString.split(",");
         metrics.forEach(function (metric) {
-          var metricFound = false;
           for (var _i = 0, _Object$keys = Object.keys(report); _i < _Object$keys.length; _i++) {
             var key = _Object$keys[_i];
             if (metric === key) {
-              statCollector.headers = util.addFieldToCsvString(statCollector.headers, report.type + "." + report.id + "." + metric, ",");
-              metricFound = true;
+              currentHeaders = util.addFieldToCsvString(currentHeaders, report.type + "." + report.id + "." + metric, ",");
               break;
             }
           }
-          if (!metricFound) {
-            statCollector.logger.warn(LOG_PREFIX, "No metric found in RTC stats report '" + report.type + "': '" + metric + "'");
-          }
         });
       }
+      return currentHeaders;
     },
     updateCompression: function () {
       var _updateCompression = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee4() {
@@ -12167,7 +12188,7 @@ var StreamStatsCollector = function StreamStatsCollector(description, id, mediaC
             case 2:
               _context5.p = 2;
               _t2 = _context5.v;
-              statCollector.logger.warn(LOG_PREFIX, "Can't compress metrics data using " + compression + ": " + _t2);
+              statCollector.logger.warn(LOG_PREFIX + "-" + statCollector.id, "Can't compress metrics data using " + compression + ": " + _t2);
               statCollector.compression = "none";
             case 3:
               return _context5.a(2);
@@ -12188,7 +12209,7 @@ var StreamStatsCollector = function StreamStatsCollector(description, id, mediaC
       statCollector.send("webRTCMetricsClientDescription", data);
     },
     send: function send(message, data) {
-      statCollector.logger.debug(LOG_PREFIX, data);
+      statCollector.logger.debug(LOG_PREFIX + "-" + statCollector.id, data);
       if (statCollector.wsConnection.readyState === WebSocket.OPEN) {
         statCollector.wsConnection.send(JSON.stringify({
           message: message,
@@ -12211,22 +12232,24 @@ var StreamStatsCollector = function StreamStatsCollector(description, id, mediaC
     },
     collectMetrics: function () {
       var _collectMetrics = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee6() {
-        var stats, metrics;
+        var stats, metrics, lostMetrics, headersUpdated;
         return _regenerator().w(function (_context6) {
           while (1) switch (_context6.n) {
             case 0:
-              if (!statCollector.timer) {
-                _context6.n = 2;
+              if (!(statCollector.timer && !statCollector.timerBusy)) {
+                _context6.n = 6;
                 break;
               }
+              // Unfortunately there are no real atomics in JS unless SharedArrayBuffer is used
+              // So we guard the timer callback with a dumb boolean
+              statCollector.timerBusy = true;
               _context6.n = 1;
               return statCollector.mediaConnection.getWebRTCStats();
             case 1:
               stats = _context6.v;
-              if (!statCollector.metricsBatch) {
-                statCollector.metricsBatch = [];
-              }
+              statCollector.startNewBatch();
               metrics = [];
+              lostMetrics = [];
               statCollector.headers.split(",").forEach(function (header) {
                 var components = header.split(".");
                 var descriptor = {
@@ -12234,7 +12257,7 @@ var StreamStatsCollector = function StreamStatsCollector(description, id, mediaC
                   id: components[1],
                   name: components[2]
                 };
-                var value = "undefined";
+                var value = null;
                 if (stats[descriptor.type]) {
                   var _iterator2 = _createForOfIteratorHelper(stats[descriptor.type]),
                     _step2;
@@ -12252,17 +12275,46 @@ var StreamStatsCollector = function StreamStatsCollector(description, id, mediaC
                     _iterator2.f();
                   }
                 }
-                metrics.push(value);
+                if (value === null) {
+                  lostMetrics.push(descriptor);
+                } else {
+                  metrics.push(value);
+                }
               });
+              // Metrics list may change if some metrics are added or some metrics are lost #WCS-4627
+              _context6.n = 2;
+              return statCollector.updateHeaders(stats);
+            case 2:
+              headersUpdated = _context6.v;
+              if (!lostMetrics.length) {
+                _context6.n = 4;
+                break;
+              }
+              statCollector.logger.info(LOG_PREFIX + "-" + statCollector.id, "Missing metrics: " + JSON.stringify(lostMetrics));
+              // Send metrics already collected and start a new batch with current metrics array to send them later #WCS-4627
+              _context6.n = 3;
+              return statCollector.sendMetrics();
+            case 3:
+              statCollector.startNewBatch(metrics);
+              _context6.n = 5;
+              break;
+            case 4:
               statCollector.metricsBatch.push(metrics);
               statCollector.batchCount--;
-              if (!(statCollector.batchCount === 0)) {
-                _context6.n = 2;
+              if (!(statCollector.batchCount === 0 || headersUpdated)) {
+                _context6.n = 5;
                 break;
               }
-              _context6.n = 2;
+              _context6.n = 5;
               return statCollector.sendMetrics();
-            case 2:
+            case 5:
+              // Check if metrics list changed and send a new headers if needed #WCS-4619
+              if (headersUpdated) {
+                statCollector.logger.info(LOG_PREFIX + "-" + statCollector.id, "RTC metrics list has changed, sending a new metrics description");
+                statCollector.sendHeaders();
+              }
+              statCollector.timerBusy = false;
+            case 6:
               return _context6.a(2);
           }
         }, _callee6);
@@ -12279,7 +12331,7 @@ var StreamStatsCollector = function StreamStatsCollector(description, id, mediaC
           while (1) switch (_context7.p = _context7.n) {
             case 0:
               metricsToSend = [];
-              for (i = 0; i < statCollector.metricsBatch.length; i++) {
+              for (i = 0; statCollector.metricsBatch && i < statCollector.metricsBatch.length; i++) {
                 metricsString = "";
                 for (j = 0; j < statCollector.metricsBatch[i].length; j++) {
                   valueString = valueToString(statCollector.metricsBatch[i][j]);
@@ -12313,7 +12365,7 @@ var StreamStatsCollector = function StreamStatsCollector(description, id, mediaC
             case 3:
               _context7.p = 3;
               _t3 = _context7.v;
-              statCollector.logger.warn(LOG_PREFIX, "Can't send metrics data using" + statCollector.compression + ": " + _t3);
+              statCollector.logger.warn(LOG_PREFIX + "-" + statCollector.id, "Can't send metrics data using" + statCollector.compression + ": " + _t3);
               metricsData = null;
             case 4:
               _context7.n = 6;
@@ -12328,8 +12380,7 @@ var StreamStatsCollector = function StreamStatsCollector(description, id, mediaC
                 };
                 statCollector.send("webRTCMetricsBatch", data);
               }
-              statCollector.metricsBatch = null;
-              statCollector.batchCount = statCollector.description.batchSize;
+              statCollector.cleanBatch();
             case 7:
               return _context7.a(2);
           }
@@ -12339,7 +12390,21 @@ var StreamStatsCollector = function StreamStatsCollector(description, id, mediaC
         return _sendMetrics.apply(this, arguments);
       }
       return sendMetrics;
-    }()
+    }(),
+    startNewBatch: function startNewBatch(metrics) {
+      if (!statCollector.metricsBatch) {
+        statCollector.metricsBatch = [];
+        if (metrics) {
+          statCollector.metricsBatch.push(metrics);
+        }
+      }
+    },
+    cleanBatch: function cleanBatch() {
+      if (statCollector.metricsBatch) {
+        statCollector.metricsBatch = null;
+        statCollector.batchCount = statCollector.description.batchSize;
+      }
+    }
   };
   return statCollector;
 };