@effect/platform-bun 4.0.0-rc.111 → 4.0.0-rc.113

package/src/BunClusterSocket.ts

@@ -61,7 +61,7 @@ export const layer = <
   const Storage extends "local" | "sql" | "byo" = never
 >(
   options?: {
-    readonly serialization?: "msgpack" | "ndjson" | undefined
+    readonly serialization?: "binary" | "ndjson" | undefined
     readonly serializationMaxBufferSize?: number | "unbounded" | undefined
     readonly clientOnly?: ClientOnly | undefined
     readonly storage?: Storage | undefined
@@ -124,7 +124,9 @@ export const layer = <
     Layer.provide(
       options?.serialization === "ndjson"
         ? RpcSerialization.layerNdjsonWith({ maxBufferSize: options?.serializationMaxBufferSize })
-        : RpcSerialization.layerMsgPackWith({ maxBufferSize: options?.serializationMaxBufferSize })
+        : RpcSerialization.layerSchemaBinary({
+          maxFrameSize: options?.serializationMaxBufferSize
+        })
     )
   ) as any
 }

package/src/BunHttpPlatform.ts

@@ -36,16 +36,20 @@ const make: Effect.Effect<
 > = Platform.make({
   platform: "bun",
   compression,
-  fileResponse(path, status, statusText, headers, start, end, _contentLength) {
+  fileResponse(path, status, statusText, headers, start, end, contentLength) {
     let file = Bun.file(path)
     if (start > 0 || end !== undefined) {
       file = file.slice(start, end)
     }
-    return Response.raw(file, { headers, status, statusText })
+    return Response.raw(file, {
+      headers: { ...headers, "content-length": contentLength.toString() },
+      status,
+      statusText
+    })
   },
   fileWebResponse(file, status, statusText, headers, options) {
-    const start = Number(options?.offset ?? 0)
-    const end = options?.bytesToRead !== undefined ? start + Number(options.bytesToRead) : undefined
+    const start = options?.offset ?? 0
+    const end = options?.bytesToRead !== undefined ? start + options.bytesToRead : undefined
     const body = start > 0 || end !== undefined
       ? (file as File).slice(start, end, file.type)
       : file

package/src/BunHttpServer.ts

@@ -12,6 +12,7 @@
  * @since 4.0.0
  */
 import type { Server as BunServer, ServerWebSocket } from "bun"
+import type * as Arr from "effect/Array"
 import * as Config from "effect/Config"
 import type { ConfigError } from "effect/Config"
 import * as Context from "effect/Context"
@@ -20,14 +21,15 @@ import * as Duration from "effect/Duration"
 import * as Effect from "effect/Effect"
 import * as Exit from "effect/Exit"
 import * as Fiber from "effect/Fiber"
-import * as FiberSet from "effect/FiberSet"
 import type * as FileSystem from "effect/FileSystem"
-import { flow } from "effect/Function"
+import { constVoid, flow } from "effect/Function"
 import * as Inspectable from "effect/Inspectable"
 import * as Layer from "effect/Layer"
 import * as Option from "effect/Option"
 import type * as Path from "effect/Path"
 import type * as Record from "effect/Record"
+import * as Result from "effect/Result"
+import * as Scheduler from "effect/Scheduler"
 import type * as Schema from "effect/Schema"
 import * as Scope from "effect/Scope"
 import * as Semaphore from "effect/Semaphore"
@@ -47,6 +49,7 @@ import * as ServerRequest from "effect/unstable/http/HttpServerRequest"
 import type * as ServerResponse from "effect/unstable/http/HttpServerResponse"
 import type * as Multipart from "effect/unstable/http/Multipart"
 import * as UrlParams from "effect/unstable/http/UrlParams"
+import * as NetAddress from "effect/unstable/net/NetAddress"
 import * as Socket from "effect/unstable/socket/Socket"
 import * as Platform from "./BunHttpPlatform.ts"
 import * as BunMultipart from "./BunMultipart.ts"
@@ -77,13 +80,27 @@ export type ServeOptions<R extends string> =
  * through, e.g.
  * `BunHttpServer.layer({ port: 3000, websocket: { perMessageDeflate: true } })`.
  *
+ * The `compressionThreshold` option controls the minimum message size in bytes
+ * that is compressed when per-message deflate is negotiated. It defaults to
+ * 1024, matching the default threshold of Node's `ws` server.
+ *
  * @category options
  * @since 4.0.0
  */
-export type WebSocketOptions = Omit<
-  Bun.WebSocketHandler<WebSocketContext>,
-  "open" | "message" | "close" | "drain" | "ping" | "pong" | "data" | "binaryType"
->
+export type WebSocketOptions =
+  & Omit<
+    Bun.WebSocketHandler<WebSocketContext>,
+    "open" | "message" | "close" | "drain" | "ping" | "pong" | "data" | "binaryType"
+  >
+  & {
+    /**
+     * The minimum message size in bytes that is compressed when per-message
+     * deflate is negotiated.
+     *
+     * @default 1024
+     */
+    readonly compressionThreshold?: number | undefined
+  }
 
 /**
  * Creates a scoped Bun `HttpServer` from `Bun.serve` options, stopping the server on scope finalization with optional graceful shutdown settings.
@@ -100,6 +117,23 @@ export const make = Effect.fnUntraced(
     }
   ) {
     const scope = yield* Effect.scope
+    let listenOptions = options
+    if (!("unix" in options) || options.unix === undefined) {
+      const internetOptions = options as Bun.Serve.HostnamePortServeOptions<WebSocketContext>
+      const hostname = internetOptions.hostname ?? "0.0.0.0"
+      if (Result.isFailure(NetAddress.ipFromString(hostname))) {
+        const resolved = yield* Effect.tryPromise({
+          try: async () => {
+            const result = await Bun.dns.lookup(hostname, { socketType: "tcp" })
+            if (result.length === 0) throw new globalThis.Error(`Could not resolve hostname: ${hostname}`)
+            return result[0].address
+          },
+          catch: (cause) => new Error.ServeError({ cause })
+        })
+        listenOptions = { ...options, hostname: resolved }
+      }
+    }
+    const { compressionThreshold = MIN_COMPRESSIBLE_SIZE, ...websocket } = options.websocket ?? {}
     const handlerStack: Array<(request: Request, server: BunServer<WebSocketContext>) => Response | Promise<Response>> =
       [
         function(_request, _server) {
@@ -107,10 +141,10 @@ export const make = Effect.fnUntraced(
         }
       ]
     const server = Bun.serve<WebSocketContext, R>({
-      ...options as ServeOptions<R>,
+      ...listenOptions as ServeOptions<R>,
       fetch: handlerStack[0],
       websocket: {
-        ...options.websocket,
+        ...websocket,
         open(ws) {
           Deferred.doneUnsafe(ws.data.deferred, Exit.succeed(ws))
         },
@@ -119,16 +153,11 @@ export const make = Effect.fnUntraced(
         },
         close(ws, code, closeReason) {
           code = typeof code === "number" ? code : 1001
-          Deferred.doneUnsafe(
-            ws.data.closeDeferred,
-            Socket.defaultCloseCodeIsError(code)
-              ? Exit.fail(
-                new Socket.SocketError({
-                  reason: new Socket.SocketCloseError({ code, closeReason })
-                })
-              )
-              : Exit.void
-          )
+          const error = new Socket.SocketError({
+            reason: new Socket.SocketCloseError({ code, closeReason })
+          })
+          ws.data.closeError = error
+          ws.data.onClose(error)
         }
       }
     })
@@ -143,8 +172,14 @@ export const make = Effect.fnUntraced(
 
     yield* Scope.addFinalizer(scope, shutdown)
 
+    const address = "unix" in options && options.unix !== undefined
+      ? NetAddress.unixPathAddress(options.unix)
+      : yield* Effect.fromResult(NetAddress.inetAddressFromIpString(server.hostname!, server.port!)).pipe(
+        Effect.mapError((cause) => new Error.ServeError({ cause }))
+      )
+
     return Server.make({
-      address: { _tag: "TcpAddress", port: server.port!, hostname: server.hostname! },
+      address,
       serve: Effect.fnUntraced(function*(httpApp, middleware) {
         const parent = yield* Effect.fiber
         const services = parent.context
@@ -161,7 +196,7 @@ export const make = Effect.fnUntraced(
             const context = Context.add(
               services,
               ServerRequest.HttpServerRequest,
-              new BunServerRequest(request, resolve, removeHost(request.url), server)
+              new BunServerRequest(request, resolve, removeHost(request.url), server, compressionThreshold)
             )
             const fiber = Fiber.runIn(Effect.runForkWith(context)(httpEffect), scope)
             request.signal.addEventListener("abort", () => {
@@ -173,16 +208,24 @@ export const make = Effect.fnUntraced(
         yield* Scope.addFinalizerExit(serveScope, () => {
           const index = handlerStack.indexOf(handler)
           if (index !== -1) handlerStack.splice(index, 1)
-          server.reload({ fetch: handlerStack[handlerStack.length - 1] })
+          server.reload({
+            fetch: handlerStack[handlerStack.length - 1],
+            ...(options.routes === undefined ? undefined : { routes: options.routes })
+          })
           return handlerStack.length === 1 ? preemptiveShutdown : Effect.void
         })
         handlerStack.push(handler)
-        server.reload({ fetch: handler })
+        server.reload({
+          fetch: handler,
+          ...(options.routes === undefined ? undefined : { routes: options.routes })
+        })
       })
     })
   }
 )
 
+const MIN_COMPRESSIBLE_SIZE = 1024
+
 const makeResponse = (
   request: ServerRequest.HttpServerRequest,
   response: ServerResponse.HttpServerResponse,
@@ -217,7 +260,9 @@ const makeResponse = (
     case "Empty": {
       return new Response(undefined, fields)
     }
-    case "Uint8Array":
+    case "Uint8Array": {
+      return new Response(body.text ?? body.body as any, fields)
+    }
     case "Raw": {
       if (body.body instanceof Response) {
         for (const [key, value] of fields.headers.entries()) {
@@ -257,7 +302,7 @@ export const layerServer: <R extends string>(
     readonly gracefulShutdownTimeout?: Duration.Input | undefined
     readonly websocket?: WebSocketOptions | undefined
   }
-) => Layer.Layer<Server.HttpServer> = flow(make, Layer.effect(Server.HttpServer)) as any
+) => Layer.Layer<Server.HttpServer, Error.ServeError> = flow(make, Layer.effect(Server.HttpServer)) as any
 
 /**
  * Layer that provides Bun HTTP support services: `HttpPlatform`, weak ETag generation, and `BunServices`.
@@ -291,7 +336,8 @@ export const layer = <R extends string>(
   | Server.HttpServer
   | HttpPlatform
   | Etag.Generator
-  | BunServices.BunServices
+  | BunServices.BunServices,
+  Error.ServeError
 > => Layer.mergeAll(layerServer(options), layerHttpServices)
 
 /**
@@ -306,7 +352,7 @@ export const layerTest: Layer.Layer<
   Layer.provide(FetchHttpClient.layer.pipe(
     Layer.provide(Layer.succeed(FetchHttpClient.RequestInit)({ keepalive: false }))
   )),
-  Layer.provideMerge(layer({ port: 0 }))
+  Layer.provideMerge(Layer.orDie(layer({ hostname: "127.0.0.1", port: 0 })))
 )
 
 /**
@@ -325,7 +371,7 @@ export const layerConfig = <R extends string>(
   >
 ): Layer.Layer<
   Server.HttpServer | HttpPlatform | FileSystem.FileSystem | Etag.Generator | Path.Path,
-  ConfigError
+  ConfigError | Error.ServeError
 > =>
   Layer.mergeAll(
     Layer.effect(Server.HttpServer)(Effect.flatMap(Config.unwrap(options), make)),
@@ -338,9 +384,10 @@ export const layerConfig = <R extends string>(
 
 interface WebSocketContext {
   readonly deferred: Deferred.Deferred<ServerWebSocket<WebSocketContext>>
-  readonly closeDeferred: Deferred.Deferred<void, Socket.SocketError>
   readonly buffer: Array<Uint8Array | string>
+  closeError: Socket.SocketError | undefined
   run: (_: Uint8Array | string) => void
+  onClose: (error: Socket.SocketError) => void
 }
 
 function wsDefaultRun(this: WebSocketContext, _: Uint8Array | string) {
@@ -354,6 +401,7 @@ class BunServerRequest extends Inspectable.Class implements ServerRequest.HttpSe
   public resolve: (response: Response) => void
   readonly url: string
   private bunServer: BunServer<WebSocketContext>
+  private compressionThreshold: number
   public headersOverride?: Headers.Headers | undefined
   private remoteAddressOverride?: Option.Option<string> | undefined
 
@@ -362,6 +410,7 @@ class BunServerRequest extends Inspectable.Class implements ServerRequest.HttpSe
     resolve: (response: Response) => void,
     url: string,
     bunServer: BunServer<WebSocketContext>,
+    compressionThreshold: number,
     headersOverride?: Headers.Headers,
     remoteAddressOverride?: Option.Option<string>
   ) {
@@ -372,6 +421,7 @@ class BunServerRequest extends Inspectable.Class implements ServerRequest.HttpSe
     this.resolve = resolve
     this.url = url
     this.bunServer = bunServer
+    this.compressionThreshold = compressionThreshold
     this.headersOverride = headersOverride
     this.remoteAddressOverride = remoteAddressOverride
   }
@@ -394,6 +444,7 @@ class BunServerRequest extends Inspectable.Class implements ServerRequest.HttpSe
       this.resolve,
       options.url ?? this.url,
       this.bunServer,
+      this.compressionThreshold,
       options.headers ?? this.headersOverride,
       "remoteAddress" in options ? options.remoteAddress : this.remoteAddressOverride
     )
@@ -539,15 +590,15 @@ class BunServerRequest extends Inspectable.Class implements ServerRequest.HttpSe
   get upgrade(): Effect.Effect<Socket.Socket, Error.HttpServerError> {
     return Effect.callback<Socket.Socket, Error.HttpServerError>((resume) => {
       const deferred = Deferred.makeUnsafe<ServerWebSocket<WebSocketContext>>()
-      const closeDeferred = Deferred.makeUnsafe<void, Socket.SocketError>()
       const semaphore = Semaphore.makeUnsafe(1)
 
       const success = this.bunServer.upgrade(this.source, {
         data: {
           deferred,
-          closeDeferred,
           buffer: [],
-          run: wsDefaultRun
+          closeError: undefined,
+          run: wsDefaultRun,
+          onClose: constVoid
         }
       })
       if (!success) {
@@ -561,49 +612,116 @@ class BunServerRequest extends Inspectable.Class implements ServerRequest.HttpSe
         ))
         return
       }
+      const compressionThreshold = this.compressionThreshold
       resume(Effect.map(Deferred.await(deferred), (ws) => {
         const write = (chunk: Uint8Array | string | Socket.CloseEvent) =>
           Effect.sync(() => {
             if (typeof chunk === "string") {
-              ws.sendText(chunk)
+              ws.sendText(chunk, chunk.length >= compressionThreshold)
             } else if (Socket.isCloseEvent(chunk)) {
               ws.close(chunk.code, chunk.reason)
             } else {
-              ws.sendBinary(chunk)
+              ws.sendBinary(chunk, chunk.byteLength >= compressionThreshold)
             }
-
-            return true
           })
-        const writer = Effect.succeed(write)
-        const runRaw = Effect.fnUntraced(
-          function*<R, E, _>(
-            handler: (_: Uint8Array | string) => Effect.Effect<_, E, R> | void,
-            opts?: { readonly onOpen?: Effect.Effect<void> | undefined }
-          ) {
-            const set = yield* FiberSet.make<any, E>()
-            const run = yield* FiberSet.runtime(set)<R>()
-            function runRaw(data: Uint8Array | string) {
-              const result = handler(data)
-              if (Effect.isEffect(result)) {
-                run(result)
+        const writeAll = (chunks: ReadonlyArray<Uint8Array | string>) =>
+          Effect.sync(() => {
+            for (let i = 0; i < chunks.length; i++) {
+              const chunk = chunks[i]
+              if (typeof chunk === "string") {
+                ws.sendText(chunk, chunk.length >= compressionThreshold)
+              } else {
+                ws.sendBinary(chunk, chunk.byteLength >= compressionThreshold)
               }
             }
-            ws.data.run = runRaw
-            ws.data.buffer.forEach(runRaw)
-            ws.data.buffer.length = 0
-            if (opts?.onOpen) yield* opts.onOpen
-            return yield* FiberSet.join(set)
-          },
-          Effect.scoped,
-          Effect.onExit((exit) => Effect.sync(() => ws.close(exit._tag === "Success" ? 1000 : 1011))),
-          Effect.raceFirst(Deferred.await(closeDeferred)),
-          semaphore.withPermits(1)
-        )
-
-        return Socket.make({
-          runRaw,
-          writer
+          })
+        const writer: Socket.Socket["writer"] = Effect.succeed({ write, writeAll })
+
+        const reader: Socket.Socket["reader"] = Effect.gen(function*() {
+          const dispatcher = (yield* Scheduler.Scheduler).makeDispatcher()
+          yield* Effect.acquireRelease(semaphore.take(1), () => semaphore.release(1))
+          const closeError = ws.data.closeError ?? (ws.readyState >= 2
+            ? new Socket.SocketError({
+              reason: new Socket.SocketCloseError({ code: 1006 })
+            })
+            : undefined)
+          if (closeError !== undefined && ws.data.buffer.length === 0) {
+            return yield* closeError
+          }
+          const scope = yield* Effect.scope
+
+          type ReadResume = (
+            effect: Effect.Effect<Arr.NonEmptyReadonlyArray<Uint8Array | string>, Socket.SocketError>
+          ) => void
+
+          let buffer: Array<Uint8Array | string> = ws.data.buffer.splice(0)
+          let error: Socket.SocketError | undefined = closeError
+          let waiter: ReadResume | undefined
+          let flushScheduled = false
+
+          function takeBuffer(): Arr.NonEmptyReadonlyArray<Uint8Array | string> {
+            const chunk = buffer
+            buffer = []
+            return chunk as unknown as Arr.NonEmptyReadonlyArray<Uint8Array | string>
+          }
+          function deliver() {
+            flushScheduled = false
+            if (waiter === undefined || buffer.length === 0) return
+            const resumeRead = waiter
+            waiter = undefined
+            resumeRead(Effect.succeed(takeBuffer()))
+          }
+          function push(data: Uint8Array | string) {
+            buffer.push(data)
+            if (waiter !== undefined && !flushScheduled) {
+              flushScheduled = true
+              dispatcher.scheduleTask(deliver, 0)
+            }
+          }
+          function fail(err: Socket.SocketError) {
+            if (error === undefined) error = err
+            if (waiter !== undefined) {
+              const resumeRead = waiter
+              waiter = undefined
+              resumeRead(buffer.length > 0 ? Effect.succeed(takeBuffer()) : Effect.fail(error))
+            }
+          }
+
+          ws.data.run = push
+          ws.data.onClose = fail
+          yield* Scope.addFinalizer(
+            scope,
+            Effect.suspend(() => {
+              // resume a pull blocked in another fiber before detaching
+              fail(
+                new Socket.SocketError({
+                  reason: new Socket.SocketCloseError({ code: 1006 })
+                })
+              )
+              ws.data.run = wsDefaultRun
+              ws.data.onClose = constVoid
+              ws.close(1000)
+              return Effect.void
+            })
+          )
+
+          return {
+            pull: Effect.callback<
+              Arr.NonEmptyReadonlyArray<Uint8Array | string>,
+              Socket.SocketError
+            >((resumeRead) => {
+              if (buffer.length > 0) return resumeRead(Effect.succeed(takeBuffer()))
+              if (error !== undefined) return resumeRead(Effect.fail(error))
+              waiter = resumeRead
+              return Effect.sync(() => {
+                if (waiter === resumeRead) waiter = undefined
+              })
+            }),
+            upgrade: Socket.SocketUpgradeError.unsupported
+          }
         })
+
+        return Socket.make({ reader, writer })
       }))
     })
   }

package/src/BunRedis.ts

@@ -9,7 +9,7 @@
  *
  * @since 4.0.0
  */
-import { RedisClient, type RedisOptions } from "bun"
+import type { RedisClient, RedisOptions } from "bun"
 import * as Config from "effect/Config"
 import * as Context from "effect/Context"
 import * as Deferred from "effect/Deferred"
@@ -35,6 +35,7 @@ const make = Effect.fnUntraced(function*(
     readonly url?: string
   } & RedisOptions
 ) {
+  const { RedisClient } = yield* Effect.promise(() => import("bun"))
   const scope = yield* Effect.scope
   yield* Scope.addFinalizer(scope, Effect.sync(() => client.close()))
   const client = new RedisClient(options?.url, options)

package/src/BunSocket.ts

@@ -29,13 +29,16 @@ export * from "@effect/platform-node-shared/NodeSocket"
 export const layerWebSocketConstructor: Layer.Layer<
   Socket.WebSocketConstructor
 > = Layer.succeed(Socket.WebSocketConstructor)(
-  (url, protocols) => new globalThis.WebSocket(url, protocols)
+  (url, options) =>
+    // Bun accepts `WebSocketOptions`, but `bun-types` selects the DOM overload
+    // when `lib.dom` is loaded and hides those constructor options.
+    new globalThis.WebSocket(url, options as string | Array<string> | undefined)
 )
 
 /**
  * Creates a `Socket.Socket` layer for a WebSocket URL using Bun's global
- * `WebSocket` constructor, honoring protocol, open-timeout, and close-code
- * error options.
+ * `WebSocket` constructor, honoring protocol, open-timeout, and
+ * high-water-mark options.
  *
  * @category layers
  * @since 4.0.0
@@ -43,9 +46,9 @@ export const layerWebSocketConstructor: Layer.Layer<
 export const layerWebSocket: (
   url: string | Effect<string>,
   options?: {
-    readonly closeCodeIsError?: ((code: number) => boolean) | undefined
     readonly openTimeout?: Duration.Input | undefined
     readonly protocols?: string | Array<string> | undefined
+    readonly highWaterMark?: number | undefined
   } | undefined
 ) => Layer.Layer<Socket.Socket, never, never> = flow(
   Socket.makeWebSocket,

package/src/BunStream.ts

@@ -13,7 +13,7 @@ import * as Arr from "effect/Array"
 import * as Cause from "effect/Cause"
 import * as Channel from "effect/Channel"
 import * as Effect from "effect/Effect"
-import type { LazyArg } from "effect/Function"
+import { constVoid, type LazyArg } from "effect/Function"
 import type * as Pull from "effect/Pull"
 import * as Scope from "effect/Scope"
 import * as Stream from "effect/Stream"
@@ -41,10 +41,19 @@ export const fromReadableStream = <A, E>(
     const reader = options.evaluate().getReader()
     yield* Scope.addFinalizer(
       scope,
-      options.releaseLockOnEnd ? Effect.sync(() => reader.releaseLock()) : Effect.promise(() => reader.cancel())
+      options.releaseLockOnEnd
+        ? Effect.sync(() => reader.releaseLock())
+        : Effect.promise(() => reader.cancel().catch(constVoid))
     )
     function readMany(): Pull.Pull<Arr.NonEmptyReadonlyArray<A>, E> {
-      const result = reader.readMany()
+      let result:
+        | Bun.ReadableStreamDefaultReadManyResult<A>
+        | Promise<Bun.ReadableStreamDefaultReadManyResult<A>>
+      try {
+        result = reader.readMany()
+      } catch (error) {
+        return Effect.fail(options.onError(error))
+      }
       if ("then" in result) {
         return Effect.callback<Arr.NonEmptyReadonlyArray<A>, E | Cause.Done>((resume) => {
           result.then((_) => resume(handleResult(_)), (e) => resume(Effect.fail(options.onError(e))))