feat(TPC): append TPC ID to stream IDs

This commit will append "-" + tpc.id to every local 'MSID', 'cname',
'label' and 'mslabel', before feeding the local SDP to the Jingle layer.
It will make stream IDs unique across TraceablePeerConnection instances
and prevent from conflicts in some corner cases.

For example this will fix a problem where if the client drops
the conference without leaving the XMPP MUC gracefully and will join
the conference again without recreating the local tracks it would lead
to the MSID conflict, because the stream is still advertised by
"the ghost" participant.

modules/RTC/LocalSdpMunger.js

@@ -161,6 +161,48 @@ export default class LocalSdpMunger {
         return modified;
     }
 
+    /**
+     * Modifies 'cname', 'msid', 'label' and 'mslabel' by appending
+     * the id of {@link LocalSdpMunger#tpc} at the end, preceding by a dash
+     * sign.
+     *
+     * @param {MLineWrap} mediaSection - The media part (audio or video) of the
+     * session description which will be modified in place.
+     * @returns {void}
+     * @private
+     */
+    _transformMediaIdentifiers(mediaSection) {
+        const pcId = this.tpc.id;
+
+        for (const ssrcLine of mediaSection.ssrcs) {
+            switch (ssrcLine.attribute) {
+            case 'cname':
+            case 'label':
+            case 'mslabel':
+                ssrcLine.value = ssrcLine.value && `${ssrcLine.value}-${pcId}`;
+                break;
+            case 'msid': {
+                if (ssrcLine.value) {
+                    const streamAndTrackIDs = ssrcLine.value.split(' ');
+
+                    if (streamAndTrackIDs.length === 2) {
+                        const streamId = streamAndTrackIDs[0];
+                        const trackId = streamAndTrackIDs[1];
+
+                        ssrcLine.value
+                            = `${streamId}-${pcId} ${trackId}-${pcId}`;
+                    } else {
+                        logger.warn(
+                            'Unable to munge local MSID'
+                                + `- weird format detected: ${ssrcLine.value}`);
+                    }
+                }
+                break;
+            }
+            }
+        }
+    }
+
     /**
      * Maybe modifies local description to fake local video tracks SDP when
      * those are muted.
@@ -185,4 +227,44 @@ export default class LocalSdpMunger {
 
         return desc;
     }
+
+    /**
+     * This transformation will make sure that stream identifiers are unique
+     * across all of the local PeerConnections even if the same stream is used
+     * by multiple instances at the same time.
+     * Each PeerConnection assigns different SSRCs to the same local
+     * MediaStream, but the MSID remains the same as it's used to identify
+     * the stream by the WebRTC backend. The transformation will append
+     * {@link TraceablePeerConnection#id} at the end of each stream's identifier
+     * ("cname", "msid", "label" and "mslabel").
+     *
+     * @param {RTCSessionDescription} sessionDesc - The local session
+     * description (this instance remains unchanged).
+     * @return {RTCSessionDescription} - Transformed local session description
+     * (a modified copy of the one given as the input).
+     */
+    transformStreamIdentifiers(sessionDesc) {
+        // FIXME similar check is probably duplicated in all other transformers
+        if (!sessionDesc || !sessionDesc.sdp || !sessionDesc.type) {
+            return sessionDesc;
+        }
+
+        const transformer = new SdpTransformWrap(sessionDesc.sdp);
+        const audioMLine = transformer.selectMedia('audio');
+
+        if (audioMLine) {
+            this._transformMediaIdentifiers(audioMLine);
+        }
+
+        const videoMLine = transformer.selectMedia('video');
+
+        if (videoMLine) {
+            this._transformMediaIdentifiers(videoMLine);
+        }
+
+        return new RTCSessionDescription({
+            type: sessionDesc.type,
+            sdp: transformer.toRawSDP()
+        });
+    }
 }

modules/RTC/RTC.js

@@ -19,6 +19,12 @@ import VideoType from '../../service/RTC/VideoType';
 
 const logger = getLogger(__filename);
 
+/**
+ * The counter used to generated id numbers assigned to peer connections
+ * @type {number}
+ */
+let peerConnectionIdCounter = 1;
+
 let rtcTrackIdCounter = 0;
 
 /**
@@ -114,12 +120,6 @@ export default class RTC extends Listenable {
          */
         this.peerConnections = new Map();
 
-        /**
-         * The counter used to generated id numbers assigned to peer connections
-         * @type {number}
-         */
-        this.peerConnectionIdCounter = 1;
-
         this.localTracks = [];
 
         this.options = options;
@@ -444,13 +444,13 @@ export default class RTC extends Listenable {
         const newConnection
             = new TraceablePeerConnection(
                 this,
-                this.peerConnectionIdCounter,
+                peerConnectionIdCounter,
                 signaling,
                 iceConfig, pcConstraints,
                 isP2P, options);
 
         this.peerConnections.set(newConnection.id, newConnection);
-        this.peerConnectionIdCounter += 1;
+        peerConnectionIdCounter += 1;
 
         return newConnection;
     }

modules/RTC/TraceablePeerConnection.js

@@ -1210,6 +1210,9 @@ const getters = {
         // happening (check setLocalDescription impl).
         desc = enforceSendRecv(desc);
 
+        // See the method's doc for more info about this transformation.
+        desc = this.localSdpMunger.transformStreamIdentifiers(desc);
+
         return desc;
     },
     remoteDescription() {