Open History to see the last commit
1/**
2 * Native Deno HTTP and WebSocket layers for Effect Cluster runners.
3 *
4 * `layerHttpServer` provides the Deno HTTP server used by cluster runners. The
5 * main `layer` builds a sharding layer for HTTP or WebSocket transport,
6 * choosing serialization, runner health checks, runner storage, message
7 * storage, and optional client-only mode from the supplied options.
8 *
9 * @stability unstable
10 * @since 4.0.0
11 */
12import * as HttpRunner from "effect/cluster/HttpRunner"
13import * as MessageStorage from "effect/cluster/MessageStorage"
14import * as RunnerHealth from "effect/cluster/RunnerHealth"
15import * as Runners from "effect/cluster/Runners"
16import * as RunnerStorage from "effect/cluster/RunnerStorage"
17import type { Sharding } from "effect/cluster/Sharding"
18import * as ShardingConfig from "effect/cluster/ShardingConfig"
19import * as SqlMessageStorage from "effect/cluster/SqlMessageStorage"
20import * as SqlRunnerStorage from "effect/cluster/SqlRunnerStorage"
21import type * as Config from "effect/Config"
22import * as Digest from "effect/crypto/Digest"
23import * as Effect from "effect/Effect"
24import type * as Etag from "effect/http/Etag"
25import type { HttpPlatform } from "effect/http/HttpPlatform"
26import type { HttpServer } from "effect/http/HttpServer"
27import type { ServeError } from "effect/http/HttpServerError"
28import * as Layer from "effect/Layer"
29import * as Option from "effect/Option"
30import * as RpcSerialization from "effect/rpc/RpcSerialization"
31import type { SqlClient } from "effect/sql/SqlClient"
32import { layerK8sHttpClient } from "./DenoClusterSocket.ts"
33import * as DenoHttpClient from "./DenoHttpClient.ts"
34import * as DenoHttpServer from "./DenoHttpServer.ts"
35import type { DenoServices } from "./DenoServices.ts"
36import * as DenoSocket from "./DenoSocket.ts"
37
38export {
39 /**
40 * Layer that provides a Kubernetes HTTP client for runner health checks.
41 *
42 * @stability unstable
43 * @category re-exports
44 * @since 4.0.0
45 */
46 layerK8sHttpClient
47}
48
49/**
50 * Layer that provides a native Deno HTTP server for cluster runners.
51 *
52 * @stability unstable
53 * @category layers
54 * @since 4.0.0
55 */
56export const layerHttpServer: Layer.Layer<
57 | HttpPlatform
58 | Etag.Generator
59 | DenoServices
60 | HttpServer,
61 ServeError,
62 ShardingConfig.ShardingConfig
63> = Effect.gen(function*() {
64 const config = yield* ShardingConfig.ShardingConfig
65 const listenAddress = Option.orElse(config.runnerListenAddress, () => config.runnerAddress)
66 if (Option.isNone(listenAddress)) {
67 return yield* Effect.die("DenoClusterHttp.layerHttpServer: ShardingConfig.runnerAddress is None")
68 }
69 return DenoHttpServer.layer({
70 hostname: listenAddress.value.host,
71 port: listenAddress.value.port,
72 onListen: () => {}
73 })
74}).pipe(Layer.unwrap)
75
76/**
77 * Creates Deno cluster layers for HTTP or WebSocket transport, configuring
78 * serialization, storage, runner health, and optional client-only mode.
79 *
80 * @stability unstable
81 * @category layers
82 * @since 4.0.0
83 */
84export const layer = <
85 const ClientOnly extends boolean = false,
86 const Storage extends "local" | "sql" | "byo" = never
87>(options: {
88 readonly transport: "http" | "websocket"
89 readonly serialization?: "binary" | "ndjson" | undefined
90 readonly serializationMaxBufferSize?: number | "unbounded" | undefined
91 readonly clientOnly?: ClientOnly | undefined
92 readonly storage?: Storage | undefined
93 readonly runnerHealth?: "ping" | "k8s" | undefined
94 readonly runnerHealthK8s?: {
95 readonly namespace?: string | undefined
96 readonly labelSelector?: string | undefined
97 } | undefined
98 readonly shardingConfig?: Partial<ShardingConfig.ShardingConfig["Service"]> | undefined
99}): ClientOnly extends true ? Layer.Layer<
100 Sharding | Runners.Runners | ("byo" extends Storage ? never : MessageStorage.MessageStorage),
101 Config.ConfigError,
102 "local" extends Storage ? never
103 : "byo" extends Storage ? (MessageStorage.MessageStorage | RunnerStorage.RunnerStorage)
104 : SqlClient
105 > :
106 Layer.Layer<
107 Sharding | Runners.Runners | ("byo" extends Storage ? never : MessageStorage.MessageStorage),
108 ServeError | Config.ConfigError,
109 "local" extends Storage ? never
110 : "byo" extends Storage ? (MessageStorage.MessageStorage | RunnerStorage.RunnerStorage)
111 : SqlClient
112 > =>
113{
114 const layer: Layer.Layer<any, any, any> = options.clientOnly
115 ? options.transport === "http"
116 ? Layer.provide(HttpRunner.layerHttpClientOnly, DenoHttpClient.layer)
117 : Layer.provide(HttpRunner.layerWebsocketClientOnly, DenoSocket.layerWebSocketConstructor)
118 : options.transport === "http"
119 ? Layer.provide(HttpRunner.layerHttp, [layerHttpServer, DenoHttpClient.layer])
120 : Layer.provide(HttpRunner.layerWebsocket, [layerHttpServer, DenoSocket.layerWebSocketConstructor])
121
122 const runnerHealth: Layer.Layer<any, any, any> = options.clientOnly
123 ? Layer.empty as any
124 : options.runnerHealth === "k8s"
125 ? RunnerHealth.layerK8s(options.runnerHealthK8s).pipe(
126 Layer.provide(layerK8sHttpClient)
127 )
128 : RunnerHealth.layerPing.pipe(
129 Layer.provide(Runners.layerRpc),
130 Layer.provide(
131 options.transport === "http"
132 ? HttpRunner.layerClientProtocolHttpDefault.pipe(Layer.provide(DenoHttpClient.layer))
133 : HttpRunner.layerClientProtocolWebsocketDefault.pipe(Layer.provide(DenoSocket.layerWebSocketConstructor))
134 )
135 )
136
137 return layer.pipe(
138 Layer.provide(runnerHealth),
139 Layer.provideMerge(
140 options.storage === "local"
141 ? MessageStorage.layerNoop
142 : options.storage === "byo"
143 ? Layer.empty
144 : SqlMessageStorage.layer.pipe(Layer.provide(Digest.layerWebCrypto))
145 ),
146 Layer.provide(
147 options.storage === "local"
148 ? RunnerStorage.layerMemory
149 : options.storage === "byo"
150 ? Layer.empty
151 : Layer.orDie(SqlRunnerStorage.layer)
152 ),
153 Layer.provide(ShardingConfig.layerFromEnv(options.shardingConfig)),
154 Layer.provide(
155 options.serialization === "ndjson"
156 ? RpcSerialization.layerNdjsonWith({ maxBufferSize: options.serializationMaxBufferSize })
157 : RpcSerialization.layerSchemaBinary({ maxFrameSize: options.serializationMaxBufferSize })
158 )
159 ) as any
160}