Add default request timeout (#844)

connectrpc · Oct 2, 2023 · 908e0dd · 908e0dd
1 parent d07926a
commit 908e0dd
Show file tree

Hide file tree

Showing 11 changed files with 105 additions and 2 deletions.
diff --git a/packages/connect-node/src/connect-transport.ts b/packages/connect-node/src/connect-transport.ts
@@ -118,6 +118,13 @@ type ConnectTransportOptions = NodeTransportOptions & {
    * available, on side-effect free methods. Defaults to false.
    */
   useHttpGet?: boolean;
+
+  /**
+   * The timeout in milliseconds to apply to all requests.
+   *
+   * This can be overridden on a per-request basis by passing a timeoutMs.
+   */
+  defaultTimeoutMs?: number;
 };
 
 /**

diff --git a/packages/connect-node/src/grpc-transport.ts b/packages/connect-node/src/grpc-transport.ts
@@ -113,6 +113,13 @@ type GrpcTransportOptions = NodeTransportOptions & {
    * The default limit is the maximum supported value of ~4GiB.
    */
   writeMaxBytes?: number;
+
+  /**
+   * The timeout in milliseconds to apply to all requests.
+   *
+   * This can be overridden on a per-request basis by passing a timeoutMs.
+   */
+  defaultTimeoutMs?: number;
 };
 
 /**

diff --git a/packages/connect-node/src/grpc-web-transport.ts b/packages/connect-node/src/grpc-web-transport.ts
@@ -113,6 +113,13 @@ type GrpcWebTransportOptions = NodeTransportOptions & {
    * The default limit is the maximum supported value of ~4GiB.
    */
   writeMaxBytes?: number;
+
+  /**
+   * The timeout in milliseconds to apply to all requests.
+   *
+   * This can be overridden on a per-request basis by passing a timeoutMs.
+   */
+  defaultTimeoutMs?: number;
 };
 
 /**

diff --git a/packages/connect-web-bench/README.md b/packages/connect-web-bench/README.md
@@ -10,5 +10,5 @@ it like a web server would usually do.
 
 | code generator | bundle size        | minified               | compressed           |
 |----------------|-------------------:|-----------------------:|---------------------:|
-| connect        | 113,448 b | 49,872 b | 13,465 b |
+| connect        | 113,658 b | 49,964 b | 13,487 b |
 | grpc-web       | 414,071 b    | 300,352 b    | 53,255 b |
diff --git a/packages/connect-web/src/connect-transport.ts b/packages/connect-web/src/connect-transport.ts
@@ -112,6 +112,13 @@ export interface ConnectTransportOptions {
    * available, on side-effect free methods. Defaults to false.
    */
   useHttpGet?: boolean;
+
+  /**
+   * The timeout in milliseconds to apply to all requests.
+   *
+   * This can be overridden on a per-request basis by passing a timeoutMs.
+   */
+  defaultTimeoutMs?: number;
 }
 
 /**
@@ -142,6 +149,12 @@ export function createConnectTransport(
         options.jsonOptions,
         options.binaryOptions,
       );
+      timeoutMs =
+        timeoutMs === undefined
+          ? options.defaultTimeoutMs
+          : timeoutMs <= 0
+          ? undefined
+          : timeoutMs;
       return await runUnaryCall<I, O>({
         interceptors: options.interceptors,
         signal,
@@ -280,6 +293,12 @@ export function createConnectTransport(
         return encodeEnvelope(0, serialize(r.value));
       }
 
+      timeoutMs =
+        timeoutMs === undefined
+          ? options.defaultTimeoutMs
+          : timeoutMs <= 0
+          ? undefined
+          : timeoutMs;
       return await runStreamingCall<I, O>({
         interceptors: options.interceptors,
         timeoutMs,

diff --git a/packages/connect-web/src/grpc-web-transport.ts b/packages/connect-web/src/grpc-web-transport.ts
@@ -102,6 +102,13 @@ export interface GrpcWebTransportOptions {
    * Optional override of the fetch implementation used by the transport.
    */
   fetch?: typeof globalThis.fetch;
