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

package/src/unstable/http/HttpServerRequest.ts

@@ -45,7 +45,7 @@ export {
    * Use to configure the maximum body size accepted while reading server
    * request bodies.
    *
-   * @category fiber refs
+   * @category references
    * @since 4.0.0
    */
   MaxBodySize
@@ -105,7 +105,7 @@ export interface HttpServerRequest extends HttpIncomingMessage.HttpIncomingMessa
  * Use to access the request currently being handled by HTTP server routes and
  * middleware.
  *
- * @category context
+ * @category services
  * @since 4.0.0
  */
 export const HttpServerRequest: Context.Service<HttpServerRequest, HttpServerRequest> = Context.Service(
@@ -125,7 +125,7 @@ export const HttpServerRequest: Context.Service<HttpServerRequest, HttpServerReq
  * Each key maps to a string value, or to an array when the parameter appears more
  * than once.
  *
- * @category search params
+ * @category services
  * @since 4.0.0
  */
 export class ParsedSearchParams extends Context.Service<
@@ -140,7 +140,7 @@ export class ParsedSearchParams extends Context.Service<
  *
  * Repeated parameters are represented as arrays in insertion order.
  *
- * @category search params
+ * @category parsing
  * @since 4.0.0
  */
 export const searchParamsFromURL = (url: URL): ReadonlyRecord<string, string | Array<string>> => {
@@ -863,25 +863,25 @@ const rawBodyStream = (request: HttpServerRequest, body: unknown): Stream.Stream
   if (body instanceof Request) {
     return streamFromReadable(request, body.body)
   }
-  if (isFormData(body)) {
-    return streamFromReadable(request, new Response(body).body)
-  }
   if (isReadableStream(body)) {
     return streamFromReadable(request, body)
   }
+  if (isBodyInit(body)) {
+    return streamFromReadable(request, new Response(body).body)
+  }
   return Stream.fail(requestParseError(request, "Unsupported body type"))
 }
 
 const rawBodyBytes = (request: HttpServerRequest, body: unknown): Effect.Effect<Uint8Array, HttpServerError> => {
-  if (body instanceof Blob) {
-    return bytesFromBodyInit(request, body)
-  }
   if (body instanceof Request) {
     return Effect.tryPromise({
       try: () => body.arrayBuffer().then((buffer) => new Uint8Array(buffer)),
       catch: (cause) => requestParseError(request, undefined, cause)
     })
   }
+  if (isBodyInit(body)) {
+    return bytesFromBodyInit(request, body)
+  }
   return Effect.fail(requestParseError(request, "Unsupported body type"))
 }
 
@@ -995,6 +995,14 @@ const isReadableStream = (u: unknown): u is ReadableStream<Uint8Array> =>
 
 const isFormData = (u: unknown): u is FormData => typeof FormData !== "undefined" && u instanceof FormData
 
+const isBodyInit = (u: unknown): u is BodyInit =>
+  typeof u === "string" ||
+  (typeof ArrayBuffer !== "undefined" && (u instanceof ArrayBuffer || ArrayBuffer.isView(u))) ||
+  (typeof Blob !== "undefined" && u instanceof Blob) ||
+  isFormData(u) ||
+  (typeof URLSearchParams !== "undefined" && u instanceof URLSearchParams) ||
+  isReadableStream(u)
+
 const textDecoder = new TextDecoder()
 
 /**

package/src/unstable/http/HttpServerResponse.ts

@@ -34,6 +34,7 @@ import * as HttpClientRequest from "./HttpClientRequest.ts"
 import * as HttpClientResponse from "./HttpClientResponse.ts"
 import * as HttpIncomingMessage from "./HttpIncomingMessage.ts"
 import type { HttpPlatform } from "./HttpPlatform.ts"
+import * as bodyInternal from "./internal/httpBody.ts"
 import * as Template from "./Template.ts"
 import * as UrlParams from "./UrlParams.ts"
 
@@ -563,6 +564,36 @@ export const setHeader: {
     makeResponse({
       ...self,
       headers: Headers.set(self.headers, key, value)
+    }, true)
+)
+
+/**
+ * Returns a response with the specified header removed.
+ *
+ * @category combinators
+ * @since 4.0.0
+ */
+export const removeHeader: {
+  /**
+   * Returns a response with the specified header removed.
+   *
+   * @category combinators
+   * @since 4.0.0
+   */
+  (key: string): (self: HttpServerResponse) => HttpServerResponse
+  /**
+   * Returns a response with the specified header removed.
+   *
+   * @category combinators
+   * @since 4.0.0
+   */
+  (self: HttpServerResponse, key: string): HttpServerResponse
+} = dual(
+  2,
+  (self: HttpServerResponse, key: string): HttpServerResponse =>
+    makeResponse({
+      ...self,
+      headers: Headers.remove(self.headers, key)
     })
 )
 
@@ -593,7 +624,7 @@ export const setHeaders: {
     makeResponse({
       ...self,
       headers: Headers.setAll(self.headers, input)
-    })
+    }, true)
 )
 
 /**
@@ -1174,7 +1205,8 @@ export const setBody: {
   (self: HttpServerResponse, body: Body.HttpBody): HttpServerResponse
 } = dual(
   2,
-  (self: HttpServerResponse, body: Body.HttpBody): HttpServerResponse => makeResponse({ ...self, body })
+  (self: HttpServerResponse, body: Body.HttpBody): HttpServerResponse =>
+    makeResponse({ ...self, headers: bodyInternal.updateHeaders(self.headers, body), body })
 )
 
 /**
@@ -1593,7 +1625,7 @@ const makeResponse = (options: {
   readonly headers?: Headers.Headers | undefined
   readonly cookies?: Cookies.Cookies | undefined
   readonly body?: Body.HttpBody | undefined
-}) => {
+}, preferHeaders = false) => {
   const self = Object.create(Proto) as Mutable<HttpServerResponse>
   self.status = options.status
   self.statusText = options.statusText
@@ -1601,13 +1633,13 @@ const makeResponse = (options: {
   self.body = options.body ?? Body.empty
   if (
     self.body._tag !== "Empty" &&
-    (self.body.contentType || self.body.contentLength)
+    (self.body.contentType || self.body.contentLength !== undefined)
   ) {
     const newHeaders = Headers.fromRecordUnsafe({ ...options.headers }) as any
-    if (self.body.contentType) {
+    if (self.body.contentType && (!preferHeaders || newHeaders["content-type"] === undefined)) {
       newHeaders["content-type"] = self.body.contentType
     }
-    if (self.body.contentLength) {
+    if (self.body.contentLength !== undefined && (!preferHeaders || newHeaders["content-length"] === undefined)) {
       newHeaders["content-length"] = self.body.contentLength.toString()
     }
     self.headers = newHeaders

package/src/unstable/http/HttpStaticServer.ts

@@ -26,14 +26,41 @@ import * as HttpServerResponse from "./HttpServerResponse.ts"
  *
  * **Example** (Serving files from a directory)
  *
- * ```ts
- * import { Effect } from "effect"
- * import { HttpStaticServer } from "effect/unstable/http"
+ * ```ts import.meta.vitest
+ * import { Effect, FileSystem, Layer, Path } from "effect"
+ * import {
+ *   HttpEffect,
+ *   HttpPlatform,
+ *   HttpServerResponse,
+ *   HttpStaticServer
+ * } from "effect/unstable/http"
  *
- * const program = Effect.gen(function*() {
- *   const app = yield* HttpStaticServer.make({ root: "./public" })
- *   return app
+ * const TestFileSystem = FileSystem.layerNoop({
+ *   stat: () =>
+ *     Effect.succeed({
+ *       type: "File",
+ *       size: FileSystem.Size(20)
+ *     } as FileSystem.File.Info)
  * })
+ * const TestHttpPlatform = Layer.succeed(
+ *   HttpPlatform.HttpPlatform,
+ *   HttpPlatform.HttpPlatform.of({
+ *     platform: "web",
+ *     fileResponse: (path) => Effect.succeed(HttpServerResponse.text(`Serving ${path}`)),
+ *     fileWebResponse: () => Effect.die("unused")
+ *   })
+ * )
+ * const TestServices = Layer.mergeAll(Path.layer, TestFileSystem, TestHttpPlatform)
+ *
+ * const program = Effect.gen(function*() {
+ *   const app = yield* HttpStaticServer.make({ root: "/public" })
+ *   const handler = HttpEffect.toWebHandler(app)
+ *   const response = yield* Effect.promise(() => handler(new Request("http://localhost/guide.txt")))
+ *   const body = yield* Effect.promise(() => response.text())
+ *   return body
+ * }).pipe(Effect.provide(TestServices))
+ *
+ * await Effect.runPromise(program) // => "Serving /public/guide.txt"
  * ```
  *
  * @category constructors
@@ -179,7 +206,7 @@ export const make: (options: {
  *
  * **Example** (Mounting static files on a router)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { Layer } from "effect"
  * import { HttpRouter, HttpServerResponse, HttpStaticServer } from "effect/unstable/http"
  *
@@ -191,6 +218,7 @@ export const make: (options: {
  * })
  *
  * const AppLayer = Layer.mergeAll(ApiLayer, StaticFilesLayer)
+ * Layer.isLayer(AppLayer) // => true
  * ```
  *
  * @category layers

package/src/unstable/http/Multipart.ts

@@ -34,7 +34,7 @@ import * as UndefinedOr from "../../UndefinedOr.ts"
 import * as IncomingMessage from "./HttpIncomingMessage.ts"
 import * as HttpServerRespondable from "./HttpServerRespondable.ts"
 import * as HttpServerResponse from "./HttpServerResponse.ts"
-import * as MP from "./Multipasta.ts"
+import * as MP from "./MultipartParser.ts"
 
 /**
  * Type identifier used to brand multipart part values.
@@ -438,7 +438,7 @@ export const makeConfig = (
  * non-empty batches of parsed `Part` values, failing with `MultipartError` for
  * parser and limit failures.
  *
- * @category Parsers
+ * @category parsing
  * @since 4.0.0
  */
 export const makeChannel = <IE>(headers: Record<string, string>): Channel.Channel<
