Merge pull request #208 from jitsi/analytics-update

Analytics update

JitsiMeetJS.js

@@ -41,6 +41,29 @@ function getLowerResolution(resolution) {
     return resName;
 }
 
+/**
+ * Checks the available devices in options and concatenate the data to the
+ * name, which will be used as analytics event name. Adds resolution for the
+ * devices.
+ * @param name name of event
+ * @param options gum options
+ * @returns {*}
+ */
+function addDeviceTypeToAnalyticsEvent(name, options) {
+    if (options.devices.indexOf("audio") !== -1) {
+        name += ".audio";
+    }
+    if (options.devices.indexOf("desktop") !== -1) {
+        name += ".desktop";
+    }
+    if (options.devices.indexOf("video") !== -1) {
+        // we have video add resolution
+        name += ".video." + options.resolution;
+    }
+
+    return name;
+}
+
 /**
  * Namespace for the interface of Jitsi Meet Library.
  */
@@ -164,10 +187,21 @@ var LibJitsiMeet = {
             }, USER_MEDIA_PERMISSION_PROMPT_TIMEOUT);
         }
 
+        if(!window.connectionTimes)
+            window.connectionTimes = {};
+        window.connectionTimes["obtainPermissions.start"] =
+            window.performance.now();
+
         return RTC.obtainAudioAndVideoPermissions(options || {})
             .then(function(tracks) {
                 promiseFulfilled = true;
 
+                window.connectionTimes["obtainPermissions.end"] =
+                    window.performance.now();
+
+                Statistics.analytics.sendEvent(addDeviceTypeToAnalyticsEvent(
+                    "getUserMedia.success", options), options);
+
                 if(!RTC.options.disableAudioLevels)
                     for(var i = 0; i < tracks.length; i++) {
                         var track = tracks[i];
@@ -197,6 +231,9 @@ var LibJitsiMeet = {
                         logger.debug("Retry createLocalTracks with resolution",
                             newResolution);
 
+                        Statistics.analytics.sendEvent(
+                            "getUserMedia.fail.resolution." + oldResolution);
+
                         return LibJitsiMeet.createLocalTracks(options);
                     }
                 }
@@ -211,11 +248,22 @@ var LibJitsiMeet = {
                         message: error.message
                     };
                     Statistics.sendLog(JSON.stringify(logObject));
+                    Statistics.analytics.sendEvent(
+                        "getUserMedia.userCancel.extensionInstall");
                 } else {
                     // Report gUM failed to the stats
                     Statistics.sendGetUserMediaFailed(error);
                 }
 
+                window.connectionTimes["obtainPermissions.end"] =
+                    window.performance.now();
+
+
+                Statistics.analytics.sendEvent(
+                    addDeviceTypeToAnalyticsEvent(
+                        "getUserMedia.failed", options) + '.' + error.name,
+                    options);
+
                 return Promise.reject(error);
             }.bind(this));
     },

modules/RTC/JitsiRemoteTrack.js

@@ -2,6 +2,7 @@ var JitsiTrack = require("./JitsiTrack");
 var JitsiTrackEvents = require("../../JitsiTrackEvents");
 var RTCBrowserType = require("./RTCBrowserType");
 var Statistics = require("../statistics/statistics");
+var AdapterJS = require("./adapter.screenshare");
 
 var ttfmTrackerAudioAttached = false;
 var ttfmTrackerVideoAttached = false;
@@ -25,6 +26,10 @@ function JitsiRemoteTrack(conference, ownerJid, stream, track, mediaType, videoT
     this.conference = conference;
     this.peerjid = ownerJid;
     this.muted = muted;
+    // we want to mark whether the track has been ever muted
+    // to detect ttfm events for startmuted conferences, as it can significantly
+    // increase ttfm values
+    this.hasBeenMuted = muted;
 }
 
 JitsiRemoteTrack.prototype = Object.create(JitsiTrack.prototype);
@@ -38,6 +43,9 @@ JitsiRemoteTrack.prototype.setMute = function (value) {
     if(this.muted === value)
         return;
 
+    if(value)
+        this.hasBeenMuted = true;
+
     // we can have a fake video stream
     if(this.stream)
         this.stream.muted = value;
@@ -89,6 +97,26 @@ JitsiRemoteTrack.prototype._setVideoType = function (type) {
     this.eventEmitter.emit(JitsiTrackEvents.TRACK_VIDEOTYPE_CHANGED, type);
 };
 
+JitsiRemoteTrack.prototype._playCallback = function () {
+    var type = (this.isVideoTrack() ? 'video' : 'audio');
+
+    var now = window.performance.now();
+    console.log("(TIME) Render " + type + ":\t", now);
+    this.conference.getConnectionTimes()[type + ".render"] = now;
+
+    var ttfm = now
+        - (this.conference.getConnectionTimes()["session.initiate"]
+        - this.conference.getConnectionTimes()["muc.joined"])
+        - (window.connectionTimes["obtainPermissions.end"]
+        - window.connectionTimes["obtainPermissions.start"]);
+    this.conference.getConnectionTimes()[type + ".ttfm"] = ttfm;
+    console.log("(TIME) TTFM " + type + ":\t", ttfm);
+    var eventName = type +'.ttfm';
+    if(this.hasBeenMuted)
+        eventName += '.muted';
+    Statistics.analytics.sendEvent(eventName, ttfm);
+};
+
 /**
  * Attach time to first media tracker only if there is conference and only
  * for the first element.
@@ -107,21 +135,13 @@ JitsiRemoteTrack.prototype._attachTTFMTracker = function (container) {
     if (this.isVideoTrack())
         ttfmTrackerVideoAttached = true;
 
-    // FIXME: this is not working for temasys
-    container.addEventListener("canplay", function () {
-        var type = (this.isVideoTrack() ? 'video' : 'audio');
-
-        var now = window.performance.now();
-        console.log("(TIME) Render " + type + ":\t", now);
-        this.conference.getConnectionTimes()[type + ".render"] = now;
-
-        var ttfm = now
-            - (this.conference.getConnectionTimes()["session.initiate"]
-            - this.conference.getConnectionTimes()["muc.joined"]);
-        this.conference.getConnectionTimes()[type + ".ttfm"] = ttfm;
-        console.log("(TIME) TTFM " + type + ":\t", ttfm);
-        Statistics.analytics.sendEvent(type +'.ttfm', ttfm);
-    }.bind(this));
+    if (RTCBrowserType.isTemasysPluginUsed()) {
+        // FIXME: this is not working for IE11
+        AdapterJS.addEvent(container, 'play', this._playCallback.bind(this));
+    }
+    else {
+        container.addEventListener("canplay", this._playCallback.bind(this));
+    }
 };
 
 module.exports = JitsiRemoteTrack;

modules/statistics/statistics.js

@@ -44,7 +44,7 @@ function loadCallStatsAPI() {
 function loadAnalytics(customScriptUrl) {
     // if we have a custom script url passed as parameter we don't want to
     // search it relatively near the library
-    JitsiMeetJS.util.ScriptUtil.loadScript(
+    ScriptUtil.loadScript(
         customScriptUrl ? customScriptUrl : 'analytics.js',
         /* async */ true,
         /* prepend */ false,