@flashphoner/websdk 2.0.262 → 2.0.264

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flashphoner/websdk",
-  "version": "2.0.262",
+  "version": "2.0.264",
   "description": "Official Flashphoner WebCallServer WebSDK package",
   "main": "./src/flashphoner-core.js",
   "types": "./src/flashphoner-core.d.ts",
@@ -20,7 +20,6 @@
     "chai": "^3.5.0",
     "grunt": "^1.0.1",
     "grunt-browserify": "^5.0.0",
-    "grunt-contrib": "^0.11.0",
     "grunt-contrib-clean": "^1.0.0",
     "grunt-contrib-concat": "^1.0.1",
     "grunt-contrib-copy": "^1.0.0",

package/src/stats-collector.js

@@ -16,6 +16,7 @@ const StreamStatsCollector = function(description, id, mediaConnection, wsConnec
         metricsBatch: null,
         timer: null,
         batchCount: 0,
+        timerBusy: false,
         start: async function() {
             let error = "Can't collect WebRTC stats to send: ";
             if (!statCollector.description.types) {
@@ -55,7 +56,7 @@ const StreamStatsCollector = function(description, id, mediaConnection, wsConnec
         update: async function(description) {
             if (!description) {
                 if (statCollector.logger) {
-                    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;
                 }
             }
@@ -91,8 +92,12 @@ const StreamStatsCollector = function(description, id, mediaConnection, wsConnec
                     break;
             }
         },
-        updateHeaders: async function() {
-            let stats = await statCollector.mediaConnection.getWebRTCStats();
+        updateHeaders: async function(stats = null) {
+            let currentHeaders = "";
+            let headersChanged = false;
+            if (!stats) {
+                stats = await statCollector.mediaConnection.getWebRTCStats();
+            }
             Object.keys(statCollector.description.types).forEach((type) => {
                 let typeDescriptor = statCollector.description.types[type];
                 let metricsString = "";
@@ -105,15 +110,15 @@ const StreamStatsCollector = function(description, id, mediaConnection, wsConnec
                 }
                 if (stats[type]) {
                     stats[type].forEach((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) {
                             let filtersMatched = true;
                             for (const 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]));
                                 let filterMatched = false;
                                 if (report[filter]) {
                                     for (const value of contentFilters[filter]) {
-                                        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;
@@ -126,34 +131,44 @@ const StreamStatsCollector = function(description, id, mediaConnection, wsConnec
                                 }
                             }
                             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 + "'");
                 }
             });
+            if (currentHeaders !== statCollector.headers) {
+                headersChanged = true;
+                let newMetrics = [];
+                currentHeaders.split(",").forEach((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 headersChanged;
         },
-        addHeaders: function(report, metricsString) {
+        addHeaders: function(currentHeaders, report, metricsString) {
             if (metricsString) {
                 let metrics = metricsString.split(",");
                 metrics.forEach((metric) => {
-                    let metricFound = false;
                     for (const key of Object.keys(report)) {
                         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: async function() {
             if (statCollector.description.compression) {
@@ -169,7 +184,7 @@ const StreamStatsCollector = function(description, id, mediaConnection, wsConnec
                 await util.compress(compression, "test", false);
                 statCollector.compression = compression;
             } catch (e) {
-                statCollector.logger.warn(LOG_PREFIX, "Can't compress metrics data using " + compression + ": " + e);
+                statCollector.logger.warn(LOG_PREFIX + "-" + statCollector.id, "Can't compress metrics data using " + compression + ": " + e);
                 statCollector.compression = "none";
             }
         },
@@ -182,7 +197,7 @@ const StreamStatsCollector = function(description, id, mediaConnection, wsConnec
             statCollector.send("webRTCMetricsClientDescription", data);
         },
         send: function(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,
@@ -204,14 +219,16 @@ const StreamStatsCollector = function(description, id, mediaConnection, wsConnec
             }
         },
         collectMetrics: async function() {
-            if (statCollector.timer) {
+            if (statCollector.timer && !statCollector.timerBusy) {
+                // 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;
                 let stats = await statCollector.mediaConnection.getWebRTCStats();
 
-                if (!statCollector.metricsBatch) {
-                    statCollector.metricsBatch = [];
-                }
+                statCollector.startNewBatch();
 
                 let metrics = [];
+                let lostMetrics = [];
                 statCollector.headers.split(",").forEach((header) => {
                     let components = header.split(".");
                     let descriptor = {
@@ -219,7 +236,7 @@ const StreamStatsCollector = function(description, id, mediaConnection, wsConnec
                         id: components[1],
                         name: components[2]
                     }
-                    let value = "undefined";
+                    let value = null;
 
                     if (stats[descriptor.type]) {
                         for (const report of stats[descriptor.type]) {
@@ -229,13 +246,32 @@ const StreamStatsCollector = function(description, id, mediaConnection, wsConnec
                             }
                         }
                     }
-                    metrics.push(value);
+                    if (value === null) {
+                        lostMetrics.push(descriptor);
+                    } else {
+                        metrics.push(value);
+                    }
                 });
-                statCollector.metricsBatch.push(metrics);
-                statCollector.batchCount--;
-                if (statCollector.batchCount === 0) {
+                // Metrics list may change if some metrics are added or some metrics are lost #WCS-4627
+                let headersUpdated = await statCollector.updateHeaders(stats);
+                if (lostMetrics.length) {
+                    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
                     await statCollector.sendMetrics();
+                    statCollector.startNewBatch(metrics);
+                } else {
+                    statCollector.metricsBatch.push(metrics);
+                    statCollector.batchCount--;
+                    if (statCollector.batchCount === 0 || headersUpdated) {
+                        await statCollector.sendMetrics();
+                    }
+                }
+                // 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;
             }
         },
         sendMetrics: async function() {
@@ -243,7 +279,7 @@ const StreamStatsCollector = function(description, id, mediaConnection, wsConnec
             let metricsToSend = [];
             let metricsData;
 
-            for (let i = 0; i < statCollector.metricsBatch.length; i++) {
+            for (let i = 0; statCollector.metricsBatch && i < statCollector.metricsBatch.length; i++) {
                 let metricsString = "";
                 for (let j = 0; j < statCollector.metricsBatch[i].length; j++) {
                     let valueString = valueToString(statCollector.metricsBatch[i][j]);
@@ -267,7 +303,7 @@ const StreamStatsCollector = function(description, id, mediaConnection, wsConnec
                 try {
                     metricsData = await util.compress(statCollector.compression, JSON.stringify(metricsToSend), true);
                 } catch(e) {
-                    statCollector.logger.warn(LOG_PREFIX, "Can't send metrics data using" + statCollector.compression + ": " + e);
+                    statCollector.logger.warn(LOG_PREFIX + "-" + statCollector.id, "Can't send metrics data using" + statCollector.compression + ": " + e);
                     metricsData = null;
                 }
             } else {
@@ -280,8 +316,21 @@ const StreamStatsCollector = function(description, id, mediaConnection, wsConnec
                 };
                 statCollector.send("webRTCMetricsBatch", data);
             }
-            statCollector.metricsBatch = null;
-            statCollector.batchCount = statCollector.description.batchSize;
+            statCollector.cleanBatch();
+        },
+        startNewBatch: function(metrics) {
+            if (!statCollector.metricsBatch) {
+                statCollector.metricsBatch = [];
+                if (metrics) {
+                    statCollector.metricsBatch.push(metrics);
+                }
+            }
+        },
+        cleanBatch: function() {
+            if (statCollector.metricsBatch) {
+                statCollector.metricsBatch = null;
+                statCollector.batchCount = statCollector.description.batchSize;
+            }
         }
     }
     return statCollector;