Uses optional statsId to report to callstats and push it to presence. (#608)

* Uses optional statsId to report to callstats and push it to presence.

The feature is behind a flag which is disabled by default.

* Renames statsId to statsID.

* Fixes doc.

JitsiConference.js

@@ -254,8 +254,14 @@ JitsiConference.prototype._init = function(options = {}) {
         // bellow).
         const windowLocation = window.location;
 
+        let callStatsAliasName = this.myUserId();
+
+        if (config.enableDisplayNameInStats && config.displayName) {
+            callStatsAliasName = config.displayName;
+        }
+
         this.statistics = new Statistics(this.xmpp, {
-            callStatsAliasName: this.myUserId(),
+            callStatsAliasName,
             callStatsConfIDNamespace:
                 config.callStatsConfIDNamespace
                     || (windowLocation && windowLocation.hostname)
@@ -263,7 +269,8 @@ JitsiConference.prototype._init = function(options = {}) {
             callStatsCustomScriptUrl: config.callStatsCustomScriptUrl,
             callStatsID: config.callStatsID,
             callStatsSecret: config.callStatsSecret,
-            roomName: this.options.name
+            roomName: this.options.name,
+            swapUserNameAndAlias: config.enableStatsID
         });
     }
 
@@ -1138,14 +1145,17 @@ JitsiConference.prototype.muteParticipant = function(id) {
  * @param role the role of the participant in the MUC
  * @param isHidden indicates if this is a hidden participant (system
  * participant for example a recorder).
+ * @param statsID the participant statsID (optional)
  */
-JitsiConference.prototype.onMemberJoined = function(jid, nick, role, isHidden) {
+JitsiConference.prototype.onMemberJoined = function(
+        jid, nick, role, isHidden, statsID) {
     const id = Strophe.getResourceFromJid(jid);
 
     if (id === 'focus' || this.myUserId() === id) {
         return;
     }
-    const participant = new JitsiParticipant(jid, this, nick, isHidden);
+    const participant
+        = new JitsiParticipant(jid, this, nick, isHidden, statsID);
 
     participant._role = role;
     this.participants[id] = participant;
@@ -2107,9 +2117,20 @@ JitsiConference.prototype._acceptP2PIncomingCall = function(
         false /* initiator */, this.room, this.rtc);
 
     logger.info('Starting CallStats for P2P connection...');
+
+    let remoteID = Strophe.getResourceFromJid(this.p2pJingleSession.peerjid);
+
+    if (this.options.config.enableStatsID) {
+        const participant = this.participants[remoteID];
+
+        if (participant) {
+            remoteID = participant.getStatsID() || remoteID;
+        }
+    }
+
     this.statistics.startCallStats(
         this.p2pJingleSession.peerconnection,
-        Strophe.getResourceFromJid(this.p2pJingleSession.peerjid));
+        remoteID);
 
     const localTracks = this.getLocalTracks();
 
@@ -2392,9 +2413,20 @@ JitsiConference.prototype._startP2PSession = function(peerJid) {
     this.p2pJingleSession.initialize(true /* initiator */, this.room, this.rtc);
 
     logger.info('Starting CallStats for P2P connection...');
+
+    let remoteID = Strophe.getResourceFromJid(this.p2pJingleSession.peerjid);
+
+    if (this.options.config.enableStatsID) {
+        const participant = this.participants[remoteID];
+
+        if (participant) {
+            remoteID = participant.getStatsID() || remoteID;
+        }
+    }
+
     this.statistics.startCallStats(
         this.p2pJingleSession.peerconnection,
-        Strophe.getResourceFromJid(this.p2pJingleSession.peerjid));
+        remoteID);
 
     // NOTE one may consider to start P2P with the local tracks detached,
     // but no data will be sent until ICE succeeds anyway. And we switch

JitsiParticipant.js

@@ -20,8 +20,9 @@ export default class JitsiParticipant {
      * @param displayName
      * @param {Boolean} hidden - True if the new JitsiParticipant instance is to
      * represent a hidden participant; otherwise, false.
+     * @param {string} statsID - optional participant statsID
      */
-    constructor(jid, conference, displayName, hidden) {
+    constructor(jid, conference, displayName, hidden, statsID) {
         this._jid = jid;
         this._id = Strophe.getResourceFromJid(jid);
         this._conference = conference;
@@ -35,6 +36,7 @@ export default class JitsiParticipant {
             video: undefined
         };
         this._hidden = hidden;
+        this._statsID = statsID;
         this._connectionStatus = ParticipantConnectionStatus.ACTIVE;
         this._properties = {};
     }
@@ -151,6 +153,13 @@ export default class JitsiParticipant {
         return this._displayName;
     }
 
+    /**
+     * @returns {String} The stats ID of this participant.
+     */
+    getStatsID() {
+        return this._statsID;
+    }
+
     /**
      * @returns {String} The status of the participant.
      */

doc/API.md

@@ -224,7 +224,10 @@ This objects represents the server connection. You can create new ```JitsiConnec
         4. callStatsID - callstats credentials
         5. callStatsSecret - callstats credentials
         6. enableTalkWhileMuted - boolean property. Enables/disables talk while muted detection, by default the value is false/disabled.
-        7. ignoreStartMuted - ignores start muted events coming from jicofo. 
+        7. ignoreStartMuted - ignores start muted events coming from jicofo.
+        8. enableStatsID - enables sending callStatsUsername as stats-id in presence, jicofo and videobridge will use it as endpointID to report stats
+        9. enableDisplayNameInStats - enables sending the users display name, if set, to callstats as alias of the endpointID stats 
+
         **NOTE: if 4 and 5 are set the library is going to send events to callstats. Otherwise the callstats integration will be disabled.**
 
 5. addEventListener(event, listener) - Subscribes the passed listener to the event.

modules/statistics/statistics.js

@@ -318,8 +318,10 @@ Statistics.prototype.startCallStats = function(tpc, remoteUserID) {
         if (!CallStats.initBackend({
             callStatsID: this.options.callStatsID,
             callStatsSecret: this.options.callStatsSecret,
-            userName,
-            aliasName: this.options.callStatsAliasName
+            userName: this.options.swapUserNameAndAlias
+                ? this.options.callStatsAliasName : userName,
+            aliasName: this.options.swapUserNameAndAlias
+                ? userName : this.options.callStatsAliasName
         })) {
 
             // Backend initialization failed bad

modules/xmpp/ChatRoom.js

@@ -7,6 +7,7 @@ import Listenable from '../util/Listenable';
 import * as MediaType from '../../service/RTC/MediaType';
 import Moderator from './moderator';
 import Recorder from './recording';
+import Settings from '../settings/Settings';
 import XMPPEvents from '../../service/xmpp/XMPPEvents';
 
 const logger = getLogger(__filename);
@@ -195,6 +196,13 @@ export default class ChatRoom extends Listenable {
             'attributes': { xmlns: 'http://jitsi.org/jitmeet/user-agent' }
         });
 
+        if (options.enableStatsID) {
+            this.presMap.nodes.push({
+                'tagName': 'stats-id',
+                'value': Settings.callStatsUserName
+            });
+        }
+
         // We need to broadcast 'videomuted' status from the beginning, cause
         // Jicofo makes decisions based on that. Initialize it with 'false'
         // here.
@@ -441,6 +449,9 @@ export default class ChatRoom extends Listenable {
             case 'userId':
                 member.id = node.value;
                 break;
+            case 'stats-id':
+                member.statsID = node.value;
+                break;
             }
         }
 
@@ -477,7 +488,11 @@ export default class ChatRoom extends Listenable {
             } else {
                 this.eventEmitter.emit(
                     XMPPEvents.MUC_MEMBER_JOINED,
-                    from, member.nick, member.role, member.isHiddenDomain);
+                    from,
+                    member.nick,
+                    member.role,
+                    member.isHiddenDomain,
+                    member.statsID);
             }
 
             hasStatusUpdate = member.status !== undefined;