feat(stats): Add a new bridge message "EndpointStats" for stats.

Use the new Colibri message "EndpointStats" for broadcasting the local stats. The bridge then will be able to filter the endpoint stats and send them only to the interested parties instead of broadcasting it to all the endpoints in the call.

JitsiConference.js

@@ -2598,6 +2598,15 @@ JitsiConference.prototype.sendEndpointMessage = function(to, payload) {
     this.rtc.sendChannelMessage(to, payload);
 };
 
+/**
+ * Sends local stats via the bridge channel which then forwards to other endpoints selectively.
+ * @param {Object} payload The payload of the message.
+ * @throws NetworkError/InvalidStateError/Error if the operation fails or if there is no data channel created.
+ */
+JitsiConference.prototype.sendEndpointStatsMessage = function(payload) {
+    this.rtc.sendEndpointStatsMessage(payload);
+};
+
 /**
  * Sends a broadcast message via the data channel.
  * @param payload {object} the payload of the message.

JitsiConferenceEventManager.js

@@ -556,6 +556,17 @@ JitsiConferenceEventManager.prototype.setupRTCListeners = function() {
             }
         });
 
+    rtc.addListener(RTCEvents.ENDPOINT_STATS_RECEIVED,
+        (from, payload) => {
+            const participant = conference.getParticipantById(from);
+
+            if (participant) {
+                conference.eventEmitter.emit(JitsiConferenceEvents.ENDPOINT_STATS_RECEIVED, participant, payload);
+            } else {
+                logger.warn(`Ignoring ENDPOINT_STATS_RECEIVED for a non-existant participant: ${from}`);
+            }
+        });
+
     rtc.addListener(RTCEvents.LOCAL_UFRAG_CHANGED,
         (tpc, ufrag) => {
             if (!tpc.isP2P) {

JitsiConferenceEvents.js

@@ -97,6 +97,11 @@ export const DTMF_SUPPORT_CHANGED = 'conference.dtmfSupportChanged';
  */
 export const ENDPOINT_MESSAGE_RECEIVED = 'conference.endpoint_message_received';
 
+/**
+ * Indicates that a message for the remote endpoint statistics has been received on the bridge channel.
+ */
+export const ENDPOINT_STATS_RECEIVED = 'conference.endpoint_stats_received';
+
 /**
  * NOTE This is lib-jitsi-meet internal event and can be removed at any time !
  *

modules/RTC/BridgeChannel.js

@@ -174,6 +174,19 @@ export default class BridgeChannel {
             || this._channel.readyState === WebSocket.OPEN);
     }
 
+    /**
+     * Sends local stats via the bridge channel.
+     * @param {Object} payload The payload of the message.
+     * @throws NetworkError/InvalidStateError/Error if the operation fails or if there is no data channel created.
+     */
+    sendEndpointStatsMessage(payload) {
+        logger.debug(`Sending endpoint stats ${JSON.stringify(payload)}`);
+        this._send({
+            colibriClass: 'EndpointStats',
+            ...payload
+        });
+    }
+
     /**
      * Sends message via the channel.
      * @param {string} to The id of the endpoint that should receive the
@@ -310,6 +323,11 @@ export default class BridgeChannel {
 
                 break;
             }
+            case 'EndpointStats': {
+                emitter.emit(RTCEvents.ENDPOINT_STATS_RECEIVED, obj.from, obj);
+
+                break;
+            }
             case 'LastNEndpointsChangeEvent': {
                 // The new/latest list of last-n endpoint IDs (i.e. endpoints for which the bridge is sending video).
                 const lastNEndpoints = obj.lastNEndpoints;

modules/RTC/RTC.js

@@ -845,8 +845,6 @@ export default class RTC extends Listenable {
         track.setAudioLevel(audioLevel, tpc);
     }
 
-    /* eslint-enable max-params */
-
     /**
      * Sends message via the bridge channel.
      * @param {string} to The id of the endpoint that should receive the
@@ -863,6 +861,17 @@ export default class RTC extends Listenable {
         }
     }
 
+    /**
+     * Sends the local stats via the bridge channel.
+     * @param {Object} payload The payload of the message.
+     * @throws NetworkError/InvalidStateError/Error if the operation fails or if there is no data channel created.
+     */
+    sendEndpointStatsMessage(payload) {
+        if (this._channel && this._channel.isOpen()) {
+            this._channel.sendEndpointStatsMessage(payload);
+        }
+    }
+
     /**
      * Selects a new value for "lastN". The requested amount of videos are going
      * to be delivered after the value is in effect. Set to -1 for unlimited or

modules/connectivity/ConnectionQuality.js

@@ -239,6 +239,8 @@ export default class ConnectionQuality {
 
         // Listen to DataChannel message from other participants in the
         // conference, and update the _remoteStats field accordingly.
+        // TODO - Delete this when all the mobile endpoints switch to using the new Colibri
+        // message format for sending the endpoint stats.
         conference.on(
             ConferenceEvents.ENDPOINT_MESSAGE_RECEIVED,
             (participant, payload) => {
@@ -248,6 +250,12 @@ export default class ConnectionQuality {
                 }
             });
 
+        conference.on(
+            ConferenceEvents.ENDPOINT_STATS_RECEIVED,
+            (participant, payload) => {
+                this._updateRemoteStats(participant.getId(), payload);
+            });
+
         // Listen to local statistics events originating from the RTC module
         // and update the _localStats field.
         // Oh, and by the way, the resolutions of all remote participants are
@@ -465,19 +473,10 @@ export default class ConnectionQuality {
         };
 
         try {
-            this._conference.broadcastEndpointMessage({
-                type: STATS_MESSAGE_TYPE,
-                values: data });
-        } catch (e) {
-            // We often hit this in the beginning of a call, before the data
-            // channel is ready. It is not a big problem, because we will
-            // send the statistics again after a few seconds, and the error is
-            // already logged elsewhere. So just ignore it.
-
-            // let errorMsg = "Failed to broadcast local stats";
-            // logger.error(errorMsg, e);
-            // GlobalOnErrorHandler.callErrorHandler(
-            //    new Error(errorMsg + ": " + e));
+            this._conference.sendEndpointStatsMessage(data);
+        } catch (err) {
+            // Ignore the error as we might hit it in the beginning of the call before the channel is ready.
+            // The statistics will be sent again after few seconds and error is logged elseware as well.
         }
     }
 

service/RTC/RTCEvents.js

@@ -88,6 +88,11 @@ const RTCEvents = {
      */
     ENDPOINT_MESSAGE_RECEIVED: 'rtc.endpoint_message_received',
 
+    /**
+     * Indicates that the remote endpoint stats have been received on data channnel.
+     */
+    ENDPOINT_STATS_RECEIVED: 'rtc.endpoint_stats_received',
+
     /**
      * Designates an event indicating that the local ICE username fragment of
      * the jingle session has changed.