@stream-io/video-client 1.54.1-beta.0 → 1.55.1

package/src/coordinator/connection/connection.ts

@@ -66,13 +66,14 @@ export class StableWSConnection {
   consecutiveFailures = 0;
   /** keep track of the total number of failures */
   totalFailures = 0;
+  lastConnectionError?: WSConnectionError;
 
   // Health-check pings + connection-staleness check.
   /** Send a health check message every 25 seconds */
   pingInterval = 25 * 1000;
   healthCheckTimeoutRef?: number;
   connectionCheckTimeout = this.pingInterval + 10 * 1000;
-  connectionCheckTimeoutRef?: NodeJS.Timeout;
+  connectionCheckTimeoutRef?: number;
   /** Store the last event time for health checks */
   lastEvent: Date | null = null;
 
@@ -102,6 +103,7 @@ export class StableWSConnection {
     }
 
     this.isDisconnected = false;
+    this.lastConnectionError = undefined;
 
     try {
       const healthCheck = await this._connect(timeout);
@@ -140,6 +142,7 @@ export class StableWSConnection {
         // _connect()'s catch) keeps a single failure from spawning two
         // parallel chains - one from this catch and one from _reconnect's
         // own catch when _connect was called from there.
+        this.lastConnectionError = error;
         this._reconnect();
       }
     }
@@ -174,18 +177,27 @@ export class StableWSConnection {
             await sleep(interval);
           }
         }
+        return undefined;
       })(),
       (async () => {
         await sleep(timeout);
         this.isConnecting = false;
-        throw new Error(
-          JSON.stringify({
-            code: '',
-            StatusCode: '',
-            message: 'initial WS connection could not be established',
-            isWSFailure: true,
-          }),
-        );
+        const e = this.lastConnectionError;
+        const errorPayload = e
+          ? {
+              code: e.code,
+              StatusCode: e.StatusCode,
+              message: e.message,
+              isWSFailure: e.isWSFailure,
+            }
+          : {
+              code: '',
+              StatusCode: '',
+              message: 'initial WS connection could not be established',
+              isWSFailure: true,
+            };
+
+        throw new Error(JSON.stringify(errorPayload));
       })(),
     ]);
   };
@@ -221,7 +233,7 @@ export class StableWSConnection {
       getTimers().clearInterval(this.healthCheckTimeoutRef);
     }
     if (this.connectionCheckTimeoutRef) {
-      clearInterval(this.connectionCheckTimeoutRef);
+      getTimers().clearTimeout(this.connectionCheckTimeoutRef);
     }
 
     removeConnectionEventListeners(this.onlineStatusChanged);
@@ -372,8 +384,10 @@ export class StableWSConnection {
         this.client.resolveConnectionId?.(this.connectionID);
         return response;
       }
