improve serve api (#324)

Effect-TS · Dec 7, 2023 · 6b90c81 · 6b90c81
1 parent b08a685
commit 6b90c81
Show file tree

Hide file tree

Showing 6 changed files with 47 additions and 38 deletions.
diff --git a/.changeset/two-items-hang.md b/.changeset/two-items-hang.md
@@ -0,0 +1,6 @@
+---
+"@effect/platform-node": patch
+"@effect/platform-bun": patch
+---
+
+improve serve api
diff --git a/docs/platform-node/Http/Server.ts.md b/docs/platform-node/Http/Server.ts.md
@@ -33,9 +33,9 @@ Also includes exports from [`@effect/platform/Http/Server`](https://effect-ts.gi
 
 ```ts
 export declare const make: (
-  evaluate: LazyArg<Http.Server>,
+  evaluate: LazyArg<Http.Server<typeof Http.IncomingMessage, typeof Http.ServerResponse>>,
   options: Net.ListenOptions
-) => Effect.Effect<Scope.Scope, never, Server.Server>
+) => Effect.Effect<Scope.Scope, ServeError, Server.Server>
 ```
 
 Added in v1.0.0
@@ -88,9 +88,9 @@ Added in v1.0.0
 
 ```ts
 export declare const layer: (
-  evaluate: LazyArg<Http.Server<typeof Http.IncomingMessage, typeof Http.ServerResponse>>,
+  evaluate: LazyArg<Http.Server>,
   options: Net.ListenOptions
-) => Layer.Layer<never, never, Server.Server | Platform.Platform>
+) => Layer.Layer<never, ServeError, Server.Server | Platform.Platform>
 ```
 
 Added in v1.0.0
@@ -101,9 +101,9 @@ Added in v1.0.0
 
 ```ts
 export declare const layerConfig: (
-  evaluate: LazyArg<Http.Server<typeof Http.IncomingMessage, typeof Http.ServerResponse>>,
+  evaluate: LazyArg<Http.Server>,
   options: Config.Config.Wrap<Net.ListenOptions>
-) => Layer.Layer<never, ConfigError.ConfigError, Server.Server | Platform.Platform>
+) => Layer.Layer<never, ServeError | ConfigError.ConfigError, Server.Server | Platform.Platform>
 ```
 
 Added in v1.0.0
diff --git a/docs/platform/Terminal.ts.md b/docs/platform/Terminal.ts.md
@@ -98,11 +98,15 @@ export interface Terminal {
   /**
    * The number of columns available on the platform's terminal interface.
    */
-  readonly columns: number
+  readonly columns: Effect<never, never, number>
   /**
    * Reads a single input event from the default standard input.
    */
   readonly readInput: Effect<never, QuitException, UserInput>
+  /**
+   * Reads a single line from the default standard input.
+   */
+  readonly readLine: Effect<never, QuitException, string>
   /**
    * Displays text to the the default standard output.
    */

diff --git a/packages/platform-bun/src/internal/http/server.ts b/packages/platform-bun/src/internal/http/server.ts
@@ -52,6 +52,7 @@ export const make = (
         const app = (middleware
           ? middleware(App.withDefaultMiddleware(respond(httpApp)))
           : App.withDefaultMiddleware(respond(httpApp))) as App.Default<never, unknown>
+
         return pipe(
           Effect.all([Effect.runtime<never>(), Effect.fiberId]),
           Effect.zipLeft(

diff --git a/packages/platform-node/src/Http/Server.ts b/packages/platform-node/src/Http/Server.ts
@@ -7,6 +7,7 @@ import type * as App from "@effect/platform/Http/App"
 import type * as Middleware from "@effect/platform/Http/Middleware"
 import type * as Platform from "@effect/platform/Http/Platform"
 import type * as Server from "@effect/platform/Http/Server"
+import type { ServeError } from "@effect/platform/Http/ServerError"
 import type * as ServerRequest from "@effect/platform/Http/ServerRequest"
 import type * as Config from "effect/Config"
 import type * as ConfigError from "effect/ConfigError"
@@ -28,9 +29,13 @@ export * from "@effect/platform/Http/Server"
  * @category constructors
  */
 export const make: (
-  evaluate: LazyArg<Http.Server>,
+  evaluate: LazyArg<Http.Server<typeof Http.IncomingMessage, typeof Http.ServerResponse>>,
   options: Net.ListenOptions
-) => Effect.Effect<Scope.Scope, never, Server.Server> = internal.make
+) => Effect.Effect<
+  Scope.Scope,
+  ServeError,
+  Server.Server
+> = internal.make
 
 /**
  * @since 1.0.0
@@ -59,15 +64,15 @@ export const makeHandler: {
  * @category layers
  */
 export const layer: (
-  evaluate: LazyArg<Http.Server<typeof Http.IncomingMessage, typeof Http.ServerResponse>>,
+  evaluate: LazyArg<Http.Server>,
   options: Net.ListenOptions
-) => Layer.Layer<never, never, Server.Server | Platform.Platform> = internal.layer
+) => Layer.Layer<never, ServeError, Server.Server | Platform.Platform> = internal.layer
 
 /**
  * @since 1.0.0
  * @category layers
  */
 export const layerConfig: (
-  evaluate: LazyArg<Http.Server<typeof Http.IncomingMessage, typeof Http.ServerResponse>>,
+  evaluate: LazyArg<Http.Server>,
   options: Config.Config.Wrap<Net.ListenOptions>
-) => Layer.Layer<never, ConfigError.ConfigError, Server.Server | Platform.Platform> = internal.layerConfig
+) => Layer.Layer<never, ServeError | ConfigError.ConfigError, Server.Server | Platform.Platform> = internal.layerConfig
diff --git a/packages/platform-node/src/internal/http/server.ts b/packages/platform-node/src/internal/http/server.ts
@@ -12,7 +12,6 @@ import type * as ServerResponse from "@effect/platform/Http/ServerResponse"
 import type * as Path from "@effect/platform/Path"
 import * as Config from "effect/Config"
 import * as Effect from "effect/Effect"
-import * as Fiber from "effect/Fiber"
 import type { LazyArg } from "effect/Function"
 import * as Layer from "effect/Layer"
 import * as Option from "effect/Option"
@@ -32,12 +31,11 @@ import * as internalPlatform from "./platform.js"
 export const make = (
   evaluate: LazyArg<Http.Server>,
   options: Net.ListenOptions
-): Effect.Effect<Scope.Scope, never, Server.Server> =>
+): Effect.Effect<Scope.Scope, Error.ServeError, Server.Server> =>
   Effect.gen(function*(_) {
-    const server = evaluate()
-
-    const serverFiber = yield* _(
-      Effect.addFinalizer(() =>
+    const server = yield* _(Effect.acquireRelease(
+      Effect.sync(evaluate),
+      (server) =>
         Effect.async<never, never, void>((resume) => {
           server.close((error) => {
             if (error) {
@@ -47,19 +45,12 @@ export const make = (
             }
           })
         })
-      ),
-      Effect.zipRight(
-        Effect.async<never, Error.ServeError, never>((resume) => {
-          server.on("error", (error) => {
-            resume(Effect.fail(Error.ServeError({ error })))
-          })
-        })
-      ),
-      Effect.scoped,
-      Effect.forkScoped
-    )
+    ))
 
-    yield* _(Effect.async<never, never, void>((resume) => {
+    yield* _(Effect.async<never, Error.ServeError, void>((resume) => {
+      server.on("error", (error) => {
+        resume(Effect.fail(Error.ServeError({ error })))
+      })
       server.listen(options, () => {
         resume(Effect.unit)
       })
@@ -80,13 +71,15 @@ export const make = (
         },
       serve: (httpApp, middleware) =>
         Effect.flatMap(makeHandler(httpApp, middleware!), (handler) =>
-          Effect.all([
-            Effect.acquireRelease(
-              Effect.sync(() => server.on("request", handler)),
-              () => Effect.sync(() => server.off("request", handler))
-            ),
-            Fiber.join(serverFiber)
-          ], { discard: true, concurrency: "unbounded" }) as Effect.Effect<never, Error.ServeError, never>)
+          Effect.zipRight(
+            Effect.addFinalizer(() => Effect.sync(() => server.off("request", handler))),
+            Effect.async<never, Error.ServeError, never>((resume) => {
+              server.on("request", handler)
+              server.on("error", (error) => {
+                resume(Effect.fail(Error.ServeError({ error })))
+              })
+            })
+          ))
     })
   }).pipe(
     Effect.locally(