Add explicit error types for future helper (#1753)

Author: lukasIO

.changeset/shaggy-donuts-hammer.md

@@ -0,0 +1,5 @@
+---
+"livekit-client": patch
+---
+
+Add explicit error types for future helper

src/e2ee/E2eeManager.ts

@@ -68,9 +68,11 @@ export class E2EEManager
 
   private keyProvider: BaseKeyProvider;
 
-  private decryptDataRequests: Map<string, Future<DecryptDataResponseMessage['data']>> = new Map();
+  private decryptDataRequests: Map<string, Future<DecryptDataResponseMessage['data'], Error>> =
+    new Map();
 
-  private encryptDataRequests: Map<string, Future<EncryptDataResponseMessage['data']>> = new Map();
+  private encryptDataRequests: Map<string, Future<EncryptDataResponseMessage['data'], Error>> =
+    new Map();
 
   private dataChannelEncryptionEnabled: boolean;
 
@@ -322,7 +324,7 @@ export class E2EEManager
         participantIdentity: this.room!.localParticipant.identity,
       },
     };
-    const future = new Future<EncryptDataResponseMessage['data']>();
+    const future = new Future<EncryptDataResponseMessage['data'], Error>();
     future.onFinally = () => {
       this.encryptDataRequests.delete(uuid);
     };
@@ -351,7 +353,7 @@ export class E2EEManager
         keyIndex,
       },
     };
-    const future = new Future<DecryptDataResponseMessage['data']>();
+    const future = new Future<DecryptDataResponseMessage['data'], Error>();
     future.onFinally = () => {
       this.decryptDataRequests.delete(uuid);
     };

src/room/Room.ts

@@ -169,7 +169,7 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
   private abortController?: AbortController;
 
   /** future holding client initiated connection attempt */
-  private connectFuture?: Future<void>;
+  private connectFuture?: Future<void, Error>;
 
   private disconnectLock: Mutex;
 

src/room/data-stream/incoming/IncomingDataStreamManager.ts

@@ -121,7 +121,7 @@ export default class IncomingDataStreamManager {
       }
 
       let streamController: ReadableStreamDefaultController<DataStream_Chunk>;
-      const outOfBandFailureRejectingFuture = new Future<never>();
+      const outOfBandFailureRejectingFuture = new Future<never, Error>();
       outOfBandFailureRejectingFuture.promise.catch((err) => {
         this.log.error(err);
       });
@@ -178,7 +178,7 @@ export default class IncomingDataStreamManager {
       }
 
       let streamController: ReadableStreamDefaultController<DataStream_Chunk>;
-      const outOfBandFailureRejectingFuture = new Future<never>();
+      const outOfBandFailureRejectingFuture = new Future<never, Error>();
       outOfBandFailureRejectingFuture.promise.catch((err) => {
         this.log.error(err);
       });

src/room/data-stream/incoming/StreamReader.ts

