allow Multipart configuration in HttpApiSchema.Multipart (#5081)

Author: tim-smart

.changeset/fifty-views-hide.md

@@ -0,0 +1,5 @@
+---
+"effect": patch
+---
+
+expose Stream.provideSomeContext

.changeset/upset-donuts-kiss.md

@@ -0,0 +1,5 @@
+---
+"@effect/platform": patch
+---
+
+allow configuring multipart limits in HttpApiSchema.Multipart

.changeset/wet-years-beg.md

@@ -0,0 +1,5 @@
+---
+"@effect/platform": minor
+---
+
+use Context.Reference for Multipart configuration

packages/effect/src/Stream.ts

@@ -3629,6 +3629,18 @@ export const provideContext: {
   <A, E, R>(self: Stream<A, E, R>, context: Context.Context<R>): Stream<A, E>
 } = internal.provideContext
 
+/**
+ * Provides the stream with some of its required context, which eliminates its
+ * dependency on `R`.
+ *
+ * @since 3.16.9
+ * @category context
+ */
+export const provideSomeContext: {
+  <R2>(context: Context.Context<R2>): <A, E, R>(self: Stream<A, E, R>) => Stream<A, E, Exclude<R, R2>>
+  <A, E, R, R2>(self: Stream<A, E, R>, context: Context.Context<R2>): Stream<A, E, Exclude<R, R2>>
+} = internal.provideSomeContext
+
 /**
  * Provides a `Layer` to the stream, which translates it to another level.
  *

packages/platform-node/src/internal/httpIncomingMessage.ts

@@ -2,7 +2,6 @@ import * as Headers from "@effect/platform/Headers"
 import * as IncomingMessage from "@effect/platform/HttpIncomingMessage"
 import * as UrlParams from "@effect/platform/UrlParams"
 import * as Effect from "effect/Effect"
-import * as FiberRef from "effect/FiberRef"
 import * as Inspectable from "effect/Inspectable"
 import * as Option from "effect/Option"
 import type * as Stream from "effect/Stream"
@@ -39,7 +38,7 @@ export abstract class HttpIncomingMessageImpl<E> extends Inspectable.Class
     }
     this.textEffect = Effect.runSync(Effect.cached(
       Effect.flatMap(
-        FiberRef.get(IncomingMessage.maxBodySize),
+        IncomingMessage.MaxBodySize,
         (maxBodySize) =>
           NodeStream.toString(() => this.source, {
             onFailure: this.onError,
@@ -82,7 +81,7 @@ export abstract class HttpIncomingMessageImpl<E> extends Inspectable.Class
 
   get arrayBuffer(): Effect.Effect<ArrayBuffer, E> {
     return Effect.flatMap(
-      FiberRef.get(IncomingMessage.maxBodySize),
+      IncomingMessage.MaxBodySize,
       (maxBodySize) =>
         NodeStream.toUint8Array(() => this.source, {
           onFailure: this.onError,

packages/platform-node/src/internal/httpServer.ts

@@ -112,8 +112,8 @@ export const make = (
         })
     })
   }).pipe(
-    Effect.locally(
-      IncomingMessage.maxBodySize,
+    Effect.provideService(
+      IncomingMessage.MaxBodySize,
       Option.some(FileSystem.Size(1024 * 1024 * 10))
     )
   )

packages/platform/src/HttpApiBuilder.ts

@@ -37,6 +37,7 @@ import * as HttpRouter from "./HttpRouter.js"
 import * as HttpServer from "./HttpServer.js"
 import * as HttpServerRequest from "./HttpServerRequest.js"
 import * as HttpServerResponse from "./HttpServerResponse.js"
+import * as Multipart from "./Multipart.js"
 import * as OpenApi from "./OpenApi.js"
 import type { Path } from "./Path.js"
 import * as UrlParams from "./UrlParams.js"
@@ -525,7 +526,8 @@ export const handler = <
 
 const requestPayload = (
   request: HttpServerRequest.HttpServerRequest,
-  urlParams: ReadonlyRecord<string, string | Array<string>>
+  urlParams: ReadonlyRecord<string, string | Array<string>>,
+  multipartLimits: Option.Option<Multipart.withLimits.Options>
 ): Effect.Effect<
   unknown,
   never,
@@ -542,7 +544,10 @@ const requestPayload = (
   if (contentType.includes("application/json")) {
     return Effect.orDie(request.json)
   } else if (contentType.includes("multipart/form-data")) {
-    return Effect.orDie(request.multipart)
+    return Effect.orDie(Option.match(multipartLimits, {
+      onNone: () => request.multipart,
+      onSome: (limits) => Multipart.withLimits(request.multipart, limits)
+    }))
   } else if (contentType.includes("x-www-form-urlencoded")) {
     return Effect.map(Effect.orDie(request.urlParamsBody), UrlParams.toRecord)
   } else if (contentType.startsWith("text/")) {
@@ -628,9 +633,12 @@ const handlerToRoute = (
 ): HttpRouter.Route<any, any> => {
   const endpoint = endpoint_ as HttpApiEndpoint.HttpApiEndpoint.AnyWithProps
   const isMultipartStream = endpoint.payloadSchema.pipe(
-    Option.map(({ ast }) => HttpApiSchema.getMultipartStream(ast)),
+    Option.map(({ ast }) => HttpApiSchema.getMultipartStream(ast) !== undefined),
     Option.getOrElse(constFalse)
   )
+  const multipartLimits = endpoint.payloadSchema.pipe(
+    Option.flatMapNullable(({ ast }) => HttpApiSchema.getMultipart(ast) || HttpApiSchema.getMultipartStream(ast))
+  )
   const decodePath = Option.map(endpoint.pathSchema, Schema.decodeUnknown)
   const decodePayload = isFullRequest || isMultipartStream
     ? Option.none()
@@ -654,11 +662,14 @@ const handlerToRoute = (
         }
         if (decodePayload._tag === "Some") {
           request.payload = yield* Effect.flatMap(
-            requestPayload(httpRequest, urlParams),
+            requestPayload(httpRequest, urlParams, multipartLimits),
             decodePayload.value
           )
         } else if (isMultipartStream) {
-          request.payload = httpRequest.multipartStream
+          request.payload = Option.match(multipartLimits, {
+            onNone: () => httpRequest.multipartStream,
+            onSome: (limits) => Multipart.withLimitsStream(httpRequest.multipartStream, limits)
+          })
         }
         if (decodeHeaders._tag === "Some") {
           request.headers = yield* decodeHeaders.value(httpRequest.headers)

packages/platform/src/HttpApiSchema.ts

@@ -7,10 +7,13 @@ import * as Effectable from "effect/Effectable"
 import type { LazyArg } from "effect/Function"
 import { constant, constVoid, dual } from "effect/Function"
 import { globalValue } from "effect/GlobalValue"
+import type * as Option from "effect/Option"
 import { hasProperty } from "effect/Predicate"
 import * as Schema from "effect/Schema"
 import * as AST from "effect/SchemaAST"
 import * as Struct from "effect/Struct"
+import type * as FileSystem from "./FileSystem.js"
+import type * as Multipart_ from "./Multipart.js"
 
 /**
  * @since 1.0.0
@@ -111,14 +114,15 @@ export const getEmptyDecodeable = (ast: AST.AST): boolean =>
  * @since 1.0.0
  * @category annotations
  */
-export const getMultipart = (ast: AST.AST): boolean => getAnnotation<boolean>(ast, AnnotationMultipart) ?? false
+export const getMultipart = (ast: AST.AST): Multipart_.withLimits.Options | undefined =>
+  getAnnotation<Multipart_.withLimits.Options>(ast, AnnotationMultipart)
 
 /**
  * @since 1.0.0
  * @category annotations
  */
-export const getMultipartStream = (ast: AST.AST): boolean =>
-  getAnnotation<boolean>(ast, AnnotationMultipartStream) ?? false
+export const getMultipartStream = (ast: AST.AST): Multipart_.withLimits.Options | undefined =>
+  getAnnotation<Multipart_.withLimits.Options>(ast, AnnotationMultipartStream)
 
 const encodingJson: Encoding = {
   kind: "Json",
@@ -406,9 +410,15 @@ export interface Multipart<S extends Schema.Schema.Any>
  * @since 1.0.0
  * @category multipart
  */
-export const Multipart = <S extends Schema.Schema.Any>(self: S): Multipart<S> =>
+export const Multipart = <S extends Schema.Schema.Any>(self: S, options?: {
+  readonly maxParts?: Option.Option<number> | undefined
+  readonly maxFieldSize?: FileSystem.SizeInput | undefined
+  readonly maxFileSize?: Option.Option<FileSystem.SizeInput> | undefined
+  readonly maxTotalSize?: Option.Option<FileSystem.SizeInput> | undefined
+  readonly fieldMimeTypes?: ReadonlyArray<string> | undefined
+}): Multipart<S> =>
   self.annotations({
-    [AnnotationMultipart]: true
+    [AnnotationMultipart]: options ?? {}
   }) as any
 
 /**
@@ -439,9 +449,15 @@ export interface MultipartStream<S extends Schema.Schema.Any> extends
  * @since 1.0.0
  * @category multipart
  */
-export const MultipartStream = <S extends Schema.Schema.Any>(self: S): MultipartStream<S> =>
+export const MultipartStream = <S extends Schema.Schema.Any>(self: S, options?: {
+  readonly maxParts?: Option.Option<number> | undefined
+  readonly maxFieldSize?: FileSystem.SizeInput | undefined
+  readonly maxFileSize?: Option.Option<FileSystem.SizeInput> | undefined
+  readonly maxTotalSize?: Option.Option<FileSystem.SizeInput> | undefined
+  readonly fieldMimeTypes?: ReadonlyArray<string> | undefined
+}): MultipartStream<S> =>
   self.annotations({
-    [AnnotationMultipartStream]: true
+    [AnnotationMultipartStream]: options ?? {}
   }) as any
 
 const defaultContentType = (encoding: Encoding["kind"]) => {

packages/platform/src/HttpIncomingMessage.ts

@@ -1,10 +1,9 @@
 /**
  * @since 1.0.0
  */
+import * as Context from "effect/Context"
 import * as Effect from "effect/Effect"
-import * as FiberRef from "effect/FiberRef"
 import { dual } from "effect/Function"
-import * as Global from "effect/GlobalValue"
 import * as Inspectable from "effect/Inspectable"
 import * as Option from "effect/Option"
 import type * as ParseResult from "effect/ParseResult"
@@ -85,10 +84,9 @@ export const schemaHeaders = <A, I extends Readonly<Record<string, string | unde
  * @since 1.0.0
  * @category fiber refs
  */
-export const maxBodySize: FiberRef.FiberRef<Option.Option<FileSystem.Size>> = Global.globalValue(
-  "@effect/platform/HttpIncomingMessage/maxBodySize",
-  () => FiberRef.unsafeMake(Option.none<FileSystem.Size>())
-)
+export class MaxBodySize extends Context.Reference<MaxBodySize>()("@effect/platform/HttpIncomingMessage/MaxBodySize", {
+  defaultValue: Option.none<FileSystem.Size>
+}) {}
 
 /**
  * @since 1.0.0
@@ -97,7 +95,7 @@ export const maxBodySize: FiberRef.FiberRef<Option.Option<FileSystem.Size>> = Gl
 export const withMaxBodySize = dual<
   (size: Option.Option<FileSystem.SizeInput>) => <A, E, R>(effect: Effect.Effect<A, E, R>) => Effect.Effect<A, E, R>,
   <A, E, R>(effect: Effect.Effect<A, E, R>, size: Option.Option<FileSystem.SizeInput>) => Effect.Effect<A, E, R>
->(2, (effect, size) => Effect.locally(effect, maxBodySize, Option.map(size, FileSystem.Size)))
+>(2, (effect, size) => Effect.provideService(effect, MaxBodySize, Option.map(size, FileSystem.Size)))
 
 /**
  * @since 1.0.0

packages/platform/src/HttpServerRequest.ts

@@ -27,7 +27,12 @@ export {
    * @since 1.0.0
    * @category fiber refs
    */
-  maxBodySize
+  MaxBodySize,
+  /**
+   * @since 1.0.0
+   * @category fiber refs
+   */
+  withMaxBodySize
 } from "./HttpIncomingMessage.js"
 
 /**