Exports additional statistics through ConnectionQuality (#813)

* feat: Read the server region from Jingle and broadcast it with statistics.

* feat: Adds the bridge count to local "statistics", refactors conference-properties.

* fix: Emits the conference properties with the event, small fixes.

* ref: Orders the imports alphabetically.

As described by @virtuacoplenny:
[T]he ordering is based on import path, not import name, with different
file depths being grouped together, node modules being grouped together
at the top.

* fix: Keeps JitsiConference#properties always defined.

* fix: Does not fire an event when the argument is undefined.

JitsiConference.js

@@ -1,54 +1,55 @@
 /* global __filename, $, Promise */
 import { Strophe } from 'strophe.js';
 
-import {
-    ACTION_JINGLE_RESTART,
-    ACTION_JINGLE_SI_RECEIVED,
-    ACTION_JINGLE_SI_TIMEOUT,
-    ACTION_JINGLE_TERMINATE,
-    ACTION_P2P_ESTABLISHED,
-    ACTION_P2P_FAILED,
-    ACTION_P2P_SWITCH_TO_JVB,
-    ICE_ESTABLISHMENT_DURATION_DIFF,
-    createJingleEvent,
-    createP2PEvent
-} from './service/statistics/AnalyticsEvents';
-import AvgRTPStatsReporter from './modules/statistics/AvgRTPStatsReporter';
-import ComponentsVersions from './modules/version/ComponentsVersions';
-import ConnectionQuality from './modules/connectivity/ConnectionQuality';
-import E2ePing from './modules/e2eping/e2eping';
-import { getLogger } from 'jitsi-meet-logger';
-import GlobalOnErrorHandler from './modules/util/GlobalOnErrorHandler';
 import EventEmitter from 'events';
-import authenticateAndUpgradeRole from './authenticateAndUpgradeRole';
+import { getLogger } from 'jitsi-meet-logger';
+import isEqual from 'lodash.isequal';
+
 import * as JitsiConferenceErrors from './JitsiConferenceErrors';
 import JitsiConferenceEventManager from './JitsiConferenceEventManager';
 import * as JitsiConferenceEvents from './JitsiConferenceEvents';
-import JitsiDTMFManager from './modules/DTMF/JitsiDTMFManager';
 import JitsiParticipant from './JitsiParticipant';
 import JitsiTrackError from './JitsiTrackError';
 import * as JitsiTrackErrors from './JitsiTrackErrors';
 import * as JitsiTrackEvents from './JitsiTrackEvents';
-import Jvb121EventGenerator from './modules/event/Jvb121EventGenerator';
-import * as MediaType from './service/RTC/MediaType';
-import ParticipantConnectionStatusHandler
-    from './modules/connectivity/ParticipantConnectionStatus';
+import authenticateAndUpgradeRole from './authenticateAndUpgradeRole';
+import JitsiDTMFManager from './modules/DTMF/JitsiDTMFManager';
 import P2PDominantSpeakerDetection from './modules/P2PDominantSpeakerDetection';
 import RTC from './modules/RTC/RTC';
+import TalkMutedDetection from './modules/TalkMutedDetection';
 import browser from './modules/browser';
-import * as RTCEvents from './service/RTC/RTCEvents';
+import ConnectionQuality from './modules/connectivity/ConnectionQuality';
+import ParticipantConnectionStatusHandler
+    from './modules/connectivity/ParticipantConnectionStatus';
+import E2ePing from './modules/e2eping/e2eping';
+import Jvb121EventGenerator from './modules/event/Jvb121EventGenerator';
+import RecordingManager from './modules/recording/RecordingManager';
+import RttMonitor from './modules/rttmonitor/rttmonitor';
+import AvgRTPStatsReporter from './modules/statistics/AvgRTPStatsReporter';
+import SpeakerStatsCollector from './modules/statistics/SpeakerStatsCollector';
 import Statistics from './modules/statistics/statistics';
-import TalkMutedDetection from './modules/TalkMutedDetection';
 import Transcriber from './modules/transcription/transcriber';
-import VideoType from './service/RTC/VideoType';
-import RecordingManager from './modules/recording/RecordingManager';
+import GlobalOnErrorHandler from './modules/util/GlobalOnErrorHandler';
+import ComponentsVersions from './modules/version/ComponentsVersions';
 import VideoSIPGW from './modules/videosipgw/VideoSIPGW';
 import * as VideoSIPGWConstants from './modules/videosipgw/VideoSIPGWConstants';
-import * as XMPPEvents from './service/xmpp/XMPPEvents';
 import { JITSI_MEET_MUC_TYPE } from './modules/xmpp/ChatRoom';
-import RttMonitor from './modules/rttmonitor/rttmonitor';
-
-import SpeakerStatsCollector from './modules/statistics/SpeakerStatsCollector';
+import * as MediaType from './service/RTC/MediaType';
+import * as RTCEvents from './service/RTC/RTCEvents';
+import VideoType from './service/RTC/VideoType';
+import {
+    ACTION_JINGLE_RESTART,
+    ACTION_JINGLE_SI_RECEIVED,
+    ACTION_JINGLE_SI_TIMEOUT,
+    ACTION_JINGLE_TERMINATE,
+    ACTION_P2P_ESTABLISHED,
+    ACTION_P2P_FAILED,
+    ACTION_P2P_SWITCH_TO_JVB,
+    ICE_ESTABLISHMENT_DURATION_DIFF,
+    createJingleEvent,
+    createP2PEvent
+} from './service/statistics/AnalyticsEvents';
+import * as XMPPEvents from './service/xmpp/XMPPEvents';
 
 const logger = getLogger(__filename);
 
@@ -142,6 +143,9 @@ export default function JitsiConference(options) {
     // the restart.
     this.wasStopped = false;
 
+    // Conference properties, maintained by jicofo.
+    this.properties = {};
+
     /**
      * The object which monitors local and remote connection statistics (e.g.
      * sending bitrate) and calculates a number which represents the connection
@@ -254,6 +258,10 @@ JitsiConference.prototype._init = function(options = {}) {
 
     this.room.updateDeviceAvailability(RTC.getDeviceAvailability());
 
+    this._updateProperties = this._updateProperties.bind(this);
+    this.room.addListener(XMPPEvents.CONFERENCE_PROPERTIES_CHANGED,
+        this._updateProperties);
+
     this.rttMonitor = new RttMonitor(config.rttMonitor || {});
 
     this.e2eping = new E2ePing(
@@ -457,6 +465,10 @@ JitsiConference.prototype.leave = function() {
             XMPPEvents.CONNECTION_ESTABLISHED,
             this._onIceConnectionEstablished);
 
+        room.removeListener(
+            XMPPEvents.CONFERENCE_PROPERTIES_CHANGED,
+            this._updateProperties);
+
         this.room = null;
 
         return room.leave().catch(error => {
@@ -1623,6 +1635,15 @@ JitsiConference.prototype._acceptJvbIncomingCall = function(
             createJingleEvent(ACTION_JINGLE_RESTART, { p2p: false }));
     }
 
+    const serverRegion
+        = $(jingleOffer)
+            .find('>server-region[xmlns="http://jitsi.org/protocol/focus"]')
+            .attr('region');
+
+    this.eventEmitter.emit(
+        JitsiConferenceEvents.SERVER_REGION_CHANGED,
+        serverRegion);
+
     this._maybeClearSITimeout();
     Statistics.sendAnalytics(createJingleEvent(
         ACTION_JINGLE_SI_RECEIVED,
@@ -2530,6 +2551,56 @@ JitsiConference.prototype._onIceConnectionEstablished = function(
 
 };
 
+/**
+ * Called when the chat room reads a new list of properties from jicofo's
+ * presence. The properties may have changed, but they don't have to.
+ *
+ * @param {Object} properties - The properties keyed by the property name
+ * ('key').
+ * @private
+ */
+JitsiConference.prototype._updateProperties = function(properties = {}) {
+    const changed = isEqual(properties, this.properties);
+
+    this.properties = properties;
+    if (changed) {
+        this.eventEmitter.emit(
+            JitsiConferenceEvents.PROPERTIES_CHANGED,
+            this.properties);
+
+        // Some of the properties need to be added to analytics events.
+        const analyticsKeys = [
+
+            // The number of jitsi-videobridge instances currently used for the
+            // conference.
+            'bridge-count',
+
+            // The conference creation time (set by jicofo).
+            'created-ms',
+            'octo-enabled'
+        ];
+
+        analyticsKeys.forEach(key => {
+            if (this.properties[key]
+                && this.properties[key].value !== undefined) {
+                Statistics.analytics.addPermanentProperties({
+                    [key.replace('-', '_')]: properties[key].value
+                });
+            }
+        });
+    }
+};
+
+/**
+ * Gets a conference property with a given key.
+ *
+ * @param {string} key - The key.
+ * @returns {*} The value
+ */
+JitsiConference.prototype.getProperty = function(key) {
+    return this.properties[key];
+};
+
 /**
  * Clears the deferred start P2P task if it has been scheduled.
  * @private

JitsiConferenceEvents.js

@@ -127,6 +127,13 @@ export const LAST_N_ENDPOINTS_CHANGED = 'conference.lastNEndpointsChanged';
  */
 export const LOCK_STATE_CHANGED = 'conference.lock_state_changed';
 
+/**
+ * Indicates that the region of the media server (jitsi-videobridge) that we
+ * are connected to changed (or was initially set).
+ * @type {string} the region.
+ */
+export const SERVER_REGION_CHANGED = 'conference.server_region_changed';
+
 /**
  * New text message was received.
  */
@@ -179,6 +186,12 @@ export const P2P_STATUS = 'conference.p2pStatus';
  */
 export const PHONE_NUMBER_CHANGED = 'conference.phoneNumberChanged';
 
+/**
+ * The conference properties changed.
+ * @type {string}
+ */
+export const PROPERTIES_CHANGED = 'conference.propertiesChanged';
+
 /**
  * Indicates that recording state changed.
  */

modules/connectivity/ConnectionQuality.js

@@ -278,6 +278,20 @@ export default class ConnectionQuality {
                     this._maybeUpdateUnmuteTime();
                 }
             });
