feat(JingleSessionPC): ICE failed notification

Make the client send ICE failed notification to let Jicofo know
that the ICE connection with the bridge has failed. It can then
re-create the channels and send new transport in the
'transport-replace' message to give it another try.

Also adds a bridge session ID so that Jicofo can discard outdated
requests. When a bridge dies multiple clients may send ICE failed
notifications at the same time. Jicofo will detect bridge failure
when processing the first one and it must not act on the following
requests for the broken bridge session which is no longer current.

A bridge session ID will be sent in new 'bridge-session' XML element
which is part of either 'session-initiate' or 'transport-replace'
message. The server's region is moved to this element as well as
it's part of a bridge session.

JitsiConference.js

@@ -1633,7 +1633,7 @@ JitsiConference.prototype._acceptJvbIncomingCall = function(
 
     const serverRegion
         = $(jingleOffer)
-            .find('>server-region[xmlns="http://jitsi.org/protocol/focus"]')
+            .find('>bridge-session[xmlns="http://jitsi.org/protocol/focus"]')
             .attr('region');
 
     this.eventEmitter.emit(
@@ -2364,6 +2364,9 @@ JitsiConference.prototype._onIceConnectionFailed = function(session) {
 
         }
         this._stopP2PSession('connectivity-error', 'ICE FAILED');
+    } else if (session && this.jvbJingleSession === session) {
+        // Let Jicofo know that the JVB's ICE connection has failed
+        session.sendIceFailedNotification();
     }
 };
 

modules/xmpp/JingleSessionPC.js

@@ -127,6 +127,17 @@ export default class JingleSessionPC extends JingleSession {
             localJid,
             remoteJid, connection, mediaConstraints, iceConfig, isInitiator);
 
+        /**
+         * The bridge session's identifier. One Jingle session can during
+         * it's lifetime participate in multiple bridge sessions managed by
+         * Jicofo. A new bridge session is started whenever Jicofo sends
+         * 'session-initiate' or 'transport-replace'.
+         *
+         * @type {?string}
+         * @private
+         */
+        this._bridgeSessionId = null;
+
         /**
          * Stores result of {@link window.performance.now()} at the time when
          * ICE enters 'checking' state.
@@ -473,10 +484,6 @@ export default class JingleSessionPC extends JingleSession {
             case 'failed':
                 this.room.eventEmitter.emit(
                     XMPPEvents.CONNECTION_ICE_FAILED, this);
-                this.room.eventEmitter.emit(
-                    XMPPEvents.CONFERENCE_SETUP_FAILED,
-                    this,
-                    new Error('ICE fail'));
                 break;
             }
         };
@@ -631,6 +638,44 @@ export default class JingleSessionPC extends JingleSession {
             cand, null, this.newJingleErrorHandler(cand), IQ_TIMEOUT);
     }
 
+    /**
+     * Sends Jingle 'session-info' message which includes custom Jitsi Meet
+     * 'ice-state' element with the text value 'failed' to let Jicofo know
+     * that the ICE connection has entered the failed state. It can then
+     * choose to re-create JVB channels and send 'transport-replace' to
+     * retry the connection.
+     */
+    sendIceFailedNotification() {
+        const sessionInfo
+            = $iq({
+                to: this.remoteJid,
+                type: 'set' })
+            .c('jingle', { xmlns: 'urn:xmpp:jingle:1',
+                action: 'session-info',
+                initiator: this.initiatorJid,
+                sid: this.sid })
+            .c('ice-state', { xmlns: 'http://jitsi.org/protocol/focus' })
+            .t('failed')
+            .up();
+
+        this._bridgeSessionId
+            && sessionInfo.c(
+                'bridge-session', {
+                    xmlns: 'http://jitsi.org/protocol/focus',
+                    id: this._bridgeSessionId
+                });
+
+        this.connection.sendIQ(
+            sessionInfo,
+            null,
+            this.newJingleErrorHandler(sessionInfo),
+            /*
+             * This message will be often sent when there are connectivity
+             * issues, so make it slightly longer than Prosody's default BOSH
+             * inactivity timeout of 60 seconds.
+             */ 65);
+    }
+
     /**
      * {@inheritDoc}
      */
@@ -913,6 +958,16 @@ export default class JingleSessionPC extends JingleSession {
             const oldLocalSdp
                 = this.peerconnection.localDescription.sdp;
 
+            const bridgeSession
+                = $(jingleOfferAnswerIq)
+                    .find('>bridge-session['
+                        + 'xmlns="http://jitsi.org/protocol/focus"]');
+            const bridgeSessionId = bridgeSession.attr('id');
+
+            if (bridgeSessionId !== this._bridgeSessionId) {
+                this._bridgeSessionId = bridgeSessionId;
+            }
+
             this._renegotiate(newRemoteSdp.raw)
                 .then(() => {
                     if (this.state === JingleSessionState.PENDING) {