Add a timeout option to HttpClientRequest

.changeset/beige-birds-attack.md

@@ -0,0 +1,5 @@
+---
+"@effect/platform": minor
+---
+
+Add a timeout option to HttpClientRequest

packages/platform/src/HttpClient.ts

@@ -358,7 +358,7 @@ export const makeWith: <E2, R2, E, R>(
  */
 export const make: (
   f: (
-    request: ClientRequest.HttpClientRequest,
+    request: Omit<ClientRequest.HttpClientRequest, "timeout">,
     url: URL,
     signal: AbortSignal,
     fiber: RuntimeFiber<ClientResponse.HttpClientResponse, Error.HttpClientError>

packages/platform/src/HttpClientRequest.ts

@@ -1,6 +1,7 @@
 /**
  * @since 1.0.0
  */
+import type * as Duration from "effect/Duration"
 import type * as Effect from "effect/Effect"
 import type { Inspectable } from "effect/Inspectable"
 import type * as Option from "effect/Option"
@@ -41,6 +42,7 @@ export interface HttpClientRequest extends Inspectable, Pipeable {
   readonly hash: Option.Option<string>
   readonly headers: Headers.Headers
   readonly body: Body.HttpBody
+  readonly timeout?: Duration.DurationInput
 }
 
 /**
@@ -56,6 +58,7 @@ export interface Options {
   readonly body?: Body.HttpBody | undefined
   readonly accept?: string | undefined
   readonly acceptJson?: boolean | undefined
+  readonly timeout?: Duration.DurationInput
 }
 
 /**
@@ -399,3 +402,18 @@ export const bodyFileWeb: {
   (file: Body.HttpBody.FileLike): (self: HttpClientRequest) => HttpClientRequest
   (self: HttpClientRequest, file: Body.HttpBody.FileLike): HttpClientRequest
 } = internal.bodyFileWeb
+
+/**
+ * @since 1.0.0
+ * @category combinators
+ */
+export const setTimeout: {
+  (timeout: Duration.DurationInput): (self: HttpClientRequest) => HttpClientRequest
+  (self: HttpClientRequest, timeout: Duration.DurationInput): HttpClientRequest
+} = internal.setTimeout
+
+/**
+ * @since 1.0.0
+ * @category combinators
+ */
+export const removeTimeout: (self: HttpClientRequest) => HttpClientRequest = internal.removeTimeout

packages/platform/src/internal/httpClient.ts

@@ -1,10 +1,11 @@
 import * as Cause from "effect/Cause"
 import * as Context from "effect/Context"
+import * as Duration from "effect/Duration"
 import * as Effect from "effect/Effect"
 import * as Exit from "effect/Exit"
 import type * as Fiber from "effect/Fiber"
 import * as FiberRef from "effect/FiberRef"
-import { constFalse, dual } from "effect/Function"
+import { constFalse, dual, identity } from "effect/Function"
 import { globalValue } from "effect/GlobalValue"
 import * as Inspectable from "effect/Inspectable"
 import * as Layer from "effect/Layer"
@@ -160,7 +161,7 @@ const responseRegistry = globalValue(
 /** @internal */
 export const make = (
   f: (
-    request: ClientRequest.HttpClientRequest,
+    request: Omit<ClientRequest.HttpClientRequest, "timeout">,
     url: URL,
     signal: AbortSignal,
     fiber: Fiber.RuntimeFiber<ClientResponse.HttpClientResponse, Error.HttpClientError>
@@ -179,18 +180,35 @@ export const make = (
           fiber.getFiberRef(currentTracerDisabledWhen)(request)
         if (tracerDisabled) {
           return Effect.uninterruptibleMask((restore) =>
-            Effect.matchCauseEffect(restore(f(request, url, controller.signal, fiber)), {
-              onSuccess(response) {
-                responseRegistry.register(response, controller)
-                return Effect.succeed(new InterruptibleResponse(response, controller))
-              },
-              onFailure(cause) {
-                if (Cause.isInterrupted(cause)) {
-                  controller.abort()
+            Effect.matchCauseEffect(
+              restore(f(request, url, controller.signal, fiber)),
+              {
+                onSuccess(response) {
+                  responseRegistry.register(response, controller)
+                  return Effect.succeed(new InterruptibleResponse(response, controller))
+                },
+                onFailure(cause) {
+                  if (Cause.isInterrupted(cause)) {
+                    controller.abort()
+                  }
+                  return Effect.failCause(cause)
                 }
-                return Effect.failCause(cause)
               }
-            })
+            ).pipe(
+              request.timeout ?
+                Effect.timeoutFail({
+                  duration: request.timeout,
+                  onTimeout: () =>
+                    new Error.RequestError({
+                      request,
+                      reason: "Transport",
+                      cause: new Cause.TimeoutException(
+                        `Request timed out after '${Duration.format(request.timeout!)}'`
+                      )
+                    })
+                }) :
+                identity
+            )
           )
         }
         return Effect.useSpan(
@@ -237,7 +255,20 @@ export const make = (
                     }
                     return Effect.failCause(cause)
                   }
-                })
+                }),
+                request.timeout ?
+                  Effect.timeoutFail({
+                    duration: request.timeout,
+                    onTimeout: () =>
+                      new Error.RequestError({
+                        request,
+                        reason: "Transport",
+                        cause: new Cause.TimeoutException(
+                          `Request timed out after '${Duration.format(request.timeout!)}'`
+                        )
+                      })
+                  }) :
+                  identity
               )
             )
           }

packages/platform/src/internal/httpClientRequest.ts

@@ -1,3 +1,4 @@
+import type * as Duration from "effect/Duration"
 import * as Effect from "effect/Effect"
 import { dual } from "effect/Function"
 import * as Inspectable from "effect/Inspectable"
@@ -44,7 +45,8 @@ function makeInternal(
   urlParams: UrlParams.UrlParams,
   hash: Option.Option<string>,
   headers: Headers.Headers,
-  body: Body.HttpBody
+  body: Body.HttpBody,
+  timeout: Duration.DurationInput | undefined
 ): ClientRequest.HttpClientRequest {
   const self = Object.create(Proto)
   self.method = method
@@ -53,6 +55,7 @@ function makeInternal(
   self.hash = hash
   self.headers = headers
   self.body = body
+  self.timeout = timeout
   return self
 }
 
@@ -67,7 +70,8 @@ export const empty: ClientRequest.HttpClientRequest = makeInternal(
   UrlParams.empty,
   Option.none(),
   Headers.empty,
-  internalBody.empty
+  internalBody.empty,
+  undefined
 )
 
 /** @internal */
@@ -134,6 +138,9 @@ export const modify = dual<
   if (options.acceptJson) {
     result = acceptJson(result)
   }
+  if (options.timeout) {
+    result = setTimeout(result, options.timeout)
+  }
 
   return result
 })
@@ -149,7 +156,8 @@ export const setHeader = dual<
     self.urlParams,
     self.hash,
     Headers.set(self.headers, key, value),
-    self.body
+    self.body,
+    self.timeout
   ))
 
 /** @internal */