+
+  /**
+   * The timeout in milliseconds to apply to all requests.
+   *
+   * This can be overridden on a per-request basis by passing a timeoutMs.
+   */
+  defaultTimeoutMs?: number;
 }
 
 /**
@@ -137,6 +144,12 @@ export function createGrpcWebTransport(
         options.jsonOptions,
         options.binaryOptions,
       );
+      timeoutMs =
+        timeoutMs === undefined
+          ? options.defaultTimeoutMs
+          : timeoutMs <= 0
+          ? undefined
+          : timeoutMs;
       return await runUnaryCall<I, O>({
         interceptors: options.interceptors,
         signal,
@@ -288,7 +301,12 @@ export function createGrpcWebTransport(
         }
         return encodeEnvelope(0, serialize(r.value));
       }
-
+      timeoutMs =
+        timeoutMs === undefined
+          ? options.defaultTimeoutMs
+          : timeoutMs <= 0
+          ? undefined
+          : timeoutMs;
       return runStreamingCall<I, O>({
         interceptors: options.interceptors,
         signal,

diff --git a/packages/connect/src/call-options.ts b/packages/connect/src/call-options.ts
@@ -19,6 +19,8 @@
 export interface CallOptions {
   /**
    * Timeout in milliseconds.
+   *
+   * Set to <= 0 to disable the default timeout.
    */
   timeoutMs?: number;
 

diff --git a/packages/connect/src/protocol-connect/transport.ts b/packages/connect/src/protocol-connect/transport.ts
@@ -76,6 +76,12 @@ export function createTransport(opt: CommonTransportOptions): Transport {
         opt.jsonOptions,
         opt,
       );
+      timeoutMs =
+        timeoutMs === undefined
+          ? opt.defaultTimeoutMs
+          : timeoutMs <= 0
+          ? undefined
+          : timeoutMs;
       return await runUnaryCall<I, O>({
         interceptors: opt.interceptors,
         signal,
@@ -192,6 +198,12 @@ export function createTransport(opt: CommonTransportOptions): Transport {
       const endStreamSerialization = createEndStreamSerialization(
         opt.jsonOptions,
       );
+      timeoutMs =
+        timeoutMs === undefined
+          ? opt.defaultTimeoutMs
+          : timeoutMs <= 0
+          ? undefined
+          : timeoutMs;
       return runStreamingCall<I, O>({
         interceptors: opt.interceptors,
         signal,

diff --git a/packages/connect/src/protocol-grpc-web/transport.ts b/packages/connect/src/protocol-grpc-web/transport.ts
@@ -70,6 +70,12 @@ export function createTransport(opt: CommonTransportOptions): Transport {
         opt.jsonOptions,
         opt,
       );
+      timeoutMs =
+        timeoutMs === undefined
+          ? opt.defaultTimeoutMs
+          : timeoutMs <= 0
+          ? undefined
+          : timeoutMs;
       return await runUnaryCall<I, O>({
         interceptors: opt.interceptors,
         signal,
@@ -193,6 +199,12 @@ export function createTransport(opt: CommonTransportOptions): Transport {
         opt.jsonOptions,
         opt,
       );
+      timeoutMs =
+        timeoutMs === undefined
+          ? opt.defaultTimeoutMs
+          : timeoutMs <= 0
+          ? undefined
+          : timeoutMs;
       return runStreamingCall<I, O>({
         interceptors: opt.interceptors,
         signal,

diff --git a/packages/connect/src/protocol-grpc/transport.ts b/packages/connect/src/protocol-grpc/transport.ts
@@ -69,6 +69,12 @@ export function createTransport(opt: CommonTransportOptions): Transport {
         opt.jsonOptions,
         opt,
       );
+      timeoutMs =
+        timeoutMs === undefined
+          ? opt.defaultTimeoutMs
+          : timeoutMs <= 0
+          ? undefined
+          : timeoutMs;
       return await runUnaryCall<I, O>({
         interceptors: opt.interceptors,
         signal,
@@ -169,6 +175,12 @@ export function createTransport(opt: CommonTransportOptions): Transport {
         opt.jsonOptions,
         opt,
       );
+      timeoutMs =
+        timeoutMs === undefined
+          ? opt.defaultTimeoutMs
+          : timeoutMs <= 0
+          ? undefined
+          : timeoutMs;
       return runStreamingCall<I, O>({
         interceptors: opt.interceptors,
         signal,

diff --git a/packages/connect/src/protocol/transport-options.ts b/packages/connect/src/protocol/transport-options.ts
@@ -120,4 +120,11 @@ export interface CommonTransportOptions {
    * available, on side-effect free methods. Defaults to false.
    */
   useHttpGet?: boolean;
+
+  /**
+   * The timeout in milliseconds to apply to all requests.
+   *
+   * This can be overridden on a per-request basis by passing a timeoutMs.
+   */
+  defaultTimeoutMs?: number;
 }