@stream-io/video-client 1.11.6 → 1.11.8

package/dist/src/coordinator/connection/client.d.ts

@@ -1,9 +1,7 @@
 import { AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios';
 import { StableWSConnection } from './connection';
 import { TokenManager } from './token_manager';
-import { WSConnectionFallback } from './connection_fallback';
 import { AllClientEvents, AllClientEventTypes, APIErrorResponse, ClientEventListener, ConnectAPIResponse, ErrorFromResponse, Logger, StreamClientOptions, StreamVideoEvent, TokenOrProvider, User, UserWithId } from './types';
-import { InsightMetrics } from './insights';
 import { ConnectedEvent, CreateGuestResponse } from '../../gen/coordinator';
 export declare class StreamClient {
     _user?: UserWithId;
@@ -27,11 +25,8 @@ export declare class StreamClient {
     userID?: string;
     wsBaseURL?: string;
     wsConnection: StableWSConnection | null;
-    wsFallback?: WSConnectionFallback;
     private wsPromiseSafe;
     consecutiveFailures: number;
-    insightMetrics: InsightMetrics;
-    defaultWSTimeoutWithFallback: number;
     defaultWSTimeout: number;
     resolveConnectionId?: Function;
     rejectConnectionId?: Function;
@@ -50,7 +45,6 @@ export declare class StreamClient {
      * @param {httpsAgent} [options.httpsAgent] - custom httpsAgent, in node it's default to https.agent()
      */
     constructor(key: string, options?: StreamClientOptions);
-    devToken: (userID: string) => string;
     getAuthType: () => "anonymous" | "jwt";
     setBaseURL: (baseURL: string) => void;
     getLocationHint: (hintUrl?: string, timeout?: number) => Promise<string>;
@@ -147,12 +141,6 @@ export declare class StreamClient {
      * @private
      */
     connect: () => Promise<ConnectedEvent | undefined>;
-    /**
-     * Check the connectivity with server for warmup purpose.
-     *
-     * @private
-     */
-    _sayHi: () => void;
     getUserAgent: () => string;
     setUserAgent: (userAgent: string) => void;
     /**
@@ -165,12 +153,6 @@ export declare class StreamClient {
         publicEndpoint?: boolean;
     }) => AxiosRequestConfig;
     _getToken: () => string | null | undefined;
-    /**
-     * encode ws url payload
-     * @private
-     * @returns json string
-     */
-    _buildWSPayload: (client_request_id?: string) => string;
     updateNetworkConnectionStatus: (event: {
         type: "online" | "offline";
     } | Event) => void;

package/dist/src/coordinator/connection/connection.d.ts

@@ -1,4 +1,3 @@
-import WebSocket from 'isomorphic-ws';
 import { StreamClient } from './client';
 import type { LogLevel, UR } from './types';
 import type { ConnectedEvent } from '../../gen/coordinator';
@@ -22,7 +21,6 @@ import type { ConnectedEvent } from '../../gen/coordinator';
 export declare class StableWSConnection {
     connectionID?: string;
     private connectionOpenSafe?;
-    authenticationSent: boolean;
     consecutiveFailures: number;
     pingInterval: number;
     healthCheckTimeoutRef?: NodeJS.Timeout;
@@ -96,27 +94,21 @@ export declare class StableWSConnection {
      */
     onlineStatusChanged: (event: Event) => void;
     onopen: (wsID: number) => void;
-    onmessage: (wsID: number, event: WebSocket.MessageEvent) => void;
-    onclose: (wsID: number, event: WebSocket.CloseEvent) => void;
-    onerror: (wsID: number, event: WebSocket.ErrorEvent) => void;
+    onmessage: (wsID: number, event: MessageEvent) => void;
+    onclose: (wsID: number, event: CloseEvent) => void;
+    onerror: (wsID: number, event: Event) => void;
     /**
      * _setHealth - Sets the connection to healthy or unhealthy.
      * Broadcasts an event in case the connection status changed.
      *
      * @param {boolean} healthy boolean indicating if the connection is healthy or not
      * @param {boolean} dispatchImmediately boolean indicating to dispatch event immediately even if the connection is unhealthy
-     *
      */
     _setHealth: (healthy: boolean, dispatchImmediately?: boolean) => void;
     /**
      * _errorFromWSEvent - Creates an error object for the WS event
-     *
      */
-    _errorFromWSEvent: (event: WebSocket.CloseEvent | WebSocket.Data | WebSocket.ErrorEvent, isWSFailure?: boolean) => Error & {
-        code?: string | number;
-        isWSFailure?: boolean;
-        StatusCode?: string | number;
-    };
+    private _errorFromWSEvent;
     /**
      * _destroyCurrentWSConnection - Removes the current WS connection
      *

package/dist/src/coordinator/connection/signing.d.ts

@@ -1,7 +1 @@
-/**
- *
- * @param {string} userId the id of the user
- * @return {string}
- */
-export declare function DevToken(userId: string): string;
-export declare function UserFromToken(token: string): string;
+export declare function getUserFromToken(token: string): string | undefined;

package/dist/src/coordinator/connection/token_manager.d.ts

@@ -13,8 +13,6 @@ export declare class TokenManager {
     user?: UserWithId;
     /**
      * Constructor
-     *
-     * @param {Secret} secret
      */
     constructor(secret?: string);
     /**

package/dist/src/coordinator/connection/types.d.ts

@@ -1,5 +1,4 @@
 import { AxiosRequestConfig, AxiosResponse } from 'axios';
-import { StableWSConnection } from './connection';
 import { ConnectedEvent, UserRequest, WSEvent } from '../../gen/coordinator';
 import { AllSfuEvents } from '../../rtc';
 export type UR = Record<string, unknown>;
@@ -90,9 +89,6 @@ export type StreamClientOptions = Partial<AxiosRequestConfig> & {
      */
     baseURL?: string;
     browser?: boolean;
-    enableInsights?: boolean;
-    /** experimental feature, please contact support if you want this feature enabled for you */
-    enableWSFallback?: boolean;
     logger?: Logger;
     logLevel?: LogLevel;
     /**
@@ -118,8 +114,11 @@ export type StreamClientOptions = Partial<AxiosRequestConfig> & {
      * The secret key for the API key. This is only needed for server side authentication.
      */
     secret?: string;
-    warmUp?: boolean;
-    wsConnection?: StableWSConnection;
+    /**
+     * The WebSocket implementation to use. This is mainly useful for testing.
+     * In Node.js environment, you can use the `ws` package.
+     */
+    WebSocketImpl?: typeof WebSocket;
 };
 export type TokenProvider = () => Promise<string>;
 export type TokenOrProvider = null | string | TokenProvider | undefined;

package/dist/src/coordinator/connection/utils.d.ts

@@ -1,5 +1,7 @@
-import { Logger } from './types';
-export declare const sleep: (m: number) => Promise<void>;
+import type { AxiosResponse } from 'axios';
+import type { APIErrorResponse } from './types';
+import type { ConnectionErrorEvent } from '../../gen/coordinator';
+export declare const sleep: (m: number) => Promise<unknown>;
 export declare function isFunction<T>(value: Function | T): value is Function;
 /**
  * A map of known error codes.
@@ -18,18 +20,14 @@ export declare const KnownCodes: {
 export declare function retryInterval(numberOfFailures: number): number;
 export declare function randomId(): string;
 export declare function generateUUIDv4(): string;
-export declare function convertErrorToJson(err: Error): Record<string, unknown>;
 /**
  * Informs if a promise is yet to be resolved or rejected
  */
 export declare function isPromisePending<T>(promise: Promise<T>): Promise<boolean>;
-/**
- * isOnline safely return the navigator.online value for browser env
- * if navigator is not in global object, it always return true
- */
-export declare function isOnline(logger: Logger): boolean;
 /**
  * listenForConnectionChanges - Adds an event listener fired on browser going online or offline
  */
 export declare function addConnectionEventListeners(cb: (e: Event) => void): void;
 export declare function removeConnectionEventListeners(cb: (e: Event) => void): void;
+export declare function isErrorResponse(res: AxiosResponse<unknown>): res is AxiosResponse<APIErrorResponse>;
+export declare function isCloseEvent(res: CloseEvent | ConnectionErrorEvent): res is CloseEvent;

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

@@ -7,7 +7,7 @@ import type { PreferredCodec } from '../types';
  * @param codecToRemove the codec to exclude from the list.
  * @param codecPreferencesSource the source of the codec preferences.
  */
-export declare const getPreferredCodecs: (kind: "audio" | "video", preferredCodec: string, codecToRemove?: string, codecPreferencesSource?: "sender" | "receiver") => RTCRtpCodec[] | undefined;
+export declare const getPreferredCodecs: (kind: "audio" | "video", preferredCodec: string, codecToRemove: string | undefined, codecPreferencesSource: "sender" | "receiver") => RTCRtpCodec[] | undefined;
 /**
  * Returns a generic SDP for the given direction.
  * We use this SDP to send it as part of our JoinRequest so that the SFU

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stream-io/video-client",
-  "version": "1.11.6",
+  "version": "1.11.8",
   "packageManager": "yarn@3.2.4",
   "main": "dist/index.cjs.js",
   "module": "dist/index.es.js",
@@ -31,15 +31,11 @@
     "@protobuf-ts/runtime": "^2.9.4",
     "@protobuf-ts/runtime-rpc": "^2.9.4",
     "@protobuf-ts/twirp-transport": "^2.9.4",
-    "@types/ws": "^8.5.7",
-    "axios": "^1.6.0",
-    "base64-js": "^1.5.1",
-    "isomorphic-ws": "^5.0.0",
+    "axios": "^1.7.7",
     "rxjs": "~7.8.1",
     "sdp-transform": "^2.14.1",
     "ua-parser-js": "^1.0.36",
-    "webrtc-adapter": "^8.2.3",
-    "ws": "^8.14.2"
+    "webrtc-adapter": "^8.2.3"
   },
   "devDependencies": {
     "@openapitools/openapi-generator-cli": "^2.13.4",
@@ -49,7 +45,7 @@
     "@stream-io/node-sdk": "^0.4.3",
     "@types/sdp-transform": "^2.4.7",
     "@types/ua-parser-js": "^0.7.37",
-    "@vitest/coverage-v8": "^0.34.4",
+    "@vitest/coverage-v8": "^2.1.4",
     "dotenv": "^16.3.1",
     "happy-dom": "^11.0.2",
     "prettier": "^3.3.2",
@@ -57,7 +53,7 @@
     "rollup": "^4.22.0",
     "typescript": "^5.5.2",
     "vite": "^5.4.6",
-    "vitest": "^1.0.0",
-    "vitest-mock-extended": "^1.2.1"
+    "vitest": "^2.1.4",
+    "vitest-mock-extended": "^2.0.2"
   }
 }

package/src/__tests__/Call.test.ts

@@ -10,7 +10,7 @@ import {
 import { StreamVideoClient } from '../StreamVideoClient';
 import 'dotenv/config';
 import { StreamClient } from '@stream-io/node-sdk';
-import { generateUUIDv4 } from '../coordinator/connection/utils';
+import { generateUUIDv4, sleep } from '../coordinator/connection/utils';
 import { CallingState } from '../store';
 import { Dispatcher } from '../rtc';
 import { Call } from '../Call';
@@ -22,7 +22,7 @@ const secret = process.env.STREAM_SECRET!;
 const serverClient = new StreamClient(apiKey, secret);
 const userId = 'jane';
 const tokenProvider = async () =>
-  serverClient.createToken(userId, undefined, Date.now() / 1000 - 10);
+  serverClient.generateUserToken({ user_id: userId, role: 'user' });
 
 let client: StreamVideoClient;
 
@@ -34,6 +34,7 @@ beforeEach(async () => {
     user: { id: 'jane' },
   });
 
+  await sleep(50);
   await client.streamClient.wsPromise;
 });
 

package/src/coordinator/connection/client.ts

@@ -1,27 +1,22 @@
 import axios, {
   AxiosError,
-  AxiosHeaders,
   AxiosInstance,
   AxiosRequestConfig,
   AxiosResponse,
 } from 'axios';
 import https from 'https';
 import { StableWSConnection } from './connection';
-import { DevToken } from './signing';
 import { TokenManager } from './token_manager';
-import { WSConnectionFallback } from './connection_fallback';
-import { isErrorResponse, isWSFailure } from './errors';
 import {
   addConnectionEventListeners,
+  isErrorResponse,
   isFunction,
-  isOnline,
   KnownCodes,
   randomId,
   removeConnectionEventListeners,
   retryInterval,
   sleep,
 } from './utils';
-
 import {
   AllClientEvents,
   AllClientEventTypes,
@@ -36,7 +31,6 @@ import {
   User,
   UserWithId,
 } from './types';
-import { InsightMetrics, postInsights } from './insights';
 import { getLocationHint } from './location';
 import {
   ConnectedEvent,
@@ -71,11 +65,8 @@ export class StreamClient {
   userID?: string;
   wsBaseURL?: string;
   wsConnection: StableWSConnection | null;
-  wsFallback?: WSConnectionFallback;
   private wsPromiseSafe: SafePromise<ConnectedEvent | undefined> | null;
   consecutiveFailures: number;
-  insightMetrics: InsightMetrics;
-  defaultWSTimeoutWithFallback: number;
   defaultWSTimeout: number;
   resolveConnectionId?: Function;
   rejectConnectionId?: Function;
@@ -122,7 +113,6 @@ export class StreamClient {
     this.options = {
       timeout: 5000,
       withCredentials: false, // making sure cookies are not sent
-      warmUp: false,
       ...inputOptions,
     };
 
@@ -137,22 +127,6 @@ export class StreamClient {
       this.options.baseURL || 'https://video.stream-io-api.com/video',
     );
 
-    if (
-      typeof process !== 'undefined' &&
-      'env' in process &&
-      process.env.STREAM_LOCAL_TEST_RUN
-    ) {
-      this.setBaseURL('http://localhost:3030/video');
-    }
-
-    if (
-      typeof process !== 'undefined' &&
-      'env' in process &&
-      process.env.STREAM_LOCAL_TEST_HOST
-    ) {
-      this.setBaseURL(`http://${process.env.STREAM_LOCAL_TEST_HOST}/video`);
-    }
-
     this.axiosInstance = axios.create({
       ...this.options,
       baseURL: this.baseURL,
@@ -172,9 +146,7 @@ export class StreamClient {
     // generated from secret.
     this.tokenManager = new TokenManager(this.secret);
     this.consecutiveFailures = 0;
-    this.insightMetrics = new InsightMetrics();
 
-    this.defaultWSTimeoutWithFallback = 6000;
     this.defaultWSTimeout = 15000;
 
     this.logger = isFunction(inputOptions.logger)
@@ -182,10 +154,6 @@ export class StreamClient {
       : () => null;
   }
 
-  devToken = (userID: string) => {
-    return DevToken(userID);
-  };
-
   getAuthType = () => {
     return this.anonymous ? 'anonymous' : 'jwt';
   };
@@ -212,8 +180,7 @@ export class StreamClient {
     return hint;
   };
 
-  _getConnectionID = () =>
-    this.wsConnection?.connectionID || this.wsFallback?.connectionID;
+  _getConnectionID = () => this.wsConnection?.connectionID;
 
   _hasConnectionID = () => Boolean(this._getConnectionID());
 
@@ -328,11 +295,7 @@ export class StreamClient {
    *                https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent
    */
   closeConnection = async (timeout?: number) => {
-    await Promise.all([
-      this.wsConnection?.disconnect(timeout),
-      this.wsFallback?.disconnect(timeout),
-    ]);
-    return Promise.resolve();
+    await this.wsConnection?.disconnect(timeout);
   };
 
   /**
@@ -354,10 +317,7 @@ export class StreamClient {
       return await wsPromise;
     }
 
-    if (
-      (this.wsConnection?.isHealthy || this.wsFallback?.isHealthy()) &&
-      this._hasConnectionID()
-    ) {
+    if (this.wsConnection?.isHealthy && this._hasConnectionID()) {
       this.logger(
         'info',
         'client:openConnection() - openConnection called twice, healthy connection already exists',
@@ -366,7 +326,7 @@ export class StreamClient {
       return;
     }
 
-    this._setupConnectionIdPromise();
+    await this._setupConnectionIdPromise();
 
     this.clientID = `${this.userID}--${randomId()}`;
     const newWsPromise = this.connect();
@@ -404,16 +364,7 @@ export class StreamClient {
     this.guestUserCreatePromise = this.doAxiosRequest<
       CreateGuestResponse,
       CreateGuestRequest
-    >(
-      'post',
-      '/guest',
-      {
-        user: {
-          ...user,
-        },
-      },
-      { publicEndpoint: true },
-    );
+    >('post', '/guest', { user }, { publicEndpoint: true });
 
     const response = await this.guestUserCreatePromise;
     this.guestUserCreatePromise.finally(
@@ -431,7 +382,7 @@ export class StreamClient {
     tokenOrProvider: TokenOrProvider,
   ) => {
     addConnectionEventListeners(this.updateNetworkConnectionStatus);
-    this._setupConnectionIdPromise();
+    await this._setupConnectionIdPromise();
 
     this.anonymous = true;
     await this._setToken(user, tokenOrProvider, this.anonymous);
@@ -705,89 +656,14 @@ export class StreamClient {
         'Call connectUser or connectAnonymousUser before starting the connection',
       );
     }
-    if (!this.wsBaseURL) {
-      throw Error('Websocket base url not set');
-    }
-    if (!this.clientID) {
-      throw Error('clientID is not set');
-    }
+    if (!this.wsBaseURL) throw Error('Websocket base url not set');
+    if (!this.clientID) throw Error('clientID is not set');
 
-    if (
-      !this.wsConnection &&
-      (this.options.warmUp || this.options.enableInsights)
-    ) {
-      this._sayHi();
-    }
     // The StableWSConnection handles all the reconnection logic.
-    if (this.options.wsConnection && this.node) {
-      // Intentionally avoiding adding ts generics on wsConnection in options since its only useful for unit test purpose.
-      (this.options.wsConnection as unknown as StableWSConnection).setClient(
-        this,
-      );
-      this.wsConnection = this.options
-        .wsConnection as unknown as StableWSConnection;
-    } else {
-      this.wsConnection = new StableWSConnection(this);
-    }
+    this.wsConnection = new StableWSConnection(this);
 
-    try {
-      // if fallback is used before, continue using it instead of waiting for WS to fail
-      if (this.wsFallback) {
-        return await this.wsFallback.connect();
-      }
-      this.logger('info', 'StreamClient.connect: this.wsConnection.connect()');
-      // if WSFallback is enabled, ws connect should timeout faster so fallback can try
-      return await this.wsConnection.connect(
-        this.options.enableWSFallback
-          ? this.defaultWSTimeoutWithFallback
-          : this.defaultWSTimeout,
-      );
-    } catch (err) {
-      // run fallback only if it's WS/Network error and not a normal API error
-      // make sure browser is online before even trying the longpoll
-      if (
-        this.options.enableWSFallback &&
-        // @ts-ignore
-        isWSFailure(err) &&
-        isOnline(this.logger)
-      ) {
-        this.logger(
-          'warn',
-          'client:connect() - WS failed, fallback to longpoll',
-        );
-        this.dispatchEvent({ type: 'transport.changed', mode: 'longpoll' });
-
-        this.wsConnection._destroyCurrentWSConnection();
-        this.wsConnection.disconnect().then(); // close WS so no retry
-        this.wsFallback = new WSConnectionFallback(this);
-        return await this.wsFallback.connect();
-      }
-
-      throw err;
-    }
-  };
-
-  /**
-   * Check the connectivity with server for warmup purpose.
-   *
-   * @private
-   */
-  _sayHi = () => {
-    const client_request_id = randomId();
-    const opts = {
-      headers: AxiosHeaders.from({
-        'x-client-request-id': client_request_id,
-      }),
-    };
-    this.doAxiosRequest('get', this.baseURL + '/hi', null, opts).catch((e) => {
-      if (this.options.enableInsights) {
-        postInsights('http_hi_failed', {
-          api_key: this.key,
-          err: e,
-          client_request_id,
-        });
-      }
-    });
+    this.logger('info', 'StreamClient.connect: this.wsConnection.connect()');
+    return await this.wsConnection.connect(this.defaultWSTimeout);
   };
 
   getUserAgent = () => {
@@ -856,19 +732,6 @@ export class StreamClient {
     return this.tokenManager.getToken();
   };
 
-  /**
-   * encode ws url payload
-   * @private
-   * @returns json string
-   */
-  _buildWSPayload = (client_request_id?: string) => {
-    return JSON.stringify({
-      user_id: this.userID,
-      user_details: this._user,
-      client_request_id,
-    });
-  };
-
   updateNetworkConnectionStatus = (
     event: { type: 'online' | 'offline' } | Event,
   ) => {