@effect/platform-bun 4.0.1 → 4.0.3

package/src/BunDns.ts

@@ -0,0 +1,82 @@
+/**
+ * Bun implementation of Effect's `Dns` service.
+ *
+ * Address lookups use `Bun.dns.lookup` with the `system` backend, which calls
+ * the operating system resolver (`getaddrinfo`) and therefore also reads the
+ * hosts file. Bun's `node:dns` lookup uses c-ares instead, which bypasses the
+ * system's name service configuration. Record queries and reverse lookups use
+ * `NodeDns.resolver` without the UTF-8 correction of `NodeDns.make`,
+ * because Bun already decodes TXT and CAA character strings as UTF-8.
+ *
+ * **Gotchas**
+ *
+ * Bun returns each character string of a TXT record as a separate record, so
+ * a record made of several strings arrives as several TXT records whose chunks
+ * cannot be reassembled (https://github.com/oven-sh/bun/issues/44692).
+ *
+ * Bun's resolver cannot query TLSA records, so TLSA queries fail with
+ * `Unsupported`.
+ *
+ * @stability experimental
+ * @since 4.0.0
+ */
+import * as NodeDns from "@effect/platform-node-shared/NodeDns"
+import * as Config from "effect/Config"
+import * as Effect from "effect/Effect"
+import * as Layer from "effect/Layer"
+import * as Dns from "effect/net/Dns"
+import type * as NetAddress from "effect/net/NetAddress"
+
+export type {
+  /**
+   * Options for the Bun `Dns` service: name servers, timeout, and tries for
+   * record queries and reverse lookups.
+   *
+   * @stability experimental
+   * @category re-exports
+   * @since 4.0.0
+   */
+  Options
+} from "@effect/platform-node-shared/NodeDns"
+
+/**
+ * Creates a Bun `Dns` service whose resolver lives as long as the scope.
+ *
+ * @stability experimental
+ * @category constructors
+ * @since 4.0.0
+ */
+export const make = Effect.fnUntraced(function*(options?: NodeDns.Options) {
+  const resolve = yield* NodeDns.resolver(options)
+  return Dns.make({
+    lookup: (host, family) =>
+      Effect.tryPromise({
+        try: () => Bun.dns.lookup(host, { family: NodeDns.toFamily(family), backend: "system" }),
+        catch: (cause) => NodeDns.dnsErrorFromCause(cause, "lookup", host)
+      }).pipe(Effect.map(NodeDns.addressesFromLookup)),
+    resolve
+  })
+})
+
+/**
+ * Layer that provides the Bun `Dns` service using the system resolver
+ * configuration.
+ *
+ * @stability experimental
+ * @category layers
+ * @since 4.0.0
+ */
+export const layer: Layer.Layer<Dns.Dns> = Layer.effect(Dns.Dns, Effect.orDie(make()))
+
+/**
+ * Creates a layer that provides the Bun `Dns` service with options read
+ * from configuration.
+ *
+ * @stability experimental
+ * @category layers
+ * @since 4.0.0
+ */
+export const layerConfig = (
+  options: Config.Wrap<NodeDns.Options>
+): Layer.Layer<Dns.Dns, Config.ConfigError | NetAddress.NetAddressError> =>
+  Layer.effect(Dns.Dns, Effect.flatMap(Config.unwrap(options), make))

package/src/BunFileSystem.ts

@@ -5,6 +5,7 @@
  * the shared Node file-system implementation. Once the layer is provided,
  * programs use the standard `effect/FileSystem` service operations.
  *
+ * @stability unstable
  * @since 4.0.0
  */
 import * as NodeFileSystem from "@effect/platform-node-shared/NodeFileSystem"
@@ -14,6 +15,7 @@ import type * as Layer from "effect/Layer"
 /**
  * Layer that provides the `FileSystem` service for Bun using the shared Node file-system implementation.
  *
+ * @stability unstable
  * @category layers
  * @since 4.0.0
  */

package/src/BunHttpClient.ts

@@ -1,4 +1,5 @@
 /**
+ * @stability unstable
  * @since 4.0.0
  */
 

package/src/BunHttpPlatform.ts