@@ -17,7 +17,7 @@ abstract class BaseStreamReader<T extends BaseStreamInfo> {
 
   protected bytesReceived: number;
 
-  protected outOfBandFailureRejectingFuture?: Future<never>;
+  protected outOfBandFailureRejectingFuture?: Future<never, Error>;
 
   get info() {
     return this._info;
@@ -46,7 +46,7 @@ abstract class BaseStreamReader<T extends BaseStreamInfo> {
     info: T,
     stream: ReadableStream<DataStream_Chunk>,
     totalByteSize?: number,
-    outOfBandFailureRejectingFuture?: Future<never>,
+    outOfBandFailureRejectingFuture?: Future<never, Error>,
   ) {
     this.reader = stream;
     this.totalByteSize = totalByteSize;
@@ -80,7 +80,7 @@ export class ByteStreamReader extends BaseStreamReader<ByteStreamInfo> {
   [Symbol.asyncIterator]() {
     const reader = this.reader.getReader();
 
-    let rejectingSignalFuture = new Future<never>();
+    let rejectingSignalFuture = new Future<never, Error>();
     let activeSignal: AbortSignal | null = null;
     let onAbort: (() => void) | null = null;
     if (this.signal) {
@@ -175,7 +175,7 @@ export class TextStreamReader extends BaseStreamReader<TextStreamInfo> {
     info: TextStreamInfo,
     stream: ReadableStream<DataStream_Chunk>,
     totalChunkCount?: number,
-    outOfBandFailureRejectingFuture?: Future<never>,
+    outOfBandFailureRejectingFuture?: Future<never, Error>,
   ) {
     super(info, stream, totalChunkCount, outOfBandFailureRejectingFuture);
     this.receivedChunks = new Map();
@@ -213,7 +213,7 @@ export class TextStreamReader extends BaseStreamReader<TextStreamInfo> {
     const reader = this.reader.getReader();
     const decoder = new TextDecoder('utf-8', { fatal: true });
 
-    let rejectingSignalFuture = new Future<never>();
+    let rejectingSignalFuture = new Future<never, Error>();
     let activeSignal: AbortSignal | null = null;
     let onAbort: (() => void) | null = null;
     if (this.signal) {

src/room/participant/LocalParticipant.ts

@@ -137,11 +137,11 @@ export default class LocalParticipant extends Participant {
 
   private encryptionType: Encryption_Type = Encryption_Type.NONE;
 
-  private reconnectFuture?: Future<void>;
+  private reconnectFuture?: Future<void, Error>;
 
-  private signalConnectedFuture?: Future<void>;
+  private signalConnectedFuture?: Future<void, Error>;
 
-  private activeAgentFuture?: Future<RemoteParticipant>;
+  private activeAgentFuture?: Future<RemoteParticipant, Error>;
 
   private firstActiveAgent?: RemoteParticipant;
 
@@ -262,7 +262,7 @@ export default class LocalParticipant extends Participant {
 
   private handleReconnecting = () => {
     if (!this.reconnectFuture) {
-      this.reconnectFuture = new Future<void>();
+      this.reconnectFuture = new Future<void, Error>();
     }
   };
 
@@ -275,15 +275,15 @@ export default class LocalParticipant extends Participant {
   private handleClosing = () => {
     if (this.reconnectFuture) {
       this.reconnectFuture.promise.catch((e) => this.log.warn(e.message, this.logContext));
-      this.reconnectFuture?.reject?.('Got disconnected during reconnection attempt');
+      this.reconnectFuture?.reject?.(new Error('Got disconnected during reconnection attempt'));
       this.reconnectFuture = undefined;
     }
     if (this.signalConnectedFuture) {
-      this.signalConnectedFuture.reject?.('Got disconnected without signal connected');
+      this.signalConnectedFuture.reject?.(new Error('Got disconnected without signal connected'));
       this.signalConnectedFuture = undefined;
     }
 
-    this.activeAgentFuture?.reject?.('Got disconnected without active agent present');
+    this.activeAgentFuture?.reject?.(new Error('Got disconnected without active agent present'));
     this.activeAgentFuture = undefined;
     this.firstActiveAgent = undefined;
   };
@@ -293,7 +293,7 @@ export default class LocalParticipant extends Participant {
       this.updateInfo(joinResponse.participant);
     }
     if (!this.signalConnectedFuture) {
-      this.signalConnectedFuture = new Future<void>();
+      this.signalConnectedFuture = new Future<void, Error>();
     }
 
     this.signalConnectedFuture.resolve?.();
@@ -926,7 +926,7 @@ export default class LocalParticipant extends Participant {
 
   private waitUntilEngineConnected() {
     if (!this.signalConnectedFuture) {
-      this.signalConnectedFuture = new Future<void>();
+      this.signalConnectedFuture = new Future<void, Error>();
     }
     return this.signalConnectedFuture.promise;
   }
@@ -2009,7 +2009,7 @@ export default class LocalParticipant extends Participant {
     if (agent) {
       this.activeAgentFuture?.resolve?.(agent);
     } else {
-      this.activeAgentFuture?.reject?.('Agent disconnected');
+      this.activeAgentFuture?.reject?.(new Error('Agent disconnected'));
     }
     this.activeAgentFuture = undefined;
   }
@@ -2019,7 +2019,7 @@ export default class LocalParticipant extends Participant {
       return Promise.resolve(this.firstActiveAgent);
     }
     if (!this.activeAgentFuture) {
-      this.activeAgentFuture = new Future<RemoteParticipant>();
+      this.activeAgentFuture = new Future<RemoteParticipant, Error>();
     }
     return this.activeAgentFuture.promise;
   }

src/room/participant/Participant.ts

@@ -96,7 +96,7 @@ export default class Participant extends (EventEmitter as new () => TypedEmitter
 
   protected loggerOptions?: LoggerOptions;
 
-  protected activeFuture?: Future<void>;
+  protected activeFuture?: Future<void, Error>;
 
   protected get logContext() {
     return {
@@ -195,7 +195,7 @@ export default class Participant extends (EventEmitter as new () => TypedEmitter
       return this.activeFuture.promise;
     }
 
-    this.activeFuture = new Future<void>();
+    this.activeFuture = new Future<void, Error>();
 
     this.once(ParticipantEvent.Active, () => {
       this.activeFuture?.resolve?.();

src/room/types.ts

@@ -125,7 +125,7 @@ export interface StreamController<T extends DataStream_Chunk> {
   startTime: number;
   endTime?: number;
   sendingParticipantIdentity: string;
-  outOfBandFailureRejectingFuture: Future<never>;
+  outOfBandFailureRejectingFuture: Future<never, Error>;
 }
 
 export interface BaseStreamInfo {

src/room/utils.ts

@@ -455,12 +455,12 @@ export function getStereoAudioStreamTrack() {
   return stereoTrack;
 }
 
-export class Future<T> {
+export class Future<T, E extends Error> {
   promise: Promise<T>;
 
   resolve?: (arg: T) => void;
 
-  reject?: (e: any) => void;
+  reject?: (e: E) => void;
 
   onFinally?: () => void;
 
@@ -471,7 +471,7 @@ export class Future<T> {
   private _isResolved: boolean = false;
 
   constructor(
-    futureBase?: (resolve: (arg: T) => void, reject: (e: any) => void) => void,
+    futureBase?: (resolve: (arg: T) => void, reject: (e: E) => void) => void,
     onFinally?: () => void,
   ) {
     this.onFinally = onFinally;