effect 4.0.5 → 4.0.7

package/dist/http/HttpClient.d.ts

@@ -16,9 +16,11 @@ import type { NonEmptyReadonlyArray } from "../Array.ts";
 import * as Context from "../Context.ts";
 import * as Duration from "../Duration.ts";
 import * as Effect from "../Effect.ts";
+import * as Exit from "../Exit.ts";
 import * as Fiber from "../Fiber.ts";
 import * as Inspectable from "../Inspectable.ts";
 import * as Layer from "../Layer.ts";
+import type * as CircuitBreaker from "../persistence/CircuitBreaker.ts";
 import type * as RateLimiter from "../persistence/RateLimiter.ts";
 import { type Pipeable } from "../Pipeable.ts";
 import * as Predicate from "../Predicate.ts";
@@ -931,6 +933,427 @@ export declare const withRateLimiter: {
      */
     <E, R>(self: HttpClient.With<E, R>, options: WithRateLimiter.Options): HttpClient.With<E | RateLimiter.RateLimiterError, R>;
 };
+/**
+ * Namespace containing configuration types for `withCircuitBreaker`.
+ *
+ * @stability experimental
+ * @since 4.0.6
+ */
+export declare namespace WithCircuitBreaker {
+    /**
+     * Options used to configure `withCircuitBreaker`.
+     *
+     * @stability experimental
+     * @category circuit breaking
+     * @since 4.0.6
+     */
+    interface Options<E, R2 = never> {
+        /**
+         * The `CircuitBreaker` service that guards each request.
+         */
+        readonly breaker: CircuitBreaker.CircuitBreaker;
+        /**
+         * The circuit key for a request. Requests with the same key share one
+         * circuit. Defaults to the request origin, falling back to the raw request
+         * URL when it cannot be parsed.
+         */
+        readonly key?: string | ((request: HttpClientRequest.HttpClientRequest) => string) | undefined;
+        /**
+         * Classifies the `Exit` of each request that the breaker admitted.
+         * Defaults to `circuitBreakerClassifier`.
+         */
+        readonly classify?: ((exit: Exit.Exit<HttpClientResponse.HttpClientResponse, E>) => CircuitBreaker.Outcome | Effect.Effect<CircuitBreaker.Outcome, never, R2>) | undefined;
+    }
+}
+/**
+ * Guards requests with a `CircuitBreaker`.
+ *
+ * **Details**
+ *
+ * Requests are keyed by origin unless `key` is set, and classified with
+ * `circuitBreakerClassifier` unless `classify` is set. A rejected request
+ * fails with `CircuitBreakerError` without reaching the wrapped client.
+ *
+ * Apply it after `withRateLimiter` and `retryTransient`, so the breaker sees
+ * one outcome per call and an open circuit skips the retry loop.
+ * `retryTransient` never retries a `CircuitBreakerError`. A custom `classify`
+ * can delegate the cases it doesn't handle to `circuitBreakerClassifier`.
+ *
+ * **Gotchas**
+ *
+ * - The breaker only sees the response headers. To count an error in the
+ *   body, lift it into the error channel below the breaker with
+ *   `transformResponse` and count it in `classify`.
+ * - `withRateLimiter` retries `429` without limit by default, which can hold
+ *   the probe slot for minutes. Set its `times`.
+ * - A rejected request has no client span. The rejection fails the caller's
+ *   span instead.
+ *
+ * **Example** (Guarding an API in the recommended order)
+ *
+ * ```ts import.meta.vitest
+ * import { Effect, Layer, Ref, Schedule } from "effect"
+ * import { HttpClient, HttpClientRequest, HttpClientResponse } from "effect/http"
+ * import { CircuitBreaker, RateLimiter } from "effect/persistence"
+ *
+ * const program = Effect.gen(function*() {
+ *   const requests = yield* Ref.make(0)
+ *   // A dependency that always answers 503.
+ *   const unavailable = HttpClient.make((request) =>
+ *     Effect.as(Ref.update(requests, (n) => n + 1), HttpClientResponse.fromWeb(request, new Response(null, { status: 503 })))
+ *   )
+ *
+ *   const breaker = yield* CircuitBreaker.make({
+ *     tripPolicy: CircuitBreaker.consecutive(1),
+ *     openDuration: "30 seconds"
+ *   })
+ *   const client = unavailable.pipe(
+ *     HttpClient.withRateLimiter({
+ *       limiter: yield* RateLimiter.RateLimiter,
+ *       key: "inventory",
+ *       limit: 100,
+ *       window: "1 second",
+ *       times: 3
+ *     }),
+ *     HttpClient.retryTransient({ times: 2, schedule: Schedule.exponential("1 millis") }),
+ *     HttpClient.withCircuitBreaker({ breaker })
+ *   )
+ *
+ *   // Three attempts, then the breaker records one failure and opens.
+ *   yield* client.execute(HttpClientRequest.get("http://inventory.test/items"))
+ *   // Rejected before the retry loop starts, so no further request is sent.
+ *   const rejected = yield* Effect.flip(client.execute(HttpClientRequest.get("http://inventory.test/items")))
+ *
+ *   return [yield* Ref.get(requests), rejected._tag]
+ * }).pipe(
+ *   Effect.scoped,
+ *   Effect.provide(Layer.merge(
+ *     CircuitBreaker.layerStoreMemory(),
+ *     RateLimiter.layer.pipe(Layer.provide(RateLimiter.layerStoreMemory))
+ *   ))
+ * )
+ *
+ * await Effect.runPromise(program) // => [3, "CircuitBreakerError"]
+ * ```
+ *
+ * **Example** (Counting an error in the body as a failure)
+ *
+ * This API answers `200` with `{ "status": "degraded" }` when it is failing.
+ *
+ * ```ts import.meta.vitest
+ * import { Data, Effect, Exit, Option } from "effect"
+ * import { HttpClient, HttpClientRequest, HttpClientResponse } from "effect/http"
+ * import { CircuitBreaker } from "effect/persistence"
+ *
+ * class Degraded extends Data.TaggedError("Degraded") {}
+ *
+ * const degraded = HttpClient.make((request) =>
+ *   Effect.succeed(HttpClientResponse.fromWeb(request, Response.json({ status: "degraded" })))
+ * )
+ *
+ * const program = Effect.gen(function*() {
+ *   const breaker = yield* CircuitBreaker.make({
+ *     tripPolicy: CircuitBreaker.consecutive(1),
+ *     openDuration: "30 seconds"
+ *   })
+ *   const client = degraded.pipe(
+ *     HttpClient.transformResponse(Effect.flatMap((response) =>
+ *       Effect.flatMap(response.json, (body) =>
+ *         typeof body === "object" && body !== null && "status" in body && body.status === "degraded"
+ *           ? Effect.fail(new Degraded())
+ *           : Effect.succeed(response))
+ *     )),
+ *     HttpClient.withCircuitBreaker({
+ *       breaker,
+ *       classify: (exit) =>
+ *         Option.exists(Exit.findErrorOption(exit), (error) => error._tag === "Degraded")
+ *           ? CircuitBreaker.failure()
+ *           : HttpClient.circuitBreakerClassifier(exit)
+ *     })
+ *   )
+ *
+ *   yield* Effect.flip(client.get("http://status.test/"))
+ *   const state = yield* breaker.state("http://status.test")
+ *   return state._tag
+ * }).pipe(Effect.scoped, Effect.provide(CircuitBreaker.layerStoreMemory()))
+ *
+ * await Effect.runPromise(program) // => "Open"
+ * ```
+ *
+ * @stability experimental
+ * @category circuit breaking
+ * @since 4.0.6
+ */
+export declare const withCircuitBreaker: {
+    /**
+     * Guards requests with a `CircuitBreaker`.
+     *
+     * **Details**
+     *
+     * Requests are keyed by origin unless `key` is set, and classified with
+     * `circuitBreakerClassifier` unless `classify` is set. A rejected request
+     * fails with `CircuitBreakerError` without reaching the wrapped client.
+     *
+     * Apply it after `withRateLimiter` and `retryTransient`, so the breaker sees
+     * one outcome per call and an open circuit skips the retry loop.
+     * `retryTransient` never retries a `CircuitBreakerError`. A custom `classify`
+     * can delegate the cases it doesn't handle to `circuitBreakerClassifier`.
+     *
+     * **Gotchas**
+     *
+     * - The breaker only sees the response headers. To count an error in the
+     *   body, lift it into the error channel below the breaker with
+     *   `transformResponse` and count it in `classify`.
+     * - `withRateLimiter` retries `429` without limit by default, which can hold
+     *   the probe slot for minutes. Set its `times`.
+     * - A rejected request has no client span. The rejection fails the caller's
+     *   span instead.
+     *
+     * **Example** (Guarding an API in the recommended order)
+     *
+     * ```ts import.meta.vitest
+     * import { Effect, Layer, Ref, Schedule } from "effect"
+     * import { HttpClient, HttpClientRequest, HttpClientResponse } from "effect/http"
+     * import { CircuitBreaker, RateLimiter } from "effect/persistence"
+     *
+     * const program = Effect.gen(function*() {
+     *   const requests = yield* Ref.make(0)
+     *   // A dependency that always answers 503.
+     *   const unavailable = HttpClient.make((request) =>
+     *     Effect.as(Ref.update(requests, (n) => n + 1), HttpClientResponse.fromWeb(request, new Response(null, { status: 503 })))
+     *   )
+     *
+     *   const breaker = yield* CircuitBreaker.make({
+     *     tripPolicy: CircuitBreaker.consecutive(1),
+     *     openDuration: "30 seconds"
+     *   })
+     *   const client = unavailable.pipe(
+     *     HttpClient.withRateLimiter({
+     *       limiter: yield* RateLimiter.RateLimiter,
+     *       key: "inventory",
+     *       limit: 100,
+     *       window: "1 second",
+     *       times: 3
+     *     }),
+     *     HttpClient.retryTransient({ times: 2, schedule: Schedule.exponential("1 millis") }),
+     *     HttpClient.withCircuitBreaker({ breaker })
+     *   )
+     *
+     *   // Three attempts, then the breaker records one failure and opens.
+     *   yield* client.execute(HttpClientRequest.get("http://inventory.test/items"))
+     *   // Rejected before the retry loop starts, so no further request is sent.
+     *   const rejected = yield* Effect.flip(client.execute(HttpClientRequest.get("http://inventory.test/items")))
+     *
+     *   return [yield* Ref.get(requests), rejected._tag]
+     * }).pipe(
+     *   Effect.scoped,
+     *   Effect.provide(Layer.merge(
+     *     CircuitBreaker.layerStoreMemory(),
+     *     RateLimiter.layer.pipe(Layer.provide(RateLimiter.layerStoreMemory))
+     *   ))
+     * )
+     *
+     * await Effect.runPromise(program) // => [3, "CircuitBreakerError"]
+     * ```
+     *
+     * **Example** (Counting an error in the body as a failure)
+     *
+     * This API answers `200` with `{ "status": "degraded" }` when it is failing.
+     *
+     * ```ts import.meta.vitest
+     * import { Data, Effect, Exit, Option } from "effect"
+     * import { HttpClient, HttpClientRequest, HttpClientResponse } from "effect/http"
+     * import { CircuitBreaker } from "effect/persistence"
+     *
+     * class Degraded extends Data.TaggedError("Degraded") {}
+     *
+     * const degraded = HttpClient.make((request) =>
+     *   Effect.succeed(HttpClientResponse.fromWeb(request, Response.json({ status: "degraded" })))
+     * )
+     *
+     * const program = Effect.gen(function*() {
+     *   const breaker = yield* CircuitBreaker.make({
+     *     tripPolicy: CircuitBreaker.consecutive(1),
+     *     openDuration: "30 seconds"
+     *   })
+     *   const client = degraded.pipe(
+     *     HttpClient.transformResponse(Effect.flatMap((response) =>
+     *       Effect.flatMap(response.json, (body) =>
+     *         typeof body === "object" && body !== null && "status" in body && body.status === "degraded"
+     *           ? Effect.fail(new Degraded())
+     *           : Effect.succeed(response))
+     *     )),
+     *     HttpClient.withCircuitBreaker({
+     *       breaker,
+     *       classify: (exit) =>
+     *         Option.exists(Exit.findErrorOption(exit), (error) => error._tag === "Degraded")
+     *           ? CircuitBreaker.failure()
+     *           : HttpClient.circuitBreakerClassifier(exit)
+     *     })
+     *   )
+     *
+     *   yield* Effect.flip(client.get("http://status.test/"))
+     *   const state = yield* breaker.state("http://status.test")
+     *   return state._tag
+     * }).pipe(Effect.scoped, Effect.provide(CircuitBreaker.layerStoreMemory()))
+     *
+     * await Effect.runPromise(program) // => "Open"
+     * ```
+     *
+     * @stability experimental
+     * @category circuit breaking
+     * @since 4.0.6
+     */
+    <E, R2 = never>(options: WithCircuitBreaker.Options<E, R2>): <R>(self: HttpClient.With<E, R>) => HttpClient.With<E | CircuitBreaker.CircuitBreakerError, R | R2>;
+    /**
+     * Guards requests with a `CircuitBreaker`.
+     *
+     * **Details**
+     *
+     * Requests are keyed by origin unless `key` is set, and classified with
+     * `circuitBreakerClassifier` unless `classify` is set. A rejected request
+     * fails with `CircuitBreakerError` without reaching the wrapped client.
+     *
+     * Apply it after `withRateLimiter` and `retryTransient`, so the breaker sees
+     * one outcome per call and an open circuit skips the retry loop.
+     * `retryTransient` never retries a `CircuitBreakerError`. A custom `classify`
+     * can delegate the cases it doesn't handle to `circuitBreakerClassifier`.
+     *
+     * **Gotchas**
+     *
+     * - The breaker only sees the response headers. To count an error in the
+     *   body, lift it into the error channel below the breaker with
+     *   `transformResponse` and count it in `classify`.
+     * - `withRateLimiter` retries `429` without limit by default, which can hold
+     *   the probe slot for minutes. Set its `times`.
+     * - A rejected request has no client span. The rejection fails the caller's
+     *   span instead.
+     *
+     * **Example** (Guarding an API in the recommended order)
+     *
+     * ```ts import.meta.vitest
+     * import { Effect, Layer, Ref, Schedule } from "effect"
+     * import { HttpClient, HttpClientRequest, HttpClientResponse } from "effect/http"
+     * import { CircuitBreaker, RateLimiter } from "effect/persistence"
+     *
+     * const program = Effect.gen(function*() {
+     *   const requests = yield* Ref.make(0)
+     *   // A dependency that always answers 503.
+     *   const unavailable = HttpClient.make((request) =>
+     *     Effect.as(Ref.update(requests, (n) => n + 1), HttpClientResponse.fromWeb(request, new Response(null, { status: 503 })))
+     *   )
+     *
+     *   const breaker = yield* CircuitBreaker.make({
+     *     tripPolicy: CircuitBreaker.consecutive(1),
+     *     openDuration: "30 seconds"
+     *   })
+     *   const client = unavailable.pipe(
+     *     HttpClient.withRateLimiter({
+     *       limiter: yield* RateLimiter.RateLimiter,
+     *       key: "inventory",
+     *       limit: 100,
+     *       window: "1 second",
+     *       times: 3
+     *     }),
+     *     HttpClient.retryTransient({ times: 2, schedule: Schedule.exponential("1 millis") }),
+     *     HttpClient.withCircuitBreaker({ breaker })
+     *   )
+     *
+     *   // Three attempts, then the breaker records one failure and opens.
+     *   yield* client.execute(HttpClientRequest.get("http://inventory.test/items"))
+     *   // Rejected before the retry loop starts, so no further request is sent.
+     *   const rejected = yield* Effect.flip(client.execute(HttpClientRequest.get("http://inventory.test/items")))
+     *
+     *   return [yield* Ref.get(requests), rejected._tag]
+     * }).pipe(
+     *   Effect.scoped,
+     *   Effect.provide(Layer.merge(
+     *     CircuitBreaker.layerStoreMemory(),
+     *     RateLimiter.layer.pipe(Layer.provide(RateLimiter.layerStoreMemory))
+     *   ))
+     * )
+     *
+     * await Effect.runPromise(program) // => [3, "CircuitBreakerError"]
+     * ```
+     *
+     * **Example** (Counting an error in the body as a failure)
+     *
+     * This API answers `200` with `{ "status": "degraded" }` when it is failing.
+     *
+     * ```ts import.meta.vitest
+     * import { Data, Effect, Exit, Option } from "effect"
+     * import { HttpClient, HttpClientRequest, HttpClientResponse } from "effect/http"
+     * import { CircuitBreaker } from "effect/persistence"
+     *
+     * class Degraded extends Data.TaggedError("Degraded") {}
+     *
+     * const degraded = HttpClient.make((request) =>
+     *   Effect.succeed(HttpClientResponse.fromWeb(request, Response.json({ status: "degraded" })))
+     * )
+     *
+     * const program = Effect.gen(function*() {
+     *   const breaker = yield* CircuitBreaker.make({
+     *     tripPolicy: CircuitBreaker.consecutive(1),
+     *     openDuration: "30 seconds"
+     *   })
+     *   const client = degraded.pipe(
+     *     HttpClient.transformResponse(Effect.flatMap((response) =>
+     *       Effect.flatMap(response.json, (body) =>
+     *         typeof body === "object" && body !== null && "status" in body && body.status === "degraded"
+     *           ? Effect.fail(new Degraded())
+     *           : Effect.succeed(response))
+     *     )),
+     *     HttpClient.withCircuitBreaker({
+     *       breaker,
+     *       classify: (exit) =>
+     *         Option.exists(Exit.findErrorOption(exit), (error) => error._tag === "Degraded")
+     *           ? CircuitBreaker.failure()
+     *           : HttpClient.circuitBreakerClassifier(exit)
+     *     })
+     *   )
+     *
+     *   yield* Effect.flip(client.get("http://status.test/"))
+     *   const state = yield* breaker.state("http://status.test")
+     *   return state._tag
+     * }).pipe(Effect.scoped, Effect.provide(CircuitBreaker.layerStoreMemory()))
+     *
+     * await Effect.runPromise(program) // => "Open"
+     * ```
+     *
+     * @stability experimental
+     * @category circuit breaking
+     * @since 4.0.6
+     */
+    <E, R, R2 = never>(self: HttpClient.With<E, R>, options: WithCircuitBreaker.Options<E, R2>): HttpClient.With<E | CircuitBreaker.CircuitBreakerError, R | R2>;
+};
+/**
+ * The default `withCircuitBreaker` classifier.
+ *
+ * **Details**
+ *
+ * - Failure: status 408, 500, 502, 503 or 504, returned or wrapped in a
+ *   `StatusCodeError`, and any `TransportError` or `Cause.TimeoutError`.
+ * - Success: any other response, including other 4xx, since the dependency
+ *   answered.
+ * - Ignored: status 429 (left to `withRateLimiter`), `EncodeError`,
+ *   `InvalidUrlError`, `DecodeError`, `EmptyBodyError`, unknown typed errors
+ *   and defects. HttpClient errors are typed, so a defect here is a bug in
+ *   the caller.
+ *
+ * When a cause holds several errors, a failure beats a success and a success
+ * beats an ignored outcome. A failure carries the longest `Retry-After` it
+ * saw. The result is an `Effect` only because parsing an HTTP-date
+ * `Retry-After` reads `Clock`.
+ *
+ * **Gotchas**
+ *
+ * `TransportError` also covers client-side refusals, which count as failures.
+ *
+ * @stability experimental
+ * @category circuit breaking
+ * @since 4.0.6
+ */
+export declare const circuitBreakerClassifier: <E>(exit: Exit.Exit<HttpClientResponse.HttpClientResponse, E>) => Effect.Effect<CircuitBreaker.Outcome>;
 /**
  * Performs an additional effect after a successful request.
  *
@@ -1057,6 +1480,37 @@ export declare const withScope: <E, R>(self: HttpClient.With<E, R>) => HttpClien
 /**
  * Enables following HTTP redirects up to a specified number of times.
  *
+ * **Details**
+ *
+ * Follows `3xx` responses that include a `Location` header, up to
+ * `maxRedirects` (default `10`) times. When the limit is reached or the
+ * `Location` header is not a valid URL, the last redirect response is returned.
+ *
+ * **Gotchas**
+ *
+ * This only sees redirects that the underlying client returns. `fetch`
+ * follows redirects itself by default, so with `FetchHttpClient` provide
+ * `FetchHttpClient.RequestInit` with `{ redirect: "manual" }`. Browsers return
+ * an opaque response without a `Location` header for manual redirects, so
+ * this cannot follow them there.
+ *
+ * **Example** (Following redirects with FetchHttpClient)
+ *
+ * ```ts
+ * import { Effect } from "effect"
+ * import { FetchHttpClient, HttpClient } from "effect/http"
+ *
+ * const program = Effect.gen(function*() {
+ *   const client = (yield* HttpClient.HttpClient).pipe(
+ *     HttpClient.followRedirects(5)
+ *   )
+ *   return yield* client.get("https://example.com/redirect")
+ * }).pipe(
+ *   Effect.provide(FetchHttpClient.layer),
+ *   Effect.provideService(FetchHttpClient.RequestInit, { redirect: "manual" })
+ * )
+ * ```
+ *
  * @stability unstable
  * @category redirects
  * @since 4.0.0
@@ -1065,6 +1519,37 @@ export declare const followRedirects: {
     /**
      * Enables following HTTP redirects up to a specified number of times.
      *
+     * **Details**
+     *
+     * Follows `3xx` responses that include a `Location` header, up to
+     * `maxRedirects` (default `10`) times. When the limit is reached or the
+     * `Location` header is not a valid URL, the last redirect response is returned.
+     *
+     * **Gotchas**
+     *
+     * This only sees redirects that the underlying client returns. `fetch`
+     * follows redirects itself by default, so with `FetchHttpClient` provide
+     * `FetchHttpClient.RequestInit` with `{ redirect: "manual" }`. Browsers return
+     * an opaque response without a `Location` header for manual redirects, so
+     * this cannot follow them there.
+     *
+     * **Example** (Following redirects with FetchHttpClient)
+     *
+     * ```ts
+     * import { Effect } from "effect"
+     * import { FetchHttpClient, HttpClient } from "effect/http"
+     *
+     * const program = Effect.gen(function*() {
+     *   const client = (yield* HttpClient.HttpClient).pipe(
+     *     HttpClient.followRedirects(5)
+     *   )
+     *   return yield* client.get("https://example.com/redirect")
+     * }).pipe(
+     *   Effect.provide(FetchHttpClient.layer),
+     *   Effect.provideService(FetchHttpClient.RequestInit, { redirect: "manual" })
+     * )
+     * ```
+     *
      * @stability unstable
      * @category redirects
      * @since 4.0.0
@@ -1073,6 +1558,37 @@ export declare const followRedirects: {
     /**
      * Enables following HTTP redirects up to a specified number of times.
      *
+     * **Details**
+     *
+     * Follows `3xx` responses that include a `Location` header, up to
+     * `maxRedirects` (default `10`) times. When the limit is reached or the
+     * `Location` header is not a valid URL, the last redirect response is returned.
+     *
+     * **Gotchas**
+     *
+     * This only sees redirects that the underlying client returns. `fetch`
+     * follows redirects itself by default, so with `FetchHttpClient` provide
+     * `FetchHttpClient.RequestInit` with `{ redirect: "manual" }`. Browsers return
+     * an opaque response without a `Location` header for manual redirects, so
+     * this cannot follow them there.
+     *
+     * **Example** (Following redirects with FetchHttpClient)
+     *
+     * ```ts
+     * import { Effect } from "effect"
+     * import { FetchHttpClient, HttpClient } from "effect/http"
+     *
+     * const program = Effect.gen(function*() {
+     *   const client = (yield* HttpClient.HttpClient).pipe(
+     *     HttpClient.followRedirects(5)
+     *   )
+     *   return yield* client.get("https://example.com/redirect")
+     * }).pipe(
+     *   Effect.provide(FetchHttpClient.layer),
+     *   Effect.provideService(FetchHttpClient.RequestInit, { redirect: "manual" })
+     * )
+     * ```
+     *
      * @stability unstable
      * @category redirects
      * @since 4.0.0