@@ -7,6 +7,7 @@
  * provides the Bun file-system layer and ETag generator required by
  * `HttpPlatform`.
  *
+ * @stability unstable
  * @since 4.0.0
  */
 import * as NodeHttpCompression from "@effect/platform-node-shared/NodeHttpCompression"
@@ -60,6 +61,7 @@ const make: Effect.Effect<
 /**
  * Layer that provides the Bun `HttpPlatform`, including file responses backed by `Bun.file`.
  *
+ * @stability unstable
  * @category layers
  * @since 4.0.0
  */

package/src/BunHttpServer.ts

@@ -9,6 +9,7 @@
  * for the server alone, the Bun HTTP support services, the combined server,
  * configurable server options, and a test server with an HTTP client.
  *
+ * @stability unstable
  * @since 4.0.0
  */
 import type { Server as BunServer, ServerWebSocket } from "bun"
@@ -60,6 +61,7 @@ import * as BunStream from "./BunStream.ts"
 /**
  * Bun serve options accepted by the HTTP server, extended with typed route definitions.
  *
+ * @stability unstable
  * @category options
  * @since 4.0.0
  */
@@ -85,6 +87,7 @@ export type ServeOptions<R extends string> =
  * that is compressed when per-message deflate is negotiated. It defaults to
  * 1024, matching the default threshold of Node's `ws` server.
  *
+ * @stability unstable
  * @category options
  * @since 4.0.0
  */
@@ -106,6 +109,7 @@ export type WebSocketOptions =
 /**
  * Creates a scoped Bun `HttpServer` from `Bun.serve` options, stopping the server on scope finalization with optional graceful shutdown settings.
  *
+ * @stability unstable
  * @category constructors
  * @since 4.0.0
  */
