@mark1russell7/service 0.8.19 → 0.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -2
- package/build/backoff.d.ts +44 -2
- package/build/{builder-zO48Vgoj.d.ts → builder.d.ts} +14 -101
- package/build/builder.js +499 -0
- package/build/builder.js.map +1 -0
- package/build/{call-context-DDhcVvn5.d.ts → call-context.d.ts} +3 -4
- package/build/channel.d.ts +1 -1
- package/build/channel.js.map +1 -1
- package/build/{core-BSzt4RI2.d.ts → client/core.d.ts} +32 -61
- package/build/{machine-BhVeHr_m.js → client/core.js} +4 -153
- package/build/client/core.js.map +1 -0
- package/build/{dial-ChwIcvd4.d.ts → client/dial.d.ts} +3 -4
- package/build/client/dial.js +52 -0
- package/build/client/dial.js.map +1 -0
- package/build/client/machine.js +29 -0
- package/build/client/machine.js.map +1 -0
- package/build/client/meets.d.ts +35 -0
- package/build/client/meets.js +78 -0
- package/build/client/meets.js.map +1 -0
- package/build/clock.d.ts +2 -2
- package/build/clock.js +1 -1
- package/build/conformance.d.ts +122 -0
- package/build/conformance.js +469 -0
- package/build/conformance.js.map +1 -0
- package/build/contract.d.ts +28 -0
- package/build/contract.js +184 -0
- package/build/contract.js.map +1 -0
- package/build/description.d.ts +161 -0
- package/build/description.js +11 -0
- package/build/description.js.map +1 -0
- package/build/drains.js +35 -0
- package/build/drains.js.map +1 -0
- package/build/events.d.ts +25 -0
- package/build/fakes.d.ts +43 -0
- package/build/fakes.js +93 -0
- package/build/fakes.js.map +1 -0
- package/build/grpc/client.d.ts +153 -0
- package/build/grpc/client.js +474 -0
- package/build/grpc/client.js.map +1 -0
- package/build/grpc/connection.d.ts +97 -0
- package/build/grpc/connection.js +59 -0
- package/build/grpc/connection.js.map +1 -0
- package/build/grpc/machine.d.ts +12 -0
- package/build/grpc/machine.js +149 -0
- package/build/grpc/machine.js.map +1 -0
- package/build/grpc/meets.d.ts +14 -0
- package/build/grpc/meets.js +105 -0
- package/build/grpc/meets.js.map +1 -0
- package/build/grpc/starting.d.ts +33 -0
- package/build/grpc/starting.js +89 -0
- package/build/grpc/starting.js.map +1 -0
- package/build/grpc.d.ts +9 -303
- package/build/grpc.js +7 -854
- package/build/health.d.ts +93 -0
- package/build/health.js +225 -0
- package/build/health.js.map +1 -0
- package/build/heartbeat.d.ts +6 -2
- package/build/heartbeat.js.map +1 -1
- package/build/host/discovery.d.ts +61 -0
- package/build/host/discovery.js +113 -0
- package/build/host/discovery.js.map +1 -0
- package/build/host/env.d.ts +14 -0
- package/build/host/env.js +57 -0
- package/build/host/env.js.map +1 -0
- package/build/host/fakes.d.ts +82 -0
- package/build/host/fakes.js +239 -0
- package/build/host/fakes.js.map +1 -0
- package/build/host/group.d.ts +142 -0
- package/build/host/group.js +524 -0
- package/build/host/group.js.map +1 -0
- package/build/host/install.d.ts +96 -0
- package/build/host/install.js +330 -0
- package/build/host/install.js.map +1 -0
- package/build/host/lock.d.ts +78 -0
- package/build/host/lock.js +190 -0
- package/build/host/lock.js.map +1 -0
- package/build/host/logs.d.ts +26 -0
- package/build/host/logs.js +48 -0
- package/build/host/logs.js.map +1 -0
- package/build/host/node.d.ts +14 -0
- package/build/host/node.js +309 -0
- package/build/host/node.js.map +1 -0
- package/build/{ports-B1ayTL-j.d.ts → host/ports.d.ts} +15 -16
- package/build/host/ports.js +17 -0
- package/build/host/ports.js.map +1 -0
- package/build/host/probes.d.ts +51 -0
- package/build/host/probes.js +139 -0
- package/build/host/probes.js.map +1 -0
- package/build/host/processes.d.ts +32 -0
- package/build/host/processes.js +63 -0
- package/build/host/processes.js.map +1 -0
- package/build/host/render.d.ts +84 -0
- package/build/host/render.js +235 -0
- package/build/host/render.js.map +1 -0
- package/build/host/watch.d.ts +90 -0
- package/build/host/watch.js +165 -0
- package/build/host/watch.js.map +1 -0
- package/build/host.d.ts +13 -671
- package/build/host.js +12 -2126
- package/build/http/answers.js +29 -0
- package/build/http/answers.js.map +1 -0
- package/build/http/fake-server.js +61 -0
- package/build/http/fake-server.js.map +1 -0
- package/build/http/outcome.d.ts +115 -0
- package/build/http/outcome.js +325 -0
- package/build/http/outcome.js.map +1 -0
- package/build/http/probes.d.ts +83 -0
- package/build/http/probes.js +232 -0
- package/build/http/probes.js.map +1 -0
- package/build/http/transport.d.ts +165 -0
- package/build/http/transport.js +518 -0
- package/build/http/transport.js.map +1 -0
- package/build/http-client/client.d.ts +121 -0
- package/build/http-client/client.js +330 -0
- package/build/http-client/client.js.map +1 -0
- package/build/http-client/connection.d.ts +78 -0
- package/build/http-client/connection.js +54 -0
- package/build/http-client/connection.js.map +1 -0
- package/build/http-client/machine.d.ts +14 -0
- package/build/http-client/machine.js +109 -0
- package/build/http-client/machine.js.map +1 -0
- package/build/http-client/meets.d.ts +11 -0
- package/build/http-client/meets.js +74 -0
- package/build/http-client/meets.js.map +1 -0
- package/build/http-client/session.d.ts +87 -0
- package/build/http-client/session.js +99 -0
- package/build/http-client/session.js.map +1 -0
- package/build/http-client/starting.d.ts +25 -0
- package/build/http-client/starting.js +65 -0
- package/build/http-client/starting.js.map +1 -0
- package/build/http-client.d.ts +9 -330
- package/build/http-client.js +8 -707
- package/build/http.d.ts +5 -353
- package/build/http.js +3 -1086
- package/build/identity.d.ts +16 -0
- package/build/identity.js +44 -0
- package/build/identity.js.map +1 -0
- package/build/index.d.ts +35 -412
- package/build/index.js +25 -3278
- package/build/knobs.d.ts +1 -0
- package/build/{knobs-BJcz6m01.js → knobs.js} +2 -34
- package/build/knobs.js.map +1 -0
- package/build/latch.d.ts +29 -0
- package/build/latch.js +122 -0
- package/build/latch.js.map +1 -0
- package/build/{rules-HyFCBStQ.d.ts → law.d.ts} +19 -37
- package/build/law.js +149 -0
- package/build/law.js.map +1 -0
- package/build/lifecycle.d.ts +144 -0
- package/build/lifecycle.js +411 -0
- package/build/lifecycle.js.map +1 -0
- package/build/limiter/machine.d.ts +40 -0
- package/build/limiter/machine.js +279 -0
- package/build/limiter/machine.js.map +1 -0
- package/build/{policy-CBcK2XGg.d.ts → limiter/policy.d.ts} +28 -29
- package/build/{policy-UYALkqVq.js → limiter/policy.js} +10 -9
- package/build/limiter/policy.js.map +1 -0
- package/build/{limiter-BNKnwzeY.d.ts → limiter/quota.d.ts} +32 -74
- package/build/{limiter-DrM0PQV9.js → limiter/quota.js} +3 -418
- package/build/limiter/quota.js.map +1 -0
- package/build/{store-DFwFKrsB.d.ts → limiter/store.d.ts} +10 -11
- package/build/limiter/store.js +145 -0
- package/build/limiter/store.js.map +1 -0
- package/build/limiter.d.ts +4 -3
- package/build/limiter.js +4 -2
- package/build/lint.d.ts +152 -0
- package/build/lint.js +576 -0
- package/build/lint.js.map +1 -0
- package/build/logger.d.ts +71 -0
- package/build/logger.js +183 -0
- package/build/logger.js.map +1 -0
- package/build/machines.d.ts +41 -0
- package/build/machines.js +451 -0
- package/build/machines.js.map +1 -0
- package/build/metrics.d.ts +53 -0
- package/build/metrics.js +111 -0
- package/build/metrics.js.map +1 -0
- package/build/mongodb/client.d.ts +131 -0
- package/build/mongodb/client.js +388 -0
- package/build/mongodb/client.js.map +1 -0
- package/build/mongodb/connection.d.ts +112 -0
- package/build/mongodb/connection.js +12 -0
- package/build/mongodb/connection.js.map +1 -0
- package/build/mongodb/machine.d.ts +14 -0
- package/build/mongodb/machine.js +122 -0
- package/build/mongodb/machine.js.map +1 -0
- package/build/mongodb/meets.d.ts +15 -0
- package/build/mongodb/meets.js +103 -0
- package/build/mongodb/meets.js.map +1 -0
- package/build/mongodb/starting.d.ts +29 -0
- package/build/mongodb/starting.js +77 -0
- package/build/mongodb/starting.js.map +1 -0
- package/build/mongodb.d.ts +8 -296
- package/build/mongodb.js +7 -682
- package/build/operation.d.ts +27 -0
- package/build/{operation-DF73RZOI.js → operation.js} +2 -2
- package/build/operation.js.map +1 -0
- package/build/otel.d.ts +2 -2
- package/build/pg/client.d.ts +96 -0
- package/build/pg/client.js +277 -0
- package/build/pg/client.js.map +1 -0
- package/build/pg/connection.d.ts +75 -0
- package/build/pg/connection.js +11 -0
- package/build/pg/connection.js.map +1 -0
- package/build/pg/machine.d.ts +13 -0
- package/build/pg/machine.js +111 -0
- package/build/pg/machine.js.map +1 -0
- package/build/pg/meets.d.ts +14 -0
- package/build/pg/meets.js +83 -0
- package/build/pg/meets.js.map +1 -0
- package/build/pg/starting.d.ts +26 -0
- package/build/pg/starting.js +62 -0
- package/build/pg/starting.js.map +1 -0
- package/build/pg.d.ts +8 -219
- package/build/pg.js +7 -525
- package/build/poller.d.ts +9 -0
- package/build/poller.js +154 -0
- package/build/poller.js.map +1 -0
- package/build/process.d.ts +114 -0
- package/build/process.js +170 -0
- package/build/process.js.map +1 -0
- package/build/profiles.d.ts +68 -0
- package/build/profiles.js +120 -0
- package/build/profiles.js.map +1 -0
- package/build/{queue-DXdw1vLO.d.ts → queue.d.ts} +16 -29
- package/build/queue.js +279 -0
- package/build/queue.js.map +1 -0
- package/build/rabbitmq/client.d.ts +144 -0
- package/build/rabbitmq/client.js +426 -0
- package/build/rabbitmq/client.js.map +1 -0
- package/build/rabbitmq/connection.d.ts +91 -0
- package/build/rabbitmq/connection.js +15 -0
- package/build/rabbitmq/connection.js.map +1 -0
- package/build/rabbitmq/machine.d.ts +13 -0
- package/build/rabbitmq/machine.js +159 -0
- package/build/rabbitmq/machine.js.map +1 -0
- package/build/rabbitmq/meets.d.ts +12 -0
- package/build/rabbitmq/meets.js +96 -0
- package/build/rabbitmq/meets.js.map +1 -0
- package/build/rabbitmq/starting.d.ts +27 -0
- package/build/rabbitmq/starting.js +67 -0
- package/build/rabbitmq/starting.js.map +1 -0
- package/build/rabbitmq.d.ts +8 -283
- package/build/rabbitmq.js +7 -742
- package/build/redis/client.d.ts +86 -0
- package/build/redis/client.js +285 -0
- package/build/redis/client.js.map +1 -0
- package/build/redis/connection.d.ts +57 -0
- package/build/redis/connection.js +11 -0
- package/build/redis/connection.js.map +1 -0
- package/build/redis/limiter.d.ts +43 -0
- package/build/redis/limiter.js +164 -0
- package/build/redis/limiter.js.map +1 -0
- package/build/redis/machine.d.ts +12 -0
- package/build/redis/machine.js +144 -0
- package/build/redis/machine.js.map +1 -0
- package/build/redis/meets.d.ts +11 -0
- package/build/redis/meets.js +75 -0
- package/build/redis/meets.js.map +1 -0
- package/build/redis/operations.d.ts +5 -0
- package/build/redis/operations.js +114 -0
- package/build/redis/operations.js.map +1 -0
- package/build/redis.d.ts +10 -207
- package/build/redis.js +9 -771
- package/build/requests.d.ts +66 -0
- package/build/requests.js +279 -0
- package/build/requests.js.map +1 -0
- package/build/retrier.d.ts +62 -0
- package/build/{retrier-Dnjhvxol.js → retrier.js} +2 -2
- package/build/retrier.js.map +1 -0
- package/build/routes.d.ts +35 -0
- package/build/routes.js +77 -0
- package/build/routes.js.map +1 -0
- package/build/rules.d.ts +19 -2
- package/build/stops.d.ts +51 -0
- package/build/stops.js +86 -0
- package/build/stops.js.map +1 -0
- package/build/testing.d.ts +8 -270
- package/build/testing.js +4 -1027
- package/build/testing.js.map +1 -1
- package/build/timing.d.ts +63 -0
- package/build/{timing-DZl36uXs.js → timing.js} +2 -2
- package/build/timing.js.map +1 -0
- package/build/units.d.ts +17 -0
- package/build/units.js +236 -0
- package/build/units.js.map +1 -0
- package/build/watchdog.d.ts +38 -0
- package/build/watchdog.js +57 -0
- package/build/watchdog.js.map +1 -0
- package/build/websocket/client.d.ts +136 -0
- package/build/websocket/client.js +422 -0
- package/build/websocket/client.js.map +1 -0
- package/build/websocket/connection.d.ts +83 -0
- package/build/websocket/connection.js +57 -0
- package/build/websocket/connection.js.map +1 -0
- package/build/websocket/machine.d.ts +12 -0
- package/build/websocket/machine.js +155 -0
- package/build/websocket/machine.js.map +1 -0
- package/build/websocket/meets.d.ts +14 -0
- package/build/websocket/meets.js +92 -0
- package/build/websocket/meets.js.map +1 -0
- package/build/websocket/starting.d.ts +25 -0
- package/build/websocket/starting.js +69 -0
- package/build/websocket/starting.js.map +1 -0
- package/build/websocket.d.ts +9 -264
- package/build/websocket.js +8 -774
- package/build/worker.d.ts +92 -0
- package/build/worker.js +153 -0
- package/build/worker.js.map +1 -0
- package/package.json +5 -4
- package/build/backoff-QTRGfkEK.d.ts +0 -45
- package/build/clock-DpVgpY4h.d.ts +0 -2
- package/build/grpc.js.map +0 -1
- package/build/host.js.map +0 -1
- package/build/http-client.js.map +0 -1
- package/build/http.js.map +0 -1
- package/build/index.js.map +0 -1
- package/build/knobs-BJcz6m01.js.map +0 -1
- package/build/lifecycle-D0J-zwZF.d.ts +0 -374
- package/build/limiter-DrM0PQV9.js.map +0 -1
- package/build/logger-B6drv9w0.d.ts +0 -488
- package/build/machine-BhVeHr_m.js.map +0 -1
- package/build/mongodb.js.map +0 -1
- package/build/operation-DF73RZOI.js.map +0 -1
- package/build/pg.js.map +0 -1
- package/build/policy-UYALkqVq.js.map +0 -1
- package/build/process-7R9M29wN.js +0 -437
- package/build/process-7R9M29wN.js.map +0 -1
- package/build/rabbitmq.js.map +0 -1
- package/build/redis.js.map +0 -1
- package/build/requests-DD2ALv0_.js +0 -583
- package/build/requests-DD2ALv0_.js.map +0 -1
- package/build/retrier-Dnjhvxol.js.map +0 -1
- package/build/timing-DZl36uXs.js.map +0 -1
- package/build/websocket.js.map +0 -1
package/build/channel.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"channel.js","names":[],"sources":["../src/channel.ts"],"sourcesContent":["// @mark1russell7/service/channel: channels in the style of Go, on the clock of the service. It\n// imports only ./clock.ts and @mark1russell7/collections: no `node:` module and no zod. Thus a\n// client in a browser can use it, as it uses ./clock.\n//\n// The code came from @mark1russell7/collections 0.7 (the review of its API, C12, S2). The changes:\n// `timeout` and `ticker` take a clock, `ticker` does not drift, the functions that start work give\n// each failure to `onError` and write nothing to the console, and `fanIn` and `merge` take an array.\n\nimport { asyncQueue, type AsyncQueue } from \"@mark1russell7/collections\";\nimport { realClock, type Cancel, type Clock } from \"./clock.ts\";\n\n/** This function gets a failure of the work that a function of this entry started. */\nexport type ErrorHandler = (error: unknown) => void;\n\n/** These options are for a function that starts work and gives an output channel. */\nexport interface FlowOptions {\n /** The size of the buffer of each output channel. The default is 0: a send waits for a receiver. */\n readonly bufferSize?: number | undefined;\n /**\n * This function gets each failure of the work. The output closes after a failure. Without it,\n * the failure is lost, but the output also closes.\n */\n readonly onError?: ErrorHandler | undefined;\n}\n\n/**\n * A channel carries values from senders to receivers, as a channel of Go does. A channel with a\n * buffer of 0 is a rendezvous: each send waits for a receiver.\n */\nexport class Channel<T> {\n private readonly queue: AsyncQueue<T>;\n private closed = false;\n\n /** This constructor makes a channel with a buffer of `bufferSize` values. The default is 0. */\n constructor(bufferSize = 0) {\n // A buffer of 0 makes a send wait for a receiver (before, `bufferSize || 1` gave it a buffer of 1: BUGS-2026-07 L17)\n this.queue = asyncQueue<T>({ capacity: bufferSize });\n }\n\n /**\n * This method sends a value. It waits while the buffer is full and no receiver waits.\n *\n * @throws Error when the channel is closed.\n */\n async send(value: T): Promise<void> {\n if (this.closed) throw new Error(\"Cannot send on closed channel\");\n await this.queue.put(value);\n }\n\n /**\n * This method receives a value. It waits while the channel has no value.\n *\n * @throws Error when the channel is closed and empty.\n */\n async receive(): Promise<T> {\n return await this.queue.take();\n }\n\n /**\n * This method waits for one value, as `receive` does, and gives it to `onValue`. When the\n * channel is closed and empty, it calls `onClosed`. These calls are synchronous: they occur in\n * the call that sends the value or closes the channel.\n *\n * @returns A function that withdraws the wait. It gives true when the wait had no value yet.\n */\n waitReceive(onValue: (value: T) => void, onClosed: (error: Error) => void): () => boolean {\n return this.queue.waitTake(onValue, onClosed);\n }\n\n /** This method sends a value if a receiver or the buffer takes it at once. It gives false when not. */\n trySend(value: T): boolean {\n if (this.closed) return false;\n return this.queue.tryPut(value);\n }\n\n /** This method receives a value if the channel has one at once. It gives undefined when not. */\n tryReceive(): T | undefined {\n return this.queue.tryTake();\n }\n\n /** This method closes the channel. A send then fails, but a receiver can take the values that stay. */\n close(): void {\n this.closed = true;\n this.queue.close();\n }\n\n /** This value is true after `close`. */\n get isClosed(): boolean {\n return this.closed;\n }\n\n /** This value is the count of values in the buffer. */\n get size(): number {\n return this.queue.size;\n }\n\n /** This method makes a case of `select` for this channel. `handler` gets the value of the case. */\n case<R>(handler: (value: T) => R): SelectCase<R> {\n return {\n // The value of each call comes from this channel, so it has the type T\n handler: (value) => handler(value as T),\n wait: (onValue, onClosed) => this.waitReceive(onValue, onClosed),\n };\n }\n\n /** This iteration receives each value. It stops when the channel is closed and empty. */\n async *[Symbol.asyncIterator](): AsyncIterator<T> {\n while (true) {\n let value: T;\n try {\n value = await this.receive();\n } catch {\n // The channel is closed and empty\n return;\n }\n yield value;\n }\n }\n}\n\n/** A wait for one value that can be withdrawn, as `Channel.waitReceive` gives it. */\nexport type Wait = (onValue: (value: unknown) => void, onClosed: (error: Error) => void) => () => boolean;\n\n/** A case of `select`: a wait for one value, and the function that gets the value. `Channel.case` makes one. */\nexport interface SelectCase<R> {\n /** This function gets the value of the case, when the case wins. */\n readonly handler: (value: unknown) => R;\n /** This function waits for one value of the case. `select` withdraws it when another case wins. */\n readonly wait: Wait;\n}\n\n/**\n * This function gives the first value of the waits, with the index of its wait. It rejects with\n * the error of the first wait whose channel is closed and empty. It withdraws each other wait in\n * the same call, so a later value stays in its channel (before, the receives of the cases that\n * lost stayed in their channels and dropped the next value of each: audit O56).\n */\nconst firstOf = (waits: readonly Wait[]): Promise<{ index: number; value: unknown }> =>\n new Promise((resolve, reject) => {\n const withdraws: Array<() => boolean> = [];\n let settled = false;\n const end = (): void => {\n settled = true;\n for (const withdraw of withdraws) withdraw();\n };\n // A wait can call back at once, in its own call, when its channel has a value or is closed\n try {\n for (let index = 0; index < waits.length && !settled; index++) {\n withdraws.push(\n waits[index]!(\n (value) => {\n if (settled) return;\n end();\n resolve({ index, value });\n },\n (error) => {\n if (settled) return;\n end();\n reject(error);\n },\n ),\n );\n }\n } catch (error) {\n // A wait that throws: the waits before it are withdrawn\n if (!settled) end();\n reject(error);\n }\n });\n\n/**\n * This function waits for the first case with a value, as the `select` of Go does, and gives the\n * result of its handler. A case that loses keeps no receive: a later value stays in its channel.\n * When the channel of a case is closed and empty, the promise rejects.\n *\n * @example\n * const result = await select(data.case((v) => `data ${v}`), timeout(1000).case(() => \"late\"));\n */\nexport const select = async <R>(...cases: readonly SelectCase<R>[]): Promise<R> => {\n const { index, value } = await firstOf(cases.map((c) => c.wait));\n // The handler runs after the race, not in the call of the sender\n return cases[index]!.handler(value);\n};\n\n/**\n * This function makes a channel that gets one value after `ms` milliseconds of `clock`, and then\n * closes. A case of it in `select` is a time limit.\n */\nexport const timeout = (ms: number, clock: Clock = realClock): Channel<void> => {\n const ch = new Channel<void>();\n clock.after(ms, () => {\n // The value waits for a receiver. The close lets the receivers after it fail at once.\n ch.send(undefined).catch(() => undefined);\n ch.close();\n });\n return ch;\n};\n\n/**\n * This error is the reason of the signal of a work that `within` stopped at its time limit. A\n * caller tells it from a failure of the work with `instanceof`.\n */\nexport class LateError extends Error {\n override readonly name = \"LateError\";\n}\n\n/**\n * The result of `within`: the value of the work, an end at the time limit, or the failure of the\n * work. The field `late` tells the two failures apart.\n */\nexport type Within<T> =\n | { readonly ok: true; readonly value: T }\n | { readonly ok: false; readonly late: true }\n | { readonly ok: false; readonly late: false; readonly error: unknown };\n\n/** A work for `within`: a promise, or a function that gets the signal of the time limit. */\nexport type WithinWork<T> = PromiseLike<T> | ((signal: AbortSignal) => PromiseLike<T> | T);\n\n/**\n * This function gives the result of `work` when the work ends within `ms` milliseconds of `clock`.\n * Else it gives `{ ok: false, late: true }` at the time limit, and it aborts the signal of the work\n * with a `LateError`. The promise does not reject: a failure of the work is a result.\n *\n * The work starts before the timer. Thus a work whose own timer on `clock` ends at the time limit\n * is in time. The end of the work stops the timer, so a finished work keeps no timer. A function\n * that throws starts no timer. A failure of the work after the time limit is caught and dropped.\n * Give the work as a function to get the signal: a promise that started before the call cannot get it.\n *\n * @example\n * const result = await within((signal) => fetch(url, { signal }), 5000, clock);\n * if (result.ok) use(result.value);\n * else if (result.late) report(\"late\");\n * else report(result.error);\n */\nexport const within = <T>(work: WithinWork<T>, ms: number, clock: Clock = realClock): Promise<Within<T>> => {\n if (!(Number.isFinite(ms) && ms >= 0)) throw new RangeError(`The time limit of within is a finite number of 0 or more, not ${ms}`);\n const controller = new AbortController();\n let started: PromiseLike<T> | T;\n try {\n started = typeof work === \"function\" ? work(controller.signal) : work;\n } catch (error) {\n return Promise.resolve({ ok: false, late: false, error });\n }\n return new Promise<Within<T>>((resolve) => {\n let done = false;\n const cancel = clock.after(ms, () => {\n if (done) return;\n done = true;\n resolve({ ok: false, late: true });\n controller.abort(new LateError(`The work did not end within ${ms} ms`));\n });\n const end = (result: Within<T>): void => {\n if (done) return;\n done = true;\n cancel();\n resolve(result);\n };\n // The handlers also catch a failure after the time limit: it is not an unhandled rejection\n Promise.resolve(started).then(\n (value) => end({ ok: true, value }),\n (error: unknown) => end({ ok: false, late: false, error }),\n );\n });\n};\n\n/** A ticker is a channel of the numbers of its ticks. `stop` stops its timer and closes it. */\nexport type Ticker = Channel<number> & { readonly stop: () => void };\n\n/**\n * This function makes a channel that gets a tick each `ms` milliseconds of `clock`. Tick k (from 0)\n * comes due at start + (k + 1) * ms, so the ticks do not drift. A late timer gives the number of\n * the last tick that came due, and skips the ticks that it missed. The buffer has 1 value: a slow\n * receiver loses ticks, as with the ticker of Go.\n */\nexport const ticker = (ms: number, clock: Clock = realClock): Ticker => {\n if (!(Number.isFinite(ms) && ms > 0)) throw new RangeError(`The period of a ticker is a finite number above 0, not ${ms}`);\n const ch = new Channel<number>(1);\n const start = clock.now();\n let cancel: Cancel | undefined;\n const arm = (tick: number): void => {\n cancel = clock.after(Math.max(0, start + (tick + 1) * ms - clock.now()), () => {\n const due = Math.max(tick, Math.floor((clock.now() - start) / ms) - 1);\n ch.trySend(due);\n arm(due + 1);\n });\n };\n arm(0);\n return Object.assign(ch, {\n stop: () => {\n cancel?.();\n ch.close();\n },\n });\n};\n\n/** This function starts `work`. It gives a failure to `onError`, and it calls `end` after the work in each case. */\nconst run = (work: () => Promise<void>, end: () => void, onError: ErrorHandler | undefined): void => {\n void work()\n .catch((error: unknown) => onError?.(error))\n .finally(end);\n};\n\n/**\n * This function gives a channel of `transform` of each value of `input`. The output closes when\n * `input` is closed and empty, or after a failure of `transform`.\n */\nexport const pipeline = <T, U>(input: Channel<T>, transform: (value: T) => U | Promise<U>, options: FlowOptions = {}): Channel<U> => {\n const output = new Channel<U>(options.bufferSize);\n run(\n async () => {\n for await (const value of input) await output.send(await transform(value));\n },\n () => output.close(),\n options.onError,\n );\n return output;\n};\n\n/**\n * This function gives `count` channels. Each one gets each value of `input`. The outputs close when\n * `input` is closed and empty, or after a failed send.\n */\nexport const fanOut = <T>(input: Channel<T>, count: number, options: FlowOptions = {}): Channel<T>[] => {\n const outputs = Array.from({ length: count }, () => new Channel<T>(options.bufferSize));\n run(\n async () => {\n for await (const value of input) await Promise.all(outputs.map((ch) => ch.send(value)));\n },\n () => {\n for (const ch of outputs) ch.close();\n },\n options.onError,\n );\n return outputs;\n};\n\n/**\n * This function gives one channel with the values of all `inputs`. The output closes when each\n * input is closed and empty. A failed send of one input goes to `onError`.\n */\nexport const fanIn = <T>(inputs: readonly Channel<T>[], options: FlowOptions = {}): Channel<T> => {\n const output = new Channel<T>(options.bufferSize);\n const workers = inputs.map(async (input) => {\n for await (const value of input) await output.send(value);\n });\n // All the workers settle, then the output closes, also after a failed send\n void Promise.allSettled(workers).then((results) => {\n output.close();\n for (const result of results) if (result.status === \"rejected\") options.onError?.(result.reason);\n });\n return output;\n};\n\n/**\n * This function gives one channel with the values of `inputs`, as `fanIn` does, but it closes when\n * the first input is closed and empty. It takes one value at a time, from the inputs in turn, and\n * keeps no receive on an input while it waits for the reader. Thus each value reaches the output\n * one time, in the order of its input, or stays in its input. With no input, the output is closed.\n */\nexport const merge = <T>(inputs: readonly Channel<T>[]): Channel<T> => {\n const output = new Channel<T>();\n // With no input, no input can give a value, so the output is closed at once, as with fanIn\n if (inputs.length === 0) {\n output.close();\n return output;\n }\n void (async () => {\n // The input after the input of the last value comes first, so a busy input starves no other\n let start = 0;\n while (true) {\n const order = inputs.map((_, offset) => (start + offset) % inputs.length);\n let next: { index: number; value: unknown };\n try {\n next = await firstOf(order.map((index): Wait => (onValue, onClosed) => inputs[index]!.waitReceive(onValue, onClosed)));\n } catch {\n // An input is closed and empty\n break;\n }\n const index = order[next.index]!;\n start = (index + 1) % inputs.length;\n try {\n // The value came from inputs[index], so it has the type T\n await output.send(next.value as T);\n } catch {\n // The reader closed the output\n break;\n }\n }\n output.close();\n })();\n return output;\n};\n\n/** This function makes a channel with a buffer of `capacity` values. */\nexport const buffered = <T>(capacity: number): Channel<T> => new Channel<T>(capacity);\n\n/** This function makes a channel with no buffer: each send waits for a receiver. */\nexport const unbuffered = <T>(): Channel<T> => new Channel<T>(0);\n\n/** This function makes a channel with a buffer of `bufferSize` values. The default is 0. */\nexport const channel = <T>(bufferSize = 0): Channel<T> => new Channel<T>(bufferSize);\n\n/** These options are for `workerPool`. */\nexport interface WorkerPoolOptions<T> {\n /** The count of workers. The default is 1. */\n readonly workers?: number | undefined;\n /** The size of the buffer of the results. The default is 0. */\n readonly bufferSize?: number | undefined;\n /** This function gets each failure of a job, with the job. The other jobs continue. */\n readonly onError?: ((error: unknown, job: T) => void) | undefined;\n}\n\n/**\n * This function starts `workers` workers. Each one takes a job from `jobs`, gives the job to\n * `worker`, and sends the result. The results close when `jobs` is closed and empty and each\n * worker is done. A failed job goes to `onError`, and its worker takes the next job.\n */\nexport const workerPool = <T, R>(jobs: Channel<T>, worker: (job: T) => Promise<R>, options: WorkerPoolOptions<T> = {}): Channel<R> => {\n const results = new Channel<R>(options.bufferSize);\n const workers = Array.from({ length: options.workers ?? 1 }, async () => {\n for await (const job of jobs) {\n try {\n await results.send(await worker(job));\n } catch (error) {\n options.onError?.(error, job);\n }\n }\n });\n void Promise.all(workers).then(() => results.close());\n return results;\n};\n\n/**\n * This error is the reason of a task that a `preemptivePool` stopped: a newer task took its place,\n * or `stop` stopped it. A caller tells it from a failure of the task with `instanceof`.\n */\nexport class PreemptedError extends Error {\n override readonly name = \"PreemptedError\";\n}\n\n/** A pool that runs at most `max` tasks at a time, and stops the oldest task for a new task. */\nexport interface PreemptivePool {\n /**\n * This method starts `task` with a signal. When the pool is full, it first stops the oldest task.\n * The promise of a stopped task rejects at once with the reason of its signal, and the signal\n * tells the task to stop its work.\n */\n run<R>(task: (signal: AbortSignal) => Promise<R>): Promise<R>;\n /** This method stops each task that runs. The reason is `reason`, or a `PreemptedError`. */\n stop(reason?: unknown): void;\n /** This count is the number of tasks that run. */\n readonly size: number;\n}\n\n/**\n * This function makes a pool of at most `max` tasks. The newest task always operates: a new task in a\n * full pool stops the oldest task. This is the policy for work whose old results nobody reads, for\n * example the load of a page that the user left. `workerPool` keeps each job in a queue instead.\n *\n * @throws RangeError when `max` is not an integer of 1 or more.\n */\nexport const preemptivePool = (max: number): PreemptivePool => {\n if (!(Number.isInteger(max) && max >= 1)) throw new RangeError(`preemptivePool: max is an integer of 1 or more, not ${max}.`);\n // The controller of each task that runs, from the oldest. A Set keeps the order of the adds.\n const running = new Set<AbortController>();\n const preempt = (controller: AbortController, reason: unknown): void => {\n running.delete(controller);\n controller.abort(reason);\n };\n return {\n run<R>(task: (signal: AbortSignal) => Promise<R>): Promise<R> {\n for (const oldest of running) {\n if (running.size < max) break;\n preempt(oldest, new PreemptedError(\"A newer task took the place of this task.\"));\n }\n const controller = new AbortController();\n running.add(controller);\n const stopped = new Promise<never>((_resolve, reject) => {\n controller.signal.addEventListener(\"abort\", () => reject(controller.signal.reason), { once: true });\n });\n // A task that throws at once rejects as a task that fails later does\n const done = Promise.resolve().then(() => task(controller.signal));\n return Promise.race([done, stopped]).finally(() => running.delete(controller));\n },\n stop(reason?: unknown): void {\n for (const controller of [...running]) preempt(controller, reason ?? new PreemptedError(\"The pool stopped this task.\"));\n },\n get size(): number {\n return running.size;\n },\n };\n};\n"],"mappings":";;;;;;;AA6BA,IAAa,UAAb,MAAwB;CACtB;CACA,SAAiB;;CAGjB,YAAY,aAAa,GAAG;EAE1B,KAAK,QAAQ,WAAc,EAAE,UAAU,WAAW,CAAC;CACrD;;;;;;CAOA,MAAM,KAAK,OAAyB;EAClC,IAAI,KAAK,QAAQ,MAAM,IAAI,MAAM,+BAA+B;EAChE,MAAM,KAAK,MAAM,IAAI,KAAK;CAC5B;;;;;;CAOA,MAAM,UAAsB;EAC1B,OAAO,MAAM,KAAK,MAAM,KAAK;CAC/B;;;;;;;;CASA,YAAY,SAA6B,UAAiD;EACxF,OAAO,KAAK,MAAM,SAAS,SAAS,QAAQ;CAC9C;;CAGA,QAAQ,OAAmB;EACzB,IAAI,KAAK,QAAQ,OAAO;EACxB,OAAO,KAAK,MAAM,OAAO,KAAK;CAChC;;CAGA,aAA4B;EAC1B,OAAO,KAAK,MAAM,QAAQ;CAC5B;;CAGA,QAAc;EACZ,KAAK,SAAS;EACd,KAAK,MAAM,MAAM;CACnB;;CAGA,IAAI,WAAoB;EACtB,OAAO,KAAK;CACd;;CAGA,IAAI,OAAe;EACjB,OAAO,KAAK,MAAM;CACpB;;CAGA,KAAQ,SAAyC;EAC/C,OAAO;GAEL,UAAU,UAAU,QAAQ,KAAU;GACtC,OAAO,SAAS,aAAa,KAAK,YAAY,SAAS,QAAQ;EACjE;CACF;;CAGA,QAAQ,OAAO,iBAAmC;EAChD,OAAO,MAAM;GACX,IAAI;GACJ,IAAI;IACF,QAAQ,MAAM,KAAK,QAAQ;GAC7B,QAAQ;IAEN;GACF;GACA,MAAM;EACR;CACF;AACF;;;;;;;AAmBA,MAAM,WAAW,UACf,IAAI,SAAS,SAAS,WAAW;CAC/B,MAAM,YAAkC,CAAC;CACzC,IAAI,UAAU;CACd,MAAM,YAAkB;EACtB,UAAU;EACV,KAAK,MAAM,YAAY,WAAW,SAAS;CAC7C;CAEA,IAAI;EACF,KAAK,IAAI,QAAQ,GAAG,QAAQ,MAAM,UAAU,CAAC,SAAS,SACpD,UAAU,KACR,MAAM,MAAM,EACT,UAAU;GACT,IAAI,SAAS;GACb,IAAI;GACJ,QAAQ;IAAE;IAAO;GAAM,CAAC;EAC1B,IACC,UAAU;GACT,IAAI,SAAS;GACb,IAAI;GACJ,OAAO,KAAK;EACd,CACF,CACF;CAEJ,SAAS,OAAO;EAEd,IAAI,CAAC,SAAS,IAAI;EAClB,OAAO,KAAK;CACd;AACF,CAAC;;;;;;;;;AAUH,MAAa,SAAS,OAAU,GAAG,UAAgD;CACjF,MAAM,EAAE,OAAO,UAAU,MAAM,QAAQ,MAAM,KAAK,MAAM,EAAE,IAAI,CAAC;CAE/D,OAAO,MAAM,MAAM,CAAE,QAAQ,KAAK;AACpC;;;;;AAMA,MAAa,WAAW,IAAY,QAAe,cAA6B;CAC9E,MAAM,KAAK,IAAI,QAAc;CAC7B,MAAM,MAAM,UAAU;EAEpB,GAAG,KAAK,KAAA,CAAS,CAAC,CAAC,YAAY,KAAA,CAAS;EACxC,GAAG,MAAM;CACX,CAAC;CACD,OAAO;AACT;;;;;AAMA,IAAa,YAAb,cAA+B,MAAM;CACnC,OAAyB;AAC3B;;;;;;;;;;;;;;;;;AA8BA,MAAa,UAAa,MAAqB,IAAY,QAAe,cAAkC;CAC1G,IAAI,EAAE,OAAO,SAAS,EAAE,KAAK,MAAM,IAAI,MAAM,IAAI,WAAW,iEAAiE,IAAI;CACjI,MAAM,aAAa,IAAI,gBAAgB;CACvC,IAAI;CACJ,IAAI;EACF,UAAU,OAAO,SAAS,aAAa,KAAK,WAAW,MAAM,IAAI;CACnE,SAAS,OAAO;EACd,OAAO,QAAQ,QAAQ;GAAE,IAAI;GAAO,MAAM;GAAO;EAAM,CAAC;CAC1D;CACA,OAAO,IAAI,SAAoB,YAAY;EACzC,IAAI,OAAO;EACX,MAAM,SAAS,MAAM,MAAM,UAAU;GACnC,IAAI,MAAM;GACV,OAAO;GACP,QAAQ;IAAE,IAAI;IAAO,MAAM;GAAK,CAAC;GACjC,WAAW,MAAM,IAAI,UAAU,+BAA+B,GAAG,IAAI,CAAC;EACxE,CAAC;EACD,MAAM,OAAO,WAA4B;GACvC,IAAI,MAAM;GACV,OAAO;GACP,OAAO;GACP,QAAQ,MAAM;EAChB;EAEA,QAAQ,QAAQ,OAAO,CAAC,CAAC,MACtB,UAAU,IAAI;GAAE,IAAI;GAAM;EAAM,CAAC,IACjC,UAAmB,IAAI;GAAE,IAAI;GAAO,MAAM;GAAO;EAAM,CAAC,CAC3D;CACF,CAAC;AACH;;;;;;;AAWA,MAAa,UAAU,IAAY,QAAe,cAAsB;CACtE,IAAI,EAAE,OAAO,SAAS,EAAE,KAAK,KAAK,IAAI,MAAM,IAAI,WAAW,0DAA0D,IAAI;CACzH,MAAM,KAAK,IAAI,QAAgB,CAAC;CAChC,MAAM,QAAQ,MAAM,IAAI;CACxB,IAAI;CACJ,MAAM,OAAO,SAAuB;EAClC,SAAS,MAAM,MAAM,KAAK,IAAI,GAAG,SAAS,OAAO,KAAK,KAAK,MAAM,IAAI,CAAC,SAAS;GAC7E,MAAM,MAAM,KAAK,IAAI,MAAM,KAAK,OAAO,MAAM,IAAI,IAAI,SAAS,EAAE,IAAI,CAAC;GACrE,GAAG,QAAQ,GAAG;GACd,IAAI,MAAM,CAAC;EACb,CAAC;CACH;CACA,IAAI,CAAC;CACL,OAAO,OAAO,OAAO,IAAI,EACvB,YAAY;EACV,SAAS;EACT,GAAG,MAAM;CACX,EACF,CAAC;AACH;;AAGA,MAAM,OAAO,MAA2B,KAAiB,YAA4C;CACnG,KAAU,CAAC,CACR,OAAO,UAAmB,UAAU,KAAK,CAAC,CAAC,CAC3C,QAAQ,GAAG;AAChB;;;;;AAMA,MAAa,YAAkB,OAAmB,WAAyC,UAAuB,CAAC,MAAkB;CACnI,MAAM,SAAS,IAAI,QAAW,QAAQ,UAAU;CAChD,IACE,YAAY;EACV,WAAW,MAAM,SAAS,OAAO,MAAM,OAAO,KAAK,MAAM,UAAU,KAAK,CAAC;CAC3E,SACM,OAAO,MAAM,GACnB,QAAQ,OACV;CACA,OAAO;AACT;;;;;AAMA,MAAa,UAAa,OAAmB,OAAe,UAAuB,CAAC,MAAoB;CACtG,MAAM,UAAU,MAAM,KAAK,EAAE,QAAQ,MAAM,SAAS,IAAI,QAAW,QAAQ,UAAU,CAAC;CACtF,IACE,YAAY;EACV,WAAW,MAAM,SAAS,OAAO,MAAM,QAAQ,IAAI,QAAQ,KAAK,OAAO,GAAG,KAAK,KAAK,CAAC,CAAC;CACxF,SACM;EACJ,KAAK,MAAM,MAAM,SAAS,GAAG,MAAM;CACrC,GACA,QAAQ,OACV;CACA,OAAO;AACT;;;;;AAMA,MAAa,SAAY,QAA+B,UAAuB,CAAC,MAAkB;CAChG,MAAM,SAAS,IAAI,QAAW,QAAQ,UAAU;CAChD,MAAM,UAAU,OAAO,IAAI,OAAO,UAAU;EAC1C,WAAW,MAAM,SAAS,OAAO,MAAM,OAAO,KAAK,KAAK;CAC1D,CAAC;CAED,QAAa,WAAW,OAAO,CAAC,CAAC,MAAM,YAAY;EACjD,OAAO,MAAM;EACb,KAAK,MAAM,UAAU,SAAS,IAAI,OAAO,WAAW,YAAY,QAAQ,UAAU,OAAO,MAAM;CACjG,CAAC;CACD,OAAO;AACT;;;;;;;AAQA,MAAa,SAAY,WAA8C;CACrE,MAAM,SAAS,IAAI,QAAW;CAE9B,IAAI,OAAO,WAAW,GAAG;EACvB,OAAO,MAAM;EACb,OAAO;CACT;CACA,CAAM,YAAY;EAEhB,IAAI,QAAQ;EACZ,OAAO,MAAM;GACX,MAAM,QAAQ,OAAO,KAAK,GAAG,YAAY,QAAQ,UAAU,OAAO,MAAM;GACxE,IAAI;GACJ,IAAI;IACF,OAAO,MAAM,QAAQ,MAAM,KAAK,WAAiB,SAAS,aAAa,OAAO,MAAM,CAAE,YAAY,SAAS,QAAQ,CAAC,CAAC;GACvH,QAAQ;IAEN;GACF;GAEA,SADc,MAAM,KAAK,SACR,KAAK,OAAO;GAC7B,IAAI;IAEF,MAAM,OAAO,KAAK,KAAK,KAAU;GACnC,QAAQ;IAEN;GACF;EACF;EACA,OAAO,MAAM;CACf,EAAA,CAAG;CACH,OAAO;AACT;;AAGA,MAAa,YAAe,aAAiC,IAAI,QAAW,QAAQ;;AAGpF,MAAa,mBAAkC,IAAI,QAAW,CAAC;;AAG/D,MAAa,WAAc,aAAa,MAAkB,IAAI,QAAW,UAAU;;;;;;AAiBnF,MAAa,cAAoB,MAAkB,QAAgC,UAAgC,CAAC,MAAkB;CACpI,MAAM,UAAU,IAAI,QAAW,QAAQ,UAAU;CACjD,MAAM,UAAU,MAAM,KAAK,EAAE,QAAQ,QAAQ,WAAW,EAAE,GAAG,YAAY;EACvE,WAAW,MAAM,OAAO,MACtB,IAAI;GACF,MAAM,QAAQ,KAAK,MAAM,OAAO,GAAG,CAAC;EACtC,SAAS,OAAO;GACd,QAAQ,UAAU,OAAO,GAAG;EAC9B;CAEJ,CAAC;CACD,QAAa,IAAI,OAAO,CAAC,CAAC,WAAW,QAAQ,MAAM,CAAC;CACpD,OAAO;AACT;;;;;AAMA,IAAa,iBAAb,cAAoC,MAAM;CACxC,OAAyB;AAC3B;;;;;;;;AAuBA,MAAa,kBAAkB,QAAgC;CAC7D,IAAI,EAAE,OAAO,UAAU,GAAG,KAAK,OAAO,IAAI,MAAM,IAAI,WAAW,uDAAuD,IAAI,EAAE;CAE5H,MAAM,0BAAU,IAAI,IAAqB;CACzC,MAAM,WAAW,YAA6B,WAA0B;EACtE,QAAQ,OAAO,UAAU;EACzB,WAAW,MAAM,MAAM;CACzB;CACA,OAAO;EACL,IAAO,MAAuD;GAC5D,KAAK,MAAM,UAAU,SAAS;IAC5B,IAAI,QAAQ,OAAO,KAAK;IACxB,QAAQ,QAAQ,IAAI,eAAe,2CAA2C,CAAC;GACjF;GACA,MAAM,aAAa,IAAI,gBAAgB;GACvC,QAAQ,IAAI,UAAU;GACtB,MAAM,UAAU,IAAI,SAAgB,UAAU,WAAW;IACvD,WAAW,OAAO,iBAAiB,eAAe,OAAO,WAAW,OAAO,MAAM,GAAG,EAAE,MAAM,KAAK,CAAC;GACpG,CAAC;GAED,MAAM,OAAO,QAAQ,QAAQ,CAAC,CAAC,WAAW,KAAK,WAAW,MAAM,CAAC;GACjE,OAAO,QAAQ,KAAK,CAAC,MAAM,OAAO,CAAC,CAAC,CAAC,cAAc,QAAQ,OAAO,UAAU,CAAC;EAC/E;EACA,KAAK,QAAwB;GAC3B,KAAK,MAAM,cAAc,CAAC,GAAG,OAAO,GAAG,QAAQ,YAAY,UAAU,IAAI,eAAe,6BAA6B,CAAC;EACxH;EACA,IAAI,OAAe;GACjB,OAAO,QAAQ;EACjB;CACF;AACF"}
|
|
1
|
+
{"version":3,"file":"channel.js","names":[],"sources":["../src/channel.ts"],"sourcesContent":["// @mark1russell7/service/channel: channels in the style of Go, on the clock of the service. It\n// imports only ./clock.ts and @mark1russell7/collections: no `node:` module and no zod. Thus a\n// client in a browser can use it, as it uses ./clock.\n//\n// The code came from @mark1russell7/collections 0.7 (the review of its API, C12, S2). The changes:\n// `timeout` and `ticker` take a clock, `ticker` does not drift, the functions that start work give\n// each failure to `onError` and write nothing to the console, and `fanIn` and `merge` take an array.\n\nimport { asyncQueue, type AsyncQueue } from \"@mark1russell7/collections\";\nimport { realClock, type Cancel, type Clock } from \"./clock.ts\";\n\n/** This function gets a failure of the work that a function of this entry started. */\nexport type ErrorHandler = (error: unknown) => void;\n\n/** These options are for a function that starts work and gives an output channel. */\nexport interface FlowOptions {\n /** The size of the buffer of each output channel. The default is 0: a send waits for a receiver. */\n readonly bufferSize?: number | undefined;\n /**\n * This function gets each failure of the work. The output closes after a failure. Without it,\n * the failure is lost, but the output also closes.\n */\n readonly onError?: ErrorHandler | undefined;\n}\n\n/**\n * A channel carries values from senders to receivers, as a channel of Go does. A channel with a\n * buffer of 0 is a rendezvous: each send waits for a receiver.\n */\nexport class Channel<T> {\n private readonly queue: AsyncQueue<T>;\n private closed = false;\n\n /** This constructor makes a channel with a buffer of `bufferSize` values. The default is 0. */\n constructor(bufferSize = 0) {\n // A buffer of 0 makes a send wait for a receiver (before, `bufferSize || 1` gave it a buffer of 1: BUGS-2026-07 L17)\n this.queue = asyncQueue<T>({ capacity: bufferSize });\n }\n\n /**\n * This method sends a value. It waits while the buffer is full and no receiver waits.\n *\n * @throws Error when the channel is closed.\n */\n async send(value: T): Promise<void> {\n if (this.closed) throw new Error(\"Cannot send on closed channel\");\n await this.queue.put(value);\n }\n\n /**\n * This method receives a value. It waits while the channel has no value.\n *\n * @throws Error when the channel is closed and empty.\n */\n async receive(): Promise<T> {\n return await this.queue.take();\n }\n\n /**\n * This method waits for one value, as `receive` does, and gives it to `onValue`. When the\n * channel is closed and empty, it calls `onClosed`. These calls are synchronous: they occur in\n * the call that sends the value or closes the channel.\n *\n * @returns A function that withdraws the wait. It gives true when the wait had no value yet.\n */\n waitReceive(onValue: (value: T) => void, onClosed: (error: Error) => void): () => boolean {\n return this.queue.waitTake(onValue, onClosed);\n }\n\n /** This method sends a value if a receiver or the buffer takes it at once. It gives false when not. */\n trySend(value: T): boolean {\n if (this.closed) return false;\n return this.queue.tryPut(value);\n }\n\n /** This method receives a value if the channel has one at once. It gives undefined when not. */\n tryReceive(): T | undefined {\n return this.queue.tryTake();\n }\n\n /** This method closes the channel. A send then fails, but a receiver can take the values that stay. */\n close(): void {\n this.closed = true;\n this.queue.close();\n }\n\n /** This value is true after `close`. */\n get isClosed(): boolean {\n return this.closed;\n }\n\n /** This value is the count of values in the buffer. */\n get size(): number {\n return this.queue.size;\n }\n\n /** This method makes a case of `select` for this channel. `handler` gets the value of the case. */\n case<R>(handler: (value: T) => R): SelectCase<R> {\n return {\n // The value of each call comes from this channel, so it has the type T\n handler: (value) => handler(value as T),\n wait: (onValue, onClosed) => this.waitReceive(onValue, onClosed),\n };\n }\n\n /** This iteration receives each value. It stops when the channel is closed and empty. */\n async *[Symbol.asyncIterator](): AsyncIterator<T> {\n while (true) {\n let value: T;\n try {\n value = await this.receive();\n } catch {\n // The channel is closed and empty\n return;\n }\n yield value;\n }\n }\n}\n\n/** A wait for one value that can be withdrawn, as `Channel.waitReceive` gives it. */\nexport type Wait = (onValue: (value: unknown) => void, onClosed: (error: Error) => void) => () => boolean;\n\n/** A case of `select`: a wait for one value, and the function that gets the value. `Channel.case` makes one. */\nexport interface SelectCase<R> {\n /** This function gets the value of the case, when the case wins. */\n readonly handler: (value: unknown) => R;\n /** This function waits for one value of the case. `select` withdraws it when another case wins. */\n readonly wait: Wait;\n}\n\n/**\n * This function gives the first value of the waits, with the index of its wait. It rejects with\n * the error of the first wait whose channel is closed and empty. It withdraws each other wait in\n * the same call, so a later value stays in its channel (before, the receives of the cases that\n * lost stayed in their channels and dropped the next value of each: audit O56).\n */\nconst firstOf = (waits: readonly Wait[]): Promise<{ index: number; value: unknown }> =>\n new Promise((resolve, reject) => {\n const withdraws: Array<() => boolean> = [];\n let settled = false;\n const end = (): void => {\n settled = true;\n for (const withdraw of withdraws) withdraw();\n };\n // A wait can call back at once, in its own call, when its channel has a value or is closed\n try {\n for (let index = 0; index < waits.length && !settled; index++) {\n withdraws.push(\n waits[index]!(\n (value) => {\n if (settled) return;\n end();\n resolve({ index, value });\n },\n (error) => {\n if (settled) return;\n end();\n reject(error);\n },\n ),\n );\n }\n } catch (error) {\n // A wait that throws: the waits before it are withdrawn\n if (!settled) end();\n reject(error);\n }\n });\n\n/**\n * This function waits for the first case with a value, as the `select` of Go does, and gives the\n * result of its handler. A case that loses keeps no receive: a later value stays in its channel.\n * When the channel of a case is closed and empty, the promise rejects.\n *\n * @example\n * const result = await select(data.case((v) => `data ${v}`), timeout(1000).case(() => \"late\"));\n */\nexport const select = async <R>(...cases: readonly SelectCase<R>[]): Promise<R> => {\n const { index, value } = await firstOf(cases.map((c) => c.wait));\n // The handler runs after the race, not in the call of the sender\n return cases[index]!.handler(value);\n};\n\n/**\n * This function makes a channel that gets one value after `ms` milliseconds of `clock`, and then\n * closes. A case of it in `select` is a time limit.\n */\nexport const timeout = (ms: number, clock: Clock = realClock): Channel<void> => {\n const ch = new Channel<void>();\n // a receiver awaits this value, thus the timer keeps the process alive (SYS-126)\n clock.after(ms, () => {\n // The value waits for a receiver. The close lets the receivers after it fail at once.\n ch.send(undefined).catch(() => undefined);\n ch.close();\n });\n return ch;\n};\n\n/**\n * This error is the reason of the signal of a work that `within` stopped at its time limit. A\n * caller tells it from a failure of the work with `instanceof`.\n */\nexport class LateError extends Error {\n override readonly name = \"LateError\";\n}\n\n/**\n * The result of `within`: the value of the work, an end at the time limit, or the failure of the\n * work. The field `late` tells the two failures apart.\n */\nexport type Within<T> =\n | { readonly ok: true; readonly value: T }\n | { readonly ok: false; readonly late: true }\n | { readonly ok: false; readonly late: false; readonly error: unknown };\n\n/** A work for `within`: a promise, or a function that gets the signal of the time limit. */\nexport type WithinWork<T> = PromiseLike<T> | ((signal: AbortSignal) => PromiseLike<T> | T);\n\n/**\n * This function gives the result of `work` when the work ends within `ms` milliseconds of `clock`.\n * Else it gives `{ ok: false, late: true }` at the time limit, and it aborts the signal of the work\n * with a `LateError`. The promise does not reject: a failure of the work is a result.\n *\n * The work starts before the timer. Thus a work whose own timer on `clock` ends at the time limit\n * is in time. The end of the work stops the timer, so a finished work keeps no timer. A function\n * that throws starts no timer. A failure of the work after the time limit is caught and dropped.\n * Give the work as a function to get the signal: a promise that started before the call cannot get it.\n *\n * @example\n * const result = await within((signal) => fetch(url, { signal }), 5000, clock);\n * if (result.ok) use(result.value);\n * else if (result.late) report(\"late\");\n * else report(result.error);\n */\nexport const within = <T>(work: WithinWork<T>, ms: number, clock: Clock = realClock): Promise<Within<T>> => {\n if (!(Number.isFinite(ms) && ms >= 0)) throw new RangeError(`The time limit of within is a finite number of 0 or more, not ${ms}`);\n const controller = new AbortController();\n let started: PromiseLike<T> | T;\n try {\n started = typeof work === \"function\" ? work(controller.signal) : work;\n } catch (error) {\n return Promise.resolve({ ok: false, late: false, error });\n }\n return new Promise<Within<T>>((resolve) => {\n let done = false;\n // the caller awaits the bound, thus the timer keeps the process alive (SYS-126)\n const cancel = clock.after(ms, () => {\n if (done) return;\n done = true;\n resolve({ ok: false, late: true });\n controller.abort(new LateError(`The work did not end within ${ms} ms`));\n });\n const end = (result: Within<T>): void => {\n if (done) return;\n done = true;\n cancel();\n resolve(result);\n };\n // The handlers also catch a failure after the time limit: it is not an unhandled rejection\n Promise.resolve(started).then(\n (value) => end({ ok: true, value }),\n (error: unknown) => end({ ok: false, late: false, error }),\n );\n });\n};\n\n/** A ticker is a channel of the numbers of its ticks. `stop` stops its timer and closes it. */\nexport type Ticker = Channel<number> & { readonly stop: () => void };\n\n/**\n * This function makes a channel that gets a tick each `ms` milliseconds of `clock`. Tick k (from 0)\n * comes due at start + (k + 1) * ms, so the ticks do not drift. A late timer gives the number of\n * the last tick that came due, and skips the ticks that it missed. The buffer has 1 value: a slow\n * receiver loses ticks, as with the ticker of Go.\n */\nexport const ticker = (ms: number, clock: Clock = realClock): Ticker => {\n if (!(Number.isFinite(ms) && ms > 0)) throw new RangeError(`The period of a ticker is a finite number above 0, not ${ms}`);\n const ch = new Channel<number>(1);\n const start = clock.now();\n let cancel: Cancel | undefined;\n const arm = (tick: number): void => {\n // a ticker keeps the process alive until its caller stops it, as with setInterval (SYS-126)\n cancel = clock.after(Math.max(0, start + (tick + 1) * ms - clock.now()), () => {\n const due = Math.max(tick, Math.floor((clock.now() - start) / ms) - 1);\n ch.trySend(due);\n arm(due + 1);\n });\n };\n arm(0);\n return Object.assign(ch, {\n stop: () => {\n cancel?.();\n ch.close();\n },\n });\n};\n\n/** This function starts `work`. It gives a failure to `onError`, and it calls `end` after the work in each case. */\nconst run = (work: () => Promise<void>, end: () => void, onError: ErrorHandler | undefined): void => {\n void work()\n .catch((error: unknown) => onError?.(error))\n .finally(end);\n};\n\n/**\n * This function gives a channel of `transform` of each value of `input`. The output closes when\n * `input` is closed and empty, or after a failure of `transform`.\n */\nexport const pipeline = <T, U>(input: Channel<T>, transform: (value: T) => U | Promise<U>, options: FlowOptions = {}): Channel<U> => {\n const output = new Channel<U>(options.bufferSize);\n run(\n async () => {\n for await (const value of input) await output.send(await transform(value));\n },\n () => output.close(),\n options.onError,\n );\n return output;\n};\n\n/**\n * This function gives `count` channels. Each one gets each value of `input`. The outputs close when\n * `input` is closed and empty, or after a failed send.\n */\nexport const fanOut = <T>(input: Channel<T>, count: number, options: FlowOptions = {}): Channel<T>[] => {\n const outputs = Array.from({ length: count }, () => new Channel<T>(options.bufferSize));\n run(\n async () => {\n for await (const value of input) await Promise.all(outputs.map((ch) => ch.send(value)));\n },\n () => {\n for (const ch of outputs) ch.close();\n },\n options.onError,\n );\n return outputs;\n};\n\n/**\n * This function gives one channel with the values of all `inputs`. The output closes when each\n * input is closed and empty. A failed send of one input goes to `onError`.\n */\nexport const fanIn = <T>(inputs: readonly Channel<T>[], options: FlowOptions = {}): Channel<T> => {\n const output = new Channel<T>(options.bufferSize);\n const workers = inputs.map(async (input) => {\n for await (const value of input) await output.send(value);\n });\n // All the workers settle, then the output closes, also after a failed send\n void Promise.allSettled(workers).then((results) => {\n output.close();\n for (const result of results) if (result.status === \"rejected\") options.onError?.(result.reason);\n });\n return output;\n};\n\n/**\n * This function gives one channel with the values of `inputs`, as `fanIn` does, but it closes when\n * the first input is closed and empty. It takes one value at a time, from the inputs in turn, and\n * keeps no receive on an input while it waits for the reader. Thus each value reaches the output\n * one time, in the order of its input, or stays in its input. With no input, the output is closed.\n */\nexport const merge = <T>(inputs: readonly Channel<T>[]): Channel<T> => {\n const output = new Channel<T>();\n // With no input, no input can give a value, so the output is closed at once, as with fanIn\n if (inputs.length === 0) {\n output.close();\n return output;\n }\n void (async () => {\n // The input after the input of the last value comes first, so a busy input starves no other\n let start = 0;\n while (true) {\n const order = inputs.map((_, offset) => (start + offset) % inputs.length);\n let next: { index: number; value: unknown };\n try {\n next = await firstOf(order.map((index): Wait => (onValue, onClosed) => inputs[index]!.waitReceive(onValue, onClosed)));\n } catch {\n // An input is closed and empty\n break;\n }\n const index = order[next.index]!;\n start = (index + 1) % inputs.length;\n try {\n // The value came from inputs[index], so it has the type T\n await output.send(next.value as T);\n } catch {\n // The reader closed the output\n break;\n }\n }\n output.close();\n })();\n return output;\n};\n\n/** This function makes a channel with a buffer of `capacity` values. */\nexport const buffered = <T>(capacity: number): Channel<T> => new Channel<T>(capacity);\n\n/** This function makes a channel with no buffer: each send waits for a receiver. */\nexport const unbuffered = <T>(): Channel<T> => new Channel<T>(0);\n\n/** This function makes a channel with a buffer of `bufferSize` values. The default is 0. */\nexport const channel = <T>(bufferSize = 0): Channel<T> => new Channel<T>(bufferSize);\n\n/** These options are for `workerPool`. */\nexport interface WorkerPoolOptions<T> {\n /** The count of workers. The default is 1. */\n readonly workers?: number | undefined;\n /** The size of the buffer of the results. The default is 0. */\n readonly bufferSize?: number | undefined;\n /** This function gets each failure of a job, with the job. The other jobs continue. */\n readonly onError?: ((error: unknown, job: T) => void) | undefined;\n}\n\n/**\n * This function starts `workers` workers. Each one takes a job from `jobs`, gives the job to\n * `worker`, and sends the result. The results close when `jobs` is closed and empty and each\n * worker is done. A failed job goes to `onError`, and its worker takes the next job.\n */\nexport const workerPool = <T, R>(jobs: Channel<T>, worker: (job: T) => Promise<R>, options: WorkerPoolOptions<T> = {}): Channel<R> => {\n const results = new Channel<R>(options.bufferSize);\n const workers = Array.from({ length: options.workers ?? 1 }, async () => {\n for await (const job of jobs) {\n try {\n await results.send(await worker(job));\n } catch (error) {\n options.onError?.(error, job);\n }\n }\n });\n void Promise.all(workers).then(() => results.close());\n return results;\n};\n\n/**\n * This error is the reason of a task that a `preemptivePool` stopped: a newer task took its place,\n * or `stop` stopped it. A caller tells it from a failure of the task with `instanceof`.\n */\nexport class PreemptedError extends Error {\n override readonly name = \"PreemptedError\";\n}\n\n/** A pool that runs at most `max` tasks at a time, and stops the oldest task for a new task. */\nexport interface PreemptivePool {\n /**\n * This method starts `task` with a signal. When the pool is full, it first stops the oldest task.\n * The promise of a stopped task rejects at once with the reason of its signal, and the signal\n * tells the task to stop its work.\n */\n run<R>(task: (signal: AbortSignal) => Promise<R>): Promise<R>;\n /** This method stops each task that runs. The reason is `reason`, or a `PreemptedError`. */\n stop(reason?: unknown): void;\n /** This count is the number of tasks that run. */\n readonly size: number;\n}\n\n/**\n * This function makes a pool of at most `max` tasks. The newest task always operates: a new task in a\n * full pool stops the oldest task. This is the policy for work whose old results nobody reads, for\n * example the load of a page that the user left. `workerPool` keeps each job in a queue instead.\n *\n * @throws RangeError when `max` is not an integer of 1 or more.\n */\nexport const preemptivePool = (max: number): PreemptivePool => {\n if (!(Number.isInteger(max) && max >= 1)) throw new RangeError(`preemptivePool: max is an integer of 1 or more, not ${max}.`);\n // The controller of each task that runs, from the oldest. A Set keeps the order of the adds.\n const running = new Set<AbortController>();\n const preempt = (controller: AbortController, reason: unknown): void => {\n running.delete(controller);\n controller.abort(reason);\n };\n return {\n run<R>(task: (signal: AbortSignal) => Promise<R>): Promise<R> {\n for (const oldest of running) {\n if (running.size < max) break;\n preempt(oldest, new PreemptedError(\"A newer task took the place of this task.\"));\n }\n const controller = new AbortController();\n running.add(controller);\n const stopped = new Promise<never>((_resolve, reject) => {\n controller.signal.addEventListener(\"abort\", () => reject(controller.signal.reason), { once: true });\n });\n // A task that throws at once rejects as a task that fails later does\n const done = Promise.resolve().then(() => task(controller.signal));\n return Promise.race([done, stopped]).finally(() => running.delete(controller));\n },\n stop(reason?: unknown): void {\n for (const controller of [...running]) preempt(controller, reason ?? new PreemptedError(\"The pool stopped this task.\"));\n },\n get size(): number {\n return running.size;\n },\n };\n};\n"],"mappings":";;;;;;;AA6BA,IAAa,UAAb,MAAwB;CACtB;CACA,SAAiB;;CAGjB,YAAY,aAAa,GAAG;EAE1B,KAAK,QAAQ,WAAc,EAAE,UAAU,WAAW,CAAC;CACrD;;;;;;CAOA,MAAM,KAAK,OAAyB;EAClC,IAAI,KAAK,QAAQ,MAAM,IAAI,MAAM,+BAA+B;EAChE,MAAM,KAAK,MAAM,IAAI,KAAK;CAC5B;;;;;;CAOA,MAAM,UAAsB;EAC1B,OAAO,MAAM,KAAK,MAAM,KAAK;CAC/B;;;;;;;;CASA,YAAY,SAA6B,UAAiD;EACxF,OAAO,KAAK,MAAM,SAAS,SAAS,QAAQ;CAC9C;;CAGA,QAAQ,OAAmB;EACzB,IAAI,KAAK,QAAQ,OAAO;EACxB,OAAO,KAAK,MAAM,OAAO,KAAK;CAChC;;CAGA,aAA4B;EAC1B,OAAO,KAAK,MAAM,QAAQ;CAC5B;;CAGA,QAAc;EACZ,KAAK,SAAS;EACd,KAAK,MAAM,MAAM;CACnB;;CAGA,IAAI,WAAoB;EACtB,OAAO,KAAK;CACd;;CAGA,IAAI,OAAe;EACjB,OAAO,KAAK,MAAM;CACpB;;CAGA,KAAQ,SAAyC;EAC/C,OAAO;GAEL,UAAU,UAAU,QAAQ,KAAU;GACtC,OAAO,SAAS,aAAa,KAAK,YAAY,SAAS,QAAQ;EACjE;CACF;;CAGA,QAAQ,OAAO,iBAAmC;EAChD,OAAO,MAAM;GACX,IAAI;GACJ,IAAI;IACF,QAAQ,MAAM,KAAK,QAAQ;GAC7B,QAAQ;IAEN;GACF;GACA,MAAM;EACR;CACF;AACF;;;;;;;AAmBA,MAAM,WAAW,UACf,IAAI,SAAS,SAAS,WAAW;CAC/B,MAAM,YAAkC,CAAC;CACzC,IAAI,UAAU;CACd,MAAM,YAAkB;EACtB,UAAU;EACV,KAAK,MAAM,YAAY,WAAW,SAAS;CAC7C;CAEA,IAAI;EACF,KAAK,IAAI,QAAQ,GAAG,QAAQ,MAAM,UAAU,CAAC,SAAS,SACpD,UAAU,KACR,MAAM,MAAM,EACT,UAAU;GACT,IAAI,SAAS;GACb,IAAI;GACJ,QAAQ;IAAE;IAAO;GAAM,CAAC;EAC1B,IACC,UAAU;GACT,IAAI,SAAS;GACb,IAAI;GACJ,OAAO,KAAK;EACd,CACF,CACF;CAEJ,SAAS,OAAO;EAEd,IAAI,CAAC,SAAS,IAAI;EAClB,OAAO,KAAK;CACd;AACF,CAAC;;;;;;;;;AAUH,MAAa,SAAS,OAAU,GAAG,UAAgD;CACjF,MAAM,EAAE,OAAO,UAAU,MAAM,QAAQ,MAAM,KAAK,MAAM,EAAE,IAAI,CAAC;CAE/D,OAAO,MAAM,MAAM,CAAE,QAAQ,KAAK;AACpC;;;;;AAMA,MAAa,WAAW,IAAY,QAAe,cAA6B;CAC9E,MAAM,KAAK,IAAI,QAAc;CAE7B,MAAM,MAAM,UAAU;EAEpB,GAAG,KAAK,KAAA,CAAS,CAAC,CAAC,YAAY,KAAA,CAAS;EACxC,GAAG,MAAM;CACX,CAAC;CACD,OAAO;AACT;;;;;AAMA,IAAa,YAAb,cAA+B,MAAM;CACnC,OAAyB;AAC3B;;;;;;;;;;;;;;;;;AA8BA,MAAa,UAAa,MAAqB,IAAY,QAAe,cAAkC;CAC1G,IAAI,EAAE,OAAO,SAAS,EAAE,KAAK,MAAM,IAAI,MAAM,IAAI,WAAW,iEAAiE,IAAI;CACjI,MAAM,aAAa,IAAI,gBAAgB;CACvC,IAAI;CACJ,IAAI;EACF,UAAU,OAAO,SAAS,aAAa,KAAK,WAAW,MAAM,IAAI;CACnE,SAAS,OAAO;EACd,OAAO,QAAQ,QAAQ;GAAE,IAAI;GAAO,MAAM;GAAO;EAAM,CAAC;CAC1D;CACA,OAAO,IAAI,SAAoB,YAAY;EACzC,IAAI,OAAO;EAEX,MAAM,SAAS,MAAM,MAAM,UAAU;GACnC,IAAI,MAAM;GACV,OAAO;GACP,QAAQ;IAAE,IAAI;IAAO,MAAM;GAAK,CAAC;GACjC,WAAW,MAAM,IAAI,UAAU,+BAA+B,GAAG,IAAI,CAAC;EACxE,CAAC;EACD,MAAM,OAAO,WAA4B;GACvC,IAAI,MAAM;GACV,OAAO;GACP,OAAO;GACP,QAAQ,MAAM;EAChB;EAEA,QAAQ,QAAQ,OAAO,CAAC,CAAC,MACtB,UAAU,IAAI;GAAE,IAAI;GAAM;EAAM,CAAC,IACjC,UAAmB,IAAI;GAAE,IAAI;GAAO,MAAM;GAAO;EAAM,CAAC,CAC3D;CACF,CAAC;AACH;;;;;;;AAWA,MAAa,UAAU,IAAY,QAAe,cAAsB;CACtE,IAAI,EAAE,OAAO,SAAS,EAAE,KAAK,KAAK,IAAI,MAAM,IAAI,WAAW,0DAA0D,IAAI;CACzH,MAAM,KAAK,IAAI,QAAgB,CAAC;CAChC,MAAM,QAAQ,MAAM,IAAI;CACxB,IAAI;CACJ,MAAM,OAAO,SAAuB;EAElC,SAAS,MAAM,MAAM,KAAK,IAAI,GAAG,SAAS,OAAO,KAAK,KAAK,MAAM,IAAI,CAAC,SAAS;GAC7E,MAAM,MAAM,KAAK,IAAI,MAAM,KAAK,OAAO,MAAM,IAAI,IAAI,SAAS,EAAE,IAAI,CAAC;GACrE,GAAG,QAAQ,GAAG;GACd,IAAI,MAAM,CAAC;EACb,CAAC;CACH;CACA,IAAI,CAAC;CACL,OAAO,OAAO,OAAO,IAAI,EACvB,YAAY;EACV,SAAS;EACT,GAAG,MAAM;CACX,EACF,CAAC;AACH;;AAGA,MAAM,OAAO,MAA2B,KAAiB,YAA4C;CACnG,KAAU,CAAC,CACR,OAAO,UAAmB,UAAU,KAAK,CAAC,CAAC,CAC3C,QAAQ,GAAG;AAChB;;;;;AAMA,MAAa,YAAkB,OAAmB,WAAyC,UAAuB,CAAC,MAAkB;CACnI,MAAM,SAAS,IAAI,QAAW,QAAQ,UAAU;CAChD,IACE,YAAY;EACV,WAAW,MAAM,SAAS,OAAO,MAAM,OAAO,KAAK,MAAM,UAAU,KAAK,CAAC;CAC3E,SACM,OAAO,MAAM,GACnB,QAAQ,OACV;CACA,OAAO;AACT;;;;;AAMA,MAAa,UAAa,OAAmB,OAAe,UAAuB,CAAC,MAAoB;CACtG,MAAM,UAAU,MAAM,KAAK,EAAE,QAAQ,MAAM,SAAS,IAAI,QAAW,QAAQ,UAAU,CAAC;CACtF,IACE,YAAY;EACV,WAAW,MAAM,SAAS,OAAO,MAAM,QAAQ,IAAI,QAAQ,KAAK,OAAO,GAAG,KAAK,KAAK,CAAC,CAAC;CACxF,SACM;EACJ,KAAK,MAAM,MAAM,SAAS,GAAG,MAAM;CACrC,GACA,QAAQ,OACV;CACA,OAAO;AACT;;;;;AAMA,MAAa,SAAY,QAA+B,UAAuB,CAAC,MAAkB;CAChG,MAAM,SAAS,IAAI,QAAW,QAAQ,UAAU;CAChD,MAAM,UAAU,OAAO,IAAI,OAAO,UAAU;EAC1C,WAAW,MAAM,SAAS,OAAO,MAAM,OAAO,KAAK,KAAK;CAC1D,CAAC;CAED,QAAa,WAAW,OAAO,CAAC,CAAC,MAAM,YAAY;EACjD,OAAO,MAAM;EACb,KAAK,MAAM,UAAU,SAAS,IAAI,OAAO,WAAW,YAAY,QAAQ,UAAU,OAAO,MAAM;CACjG,CAAC;CACD,OAAO;AACT;;;;;;;AAQA,MAAa,SAAY,WAA8C;CACrE,MAAM,SAAS,IAAI,QAAW;CAE9B,IAAI,OAAO,WAAW,GAAG;EACvB,OAAO,MAAM;EACb,OAAO;CACT;CACA,CAAM,YAAY;EAEhB,IAAI,QAAQ;EACZ,OAAO,MAAM;GACX,MAAM,QAAQ,OAAO,KAAK,GAAG,YAAY,QAAQ,UAAU,OAAO,MAAM;GACxE,IAAI;GACJ,IAAI;IACF,OAAO,MAAM,QAAQ,MAAM,KAAK,WAAiB,SAAS,aAAa,OAAO,MAAM,CAAE,YAAY,SAAS,QAAQ,CAAC,CAAC;GACvH,QAAQ;IAEN;GACF;GAEA,SADc,MAAM,KAAK,SACR,KAAK,OAAO;GAC7B,IAAI;IAEF,MAAM,OAAO,KAAK,KAAK,KAAU;GACnC,QAAQ;IAEN;GACF;EACF;EACA,OAAO,MAAM;CACf,EAAA,CAAG;CACH,OAAO;AACT;;AAGA,MAAa,YAAe,aAAiC,IAAI,QAAW,QAAQ;;AAGpF,MAAa,mBAAkC,IAAI,QAAW,CAAC;;AAG/D,MAAa,WAAc,aAAa,MAAkB,IAAI,QAAW,UAAU;;;;;;AAiBnF,MAAa,cAAoB,MAAkB,QAAgC,UAAgC,CAAC,MAAkB;CACpI,MAAM,UAAU,IAAI,QAAW,QAAQ,UAAU;CACjD,MAAM,UAAU,MAAM,KAAK,EAAE,QAAQ,QAAQ,WAAW,EAAE,GAAG,YAAY;EACvE,WAAW,MAAM,OAAO,MACtB,IAAI;GACF,MAAM,QAAQ,KAAK,MAAM,OAAO,GAAG,CAAC;EACtC,SAAS,OAAO;GACd,QAAQ,UAAU,OAAO,GAAG;EAC9B;CAEJ,CAAC;CACD,QAAa,IAAI,OAAO,CAAC,CAAC,WAAW,QAAQ,MAAM,CAAC;CACpD,OAAO;AACT;;;;;AAMA,IAAa,iBAAb,cAAoC,MAAM;CACxC,OAAyB;AAC3B;;;;;;;;AAuBA,MAAa,kBAAkB,QAAgC;CAC7D,IAAI,EAAE,OAAO,UAAU,GAAG,KAAK,OAAO,IAAI,MAAM,IAAI,WAAW,uDAAuD,IAAI,EAAE;CAE5H,MAAM,0BAAU,IAAI,IAAqB;CACzC,MAAM,WAAW,YAA6B,WAA0B;EACtE,QAAQ,OAAO,UAAU;EACzB,WAAW,MAAM,MAAM;CACzB;CACA,OAAO;EACL,IAAO,MAAuD;GAC5D,KAAK,MAAM,UAAU,SAAS;IAC5B,IAAI,QAAQ,OAAO,KAAK;IACxB,QAAQ,QAAQ,IAAI,eAAe,2CAA2C,CAAC;GACjF;GACA,MAAM,aAAa,IAAI,gBAAgB;GACvC,QAAQ,IAAI,UAAU;GACtB,MAAM,UAAU,IAAI,SAAgB,UAAU,WAAW;IACvD,WAAW,OAAO,iBAAiB,eAAe,OAAO,WAAW,OAAO,MAAM,GAAG,EAAE,MAAM,KAAK,CAAC;GACpG,CAAC;GAED,MAAM,OAAO,QAAQ,QAAQ,CAAC,CAAC,WAAW,KAAK,WAAW,MAAM,CAAC;GACjE,OAAO,QAAQ,KAAK,CAAC,MAAM,OAAO,CAAC,CAAC,CAAC,cAAc,QAAQ,OAAO,UAAU,CAAC;EAC/E;EACA,KAAK,QAAwB;GAC3B,KAAK,MAAM,cAAc,CAAC,GAAG,OAAO,GAAG,QAAQ,YAAY,UAAU,IAAI,eAAe,6BAA6B,CAAC;EACxH;EACA,IAAI,OAAe;GACjB,OAAO,QAAQ;EACjB;CACF;AACF"}
|
|
@@ -1,43 +1,15 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
3
|
-
import {
|
|
4
|
-
import {
|
|
5
|
-
import {
|
|
1
|
+
import { Backoff } from "../backoff.js";
|
|
2
|
+
import { ServiceBuilder } from "../builder.js";
|
|
3
|
+
import { Clock } from "../clock.js";
|
|
4
|
+
import { Check, Dependency, Gate, ServiceDescription, Step } from "../description.js";
|
|
5
|
+
import { Recorder } from "../events.js";
|
|
6
|
+
import "../latch.js";
|
|
7
|
+
import { DependencyHandle } from "../lifecycle.js";
|
|
8
|
+
import { Operation } from "../operation.js";
|
|
9
|
+
import { CheckFn } from "../poller.js";
|
|
10
|
+
import { Poll } from "../timing.js";
|
|
11
|
+
import { Meeting } from "./meets.js";
|
|
6
12
|
import { Extent, Quantity } from "@mark1russell7/quantity";
|
|
7
|
-
/** A situation is what the connection did when the failure started: a command in flight, or idle. */
|
|
8
|
-
type Situation = "in flight" | "idle";
|
|
9
|
-
/** A detector is a mechanism that finds a failure, and the most time that it takes. */
|
|
10
|
-
interface Detector {
|
|
11
|
-
/** This name identifies the mechanism: a knob of the declaration, or the kernel. */
|
|
12
|
-
readonly by: string;
|
|
13
|
-
/** This time is the most that the detector takes, after the failure starts. "infinite" tells that it does not find the failure. */
|
|
14
|
-
readonly within: Extent;
|
|
15
|
-
readonly situation: Situation;
|
|
16
|
-
/** This text tells what the detector does, for example that it fails a command without a change of state. */
|
|
17
|
-
readonly effect: string;
|
|
18
|
-
}
|
|
19
|
-
/**
|
|
20
|
-
* A meeting is a manifestation that the client can meet, and its detectors (E9). The names of the
|
|
21
|
-
* manifestations are the names of the vocabulary of the harness and the corpus. `app-stall` is a
|
|
22
|
-
* server whose process is alive and does not answer, a proposal of the vocabulary.
|
|
23
|
-
*/
|
|
24
|
-
interface Meeting {
|
|
25
|
-
readonly manifestation: string;
|
|
26
|
-
/** This text tells the failure in words. */
|
|
27
|
-
readonly what: string;
|
|
28
|
-
readonly detectors: readonly Detector[];
|
|
29
|
-
}
|
|
30
|
-
/** These are the manifestations that each client gives a meeting for, in this sequence. */
|
|
31
|
-
declare const MANIFESTATIONS: readonly ["rst", "fin", "blackhole", "freeze-host", "freeze-process", "app-stall"];
|
|
32
|
-
/** A manifestation is one name of `MANIFESTATIONS`. */
|
|
33
|
-
type Manifestation = (typeof MANIFESTATIONS)[number];
|
|
34
|
-
/** This function gives the first detector of a manifestation in a situation, or null when no detector has an end (C3). */
|
|
35
|
-
declare const firstDetector: (meeting: Meeting, situation: Situation) => Detector | null;
|
|
36
|
-
/** This function gives each manifestation and situation that no detector of the client finds: the standing rule, as a query (C3, E9). */
|
|
37
|
-
declare const unwatched: (meets: readonly Meeting[]) => Array<{
|
|
38
|
-
readonly manifestation: string;
|
|
39
|
-
readonly situation: Situation;
|
|
40
|
-
}>;
|
|
41
13
|
/**
|
|
42
14
|
* A sent result is the outcome of a call, in three values (C8):
|
|
43
15
|
* - `ok`: the server answered.
|
|
@@ -45,7 +17,7 @@ declare const unwatched: (meets: readonly Meeting[]) => Array<{
|
|
|
45
17
|
* not leave the client.
|
|
46
18
|
* - `indeterminate`: the call can have reached the server, and nothing tells if it applied.
|
|
47
19
|
*/
|
|
48
|
-
type Sent<T> = {
|
|
20
|
+
export type Sent<T> = {
|
|
49
21
|
readonly outcome: "ok";
|
|
50
22
|
readonly value: T;
|
|
51
23
|
readonly attempts: number;
|
|
@@ -60,7 +32,7 @@ type Sent<T> = {
|
|
|
60
32
|
readonly attempts: number;
|
|
61
33
|
};
|
|
62
34
|
/** This type is the outcome of one try of a call, before the core counts the tries. */
|
|
63
|
-
type Attempt<T = unknown> = {
|
|
35
|
+
export type Attempt<T = unknown> = {
|
|
64
36
|
readonly outcome: "ok";
|
|
65
37
|
readonly value: T;
|
|
66
38
|
} | {
|
|
@@ -72,18 +44,18 @@ type Attempt<T = unknown> = {
|
|
|
72
44
|
readonly error: string;
|
|
73
45
|
};
|
|
74
46
|
/** Send options tell how the client sends one call. */
|
|
75
|
-
interface SendOptions {
|
|
47
|
+
export interface SendOptions {
|
|
76
48
|
/** This signal abandons the call. A call that left the client is then indeterminate. */
|
|
77
49
|
readonly signal?: AbortSignal | undefined;
|
|
78
50
|
/** False stops the client: it does not send the call again. A check that must fail at once uses it. */
|
|
79
51
|
readonly reissue?: boolean | undefined;
|
|
80
52
|
}
|
|
81
53
|
/** A dial function opens a new connection to the server, and reads one reply of the protocol. The `dial` check uses it. */
|
|
82
|
-
type DialFn = (host: string, port: number, signal: AbortSignal) => Promise<void>;
|
|
54
|
+
export type DialFn = (host: string, port: number, signal: AbortSignal) => Promise<void>;
|
|
83
55
|
/** The steps of a connection that each client gives a check for (B14). A client can add more steps. */
|
|
84
|
-
type ClientStep = Extract<Step, "dial" | "round-trip" | "local-state">;
|
|
56
|
+
export type ClientStep = Extract<Step, "dial" | "round-trip" | "local-state">;
|
|
85
57
|
/** Check options tell which checks the client gives the health runtime, and which policy each one controls. */
|
|
86
|
-
interface CheckOptions<S extends Step = ClientStep> {
|
|
58
|
+
export interface CheckOptions<S extends Step = ClientStep> {
|
|
87
59
|
readonly poll: Poll;
|
|
88
60
|
/** For each step, the policy that its check controls, or null for a check that only reports. A step that is absent has no check. */
|
|
89
61
|
readonly steps: Partial<Record<S, Gate | null>>;
|
|
@@ -99,7 +71,7 @@ interface CheckOptions<S extends Step = ClientStep> {
|
|
|
99
71
|
* These are the knobs that each client has, by the names of the ordering law. Each driver adds its
|
|
100
72
|
* own knobs. The comments of each driver tell which option of the driver a knob sets.
|
|
101
73
|
*/
|
|
102
|
-
interface ClientKnobs {
|
|
74
|
+
export interface ClientKnobs {
|
|
103
75
|
/** This time bounds a new connection. */
|
|
104
76
|
readonly connect_bound: Quantity;
|
|
105
77
|
/** This time bounds each call on the connection of the application. */
|
|
@@ -117,7 +89,7 @@ interface ClientKnobs {
|
|
|
117
89
|
readonly retrans_giveup_time: Extent;
|
|
118
90
|
}
|
|
119
91
|
/** A client spec is the declaration of one client: where it connects, and its knobs. Each driver adds its own fields. */
|
|
120
|
-
interface ClientSpec<K extends ClientKnobs = ClientKnobs> {
|
|
92
|
+
export interface ClientSpec<K extends ClientKnobs = ClientKnobs> {
|
|
121
93
|
readonly host: string;
|
|
122
94
|
readonly port: number;
|
|
123
95
|
readonly password?: string | undefined;
|
|
@@ -128,9 +100,9 @@ interface ClientSpec<K extends ClientKnobs = ClientKnobs> {
|
|
|
128
100
|
readonly operations?: Readonly<Record<string, Operation>> | undefined;
|
|
129
101
|
}
|
|
130
102
|
/** A factory makes the connection or the pool of a client from the options of its driver. */
|
|
131
|
-
type Factory<O, C> = (options: O) => C | Promise<C>;
|
|
103
|
+
export type Factory<O, C> = (options: O) => C | Promise<C>;
|
|
132
104
|
/** These options make a client. Without them, a client uses its driver, the real clock, and the dial of its protocol. */
|
|
133
|
-
interface ClientOptions<F> {
|
|
105
|
+
export interface ClientOptions<F> {
|
|
134
106
|
readonly create?: F | undefined;
|
|
135
107
|
readonly clock?: Clock | undefined;
|
|
136
108
|
/** This function receives each transition of the client, for the prober (D3). */
|
|
@@ -138,7 +110,7 @@ interface ClientOptions<F> {
|
|
|
138
110
|
readonly dial?: DialFn | undefined;
|
|
139
111
|
}
|
|
140
112
|
/** A client socket is the part of the socket of a connection that the join of the prober and the bounded close read. */
|
|
141
|
-
interface ClientSocket {
|
|
113
|
+
export interface ClientSocket {
|
|
142
114
|
readonly localAddress?: string | undefined;
|
|
143
115
|
readonly localPort?: number | undefined;
|
|
144
116
|
readonly remoteAddress?: string | undefined;
|
|
@@ -150,7 +122,7 @@ interface ClientSocket {
|
|
|
150
122
|
* A client join is one connection, at the time when it can serve (D1, D2). The prober joins its
|
|
151
123
|
* kernel records to the server's view of the connection through it. Each driver adds the server's id of the connection.
|
|
152
124
|
*/
|
|
153
|
-
interface ClientJoin {
|
|
125
|
+
export interface ClientJoin {
|
|
154
126
|
readonly generation: number;
|
|
155
127
|
/** This time is when the connection became ready, in milliseconds on the monotonic clock. */
|
|
156
128
|
readonly at: number;
|
|
@@ -160,7 +132,7 @@ interface ClientJoin {
|
|
|
160
132
|
readonly remotePort: number | null;
|
|
161
133
|
}
|
|
162
134
|
/** A client is a dependency of a service: its declaration, its handle and its checks. Each driver adds the method that sends a call. */
|
|
163
|
-
interface Client<S extends Step = ClientStep, J extends ClientJoin = ClientJoin> {
|
|
135
|
+
export interface Client<S extends Step = ClientStep, J extends ClientJoin = ClientJoin> {
|
|
164
136
|
readonly name: string;
|
|
165
137
|
/** This declaration goes to `svc.dependency(name, declaration, handle)`. */
|
|
166
138
|
readonly declaration: Omit<Dependency, "name">;
|
|
@@ -182,16 +154,16 @@ interface Client<S extends Step = ClientStep, J extends ClientJoin = ClientJoin>
|
|
|
182
154
|
* A ready wait holds the calls that wait for a ready connection before their second try. A client
|
|
183
155
|
* that connects again by itself uses it: Redis and RabbitMQ.
|
|
184
156
|
*/
|
|
185
|
-
interface ReadyWait {
|
|
157
|
+
export interface ReadyWait {
|
|
186
158
|
/** This method waits until the client is ready, for `within` milliseconds at most. It gives true when the client is ready. */
|
|
187
159
|
wait(within: number, signal?: AbortSignal): Promise<boolean>;
|
|
188
160
|
/** This method ends each wait with true. The client uses it when its connection is ready. */
|
|
189
161
|
wake(): void;
|
|
190
162
|
}
|
|
191
163
|
/** This function makes the ready wait of a client. The function `ready` tells if the client is ready. */
|
|
192
|
-
declare const readyWait: (clock: Clock, ready: () => boolean) => ReadyWait;
|
|
164
|
+
export declare const readyWait: (clock: Clock, ready: () => boolean) => ReadyWait;
|
|
193
165
|
/** These are the knobs of a client that connects again by itself, after a delay that doubles. */
|
|
194
|
-
interface RetryKnobs {
|
|
166
|
+
export interface RetryKnobs {
|
|
195
167
|
/** This time is the first delay before a new try to connect. The delay doubles after each try. */
|
|
196
168
|
readonly retry_base: Quantity;
|
|
197
169
|
/** This time is the most that one delay can be, before its jitter. */
|
|
@@ -201,12 +173,12 @@ interface RetryKnobs {
|
|
|
201
173
|
* This function gives the backoff of the tries to connect: from `retry_base`, doubling to
|
|
202
174
|
* `retry_cap`, each with a jitter up to the base. The client rounds each delay to a whole millisecond.
|
|
203
175
|
*/
|
|
204
|
-
declare const retryBackoff: (knobs: RetryKnobs) => Backoff;
|
|
176
|
+
export declare const retryBackoff: (knobs: RetryKnobs) => Backoff;
|
|
205
177
|
/**
|
|
206
178
|
* A retry schedule holds the next try to connect, for a client that connects again by itself. It
|
|
207
179
|
* counts the tries since the last join. Each delay comes from the backoff, rounded to a whole millisecond.
|
|
208
180
|
*/
|
|
209
|
-
interface RetrySchedule {
|
|
181
|
+
export interface RetrySchedule {
|
|
210
182
|
/** This count is the number of tries since the last reset. */
|
|
211
183
|
readonly tries: number;
|
|
212
184
|
/** This method counts one more try, and starts `due` after the delay of that try. It stops a try that waits. */
|
|
@@ -217,13 +189,12 @@ interface RetrySchedule {
|
|
|
217
189
|
reset(): void;
|
|
218
190
|
}
|
|
219
191
|
/** This function makes the retry schedule of a client, from its backoff and its random numbers. RabbitMQ and WebSocket use it. */
|
|
220
|
-
declare const retrySchedule: (clock: Clock, backoff: Backoff, random: () => number) => RetrySchedule;
|
|
192
|
+
export declare const retrySchedule: (clock: Clock, backoff: Backoff, random: () => number) => RetrySchedule;
|
|
221
193
|
/** This function gives the problems of the retry knobs: the cap must not be below the base. */
|
|
222
|
-
declare const retryProblems: (name: string, knobs: RetryKnobs) => string[];
|
|
194
|
+
export declare const retryProblems: (name: string, knobs: RetryKnobs) => string[];
|
|
223
195
|
/**
|
|
224
196
|
* This poll is a poll of the checks to start from: each 5 s with a jitter of 20 %, and a timeout of
|
|
225
197
|
* 4 s (B6, O12). Its slowest poll is 4 s + 5 s × 1.2 = 10 s, the slowest poll of the cells of O13.
|
|
226
198
|
* It does not depend on a driver. The starting knobs of each driver fit it.
|
|
227
199
|
*/
|
|
228
|
-
declare const STARTING_POLL: Poll;
|
|
229
|
-
export { MANIFESTATIONS as C, firstDetector as D, Situation as E, unwatched as O, Detector as S, Meeting as T, Sent as _, ClientKnobs as a, retryProblems as b, ClientSpec as c, Factory as d, ReadyWait as f, SendOptions as g, STARTING_POLL as h, ClientJoin as i, ClientStep as l, RetrySchedule as m, CheckOptions as n, ClientOptions as o, RetryKnobs as p, Client as r, ClientSocket as s, Attempt as t, DialFn as u, readyWait as v, Manifestation as w, retrySchedule as x, retryBackoff as y };
|
|
200
|
+
export declare const STARTING_POLL: Poll;
|
|
@@ -1,81 +1,6 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
1
|
+
import { retrierOn } from "../retrier.js";
|
|
2
|
+
import { mayReissue } from "../operation.js";
|
|
3
3
|
import { quantity, valueIn } from "@mark1russell7/quantity";
|
|
4
|
-
import { connect } from "node:net";
|
|
5
|
-
// src/client/meets.ts
|
|
6
|
-
/** These are the manifestations that each client gives a meeting for, in this sequence. */
|
|
7
|
-
const MANIFESTATIONS = [
|
|
8
|
-
"rst",
|
|
9
|
-
"fin",
|
|
10
|
-
"blackhole",
|
|
11
|
-
"freeze-host",
|
|
12
|
-
"freeze-process",
|
|
13
|
-
"app-stall"
|
|
14
|
-
];
|
|
15
|
-
/**
|
|
16
|
-
* These words tell each manifestation that does not depend on the driver. The words of `app-stall`
|
|
17
|
-
* name an example, and the example is a fact of each server, thus each client gives them.
|
|
18
|
-
*/
|
|
19
|
-
const WHAT = {
|
|
20
|
-
rst: "the server answers each segment with a reset, and refuses each new connection",
|
|
21
|
-
fin: "the process of the server ends, and its kernel closes the connection",
|
|
22
|
-
blackhole: "the network drops each segment in the two directions",
|
|
23
|
-
"freeze-host": "the host of the server stops, without a close: the death without a close",
|
|
24
|
-
"freeze-process": "the process of the server stops, and its kernel stays up"
|
|
25
|
-
};
|
|
26
|
-
/** This amount is a detector that does not find the failure. */
|
|
27
|
-
const NEVER = {
|
|
28
|
-
value: "infinite",
|
|
29
|
-
unit: "s"
|
|
30
|
-
};
|
|
31
|
-
const s = (value) => quantity(Math.round(value * 1e6) / 1e6, "s");
|
|
32
|
-
const seconds = (amount) => amount.value === "infinite" ? Number.POSITIVE_INFINITY : valueIn(amount, "s");
|
|
33
|
-
/** This function gives the time at which Node's TCP keepalive gives up a silent peer: the idle time, then 10 probes 1 s apart. */
|
|
34
|
-
const keepaliveGiveUp = (idle) => idle.value === "infinite" ? NEVER : s(seconds(idle) + 10);
|
|
35
|
-
/** This detector is a segment that arrives at once: a reset or a FIN. */
|
|
36
|
-
const immediate = (situation, effect) => ({
|
|
37
|
-
by: "the next segment",
|
|
38
|
-
within: s(0),
|
|
39
|
-
situation,
|
|
40
|
-
effect
|
|
41
|
-
});
|
|
42
|
-
/** This detector is TCP keepalive on a silent peer. It gives up after its probes, and the socket closes. */
|
|
43
|
-
const keepaliveSilent = (idle) => ({
|
|
44
|
-
by: "keepalive_idle",
|
|
45
|
-
within: keepaliveGiveUp(idle),
|
|
46
|
-
situation: "idle",
|
|
47
|
-
effect: "TCP keepalive gives up, and the socket closes"
|
|
48
|
-
});
|
|
49
|
-
/** This detector is TCP keepalive on a peer whose kernel stays up. That kernel answers each probe, thus keepalive does not find the failure. */
|
|
50
|
-
const keepaliveAnswered = () => ({
|
|
51
|
-
by: "keepalive_idle",
|
|
52
|
-
within: NEVER,
|
|
53
|
-
situation: "idle",
|
|
54
|
-
effect: "the kernel of the server answers each probe"
|
|
55
|
-
});
|
|
56
|
-
/** This detector is TCP keepalive on a peer that resets: the first probe gets the reset. */
|
|
57
|
-
const keepaliveReset = (idle) => ({
|
|
58
|
-
by: "keepalive_idle",
|
|
59
|
-
within: idle.value === "infinite" ? NEVER : idle,
|
|
60
|
-
situation: "idle",
|
|
61
|
-
effect: "the first probe gets a reset"
|
|
62
|
-
});
|
|
63
|
-
/** This detector is the kernel, which gives up the retransmissions of a segment in flight. A driver can add what follows. */
|
|
64
|
-
const kernelGiveUp = (within, after) => ({
|
|
65
|
-
by: "retrans_giveup_time",
|
|
66
|
-
within,
|
|
67
|
-
situation: "in flight",
|
|
68
|
-
effect: `the kernel gives up the retransmissions and closes the socket${after === void 0 ? "" : `, and ${after}`}`
|
|
69
|
-
});
|
|
70
|
-
/** This function gives the first detector of a manifestation in a situation, or null when no detector has an end (C3). */
|
|
71
|
-
const firstDetector = (meeting, situation) => {
|
|
72
|
-
return meeting.detectors.filter((detector) => detector.situation === situation && detector.within.value !== "infinite").sort((a, b) => seconds(a.within) - seconds(b.within))[0] ?? null;
|
|
73
|
-
};
|
|
74
|
-
/** This function gives each manifestation and situation that no detector of the client finds: the standing rule, as a query (C3, E9). */
|
|
75
|
-
const unwatched = (meets) => meets.flatMap((meeting) => ["in flight", "idle"].flatMap((situation) => firstDetector(meeting, situation) === null ? [{
|
|
76
|
-
manifestation: meeting.manifestation,
|
|
77
|
-
situation
|
|
78
|
-
}] : []));
|
|
79
4
|
// src/client/core.ts
|
|
80
5
|
/** This interval is the poll of a catalog check that gates nothing (B19). */
|
|
81
6
|
const CATALOG_INTERVAL = quantity(30, "s");
|
|
@@ -473,80 +398,6 @@ const STARTING_POLL = {
|
|
|
473
398
|
unit: "s"
|
|
474
399
|
}
|
|
475
400
|
};
|
|
476
|
-
|
|
477
|
-
/**
|
|
478
|
-
* This function makes a dial function. The dial opens a TCP connection, sends `hello`, and reads the
|
|
479
|
-
* answer until `judge` decides. An abort, an error of the socket, and a close before the decision fail the dial.
|
|
480
|
-
* The dial destroys its socket at its end.
|
|
481
|
-
*/
|
|
482
|
-
const helloDial = (hello, judge) => (host, port, signal) => new Promise((resolve, reject) => {
|
|
483
|
-
if (signal.aborted) {
|
|
484
|
-
reject(/* @__PURE__ */ new Error("the dial was aborted"));
|
|
485
|
-
return;
|
|
486
|
-
}
|
|
487
|
-
const socket = connect({
|
|
488
|
-
host,
|
|
489
|
-
port
|
|
490
|
-
});
|
|
491
|
-
let received = Buffer.alloc(0);
|
|
492
|
-
const end = (error) => {
|
|
493
|
-
signal.removeEventListener("abort", onAbort);
|
|
494
|
-
socket.destroy();
|
|
495
|
-
if (error === void 0) resolve();
|
|
496
|
-
else reject(error);
|
|
497
|
-
};
|
|
498
|
-
const onAbort = () => end(/* @__PURE__ */ new Error("the dial was aborted"));
|
|
499
|
-
signal.addEventListener("abort", onAbort, { once: true });
|
|
500
|
-
socket.once("connect", () => socket.write(hello));
|
|
501
|
-
socket.on("data", (chunk) => {
|
|
502
|
-
received = Buffer.concat([received, chunk]);
|
|
503
|
-
const verdict = judge(received);
|
|
504
|
-
if (verdict === "more") return;
|
|
505
|
-
end(verdict ?? void 0);
|
|
506
|
-
});
|
|
507
|
-
socket.once("error", (error) => end(error));
|
|
508
|
-
socket.once("close", () => end(/* @__PURE__ */ new Error("the server closed the dial")));
|
|
509
|
-
});
|
|
510
|
-
/** This function gives the authority of a host and a port for a Host header. An IPv6 address goes in brackets. */
|
|
511
|
-
const authority = (host, port) => `${host.includes(":") ? `[${host}]` : host}:${port}`;
|
|
512
|
-
/**
|
|
513
|
-
* This function makes a judge of the status line of an HTTP/1.1 answer. The judge waits for the end
|
|
514
|
-
* of the line, in the first 8 KiB. Then `accept` reads the status code, and gives null for a good status or an error.
|
|
515
|
-
* The HTTP client accepts each status. The WebSocket client accepts only 101.
|
|
516
|
-
*/
|
|
517
|
-
const statusLineJudge = (accept) => (received) => {
|
|
518
|
-
const end = received.indexOf("\r\n");
|
|
519
|
-
if (end < 0) return received.length > 8192 ? /* @__PURE__ */ new Error("the answer has no status line in its first 8 KiB") : "more";
|
|
520
|
-
const line = received.toString("latin1", 0, end);
|
|
521
|
-
const status = /^HTTP\/1\.[01] (\d{3})/.exec(line);
|
|
522
|
-
return status === null ? /* @__PURE__ */ new Error(`the answer ${JSON.stringify(line)} is not an HTTP/1.1 status line`) : accept(Number(status[1]), line);
|
|
523
|
-
};
|
|
524
|
-
// src/client/machine.ts
|
|
525
|
-
/** This function gives one transition of a machine document. */
|
|
526
|
-
const transition = (id, from, on, to, extra = {}) => ({
|
|
527
|
-
id,
|
|
528
|
-
from,
|
|
529
|
-
on,
|
|
530
|
-
to,
|
|
531
|
-
...extra
|
|
532
|
-
});
|
|
533
|
-
/** This function gives a knob of a client in a machine document, by the option of the driver that it sets. */
|
|
534
|
-
const clientKnob = (key) => ({
|
|
535
|
-
key,
|
|
536
|
-
scope: "client",
|
|
537
|
-
unit: "s",
|
|
538
|
-
default: null
|
|
539
|
-
});
|
|
540
|
-
/** This timer is the bound of the close. The close request arms it, and the end cancels it. At its end, the driver destroys each socket. */
|
|
541
|
-
const closeTimer = () => ({
|
|
542
|
-
duration: {
|
|
543
|
-
knob: "close_bound",
|
|
544
|
-
unit: "s"
|
|
545
|
-
},
|
|
546
|
-
arms: ["close.request"],
|
|
547
|
-
cancels: ["status.end"],
|
|
548
|
-
fires: "close.bound"
|
|
549
|
-
});
|
|
550
|
-
export { retrySchedule as A, zeroProblems as B, notSent as C, readyWait as D, poolProblems as E, timeProblems as F, immediate as G, NEVER as H, trackWithTimer as I, keepaliveSilent as J, keepaliveAnswered as K, wholeProblems as L, sendWithReissue as M, socketEnds as N, retryBackoff as O, stepChecks as P, withinBound as R, ms as S, orZero as T, WHAT as U, MANIFESTATIONS as V, firstDetector as W, unwatched as X, kernelGiveUp as Y, inFlight as _, helloDial as a, message as b, ageProblems as c, clientProblems as d, clientRecorder as f, idleCloseProblem as g, finiteMs as h, authority as i, roundTripCheck as j, retryProblems as k, attachClient as l, dialCheck as m, closeTimer as n, statusLineJudge as o, deadlineProblem as p, keepaliveReset as q, transition as r, STARTING_POLL as s, clientKnob as t, clientBounds as u, keepaliveOnProblems as v, operationTable as w, missesProblems as x, localStateCheck as y, wrapperTimerProblems as z };
|
|
401
|
+
export { CATALOG_INTERVAL, STARTING_POLL, ageProblems, attachClient, clientBounds, clientProblems, clientRecorder, deadlineProblem, dialCheck, finiteMs, idleCloseProblem, inFlight, keepaliveOnProblems, localStateCheck, message, missesProblems, ms, notSent, operationTable, orZero, passes, poolProblems, readyWait, retryBackoff, retryProblems, retrySchedule, roundTripCheck, sendWithReissue, socketEnds, stepChecks, timeProblems, trackWithTimer, wholeMs, wholeProblems, wholeSeconds, withinBound, wrapperTimerProblems, zeroProblems };
|
|
551
402
|
|
|
552
|
-
//# sourceMappingURL=
|
|
403
|
+
//# sourceMappingURL=core.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"core.js","names":[],"sources":["../../src/client/core.ts"],"sourcesContent":["// The parts of a client wrapper that do not change from one client to the next. Each client entry\n// (`./redis`, `./pg`, `./http-client`, `./websocket`, and each later client of S1) fills them in with its driver. The core gives\n// the shapes of a client, the outcome of a call in three values, the rule that sends a call again,\n// the record of the calls in flight, the bounded close, the checks of the steps of a connection,\n// and the problems of a spec and of a client in a description. It loads only quantity.\n// The section \"Unified or separate\" of docs/S6.md gives each part, and the reason for each part that stays in a driver.\n\nimport type { Extent, Quantity } from \"@mark1russell7/quantity\";\nimport { quantity, valueIn } from \"@mark1russell7/quantity\";\nimport type { Backoff } from \"../backoff.ts\";\nimport { retrierOn } from \"../retrier.ts\";\nimport type { ServiceBuilder } from \"../builder.ts\";\nimport type { Cancel, Clock } from \"../clock.ts\";\nimport type { Check, Dependency, Gate, ServiceDescription, Step } from \"../description.ts\";\nimport type { Recorder } from \"../events.ts\";\nimport type { Outcome } from \"../latch.ts\";\nimport type { DependencyHandle } from \"../lifecycle.ts\";\nimport type { Operation } from \"../operation.ts\";\nimport { mayReissue } from \"../operation.ts\";\nimport type { CheckFn } from \"../poller.ts\";\nimport type { Poll } from \"../timing.ts\";\nimport type { Meeting } from \"./meets.ts\";\n\n/**\n * A sent result is the outcome of a call, in three values (C8):\n * - `ok`: the server answered.\n * - `error`: the call did not apply. The server answered with an error (`reply`), or the call did\n * not leave the client.\n * - `indeterminate`: the call can have reached the server, and nothing tells if it applied.\n */\nexport type Sent<T> =\n | { readonly outcome: \"ok\"; readonly value: T; readonly attempts: number }\n | { readonly outcome: \"error\"; readonly error: string; readonly reply: boolean; readonly attempts: number }\n | { readonly outcome: \"indeterminate\"; readonly error: string; readonly attempts: number };\n\n/** This type is the outcome of one try of a call, before the core counts the tries. */\nexport type Attempt<T = unknown> =\n | { readonly outcome: \"ok\"; readonly value: T }\n | { readonly outcome: \"error\"; readonly error: string; readonly reply: boolean }\n | { readonly outcome: \"indeterminate\"; readonly error: string };\n\n/** Send options tell how the client sends one call. */\nexport interface SendOptions {\n /** This signal abandons the call. A call that left the client is then indeterminate. */\n readonly signal?: AbortSignal | undefined;\n /** False stops the client: it does not send the call again. A check that must fail at once uses it. */\n readonly reissue?: boolean | undefined;\n}\n\n/** A dial function opens a new connection to the server, and reads one reply of the protocol. The `dial` check uses it. */\nexport type DialFn = (host: string, port: number, signal: AbortSignal) => Promise<void>;\n\n/** The steps of a connection that each client gives a check for (B14). A client can add more steps. */\nexport type ClientStep = Extract<Step, \"dial\" | \"round-trip\" | \"local-state\">;\n\n/** Check options tell which checks the client gives the health runtime, and which policy each one controls. */\nexport interface CheckOptions<S extends Step = ClientStep> {\n readonly poll: Poll;\n /** For each step, the policy that its check controls, or null for a check that only reports. A step that is absent has no check. */\n readonly steps: Partial<Record<S, Gate | null>>;\n /**\n * With a catalog, the client gives a check for each step that it has (B19). The steps of `steps` are\n * the nominated checks. Each other step reports only, and polls at the catalog poll. `true` is a poll\n * of 30 s with the jitter and the timeout of `poll`. A nominated step that the client has no check\n * for then fails the attach. Without a catalog, the client gives only the steps of `steps`.\n */\n readonly catalog?: true | Poll | undefined;\n}\n\n/** This interval is the poll of a catalog check that gates nothing (B19). */\nexport const CATALOG_INTERVAL: Quantity = quantity(30, \"s\");\n\n/** A step check is the function of one step, and if it uses the connection of the application. */\nexport interface StepCheck {\n readonly ownConnection: boolean;\n readonly run: CheckFn;\n}\n\n/** This function gives an amount in milliseconds. \"infinite\" is `Infinity`. */\nexport const ms = (amount: Extent): number =>\n amount.value === \"infinite\" ? Number.POSITIVE_INFINITY : valueIn(amount as Quantity, \"ms\");\n\n/** This function gives an amount in milliseconds, or undefined for \"infinite\". Each driver then writes its own form of \"no timer\". */\nexport const finiteMs = (amount: Extent): number | undefined => {\n const value = ms(amount);\n return Number.isFinite(value) ? value : undefined;\n};\n\n/** This function gives the text of an error. */\nexport const message = (error: unknown): string => (error instanceof Error ? error.message : String(error));\n\n/**\n * These are the knobs that each client has, by the names of the ordering law. Each driver adds its\n * own knobs. The comments of each driver tell which option of the driver a knob sets.\n */\nexport interface ClientKnobs {\n /** This time bounds a new connection. */\n readonly connect_bound: Quantity;\n /** This time bounds each call on the connection of the application. */\n readonly request_timeout: Quantity;\n /** This time is the idle time of TCP keepalive. Node then sends 10 probes 1 s apart. */\n readonly keepalive_idle: Extent;\n /** This time is the age at which the client replaces a connection. */\n readonly max_connection_age: Extent;\n /** This time bounds the close of the client at the shutdown. */\n readonly close_bound: Quantity;\n /**\n * This time is when the kernel gives up a segment that it retransmits. Node cannot set it, thus\n * the declaration states it for the ordering law (O17), from the platform.\n */\n readonly retrans_giveup_time: Extent;\n}\n\n/** A client spec is the declaration of one client: where it connects, and its knobs. Each driver adds its own fields. */\nexport interface ClientSpec<K extends ClientKnobs = ClientKnobs> {\n readonly host: string;\n readonly port: number;\n readonly password?: string | undefined;\n /** This identifier is the component in the corpus, for example `systems.component.redis`, or null. */\n readonly system: string | null;\n readonly knobs: K;\n /** These operations add to the table of the client, or change it. */\n readonly operations?: Readonly<Record<string, Operation>> | undefined;\n}\n\n/** A factory makes the connection or the pool of a client from the options of its driver. */\nexport type Factory<O, C> = (options: O) => C | Promise<C>;\n\n/** These options make a client. Without them, a client uses its driver, the real clock, and the dial of its protocol. */\nexport interface ClientOptions<F> {\n readonly create?: F | undefined;\n readonly clock?: Clock | undefined;\n /** This function receives each transition of the client, for the prober (D3). */\n readonly record?: Recorder | undefined;\n readonly dial?: DialFn | undefined;\n}\n\n/** A client socket is the part of the socket of a connection that the join of the prober and the bounded close read. */\nexport interface ClientSocket {\n readonly localAddress?: string | undefined;\n readonly localPort?: number | undefined;\n readonly remoteAddress?: string | undefined;\n readonly remotePort?: number | undefined;\n /** This method closes the socket at once. A close of the driver only half-closes it, and a silent peer does not answer that. */\n destroy?(): void;\n}\n\n/**\n * A client join is one connection, at the time when it can serve (D1, D2). The prober joins its\n * kernel records to the server's view of the connection through it. Each driver adds the server's id of the connection.\n */\nexport interface ClientJoin {\n readonly generation: number;\n /** This time is when the connection became ready, in milliseconds on the monotonic clock. */\n readonly at: number;\n readonly localAddress: string | null;\n readonly localPort: number | null;\n readonly remoteAddress: string | null;\n readonly remotePort: number | null;\n}\n\n/** This function gives the addresses and the ports of a socket for a join. Each one is null when the socket does not give it. */\nexport const socketEnds = (\n socket: ClientSocket | undefined,\n): Pick<ClientJoin, \"localAddress\" | \"localPort\" | \"remoteAddress\" | \"remotePort\"> => ({\n localAddress: socket?.localAddress ?? null,\n localPort: socket?.localPort ?? null,\n remoteAddress: socket?.remoteAddress ?? null,\n remotePort: socket?.remotePort ?? null,\n});\n\n/** A client is a dependency of a service: its declaration, its handle and its checks. Each driver adds the method that sends a call. */\nexport interface Client<S extends Step = ClientStep, J extends ClientJoin = ClientJoin> {\n readonly name: string;\n /** This declaration goes to `svc.dependency(name, declaration, handle)`. */\n readonly declaration: Omit<Dependency, \"name\">;\n readonly handle: DependencyHandle;\n /** These are the manifestations that the client can meet, and the detectors of each (E9). */\n readonly meets: readonly Meeting[];\n /** This text is the state of the client, as the machine document of the client names it. */\n readonly status: string;\n /** These are the connections of the client, the latest last. */\n readonly joins: readonly J[];\n /** This method gives the checks of the client and their functions, for `svc.check(check, run)`. */\n checks(options: CheckOptions<S>): ReadonlyArray<readonly [Check, CheckFn]>;\n /** This method declares the client in a service: its dependency, its handle and its checks. */\n attach(svc: ServiceBuilder, options: CheckOptions<S>): ServiceBuilder;\n /** This method gives the problems of the client in a description: a close that does not fit in its phase, for example. */\n problems(description: ServiceDescription): string[];\n}\n\n/** This function declares a client in a service: its dependency, its handle, and each of its checks. */\nexport const attachClient = (\n svc: ServiceBuilder,\n name: string,\n declaration: Omit<Dependency, \"name\">,\n handle: DependencyHandle,\n checks: ReadonlyArray<readonly [Check, CheckFn]>,\n): ServiceBuilder => {\n svc.dependency(name, declaration, handle);\n for (const [check, run] of checks) svc.check(check, run);\n return svc;\n};\n\n/** This function gives the table of operations of a client: the defaults of its driver, then the operations of its spec. */\nexport const operationTable = (\n defaults: Readonly<Record<string, Operation>>,\n more: Readonly<Record<string, Operation>> | undefined,\n): Readonly<Record<string, Operation>> => ({ ...defaults, ...more });\n\n/** A client recorder gives one transition of a client to the recorder of the options, for the prober (D3). */\nexport type ClientRecorder = (from: string, to: string, on: string, detail?: string) => void;\n\n/** This function makes the recorder of a client. Each event has the machine \"client\", and the name of the client as its instance. */\nexport const clientRecorder =\n (record: Recorder | undefined, clock: Clock, name: string): ClientRecorder =>\n (from, to, on, detail) =>\n record?.({ at: clock.now(), machine: \"client\", instance: name, from, to, on, ...(detail === undefined ? {} : { detail }) });\n\n/** This function gives the outcome of a call that did not leave the client. It is certain: the call did not apply. */\nexport const notSent = (error: string): Attempt<never> => ({ outcome: \"error\", error, reply: false });\n\n/** A settle function gives the outcome of a call in flight. A driver can give a cause, for example the error that ends a client of a pool. */\nexport type Settle<T = unknown> = (value: Attempt<T>, cause?: Error) => void;\n\n/**\n * This record holds the calls in flight of a client. Each call settles one time. A call that the\n * caller abandons after it left the client is indeterminate, because a sent call cannot be\n * cancelled (principle 9). The close and a closed connection settle each call that stays (C10).\n */\nexport interface InFlight {\n /** This number is the count of the calls in flight. */\n readonly size: number;\n /**\n * This method sends one call, and records it until it settles. `start` sends the call, and gives\n * its outcome to `settle`. `after` operates one time, after the call settles and before its promise resolves.\n */\n track<T>(\n signal: AbortSignal | undefined,\n abandoned: string,\n start: (settle: Settle<T>) => void,\n after?: (value: Attempt<T>, cause: Error | undefined) => void,\n ): Promise<Attempt<T>>;\n /** This method settles each call in flight as indeterminate, with this error. */\n settleAll(error: string): void;\n /** This method resolves when no call is in flight. A close that waits for its calls uses it in its bound. */\n idle(): Promise<void>;\n}\n\n/** This function makes the record of the calls in flight of a client. */\nexport const inFlight = (): InFlight => {\n const closes = new Set<(error: string) => void>();\n const waiters = new Set<() => void>();\n const wake = (): void => {\n if (closes.size > 0) return;\n for (const waiter of [...waiters]) waiter();\n waiters.clear();\n };\n return {\n get size() {\n return closes.size;\n },\n idle: () =>\n new Promise<void>((resolve) => {\n if (closes.size === 0) resolve();\n else waiters.add(resolve);\n }),\n track<T>(\n signal: AbortSignal | undefined,\n abandoned: string,\n start: (settle: Settle<T>) => void,\n after?: (value: Attempt<T>, cause: Error | undefined) => void,\n ): Promise<Attempt<T>> {\n return new Promise<Attempt<T>>((resolve) => {\n let settled = false;\n const settle: Settle<T> = (value, cause) => {\n if (settled) return;\n settled = true;\n closes.delete(close);\n signal?.removeEventListener(\"abort\", aborted);\n after?.(value, cause);\n resolve(value);\n wake();\n };\n const close = (error: string): void => settle({ outcome: \"indeterminate\", error }, new Error(error));\n const aborted = (): void => close(abandoned);\n closes.add(close);\n signal?.addEventListener(\"abort\", aborted, { once: true });\n start(settle);\n });\n },\n settleAll(error) {\n for (const close of [...closes]) close(error);\n },\n };\n};\n\n/**\n * This function sends one call through the record of the calls in flight, with a timer of the\n * wrapper. A driver with no timer for its call uses it: amqplib, and the agent of Node. At `bound`\n * milliseconds the call is indeterminate with the error `timedOut`, because it left the client.\n * The timer stops when the call settles, before `after` operates.\n */\nexport const trackWithTimer = <T>(\n flight: InFlight,\n clock: Clock,\n bound: number,\n signal: AbortSignal | undefined,\n abandoned: string,\n timedOut: string,\n start: (settle: Settle<T>) => void,\n after?: (value: Attempt<T>, cause: Error | undefined) => void,\n): Promise<Attempt<T>> => {\n let stop: Cancel = () => {};\n return flight.track<T>(\n signal,\n abandoned,\n (settle) => {\n // the caller awaits the attempt, thus its bound keeps the process alive (SYS-126)\n stop = clock.after(bound, () => settle({ outcome: \"indeterminate\", error: timedOut }));\n start(settle);\n },\n (value, cause) => {\n stop();\n after?.(value, cause);\n },\n );\n};\n\n/**\n * This function waits for the work of a close, for `bound` milliseconds at most. It gives true when\n * the work ended in its bound, with a success or a failure. It gives false at the bound. The driver\n * then destroys each socket that stays, because a silent server does not close its half.\n */\nexport const withinBound = (clock: Clock, bound: number, work: Promise<unknown>): Promise<boolean> => {\n const done = work.then(\n () => true,\n () => true,\n );\n let cancel: Cancel = () => {};\n const timer = new Promise<boolean>((resolve) => {\n // the caller awaits this bound, thus it keeps the process alive (SYS-126)\n cancel = clock.after(bound, () => resolve(false));\n });\n return Promise.race([done, timer]).then((ended) => {\n cancel();\n return ended;\n });\n};\n\n/**\n * A ready wait holds the calls that wait for a ready connection before their second try. A client\n * that connects again by itself uses it: Redis and RabbitMQ.\n */\nexport interface ReadyWait {\n /** This method waits until the client is ready, for `within` milliseconds at most. It gives true when the client is ready. */\n wait(within: number, signal?: AbortSignal): Promise<boolean>;\n /** This method ends each wait with true. The client uses it when its connection is ready. */\n wake(): void;\n}\n\n/** This function makes the ready wait of a client. The function `ready` tells if the client is ready. */\nexport const readyWait = (clock: Clock, ready: () => boolean): ReadyWait => {\n const waiters = new Set<() => void>();\n return {\n wait: (within, signal) =>\n new Promise((resolve) => {\n if (ready()) {\n resolve(true);\n return;\n }\n let cancel: Cancel = () => {};\n const done = (value: boolean): void => {\n waiters.delete(wake);\n cancel();\n signal?.removeEventListener(\"abort\", aborted);\n resolve(value);\n };\n const wake = (): void => done(true);\n const aborted = (): void => done(false);\n waiters.add(wake);\n // the caller awaits the readiness, thus this bound keeps the process alive (SYS-126)\n cancel = clock.after(within, () => done(ready()));\n signal?.addEventListener(\"abort\", aborted, { once: true });\n }),\n wake() {\n for (const wake of [...waiters]) wake();\n },\n };\n};\n\n/** These are the knobs of a client that connects again by itself, after a delay that doubles. */\nexport interface RetryKnobs {\n /** This time is the first delay before a new try to connect. The delay doubles after each try. */\n readonly retry_base: Quantity;\n /** This time is the most that one delay can be, before its jitter. */\n readonly retry_cap: Quantity;\n}\n\n/**\n * This function gives the backoff of the tries to connect: from `retry_base`, doubling to\n * `retry_cap`, each with a jitter up to the base. The client rounds each delay to a whole millisecond.\n */\nexport const retryBackoff = (knobs: RetryKnobs): Backoff => ({\n base: ms(knobs.retry_base),\n factor: 2,\n cap: ms(knobs.retry_cap),\n jitter: { kind: \"add\", amount: ms(knobs.retry_base) },\n});\n\n/**\n * A retry schedule holds the next try to connect, for a client that connects again by itself. It\n * counts the tries since the last join. Each delay comes from the backoff, rounded to a whole millisecond.\n */\nexport interface RetrySchedule {\n /** This count is the number of tries since the last reset. */\n readonly tries: number;\n /** This method counts one more try, and starts `due` after the delay of that try. It stops a try that waits. */\n schedule(due: () => void): void;\n /** This method stops the try that waits. The close uses it. */\n cancel(): void;\n /** This method sets the count of tries to zero. The client uses it at each join. */\n reset(): void;\n}\n\n/** This function makes the retry schedule of a client, from its backoff and its random numbers. RabbitMQ and WebSocket use it. */\nexport const retrySchedule = (clock: Clock, backoff: Backoff, random: () => number): RetrySchedule => {\n // the public retrier does the same work: the schedule only names its count `tries`\n const retry = retrierOn(clock, backoff, random);\n return {\n get tries() {\n return retry.attempts;\n },\n schedule(due) {\n retry.schedule(due);\n },\n cancel: () => retry.cancel(),\n reset: () => retry.reset(),\n };\n};\n\n/** This function gives the problems of the retry knobs: the cap must not be below the base. */\nexport const retryProblems = (name: string, knobs: RetryKnobs): string[] =>\n ms(knobs.retry_cap) < ms(knobs.retry_base) ? [`${name}'s retry_cap is below its retry_base`] : [];\n\n/**\n * This function gives the problem of a count of misses that is not a whole number above zero. A\n * client that closes its connection after a count of heartbeat misses uses it. `mechanism` names the heartbeat, for example \"watchdog\".\n */\nexport const missesProblems = (name: string, misses: number, mechanism: string): string[] =>\n Number.isInteger(misses) && misses >= 1 ? [] : [`${name}'s ${mechanism} closes the connection after ${misses} misses, not a whole number above zero`];\n\n/** This function gives the problems of the knobs of a spec that each client has: each knob must be a time of zero or more. */\nexport const timeProblems = (name: string, knobs: object): string[] => {\n const problems: string[] = [];\n for (const [knob, amount] of Object.entries(knobs) as Array<[string, Extent]>) {\n if (amount.value !== \"infinite\" && !(ms(amount) >= 0)) problems.push(`${name}'s ${knob} is not a time of zero or more`);\n }\n return problems;\n};\n\n/** This function writes a bound for a driver that reads 0 as no timer: \"infinite\" is 0. */\nexport const orZero = (amount: Extent): number => finiteMs(amount) ?? 0;\n\n/** This function tells if an amount is a whole number of milliseconds. \"infinite\" is whole. */\nexport const wholeMs = (amount: Extent): boolean => amount.value === \"infinite\" || Number.isInteger(ms(amount));\n\n/** This function tells if an amount is a whole number of seconds. \"infinite\" is whole. */\nexport const wholeSeconds = (amount: Extent): boolean =>\n amount.value === \"infinite\" || Number.isInteger(valueIn(amount as Quantity, \"s\"));\n\n/** These are the knobs of a spec that `zeroProblems` and `wholeProblems` examine, by their kind. */\nexport interface KnobKinds {\n /** These knobs must be a finite time above zero, because the driver reads 0 as no bound. */\n readonly bounded?: readonly string[] | undefined;\n /** These knobs can be \"infinite\", which the driver writes as 0. Thus 0 itself is not a bound. */\n readonly open?: readonly string[] | undefined;\n /** These knobs go to the driver in whole milliseconds. */\n readonly millis?: readonly string[] | undefined;\n /** These knobs go to the driver or to Node in whole seconds. */\n readonly seconds?: readonly string[] | undefined;\n}\n\nconst knobOf = (knobs: object, knob: string): Extent => (knobs as Record<string, Extent>)[knob]!;\n\n/**\n * This function gives the problems of the knobs of a driver that reads 0 as no timer. pg and the\n * MongoDB driver read 0 so. A bounded knob must be a finite time above zero. An open knob can be\n * \"infinite\", and 0 is then a mistake.\n */\nexport const zeroProblems = (name: string, driver: string, knobs: object, kinds: KnobKinds): string[] => {\n const problems: string[] = [];\n for (const knob of kinds.bounded ?? []) {\n const value = ms(knobOf(knobs, knob));\n if (!(value > 0) || !Number.isFinite(value)) problems.push(`${name}'s ${knob} is not a finite time above zero: ${driver} reads 0 as no bound`);\n }\n for (const knob of kinds.open ?? []) {\n const amount = knobOf(knobs, knob);\n if (amount.value !== \"infinite\" && !(ms(amount) > 0)) problems.push(`${name}'s ${knob} is zero: give \"infinite\" for no bound`);\n }\n return problems;\n};\n\n/** This function gives the problems of the knobs that a driver takes in whole milliseconds or in whole seconds. */\nexport const wholeProblems = (name: string, knobs: object, kinds: KnobKinds): string[] => [\n ...(kinds.millis ?? []).filter((knob) => !wholeMs(knobOf(knobs, knob))).map((knob) => `${name}'s ${knob} is not a whole number of milliseconds`),\n ...(kinds.seconds ?? []).filter((knob) => !wholeSeconds(knobOf(knobs, knob))).map((knob) => `${name}'s ${knob} is not a whole number of seconds`),\n];\n\n/** This function gives the problems of the sizes of a pool: at most `max` connections, and `min` from 0 to `max`. */\nexport const poolProblems = (name: string, pool: { readonly max: number; readonly min: number }): string[] => {\n const problems: string[] = [];\n if (!Number.isInteger(pool.max) || pool.max < 1) problems.push(`${name}'s pool has a max of ${pool.max}, not a whole number above zero`);\n if (!Number.isInteger(pool.min) || pool.min < 0 || pool.min > pool.max)\n problems.push(`${name}'s pool has a min of ${pool.min}, not a whole number from 0 to its max`);\n return problems;\n};\n\n/**\n * This function gives the problem O07 of a client whose server has a deadline, or null. The client\n * must wait longer than the deadline of the server. Then the server ends a slow call with an error\n * first. Otherwise the client gives up first, and the server goes on with the call. `call` names\n * the call of the server, for example a statement.\n */\nexport const deadlineProblem = (name: string, request: Quantity, deadline: Extent, call: string): string | null =>\n deadline.value !== \"infinite\" && ms(request) <= ms(deadline)\n ? `${name}'s request_timeout is not above its statement_timeout: the server goes on with a ${call} that the client gave up (O07)`\n : null;\n\n/**\n * This function gives the problem O01 of a client pool, or null. The pool must close an idle\n * connection before its server does. Otherwise a request can go on a connection that the server\n * closed. A server that keeps an idle connection with no bound gives no problem. `knob` names the\n * idle time of the client: `pool_idle_expiry` of a pool, or `client_idle_timeout` of a gRPC channel.\n */\nexport const idleCloseProblem = (name: string, expiry: Extent, close: Extent, knob = \"pool_idle_expiry\"): string | null =>\n close.value !== \"infinite\" && !(ms(expiry) < ms(close))\n ? `${name}'s ${knob} is not below the idle close of its server: a request can go on a connection that the server closed (O01)`\n : null;\n\n/**\n * This function gives the problems of the timers that the wrapper has, because its driver has none.\n * Each one must be a finite time above zero. `bounds` gives what each knob bounds, for example \"a call\".\n */\nexport const wrapperTimerProblems = (name: string, knobs: object, bounds: Readonly<Record<string, string>>): string[] =>\n Object.entries(bounds)\n .filter(([knob]) => {\n const value = ms(knobOf(knobs, knob));\n return !(value > 0) || !Number.isFinite(value);\n })\n .map(([knob, what]) => `${name}'s ${knob} is not a finite time above zero: the timer of the wrapper is the only bound of ${what}`);\n\n/** This function gives the problem of a finite connection age, for a client that does not replace a connection at an age. `reason` tells why. */\nexport const ageProblems = (name: string, knobs: Pick<ClientKnobs, \"max_connection_age\">, reason: string): string[] =>\n knobs.max_connection_age.value === \"infinite\" ? [] : [`${name}'s max_connection_age is not \"infinite\": ${reason}`];\n\n/** This function gives the problem of a keepalive that is not a finite time above zero, for a driver that always turns keepalive on. */\nexport const keepaliveOnProblems = (name: string, knobs: Pick<ClientKnobs, \"keepalive_idle\">, driver: string): string[] => {\n const value = ms(knobs.keepalive_idle);\n return value > 0 && Number.isFinite(value) ? [] : [`${name}'s keepalive_idle is not a finite time above zero: ${driver} always turns keepalive on`];\n};\n\n/** These are the parts of one call that the core uses to send it, and to send it again. */\nexport interface Reissue<T> {\n readonly clock: Clock;\n /** This time bounds the call and its second try, in milliseconds from its start. */\n readonly bound: number;\n /** This operation is the declaration of the call, or undefined when the table does not name it. */\n readonly operation: Operation | undefined;\n readonly options: SendOptions;\n /** This function makes one try. Its signal ends the try. */\n readonly attempt: (signal: AbortSignal | undefined) => Promise<Attempt<T>>;\n /** This function operates before the second try, with the time that is left. False stops the second try. */\n readonly beforeAgain?: ((left: number, signal: AbortSignal | undefined) => Promise<boolean>) | undefined;\n /** This function receives the start of a second try, for the record of the client. */\n readonly onReissue: () => void;\n}\n\n/**\n * This function sends a call, and gives its outcome in three values. It sends again only an\n * idempotent operation, one time at most, after an outcome that is not certain. A reply of the\n * server is certain. The second try ends at the bound of the call, not one bound after its own start.\n */\nexport const sendWithReissue = async <T>(call: Reissue<T>): Promise<Sent<T>> => {\n const { clock, bound } = call;\n const { signal } = call.options;\n const operation = call.options.reissue === false ? undefined : call.operation;\n const started = clock.now();\n const first = await call.attempt(signal);\n if (first.outcome === \"ok\") return { outcome: \"ok\", value: first.value, attempts: 1 };\n const again =\n !(first.outcome === \"error\" && first.reply) &&\n operation !== undefined &&\n signal?.aborted !== true &&\n mayReissue(operation, quantity((clock.now() - started) / 1000, \"s\"));\n const left = bound - (clock.now() - started);\n if (!again || left <= 0) return { ...first, attempts: 1 };\n if (call.beforeAgain !== undefined && !(await call.beforeAgain(left, signal))) return { ...first, attempts: 1 };\n call.onReissue();\n const end = new AbortController();\n // the caller awaits the second try, thus its bound keeps the process alive (SYS-126)\n const stop = clock.after(Math.max(0, bound - (clock.now() - started)), () => end.abort());\n const forward = (): void => end.abort();\n signal?.addEventListener(\"abort\", forward, { once: true });\n const second = await call.attempt(end.signal);\n stop();\n signal?.removeEventListener(\"abort\", forward);\n return second.outcome === \"ok\" ? { outcome: \"ok\", value: second.value, attempts: 2 } : { ...second, attempts: 2 };\n};\n\n/**\n * This function gives the checks of a client, for `svc.check(check, run)`. Without a catalog, it gives\n * a check for each step that the options name, when the client has a function for that step. With a\n * catalog, it gives a check for each step of the client. It then throws for a nominated step that the\n * client does not have (B19). The name of each check is the pair of the component and the step, a\n * public contract.\n */\nexport const stepChecks = <S extends Step>(\n name: string,\n options: CheckOptions<S>,\n runs: Readonly<Partial<Record<S, StepCheck>>>,\n): ReadonlyArray<readonly [Check, CheckFn]> => {\n const has = (Object.entries(runs) as Array<[S, StepCheck | undefined]>).filter(([, run]) => run !== undefined).map(([step]) => step);\n const catalog = options.catalog === true ? { ...options.poll, interval: CATALOG_INTERVAL } : options.catalog;\n if (catalog !== undefined) {\n const missing = Object.keys(options.steps).filter((step) => !has.includes(step as S));\n if (missing.length > 0) {\n throw new Error(`${name}: the nominated checks ${missing.join(\", \")} are not in the catalog of the client (${has.join(\", \")})`);\n }\n }\n const made: Array<readonly [Check, CheckFn]> = [];\n for (const step of has) {\n const run = runs[step] as StepCheck;\n const nominated = step in options.steps;\n if (!nominated && catalog === undefined) continue;\n made.push([\n {\n name: `${name}.${step}`,\n dependency: name,\n step,\n ownConnection: run.ownConnection,\n gates: nominated ? (options.steps[step] ?? null) : null,\n poll: nominated || catalog === undefined ? options.poll : catalog,\n },\n run.run,\n ]);\n }\n return made;\n};\n\n/** This function makes a check outcome from a sent result: only `ok` passes. */\nexport const passes = (sent: Sent<unknown>): Outcome => (sent.outcome === \"ok\" ? \"ok\" : \"error\");\n\n/** This check gives the state of the client, without a round trip. */\nexport const localStateCheck = (ready: () => boolean): StepCheck => ({ ownConnection: true, run: () => (ready() ? \"ok\" : \"error\") });\n\n/**\n * This check sends one call on the connection of the application. A check measures the step at this time.\n * Thus it does not send the call again, and only `ok` passes.\n */\nexport const roundTripCheck = (send: (options: SendOptions) => Promise<Sent<unknown>>): StepCheck => ({\n ownConnection: true,\n run: async (signal) => passes(await send({ signal, reissue: false })),\n});\n\n/**\n * This check opens a new connection each time. It finds a server that refuses connections, but not\n * a stalled connection of the application. A failed dial throws, and the poller counts the throw as an error.\n */\nexport const dialCheck = (dial: DialFn, host: string, port: number): StepCheck => ({\n ownConnection: false,\n run: async (signal) => {\n await dial(host, port, signal);\n return \"ok\" as const;\n },\n});\n\n/** These are the bounds of a client that the core examines in a description. */\nexport interface ClientBounds {\n /** This time bounds the close of the client, in milliseconds. */\n readonly close: number;\n /** This time bounds a call on the connection of the application, in milliseconds. */\n readonly request: number;\n}\n\n/** This function gives the bounds of a client that `clientProblems` examines, from its knobs. */\nexport const clientBounds = (knobs: ClientKnobs): ClientBounds => ({ close: ms(knobs.close_bound), request: ms(knobs.request_timeout) });\n\n/**\n * This function gives the problems of a client in a description:\n * - The client needs the phase \"tear down dependencies\", and its close must fit in the cap of that phase.\n * - A round-trip check must end in one jittered poll (B7, O13).\n */\nexport const clientProblems = (name: string, description: ServiceDescription, bounds: ClientBounds): string[] => {\n const found: string[] = [];\n const teardown = description.shutdown.phases.find((phase) => phase.name === \"tear down dependencies\");\n if (teardown === undefined) found.push(`${name} needs the phase \"tear down dependencies\" to close`);\n else if (bounds.close >= valueIn(teardown.cap, \"ms\"))\n found.push(`${name}'s close_bound of ${bounds.close} ms does not fit in the cap of \"tear down dependencies\"`);\n for (const check of description.checks) {\n if (check.dependency !== name || check.step !== \"round-trip\") continue;\n const slowest = valueIn(check.poll.timeout, \"ms\") + valueIn(check.poll.interval, \"ms\") * (1 + check.poll.jitter);\n if (bounds.request > slowest) found.push(`${name}'s request_timeout outlives one jittered poll of ${check.name} (B7, O13)`);\n }\n return found;\n};\n\n/**\n * This poll is a poll of the checks to start from: each 5 s with a jitter of 20 %, and a timeout of\n * 4 s (B6, O12). Its slowest poll is 4 s + 5 s × 1.2 = 10 s, the slowest poll of the cells of O13.\n * It does not depend on a driver. The starting knobs of each driver fit it.\n */\nexport const STARTING_POLL: Poll = { interval: { value: 5, unit: \"s\" }, jitter: 0.2, timeout: { value: 4, unit: \"s\" } };\n"],"mappings":";;;;;AAsEA,MAAa,mBAA6B,SAAS,IAAI,GAAG;;AAS1D,MAAa,MAAM,WACjB,OAAO,UAAU,aAAa,OAAO,oBAAoB,QAAQ,QAAoB,IAAI;;AAG3F,MAAa,YAAY,WAAuC;CAC9D,MAAM,QAAQ,GAAG,MAAM;CACvB,OAAO,OAAO,SAAS,KAAK,IAAI,QAAQ,KAAA;AAC1C;;AAGA,MAAa,WAAW,UAA4B,iBAAiB,QAAQ,MAAM,UAAU,OAAO,KAAK;;AAyEzG,MAAa,cACX,YACqF;CACrF,cAAc,QAAQ,gBAAgB;CACtC,WAAW,QAAQ,aAAa;CAChC,eAAe,QAAQ,iBAAiB;CACxC,YAAY,QAAQ,cAAc;AACpC;;AAuBA,MAAa,gBACX,KACA,MACA,aACA,QACA,WACmB;CACnB,IAAI,WAAW,MAAM,aAAa,MAAM;CACxC,KAAK,MAAM,CAAC,OAAO,QAAQ,QAAQ,IAAI,MAAM,OAAO,GAAG;CACvD,OAAO;AACT;;AAGA,MAAa,kBACX,UACA,UACyC;CAAE,GAAG;CAAU,GAAG;AAAK;;AAMlE,MAAa,kBACV,QAA8B,OAAc,UAC5C,MAAM,IAAI,IAAI,WACb,SAAS;CAAE,IAAI,MAAM,IAAI;CAAG,SAAS;CAAU,UAAU;CAAM;CAAM;CAAI;CAAI,GAAI,WAAW,KAAA,IAAY,CAAC,IAAI,EAAE,OAAO;AAAG,CAAC;;AAG9H,MAAa,WAAW,WAAmC;CAAE,SAAS;CAAS;CAAO,OAAO;AAAM;;AA8BnG,MAAa,iBAA2B;CACtC,MAAM,yBAAS,IAAI,IAA6B;CAChD,MAAM,0BAAU,IAAI,IAAgB;CACpC,MAAM,aAAmB;EACvB,IAAI,OAAO,OAAO,GAAG;EACrB,KAAK,MAAM,UAAU,CAAC,GAAG,OAAO,GAAG,OAAO;EAC1C,QAAQ,MAAM;CAChB;CACA,OAAO;EACL,IAAI,OAAO;GACT,OAAO,OAAO;EAChB;EACA,YACE,IAAI,SAAe,YAAY;GAC7B,IAAI,OAAO,SAAS,GAAG,QAAQ;QAC1B,QAAQ,IAAI,OAAO;EAC1B,CAAC;EACH,MACE,QACA,WACA,OACA,OACqB;GACrB,OAAO,IAAI,SAAqB,YAAY;IAC1C,IAAI,UAAU;IACd,MAAM,UAAqB,OAAO,UAAU;KAC1C,IAAI,SAAS;KACb,UAAU;KACV,OAAO,OAAO,KAAK;KACnB,QAAQ,oBAAoB,SAAS,OAAO;KAC5C,QAAQ,OAAO,KAAK;KACpB,QAAQ,KAAK;KACb,KAAK;IACP;IACA,MAAM,SAAS,UAAwB,OAAO;KAAE,SAAS;KAAiB;IAAM,GAAG,IAAI,MAAM,KAAK,CAAC;IACnG,MAAM,gBAAsB,MAAM,SAAS;IAC3C,OAAO,IAAI,KAAK;IAChB,QAAQ,iBAAiB,SAAS,SAAS,EAAE,MAAM,KAAK,CAAC;IACzD,MAAM,MAAM;GACd,CAAC;EACH;EACA,UAAU,OAAO;GACf,KAAK,MAAM,SAAS,CAAC,GAAG,MAAM,GAAG,MAAM,KAAK;EAC9C;CACF;AACF;;;;;;;AAQA,MAAa,kBACX,QACA,OACA,OACA,QACA,WACA,UACA,OACA,UACwB;CACxB,IAAI,aAAqB,CAAC;CAC1B,OAAO,OAAO,MACZ,QACA,YACC,WAAW;EAEV,OAAO,MAAM,MAAM,aAAa,OAAO;GAAE,SAAS;GAAiB,OAAO;EAAS,CAAC,CAAC;EACrF,MAAM,MAAM;CACd,IACC,OAAO,UAAU;EAChB,KAAK;EACL,QAAQ,OAAO,KAAK;CACtB,CACF;AACF;;;;;;AAOA,MAAa,eAAe,OAAc,OAAe,SAA6C;CACpG,MAAM,OAAO,KAAK,WACV,YACA,IACR;CACA,IAAI,eAAuB,CAAC;CAC5B,MAAM,QAAQ,IAAI,SAAkB,YAAY;EAE9C,SAAS,MAAM,MAAM,aAAa,QAAQ,KAAK,CAAC;CAClD,CAAC;CACD,OAAO,QAAQ,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,MAAM,UAAU;EACjD,OAAO;EACP,OAAO;CACT,CAAC;AACH;;AAcA,MAAa,aAAa,OAAc,UAAoC;CAC1E,MAAM,0BAAU,IAAI,IAAgB;CACpC,OAAO;EACL,OAAO,QAAQ,WACb,IAAI,SAAS,YAAY;GACvB,IAAI,MAAM,GAAG;IACX,QAAQ,IAAI;IACZ;GACF;GACA,IAAI,eAAuB,CAAC;GAC5B,MAAM,QAAQ,UAAyB;IACrC,QAAQ,OAAO,IAAI;IACnB,OAAO;IACP,QAAQ,oBAAoB,SAAS,OAAO;IAC5C,QAAQ,KAAK;GACf;GACA,MAAM,aAAmB,KAAK,IAAI;GAClC,MAAM,gBAAsB,KAAK,KAAK;GACtC,QAAQ,IAAI,IAAI;GAEhB,SAAS,MAAM,MAAM,cAAc,KAAK,MAAM,CAAC,CAAC;GAChD,QAAQ,iBAAiB,SAAS,SAAS,EAAE,MAAM,KAAK,CAAC;EAC3D,CAAC;EACH,OAAO;GACL,KAAK,MAAM,QAAQ,CAAC,GAAG,OAAO,GAAG,KAAK;EACxC;CACF;AACF;;;;;AAcA,MAAa,gBAAgB,WAAgC;CAC3D,MAAM,GAAG,MAAM,UAAU;CACzB,QAAQ;CACR,KAAK,GAAG,MAAM,SAAS;CACvB,QAAQ;EAAE,MAAM;EAAO,QAAQ,GAAG,MAAM,UAAU;CAAE;AACtD;;AAkBA,MAAa,iBAAiB,OAAc,SAAkB,WAAwC;CAEpG,MAAM,QAAQ,UAAU,OAAO,SAAS,MAAM;CAC9C,OAAO;EACL,IAAI,QAAQ;GACV,OAAO,MAAM;EACf;EACA,SAAS,KAAK;GACZ,MAAM,SAAS,GAAG;EACpB;EACA,cAAc,MAAM,OAAO;EAC3B,aAAa,MAAM,MAAM;CAC3B;AACF;;AAGA,MAAa,iBAAiB,MAAc,UAC1C,GAAG,MAAM,SAAS,IAAI,GAAG,MAAM,UAAU,IAAI,CAAC,GAAG,KAAK,qCAAqC,IAAI,CAAC;;;;;AAMlG,MAAa,kBAAkB,MAAc,QAAgB,cAC3D,OAAO,UAAU,MAAM,KAAK,UAAU,IAAI,CAAC,IAAI,CAAC,GAAG,KAAK,KAAK,UAAU,+BAA+B,OAAO,uCAAuC;;AAGtJ,MAAa,gBAAgB,MAAc,UAA4B;CACrE,MAAM,WAAqB,CAAC;CAC5B,KAAK,MAAM,CAAC,MAAM,WAAW,OAAO,QAAQ,KAAK,GAC/C,IAAI,OAAO,UAAU,cAAc,EAAE,GAAG,MAAM,KAAK,IAAI,SAAS,KAAK,GAAG,KAAK,KAAK,KAAK,+BAA+B;CAExH,OAAO;AACT;;AAGA,MAAa,UAAU,WAA2B,SAAS,MAAM,KAAK;;AAGtE,MAAa,WAAW,WAA4B,OAAO,UAAU,cAAc,OAAO,UAAU,GAAG,MAAM,CAAC;;AAG9G,MAAa,gBAAgB,WAC3B,OAAO,UAAU,cAAc,OAAO,UAAU,QAAQ,QAAoB,GAAG,CAAC;AAclF,MAAM,UAAU,OAAe,SAA0B,MAAiC;;;;;;AAO1F,MAAa,gBAAgB,MAAc,QAAgB,OAAe,UAA+B;CACvG,MAAM,WAAqB,CAAC;CAC5B,KAAK,MAAM,QAAQ,MAAM,WAAW,CAAC,GAAG;EACtC,MAAM,QAAQ,GAAG,OAAO,OAAO,IAAI,CAAC;EACpC,IAAI,EAAE,QAAQ,MAAM,CAAC,OAAO,SAAS,KAAK,GAAG,SAAS,KAAK,GAAG,KAAK,KAAK,KAAK,oCAAoC,OAAO,qBAAqB;CAC/I;CACA,KAAK,MAAM,QAAQ,MAAM,QAAQ,CAAC,GAAG;EACnC,MAAM,SAAS,OAAO,OAAO,IAAI;EACjC,IAAI,OAAO,UAAU,cAAc,EAAE,GAAG,MAAM,IAAI,IAAI,SAAS,KAAK,GAAG,KAAK,KAAK,KAAK,uCAAuC;CAC/H;CACA,OAAO;AACT;;AAGA,MAAa,iBAAiB,MAAc,OAAe,UAA+B,CACxF,IAAI,MAAM,UAAU,CAAC,EAAA,CAAG,QAAQ,SAAS,CAAC,QAAQ,OAAO,OAAO,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,SAAS,GAAG,KAAK,KAAK,KAAK,uCAAuC,GAC/I,IAAI,MAAM,WAAW,CAAC,EAAA,CAAG,QAAQ,SAAS,CAAC,aAAa,OAAO,OAAO,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,SAAS,GAAG,KAAK,KAAK,KAAK,kCAAkC,CAClJ;;AAGA,MAAa,gBAAgB,MAAc,SAAmE;CAC5G,MAAM,WAAqB,CAAC;CAC5B,IAAI,CAAC,OAAO,UAAU,KAAK,GAAG,KAAK,KAAK,MAAM,GAAG,SAAS,KAAK,GAAG,KAAK,uBAAuB,KAAK,IAAI,gCAAgC;CACvI,IAAI,CAAC,OAAO,UAAU,KAAK,GAAG,KAAK,KAAK,MAAM,KAAK,KAAK,MAAM,KAAK,KACjE,SAAS,KAAK,GAAG,KAAK,uBAAuB,KAAK,IAAI,uCAAuC;CAC/F,OAAO;AACT;;;;;;;AAQA,MAAa,mBAAmB,MAAc,SAAmB,UAAkB,SACjF,SAAS,UAAU,cAAc,GAAG,OAAO,KAAK,GAAG,QAAQ,IACvD,GAAG,KAAK,mFAAmF,KAAK,kCAChG;;;;;;;AAQN,MAAa,oBAAoB,MAAc,QAAgB,OAAe,OAAO,uBACnF,MAAM,UAAU,cAAc,EAAE,GAAG,MAAM,IAAI,GAAG,KAAK,KACjD,GAAG,KAAK,KAAK,KAAK,6GAClB;;;;;AAMN,MAAa,wBAAwB,MAAc,OAAe,WAChE,OAAO,QAAQ,MAAM,CAAC,CACnB,QAAQ,CAAC,UAAU;CAClB,MAAM,QAAQ,GAAG,OAAO,OAAO,IAAI,CAAC;CACpC,OAAO,EAAE,QAAQ,MAAM,CAAC,OAAO,SAAS,KAAK;AAC/C,CAAC,CAAC,CACD,KAAK,CAAC,MAAM,UAAU,GAAG,KAAK,KAAK,KAAK,kFAAkF,MAAM;;AAGrI,MAAa,eAAe,MAAc,OAAgD,WACxF,MAAM,mBAAmB,UAAU,aAAa,CAAC,IAAI,CAAC,GAAG,KAAK,2CAA2C,QAAQ;;AAGnH,MAAa,uBAAuB,MAAc,OAA4C,WAA6B;CACzH,MAAM,QAAQ,GAAG,MAAM,cAAc;CACrC,OAAO,QAAQ,KAAK,OAAO,SAAS,KAAK,IAAI,CAAC,IAAI,CAAC,GAAG,KAAK,qDAAqD,OAAO,2BAA2B;AACpJ;;;;;;AAuBA,MAAa,kBAAkB,OAAU,SAAuC;CAC9E,MAAM,EAAE,OAAO,UAAU;CACzB,MAAM,EAAE,WAAW,KAAK;CACxB,MAAM,YAAY,KAAK,QAAQ,YAAY,QAAQ,KAAA,IAAY,KAAK;CACpE,MAAM,UAAU,MAAM,IAAI;CAC1B,MAAM,QAAQ,MAAM,KAAK,QAAQ,MAAM;CACvC,IAAI,MAAM,YAAY,MAAM,OAAO;EAAE,SAAS;EAAM,OAAO,MAAM;EAAO,UAAU;CAAE;CACpF,MAAM,QACJ,EAAE,MAAM,YAAY,WAAW,MAAM,UACrC,cAAc,KAAA,KACd,QAAQ,YAAY,QACpB,WAAW,WAAW,UAAU,MAAM,IAAI,IAAI,WAAW,KAAM,GAAG,CAAC;CACrE,MAAM,OAAO,SAAS,MAAM,IAAI,IAAI;CACpC,IAAI,CAAC,SAAS,QAAQ,GAAG,OAAO;EAAE,GAAG;EAAO,UAAU;CAAE;CACxD,IAAI,KAAK,gBAAgB,KAAA,KAAa,CAAE,MAAM,KAAK,YAAY,MAAM,MAAM,GAAI,OAAO;EAAE,GAAG;EAAO,UAAU;CAAE;CAC9G,KAAK,UAAU;CACf,MAAM,MAAM,IAAI,gBAAgB;CAEhC,MAAM,OAAO,MAAM,MAAM,KAAK,IAAI,GAAG,SAAS,MAAM,IAAI,IAAI,QAAQ,SAAS,IAAI,MAAM,CAAC;CACxF,MAAM,gBAAsB,IAAI,MAAM;CACtC,QAAQ,iBAAiB,SAAS,SAAS,EAAE,MAAM,KAAK,CAAC;CACzD,MAAM,SAAS,MAAM,KAAK,QAAQ,IAAI,MAAM;CAC5C,KAAK;CACL,QAAQ,oBAAoB,SAAS,OAAO;CAC5C,OAAO,OAAO,YAAY,OAAO;EAAE,SAAS;EAAM,OAAO,OAAO;EAAO,UAAU;CAAE,IAAI;EAAE,GAAG;EAAQ,UAAU;CAAE;AAClH;;;;;;;;AASA,MAAa,cACX,MACA,SACA,SAC6C;CAC7C,MAAM,MAAO,OAAO,QAAQ,IAAI,CAAC,CAAuC,QAAQ,GAAG,SAAS,QAAQ,KAAA,CAAS,CAAC,CAAC,KAAK,CAAC,UAAU,IAAI;CACnI,MAAM,UAAU,QAAQ,YAAY,OAAO;EAAE,GAAG,QAAQ;EAAM,UAAU;CAAiB,IAAI,QAAQ;CACrG,IAAI,YAAY,KAAA,GAAW;EACzB,MAAM,UAAU,OAAO,KAAK,QAAQ,KAAK,CAAC,CAAC,QAAQ,SAAS,CAAC,IAAI,SAAS,IAAS,CAAC;EACpF,IAAI,QAAQ,SAAS,GACnB,MAAM,IAAI,MAAM,GAAG,KAAK,yBAAyB,QAAQ,KAAK,IAAI,EAAE,yCAAyC,IAAI,KAAK,IAAI,EAAE,EAAE;CAElI;CACA,MAAM,OAAyC,CAAC;CAChD,KAAK,MAAM,QAAQ,KAAK;EACtB,MAAM,MAAM,KAAK;EACjB,MAAM,YAAY,QAAQ,QAAQ;EAClC,IAAI,CAAC,aAAa,YAAY,KAAA,GAAW;EACzC,KAAK,KAAK,CACR;GACE,MAAM,GAAG,KAAK,GAAG;GACjB,YAAY;GACZ;GACA,eAAe,IAAI;GACnB,OAAO,YAAa,QAAQ,MAAM,SAAS,OAAQ;GACnD,MAAM,aAAa,YAAY,KAAA,IAAY,QAAQ,OAAO;EAC5D,GACA,IAAI,GACN,CAAC;CACH;CACA,OAAO;AACT;;AAGA,MAAa,UAAU,SAAkC,KAAK,YAAY,OAAO,OAAO;;AAGxF,MAAa,mBAAmB,WAAqC;CAAE,eAAe;CAAM,WAAY,MAAM,IAAI,OAAO;AAAS;;;;;AAMlI,MAAa,kBAAkB,UAAuE;CACpG,eAAe;CACf,KAAK,OAAO,WAAW,OAAO,MAAM,KAAK;EAAE;EAAQ,SAAS;CAAM,CAAC,CAAC;AACtE;;;;;AAMA,MAAa,aAAa,MAAc,MAAc,UAA6B;CACjF,eAAe;CACf,KAAK,OAAO,WAAW;EACrB,MAAM,KAAK,MAAM,MAAM,MAAM;EAC7B,OAAO;CACT;AACF;;AAWA,MAAa,gBAAgB,WAAsC;CAAE,OAAO,GAAG,MAAM,WAAW;CAAG,SAAS,GAAG,MAAM,eAAe;AAAE;;;;;;AAOtI,MAAa,kBAAkB,MAAc,aAAiC,WAAmC;CAC/G,MAAM,QAAkB,CAAC;CACzB,MAAM,WAAW,YAAY,SAAS,OAAO,MAAM,UAAU,MAAM,SAAS,wBAAwB;CACpG,IAAI,aAAa,KAAA,GAAW,MAAM,KAAK,GAAG,KAAK,mDAAmD;MAC7F,IAAI,OAAO,SAAS,QAAQ,SAAS,KAAK,IAAI,GACjD,MAAM,KAAK,GAAG,KAAK,oBAAoB,OAAO,MAAM,wDAAwD;CAC9G,KAAK,MAAM,SAAS,YAAY,QAAQ;EACtC,IAAI,MAAM,eAAe,QAAQ,MAAM,SAAS,cAAc;EAC9D,MAAM,UAAU,QAAQ,MAAM,KAAK,SAAS,IAAI,IAAI,QAAQ,MAAM,KAAK,UAAU,IAAI,KAAK,IAAI,MAAM,KAAK;EACzG,IAAI,OAAO,UAAU,SAAS,MAAM,KAAK,GAAG,KAAK,mDAAmD,MAAM,KAAK,WAAW;CAC5H;CACA,OAAO;AACT;;;;;;AAOA,MAAa,gBAAsB;CAAE,UAAU;EAAE,OAAO;EAAG,MAAM;CAAI;CAAG,QAAQ;CAAK,SAAS;EAAE,OAAO;EAAG,MAAM;CAAI;AAAE"}
|
|
@@ -1,13 +1,12 @@
|
|
|
1
|
-
import "./core
|
|
1
|
+
import "./core.js";
|
|
2
2
|
/**
|
|
3
3
|
* A judge reads the bytes that the server sent so far. It gives null for a good answer, an error for
|
|
4
4
|
* a bad answer, or "more" when it must wait for more bytes.
|
|
5
5
|
*/
|
|
6
|
-
type Judge = (received: Buffer) => Error | null | "more";
|
|
6
|
+
export type Judge = (received: Buffer) => Error | null | "more";
|
|
7
7
|
/**
|
|
8
8
|
* This function makes a judge of the status line of an HTTP/1.1 answer. The judge waits for the end
|
|
9
9
|
* of the line, in the first 8 KiB. Then `accept` reads the status code, and gives null for a good status or an error.
|
|
10
10
|
* The HTTP client accepts each status. The WebSocket client accepts only 101.
|
|
11
11
|
*/
|
|
12
|
-
declare const statusLineJudge: (accept: (status: number, line: string) => Error | null) => Judge;
|
|
13
|
-
export { statusLineJudge as n, Judge as t };
|
|
12
|
+
export declare const statusLineJudge: (accept: (status: number, line: string) => Error | null) => Judge;
|