effect 4.0.0-beta.101 → 4.0.0-beta.103

package/src/unstable/http/HttpClient.ts

@@ -34,6 +34,7 @@ import type { EqualsWith, ExcludeTag, ExtractTag, NoExcessProperties, NoInfer, T
 import type * as RateLimiter from "../persistence/RateLimiter.ts"
 import * as Cookies from "./Cookies.ts"
 import * as Headers from "./Headers.ts"
+import * as HttpBody from "./HttpBody.ts"
 import * as Error from "./HttpClientError.ts"
 import * as HttpClientRequest from "./HttpClientRequest.ts"
 import * as HttpClientResponse from "./HttpClientResponse.ts"
@@ -257,7 +258,7 @@ export const options: (url: string | URL, options?: HttpClientRequest.Options.No
  *
  * The transformation receives both the response effect and the original request, allowing it to change success, error, and environment behavior.
  *
- * @category mapping & sequencing
+ * @category mapping
  * @since 4.0.0
  */
 export const transform: {
@@ -268,7 +269,7 @@ export const transform: {
    *
    * The transformation receives both the response effect and the original request, allowing it to change success, error, and environment behavior.
    *
-   * @category mapping & sequencing
+   * @category mapping
    * @since 4.0.0
    */
   <E, R, E1, R1>(
@@ -284,7 +285,7 @@ export const transform: {
    *
    * The transformation receives both the response effect and the original request, allowing it to change success, error, and environment behavior.
    *
-   * @category mapping & sequencing
+   * @category mapping
    * @since 4.0.0
    */
   <E, R, E1, R1>(
@@ -309,14 +310,14 @@ export const transform: {
 /**
  * Transforms a client by applying an effectful transformation to each response effect.
  *
- * @category mapping & sequencing
+ * @category mapping
  * @since 4.0.0
  */
 export const transformResponse: {
   /**
    * Transforms a client by applying an effectful transformation to each response effect.
    *
-   * @category mapping & sequencing
+   * @category mapping
    * @since 4.0.0
    */
   <E, R, E1, R1>(
@@ -327,7 +328,7 @@ export const transformResponse: {
   /**
    * Transforms a client by applying an effectful transformation to each response effect.
    *
-   * @category mapping & sequencing
+   * @category mapping
    * @since 4.0.0
    */
   <E, R, E1, R1>(
@@ -569,14 +570,14 @@ export const catchTags: {
 /**
  * Filters the result of a response, or runs an alternative effect if the predicate fails.
  *
- * @category filters
+ * @category filtering
  * @since 4.0.0
  */
 export const filterOrElse: {
   /**
    * Filters the result of a response, or runs an alternative effect if the predicate fails.
    *
-   * @category filters
+   * @category filtering
    * @since 4.0.0
    */
   <B extends HttpClientResponse.HttpClientResponse, E2, R2>(
@@ -593,7 +594,7 @@ export const filterOrElse: {
   /**
    * Filters the result of a response, or runs an alternative effect if the predicate fails.
    *
-   * @category filters
+   * @category filtering
    * @since 4.0.0
    */
   <E2, R2>(
@@ -605,7 +606,7 @@ export const filterOrElse: {
   /**
    * Filters the result of a response, or runs an alternative effect if the predicate fails.
    *
-   * @category filters
+   * @category filtering
    * @since 4.0.0
    */
   <E, R, B extends HttpClientResponse.HttpClientResponse, E2, R2>(
@@ -623,7 +624,7 @@ export const filterOrElse: {
   /**
    * Filters the result of a response, or runs an alternative effect if the predicate fails.
    *
-   * @category filters
+   * @category filtering
    * @since 4.0.0
    */
   <E, R, E2, R2>(
@@ -638,14 +639,14 @@ export const filterOrElse: {
 /**
  * Filters successful responses, or fails with the error produced by `orFailWith` when the predicate does not match.
  *
- * @category filters
+ * @category filtering
  * @since 4.0.0
  */
 export const filterOrFail: {
   /**
    * Filters successful responses, or fails with the error produced by `orFailWith` when the predicate does not match.
    *
-   * @category filters
+   * @category filtering
    * @since 4.0.0
    */
   <B extends HttpClientResponse.HttpClientResponse, E2>(
@@ -655,7 +656,7 @@ export const filterOrFail: {
   /**
    * Filters successful responses, or fails with the error produced by `orFailWith` when the predicate does not match.
    *
-   * @category filters
+   * @category filtering
    * @since 4.0.0
    */
   <E2>(
@@ -665,7 +666,7 @@ export const filterOrFail: {
   /**
    * Filters successful responses, or fails with the error produced by `orFailWith` when the predicate does not match.
    *
-   * @category filters
+   * @category filtering
    * @since 4.0.0
    */
   <E, R, B extends HttpClientResponse.HttpClientResponse, E2>(
@@ -676,7 +677,7 @@ export const filterOrFail: {
   /**
    * Filters successful responses, or fails with the error produced by `orFailWith` when the predicate does not match.
    *
-   * @category filters
+   * @category filtering
    * @since 4.0.0
    */
   <E, R, E2>(
@@ -689,21 +690,21 @@ export const filterOrFail: {
 /**
  * Filters responses by HTTP status code.
  *
- * @category filters
+ * @category filtering
  * @since 4.0.0
  */
 export const filterStatus: {
   /**
    * Filters responses by HTTP status code.
    *
-   * @category filters
+   * @category filtering
    * @since 4.0.0
    */
   (f: (status: number) => boolean): <E, R>(self: HttpClient.With<E, R>) => HttpClient.With<E | Error.HttpClientError, R>
   /**
    * Filters responses by HTTP status code.
    *
-   * @category filters
+   * @category filtering
    * @since 4.0.0
    */
   <E, R>(self: HttpClient.With<E, R>, f: (status: number) => boolean): HttpClient.With<E | Error.HttpClientError, R>
@@ -716,7 +717,7 @@ export const filterStatus: {
 /**
  * Filters responses that return a 2xx status code.
  *
- * @category filters
+ * @category filtering
  * @since 4.0.0
  */
 export const filterStatusOk: <E, R>(self: HttpClient.With<E, R>) => HttpClient.With<E | Error.HttpClientError, R> =
@@ -839,8 +840,10 @@ export const make = (
               span.attribute("url.query", query)
             }
             const redactedHeaderNames = fiber.getRef(Headers.CurrentRedactedNames)
+            const headerFilter = fiber.getRef(TracerHeaderFilter)
             const redactedHeaders = Headers.redact(request.headers, redactedHeaderNames)
             for (const name in redactedHeaders) {
+              if (!headerFilter(name, "request")) continue
               span.attribute(`http.request.header.${name}`, String(redactedHeaders[name]))
             }
             request = fiber.getRef(TracerPropagationEnabled)
@@ -854,6 +857,7 @@ export const make = (
                     span.attribute("http.response.status_code", response.status)
                     const redactedHeaders = Headers.redact(response.headers, redactedHeaderNames)
                     for (const name in redactedHeaders) {
+                      if (!headerFilter(name, "response")) continue
                       span.attribute(`http.response.header.${name}`, String(redactedHeaders[name]))
                     }
 
@@ -877,14 +881,14 @@ export const make = (
 /**
  * Appends a transformation of the request object before sending it.
  *
- * @category mapping & sequencing
+ * @category mapping
  * @since 4.0.0
  */
 export const mapRequest: {
   /**
    * Appends a transformation of the request object before sending it.
    *
-   * @category mapping & sequencing
+   * @category mapping
    * @since 4.0.0
    */
   (
@@ -893,7 +897,7 @@ export const mapRequest: {
   /**
    * Appends a transformation of the request object before sending it.
    *
-   * @category mapping & sequencing
+   * @category mapping
    * @since 4.0.0
    */
   <E, R>(
@@ -911,14 +915,14 @@ export const mapRequest: {
 /**
  * Appends an effectful transformation of the request object before sending it.
  *
- * @category mapping & sequencing
+ * @category mapping
  * @since 4.0.0
  */
 export const mapRequestEffect: {
   /**
    * Appends an effectful transformation of the request object before sending it.
    *
-   * @category mapping & sequencing
+   * @category mapping
    * @since 4.0.0
    */
   <E2, R2>(
@@ -927,7 +931,7 @@ export const mapRequestEffect: {
   /**
    * Appends an effectful transformation of the request object before sending it.
    *
-   * @category mapping & sequencing
+   * @category mapping
    * @since 4.0.0
    */
   <E, R, E2, R2>(
@@ -946,14 +950,14 @@ export const mapRequestEffect: {
 /**
  * Prepends a transformation of the request object before sending it.
  *
- * @category mapping & sequencing
+ * @category mapping
  * @since 4.0.0
  */
 export const mapRequestInput: {
   /**
    * Prepends a transformation of the request object before sending it.
    *
-   * @category mapping & sequencing
+   * @category mapping
    * @since 4.0.0
    */
   (
@@ -962,7 +966,7 @@ export const mapRequestInput: {
   /**
    * Prepends a transformation of the request object before sending it.
    *
-   * @category mapping & sequencing
+   * @category mapping
    * @since 4.0.0
    */
   <E, R>(
@@ -980,14 +984,14 @@ export const mapRequestInput: {
 /**
  * Prepends an effectful transformation of the request object before sending it.
  *
- * @category mapping & sequencing
+ * @category mapping
  * @since 4.0.0
  */
 export const mapRequestInputEffect: {
   /**
    * Prepends an effectful transformation of the request object before sending it.
    *
-   * @category mapping & sequencing
+   * @category mapping
    * @since 4.0.0
    */
   <E2, R2>(
@@ -996,7 +1000,7 @@ export const mapRequestInputEffect: {
   /**
    * Prepends an effectful transformation of the request object before sending it.
    *
-   * @category mapping & sequencing
+   * @category mapping
    * @since 4.0.0
    */
   <E, R, E2, R2>(
@@ -1654,14 +1658,14 @@ const getHeader = (headers: Headers.Headers, ...keys: Array<string>): string | u
 /**
  * Performs an additional effect after a successful request.
  *
- * @category mapping & sequencing
+ * @category sequencing
  * @since 4.0.0
  */
 export const tap: {
   /**
    * Performs an additional effect after a successful request.
    *
-   * @category mapping & sequencing
+   * @category sequencing
    * @since 4.0.0
    */
   <_, E2, R2>(
@@ -1670,7 +1674,7 @@ export const tap: {
   /**
    * Performs an additional effect after a successful request.
    *
-   * @category mapping & sequencing
+   * @category sequencing
    * @since 4.0.0
    */
   <E, R, _, E2, R2>(
@@ -1688,21 +1692,21 @@ export const tap: {
 /**
  * Performs an additional effect after an unsuccessful request.
  *
- * @category mapping & sequencing
+ * @category sequencing
  * @since 4.0.0
  */
 export const tapError: {
   /**
    * Performs an additional effect after an unsuccessful request.
    *
-   * @category mapping & sequencing
+   * @category sequencing
    * @since 4.0.0
    */
   <_, E, E2, R2>(f: (e: NoInfer<E>) => Effect.Effect<_, E2, R2>): <R>(self: HttpClient.With<E, R>) => HttpClient.With<E | E2, R | R2>
   /**
    * Performs an additional effect after an unsuccessful request.
    *
-   * @category mapping & sequencing
+   * @category sequencing
    * @since 4.0.0
    */
   <E, R, _, E2, R2>(
@@ -1720,21 +1724,21 @@ export const tapError: {
 /**
  * Performs an additional effect on the request before sending it.
  *
- * @category mapping & sequencing
+ * @category sequencing
  * @since 4.0.0
  */
 export const tapRequest: {
   /**
    * Performs an additional effect on the request before sending it.
    *
-   * @category mapping & sequencing
+   * @category sequencing
    * @since 4.0.0
    */
   <_, E2, R2>(f: (a: HttpClientRequest.HttpClientRequest) => Effect.Effect<_, E2, R2>): <E, R>(self: HttpClient.With<E, R>) => HttpClient.With<E | E2, R | R2>
   /**
    * Performs an additional effect on the request before sending it.
    *
-   * @category mapping & sequencing
+   * @category sequencing
    * @since 4.0.0
    */
   <E, R, _, E2, R2>(
@@ -1864,17 +1868,29 @@ export const followRedirects: {
       ): Effect.Effect<HttpClientResponse.HttpClientResponse, E, R> =>
         Effect.flatMap(
           self.postprocess(Effect.succeed(request)),
-          (response) =>
-            response.status >= 300 && response.status < 400 && response.headers.location &&
-              redirects < (maxRedirects ?? 10)
-              ? loop(
-                HttpClientRequest.setUrl(
-                  request,
-                  new URL(response.headers.location, response.request.url)
-                ),
-                redirects + 1
-              )
-              : Effect.succeed(response)
+          (response) => {
+            if (
+              response.status < 300 || response.status >= 400 || !response.headers.location ||
+              redirects >= (maxRedirects ?? 10)
+            ) {
+              return Effect.succeed(response)
+            }
+            const url = new URL(response.headers.location, response.request.url)
+            let nextRequest = request
+            if (
+              ((response.status === 301 || response.status === 302) && request.method === "POST") ||
+              (response.status === 303 && request.method !== "GET" && request.method !== "HEAD")
+            ) {
+              nextRequest = HttpClientRequest.setMethod(nextRequest, "GET")
+              nextRequest = HttpClientRequest.setBody(nextRequest, HttpBody.empty)
+            }
+            if (url.origin !== new URL(response.request.url).origin) {
+              nextRequest = HttpClientRequest.removeHeader(nextRequest, "authorization")
+              nextRequest = HttpClientRequest.removeHeader(nextRequest, "proxy-authorization")
+              nextRequest = HttpClientRequest.removeHeader(nextRequest, "cookie")
+            }
+            return loop(HttpClientRequest.setUrl(nextRequest, url), redirects + 1)
+          }
         )
       return Effect.flatMap(request, (request) => loop(request, 0))
     },
@@ -1884,7 +1900,7 @@ export const followRedirects: {
 /**
  * Context reference for a predicate that disables client-side tracing for matching outgoing requests.
  *
- * @category references
+ * @category services
  * @since 4.0.0
  */
 export const TracerDisabledWhen = Context.Reference<
@@ -1893,10 +1909,22 @@ export const TracerDisabledWhen = Context.Reference<
   defaultValue: () => constFalse
 })
 
+/**
+ * Context reference for filtering request and response headers added to client spans.
+ *
+ * @category services
+ * @since 4.0.0
+ */
+export const TracerHeaderFilter = Context.Reference<
+  (headerName: string, phase: "request" | "response") => boolean
+>("effect/http/HttpClient/TracerHeaderFilter", {
+  defaultValue: () => constTrue
+})
+
 /**
  * Context reference that controls whether outgoing client spans are propagated to request headers.
  *
- * @category references
+ * @category services
  * @since 4.0.0
  */
 export const TracerPropagationEnabled = Context.Reference<boolean>("effect/HttpClient/TracerPropagationEnabled", {
@@ -1906,7 +1934,7 @@ export const TracerPropagationEnabled = Context.Reference<boolean>("effect/HttpC
 /**
  * Context reference for generating the span name used for outgoing client request spans.
  *
- * @category references
+ * @category services
  * @since 4.0.0
  */
 export const SpanNameGenerator = Context.Reference<

package/src/unstable/http/HttpClientRequest.ts

@@ -375,6 +375,63 @@ export const setHeaders: {
     self.body
   ))
 
+/**
+ * Transforms the request headers with the provided function, returning a new request.
+ *
+ * @category combinators
+ * @since 4.0.0
+ */
+export const updateHeaders: {
+  /**
+   * Transforms the request headers with the provided function, returning a new request.
+   *
+   * @category combinators
+   * @since 4.0.0
+   */
+  (f: (headers: Headers.Headers) => Headers.Headers): (self: HttpClientRequest) => HttpClientRequest
+  /**
+   * Transforms the request headers with the provided function, returning a new request.
+   *
+   * @category combinators
+   * @since 4.0.0
+   */
+  (self: HttpClientRequest, f: (headers: Headers.Headers) => Headers.Headers): HttpClientRequest
+} = dual(2, (self: HttpClientRequest, f: (headers: Headers.Headers) => Headers.Headers): HttpClientRequest =>
+  makeWith(
+    self.method,
+    self.url,
+    self.urlParams,
+    self.hash,
+    f(self.headers),
+    self.body
+  ))
+
+/**
+ * Removes a single request header by name, returning a new request.
+ *
+ * @category combinators
+ * @since 4.0.0
+ */
+export const removeHeader: {
+  /**
+   * Removes a single request header by name, returning a new request.
+   *
+   * @category combinators
+   * @since 4.0.0
+   */
+  (key: string): (self: HttpClientRequest) => HttpClientRequest
+  /**
+   * Removes a single request header by name, returning a new request.
+   *
+   * @category combinators
+   * @since 4.0.0
+   */
+  (self: HttpClientRequest, key: string): HttpClientRequest
+} = dual(
+  2,
+  (self: HttpClientRequest, key: string): HttpClientRequest => updateHeaders(self, Headers.remove(key))
+)
+
 /**
  * Sets the `Authorization` header using HTTP Basic authentication credentials.
  *
@@ -826,6 +883,8 @@ export const setBody: {
     }
     if (body.contentLength !== undefined) {
       headers = Headers.set(headers, "content-length", body.contentLength.toString())
+    } else {
+      headers = Headers.remove(headers, "content-length")
     }
   }
   return makeWith(

package/src/unstable/http/HttpClientResponse.ts

@@ -213,21 +213,21 @@ export const matchStatus: {
 /**
  * Succeeds with the response when its status satisfies the predicate, otherwise fails with `HttpClientError`.
  *
- * @category filters
+ * @category filtering
  * @since 4.0.0
  */
 export const filterStatus: {
   /**
    * Succeeds with the response when its status satisfies the predicate, otherwise fails with `HttpClientError`.
    *
-   * @category filters
+   * @category filtering
    * @since 4.0.0
    */
   (f: (status: number) => boolean): (self: HttpClientResponse) => Effect.Effect<HttpClientResponse, Error.HttpClientError>
   /**
    * Succeeds with the response when its status satisfies the predicate, otherwise fails with `HttpClientError`.
    *
-   * @category filters
+   * @category filtering
    * @since 4.0.0
    */
   (self: HttpClientResponse, f: (status: number) => boolean): Effect.Effect<HttpClientResponse, Error.HttpClientError>
@@ -250,7 +250,7 @@ export const filterStatus: {
 /**
  * Succeeds with the response only when its status is in the 2xx range, otherwise fails with `HttpClientError`.
  *
- * @category filters
+ * @category filtering
  * @since 4.0.0
  */
 export const filterStatusOk = (self: HttpClientResponse): Effect.Effect<HttpClientResponse, Error.HttpClientError> =>

package/src/unstable/http/HttpEffect.ts

@@ -172,7 +172,7 @@ const scoped = <A, E, R>(effect: Effect.Effect<A, E, R>) =>
 /**
  * Function run with the current request and response just before the response is sent, allowing the response to be replaced or failing with `HttpServerError`.
  *
- * @category Pre-response handlers
+ * @category handlers
  * @since 4.0.0
  */
 export type PreResponseHandler = (
@@ -183,7 +183,7 @@ export type PreResponseHandler = (
 /**
  * Registers an additional pre-response handler for the current HTTP server request.
  *
- * @category fiber refs
+ * @category handlers
  * @since 4.0.0
  */
 export const appendPreResponseHandler = (handler: PreResponseHandler): Effect.Effect<void, never, HttpServerRequest> =>
@@ -195,7 +195,7 @@ export const appendPreResponseHandler = (handler: PreResponseHandler): Effect.Ef
 /**
  * Registers a pre-response handler for the supplied HTTP server request.
  *
- * @category fiber refs
+ * @category unsafe
  * @since 4.0.0
  */
 export const appendPreResponseHandlerUnsafe: (
@@ -206,21 +206,21 @@ export const appendPreResponseHandlerUnsafe: (
 /**
  * Runs an effect after registering a pre-response handler for the current HTTP server request.
  *
- * @category fiber refs
+ * @category handlers
  * @since 4.0.0
  */
 export const withPreResponseHandler: {
   /**
    * Runs an effect after registering a pre-response handler for the current HTTP server request.
    *
-   * @category fiber refs
+   * @category handlers
    * @since 4.0.0
    */
   (handler: PreResponseHandler): <A, E, R>(self: Effect.Effect<A, E, R>) => Effect.Effect<A, E, R | HttpServerRequest>
   /**
    * Runs an effect after registering a pre-response handler for the current HTTP server request.
    *
-   * @category fiber refs
+   * @category handlers
    * @since 4.0.0
    */
   <A, E, R>(self: Effect.Effect<A, E, R>, handler: PreResponseHandler): Effect.Effect<A, E, R | HttpServerRequest>
@@ -228,14 +228,14 @@ export const withPreResponseHandler: {
   /**
    * Runs an effect after registering a pre-response handler for the current HTTP server request.
    *
-   * @category fiber refs
+   * @category handlers
    * @since 4.0.0
    */
   (handler: PreResponseHandler) => <A, E, R>(self: Effect.Effect<A, E, R>) => Effect.Effect<A, E, R | HttpServerRequest>,
   /**
    * Runs an effect after registering a pre-response handler for the current HTTP server request.
    *
-   * @category fiber refs
+   * @category handlers
    * @since 4.0.0
    */
   <A, E, R>(self: Effect.Effect<A, E, R>, handler: PreResponseHandler) => Effect.Effect<A, E, R | HttpServerRequest>

package/src/unstable/http/HttpMethod.ts

@@ -51,7 +51,7 @@ export declare namespace HttpMethod {
 /**
  * Returns `true` when a method can carry a request body and narrows it to `HttpMethod.WithBody`.
  *
- * @category predicates
+ * @category guards
  * @since 4.0.0
  */
 export const hasBody = (method: HttpMethod): method is HttpMethod.WithBody =>
@@ -107,18 +107,15 @@ export const allShort = [
  *
  * **Example** (Checking HTTP method values)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { HttpMethod } from "effect/unstable/http"
  *
- * console.log(HttpMethod.isHttpMethod("GET"))
- * // true
- * console.log(HttpMethod.isHttpMethod("get"))
- * // false
- * console.log(HttpMethod.isHttpMethod(1))
- * // false
+ * HttpMethod.isHttpMethod("GET") // => true
+ * HttpMethod.isHttpMethod("get") // => false
+ * HttpMethod.isHttpMethod(1) // => false
  * ```
  *
- * @category refinements
+ * @category guards
  * @since 4.0.0
  */
 export const isHttpMethod = (u: unknown): u is HttpMethod => all.has(u as HttpMethod)