Add optional timeouts to clients in server APIs

packages/livekit-server-sdk/src/AgentDispatchClient.ts

@@ -17,6 +17,10 @@
   metadata?: string;
 }
 
+type ClientOptions = {
+  requestTimeout?: number;
+};
+
 const svc = 'AgentDispatchService';
 
 /**
@@ -29,10 +33,15 @@
    * @param host - hostname including protocol. i.e. 'https://<project>.livekit.cloud'
    * @param apiKey - API Key, can be set in env var LIVEKIT_API_KEY
    * @param secret - API Secret, can be set in env var LIVEKIT_API_SECRET
+   * @param options - client options
+   * @param options.requestTimeout - optional timeout, in seconds, for all server requests
    */
-  constructor(host: string, apiKey?: string, secret?: string) {
+  constructor(host: string, apiKey?: string, secret?: string, options?: ClientOptions) {
     super(apiKey, secret);
-    this.rpc = new TwirpRpc(host, livekitPackage);
+    const rpcOptions = options?.requestTimeout
+      ? { requestTimeout: options.requestTimeout }
+      : undefined;
+    this.rpc = new TwirpRpc(host, livekitPackage, rpcOptions);
   }
 
   /**

packages/livekit-server-sdk/src/EgressClient.ts

@@ -127,6 +127,10 @@
   active?: boolean;
 }
 
+type ClientOptions = {
+  requestTimeout?: number;
+};
+
 /**
  * Client to access Egress APIs
  */
@@ -137,10 +141,15 @@
    * @param host - hostname including protocol. i.e. 'https://<project>.livekit.cloud'
    * @param apiKey - API Key, can be set in env var LIVEKIT_API_KEY
    * @param secret - API Secret, can be set in env var LIVEKIT_API_SECRET
+   * @param options - client options
+   * @param options.requestTimeout - optional timeout, in seconds, for all server requests
    */
-  constructor(host: string, apiKey?: string, secret?: string) {
+  constructor(host: string, apiKey?: string, secret?: string, options?: ClientOptions) {
     super(apiKey, secret);
-    this.rpc = new TwirpRpc(host, livekitPackage);
+    const rpcOptions = options?.requestTimeout
+      ? { requestTimeout: options.requestTimeout }
+      : undefined;
+    this.rpc = new TwirpRpc(host, livekitPackage, rpcOptions);
   }
 
   /**

packages/livekit-server-sdk/src/IngressClient.ts

@@ -114,6 +114,10 @@
   ingressId?: string;
 }
 
+type ClientOptions = {
+  requestTimeout?: number;
+};
+
 /**
  * Client to access Ingress APIs
  */
@@ -124,10 +128,15 @@
    * @param host - hostname including protocol. i.e. 'https://<project>.livekit.cloud'
    * @param apiKey - API Key, can be set in env var LIVEKIT_API_KEY
    * @param secret - API Secret, can be set in env var LIVEKIT_API_SECRET
+   * @param options - client options
+   * @param options.requestTimeout - optional timeout, in seconds, for all server requests
    */
-  constructor(host: string, apiKey?: string, secret?: string) {
+  constructor(host: string, apiKey?: string, secret?: string, options?: ClientOptions) {
     super(apiKey, secret);
-    this.rpc = new TwirpRpc(host, livekitPackage);
+    const rpcOptions = options?.requestTimeout
+      ? { requestTimeout: options.requestTimeout }
+      : undefined;
+    this.rpc = new TwirpRpc(host, livekitPackage, rpcOptions);
   }
 
   /**

packages/livekit-server-sdk/src/RoomServiceClient.ts

@@ -107,6 +107,10 @@
   name?: string;
 };
 
+type ClientOptions = {
+  requestTimeout?: number;
+};
+
 const svc = 'RoomService';
 
 /**
@@ -120,10 +124,15 @@
    * @param host - hostname including protocol. i.e. 'https://<project>.livekit.cloud'
    * @param apiKey - API Key, can be set in env var LIVEKIT_API_KEY
    * @param secret - API Secret, can be set in env var LIVEKIT_API_SECRET
+   * @param options - client options
+   * @param options.requestTimeout - optional timeout, in seconds, for all server requests
    */
-  constructor(host: string, apiKey?: string, secret?: string) {
+  constructor(host: string, apiKey?: string, secret?: string, options?: ClientOptions) {
     super(apiKey, secret);
-    this.rpc = new TwirpRpc(host, livekitPackage);
+    const rpcOptions = options?.requestTimeout
+      ? { requestTimeout: options.requestTimeout }
+      : undefined;
+    this.rpc = new TwirpRpc(host, livekitPackage, rpcOptions);
   }
 
   /**

packages/livekit-server-sdk/src/SipClient.ts

@@ -205,6 +205,10 @@
   headers?: { [key: string]: string };
 }
 
+type ClientOptions = {
+  requestTimeout?: number;
+};
+
 /**
  * Client to access Egress APIs
  */
@@ -215,10 +219,15 @@
    * @param host - hostname including protocol. i.e. 'https://<project>.livekit.cloud'
    * @param apiKey - API Key, can be set in env var LIVEKIT_API_KEY
    * @param secret - API Secret, can be set in env var LIVEKIT_API_SECRET
+   * @param options - client options
+   * @param options.requestTimeout - optional timeout, in seconds, for all server requests
    */
-  constructor(host: string, apiKey?: string, secret?: string) {
+  constructor(host: string, apiKey?: string, secret?: string, options?: ClientOptions) {
     super(apiKey, secret);
-    this.rpc = new TwirpRpc(host, livekitPackage);
+    const rpcOptions = options?.requestTimeout
+      ? { requestTimeout: options.requestTimeout }
+      : undefined;
+    this.rpc = new TwirpRpc(host, livekitPackage, rpcOptions);
   }
 
   /**

packages/livekit-server-sdk/src/TwirpRPC.ts

@@ -5,7 +5,15 @@ import type { JsonValue } from '@bufbuild/protobuf';
 
 // twirp RPC adapter for client implementation
 
+type Options = {
+  /** Prefix for the RPC requests */
+  prefix?: string;
+  /** Timeout for fetch requests, in seconds. Must resolve to a positive integer millisecond value. */
+  requestTimeout?: number;
+};
+
 const defaultPrefix = '/twirp';
+const defaultTimeoutSeconds = 60;
 
 export const livekitPackage = 'livekit';
 export interface Rpc {
@@ -48,21 +56,24 @@ export class TwirpRpc {
 
   prefix: string;
 
-  constructor(host: string, pkg: string, prefix?: string) {
+  requestTimeout: number;
+
+  constructor(host: string, pkg: string, options?: Options) {
     if (host.startsWith('ws')) {
       host = host.replace('ws', 'http');
     }
     this.host = host;
     this.pkg = pkg;
-    this.prefix = prefix || defaultPrefix;
+    this.requestTimeout = options?.requestTimeout ?? defaultTimeoutSeconds;
+    this.prefix = options?.prefix || defaultPrefix;
   }
 
   async request(
     service: string,
     method: string,
     data: any, // eslint-disable-line @typescript-eslint/no-explicit-any
     headers: any, // eslint-disable-line @typescript-eslint/no-explicit-any
-    timeout = 60,
+    timeout = this.requestTimeout,
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
   ): Promise<any> {
     const path = `${this.prefix}/${this.pkg}.${service}/${method}`;