Adds confID to JitsiConference option and enables callstats siteID. (#934)

* Adds confID to JitsiConference option and enables callstats siteID.

* Simplifies siteID logic and use '/' as default when there is no tenant.

JitsiConference.js

@@ -295,14 +295,6 @@ JitsiConference.prototype._init = function(options = {}) {
     this.participantConnectionStatus.init();
 
     if (!this.statistics) {
-        // XXX The property location on the global variable window is not
-        // defined in all execution environments (e.g. react-native). While
-        // jitsi-meet may polyfill it when executing on react-native, it is
-        // better for the cross-platform support to not require window.location
-        // especially when there is a worthy alternative (as demonstrated
-        // bellow).
-        const windowLocation = window.location;
-
         let callStatsAliasName = this.myUserId();
 
         if (config.enableDisplayNameInStats && config.displayName) {
@@ -311,14 +303,10 @@ JitsiConference.prototype._init = function(options = {}) {
 
         this.statistics = new Statistics(this.xmpp, {
             callStatsAliasName,
-            callStatsConfIDNamespace:
-                config.callStatsConfIDNamespace
-                    || (windowLocation && windowLocation.hostname)
-                    || (config.hosts && config.hosts.domain),
+            confID: config.confID || `${config.hosts.domain}/${this.options.name}`,
             customScriptUrl: config.callStatsCustomScriptUrl,
             callStatsID: config.callStatsID,
             callStatsSecret: config.callStatsSecret,
-            roomName: this.options.name,
             swapUserNameAndAlias: config.enableStatsID,
             applicationName: config.applicationName,
             getWiFiStatsMethod: config.getWiFiStatsMethod

doc/API.md

@@ -50,7 +50,6 @@ The ```options``` parameter is JS object with the following properties:
     - `disableThirdPartyRequests` - if true - callstats will be disabled and the callstats API won't be included.
     - `enableAnalyticsLogging` - boolean property (default false). Enables/disables analytics logging.
     - `callStatsCustomScriptUrl` - (optional) custom url to access callstats client script
-    - `callStatsConfIDNamespace` - (optional) a namespace to prepend the callstats conference ID with. Defaults to the window.location.hostname
     - `disableRtx` - (optional) boolean property (default to false).  Enables/disable the use of RTX.
     - `disableH264` - (optional) boolean property (default to false).  If enabled, strips the H.264 codec from the local SDP.
     - `preferH264` - (optional) boolean property (default to false).  Enables/disable preferring the first instance of an h264 codec in an offer by moving it to the front of the codec list.
@@ -228,6 +227,7 @@ This objects represents the server connection. You can create new ```JitsiConnec
         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
         10. startSilent - enables silent mode, will mark audio as inactive will not send/receive audio
+        11. confID - Used for statistics to identify conference, if tenants are supported will contain tenant and the non lower case variant for the room name.
 
         **NOTE: if 4 and 5 are set the library is going to send events to callstats. Otherwise the callstats integration will be disabled.**
 

modules/statistics/CallStats.js

@@ -371,6 +371,14 @@ export default class CallStats {
                 };
             }
 
+            if (options.confID) {
+                // we first check is there a tenant in the confID
+                const match = options.confID.match(/.*\/(.*)\/.*/);
+
+                // if there is no tenant, we will just set '/'
+                configParams.siteID = (match && match[1]) || '/';
+            }
+
             // userID is generated or given by the origin server
             CallStats.backend.initialize(
                 CallStats.callStatsID,

modules/statistics/statistics.js

@@ -73,7 +73,8 @@ function _initCallStatsBackend(options) {
         aliasName: options.swapUserNameAndAlias
             ? userName : options.callStatsAliasName,
         applicationName: options.applicationName,
-        getWiFiStatsMethod: options.getWiFiStatsMethod
+        getWiFiStatsMethod: options.getWiFiStatsMethod,
+        confID: options.confID
     })) {
         logger.error('CallStats Backend initialization failed bad');
     }
@@ -129,13 +130,11 @@ Statistics.init = function(options) {
  * callstats.
  * @property {string} callStatsAliasName - The alias name to use when
  * initializing callstats.
- * @property {string} callStatsConfIDNamespace - A namespace to prepend the
- * callstats conference ID with.
+ * @property {string} confID - The callstats conference ID to use.
  * @property {string} callStatsID - Callstats credentials - the id.
  * @property {string} callStatsSecret - Callstats credentials - the secret.
  * @property {string} customScriptUrl - A custom lib url to use when downloading
  * callstats library.
- * @property {string} roomName - The room name we are currently in.
  * @property {boolean} swapUserNameAndAlias - Whether to swap the places of
  * username and alias when initiating callstats.
  */
@@ -170,8 +169,8 @@ export default function Statistics(xmpp, options) {
             loadCallStatsAPI(this.options);
         }
 
-        if (!this.options.callStatsConfIDNamespace) {
-            logger.warn('"callStatsConfIDNamespace" is not defined');
+        if (!this.options.confID) {
+            logger.warn('"confID" is not defined');
         }
     }
 
@@ -368,7 +367,7 @@ Statistics.prototype.startCallStats = function(tpc, remoteUserID) {
         = new CallStats(
             tpc,
             {
-                confID: this._getCallStatsConfID(),
+                confID: this.options.confID,
                 remoteUserID
             });
 
@@ -393,19 +392,6 @@ Statistics._getAllCallStatsInstances = function() {
     return csInstances;
 };
 
-/**
- * Constructs the CallStats conference ID based on the options currently
- * configured in this instance.
- * @return {string}
- * @private
- */
-Statistics.prototype._getCallStatsConfID = function() {
-    // The conference ID is case sensitive!!!
-    return this.options.callStatsConfIDNamespace
-        ? `${this.options.callStatsConfIDNamespace}/${this.options.roomName}`
-        : this.options.roomName;
-};
-
 /**
  * Removes the callstats.io instances.
  */
@@ -686,7 +672,7 @@ Statistics.sendLog = function(m) {
  * @param comment the comment from the user.
  */
 Statistics.prototype.sendFeedback = function(overall, comment) {
-    CallStats.sendFeedback(this._getCallStatsConfID(), overall, comment);
+    CallStats.sendFeedback(this.options.confID, overall, comment);
     Statistics.analytics.sendEvent(
         FEEDBACK,
         {