@@ -163,7 +171,8 @@ export const setHeaders = dual<
     self.urlParams,
     self.hash,
     Headers.setAll(self.headers, input),
-    self.body
+    self.body,
+    self.timeout
   ))
 
 const stringOrRedacted = (value: string | Redacted.Redacted): string =>
@@ -212,7 +221,8 @@ export const setMethod = dual<
     self.urlParams,
     self.hash,
     self.headers,
-    self.body
+    self.body,
+    self.timeout
   ))
 
 /** @internal */
@@ -227,7 +237,8 @@ export const setUrl = dual<
       self.urlParams,
       self.hash,
       self.headers,
-      self.body
+      self.body,
+      self.timeout
     )
   }
   const clone = new URL(url.toString())
@@ -241,7 +252,8 @@ export const setUrl = dual<
     urlParams,
     hash,
     self.headers,
-    self.body
+    self.body,
+    self.timeout
   )
 })
 
@@ -258,7 +270,8 @@ export const appendUrl = dual<
     self.urlParams,
     self.hash,
     self.headers,
-    self.body
+    self.body,
+    self.timeout
   ))
 
 /** @internal */
@@ -274,7 +287,8 @@ export const prependUrl = dual<
     self.urlParams,
     self.hash,
     self.headers,
-    self.body
+    self.body,
+    self.timeout
   ))
 
 /** @internal */
