Merge pull request #49 from jitsi/reduce-muc-joined-time

Reduce MUC joined time

modules/xmpp/ChatRoom.js

@@ -123,12 +123,13 @@ ChatRoom.prototype.join = function (password) {
 };
 
 ChatRoom.prototype.sendPresence = function (fromJoin) {
-    if (!this.presMap['to'] || (!this.joined && !fromJoin)) {
+    var to = this.presMap['to'];
+    if (!to || (!this.joined && !fromJoin)) {
         // Too early to send presence - not initialized
         return;
     }
 
-    var pres = $pres({to: this.presMap['to'] });
+    var pres = $pres({to: to });
     pres.c('x', {xmlns: this.presMap['xns']});
 
     if (this.password) {
@@ -138,13 +139,22 @@ ChatRoom.prototype.sendPresence = function (fromJoin) {
     pres.up();
 
     // Send XEP-0115 'c' stanza that contains our capabilities info
-    if (this.connection.caps) {
-        this.connection.caps.node = this.xmpp.options.clientNode;
-        pres.c('c', this.connection.caps.generateCapsAttrs()).up();
+    var connection = this.connection;
+    var caps = connection.caps;
+    if (caps) {
+        caps.node = this.xmpp.options.clientNode;
+        pres.c('c', caps.generateCapsAttrs()).up();
     }
 
     parser.JSON2packet(this.presMap.nodes, pres);
-    this.connection.send(pres);
+    connection.send(pres);
+    if (fromJoin) {
+        // XXX We're pressed for time here because we're beginning a complex
+        // and/or lengthy conference-establishment process which supposedly
+        // involves multiple RTTs. We don't have the time to wait for Strophe to
+        // decide to send our IQ.
+        connection.flush();
+    }
 };
 
 
@@ -214,17 +224,16 @@ ChatRoom.prototype.onPresence = function (pres) {
     var member = {};
     member.show = $(pres).find('>show').text();
     member.status = $(pres).find('>status').text();
-    var tmp = $(pres).find('>x[xmlns="http://jabber.org/protocol/muc#user"]>item');
-    member.affiliation = tmp.attr('affiliation');
-    member.role = tmp.attr('role');
+    var mucUserItem
+        = $(pres).find('>x[xmlns="http://jabber.org/protocol/muc#user"]>item');
+    member.affiliation = mucUserItem.attr('affiliation');
+    member.role = mucUserItem.attr('role');
 
     // Focus recognition
-    member.jid = tmp.attr('jid');
-    member.isFocus = false;
-    if (member.jid
-        && member.jid.indexOf(this.moderator.getFocusUserJid() + "/") === 0) {
-        member.isFocus = true;
-    }
+    var jid = mucUserItem.attr('jid');
+    member.jid = jid;
+    member.isFocus
+        = !!jid && jid.indexOf(this.moderator.getFocusUserJid() + "/") === 0;
 
     $(pres).find(">x").remove();
     var nodes = [];
@@ -248,11 +257,9 @@ ChatRoom.prototype.onPresence = function (pres) {
     }
 
     if (from == this.myroomjid) {
-        if (member.affiliation == 'owner'
-            &&  this.role !== member.role) {
-                this.role = member.role;
-                this.eventEmitter.emit(
-                    XMPPEvents.LOCAL_ROLE_CHANGED, this.role);
+        if (member.affiliation == 'owner' && this.role !== member.role) {
+            this.role = member.role;
+            this.eventEmitter.emit(XMPPEvents.LOCAL_ROLE_CHANGED, this.role);
         }
         if (!this.joined) {
             this.joined = true;
@@ -272,7 +279,7 @@ ChatRoom.prototype.onPresence = function (pres) {
                 if(this.lastJibri)
                     this.recording.handleJibriPresence(this.lastJibri);
             }
-            logger.info("Ignore focus: " + from + ", real JID: " + member.jid);
+            logger.info("Ignore focus: " + from + ", real JID: " + jid);
         }
         else {
             this.eventEmitter.emit(
@@ -281,15 +288,16 @@ ChatRoom.prototype.onPresence = function (pres) {
     } else {
         // Presence update for existing participant
         // Watch role change:
-        if (this.members[from].role != member.role) {
-            this.members[from].role = member.role;
+        var memberOfThis = this.members[from];
+        if (memberOfThis.role != member.role) {
+            memberOfThis.role = member.role;
             this.eventEmitter.emit(
                 XMPPEvents.MUC_ROLE_CHANGED, from, member.role);
         }
 
         // store the new display name
         if(member.displayName)
-            this.members[from].displayName = member.displayName;
+            memberOfThis.displayName = member.displayName;
     }
 
     // after we had fired member or room joined events, lets fire events
@@ -343,7 +351,6 @@ ChatRoom.prototype.onPresence = function (pres) {
         if(this.recording)
             this.recording.handleJibriPresence(jibri);
     }
-
 };
 
 ChatRoom.prototype.processNode = function (node, from) {

modules/xmpp/SDP.js

@@ -5,29 +5,33 @@ var SDPUtil = require("./SDPUtil");
 
 // SDP STUFF
 function SDP(sdp) {
-    /**
-     * Whether or not to remove TCP ice candidates when translating from/to jingle.
-     * @type {boolean}
-     */
-    this.removeTcpCandidates = false;
-
-    /**
-     * Whether or not to remove UDP ice candidates when translating from/to jingle.
-     * @type {boolean}
-     */
-    this.removeUdpCandidates = false;
-
-    this.media = sdp.split('\r\nm=');
-    for (var i = 1; i < this.media.length; i++) {
-        this.media[i] = 'm=' + this.media[i];
-        if (i != this.media.length - 1) {
-            this.media[i] += '\r\n';
+    var media = sdp.split('\r\nm=');
+    for (var i = 1, length = media.length; i < length; i++) {
+        var media_i = 'm=' + media[i];
+        if (i != length - 1) {
+            media_i += '\r\n';
         }
+        media[i] = media_i;
     }
-    this.session = this.media.shift() + '\r\n';
-    this.raw = this.session + this.media.join('');
+    var session = media.shift() + '\r\n';
+
+    this.media = media;
+    this.raw = session + media.join('');
+    this.session = session;
 }
 
+/**
+ * Whether or not to remove TCP ice candidates when translating from/to jingle.
+ * @type {boolean}
+ */
+SDP.prototype.removeTcpCandidates = false;
+
+/**
+ * Whether or not to remove UDP ice candidates when translating from/to jingle.
+ * @type {boolean}
+ */
+SDP.prototype.removeUdpCandidates = false;
+
 /**
  * Returns map of MediaChannel mapped per channel idx.
  */
@@ -57,7 +61,7 @@ SDP.prototype.getMediaSsrcMap = function() {
             media.ssrcs[linessrc].lines.push(line);
         });
         tmp = SDPUtil.find_lines(self.media[mediaindex], 'a=ssrc-group:');
-        tmp.forEach(function(line){
+        tmp.forEach(function(line) {
             var idx = line.indexOf(' ');
             var semantics = line.substr(0, idx).substr(13);
             var ssrcs = line.substr(14 + semantics.length).split(' ');
@@ -107,13 +111,10 @@ SDP.prototype.mangle = function () {
                 if (rtpmap.name == 'CN' || rtpmap.name == 'ISAC')
                     continue;
                 mline.fmt.push(rtpmap.id);
-                newdesc += lines[j] + '\r\n';
-            } else {
-                newdesc += lines[j] + '\r\n';
             }
+            newdesc += lines[j] + '\r\n';
         }
-        this.media[i] = SDPUtil.build_mline(mline) + '\r\n';
-        this.media[i] += newdesc;
+        this.media[i] = SDPUtil.build_mline(mline) + '\r\n' + newdesc;
     }
     this.raw = this.session + this.media.join('');
 };
@@ -162,8 +163,7 @@ SDP.prototype.toJingle = function (elem, thecreator) {
         mline = SDPUtil.parse_mline(this.media[i].split('\r\n')[0]);
         if (!(mline.media === 'audio' ||
               mline.media === 'video' ||
-              mline.media === 'application'))
-        {
+              mline.media === 'application')) {
             continue;
         }
         var assrcline = SDPUtil.find_line(this.media[i], 'a=ssrc:');
@@ -247,16 +247,12 @@ SDP.prototype.toJingle = function (elem, thecreator) {
                     elem.attrs({name: "cname", value:Math.random().toString(36).substring(7)});
                     elem.up();
                     var msid = null;
-                    if(mline.media == "audio")
-                    {
+                    if(mline.media == "audio") {
                         msid = APP.RTC.localAudio._getId();
-                    }
-                    else
-                    {
+                    } else {
                         msid = APP.RTC.localVideo._getId();
                     }
-                    if(msid != null)
-                    {
+                    if(msid != null) {
                         msid = SDPUtil.filter_special_chars(msid);
                         elem.c('parameter');
                         elem.attrs({name: "msid", value:msid});
@@ -497,11 +493,9 @@ SDP.prototype.jingle2media = function (content) {
         // estos hack to reject an m-line.
         tmp.port = '0';
     }
-    if (content.find('>transport>fingerprint').length || desc.find('encryption').length) {
-        if (sctp.length)
-            tmp.proto = 'DTLS/SCTP';
-        else
-            tmp.proto = 'RTP/SAVPF';
+    if (content.find('>transport>fingerprint').length
+            || desc.find('encryption').length) {
+        tmp.proto = sctp.length ? 'DTLS/SCTP' : 'RTP/SAVPF';
     } else {
         tmp.proto = 'RTP/AVPF';
     }

modules/xmpp/moderator.js

@@ -246,103 +246,138 @@ Moderator.prototype.parseConfigOptions =  function (resultIq) {
     logger.info("Sip gateway enabled:  " + this.sipGatewayEnabled);
 };
 
-// FIXME =  we need to show the fact that we're waiting for the focus
-// to the user(or that focus is not available)
+// FIXME We need to show the fact that we're waiting for the focus to the user
+// (or that the focus is not available)
+/**
+ * Allocates the conference focus.
+ *
+ * @param {Function} callback - the function to be called back upon the
+ * successful allocation of the conference focus
+ */
 Moderator.prototype.allocateConferenceFocus =  function (callback) {
     // Try to use focus user JID from the config
     this.setFocusUserJid(this.xmppService.options.focusUserJid);
     // Send create conference IQ
-    var iq = this.createConferenceIq();
     var self = this;
     this.connection.sendIQ(
-        iq,
+        this.createConferenceIq(),
         function (result) {
-
-            // Setup config options
-            self.parseConfigOptions(result);
-
-            if ('true' === $(result).find('conference').attr('ready')) {
-                // Reset both timers
-                self.getNextTimeout(true);
-                self.getNextErrorTimeout(true);
-                // Exec callback
-                callback();
-            } else {
-                var waitMs = self.getNextTimeout();
-                logger.info("Waiting for the focus... " + waitMs);
-                // Reset error timeout
-                self.getNextErrorTimeout(true);
-                window.setTimeout(
-                    function () {
-                        self.allocateConferenceFocus(callback);
-                    }, waitMs);
-            }
+            self._allocateConferenceFocusSuccess(result, callback);
         },
         function (error) {
-            // Invalid session ? remove and try again
-            // without session ID to get a new one
-            var invalidSession
-                = $(error).find('>error>session-invalid').length;
-            if (invalidSession) {
-                logger.info("Session expired! - removing");
-                self.settings.clearSessionId();
-            }
-            if ($(error).find('>error>graceful-shutdown').length) {
-                self.eventEmitter.emit(XMPPEvents.GRACEFUL_SHUTDOWN);
-                return;
-            }
-            // Check for error returned by the reservation system
-            var reservationErr = $(error).find('>error>reservation-error');
-            if (reservationErr.length) {
-                // Trigger error event
-                var errorCode = reservationErr.attr('error-code');
-                var errorMsg;
-                if ($(error).find('>error>text')) {
-                    errorMsg = $(error).find('>error>text').text();
-                }
-                self.eventEmitter.emit(
-                    XMPPEvents.RESERVATION_ERROR, errorCode, errorMsg);
-                return;
-            }
-            // Not authorized to create new room
-            if ($(error).find('>error>not-authorized').length) {
-                logger.warn("Unauthorized to start the conference", error);
-                var toDomain
-                    = Strophe.getDomainFromJid(error.getAttribute('to'));
-                if (toDomain !==
-                    self.xmppService.options.hosts.anonymousdomain) {
-                    //FIXME:  "is external" should come either from
-                    // the focus or config.js
-                    self.externalAuthEnabled = true;
-                }
-                self.eventEmitter.emit(
-                    XMPPEvents.AUTHENTICATION_REQUIRED,
-                    function () {
-                        self.allocateConferenceFocus(
-                            callback);
-                    });
-                return;
-            }
-            var waitMs = self.getNextErrorTimeout();
-            logger.error("Focus error, retry after " + waitMs, error);
-            // Show message
-            var focusComponent = self.getFocusComponent();
-            var retrySec = waitMs / 1000;
-            //FIXME:  message is duplicated ?
-            // Do not show in case of session invalid
-            // which means just a retry
-            if (!invalidSession) {
-                self.eventEmitter.emit(XMPPEvents.FOCUS_DISCONNECTED,
-                    focusComponent, retrySec);
-            }
-            // Reset response timeout
-            self.getNextTimeout(true);
-            window.setTimeout(
+            self._allocateConferenceFocusError(error);
+        });
+    // XXX We're pressed for time here because we're beginning a complex and/or
+    // lengthy conference-establishment process which supposedly involves
+    // multiple RTTs. We don't have the time to wait for Strophe to decide to
+    // send our IQ.
+    this.connection.flush();
+};
+
+/**
+ * Invoked by {@link #allocateConferenceFocus} upon its request receiving an
+ * error result.
+ *
+ * @param error - the error result of the request that
+ * {@link #allocateConferenceFocus} sent
+ * @param {Function} callback - the function to be called back upon the
+ * successful allocation of the conference focus
+ */
+Moderator.prototype._allocateConferenceFocusError = function (error, callback) {
+    var self = this;
+
+    // If the session is invalid, remove and try again without session ID to get
+    // a new one
+    var invalidSession = $(error).find('>error>session-invalid').length;
+    if (invalidSession) {
+        logger.info("Session expired! - removing");
+        self.settings.clearSessionId();
+    }
+    if ($(error).find('>error>graceful-shutdown').length) {
+        self.eventEmitter.emit(XMPPEvents.GRACEFUL_SHUTDOWN);
+        return;
+    }
+    // Check for error returned by the reservation system
+    var reservationErr = $(error).find('>error>reservation-error');
+    if (reservationErr.length) {
+        // Trigger error event
+        var errorCode = reservationErr.attr('error-code');
+        var errorTextNode = $(error).find('>error>text');
+        var errorMsg;
+        if (errorTextNode) {
+            errorMsg = errorTextNode.text();
+        }
+        self.eventEmitter.emit(
+                XMPPEvents.RESERVATION_ERROR, errorCode, errorMsg);
+        return;
+    }
+    // Not authorized to create new room
+    if ($(error).find('>error>not-authorized').length) {
+        logger.warn("Unauthorized to start the conference", error);
+        var toDomain = Strophe.getDomainFromJid(error.getAttribute('to'));
+        if (toDomain !== self.xmppService.options.hosts.anonymousdomain) {
+            //FIXME "is external" should come either from the focus or config.js
+            self.externalAuthEnabled = true;
+        }
+        self.eventEmitter.emit(
+                XMPPEvents.AUTHENTICATION_REQUIRED,
                 function () {
                     self.allocateConferenceFocus(callback);
-                }, waitMs);
-        }
-    );
+                });
+        return;
+    }
+    var waitMs = self.getNextErrorTimeout();
+    logger.error("Focus error, retry after " + waitMs, error);
+    // Show message
+    var focusComponent = self.getFocusComponent();
+    var retrySec = waitMs / 1000;
+    //FIXME: message is duplicated ? Do not show in case of session invalid
+    // which means just a retry
+    if (!invalidSession) {
+        self.eventEmitter.emit(
+                XMPPEvents.FOCUS_DISCONNECTED, focusComponent, retrySec);
+    }
+    // Reset response timeout
+    self.getNextTimeout(true);
+    window.setTimeout(
+            function () {
+                self.allocateConferenceFocus(callback);
+            },
+            waitMs);
+};
+
+/**
+ * Invoked by {@link #allocateConferenceFocus} upon its request receiving a
+ * success (i.e. non-error) result.
+ *
+ * @param result - the success (i.e. non-error) result of the request that
+ * {@link #allocateConferenceFocus} sent
+ * @param {Function} callback - the function to be called back upon the
+ * successful allocation of the conference focus
+ */
+Moderator.prototype._allocateConferenceFocusSuccess = function (
+        result,
+        callback) {
+    // Setup config options
+    this.parseConfigOptions(result);
+
+    // Reset the error timeout (because we haven't failed here).
+    this.getNextErrorTimeout(true);
+    if ('true' === $(result).find('conference').attr('ready')) {
+        // Reset the non-error timeout (because we've succeeded here).
+        this.getNextTimeout(true);
+        // Exec callback
+        callback();
+    } else {
+        var waitMs = this.getNextTimeout();
+        logger.info("Waiting for the focus... " + waitMs);
+        var self = this;
+        window.setTimeout(
+                function () {
+                    self.allocateConferenceFocus(callback);
+                },
+                waitMs);
+    }
 };
 
 Moderator.prototype.authenticate = function () {