@@ -189,7 +193,9 @@ export const make = Effect.fnUntraced(
 
         const httpEffect = HttpEffect.toHandled(httpApp, (request, response) =>
           Effect.sync(() => {
-            ;(request as BunServerRequest).resolve(makeResponse(request, response, services, scope))
+            const bunRequest = request as BunServerRequest
+            bunRequest.resolve(makeResponse(request, response, services, scope))
+            if (upgradedSources.has(bunRequest.source)) return upgradedResponse
           }), middleware)
 
         function handler(request: Request, server: BunServer<WebSocketContext>) {
@@ -227,6 +233,12 @@ export const make = Effect.fnUntraced(
 
 const MIN_COMPRESSIBLE_SIZE = 1024
 
+// Reported to middleware in place of the handler's discarded response.
+const upgradedResponse = ServerResponse.empty({ status: 101 })
+
+// Keyed by source so request copies from `modify` share the upgrade state.
+const upgradedSources = new WeakSet<Request>()
+
 const makeResponse = (
   request: ServerRequest.HttpServerRequest,
   response: ServerResponse.HttpServerResponse,
@@ -294,6 +306,7 @@ const makeResponse = (
 /**
  * Layer that provides only `HttpServer` by constructing a scoped Bun server from the supplied serve options.
  *
+ * @stability unstable
  * @category layers
  * @since 4.0.0
  */
@@ -308,6 +321,7 @@ export const layerServer: <R extends string>(
 /**
  * Layer that provides Bun HTTP support services: `HttpPlatform`, weak ETag generation, and `BunServices`.
  *
+ * @stability unstable
  * @category layers
  * @since 4.0.0
  */
@@ -324,6 +338,7 @@ export const layerHttpServices: Layer.Layer<
 /**
  * Layer that provides a Bun `HttpServer` together with the Bun HTTP platform, ETag generator, and Bun services.
  *
+ * @stability unstable
  * @category layers
  * @since 4.0.0
  */
@@ -344,6 +359,7 @@ export const layer = <R extends string>(
 /**
  * Layer that starts a Bun HTTP server on an ephemeral port for tests.
  *
+ * @stability unstable
  * @category testing
  * @since 4.0.0
  */
@@ -359,6 +375,7 @@ export const layerTest: Layer.Layer<
 /**
  * Creates the Bun HTTP server and support-services layer from configurable serve options.
  *
+ * @stability unstable
  * @category layers
  * @since 4.0.0
  */
@@ -613,6 +630,7 @@ class BunServerRequest extends Inspectable.Class implements ServerRequest.HttpSe
         ))
         return
       }
+      upgradedSources.add(this.source)
       const compressionThreshold = this.compressionThreshold
       resume(Effect.map(Deferred.await(deferred), (ws) => {
         const write = (chunk: Uint8Array | string | Socket.CloseEvent) =>

package/src/BunHttpServerRequest.ts

@@ -5,6 +5,7 @@
  * `Bun.BunRequest` stored inside a Bun-backed `HttpServerRequest`. It is meant
  * for code that needs to interoperate with Bun-specific request APIs.
  *
+ * @stability unstable
  * @since 4.0.0
  */
 import type { HttpServerRequest } from "effect/http/HttpServerRequest"
@@ -12,6 +13,7 @@ import type { HttpServerRequest } from "effect/http/HttpServerRequest"
 /**
  * Returns the underlying `Bun.BunRequest` from an Effect `HttpServerRequest`.
  *
+ * @stability unstable
  * @category accessors
  * @since 4.0.0
  */

package/src/BunMultipart.ts

@@ -6,6 +6,7 @@
  * `persisted` collects the form and writes file parts to scoped temporary files
  * through the current `FileSystem`, `Path`, and `Scope` services.
  *
+ * @stability unstable
  * @since 4.0.0
  */
 import type * as Effect from "effect/Effect"
@@ -19,6 +20,7 @@ import * as BunStream from "./BunStream.ts"
 /**
  * Parses a Bun `Request` body as multipart data and returns a stream of multipart parts.
  *
+ * @stability unstable
  * @category constructors
  * @since 4.0.0
  */
@@ -39,6 +41,7 @@ export const stream = (source: Request): Stream.Stream<Multipart.Part, Multipart
 /**
  * Parses and persists multipart data from a Bun `Request`, requiring file-system, path, and scope services.
  *
+ * @stability unstable
  * @category constructors
  * @since 4.0.0
  */

package/src/BunPath.ts

@@ -6,6 +6,7 @@
  * Bun code should receive path operations from the Effect environment instead
  * of importing runtime path helpers directly.
  *
+ * @stability unstable
  * @since 4.0.0
  */
 import * as NodePath from "@effect/platform-node-shared/NodePath"
@@ -15,6 +16,7 @@ import type { Path } from "effect/Path"
 /**
  * Layer that provides the default `Path` service for Bun using the shared Node path implementation.
  *
+ * @stability unstable
  * @category layers
  * @since 4.0.0
  */
@@ -23,6 +25,7 @@ export const layer: Layer.Layer<Path> = NodePath.layer
 /**
  * Layer that provides the POSIX `Path` service for Bun using the shared Node path implementation.
  *
+ * @stability unstable
  * @category layers
  * @since 4.0.0
  */
@@ -31,6 +34,7 @@ export const layerPosix: Layer.Layer<Path> = NodePath.layerPosix
 /**
  * Layer that provides the Win32 `Path` service for Bun using the shared Node path implementation.
  *
+ * @stability unstable
  * @category layers
  * @since 4.0.0
  */

package/src/BunRuntime.ts

@@ -5,6 +5,7 @@
  * fiber in Bun. It reuses the shared Node runtime runner, including its error
  * reporting, signal handling, and optional teardown behavior.
  *
+ * @stability unstable
  * @since 4.0.0
  */
 import * as NodeRuntime from "@effect/platform-node-shared/NodeRuntime"
@@ -32,6 +33,7 @@ import type { Teardown } from "effect/Runtime"
  * - `disablePrettyLogger`: Avoid adding the pretty logger.
  * - `teardown`: Provide custom finalization logic.
  *
+ * @stability unstable
  * @category running
  * @since 4.0.0
  */
@@ -57,6 +59,7 @@ export const runMain: {
    * - `disablePrettyLogger`: Avoid adding the pretty logger.
    * - `teardown`: Provide custom finalization logic.
    *
+   * @stability unstable
    * @category running
    * @since 4.0.0
    */
@@ -87,6 +90,7 @@ export const runMain: {
    * - `disablePrettyLogger`: Avoid adding the pretty logger.
    * - `teardown`: Provide custom finalization logic.
    *
+   * @stability unstable
    * @category running
    * @since 4.0.0
    */

package/src/BunServices.ts

@@ -6,6 +6,7 @@
  * and terminal services. Use the layer when a Bun program wants the standard
  * platform services from one place.
  *
+ * @stability unstable
  * @since 4.0.0
  */
 import type { Crypto } from "effect/Crypto"
@@ -26,6 +27,7 @@ import * as BunTerminal from "./BunTerminal.ts"
  * The union of core services provided by the Bun platform layer, including child
  * process spawning, filesystem, path, stdio, and terminal services.
  *
+ * @stability unstable
  * @category models
  * @since 4.0.0
  */
@@ -35,6 +37,7 @@ export type BunServices = ChildProcessSpawner | Crypto | FileSystem | Path | Ter
  * Provides the default Bun implementations for child process spawning,
  * filesystem, path, stdio, and terminal services.
  *
+ * @stability unstable
  * @category layers
  * @since 4.0.0
  */

package/src/BunSink.ts

@@ -1,4 +1,5 @@
 /**
+ * @stability unstable
  * @since 4.0.0
  */
 

package/src/BunSocket.ts

@@ -6,6 +6,7 @@
  * It also provides Bun WebSocket layers using `globalThis.WebSocket`, including
  * a constructor layer and a `Socket.Socket` layer for a WebSocket URL.
  *
+ * @stability unstable
  * @since 4.0.0
  */
 import type * as Duration from "effect/Duration"
@@ -21,25 +22,45 @@ export * from "@effect/platform-node-shared/NodeSocket"
 
 /**
  * Provides a `Socket.WebSocketConstructor` backed by Bun's global
- * `WebSocket` implementation.
+ * `WebSocket` implementation, supporting handshake headers and subprotocols
+ * together in client options objects.
  *
+ * @stability unstable
  * @category layers
  * @since 4.0.0
  */
 export const layerWebSocketConstructor: Layer.Layer<
   Socket.WebSocketConstructor
 > = Layer.succeed(Socket.WebSocketConstructor)(
-  (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)
+  (url, options) => {
+    if (options === undefined || typeof options === "string" || Array.isArray(options)) {
+      return new globalThis.WebSocket(url, options)
+    }
+    // Bun accepts `WebSocketOptions`, but `bun-types` selects the DOM
+    // overload when `lib.dom` is loaded and hides those constructor options.
+    const WebSocket = globalThis.WebSocket as unknown as {
+      new(
+        url: string,
+        options: {
+          protocols?: Array<string> | undefined
+          headers?: Readonly<Record<string, string>> | undefined
+        }
+      ): globalThis.WebSocket
+    }
+    return new WebSocket(url, {
+      // Bun requires a sequence for `protocols` in its options object.
+      protocols: typeof options.protocols === "string" ? [options.protocols] : options.protocols,
+      headers: options.headers
+    })
+  }
 )
 
 /**
  * Creates a `Socket.Socket` layer for a WebSocket URL using Bun's global
- * `WebSocket` constructor, honoring protocol, open-timeout, and
+ * `WebSocket` constructor, honoring protocol, handshake-header, open-timeout, and
  * high-water-mark options.
  *
+ * @stability unstable
  * @category layers
  * @since 4.0.0
  */
@@ -48,6 +69,7 @@ export const layerWebSocket: (
   options?: {
     readonly openTimeout?: Duration.Input | undefined
     readonly protocols?: string | Array<string> | undefined
+    readonly headers?: Readonly<Record<string, string>> | undefined
     readonly highWaterMark?: number | undefined
   } | undefined
 ) => Layer.Layer<Socket.Socket, never, never> = flow(

package/src/BunSocketServer.ts

@@ -1,4 +1,5 @@
 /**
+ * @stability unstable
  * @since 4.0.0
  */
 

package/src/BunStdio.ts

@@ -6,6 +6,7 @@
  * is read from `process.stdin`, and output and error output write to
  * `process.stdout` and `process.stderr`.
  *
+ * @stability unstable
  * @since 4.0.0
  */
 import * as NodeStdio from "@effect/platform-node-shared/NodeStdio"
@@ -16,6 +17,7 @@ import type { Stdio } from "effect/Stdio"
  * Provides the `Stdio` service backed by the current process arguments,
  * stdin, stdout, and stderr streams.
  *
+ * @stability unstable
  * @category layers
  * @since 4.0.0
  */

package/src/BunStream.ts

@@ -7,6 +7,7 @@
  * `ReadableStream` adapter that uses Bun's `readMany` reader method to pull
  * batches of values into an Effect `Stream`.
  *
+ * @stability unstable
  * @since 4.0.0
  */
 import * as Arr from "effect/Array"
@@ -27,6 +28,7 @@ export * from "@effect/platform-node-shared/NodeStream"
  * Creates a stream from a `ReadableStream` using Bun's optimized `.readMany`
  * API.
  *
+ * @stability unstable
  * @category constructors
  * @since 4.0.0
  */

package/src/BunTerminal.ts

@@ -5,6 +5,7 @@
  * creates a scoped process-backed `Terminal` service, and `layer` provides the
  * default terminal service with the standard quit behavior for key input.
  *
+ * @stability unstable
  * @since 4.0.0
  */
 import * as NodeTerminal from "@effect/platform-node-shared/NodeTerminal"
@@ -14,9 +15,11 @@ import type { Scope } from "effect/Scope"
 import type { Terminal, UserInput } from "effect/Terminal"
 
 /**
- * Creates a scoped `Terminal` service backed by process stdin/stdout, using the
- * optional predicate to decide when key input should end the input stream.
+ * Creates a scoped `Terminal` service backed by process stdin/stdout.
+ * By default, Esc, Ctrl+C, and Ctrl+D end key input. Supply `shouldQuit` to
+ * override these quit keys.
  *
+ * @stability unstable
  * @category constructors
  * @since 4.0.0
  */
@@ -24,8 +27,9 @@ export const make: (shouldQuit?: (input: UserInput) => boolean) => Effect<Termin
 
 /**
  * Provides the default process-backed `Terminal` service, ending key input on
- * the default quit keys.
+ * bare Esc, Ctrl+C, or Ctrl+D.
  *
+ * @stability unstable
  * @category layers
  * @since 4.0.0
  */

package/src/BunWorker.ts

@@ -8,6 +8,7 @@
  * asks workers to close on scope finalization, and terminates them if graceful
  * shutdown times out.
  *
+ * @stability unstable
  * @since 4.0.0
  */
 import * as Deferred from "effect/Deferred"
@@ -22,6 +23,7 @@ import { WorkerError, WorkerUnknownError } from "effect/workers/WorkerError"
  * Provides the Bun `WorkerPlatform` together with a `Worker.Spawner` created
  * from the supplied worker spawning function.
  *
+ * @stability unstable
  * @category layers
  * @since 4.0.0
  */
@@ -38,6 +40,7 @@ export const layer = (
  * Effect workers and requesting graceful worker shutdown during scope
  * finalization before terminating on timeout.
  *
+ * @stability unstable
  * @category layers
  * @since 4.0.0
  */

package/src/BunWorkerRunner.ts

@@ -7,6 +7,7 @@
  * responses through the worker `postMessage` channel, and closes when the
  * parent sends the close message.
  *
+ * @stability unstable
  * @since 4.0.0
  */
 import * as Cause from "effect/Cause"
@@ -27,6 +28,7 @@ declare const self: MessagePort
  * routing parent messages to the registered handler and sending responses back
  * through the worker port.
  *
+ * @stability unstable
  * @category layers
  * @since 4.0.0
  */
@@ -62,7 +64,6 @@ export const layer: Layer.Layer<WorkerRunner.WorkerRunnerPlatform> = Layer.succe
               trackFiber(fiber)
             }
           } else {
-            port.close()
             Deferred.doneUnsafe(closeLatch, Exit.void)
           }
         }