fix(analytics): delay conference.join event (#1048)

Send conference.join event only after the peer connection is created.
This way we won't send events for lonely calls.

JitsiConference.js

@@ -56,6 +56,7 @@ import {
     ACTION_P2P_FAILED,
     ACTION_P2P_SWITCH_TO_JVB,
     ICE_ESTABLISHMENT_DURATION_DIFF,
+    createConferenceEvent,
     createJingleEvent,
     createP2PEvent
 } from './service/statistics/AnalyticsEvents';
@@ -231,6 +232,7 @@ export default function JitsiConference(options) {
 
     this.videoSIPGWHandler = new VideoSIPGW(this.room);
     this.recordingManager = new RecordingManager(this.room);
+    this._conferenceJoinAnalyticsEventSent = false;
 }
 
 // FIXME convert JitsiConference to ES6 - ASAP !
@@ -290,12 +292,12 @@ JitsiConference.prototype._init = function(options = {}) {
     }
 
     const { config } = this.options;
-    const statsCurrentId = config.statisticsId ? config.statisticsId : Settings.callStatsUserName;
 
+    this._statsCurrentId = config.statisticsId ? config.statisticsId : Settings.callStatsUserName;
     this.room = this.xmpp.createRoom(
         this.options.name, {
             ...config,
-            statsId: statsCurrentId
+            statsId: this._statsCurrentId
         },
         JitsiConference.resourceCreator
     );
@@ -319,6 +321,9 @@ JitsiConference.prototype._init = function(options = {}) {
     this.room.addListener(XMPPEvents.CONFERENCE_PROPERTIES_CHANGED,
         this._updateProperties);
 
+    this._sendConferenceJoinAnalyticsEvent = this._sendConferenceJoinAnalyticsEvent.bind(this);
+    this.room.addListener(XMPPEvents.MEETING_ID_SET, this._sendConferenceJoinAnalyticsEvent);
+
     this.rttMonitor = new RttMonitor(config.rttMonitor || {});
 
     this.e2eping = new E2ePing(
@@ -354,7 +359,7 @@ JitsiConference.prototype._init = function(options = {}) {
 
     if (!this.statistics) {
         this.statistics = new Statistics(this.xmpp, {
-            aliasName: statsCurrentId,
+            aliasName: this._statsCurrentId,
             userName: config.statisticsDisplayName ? config.statisticsDisplayName : this.myUserId(),
             callStatsConfIDNamespace: this.connection.options.hosts.domain,
             confID: config.confID || `${this.connection.options.hosts.domain}/${this.options.name}`,
@@ -367,7 +372,7 @@ JitsiConference.prototype._init = function(options = {}) {
             getWiFiStatsMethod: config.getWiFiStatsMethod
         });
         Statistics.analytics.addPermanentProperties({
-            'callstats_name': statsCurrentId
+            'callstats_name': this._statsCurrentId
         });
     }
 
@@ -571,6 +576,8 @@ JitsiConference.prototype.leave = function() {
             XMPPEvents.CONFERENCE_PROPERTIES_CHANGED,
             this._updateProperties);
 
+        room.removeListener(XMPPEvents.MEETING_ID_SET, this._sendConferenceJoinAnalyticsEvent);
+
         this.eventManager.removeXMPPListeners();
 
         this.room = null;
@@ -1833,6 +1840,7 @@ JitsiConference.prototype._acceptJvbIncomingCall = function(
     // Accept incoming call
     this.jvbJingleSession = jingleSession;
     this.room.connectionTimes['session.initiate'] = now;
+    this._sendConferenceJoinAnalyticsEvent();
 
     if (this.wasStopped) {
         Statistics.sendAnalyticsAndLog(
@@ -2609,6 +2617,7 @@ JitsiConference.prototype._acceptP2PIncomingCall = function(
 
     // Accept the offer
     this.p2pJingleSession = jingleSession;
+    this._sendConferenceJoinAnalyticsEvent();
 
     this.p2pJingleSession.initialize(this.room, this.rtc, this.options.config);
 
@@ -2957,6 +2966,7 @@ JitsiConference.prototype._startP2PSession = function(remoteJid) {
             remoteJid);
     logger.info(
         'Created new P2P JingleSession', this.room.myroomjid, remoteJid);
+    this._sendConferenceJoinAnalyticsEvent();
 
     this.p2pJingleSession.initialize(this.room, this.rtc, this.options.config);
 
@@ -3266,3 +3276,22 @@ JitsiConference.prototype.createVideoSIPGWSession
         return this.videoSIPGWHandler
             .createVideoSIPGWSession(sipAddress, displayName);
     };
+
+/**
+ * Sends a conference.join analytics event.
+ *
+ * @returns {void}
+ */
+JitsiConference.prototype._sendConferenceJoinAnalyticsEvent = function() {
+    const meetingId = this.getMeetingUniqueId();
+
+    if (this._conferenceJoinAnalyticsEventSent || !meetingId || this.getActivePeerConnection() === null) {
+        return;
+    }
+
+    Statistics.sendAnalytics(createConferenceEvent('joined', {
+        meetingId,
+        participantId: `${meetingId}.${this._statsCurrentId}`
+    }));
+    this._conferenceJoinAnalyticsEventSent = true;
+};

modules/xmpp/ChatRoom.js

@@ -7,9 +7,7 @@ import GlobalOnErrorHandler from '../util/GlobalOnErrorHandler';
 import * as JitsiTranscriptionStatus from '../../JitsiTranscriptionStatus';
 import Listenable from '../util/Listenable';
 import * as MediaType from '../../service/RTC/MediaType';
-import { createConferenceEvent } from '../../service/statistics/AnalyticsEvents';
 import XMPPEvents from '../../service/xmpp/XMPPEvents';
-import Statistics from '../statistics/statistics';
 
 import Moderator from './moderator';
 import XmppConnection from './XmppConnection';
@@ -314,10 +312,7 @@ export default class ChatRoom extends Listenable {
                 logger.warn(`Meeting Id changed from:${this.meetingId} to:${meetingId}`);
             }
             this.meetingId = meetingId;
-
-            // The name of the action is a little bit confusing but it seems this is the preferred name by the consumers
-            // of the analytics events.
-            Statistics.sendAnalytics(createConferenceEvent('joined', { meetingId }));
+            this.eventEmitter.emit(XMPPEvents.MEETING_ID_SET, meetingId);
         }
     }
 

service/xmpp/XMPPEvents.js

@@ -99,6 +99,11 @@ const XMPPEvents = {
     // Designates an event indicating that our role in the XMPP MUC has changed.
     LOCAL_ROLE_CHANGED: 'xmpp.localrole_changed',
 
+    /**
+     * Event fired when the unique meeting id is set.
+     */
+    MEETING_ID_SET: 'xmpp.meeting_id_set',
+
     // Designates an event indicating that an XMPP message in the MUC was
     // received.
     MESSAGE_RECEIVED: 'xmpp.message_received',