effect 4.0.0-beta.102 → 4.0.0-beta.104

package/src/unstable/http/FindMyWay.ts

@@ -1,15 +1,74 @@
 /**
- * Re-exports the `find-my-way-ts` router package used by the unstable HTTP
- * routing modules.
+ * A radix-tree HTTP router used by the unstable HTTP routing modules.
  *
- * This module keeps the router types and helpers available from the Effect HTTP
- * namespace without wrapping or changing them.
+ * @since 4.0.0
+ */
+import * as internal from "./FindMyWay/internal/router.ts"
+
+/*
+ * MIT License
+ *
+ * Copyright (c) 2017-2019 Tomas Della Vedova
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
  *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+/**
+ * @since 4.0.0
+ * @category models
+ */
+export interface RouterConfig {
+  readonly ignoreTrailingSlash: boolean
+  readonly ignoreDuplicateSlashes: boolean
+  readonly caseSensitive: boolean
+  readonly maxParamLength: number
+}
+
+/**
+ * @since 4.0.0
+ * @category models
+ */
+export type PathInput = `/${string}` | "*"
+
+/**
+ * @since 4.0.0
+ * @category models
+ */
+export interface Router<A> {
+  readonly on: (method: string | Iterable<string>, path: PathInput, handler: A) => void
+  readonly all: (path: PathInput, handler: A) => void
+  readonly find: (method: string, url: string) => FindResult<A> | undefined
+  readonly has: (method: string, url: string) => boolean
+}
+
+/**
  * @since 4.0.0
+ * @category models
  */
+export interface FindResult<A> {
+  readonly handler: A
+  readonly params: Record<string, string | undefined>
+  readonly searchParams: Record<string, string | Array<string>>
+}
 
 /**
- * @category re-exports
  * @since 4.0.0
+ * @category constructors
  */
-export * from "find-my-way-ts"
+export const make: <A>(options?: Partial<RouterConfig>) => Router<A> = internal.make

package/src/unstable/http/Headers.ts

@@ -42,7 +42,7 @@ export type TypeId = typeof TypeId
 /**
  * Returns `true` if the provided value is a `Headers` value.
  *
- * @category refinements
+ * @category guards
  * @since 4.0.0
  */
 export const isHeaders = (u: unknown): u is Headers => Predicate.hasProperty(u, TypeId)
@@ -718,7 +718,7 @@ export const redact: {
  *
  * Defaults include `authorization`, `cookie`, `set-cookie`, and `x-api-key`.
  *
- * @category fiber refs
+ * @category services
  * @since 4.0.0
  */
 export const CurrentRedactedNames = Context.Reference<

package/src/unstable/http/HttpBody.ts

@@ -30,7 +30,7 @@ const TypeId = "~effect/http/HttpBody"
 /**
  * Returns `true` if the provided value is an `HttpBody`.
  *
- * @category refinements
+ * @category guards
  * @since 4.0.0
  */
 export const isHttpBody = (u: unknown): u is HttpBody => Predicate.hasProperty(u, TypeId)
@@ -484,12 +484,26 @@ export const stream = (
   contentLength?: number
 ): Stream => new Stream(body, contentType ?? "application/octet-stream", contentLength)
 
+const fileContentLength = (
+  size: FileSystem.SizeInput,
+  options?: {
+    readonly bytesToRead?: FileSystem.SizeInput | undefined
+    readonly offset?: FileSystem.SizeInput | undefined
+  }
+): number => {
+  const available = Math.max(0, Number(size) - Number(options?.offset ?? 0))
+  return options?.bytesToRead === undefined
+    ? available
+    : Math.min(available, Math.max(0, Number(options.bytesToRead)))
+}
+
 /**
  * Creates a streaming HTTP body for a file path.
  *
  * **Details**
  *
- * The effect requires `FileSystem`, stats the file to set the content length, and can fail with `PlatformError`.
+ * The effect requires `FileSystem`, stats the file to set the selected content length, and can fail with
+ * `PlatformError`.
  *
  * @category constructors
  * @since 4.0.0
@@ -510,7 +524,7 @@ export const file = (
         stream(
           fs.stream(path, options),
           options?.contentType,
-          Number(info.size)
+          fileContentLength(info.size, options)
         ))
   )
 
@@ -519,7 +533,8 @@ export const file = (
  *
  * **Details**
  *
- * The effect requires `FileSystem`, uses the provided file size as the content length, and can fail with `PlatformError`.
+ * The effect requires `FileSystem`, uses the provided file size to determine the selected content length, and can
+ * fail with `PlatformError`.
  *
  * @category constructors
  * @since 4.0.0
@@ -540,6 +555,6 @@ export const fileFromInfo = (
       stream(
         fs.stream(path, options),
         options?.contentType,
-        Number(info.size)
+        fileContentLength(info.size, options)
       )
   )

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/HttpClientError.ts

@@ -299,7 +299,7 @@ export type HttpClientErrorReason = RequestError | ResponseError
  * @category schemas
  * @since 4.0.0
  */
-export class HttpClientErrorSchema extends Schema.ErrorClass<HttpClientErrorSchema>(TypeId)({
+export class HttpClientErrorSchema extends Schema.Error<HttpClientErrorSchema>(TypeId)({
   _tag: Schema.tag("HttpError"),
   kind: Schema.Literals(
     [

package/src/unstable/http/HttpClientRequest.ts

@@ -28,6 +28,7 @@ import * as Stream from "../../Stream.ts"
 import * as Headers from "./Headers.ts"
 import * as HttpBody from "./HttpBody.ts"
 import { hasBody, type HttpMethod } from "./HttpMethod.ts"
+import * as bodyInternal from "./internal/httpBody.ts"
 import * as Url from "./Url.ts"
 import * as UrlParams from "./UrlParams.ts"
 
@@ -874,23 +875,12 @@ export const setBody: {
    */
   (self: HttpClientRequest, body: HttpBody.HttpBody): HttpClientRequest
 } = dual(2, (self: HttpClientRequest, body: HttpBody.HttpBody): HttpClientRequest => {
-  let headers = self.headers
-  if (body._tag === "Empty" || body._tag === "FormData") {
-    headers = Headers.remove(Headers.remove(headers, "Content-Type"), "Content-length")
-  } else {
-    if (body.contentType) {
-      headers = Headers.set(headers, "content-type", body.contentType)
-    }
-    if (body.contentLength !== undefined) {
-      headers = Headers.set(headers, "content-length", body.contentLength.toString())
-    }
-  }
   return makeWith(
     self.method,
     self.url,
     self.urlParams,
     self.hash,
-    headers,
+    bodyInternal.updateHeaders(self.headers, body),
     body
   )
 })