add HttpServer.layerContext to platform-node/bun

Effect-TS · Oct 21, 2024 · ec8c546 · ec8c546
1 parent 6734a03
commit ec8c546
Show file tree

Hide file tree

Showing 6 changed files with 58 additions and 9 deletions.
diff --git a/.changeset/three-horses-learn.md b/.changeset/three-horses-learn.md
@@ -0,0 +1,7 @@
+---
+"@effect/platform-node": patch
+"@effect/platform-bun": patch
+"@effect/platform": patch
+---
+
+add HttpServer.layerContext to platform-node/bun
diff --git a/packages/platform-bun/src/BunHttpServer.ts b/packages/platform-bun/src/BunHttpServer.ts
@@ -64,3 +64,19 @@ export const layerConfig: (
  Server.HttpServer | Platform.HttpPlatform | Etag.Generator | BunContext.BunContext,
  ConfigError.ConfigError
 > = internal.layerConfig
+
+/**
+ * A Layer providing the `HttpPlatform`, `FileSystem`, `Etag.Generator`, and `Path`
+ * services.
+ *
+ * The `FileSystem` service is a no-op implementation, so this layer is only
+ * useful for platforms that have no file system.
+ *
+ * @since 1.0.0
+ * @category layers
+ */
+export const layerContext: Layer.Layer<
+ | Platform.HttpPlatform
+ | Etag.Generator
+ | BunContext.BunContext
+> = internal.layerContext
diff --git a/packages/platform-bun/src/internal/httpServer.ts b/packages/platform-bun/src/internal/httpServer.ts
@@ -173,9 +173,7 @@ export const layer = (
 ) =>
  Layer.mergeAll(
  Layer.scoped(Server.HttpServer, make(options)),
- Platform.layer,
- Etag.layerWeak,
- BunContext.layer
+ layerContext
  )
 
 /** @internal */
@@ -192,11 +190,16 @@ export const layerConfig = (
 ) =>
  Layer.mergeAll(
  Layer.scoped(Server.HttpServer, Effect.flatMap(Config.unwrap(options), make)),
- Platform.layer,
- Etag.layerWeak,
- BunContext.layer
+ layerContext
  )
 
+/** @internal */
+export const layerContext = Layer.mergeAll(
+ Platform.layer,
+ Etag.layerWeak,
+ BunContext.layer
+)
+
 interface WebSocketContext {
  readonly deferred: Deferred.Deferred<ServerWebSocket<WebSocketContext>>
  readonly closeDeferred: Deferred.Deferred<void, Socket.SocketError>

diff --git a/packages/platform-node/src/NodeHttpServer.ts b/packages/platform-node/src/NodeHttpServer.ts
@@ -112,3 +112,19 @@ export const layerTest: Layer.Layer<
  | NodeContext.NodeContext,
  ServeError
 > = internal.layerTest
+
+/**
+ * A Layer providing the `HttpPlatform`, `FileSystem`, `Etag.Generator`, and `Path`
+ * services.
+ *
+ * The `FileSystem` service is a no-op implementation, so this layer is only
+ * useful for platforms that have no file system.
+ *
+ * @since 1.0.0
+ * @category layers
+ */
+export const layerContext: Layer.Layer<
+ | Platform.HttpPlatform
+ | Etag.Generator
+ | NodeContext.NodeContext
+> = internal.layerContext
diff --git a/packages/platform-node/src/internal/httpServer.ts b/packages/platform-node/src/internal/httpServer.ts
@@ -328,11 +328,16 @@ export const layer = (
 ) =>
  Layer.mergeAll(
  Layer.scoped(Server.HttpServer, make(evaluate, options)),
- internalPlatform.layer,
- Etag.layerWeak,
- NodeContext.layer
+ layerContext
  )
 
+/** @internal */
+export const layerContext = Layer.mergeAll(
+ internalPlatform.layer,
+ Etag.layerWeak,
+ NodeContext.layer
+)
+
 /** @internal */
 export const layerTest = Server.layerTestClient.pipe(
  Layer.provide(NodeHttpClient.layerWithoutAgent),

diff --git a/packages/platform/src/HttpApiBuilder.ts b/packages/platform/src/HttpApiBuilder.ts
@@ -137,6 +137,8 @@ export const httpApp: Effect.Effect<
  * const { dispose, handler } = HttpApiBuilder.toWebHandler(
  * Layer.mergeAll(
  * MyApiLive,
+ * // you could also use NodeHttpServer.layerContext, depending on your
+ * // server's platform
  * HttpServer.layerContext
  * )
  * )