+
+        conference.on(
+            ConferenceEvents.SERVER_REGION_CHANGED,
+            serverRegion => {
+                this._localStats.serverRegion = serverRegion;
+            });
+
+        conference.on(
+            ConferenceEvents.PROPERTIES_CHANGED,
+            properties => {
+                this._localStats.bridgeCount
+                    = Number((properties || {})['bridge-count']);
+            }
+        );
     }
 
     /**
@@ -438,7 +452,8 @@ export default class ConnectionQuality {
             bitrate: this._localStats.bitrate,
             packetLoss: this._localStats.packetLoss,
             connectionQuality: this._localStats.connectionQuality,
-            jvbRTT: this._localStats.jvbRTT
+            jvbRTT: this._localStats.jvbRTT,
+            serverRegion: this._localStats.serverRegion
         };
 
         try {
@@ -527,7 +542,8 @@ export default class ConnectionQuality {
             bitrate: data.bitrate,
             packetLoss: data.packetLoss,
             connectionQuality: data.connectionQuality,
-            jvbRTT: data.jvbRTT
+            jvbRTT: data.jvbRTT,
+            serverRegion: data.serverRegion
         };
 
         this.eventEmitter.emit(

modules/xmpp/ChatRoom.js

@@ -11,7 +11,6 @@ import * as MediaType from '../../service/RTC/MediaType';
 import XMPPEvents from '../../service/xmpp/XMPPEvents';
 
 import Moderator from './moderator';
-import Statistics from '../statistics/statistics';
 
 const logger = getLogger(__filename);
 
@@ -625,32 +624,18 @@ export default class ChatRoom extends Listenable {
                 break;
             case 'conference-properties':
                 if (member.isFocus) {
+                    const properties = {};
+
                     for (let j = 0; j < node.children.length; j++) {
                         const { attributes } = node.children[j];
 
-                        if (!attributes) {
-                            break;
+                        if (attributes && attributes.key) {
+                            properties[attributes.key] = attributes.value;
                         }
-
-                        const { key, value } = attributes;
-
-                        /* eslint-disable no-fallthrough */
-                        switch (key) {
-
-                        // The number of jitsi-videobridge instances currently
-                        // used for the conference.
-                        case 'bridge-count':
-
-                        // The conference creation time (set by jicofo).
-                        case 'created-ms':
-                        case 'octo-enabled':
-                            Statistics.analytics.addPermanentProperties({
-                                [key.replace('-', '_')]: value
-                            });
-                            break;
-                        }
-                        /* eslint-enable no-fallthrough */
                     }
