@genroc/eval-node 0.0.0-edge.00ee483

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/LICENSE ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
package/README.md ADDED
@@ -0,0 +1,337 @@
1
+ # @genroc/eval-node
2
+
3
+ Script tasks for Node. Two halves with different jobs:
4
+
5
+ * **the bundler** (`genroc-import`) — an author-time resolver genctl runs on every apply and
6
+ every edit, turning `$import: ./x.ts` into a bundled, typechecked string
7
+ * **the worker** (`genroc-eval-node`) — claims parked `external` script tasks off genroc's queue
8
+ and evaluates each in its own realm
9
+
10
+ ## Setting up a project
11
+
12
+ npm i -D @genroc/eval-node
13
+
14
+ Then register the resolver in a `.genroc` beside your definitions — a dotfile, so it does not
15
+ read as another process definition. Discovery walks up from the source file, so nothing depends
16
+ on the cwd:
17
+
18
+ resolvers:
19
+ import:
20
+ phase: code
21
+ ext: .ts
22
+ command: [npx, genroc-import]
23
+
24
+ `genctl apply` and `genctl types` now resolve `$import` directives. Typechecking is the
25
+ resolver's exit code, so a stored definition cannot hold code that failed to typecheck.
26
+
27
+ ## Building
28
+
29
+ pnpm run build # tsc -p tsconfig.build.json -> dist/
30
+
31
+ The published package is JavaScript, not TypeScript. **Node refuses to strip types for files
32
+ under `node_modules`**, so shipping `.ts` works from a checkout and fails for every consumer —
33
+ which is why `prepublishOnly` builds and CI installs the packed tarball rather than only running
34
+ from source. The source keeps its `.ts` import extensions; `rewriteRelativeImportExtensions`
35
+ turns them into `.js` on the way out.
36
+
37
+ ## Running the worker
38
+
39
+ docker run -e GENROC_SERVER=http://host:8448 ghcr.io/genroc/eval-node:preview
40
+
41
+ or locally, if you already have Node:
42
+
43
+ GENROC_SERVER=http://localhost:8448 npx genroc-eval-node
44
+
45
+ Add `GENROC_TOKEN` once the server has auth on; `worker` is the only permission it needs.
46
+
47
+ **The bundler cannot be the image.** It runs per edit and must resolve your project's own
48
+ `node_modules`, so a container start per invocation would break the editor loop.
49
+
50
+ Design record: [specs/external-task-queue.md](../specs/external-task-queue.md) for the queue,
51
+ [specs/script-tasks.md](../specs/script-tasks.md) for the runtime.
52
+
53
+ GENROC_SERVER=http://localhost:8448 node eval-node/worker.ts
54
+
55
+ Against a server started with `--auth token`, mint a scoped credential first:
56
+
57
+ TOKEN=$(genctl token create --perms worker --label evaluator -q)
58
+ GENROC_SERVER=http://localhost:8448 GENROC_TOKEN=$TOKEN node eval-node/worker.ts
59
+
60
+ `worker` reaches the four queue verbs and `GET /api/objects/{ref}` — enough to claim, fetch an
61
+ externalized input and answer, and nothing else. This is the credential most likely to end up on
62
+ a machine you trust least, so it is worth scoping rather than reusing an admin token: a leaked
63
+ one cannot read a definition, list an instance, or mint another token.
64
+
65
+ A credential problem **exits the worker** rather than being retried. Polling through a 401 looks
66
+ like a healthy worker that never picks anything up, which is the worst shape to debug.
67
+
68
+ It needs **Node 24 or newer**: the sources are TypeScript and are run as-is, by Node's own
69
+ type stripping.
70
+
71
+ | env | default | |
72
+ |---|---|---|
73
+ | `GENROC_SERVER` | `http://localhost:8448` | where to claim from |
74
+ | `GENROC_TOKEN` | *(none)* | credential, when the server runs with `--auth token`. Needs the **`worker`** permission and nothing more |
75
+ | `WORKER_ID` | `evaluator-<pid>` | the claim holder; renewals are scoped to it |
76
+ | `CONCURRENCY` | `4` | how many scripts run at once — **this worker's** decision |
77
+ | `LEASE_MS` | `30000` | visibility timeout; renewed at a third of it while working |
78
+ | `POLL_MS` | `250` | idle poll interval; a non-empty claim polls again immediately |
79
+ | `PROCESS` / `TASK` | unset | claim only this process / task id |
80
+
81
+ **The worker calls genroc, not the other way round.** That is the whole reason this is a
82
+ queue worker rather than the HTTP sidecar it used to be:
83
+
84
+ - **Concurrency is the worker's to set.** Under the old `fetch` shape genroc decided how many
85
+ scripts ran at once (`--max-concurrent`, default 200) and the evaluator accepted every one.
86
+ A backlog is now a queue, not 200 threads fighting over a core.
87
+ - **No engine worker is held.** A `fetch` occupies one of genroc's advance slots for its whole
88
+ duration, so a slow evaluator starved unrelated tasks. An `external` task parks.
89
+ - **The connection direction inverts.** `/eval` was unauthenticated arbitrary code execution
90
+ that genroc had to be able to reach. A worker only needs outbound access, so it can live
91
+ anywhere — behind NAT, in another trust zone.
92
+
93
+ The cost of that inversion is that genroc cannot reach a running worker, so anything it needs
94
+ to say has to ride the renewal the worker already makes. **Renewing is therefore mandatory,
95
+ not an optimisation** — a worker that stops renewing is indistinguishable from one that died.
96
+ The response answers per token:
97
+
98
+ | list | what it means | what this worker does |
99
+ |---|---|---|
100
+ | `renewed` | still yours | carry on |
101
+ | `lost` | already someone else's | stop; do **not** release — that would bump the new holder's claim |
102
+ | `cancelled` | still yours, nobody wants it | abort the script and release the claim |
103
+
104
+ `cancelled` is how an operator's `genctl cancel` reaches work already running: the evaluation
105
+ is aborted through an `AbortSignal`, its realm is terminated, and no outcome is submitted —
106
+ the process is stopping, so there is nothing left to answer. `renew_before_ms` on the claim
107
+ says how long the worker may wait before renewing again, so the interval is a value it reads
108
+ rather than one it guesses.
109
+
110
+ ## The task input
111
+
112
+ The `input` of the external task IS the evaluation request:
113
+
114
+ ```jsonc
115
+ {
116
+ "code": "export default (input) => ({ fee: input.amount * 0.1 });", // required — a module
117
+ "input": { "amount": 250 }, // optional — its argument
118
+ "timeout_ms": 5000 // optional — default 5000
119
+ }
120
+ ```
121
+
122
+ `code` is an **ES module**, and the evaluator imports it and calls its **default export** with
123
+ `input`. The value it returns reaches genroc; the function may be async, and so may the module's
124
+ top level. A module exporting anything else — or nothing — is a `compile_error`: there is
125
+ nothing to call, and so is one that will not parse; a throw from its top level is a `threw`
126
+ like any other. `import` of a node builtin resolves as it does anywhere else, and that is what
127
+ a bundled builtin lands on.
128
+
129
+ ## The answer — the failure kind IS the error code
130
+
131
+ genroc's `on_error` matches error codes, and an external task's `raises` declares the closed
132
+ set a worker may send. So the classification lives in the **code**, where a rule can match it,
133
+ rather than in a body a `switch` has to read.
134
+
135
+ | outcome | the worker submits | |
136
+ |---|---|---|
137
+ | the script returned | `result: <the return value>` | `return;` sends nothing, which genroc reads as `null` |
138
+ | the script faulted | `error: {code, message, data}` | `code` is the kind, below |
139
+ | the **evaluator** faulted | *nothing* — it releases the claim | the task returns to the queue for another worker |
140
+
141
+ The five kinds, every one of them **permanent** — a retry re-runs the same code on the same
142
+ input and fails identically:
143
+
144
+ `compile_error` · `threw` · `timeout` · `nonserializable` · `exited`
145
+
146
+ `data` carries `{name, stack?}`: `name` is what a script sets to tell one refusal from another
147
+ (`e.name = 'LimitExceeded'`), and `stack` is renumbered to the lines the author wrote and
148
+ trimmed to 2 KiB.
149
+
150
+ **The retryable class has no code on purpose.** A runner that faults releases its claim, which
151
+ is how a queue spells "try this somewhere else" — it puts the task in front of a different
152
+ worker instead of spending the definition's `on_error` budget on this one's bad day. There is
153
+ no retry policy to write.
154
+
155
+ ## The genroc side
156
+
157
+ ```yaml
158
+ - id: price
159
+ action:
160
+ type: external
161
+ input:
162
+ code: |
163
+ export default function (input) {
164
+ if (input.amount > 100) {
165
+ const e = new Error('amount over the limit');
166
+ e.name = 'LimitExceeded';
167
+ throw e;
168
+ }
169
+ return { fee: input.amount * 0.1 };
170
+ }
171
+ input: "$: input"
172
+ result_schema: { type: object, properties: { fee: { type: number } }, required: [fee] }
173
+ raises:
174
+ threw: { $ref: "#/$defs/script_error" }
175
+ timeout: { $ref: "#/$defs/script_error" }
176
+ compile_error: { $ref: "#/$defs/script_error" }
177
+ nonserializable: { $ref: "#/$defs/script_error" }
178
+ exited: { $ref: "#/$defs/script_error" }
179
+ timeout: 30s
180
+ on_error:
181
+ - code: [threw]
182
+ goto: $script_failed
183
+ - code: [compile_error, nonserializable, exited]
184
+ panic: { code: script_broken, message: "the script did not run: ${error.code}" }
185
+ switch: [{ goto: end }]
186
+
187
+ - id: script_failed
188
+ switch:
189
+ - case: 'last_error.data.name == "LimitExceeded"'
190
+ raise: { code: limit_exceeded, message: "the script rejected the amount" }
191
+ - raise: { code: script_failed, message: "the script failed" }
192
+ ```
193
+
194
+ **A script cannot name a genroc error code.** `raise`/`panic` codes are literals, never
195
+ expressions, so the mapping from a thrown error to an authored code is this `switch` — one
196
+ task the definition owns, reading `error.data`. That is the whole error protocol: the worker
197
+ classifies into a code, the definition names the outcome.
198
+
199
+ Set the task `timeout` **above** `timeout_ms`. If the task's deadline fires first the code is
200
+ `external.timeout`, which is in `errcode.Unknowable()` — permanently unretryable on an
201
+ `only_once` task, and indistinguishable from no evaluator running at all.
202
+
203
+ `only_once` is worth considering if your scripts have side effects: without it a worker that
204
+ dies mid-script has its task re-claimed and the script runs again. With it the task is never
205
+ handed out twice, and the instance gets a catchable `external.lost` instead.
206
+
207
+ ## `${` must be escaped as `$${` — when the code is inline
208
+
209
+ An external task's `input` is a Shape, so `${…}` is genroc's interpolation marker and a JS
210
+ template literal inside `code` is read by genroc rather than passed through. Write `` `<$${x}>` ``.
211
+ A leading `$:` on the code string needs `$$:` for the same reason. See
212
+ [specs/typed-values.md](../specs/typed-values.md). Moving the code into a `.ts` file
213
+ removes this entirely — see the next section.
214
+
215
+ ## `import.ts` — the author-time half
216
+
217
+ `import.ts` is the **code-phase resolver** genctl runs before a definition is applied. It
218
+ never touches the queue and the worker never runs it; the two halves share this package only
219
+ because they share a calling convention, which is exactly the coupling that breaks silently
220
+ if they version apart.
221
+
222
+ Register it in the project's `.genroc`:
223
+
224
+ ```yaml
225
+ resolvers:
226
+ import: { phase: code, ext: .ts, command: [node, ../eval-node/import.ts] }
227
+ ```
228
+
229
+ then write the script as a module and name it from the definition:
230
+
231
+ ```yaml
232
+ body:
233
+ code: "$import: ./fee.ts"
234
+ input: "$: input"
235
+ ```
236
+
237
+ ```ts
238
+ import type { Input, Output } from "./fee.genroc";
239
+
240
+ export default async function (input: Input): Promise<Output> {
241
+ return { fee: input.amount * 0.1 };
242
+ }
243
+ ```
244
+
245
+ `genctl types -f process.yaml` writes `fee.genroc.d.ts` beside the script — named for the
246
+ **script's path**, not the task, so renaming a task cannot break the import line. `Input` is
247
+ the inferred type of what the definition passes; `Output` is what it declares
248
+ (`responses.200`, or `result_schema` on a child). `genctl apply` regenerates them, runs
249
+ `tsc --noEmit`, and bundles — so **a type error is a failed apply**, and a stored definition
250
+ cannot hold code that failed to typecheck.
251
+
252
+ The bundle is one self-contained ES module whose default export is the author's own — nothing
253
+ wraps or rewrites it, so what the editor checks and what the realm runs are the same module, and
254
+ **a missing default export is a failed apply** rather than a fault at run time. Imports resolve
255
+ through TypeScript under the same config the check ran with, so a `paths` alias that typechecks
256
+ also bundles. They are inlined at build time, so the string a definition version stores is
257
+ self-contained forever — with one exception: **node builtins stay as imports**, which the realm
258
+ resolves. A package is frozen into the definition; `node:fs` is resolved by whatever runner
259
+ executes it.
260
+
261
+ ### Your tsconfig, your types
262
+
263
+ The generated project config `extends` **the nearest `tsconfig.json` above the script** —
264
+ the one your editor already reads, so the two cannot disagree. Two scripts under two
265
+ different configs are two `tsc` runs.
266
+
267
+ Of that config, three keys are the toolchain's and the rest are yours:
268
+
269
+ | key | owner | why |
270
+ |---|---|---|
271
+ | `lib` | the toolchain | Describes the realm. A worker thread has no `document`, whatever a config claims. |
272
+ | `include` | the toolchain | Forced to `[]`. A base `include` survives beside our `files` and would drag your whole tree in to be checked as scripts. |
273
+ | `types` | **you** | How a script opts into the node globals. The realm has them, so refusing the declarations would only lie. With no tsconfig at all the default is `[]`. |
274
+
275
+ ```jsonc
276
+ // tsconfig.json beside your scripts
277
+ { "compilerOptions": { "types": ["node"] } } // now `import { appendFile } from "node:fs/promises"` typechecks
278
+ ```
279
+
280
+ **This is what removes the `$${` escaping above** — a template literal in a `.ts` file is
281
+ never read by genroc, because genctl doubles every `$` on splice.
282
+
283
+ ## The realm — one Worker per execution
284
+
285
+ `evaluate()` starts a Worker (`realm.ts`), posts the code into it — where a module loader hook
286
+ serves it to `import()`, so the engine numbers the script's frames from the author's own source —
287
+ and races the reply against the budget; `terminate()` runs on every path. That thread is what the contract rests on, and it buys
288
+ exactly three things the previous in-process evaluator could not:
289
+
290
+ - **The budget is enforced, not merely reported.** A synchronous `while(true){}` never
291
+ yields, so no in-process timer can interrupt it — the old evaluator hung forever on that
292
+ input, and said so in this file. Killing the thread is the only bound. Measured on Node
293
+ 24: `terminate()` stops a spinning worker, and the CPU it was burning goes with it.
294
+ - **A fresh global object per execution.** One script cannot configure the next. It is also
295
+ why there is no compile cache any more: a cache inside a discarded realm can never be hit.
296
+ - **The script's mistakes stay the script's.** An uncaught throw, and `process.exit()`, end
297
+ the realm and come back as a `422` — neither reaches the runner.
298
+
299
+ It costs about **27ms per execution** end to end for a trivial script (Node 24, M-series
300
+ laptop), a 200 KiB body about 30ms. Roughly 11ms of that is Node re-stripping `realm.ts`'s
301
+ types on every realm — precompiling it to JavaScript measures 17ms and would buy that back, and
302
+ is deliberately not done: a build artefact that goes stale against its source fails silently,
303
+ and this file is the one where a wrong line number is invisible.
304
+
305
+ A subprocess per execution measures ~55ms here, twice the thread rather than the ten times it
306
+ cost on the previous runtime. It contains the two things a thread cannot (below), so the upgrade
307
+ path is a live one at a price worth naming rather than a theoretical one.
308
+
309
+ ## What this is not
310
+
311
+ - **Not deterministic.** A script reads the real clock and the real RNG, and a retry
312
+ re-executes — so attempt two can differ from attempt one. An earlier version injected a
313
+ pinned `Date` and a seeded `Math`; nothing could supply a stable `now` (the expression
314
+ environment has no clock), so the pin was the wall clock under another name, and the `ctx`
315
+ it needed was surface with nothing behind it. A value that must survive a retry belongs in
316
+ the definition, passed through `input`.
317
+ - **Not a sandbox.** The realm isolates *execution*, not *authority*: a script gets the
318
+ worker's filesystem, network and environment, and any node builtin it imports. That is
319
+ deliberate — a script task is meant to do real work — but the trust boundary stays the
320
+ same-trust-domain one (your genroc, your worker host). It is not the multi-tenant story, and
321
+ nothing here should be mistaken for one. Pulling does move the boundary in one useful way:
322
+ the worker needs no inbound reachability, so nothing but the worker can ask it to run code.
323
+ - **A thread does not contain memory or a native crash.** A worker shares the process
324
+ address space, so a script that exhausts memory takes the runner with it — and so does a
325
+ fault in the runtime itself, which is not hypothetical: the previous one segfaulted on
326
+ resume from laptop sleep, taking the in-flight evaluation with it. Containing that is what
327
+ the subprocess strategy is for — `eval.ts` keeps HTTP out precisely so it can be swapped
328
+ underneath.
329
+ - **Concurrency is capped by this worker, not by genroc.** Each evaluation is a thread, and
330
+ `CONCURRENCY` is how many it will claim at once. Raising it past what the host can run turns
331
+ a queue back into threads fighting over a core.
332
+ - **Not where imports and type checking happen.** The evaluator takes one self-contained
333
+ module and knows nothing about TypeScript; `import.ts` is what bundles an author's script and
334
+ its dependencies into that module, at author time. See above.
335
+ - **`eval.ts` and `realm.ts` know nothing about genroc.** `worker.ts` is the entire
336
+ queue-facing half, which is what keeps the containment strategy swappable — and what lets
337
+ the realm's own properties be tested by calling `evaluate()` directly.
package/dist/eval.js ADDED
@@ -0,0 +1,85 @@
1
+ // Evaluation core: import a script module in its OWN realm, call its default export, and
2
+ // classify every outcome into one of the failure kinds in README.md. Nothing here knows about
3
+ // genroc — worker.ts is the only thing that talks to the queue — so this stays testable and
4
+ // the containment stays swappable.
5
+ //
6
+ // The containment is a Worker per execution (realm.ts). It is what makes the budget real:
7
+ // a synchronous busy loop never yields, so no in-process timer can interrupt it, and only a
8
+ // thread the host can kill bounds it.
9
+ import { Worker } from "node:worker_threads";
10
+ const DEFAULT_TIMEOUT_MS = 5_000;
11
+ // Resolved from THIS file's own extension: run from a checkout it is `.ts`, and from the
12
+ // published package `.js`, because Node will not strip types under node_modules.
13
+ const REALM_URL = new URL(import.meta.url.endsWith(".ts") ? "./realm.ts" : "./realm.js", import.meta.url);
14
+ /** Thrown, not returned: a realm that fails to start is the RUNNER faulting, which worker.ts
15
+ * answers by releasing the claim rather than by reporting an outcome. A script fault is a
16
+ * return value. */
17
+ class RealmFault extends Error {
18
+ constructor(message) {
19
+ super(message);
20
+ this.name = "RealmFault";
21
+ }
22
+ }
23
+ /** Thrown when `signal` aborts: the work was cancelled server-side, so there is no outcome to
24
+ * report and worker.ts must release rather than answer. Distinct from RealmFault because the
25
+ * runner did not fault -- nothing is wrong, the answer is simply no longer wanted. */
26
+ export class Cancelled extends Error {
27
+ constructor() {
28
+ super("cancelled");
29
+ this.name = "Cancelled";
30
+ }
31
+ }
32
+ export async function evaluate(req, signal) {
33
+ const budget = typeof req.timeout_ms === "number" ? req.timeout_ms : DEFAULT_TIMEOUT_MS;
34
+ const worker = new Worker(REALM_URL);
35
+ let timer;
36
+ let onAbort;
37
+ try {
38
+ return await new Promise((resolve, reject) => {
39
+ timer = setTimeout(() => resolve(timedOut(budget)), budget);
40
+ // The abort is wired to the same promise as the budget, so both settle through the one
41
+ // finally below -- which is what guarantees the thread is gone before either returns.
42
+ if (signal) {
43
+ if (signal.aborted)
44
+ reject(new Cancelled());
45
+ onAbort = () => reject(new Cancelled());
46
+ signal.addEventListener("abort", onAbort, { once: true });
47
+ }
48
+ worker.once("message", (reply) => resolve(reply));
49
+ // A script may end its own realm (`process.exit()`), which is not a throw and would
50
+ // otherwise present as a hang until the budget expired. Our own terminate() raises
51
+ // this too, by which time the promise has settled and the first result stands.
52
+ worker.once("exit", (code) => resolve(exited(code)));
53
+ worker.once("error", (err) => reject(new RealmFault(errorText(err))));
54
+ worker.postMessage({ code: req.code, input: req.input });
55
+ });
56
+ }
57
+ finally {
58
+ clearTimeout(timer);
59
+ if (signal && onAbort)
60
+ signal.removeEventListener("abort", onAbort);
61
+ // Awaited, and the whole point: on the timeout path a thread is still burning a core, and
62
+ // resolving before it is gone would report an evaluation the machine is still running.
63
+ await worker.terminate();
64
+ }
65
+ }
66
+ function timedOut(ms) {
67
+ return {
68
+ ok: false,
69
+ failure: { kind: "timeout", name: "TimeoutError", message: `script exceeded its ${ms}ms budget` },
70
+ };
71
+ }
72
+ function exited(code) {
73
+ return {
74
+ ok: false,
75
+ failure: {
76
+ kind: "exited",
77
+ name: "RealmExited",
78
+ message: `the script ended its own realm with code ${code} instead of returning`,
79
+ },
80
+ };
81
+ }
82
+ function errorText(e) {
83
+ const message = e?.message;
84
+ return typeof message === "string" && message !== "" ? message : "the evaluation realm failed to start";
85
+ }