@@ -678,6 +678,8 @@ export const toPersisted = (
     const path_ = yield* Path.Path
     const dir = yield* fs.makeTempDirectoryScoped()
     const persisted: Record<string, Array<PersistedFile> | Array<string> | string> = Object.create(null)
+    const usedPaths = new Set<string>()
+    let fileIndex = 0
     yield* Stream.runForEach(stream, (part) => {
       if (part._tag === "Field") {
         if (!(part.key in persisted)) {
@@ -692,7 +694,12 @@ export const toPersisted = (
         return Effect.void
       }
       const file = part
-      const path = path_.join(dir, path_.basename(file.name).slice(-128))
+      const fileName = path_.basename(file.name).slice(-128)
+      let path = path_.join(dir, fileName)
+      while (usedPaths.has(path)) {
+        path = path_.join(dir, `${fileIndex++}-${fileName}`)
+      }
+      usedPaths.add(path)
       const filePart = new PersistedFileImpl(
         file.key,
         file.name,
@@ -794,7 +801,7 @@ export declare namespace withLimits {
    * These settings control maximum part count, field size, file size, total body
    * size, and MIME types that should be treated as fields instead of files.
    *
-   * @category fiber refs
+   * @category options
    * @since 4.0.0
    */
   export type Options = {
@@ -813,7 +820,7 @@ export declare namespace withLimits {
  *
  * The default is `undefined`, meaning no explicit part-count limit.
  *
- * @category references
+ * @category services
  * @since 4.0.0
  */
 export const MaxParts = Context.Reference<number | undefined>("effect/http/Multipart/MaxParts", {
@@ -827,7 +834,7 @@ export const MaxParts = Context.Reference<number | undefined>("effect/http/Multi
  *
  * The default limit is 10 MiB.
  *
- * @category references
+ * @category services
  * @since 4.0.0
  */
 export const MaxFieldSize = Context.Reference<FileSystem.SizeInput>("effect/http/Multipart/MaxFieldSize", {
@@ -841,7 +848,7 @@ export const MaxFieldSize = Context.Reference<FileSystem.SizeInput>("effect/http
  *
  * The default is `undefined`, meaning no explicit per-file limit.
  *
- * @category references
+ * @category services
  * @since 4.0.0
  */
 export const MaxFileSize = Context.Reference<FileSystem.SizeInput | undefined>(
@@ -857,7 +864,7 @@ export const MaxFileSize = Context.Reference<FileSystem.SizeInput | undefined>(
  *
  * The default treats `application/json` parts as fields.
  *
- * @category references
+ * @category services
  * @since 4.0.0
  */
 export const FieldMimeTypes = Context.Reference<ReadonlyArray<string>>("effect/http/Multipart/FieldMimeTypes", {

package/src/unstable/http/MultipartParser/HeadersParser.ts

@@ -0,0 +1,68 @@
+/**
+ * Low-level parser for multipart header blocks.
+ *
+ * @since 4.0.0
+ */
+import * as internal from "./internal/headers.ts"
+
+/**
+ * The reason a multipart header block could not be parsed.
+ *
+ * @category errors
+ * @since 4.0.0
+ */
+export type FailureReason =
+  | "TooManyHeaders"
+  | "HeaderTooLarge"
+  | "InvalidHeaderName"
+  | "InvalidHeaderValue"
+
+/**
+ * Indicates that the parser needs more input.
+ *
+ * @category models
+ * @since 4.0.0
+ */
+export interface Continue {
+  readonly _tag: "Continue"
+}
+
+/**
+ * A multipart header parsing failure.
+ *
+ * @category errors
+ * @since 4.0.0
+ */
+export interface Failure {
+  readonly _tag: "Failure"
+  readonly reason: FailureReason
+  readonly headers: Record<string, string | Array<string>>
+}
+
+/**
+ * A successfully parsed multipart header block.
+ *
+ * @category models
+ * @since 4.0.0
+ */
+export interface Headers {
+  readonly _tag: "Headers"
+  readonly headers: Record<string, string | Array<string>>
+  readonly endPosition: number
+}
+
+/**
+ * The result of parsing a multipart header block.
+ *
+ * @category models
+ * @since 4.0.0
+ */
+export type ReturnValue = Continue | Failure | Headers
+
+/**
+ * Creates an incremental multipart header parser.
+ *
+ * @category constructors
+ * @since 4.0.0
+ */
+export const make: () => (chunk: Uint8Array, start: number) => ReturnValue = internal.make

package/src/unstable/http/MultipartParser/Search.ts

@@ -0,0 +1,17 @@
+/**
+ * Low-level byte search used by the multipart parser.
+ *
+ * @since 4.0.0
+ */
+import * as internal from "./internal/search.ts"
+
+/**
+ * Creates an incremental byte search for a string boundary.
+ *
+ * @category constructors
+ * @since 4.0.0
+ */
+export const make: (
+  needle: string,
+  callback: (index: number, chunk: Uint8Array) => void
+) => { readonly write: (chunk: Uint8Array) => void; readonly end: () => void } = internal.make

package/src/unstable/http/MultipartParser/internal/contentType.ts

@@ -0,0 +1,103 @@
+// taken from https://github.com/fastify/fast-content-type-parse
+// under the MIT license
+
+/**
+ * RegExp to match *( ";" parameter ) in RFC 7231 sec 3.1.1.1
+ *
+ * parameter     = token "=" ( token / quoted-string )
+ * token         = 1*tchar
+ * tchar         = "!" / "#" / "$" / "%" / "&" / "'" / "*"
+ *               / "+" / "-" / "." / "^" / "_" / "`" / "|" / "~"
+ *               / DIGIT / ALPHA
+ *               ; any VCHAR, except delimiters
+ * quoted-string = DQUOTE *( qdtext / quoted-pair ) DQUOTE
+ * qdtext        = HTAB / SP / %x21 / %x23-5B / %x5D-7E / obs-text
+ * obs-text      = %x80-FF
+ * quoted-pair   = "\" ( HTAB / SP / VCHAR / obs-text )
+ */
+const paramRE =
+  /; *([!#$%&'*+.^\w`|~-]+)=("(?:[\v\u0020\u0021\u0023-\u005b\u005d-\u007e\u0080-\u{10ffff}]|\\[\v\u0020-\u{10ffff}])*"|[!#$%&'*+.^\w`|~-]+) */gu
+
+/**
+ * RegExp to match quoted-pair in RFC 7230 sec 3.2.6
+ *
+ * quoted-pair = "\" ( HTAB / SP / VCHAR / obs-text )
+ * obs-text    = %x80-FF
+ */
+const quotedPairRE = /\\([\v\u0020-\u{10ffff}])/gu
+
+/**
+ * RegExp to match type in RFC 7231 sec 3.1.1.1
+ *
+ * media-type = type "/" subtype
+ * type       = token
+ * subtype    = token
+ */
+const mediaTypeRE = /^[!#$%&'*+.^\w|~-]+\/[!#$%&'*+.^\w|~-]+$/u
+const mediaTypeRENoSlash = /^[!#$%&'*+.^\w|~-]+$/u
+
+// default ContentType to prevent repeated object creation
+const defaultContentType = { value: "", parameters: Object.create(null) }
+
+export function parse(
+  header: string | undefined,
+  withoutSlash = false
+): {
+  readonly value: string
+  readonly parameters: Record<string, string>
+} {
+  if (typeof header !== "string") {
+    return defaultContentType
+  }
+
+  let index = header.indexOf(";")
+  const type = index !== -1 ? header.slice(0, index).trim() : header.trim()
+  const mediaRE = withoutSlash ? mediaTypeRENoSlash : mediaTypeRE
+
+  if (mediaRE.test(type) === false) {
+    return defaultContentType
+  }
+
+  const result = {
+    value: type.toLowerCase(),
+    parameters: Object.create(null)
+  }
+
+  // parse parameters
+  if (index === -1) {
+    return result
+  }
+
+  let key: string
+  let match: RegExpExecArray | null
+  let value: string
+
+  paramRE.lastIndex = index
+
+  while ((match = paramRE.exec(header))) {
+    if (match.index !== index) {
+      return defaultContentType
+    }
+
+    index += match[0].length
+    key = match[1].toLowerCase()
+    value = match[2]
+
+    if (value[0] === "\"") {
+      // remove quotes and escapes
+      value = value.slice(1, value.length - 1)
+
+      if (!withoutSlash && quotedPairRE.test(value)) {
+        value = value.replace(quotedPairRE, "$1")
+      }
+    }
+
+    result.parameters[key] = value
+  }
+
+  if (index !== header.length) {
+    return defaultContentType
+  }
+
+  return result
+}