+
+                    this.eventEmitter.emit(
+                        XMPPEvents.CONFERENCE_PROPERTIES_CHANGED, properties);
                 }
                 break;
             case 'transcription-status': {

package-lock.json

@@ -5538,6 +5538,11 @@
       "integrity": "sha1-gteb/zCmfEAF/9XiUVMArZyk168=",
       "dev": true
     },
+    "lodash.isequal": {
+      "version": "4.5.0",
+      "resolved": "https://registry.npmjs.org/lodash.isequal/-/lodash.isequal-4.5.0.tgz",
+      "integrity": "sha1-QVxEePK8wwEgwizhDtMib30+GOA="
+    },
     "log-symbols": {
       "version": "2.2.0",
       "resolved": "https://registry.npmjs.org/log-symbols/-/log-symbols-2.2.0.tgz",

package.json

@@ -22,6 +22,7 @@
     "current-executing-script": "0.1.3",
     "jitsi-meet-logger": "github:jitsi/jitsi-meet-logger#6fff754a77a56ab52499f3559105a15886942a1e",
     "js-utils": "github:jitsi/js-utils#d4b78721b754a15c2588b7b0c621a9fff6fa1363",
+    "lodash.isequal": "4.5.0",
     "react-native-callstats": "3.53.4",
     "sdp-transform": "2.3.0",
     "strophe.js": "1.2.15",

service/xmpp/XMPPEvents.js

@@ -25,6 +25,10 @@ const XMPPEvents = {
     // person in the conference room.
     CALL_ENDED: 'xmpp.callended.jingle',
     CHAT_ERROR_RECEIVED: 'xmpp.chat_error_received',
+
+    // The conference properties (as advertised by jicofo) have changed
+    CONFERENCE_PROPERTIES_CHANGED: 'xmpp.conference_properties_changed',
+
     CONFERENCE_SETUP_FAILED: 'xmpp.conference_setup_failed',
 
     /**