Add timeout option for HTTP requests (#1660)

Author: webmaster128

CHANGELOG.md

@@ -6,6 +6,13 @@ and this project adheres to
 
 ## [Unreleased]
 
+### Added
+
+- @cosmjs/tendermint-rpc: Add timeout option for HTTP requests in `HttpClient`
+  and `HttpBatchClient`. ([#1660])
+
+[#1660]: https://github.com/cosmos/cosmjs/pull/1660
+
 ### Changed
 
 - all: Drop support for Node.js < 20.

packages/tendermint-rpc/src/rpcclients/http.ts

@@ -18,15 +18,17 @@ export async function http(
   url: string,
   headers: Record<string, string> | undefined,
   request?: any,
+  timeout?: number,
 ): Promise<any> {
-  const settings = {
+  const settings: RequestInit = {
     method: method,
     body: request ? JSON.stringify(request) : undefined,
     headers: {
       // eslint-disable-next-line @typescript-eslint/naming-convention
       "Content-Type": "application/json",
       ...headers,
     },
+    signal: timeout ? AbortSignal.timeout(timeout) : undefined,
   };
   return fetch(url, settings)
     .then(filterBadStatus)

packages/tendermint-rpc/src/rpcclients/httpbatchclient.ts

@@ -14,6 +14,8 @@ export interface HttpBatchClientOptions {
   dispatchInterval: number;
   /** Max number of items sent in one request */
   batchSizeLimit: number;
+  /** Timeout for HTTP requests in milliseconds. Set to undefined to disable timeout. */
+  httpTimeout?: number;
 }
 
 // Those values are private and can change any time.
@@ -40,6 +42,7 @@ export class HttpBatchClient implements RpcClient {
     this.options = {
       batchSizeLimit: options.batchSizeLimit ?? defaultHttpBatchClientOptions.batchSizeLimit,
       dispatchInterval: options.dispatchInterval ?? defaultHttpBatchClientOptions.dispatchInterval,
+      httpTimeout: options.httpTimeout,
     };
     if (typeof endpoint === "string") {
       if (!hasProtocol(endpoint)) {
@@ -93,7 +96,7 @@ export class HttpBatchClient implements RpcClient {
     const requests = batch.map((s) => s.request);
     const requestIds = requests.map((request) => request.id);
 
-    http("POST", this.url, this.headers, requests).then(
+    http("POST", this.url, this.headers, requests, this.options.httpTimeout).then(
       (raw) => {
         // Requests with a single entry return as an object
         const arr = Array.isArray(raw) ? raw : [raw];

packages/tendermint-rpc/src/rpcclients/httpclient.ts

@@ -25,8 +25,9 @@ export interface HttpEndpoint {
 export class HttpClient implements RpcClient {
   protected readonly url: string;
   protected readonly headers: Record<string, string> | undefined;
+  protected readonly timeout: number | undefined;
 
-  public constructor(endpoint: string | HttpEndpoint) {
+  public constructor(endpoint: string | HttpEndpoint, timeout?: number) {
     if (typeof endpoint === "string") {
       if (!hasProtocol(endpoint)) {
         throw new Error("Endpoint URL is missing a protocol. Expected 'https://' or 'http://'.");
@@ -36,14 +37,15 @@ export class HttpClient implements RpcClient {
       this.url = endpoint.url;
       this.headers = endpoint.headers;
     }
+    this.timeout = timeout;
   }
 
   public disconnect(): void {
     // nothing to be done
   }
 
   public async execute(request: JsonRpcRequest): Promise<JsonRpcSuccessResponse> {
-    const response = parseJsonRpcResponse(await http("POST", this.url, this.headers, request));
+    const response = parseJsonRpcResponse(await http("POST", this.url, this.headers, request, this.timeout));
     if (isJsonRpcErrorResponse(response)) {
       throw new Error(JSON.stringify(response.error));
     }