@stream-io/video-client 1.16.3 → 1.16.5

package/dist/src/rtc/BasePeerConnection.d.ts

@@ -34,7 +34,7 @@ export declare abstract class BasePeerConnection {
     /**
      * Disposes the `RTCPeerConnection` instance.
      */
-    dispose: () => void;
+    dispose(): void;
     /**
      * Detaches the event handlers from the `RTCPeerConnection`.
      */

package/dist/src/rtc/Publisher.d.ts

@@ -10,6 +10,7 @@ export type PublisherConstructorOpts = BasePeerConnectionOpts & {
  */
 export declare class Publisher extends BasePeerConnection {
     private readonly transceiverCache;
+    private readonly clonedTracks;
     private publishOptions;
     /**
      * Constructs a new `Publisher` instance.
@@ -21,6 +22,10 @@ export declare class Publisher extends BasePeerConnection {
      * instance with a new one (in case of migration).
      */
     detachEventHandlers(): void;
+    /**
+     * Disposes this Publisher instance.
+     */
+    dispose(): void;
     /**
      * Starts publishing the given track of the given media stream.
      *
@@ -53,6 +58,10 @@ export declare class Publisher extends BasePeerConnection {
      * Stops the cloned track that is being published to the SFU.
      */
     stopTracks: (...trackTypes: TrackType[]) => void;
+    /**
+     * Stops all the cloned tracks that are being published to the SFU.
+     */
+    stopAllTracks: () => void;
     private changePublishQuality;
     /**
      * Restarts the ICE connection and renegotiates with the SFU.
@@ -84,4 +93,6 @@ export declare class Publisher extends BasePeerConnection {
      * Converts the given transceiver to a `TrackInfo` object.
      */
     private toTrackInfo;
+    private cloneTrack;
+    private stopTrack;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stream-io/video-client",
-  "version": "1.16.3",
+  "version": "1.16.5",
   "packageManager": "yarn@3.2.4",
   "main": "dist/index.cjs.js",
   "module": "dist/index.es.js",

package/src/rtc/BasePeerConnection.ts

@@ -75,12 +75,12 @@ export abstract class BasePeerConnection {
   /**
    * Disposes the `RTCPeerConnection` instance.
    */
-  dispose = () => {
+  dispose() {
     this.onUnrecoverableError = undefined;
     this.isDisposed = true;
     this.detachEventHandlers();
     this.pc.close();
-  };
+  }
 
   /**
    * Detaches the event handlers from the `RTCPeerConnection`.

package/src/rtc/Publisher.ts

@@ -31,6 +31,7 @@ export type PublisherConstructorOpts = BasePeerConnectionOpts & {
  */
 export class Publisher extends BasePeerConnection {
   private readonly transceiverCache = new TransceiverCache();
+  private readonly clonedTracks = new Set<MediaStreamTrack>();
   private publishOptions: PublishOption[];
 
   /**
@@ -73,6 +74,15 @@ export class Publisher extends BasePeerConnection {
     withCancellation('publisher.negotiate', () => Promise.resolve());
   }
 
+  /**
+   * Disposes this Publisher instance.
+   */
+  dispose() {
+    super.dispose();
+    this.stopAllTracks();
+    this.clonedTracks.clear();
+  }
+
   /**
    * Starts publishing the given track of the given media stream.
    *
@@ -92,13 +102,15 @@ export class Publisher extends BasePeerConnection {
 
       // create a clone of the track as otherwise the same trackId will
       // appear in the SDP in multiple transceivers
-      const trackToPublish = track.clone();
+      const trackToPublish = this.cloneTrack(track);
 
       const transceiver = this.transceiverCache.get(publishOption);
       if (!transceiver) {
         this.addTransceiver(trackToPublish, publishOption);
       } else {
+        const previousTrack = transceiver.sender.track;
         await transceiver.sender.replaceTrack(trackToPublish);
+        this.stopTrack(previousTrack);
       }
     }
   };
@@ -143,7 +155,7 @@ export class Publisher extends BasePeerConnection {
 
       // take the track from the existing transceiver for the same track type,
       // clone it and publish it with the new publish options
-      const track = item.transceiver.sender.track!.clone();
+      const track = this.cloneTrack(item.transceiver.sender.track!);
       this.addTransceiver(track, publishOption);
     }
 
@@ -157,7 +169,7 @@ export class Publisher extends BasePeerConnection {
       );
       if (hasPublishOption) continue;
       // it is safe to stop the track here, it is a clone
-      transceiver.sender.track?.stop();
+      this.stopTrack(transceiver.sender.track);
       await transceiver.sender.replaceTrack(null);
     }
   };
@@ -199,7 +211,19 @@ export class Publisher extends BasePeerConnection {
     for (const item of this.transceiverCache.items()) {
       const { publishOption, transceiver } = item;
       if (!trackTypes.includes(publishOption.trackType)) continue;
-      transceiver.sender.track?.stop();
+      this.stopTrack(transceiver.sender.track);
+    }
+  };
+
+  /**
+   * Stops all the cloned tracks that are being published to the SFU.
+   */
+  stopAllTracks = () => {
+    for (const { transceiver } of this.transceiverCache.items()) {
+      this.stopTrack(transceiver.sender.track);
+    }
+    for (const track of this.clonedTracks) {
+      this.stopTrack(track);
     }
   };
 
@@ -414,4 +438,16 @@ export class Publisher extends BasePeerConnection {
       publishOptionId: publishOption.id,
     };
   };
+
+  private cloneTrack = (track: MediaStreamTrack): MediaStreamTrack => {
+    const clone = track.clone();
+    this.clonedTracks.add(clone);
+    return clone;
+  };
+
+  private stopTrack = (track: MediaStreamTrack | null | undefined) => {
+    if (!track) return;
+    track.stop();
+    this.clonedTracks.delete(track);
+  };
 }

package/src/rtc/__tests__/Publisher.test.ts

@@ -116,6 +116,7 @@ describe('Publisher', () => {
           },
         ],
       });
+      expect(publisher['clonedTracks'].size).toBe(1);
     });
 
     it('should update an existing transceiver for a new track', async () => {
@@ -124,6 +125,8 @@ describe('Publisher', () => {
       vi.spyOn(track, 'clone').mockReturnValue(clone);
 
       const transceiver = new RTCRtpTransceiver();
+      // @ts-ignore test setup
+      transceiver.sender.track = track;
       publisher['transceiverCache'].add(
         publisher['publishOptions'][0],
         transceiver,
@@ -134,6 +137,7 @@ describe('Publisher', () => {
       expect(track.clone).toHaveBeenCalled();
       expect(publisher['pc'].addTransceiver).not.toHaveBeenCalled();
       expect(transceiver.sender.replaceTrack).toHaveBeenCalledWith(clone);
+      expect(track.stop).toHaveBeenCalled();
     });
   });
 
@@ -594,10 +598,22 @@ describe('Publisher', () => {
       );
       vi.spyOn(inactiveTrack, 'readyState', 'get').mockReturnValue('ended');
 
+      const audioTransceiver = new RTCRtpTransceiver();
+      const audioTrack = new MediaStreamTrack();
+      vi.spyOn(audioTrack, 'kind', 'get').mockReturnValue('audio');
+      vi.spyOn(audioTrack, 'enabled', 'get').mockReturnValue(true);
+      vi.spyOn(audioTransceiver.sender, 'track', 'get').mockReturnValue(
+        audioTrack,
+      );
+
       // @ts-expect-error incomplete data
       cache.add({ trackType: TrackType.VIDEO, id: 1 }, transceiver);
       // @ts-expect-error incomplete data
       cache.add({ trackType: TrackType.VIDEO, id: 2 }, inactiveTransceiver);
+      // @ts-expect-error incomplete data
+      cache.add({ trackType: TrackType.AUDIO, id: 3 }, audioTransceiver);
+
+      publisher['clonedTracks'].add(track).add(inactiveTrack).add(audioTrack);
     });
 
     it('negotiate should set up the local and remote descriptions', async () => {
@@ -663,13 +679,13 @@ describe('Publisher', () => {
 
     it('getPublishedTracks returns the published tracks', () => {
       const tracks = publisher.getPublishedTracks();
-      expect(tracks).toHaveLength(1);
+      expect(tracks).toHaveLength(2);
       expect(tracks[0].readyState).toBe('live');
     });
 
     it('getAnnouncedTracks should return all tracks', () => {
       const trackInfos = publisher.getAnnouncedTracks('');
-      expect(trackInfos).toHaveLength(2);
+      expect(trackInfos).toHaveLength(3);
       expect(trackInfos[0].muted).toBe(false);
       expect(trackInfos[0].mid).toBe('0');
       expect(trackInfos[1].muted).toBe(true);
@@ -698,8 +714,19 @@ describe('Publisher', () => {
     it('stopTracks should stop tracks', () => {
       const track = cache['cache'][0].transceiver.sender.track;
       vi.spyOn(track, 'stop');
+      expect(publisher['clonedTracks'].size).toBe(3);
       publisher.stopTracks(TrackType.VIDEO);
       expect(track!.stop).toHaveBeenCalled();
+      expect(publisher['clonedTracks'].size).toBe(1);
+    });
+
+    it('stopAllTracks should stop all tracks', () => {
+      const track = cache['cache'][0].transceiver.sender.track;
+      vi.spyOn(track, 'stop');
+      expect(publisher['clonedTracks'].size).toBe(3);
+      publisher.stopAllTracks();
+      expect(track!.stop).toHaveBeenCalled();
+      expect(publisher['clonedTracks'].size).toBe(0);
     });
   });
 });

package/src/rtc/__tests__/mocks/webrtc.mocks.ts

@@ -6,7 +6,7 @@ const RTCPeerConnectionMock = vi.fn((): Partial<RTCPeerConnection> => {
     addIceCandidate: vi.fn(),
     removeEventListener: vi.fn(),
     getTransceivers: vi.fn(),
-    addTransceiver: vi.fn(),
+    addTransceiver: vi.fn().mockReturnValue(new RTCRtpTransceiverMock()),
     getConfiguration: vi.fn(),
     setConfiguration: vi.fn(),
     createOffer: vi.fn().mockResolvedValue({}),