+      return undefined;
     } catch (caught) {
       const err = caught as WSConnectionError;
+      this.lastConnectionError = err;
       this.isConnecting = false;
       this._log(`_connect() - Error - `, err);
       // Reject THIS attempt's connection-id promise (P1) directly via the
@@ -579,7 +593,7 @@ export class StableWSConnection {
         code === KnownCodes.TOKEN_EXPIRED &&
         !this.client.tokenManager.isStatic()
       ) {
-        clearTimeout(this.connectionCheckTimeoutRef);
+        getTimers().clearTimeout(this.connectionCheckTimeoutRef);
         this._log(
           'connect() - WS failure due to expired token, so going to try to reload token and reconnect',
         );
@@ -769,8 +783,9 @@ export class StableWSConnection {
    * to be reconnected.
    */
   scheduleConnectionCheck = () => {
-    clearTimeout(this.connectionCheckTimeoutRef);
-    this.connectionCheckTimeoutRef = setTimeout(() => {
+    const timers = getTimers();
+    timers.clearTimeout(this.connectionCheckTimeoutRef);
+    this.connectionCheckTimeoutRef = timers.setTimeout(() => {
       const now = new Date();
       if (
         this.lastEvent &&

package/src/gen/video/sfu/event/events.ts

@@ -1,4 +1,3 @@
- 
 // @generated by protobuf-ts 2.10.0 with parameter long_type_string,client_generic,server_none,eslint_disable,optimize_code_size
 // @generated from protobuf file "video/sfu/event/events.proto" (package "stream.video.sfu.event", syntax proto3)
 // tslint:disable

package/src/gen/video/sfu/models/models.ts

@@ -1,4 +1,3 @@
- 
 // @generated by protobuf-ts 2.10.0 with parameter long_type_string,client_generic,server_none,eslint_disable,optimize_code_size
 // @generated from protobuf file "video/sfu/models/models.proto" (package "stream.video.sfu.models", syntax proto3)
 // tslint:disable

package/src/gen/video/sfu/signal_rpc/signal.client.ts

@@ -1,4 +1,3 @@
- 
 // @generated by protobuf-ts 2.10.0 with parameter long_type_string,client_generic,server_none,eslint_disable,optimize_code_size
 // @generated from protobuf file "video/sfu/signal_rpc/signal.proto" (package "stream.video.sfu.signal", syntax proto3)
 // tslint:disable

package/src/gen/video/sfu/signal_rpc/signal.ts

@@ -1,4 +1,3 @@
- 
 // @generated by protobuf-ts 2.10.0 with parameter long_type_string,client_generic,server_none,eslint_disable,optimize_code_size
 // @generated from protobuf file "video/sfu/signal_rpc/signal.proto" (package "stream.video.sfu.signal", syntax proto3)
 // tslint:disable

package/src/helpers/MediaPlaybackWatchdog.ts

@@ -93,6 +93,7 @@ export class MediaPlaybackWatchdog {
     const HAVE_CURRENT_DATA = 2;
     if (this.element.readyState < HAVE_CURRENT_DATA) return 'notReady';
     if (!this.element.paused) return 'notPaused';
+    return undefined;
   };
 
   private attemptPlay = async () => {

package/src/helpers/__tests__/browsers.test.ts

@@ -169,70 +169,70 @@ describe('browsers', () => {
 
     it('should return true for supported Chrome version', async () => {
       vi.mocked(getClientDetails).mockResolvedValue({
-        browser: { name: 'Chrome', version: '124' },
+        browser: { name: 'Chrome', version: '136' },
       } as ClientDetails);
       expect(await isSupportedBrowser()).toBe(true);
     });
 
     it('should return true for supported Chrome detailed version', async () => {
       vi.mocked(getClientDetails).mockResolvedValue({
-        browser: { name: 'Chrome', version: '124.0.7204.158' },
+        browser: { name: 'Chrome', version: '136.0.7204.158' },
       } as ClientDetails);
       expect(await isSupportedBrowser()).toBe(true);
     });
 
     it('should return false for unsupported Chrome version', async () => {
       vi.mocked(getClientDetails).mockResolvedValue({
-        browser: { name: 'Chrome', version: '123' },
+        browser: { name: 'Chrome', version: '135' },
       } as ClientDetails);
       expect(await isSupportedBrowser()).toBe(false);
     });
 
     it('should return false for unsupported Chrome detailed version', async () => {
       vi.mocked(getClientDetails).mockResolvedValue({
-        browser: { name: 'Chrome', version: '123.0.1234.99' },
+        browser: { name: 'Chrome', version: '135.0.1234.99' },
       } as ClientDetails);
       expect(await isSupportedBrowser()).toBe(false);
     });
 
     it('should return true for supported Edge version', async () => {
       vi.mocked(getClientDetails).mockResolvedValue({
-        browser: { name: 'Edge', version: '124' },
+        browser: { name: 'Edge', version: '136' },
       } as ClientDetails);
       expect(await isSupportedBrowser()).toBe(true);
     });
 
     it('should return false for unsupported Edge version', async () => {
       vi.mocked(getClientDetails).mockResolvedValue({
-        browser: { name: 'Edge', version: '123' },
+        browser: { name: 'Edge', version: '135' },
       } as ClientDetails);
       expect(await isSupportedBrowser()).toBe(false);
     });
 
     it('should return true for supported Firefox version', async () => {
       vi.mocked(getClientDetails).mockResolvedValue({
-        browser: { name: 'Firefox', version: '124' },
+        browser: { name: 'Firefox', version: '137' },
       } as ClientDetails);
       expect(await isSupportedBrowser()).toBe(true);
     });
 
     it('should return false for unsupported Firefox version', async () => {
       vi.mocked(getClientDetails).mockResolvedValue({
-        browser: { name: 'Firefox', version: '123' },
+        browser: { name: 'Firefox', version: '136' },
       } as ClientDetails);
       expect(await isSupportedBrowser()).toBe(false);
     });
 
     it('should return true for supported Safari version', async () => {
       vi.mocked(getClientDetails).mockResolvedValue({
-        browser: { name: 'Safari', version: '17' },
+        browser: { name: 'Safari', version: '18' },
       } as ClientDetails);
       expect(await isSupportedBrowser()).toBe(true);
     });
 
     it('should return false for unsupported Safari version', async () => {
       vi.mocked(getClientDetails).mockResolvedValue({
-        browser: { name: 'Safari', version: '16' },
+        browser: { name: 'Safari', version: '17' },
       } as ClientDetails);
       expect(await isSupportedBrowser()).toBe(false);
     });
@@ -253,14 +253,14 @@ describe('browsers', () => {
 
     it('should return true for supported WebView version (WebView on Android)', async () => {
       vi.mocked(getClientDetails).mockResolvedValue({
-        browser: { name: 'WebView', version: '124' },
+        browser: { name: 'WebView', version: '136' },
       } as ClientDetails);
       expect(await isSupportedBrowser()).toBe(true);
     });
 
     it('should return false for unsupported WebView version (WebView on Android)', async () => {
       vi.mocked(getClientDetails).mockResolvedValue({
-        browser: { name: 'WebView', version: '123' },
+        browser: { name: 'WebView', version: '135' },
       } as ClientDetails);
       expect(await isSupportedBrowser()).toBe(false);
     });

package/src/helpers/browsers.ts

@@ -62,11 +62,11 @@ export const isSupportedBrowser = async (): Promise<boolean> => {
   const [major] = browser.version.split('.');
   const version = parseInt(major, 10);
   return (
-    (name.includes('chrome') && version >= 124) ||
-    (name.includes('edge') && version >= 124) ||
-    (name.includes('firefox') && version >= 124) ||
-    (name.includes('safari') && version >= 17) ||
+    (name.includes('chrome') && version >= 136) ||
+    (name.includes('edge') && version >= 136) ||
+    (name.includes('firefox') && version >= 137) ||
+    (name.includes('safari') && version >= 18) ||
     (name.includes('webkit') && version >= 605) || // WebView on iOS
-    (name.includes('webview') && version >= 124) // WebView on Android
+    (name.includes('webview') && version >= 136) // WebView on Android
   );
 };

package/src/helpers/client-details.ts

@@ -192,6 +192,6 @@ export const getClientDetails = async (): Promise<ClientDetails> => {
         .join(' '),
       version: '',
     },
-    webrtcVersion: webRtcInfo?.version || '',
+    webrtcVersion: browserVersion,
   };
 };

package/src/reporting/ClientEventReporter.ts

@@ -219,7 +219,7 @@ export class ClientEventReporter {
       joinAttemptIdSnapshot: this.joinAttemptIds.get(cid),
     };
 
-    this.send({
+    this.sendForCall(cid, {
       ...this.buildCommon(cid, 'MediaDevicePermission', pair),
       ...this.sessionIdField(cid),
       microphone_permission_status: readPermissionStatus(
@@ -322,7 +322,7 @@ export class ClientEventReporter {
     };
 
     const resolvedSfuId = this.getSfuId(cid);
-    this.send({
+    this.sendForCall(cid, {
       ...this.buildCommon(cid, stage, pair),
       ...this.sessionIdField(cid),
       ...(resolvedSfuId && { sfu_id: resolvedSfuId }),
@@ -395,7 +395,7 @@ export class ClientEventReporter {
     const coordinatorConnectId = this.coordinatorConnectId;
     const ctx = this.callContexts.get(cid);
 
-    this.send({
+    this.sendForCall(cid, {
       user_id: this.streamClient.userID || this.coordinatorConnectUserId,
       type: ctx?.callType,
       id: ctx?.callId,
@@ -454,7 +454,7 @@ export class ClientEventReporter {
         joinReasonSnapshot: this.joinReasons.get(cid),
       };
       this.coordinatorPairs.set(cid, pair);
-      this.send({
+      this.sendForCall(cid, {
         ...this.buildCommon(cid, 'CoordinatorJoin', pair),
         ...(pair.joinReasonSnapshot && {
           join_reason: pair.joinReasonSnapshot,
@@ -469,7 +469,7 @@ export class ClientEventReporter {
   private succeedCoordinator = (cid: string) => {
     const pair = this.coordinatorPairs.get(cid);
     if (!pair) return;
-    this.send({
+    this.sendForCall(cid, {
       ...this.buildCommon(cid, 'CoordinatorJoin', pair),
       ...this.sessionIdField(cid),
       ...(pair.joinReasonSnapshot && { join_reason: pair.joinReasonSnapshot }),
@@ -488,7 +488,7 @@ export class ClientEventReporter {
       return;
     }
     const { reason, code } = pair.lastError;
-    this.send({
+    this.sendForCall(cid, {
       ...this.buildCommon(cid, 'CoordinatorJoin', pair),
       ...this.sessionIdField(cid),
       ...(pair.joinReasonSnapshot && { join_reason: pair.joinReasonSnapshot }),
@@ -513,7 +513,7 @@ export class ClientEventReporter {
       };
       this.wsPairs.set(cid, pair);
       const sfuId = this.getSfuId(cid);
-      this.send({
+      this.sendForCall(cid, {
         ...this.buildCommon(cid, 'WSJoin', pair),
         ...this.sessionIdField(cid),
         ...(sfuId && { sfu_id: sfuId }),
@@ -529,7 +529,7 @@ export class ClientEventReporter {
     const pair = this.wsPairs.get(cid);
     if (!pair) return;
     const sfuId = this.getSfuId(cid);
-    this.send({
+    this.sendForCall(cid, {
       ...this.buildCommon(cid, 'WSJoin', pair),
       ...this.sessionIdField(cid),
       ...(sfuId && { sfu_id: sfuId }),
@@ -552,7 +552,7 @@ export class ClientEventReporter {
     const { reason, code } = pair.lastError;
     const sfuId = this.getSfuId(cid);
 
-    this.send({
+    this.sendForCall(cid, {
       ...this.buildCommon(cid, 'WSJoin', pair),
       ...this.sessionIdField(cid),
       event_type: 'completed',
@@ -627,7 +627,7 @@ export class ClientEventReporter {
     };
     this.peerConnectionPairs.set(key, pair);
 
-    this.send({
+    this.sendForCall(cid, {
       ...this.buildCommon(cid, 'PeerConnectionConnect', pair),
       ...this.sessionIdField(cid),
       peer_connection: role,
@@ -648,7 +648,7 @@ export class ClientEventReporter {
     const pair = this.peerConnectionPairs.get(key);
     if (!pair) return;
 
-    this.send({
+    this.sendForCall(cid, {
       ...this.buildCommon(cid, 'PeerConnectionConnect', pair),
       ...this.sessionIdField(cid),
       peer_connection: role,
@@ -676,7 +676,7 @@ export class ClientEventReporter {
     const pair = this.peerConnectionPairs.get(key);
     if (!pair) return;
 
-    this.send({
+    this.sendForCall(cid, {
       ...this.buildCommon(cid, 'PeerConnectionConnect', pair),
       ...this.sessionIdField(cid),
       peer_connection: role,
@@ -738,6 +738,11 @@ export class ClientEventReporter {
     void this.sendWithRetry(body);
   };
 
+  private sendForCall = (cid: string, body: Record<string, unknown>) => {
+    if (!this.callContexts.has(cid)) return;
+    this.send(body);
+  };
+
   private sendWithRetry = async (
     body: Record<string, unknown>,
   ): Promise<boolean> => {

package/src/reporting/__tests__/ClientEventReporter.test.ts

@@ -617,6 +617,58 @@ describe('ClientEventReporter', () => {
     expect(ws1.every((e) => e.sfu_id === 'sfu-1')).toBe(true);
     expect(ws2.every((e) => e.sfu_id === 'sfu-2')).toBe(true);
   });
+
+  describe('drops events for an unregistered call', () => {
+    it('does not emit stage events after the call is unregistered', async () => {
+      reporter.startCorrelation(cid, 'first-attempt');
+      reporter.unregisterCall(cid);
+      await flush();
+      doAxiosRequest.mockClear();
+
+      await reporter.track(cid, 'WSJoin', () => Promise.resolve('ok'));
+      reporter.reportFirstFrame(cid, TrackType.VIDEO, 'track-1');
+      await flush();
+
+      expect(doAxiosRequest).not.toHaveBeenCalled();
+    });
+
+    it('does not emit a stage completion when unregistered mid-flight', async () => {
+      reporter.startCorrelation(cid, 'first-attempt');
+      await flush();
+      doAxiosRequest.mockClear();
+
+      await reporter.track(cid, 'WSJoin', async () => {
+        reporter.unregisterCall(cid);
+        return 'ok';
+      });
+      await flush();
+
+      const completed = postedEvents().filter(
+        (e) => e.stage === 'WSJoin' && e.event_type === 'completed',
+      );
+      expect(completed).toHaveLength(0);
+    });
+
+    it('does not emit JoinInitiated for an unregistered call', async () => {
+      reporter.unregisterCall(cid);
+      reporter.startCorrelation(cid, 'first-attempt');
+      await flush();
+
+      const joinInitiated = postedEvents().filter(
+        (e) => e.stage === 'JoinInitiated',
+      );
+      expect(joinInitiated).toHaveLength(0);
+    });
+
+    it('still emits CoordinatorWS events (connection-scoped, not call-gated)', async () => {
+      reporter.unregisterCall(cid);
+      await reporter.trackCoordinatorWs(() => Promise.resolve('ok'));
+      await flush();
+
+      const ws = postedEvents().filter((e) => e.stage === 'CoordinatorWS');
+      expect(ws.length).toBeGreaterThan(0);
+    });
+  });
 });
 
 describe('ClientEventReporter (disabled)', () => {

package/src/rtc/BasePeerConnection.ts

@@ -13,6 +13,7 @@ import { StreamSfuClient } from '../StreamSfuClient';
 import { AllSfuEvents, Dispatcher } from './Dispatcher';
 import { withoutConcurrency } from '../helpers/concurrency';
 import { StatsTracer, Tracer, traceRTCPeerConnection } from '../stats';
+import { toJSON } from './helpers/iceCandiates';
 import {
   BasePeerConnectionOpts,
   OnIceConnected,
@@ -37,7 +38,7 @@ export abstract class BasePeerConnection {
   protected tag: string;
   protected sfuClient: StreamSfuClient;
 
-  private onReconnectionNeeded?: OnReconnectionNeeded;
+  protected onReconnectionNeeded?: OnReconnectionNeeded;
   private onIceConnected?: OnIceConnected;
   private onPeerConnectionStateChange?: OnPeerConnectionStateChange;
   protected onRemoteTrackUnmute?: OnRemoteTrackUnmute;
@@ -224,11 +225,17 @@ export abstract class BasePeerConnection {
    * Appends the trickled ICE candidates to the `RTCPeerConnection`.
    */
   protected addTrickledIceCandidates = () => {
+    // Declare the ICE generation this negotiation established so the buffer
+    // only replays candidates of the current generation.
     const { iceTrickleBuffer } = this.sfuClient;
+    const sdp = this.pc.remoteDescription?.sdp;
+    iceTrickleBuffer.updateActiveGeneration(this.peerType, sdp);
+
+    const { subscriber, publisher } = iceTrickleBuffer;
     const observable =
       this.peerType === PeerType.SUBSCRIBER
-        ? iceTrickleBuffer.subscriberCandidates
-        : iceTrickleBuffer.publisherCandidates;
+        ? subscriber.candidates
+        : publisher.candidates;
 
     this.unsubscribeIceTrickle?.();
     this.unsubscribeIceTrickle = createSafeAsyncSubscription(
@@ -283,20 +290,6 @@ export abstract class BasePeerConnection {
     return !failedStates.has(iceState) && !failedStates.has(connectionState);
   };
 
-  /**
-   * Returns true only when the peer connection is currently fully established
-   * (ICE `connected`/`completed` AND connection state `connected`).
-   * Transient states like `disconnected`, `checking`, or `new` return false.
-   */
-  isStable = () => {
-    const iceState = this.pc.iceConnectionState;
-    const connectionState = this.pc.connectionState;
-    return (
-      (iceState === 'connected' || iceState === 'completed') &&
-      connectionState === 'connected'
-    );
-  };
-
   /**
    * Handles the ICECandidate event and
    * Initiates an ICE Trickle process with the SFU.
@@ -308,7 +301,7 @@ export abstract class BasePeerConnection {
       return;
     }
 
-    const iceCandidate = this.asJSON(candidate);
+    const iceCandidate = toJSON(candidate);
     this.sfuClient
       .iceTrickle({ peerType: this.peerType, iceCandidate })
       .catch((err) => {
@@ -317,20 +310,6 @@ export abstract class BasePeerConnection {
       });
   };
 
-  /**
-   * Converts the ICE candidate to a JSON string.
-   */
-  private asJSON = (candidate: RTCIceCandidate): string => {
-    if (!candidate.usernameFragment) {
-      // react-native-webrtc doesn't include usernameFragment in the candidate
-      const segments = candidate.candidate.split(' ');
-      const ufragIndex = segments.findIndex((s) => s === 'ufrag') + 1;
-      const usernameFragment = segments[ufragIndex];
-      return JSON.stringify({ ...candidate, usernameFragment });
-    }
-    return JSON.stringify(candidate.toJSON());
-  };
-
   /**
    * Handles the ConnectionStateChange event.
    */
@@ -343,8 +322,10 @@ export abstract class BasePeerConnection {
     });
     if (this.tracer && (state === 'connected' || state === 'failed')) {
       try {
-        const stats = await this.stats.get();
-        this.tracer.trace('getstats', stats.delta);
+        // Sample stats into the delivery chain at connect/fail. The reporter
+        // ships and commits the un-acked chain, so we must not trace the delta
+        // separately here (that would double-send it and corrupt the chain).
+        await this.stats.takeSample();
       } catch (err) {
         this.tracer.trace('getstatsOnFailure', (err as Error).toString());
       }