@@ -288,7 +302,8 @@ export const updateUrl = dual<
     self.urlParams,
     self.hash,
     self.headers,
-    self.body
+    self.body,
+    self.timeout
   ))
 
 /** @internal */
@@ -302,7 +317,8 @@ export const appendUrlParam = dual<
     UrlParams.append(self.urlParams, key, value),
     self.hash,
     self.headers,
-    self.body
+    self.body,
+    self.timeout
   ))
 
 /** @internal */
@@ -316,7 +332,8 @@ export const appendUrlParams = dual<
     UrlParams.appendAll(self.urlParams, input),
     self.hash,
     self.headers,
-    self.body
+    self.body,
+    self.timeout
   ))
 
 /** @internal */
@@ -330,7 +347,8 @@ export const setUrlParam = dual<
     UrlParams.set(self.urlParams, key, value),
     self.hash,
     self.headers,
-    self.body
+    self.body,
+    self.timeout
   ))
 
 /** @internal */
@@ -344,7 +362,8 @@ export const setUrlParams = dual<
     UrlParams.setAll(self.urlParams, input),
     self.hash,
     self.headers,
-    self.body
+    self.body,
+    self.timeout
   ))
 
 /** @internal */
@@ -358,7 +377,8 @@ export const setHash = dual<
     self.urlParams,
     Option.some(hash),
     self.headers,
-    self.body
+    self.body,
+    self.timeout
   ))
 
 /** @internal */
@@ -369,7 +389,8 @@ export const removeHash = (self: ClientRequest.HttpClientRequest): ClientRequest
     self.urlParams,
     Option.none(),
     self.headers,
-    self.body
+    self.body,
+    self.timeout
   )
 
 /** @internal */
@@ -397,7 +418,8 @@ export const setBody = dual<
     self.urlParams,
     self.hash,
     headers,
-    body
+    body,
+    self.timeout
   )
 })
 
@@ -528,3 +550,29 @@ export const bodyStream = dual<
   (self, body, { contentLength, contentType = "application/octet-stream" } = {}) =>
     setBody(self, internalBody.stream(body, contentType, contentLength))
 )
+
+export const setTimeout = dual<
+  (timeout: Duration.DurationInput) => (self: ClientRequest.HttpClientRequest) => ClientRequest.HttpClientRequest,
+  (self: ClientRequest.HttpClientRequest, timeout: Duration.DurationInput) => ClientRequest.HttpClientRequest
+>(2, (self, timeout) =>
+  makeInternal(
+    self.method,
+    self.url,
+    self.urlParams,
+    self.hash,
+    self.headers,
+    self.body,
+    timeout
+  ))
+
+/** @internal */
+export const removeTimeout = (self: ClientRequest.HttpClientRequest): ClientRequest.HttpClientRequest =>
+  makeInternal(
+    self.method,
+    self.url,
+    self.urlParams,
+    self.hash,
+    self.headers,
+    self.body,
+    undefined
+  )

packages/platform/test/HttpClient.test.ts

@@ -23,7 +23,7 @@ import {
   Stream,
   Struct
 } from "effect"
-import { assertInclude, deepStrictEqual, strictEqual } from "effect/test/util"
+import { assertEquals, assertInclude, deepStrictEqual, strictEqual } from "effect/test/util"
 
 const Todo = Schema.Struct({
   userId: Schema.Number,
@@ -104,6 +104,14 @@ describe("HttpClient", () => {
       assertInclude(response, "Google")
     }).pipe(Effect.provide(FetchHttpClient.layer), Effect.runPromise))
 
+  it("google timeout", () =>
+    Effect.gen(function*() {
+      const error = yield* Effect.flip(HttpClient.get("https://www.google.com/", { timeout: "1 milli" }))
+      assertEquals(error._tag, "RequestError")
+      assertEquals(error.reason, "Transport")
+      assertEquals(error.cause!.toString(), "TimeoutException: Request timed out after '1ms'")
+    }).pipe(Effect.provide(FetchHttpClient.layer), Effect.runPromise))
+
   it("jsonplaceholder", () =>
     Effect.gen(function*() {
       const jp = yield* JsonPlaceholder