effect 4.0.4 → 4.0.6

package/src/http/HttpClient.ts

@@ -46,7 +46,9 @@ import * as HttpIncomingMessage from "./HttpIncomingMessage.ts"
 import * as HttpMethod from "./HttpMethod.ts"
 import * as TraceContext from "./HttpTraceContext.ts"
 import * as tracing from "./internal/tracing.ts"
+import { getWebSource, WebSourceSymbol } from "./internal/webResponse.ts"
 import * as Url from "./Url.ts"
+import * as UrlParams from "./UrlParams.ts"
 
 const TypeId = "~effect/http/HttpClient"
 
@@ -466,56 +468,7 @@ export const catchTag: {
     transformResponse(
       self,
       (effect) =>
-        Effect.catchTag</**
-         * Handles client failures with one or more matching `_tag` values and returns a transformed client.
-         *
-         * @stability unstable
-         * @category error handling
-         * @since 4.0.0
-         */
-        HttpClientResponse.HttpClientResponse, /**
-         * Handles client failures with one or more matching `_tag` values and returns a transformed client.
-         *
-         * @stability unstable
-         * @category error handling
-         * @since 4.0.0
-         */
-        E, /**
-         * Handles client failures with one or more matching `_tag` values and returns a transformed client.
-         *
-         * @stability unstable
-         * @category error handling
-         * @since 4.0.0
-         */
-        R, /**
-         * Handles client failures with one or more matching `_tag` values and returns a transformed client.
-         *
-         * @stability unstable
-         * @category error handling
-         * @since 4.0.0
-         */
-        K, /**
-         * Handles client failures with one or more matching `_tag` values and returns a transformed client.
-         *
-         * @stability unstable
-         * @category error handling
-         * @since 4.0.0
-         */
-        R1, /**
-         * Handles client failures with one or more matching `_tag` values and returns a transformed client.
-         *
-         * @stability unstable
-         * @category error handling
-         * @since 4.0.0
-         */
-        E1, /**
-         * Handles client failures with one or more matching `_tag` values and returns a transformed client.
-         *
-         * @stability unstable
-         * @category error handling
-         * @since 4.0.0
-         */
-        HttpClientResponse.HttpClientResponse>(
+        Effect.catchTag<HttpClientResponse.HttpClientResponse, E, R, K, R1, E1, HttpClientResponse.HttpClientResponse>(
           effect,
           tag,
           f
@@ -905,7 +858,11 @@ export const make = (
           (span) => {
             span.attribute("http.request.method", request.method)
             const redactedHeaderNames = fiber.getRef(Headers.CurrentRedactedNames)
-            tracing.addUrlAttributes(span, url)
+            tracing.addUrlAttributes(
+              span,
+              url,
+              tracing.redactedNames(request.urlParams, fiber.getRef(UrlParams.CurrentRedactedNames))
+            )
             const headerFilter = fiber.getRef(TracerHeaderFilter)
             tracing.addHeaderAttributes(span, "request", request.headers, headerFilter, redactedHeaderNames)
             request = fiber.getRef(TracerPropagationEnabled)
@@ -1636,81 +1593,18 @@ export const withRateLimiter: {
     ) => {
       onResponse?.(clock, key, response.headers, tokens, sent)
       if (options.disableResponseInspection || response.status !== 429) {
-        return Effect.succeed</**
-         * Applies request rate limiting using the `RateLimiter` service.
-         *
-         * **Details**
-         *
-         * It can update limits by inspecting common rate limit response headers and
-         * automatically retries HTTP `429` responses (or `HttpClientError` values
-         * wrapping a `429` response) by forcing the retry back through the limiter.
-         * When a response reports the remaining budget, requests wait for the
-         * reported reset once that budget is exhausted.
-         *
-         * **Gotchas**
-         *
-         * Automatic HTTP `429` retries are unlimited unless `times` is specified.
-         * Disabling response inspection does not disable retries; set `times` to `0`
-         * to return or fail with the first `429`.
-         *
-         * @stability unstable
-         * @category rate limiting
-         * @since 4.0.0
-         */
-        Duration.Duration | undefined>(undefined);
+        return Effect.succeed<Duration.Duration | undefined>(undefined)
       }
       const retryAfter = parseRetryAfter(
         clock.currentTimeMillisUnsafe(),
         getHeader(response.headers, ...headerNames.retryAfter)
       )
       if (retryAfter === undefined) {
-        return Effect.succeed</**
-         * Applies request rate limiting using the `RateLimiter` service.
-         *
-         * **Details**
-         *
-         * It can update limits by inspecting common rate limit response headers and
-         * automatically retries HTTP `429` responses (or `HttpClientError` values
-         * wrapping a `429` response) by forcing the retry back through the limiter.
-         * When a response reports the remaining budget, requests wait for the
-         * reported reset once that budget is exhausted.
-         *
-         * **Gotchas**
-         *
-         * Automatic HTTP `429` retries are unlimited unless `times` is specified.
-         * Disabling response inspection does not disable retries; set `times` to `0`
-         * to return or fail with the first `429`.
-         *
-         * @stability unstable
-         * @category rate limiting
-         * @since 4.0.0
-         */
-        Duration.Duration | undefined>(undefined);
+        return Effect.succeed<Duration.Duration | undefined>(undefined)
       }
       const delay = parseRateLimitWindow(clock, response.headers, headerNames) ?? retryAfter
       if (adaptive === undefined) {
-        return Effect.succeed</**
-         * Applies request rate limiting using the `RateLimiter` service.
-         *
-         * **Details**
-         *
-         * It can update limits by inspecting common rate limit response headers and
-         * automatically retries HTTP `429` responses (or `HttpClientError` values
-         * wrapping a `429` response) by forcing the retry back through the limiter.
-         * When a response reports the remaining budget, requests wait for the
-         * reported reset once that budget is exhausted.
-         *
-         * **Gotchas**
-         *
-         * Automatic HTTP `429` retries are unlimited unless `times` is specified.
-         * Disabling response inspection does not disable retries; set `times` to `0`
-         * to return or fail with the first `429`.
-         *
-         * @stability unstable
-         * @category rate limiting
-         * @since 4.0.0
-         */
-        Duration.Duration | undefined>(delay);
+        return Effect.succeed<Duration.Duration | undefined>(delay)
       }
       return Effect.as(
         options.limiter.adaptiveFeedback({
@@ -1781,7 +1675,7 @@ export const withRateLimiter: {
         return Duration.isZero(delay) ? runAdaptive() : Effect.flatMap(Effect.sleep(delay), runAdaptive)
       }
     )
-  });
+  })
 })
 
 interface RateLimiterHeaderNames {
@@ -1883,6 +1777,8 @@ const parseRateLimitWindow = (
   return parseResetHeader(clock, getHeader(headers, ...headerNames.reset))
 }
 
+// An invalid Retry-After is treated as absent (RFC 9110 §10.2.3); the
+// one millisecond floor keeps a past date or `0` from retrying immediately.
 const parseRetryAfter = (
   nowMillis: number,
   value: string | undefined
@@ -1890,22 +1786,10 @@ const parseRetryAfter = (
   if (value === undefined) {
     return undefined
   }
-  const trimmed = value.trim()
-  if (/^\d+(?:\.\d+)?$/.test(trimmed)) {
-    const numeric = Number(trimmed)
-    return Number.isFinite(numeric)
-      ? Duration.max(Duration.seconds(numeric), Duration.millis(1))
-      : undefined
-  }
-  const parsedDate = Date.parse(trimmed)
-  if (Number.isNaN(parsedDate)) {
-    return undefined
-  }
-  const millis = parsedDate - nowMillis
-  if (millis <= 0) {
-    return Duration.millis(1)
-  }
-  return Duration.millis(millis)
+  const retryAfter = Headers.parseRetryAfter(value)
+  return Result.isSuccess(retryAfter)
+    ? Duration.max(Headers.retryAfterDelay(retryAfter.success, nowMillis), Duration.millis(1))
+    : undefined
 }
 
 const parseResetAfter = (value: string | undefined): Duration.Duration | undefined => {
@@ -2152,6 +2036,37 @@ export const withScope = <E, R>(
 /**
  * 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
@@ -2160,6 +2075,37 @@ export 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
@@ -2168,6 +2114,37 @@ export 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
@@ -2197,7 +2174,11 @@ export const followRedirects: {
               ) {
                 return Effect.succeed(response)
               }
-              const url = new URL(response.headers.location, response.request.url)
+              const urlResult = Url.fromString(response.headers.location, response.request.url)
+              if (Result.isFailure(urlResult)) {
+                return Effect.succeed(response)
+              }
+              const url = urlResult.success
               const request = currentRequest ?? response.request
               let nextRequest = request
               if (
@@ -2255,6 +2236,18 @@ export const TracerHeaderFilter = Context.Reference<
 /**
  * Context reference that controls whether outgoing client spans are propagated to request headers.
  *
+ * **Details**
+ *
+ * When this is `true`, the client writes the compact B3 `b3` header and the
+ * W3C `traceparent` header. The default is on. The client span is still
+ * created when this is `false`.
+ *
+ * **Gotchas**
+ *
+ * A browser preflight fails when the target does not list `b3` and
+ * `traceparent` in `Access-Control-Allow-Headers`. Set this to `false` for
+ * those requests.
+ *
  * @stability unstable
  * @category services
  * @since 4.0.0
@@ -2307,7 +2300,11 @@ export const layerMergedContext = <E, R>(
 const responseRegistry = (() => {
   if ("FinalizationRegistry" in globalThis && globalThis.FinalizationRegistry) {
     const registry = new FinalizationRegistry((controller: AbortController) => {
-      controller.abort()
+      try {
+        controller.abort()
+      } catch {
+        // Runtimes such as workerd disallow aborting I/O outside its request context.
+      }
     })
     return {
       register(response: HttpClientResponse.HttpClientResponse, controller: AbortController) {
@@ -2407,6 +2404,17 @@ class InterruptibleResponse implements HttpClientResponse.HttpClientResponse, Pi
     return this.applyInterrupt(this.original.arrayBuffer)
   }
 
+  get upgrade() {
+    return this.applyInterrupt(this.original.upgrade)
+  }
+
+  [WebSourceSymbol]() {
+    const source = getWebSource(this.original)
+    // A handed-over Web body outlives this wrapper, so collecting it must not abort the request.
+    if (source !== undefined) responseRegistry.unregister(this.original)
+    return source
+  }
+
   get stream() {
     return Stream.suspend(() => {
       responseRegistry.unregister(this.original)

package/src/http/HttpClientError.ts

@@ -15,6 +15,7 @@ import { hasProperty } from "../Predicate.ts"
 import * as Schema from "../Schema.ts"
 import type * as HttpClientRequest from "./HttpClientRequest.ts"
 import type * as ClientResponse from "./HttpClientResponse.ts"
+import * as UrlParams from "./UrlParams.ts"
 
 const TypeId = "~effect/http/HttpClientError"
 
@@ -88,6 +89,9 @@ const formatReason = (tag: string) => tag.endsWith("Error") ? tag.slice(0, -5) :
 const formatMessage = (reason: string, description: string | undefined, info: string) =>
   description ? `${reason}: ${description} (${info})` : `${reason} error (${info})`
 
+const formatMethodAndUrl = (request: HttpClientRequest.HttpClientRequest) =>
+  `${request.method} ${UrlParams.redactUrl(request.url)}`
+
 /**
  * Error describing transport-level failures that occur while sending an HTTP request.
  *
@@ -107,7 +111,7 @@ export class TransportError extends Data.TaggedError("TransportError")<{
    * @since 4.0.0
    */
   get methodAndUrl() {
-    return `${this.request.method} ${this.request.url}`
+    return formatMethodAndUrl(this.request)
   }
 
   /**
@@ -140,7 +144,7 @@ export class EncodeError extends Data.TaggedError("EncodeError")<{
    * @since 4.0.0
    */
   get methodAndUrl() {
-    return `${this.request.method} ${this.request.url}`
+    return formatMethodAndUrl(this.request)
   }
 
   /**
@@ -173,7 +177,7 @@ export class InvalidUrlError extends Data.TaggedError("InvalidUrlError")<{
    * @since 4.0.0
    */
   get methodAndUrl() {
-    return `${this.request.method} ${this.request.url}`
+    return formatMethodAndUrl(this.request)
   }
 
   /**
@@ -207,7 +211,7 @@ export class StatusCodeError extends Data.TaggedError("StatusCodeError")<{
    * @since 4.0.0
    */
   get methodAndUrl() {
-    return `${this.request.method} ${this.request.url}`
+    return formatMethodAndUrl(this.request)
   }
 
   /**
@@ -242,7 +246,7 @@ export class DecodeError extends Data.TaggedError("DecodeError")<{
    * @since 4.0.0
    */
   get methodAndUrl() {
-    return `${this.request.method} ${this.request.url}`
+    return formatMethodAndUrl(this.request)
   }
 
   /**
@@ -277,7 +281,7 @@ export class EmptyBodyError extends Data.TaggedError("EmptyBodyError")<{
    * @since 4.0.0
    */
   get methodAndUrl() {
-    return `${this.request.method} ${this.request.url}`
+    return formatMethodAndUrl(this.request)
   }
 
   /**