@genroc/eval-node 0.15.0 → 0.17.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/dist/import.js CHANGED
@@ -1,11 +1,7 @@
1
1
  #!/usr/bin/env node
2
- // The code-phase resolver: manifest on stdin, `{"code": [...]}` on stdout, non-zero exit
3
- // with the diagnostic on stderr. genctl never parses TypeScript and this never parses YAML
4
- // — the manifest is the whole contract. See specs/source-resolution.md.
5
- //
6
- // Two modes, one binary: "types" writes the declarations an editor needs and returns no
7
- // code; "build" typechecks and bundles. A separate types hook would mean a second `tsc`
8
- // over the same project.
2
+ // The typed-phase resolver: manifest on stdin, `{"values": [...]}` on stdout, diagnostic on stderr
3
+ // with a non-zero exit (specs/source-resolution.md). Two modes share one `tsc` pass: "generate"
4
+ // writes declarations only, "resolve" typechecks and bundles.
9
5
  import { existsSync } from "node:fs";
10
6
  import { access, writeFile } from "node:fs/promises";
11
7
  import { builtinModules } from "node:module";
@@ -120,7 +116,7 @@ function declarations(at) {
120
116
  emitted.push(`export type ${identifier(next)} = ${body};`);
121
117
  }
122
118
  return [
123
- "// Generated by genroc. Do not edit - regenerate with `genctl types`.",
119
+ "// Generated by genroc. Do not edit - regenerate with `genctl generate`.",
124
120
  `// ${where.name} (${address(site.pointer)})`,
125
121
  "",
126
122
  ...emitted,
@@ -137,9 +133,8 @@ function typesPathFor(scriptPath) {
137
133
  return scriptPath.replace(/\.[^.\/]+$/, "") + ".genroc.d.ts";
138
134
  }
139
135
  // ── typecheck ──────────────────────────────────────────────────────────────────
140
- /** The nearest tsconfig above the script — the one the author's editor already reads. Two
141
- * different configs mean a red editor over a clean apply, or the reverse. The walk stops at
142
- * the project root: above it is not this project. */
136
+ /** The tsconfig the author's editor reads, so editor and apply agree. Stops at the project
137
+ * root. */
143
138
  async function nearestTsconfig(from, root) {
144
139
  for (let dir = from;; dir = dirname(dir)) {
145
140
  const candidate = join(dir, "tsconfig.json");
@@ -175,9 +170,8 @@ async function typecheck(sites) {
175
170
  // `lib` DESCRIBES the realm and is written after `extends` so a base cannot widen it:
176
171
  // a worker thread has no document, whatever an author's config claims.
177
172
  lib: ["esnext", "webworker"],
178
- // `types` is the author's, and it is how a script opts into the node globals —
179
- // the worker realm has them, so refusing the declarations would only lie. With no
180
- // base config there is nothing to opt in with, so the default stays none.
173
+ // `types` is the author's opt-in to node globals, which the realm has. With no base
174
+ // config there is nothing to opt in with, so it stays none.
181
175
  ...(base ? {} : { types: [] }),
182
176
  },
183
177
  files: group.flatMap((s) => [s.file, typesPathFor(s.file)]),
@@ -185,8 +179,9 @@ async function typecheck(sites) {
185
179
  // drag the author's whole tree in, to be checked under the worker lib.
186
180
  include: [],
187
181
  };
188
- // Never written: the name only anchors `@types` lookup at the root, where a real one would sit.
189
- const parsed = ts.parseJsonConfigFileContent(config, ts.sys, root, undefined, join(root, "tsconfig.json"));
182
+ // Never written; anchors `@types` lookup at the root. Not `tsconfig.json`: that is often the
183
+ // base it extends, and tsc refuses a circular extends.
184
+ const parsed = ts.parseJsonConfigFileContent(config, ts.sys, root, undefined, join(root, "tsconfig.genroc.json"));
190
185
  const program = ts.createProgram({
191
186
  rootNames: parsed.fileNames,
192
187
  options: parsed.options,
@@ -231,11 +226,9 @@ const BUILTIN = new Set([
231
226
  ...builtinModules,
232
227
  ...builtinModules.map((m) => `node:${m}`),
233
228
  ]);
234
- /** Resolves imports through TYPESCRIPT, using the same config the typecheck ran under, so a
235
- * `paths` alias that compiles also bundles. Reimplementing `paths` here would be a second
236
- * resolver to keep in agreement with tsc; this one cannot disagree.
237
- * A package resolving to a `.d.ts` is declined — that is a type, not the implementation —
238
- * which leaves node_modules to nodeResolve. */
229
+ /** Resolves through TYPESCRIPT under the typecheck's config, so a `paths` alias that compiles
230
+ * also bundles. A `.d.ts` resolution is declined (a type, not code), leaving node_modules to
231
+ * nodeResolve. */
239
232
  function tsResolve(configPath) {
240
233
  let options = {};
241
234
  if (configPath) {
@@ -256,14 +249,12 @@ function tsResolve(configPath) {
256
249
  },
257
250
  };
258
251
  }
259
- /** Bundles to a self-contained ES module, which is what the evaluator imports: the default
260
- * export it calls is the author's own, so nothing wraps or rewrites the code between the two.
261
- * Bundling is entirely the importer's job, so a definition version pins its code forever. */
252
+ /** A self-contained ES module whose default export is the author's own, unwrapped. Bundling here
253
+ * means a definition version pins its code forever. */
262
254
  async function bundle(at) {
263
255
  const site = at.site;
264
- // Builtins are EXTERNALISED as imports the realm resolves natively. Anything else
265
- // unresolved is a REFUSAL, not an external: rollup's default is to leave it as an import
266
- // of a module that will not be there, which bundles clean and fails at runtime.
256
+ // Builtins are externalised; anything else unresolved is a REFUSAL, since rollup's default
257
+ // leaves an import that bundles clean and fails at runtime.
267
258
  const built = await rollup({
268
259
  input: at.file,
269
260
  external: (id) => BUILTIN.has(id),
@@ -271,8 +262,7 @@ async function bundle(at) {
271
262
  tsResolve(await nearestTsconfig(dirname(at.file), root)),
272
263
  nodeResolve({ extensions: [".ts", ".tsx", ".mjs", ".js", ".json"] }),
273
264
  commonjs(),
274
- // A `.json` import is a data file inlined at build time, which the previous bundler
275
- // did natively; without it rollup hands the JSON to the JS parser.
265
+ // Inlines `.json` imports; without it rollup hands JSON to the JS parser.
276
266
  json(),
277
267
  transpile,
278
268
  ],
@@ -317,20 +307,18 @@ function address(pointer) {
317
307
  .join("")
318
308
  .replace(/^\./, "");
319
309
  }
320
- const located = manifest.processes.flatMap((where) => where.sites.map((site) => ({
321
- site,
322
- where,
323
- file: resolve(where.dir, site.argument),
324
- })));
325
- // genctl is agnostic about what a script is for; the contract that an evaluation request carries
326
- // its module in `code` is THIS resolver's, so it is the one that checks a directive landed there.
327
- // `child` is the shape the scaffold uses — a call to a process that forwards to the evaluator —
328
- // and `external` is the same request made directly.
310
+ const located = manifest.processes.flatMap((where) => where.sites.map((site) => {
311
+ const [script, ...rest] = site.args;
312
+ if (script === undefined || rest.length > 0) {
313
+ die(`${join(where.dir, where.file)}: ${address(site.pointer)}: $import takes one script, ` +
314
+ `and is given ${site.args.length} arguments`);
315
+ }
316
+ return { site, where, file: resolve(where.dir, script) };
317
+ }));
318
+ // The `code`-field contract is this resolver's, not genctl's, so it checks the directive landed
319
+ // there: in a child call (the scaffold's shape) or an external task's input.
329
320
  for (const at of located) {
330
- // Two halves, from the two places that carry them: the action's KIND is a field, and WHERE in
331
- // it the directive sits is the pointer. A child call is the shape the scaffold generates — to a
332
- // process that forwards to the evaluator — and an external task is the same request made
333
- // directly.
321
+ // The action's kind is a field; where in it the directive sits is the pointer.
334
322
  const kind = at.site.level === "action" ? (at.site.action ?? "") : "";
335
323
  const slot = at.site.pointer.slice(-2).join(".");
336
324
  if ((kind !== "child" && kind !== "external") || slot !== "input.code") {
@@ -339,12 +327,11 @@ for (const at of located) {
339
327
  `${kind ? `a ${kind} task's ` : ""}\`${slot}\`.`);
340
328
  }
341
329
  }
342
- // genctl no longer stats the argument — it does not know it is a file — so the resolver that
343
- // does is the one that must say when it is not there.
330
+ // genctl does not know the argument is a file, so this resolver reports a missing one.
344
331
  for (const at of located) {
345
332
  if (!existsSync(at.file)) {
346
333
  die(`${join(at.where.dir, at.where.file)}: ${address(at.site.pointer)}: ` +
347
- `"$import: ${at.site.argument}" names no file (looked at ${at.file})`);
334
+ `"$import: ${at.site.args[0]}" names no file (looked at ${at.file})`);
348
335
  }
349
336
  }
350
337
  // One script at two sites with different input types is a refusal, not a union: the union
@@ -363,13 +350,12 @@ for (const at of located) {
363
350
  for (const at of byPath.values()) {
364
351
  await writeFile(typesPathFor(at.file), declarations(at));
365
352
  }
366
- if (manifest.mode === "types") {
367
- console.log(JSON.stringify(manifest, null, 2));
353
+ if (manifest.mode === "generate") {
368
354
  process.exit(0);
369
355
  }
370
356
  await typecheck([...byPath.values()]);
371
- const code = [];
357
+ const values = [];
372
358
  for (const at of located) {
373
- code.push(await bundle(at));
359
+ values.push(await bundle(at));
374
360
  }
375
- process.stdout.write(JSON.stringify({ code }));
361
+ process.stdout.write(JSON.stringify({ values }));
package/dist/realm.js CHANGED
@@ -1,9 +1,5 @@
1
- // The evaluation realm. One Worker per execution: a fresh global object per script, and a
2
- // thread the host can kill mid-loop — the only thing that bounds a synchronous busy loop.
3
- // eval.ts owns the budget and does the killing; nothing here knows about time.
4
- //
5
- // Everything that touches the script's VALUE lives on this side of the boundary — loading,
6
- // classifying, serialising — because this is the only realm the value exists in.
1
+ // The evaluation realm: one Worker per execution, killable mid-loop by eval.ts, which owns the
2
+ // budget. Everything touching the script's VALUE lives here, the only realm it exists in.
7
3
  var __rewriteRelativeImportExtension = (this && this.__rewriteRelativeImportExtension) || function (path, preserveJsx) {
8
4
  if (typeof path === "string" && /^\.\.?\//.test(path)) {
9
5
  return path.replace(/\.(tsx)$|((?:\.d)?)((?:\.[^./]+?)?)\.([cm]?)ts$/i, function (m, tsx, d, ext, cm) {
@@ -14,9 +10,8 @@ var __rewriteRelativeImportExtension = (this && this.__rewriteRelativeImportExte
14
10
  };
15
11
  import { registerHooks } from "node:module";
16
12
  import { parentPort } from "node:worker_threads";
17
- // The script is IMPORTED as a module under a URL of our own, not compiled from a string: its
18
- // frames then carry the author's own line numbers, and an `import` of a node builtin resolves
19
- // the way it does everywhere else.
13
+ // IMPORTED under our own URL rather than compiled from a string, so frames carry the author's
14
+ // line numbers and builtin imports resolve normally.
20
15
  const SCRIPT_URL = "script:main";
21
16
  const STACK_BYTES = 2_048;
22
17
  // The only channel a load hook has to the source. Written per request and read once — a realm
@@ -54,9 +49,8 @@ function safeText(v) {
54
49
  return String(v);
55
50
  }
56
51
  }
57
- /** A module that will not parse, or names an import nothing resolves, is broken code — only
58
- * editing it helps. Anything else thrown by the import is the module's top level running,
59
- * which is the script throwing. */
52
+ /** Unparseable code or an unresolvable import is broken code; anything else the import throws is
53
+ * the module's top level running, i.e. the script throwing. */
60
54
  function unloadable(err) {
61
55
  const code = err?.code;
62
56
  return err instanceof SyntaxError || (typeof code === "string" && code.startsWith("ERR_MODULE"));
@@ -97,10 +91,8 @@ async function run(req) {
97
91
  return { ok: false, failure: describe(err, "nonserializable") };
98
92
  }
99
93
  }
100
- // The realm's stdio is a pipe to the host thread, and eval.ts terminates this thread the moment
101
- // the reply lands — so whatever a script wrote last is still in the pipe when it dies. An empty
102
- // write's callback fires once the queue ahead of it has drained, which makes the reply a barrier
103
- // for `console` and a direct process.stdout.write alike: both are this stream.
94
+ // eval.ts terminates this thread the moment the reply lands, while stdio may still be in the
95
+ // pipe. An empty write's callback fires once the queue drains, making the reply a barrier.
104
96
  function flush(stream) {
105
97
  return new Promise((resolve) => stream.write("", () => resolve()));
106
98
  }
package/dist/worker.js CHANGED
@@ -1,31 +1,18 @@
1
1
  #!/usr/bin/env node
2
- // The queue worker: claims parked `external` script tasks from genroc, evaluates each in its
3
- // own realm, and answers. This is the whole genroc-facing half — eval.ts and realm.ts know
4
- // nothing about the queue, which is what keeps the containment strategy swappable.
5
- //
6
- // See README.md for the contract, and specs/external-task-queue.md for the queue itself.
2
+ // The queue worker: claims parked `external` script tasks, evaluates each in its own realm, and
3
+ // answers. The only genroc-facing half (README.md; specs/external-task-queue.md).
7
4
  import { readFileSync } from "node:fs";
8
5
  import { Cancelled, evaluate } from "./eval.js";
9
6
  const SERVER = (process.env.GENROC_SERVER ?? "http://localhost:8448").replace(/\/$/, "");
10
7
  const WORKER_ID = process.env.WORKER_ID ?? `evaluator-${process.pid}`;
11
- // The credential, when the server runs with --auth token. A worker needs exactly the `worker`
12
- // permission — the four queue verbs plus GET /api/objects — so mint it scoped rather than
13
- // handing a worker an admin token: this is the credential most likely to sit on a machine you
14
- // trust least. specs/api-auth.md §5.
15
- //
16
- // Sent as a header rather than in the URL because Node's fetch REFUSES a URL carrying
17
- // credentials ("Request cannot be constructed from a URL that includes credentials"), so the
18
- // basic-auth-in-the-URL trick that works for genctl is not available here.
19
- // GENROC_TOKEN_FILE is the mounted-secret shape: a credential in a file rather than an
20
- // environment variable, so it stays out of `docker inspect` and out of the process environment
21
- // any child inherits. The inline variable wins when both are set.
8
+ // Needs only the `worker` permission (specs/api-auth.md §5): this credential sits on the machine
9
+ // you trust least. A header, because Node's fetch refuses credentials in a URL. The file form
10
+ // keeps it out of `docker inspect` and child environments; the inline variable wins.
22
11
  const TOKEN = process.env.GENROC_TOKEN ??
23
12
  (process.env.GENROC_TOKEN_FILE ? readFileSync(process.env.GENROC_TOKEN_FILE, "utf8").trim() : "");
24
13
  const authHeaders = TOKEN ? { authorization: `Bearer ${TOKEN}` } : {};
25
- // Concurrency is the worker's to set, and that is the point of pulling: under the old fetch
26
- // shape genroc decided how many scripts ran at once (--max-concurrent, default 200) and the
27
- // evaluator accepted every one of them. Here it claims what it can run and no more, so a
28
- // backlog is a queue rather than 200 threads fighting over a core.
14
+ // The worker claims only what it can run, so a backlog is a queue rather than threads fighting
15
+ // over a core.
29
16
  const CONCURRENCY = Number(process.env.CONCURRENCY ?? 4);
30
17
  const POLL_MS = Number(process.env.POLL_MS ?? 250);
31
18
  // The visibility timeout. Short, and renewed while work is in flight: a worker that dies
@@ -34,17 +21,15 @@ const LEASE_MS = Number(process.env.LEASE_MS ?? 30_000);
34
21
  const RENEW_MS = Math.max(1_000, Math.floor(LEASE_MS / 3));
35
22
  const PROCESS_FILTER = process.env.PROCESS ?? "";
36
23
  const TASK_FILTER = process.env.TASK ?? "";
37
- // Values too large to ship inline are listed rather than carried, and a bundle is exactly that:
38
- // one object shared by every instance of a definition version, fetched once instead of copied
39
- // into each task. A ref is a content hash, so it is immutable — the cache never invalidates.
24
+ // Large values arrive as refs; a bundle is one object per definition version, fetched once.
25
+ // Refs are content hashes, so the cache never invalidates.
40
26
  const objectCache = new Map();
41
27
  async function fetchObject(ref) {
42
28
  const cached = objectCache.get(ref);
43
29
  if (cached !== undefined)
44
30
  return cached;
45
- // Left to throw on purpose: this runs while a task is IN FLIGHT, and a task whose input
46
- // cannot be fetched must fail rather than silently run against a missing value. The caller
47
- // releases the claim, so the task returns to the queue.
31
+ // Left to throw: a task whose input cannot be fetched must not run against a missing value.
32
+ // The caller releases the claim.
48
33
  const res = await fetch(`${SERVER}/api/objects/${encodeURIComponent(ref)}`, { headers: authHeaders });
49
34
  if (!res.ok)
50
35
  throw new Error(`fetch object ${ref}: HTTP ${res.status}`);
@@ -84,10 +69,8 @@ async function resolveObjects(job) {
84
69
  return input;
85
70
  }
86
71
  async function call(path, body) {
87
- // A network error is a REPLY, not a throw. A worker outlives the server it polls — a
88
- // restart, a rolling deploy, a container coming up before genroc is listening — and an
89
- // unhandled rejection here kills it for a condition the next poll would clear. Status 0
90
- // says "never reached the server", which is distinct from anything genroc answers.
72
+ // A network error is a REPLY (status 0, "never reached the server"), not a throw: a worker
73
+ // outlives restarts and deploys, and an unhandled rejection would kill it.
91
74
  let res;
92
75
  try {
93
76
  res = await fetch(SERVER + path, {
@@ -109,9 +92,8 @@ async function call(path, body) {
109
92
  }
110
93
  return { ok: res.ok, status: res.status, data };
111
94
  }
112
- /** The task input IS an EvalRequest: `code` required, `input` and `timeout_ms` optional. A task
113
- * whose input is not that shape is the definition's fault, not the script's, and is reported
114
- * as a compile_error — the nearest permanent kind, since no retry can fix the definition. */
95
+ /** A task input that is not an EvalRequest is the definition's fault, reported as compile_error:
96
+ * the nearest permanent kind, since no retry fixes the definition. */
115
97
  function asEvalRequest(input) {
116
98
  if (typeof input !== "object" || input === null)
117
99
  return "the task input is not an object";
@@ -126,10 +108,8 @@ function asEvalRequest(input) {
126
108
  }
127
109
  const inFlight = new Map();
128
110
  let running = true;
129
- // Whether the last claim reached genroc. A worker polls several times a second, so an
130
- // unreachable server would otherwise emit a line per poll — thousands during a restart, which
131
- // buries the one line that mattered. Announce the TRANSITIONS instead: going away, and coming
132
- // back. Silence in between is the report that nothing changed.
111
+ // Announce reachability TRANSITIONS only: polling several times a second would otherwise emit
112
+ // thousands of lines during a restart.
133
113
  let serverReachable = true;
134
114
  async function claim(n) {
135
115
  const { ok, status, data } = await call("/api/external-tasks/claim", {
@@ -140,18 +120,15 @@ async function claim(n) {
140
120
  ...(TASK_FILTER ? { task: TASK_FILTER } : {}),
141
121
  });
142
122
  if (!ok) {
143
- // A credential problem is not transient, and polling through it looks like a healthy
144
- // worker that never picks anything up — the worst shape for an operator to debug. Exit
145
- // instead, so a supervisor restarts it and the failure is visible where it happened.
123
+ // A credential problem is not transient, and polling through it looks like a healthy idle
124
+ // worker. Exit, so a supervisor restarts it visibly.
146
125
  if (status === 401 || status === 403) {
147
126
  console.error(`claim rejected (${status}): ${JSON.stringify(data)}\n` +
148
127
  `The server requires authentication. Set GENROC_TOKEN to a token with the 'worker' ` +
149
128
  `permission — mint one with: genctl token create --perms worker --label evaluator -q`);
150
129
  process.exit(1);
151
130
  }
152
- // status 0 is "never reached the server" (see call): a restart, a rolling deploy, a
153
- // network blip. Not an error to act on — the next poll clears it — so it is reported once
154
- // and then waited out.
131
+ // status 0 (see call): a restart or blip the next poll clears, so it is reported once.
155
132
  if (status === 0) {
156
133
  if (serverReachable) {
157
134
  serverReachable = false;
@@ -174,10 +151,8 @@ async function release(token) {
174
151
  if (!ok)
175
152
  console.error(`release failed: ${JSON.stringify(data)}`);
176
153
  }
177
- /** answer submits the outcome. A refusal is NOT retried with a different one: the definition
178
- * declared a contract this worker does not satisfy (an undeclared code, a payload that does
179
- * not fit `raises`), and guessing again would only pick a second wrong answer. Release it, so
180
- * the task returns to the queue and an operator sees it waiting rather than silently gone. */
154
+ /** A refused outcome is not retried with another: the worker does not satisfy the declared
155
+ * contract. Released, so an operator sees the task waiting rather than gone. */
181
156
  async function answer(token, outcome) {
182
157
  const { ok, data } = await call("/api/external-tasks/resolve", { token, ...outcome });
183
158
  if (ok)
@@ -209,18 +184,15 @@ async function run(job, signal) {
209
184
  result = await evaluate(req, signal);
210
185
  }
211
186
  catch (err) {
212
- // Cancelled is not a fault: the process was stopped while this ran. The claim still goes
213
- // back — the row is terminal, so nothing re-claims it, and the release is what stops it
214
- // waiting out a lease nobody is serving.
187
+ // Cancelled is not a fault. Still released: the row is terminal so nothing re-claims it,
188
+ // but the release stops it waiting out a lease nobody serves.
215
189
  if (err instanceof Cancelled) {
216
190
  console.log(`cancelled: ${job.token}`);
217
191
  await release(job.token);
218
192
  return;
219
193
  }
220
- // The RUNNER faulted, not the script — the one class where a retry can help. There is no
221
- // error code for it on purpose: releasing the claim is how a queue spells "retryable", and
222
- // it puts the task in front of a different worker instead of burning the definition's
223
- // on_error budget on this one's bad day.
194
+ // The RUNNER faulted, the one retryable class. Releasing is how a queue spells "retryable",
195
+ // and it reaches another worker without spending the definition's on_error budget.
224
196
  console.error(`evaluator fault on ${job.token}: ${err instanceof Error ? err.message : String(err)}`);
225
197
  await release(job.token);
226
198
  return;
@@ -255,17 +227,13 @@ async function renewLoop() {
255
227
  });
256
228
  if (!ok)
257
229
  continue;
258
- // Cancelled: the process was stopped, so the evaluation is abandoned and the claim handed
259
- // back. Aborting first is the point of the list — waiting for the script to finish would
260
- // keep burning a core on work an operator has already stopped. The release rides run()'s
261
- // own catch, so nothing is released twice.
230
+ // Abort first rather than let a stopped script burn a core; the release rides run()'s
231
+ // catch, so nothing is released twice.
262
232
  for (const token of (data?.cancelled ?? [])) {
263
233
  inFlight.get(token)?.abort.abort();
264
234
  }
265
- // Lost: someone else holds this claim now. The work continues and its answer will be
266
- // refused — that is not fixable here — but say so, because it is the signal that LEASE_MS
267
- // is too short for what these scripts actually take. Deliberately NOT released: the claim
268
- // is the new holder's, and releasing would bump the epoch out from under it.
235
+ // Lost: another worker holds it now and our answer will be refused; logged as the sign that
236
+ // LEASE_MS is too short. NOT released: that would bump the epoch out from under the holder.
269
237
  const lost = (data?.lost ?? []);
270
238
  if (lost.length) {
271
239
  console.error(`lost ${lost.length}/${tokens.length} claims; a lease lapsed under load`);
package/eval.ts CHANGED
@@ -1,11 +1,6 @@
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.
1
+ // Imports a script module in its own realm (a Worker per execution, realm.ts), calls its default
2
+ // export, and classifies every outcome (README.md). Only a killable thread bounds a synchronous
3
+ // busy loop, which is what makes the budget real. Knows nothing of genroc; worker.ts does.
9
4
 
10
5
  import { Worker } from "node:worker_threads";
11
6
 
@@ -16,9 +11,8 @@ export type EvalRequest = {
16
11
  timeout_ms?: number;
17
12
  };
18
13
 
19
- /** Every kind here is PERMANENT: a retry re-runs the same code on the same input and fails
20
- * identically. The retryable class has no kind because it is not an outcome — a runner that
21
- * faults releases its claim and lets another worker take the task. */
14
+ /** Every kind is PERMANENT: a retry fails identically. A faulting runner is not an outcome; it
15
+ * releases its claim. */
22
16
  export type FailureKind = "compile_error" | "threw" | "timeout" | "nonserializable" | "exited";
23
17
 
24
18
  export type EvalFailure = {
@@ -28,9 +22,8 @@ export type EvalFailure = {
28
22
  stack?: string;
29
23
  };
30
24
 
31
- /** `body` is JSON TEXT, not a value: serialising in the realm is what makes a nonserializable
32
- * return a script fault rather than a 500 thrown out of the response path. It is also what
33
- * crosses the worker boundary — structured clone would refuse a different set of values. */
25
+ /** JSON TEXT serialised in the realm, so a nonserializable return is a script fault, not a 500,
26
+ * and structured clone (which refuses a different set of values) never sees the value. */
34
27
  export type EvalResult =
35
28
  | { ok: true; body: string }
36
29
  | { ok: false; failure: EvalFailure };
@@ -47,9 +40,8 @@ const REALM_URL = new URL(
47
40
  import.meta.url,
48
41
  );
49
42
 
50
- /** Thrown, not returned: a realm that fails to start is the RUNNER faulting, which worker.ts
51
- * answers by releasing the claim rather than by reporting an outcome. A script fault is a
52
- * return value. */
43
+ /** Thrown, not returned: a realm that fails to start is the runner faulting, which worker.ts
44
+ * answers by releasing the claim. */
53
45
  class RealmFault extends Error {
54
46
  constructor(message: string) {
55
47
  super(message);
@@ -57,9 +49,8 @@ class RealmFault extends Error {
57
49
  }
58
50
  }
59
51
 
60
- /** Thrown when `signal` aborts: the work was cancelled server-side, so there is no outcome to
61
- * report and worker.ts must release rather than answer. Distinct from RealmFault because the
62
- * runner did not fault -- nothing is wrong, the answer is simply no longer wanted. */
52
+ /** Thrown when `signal` aborts: the answer is no longer wanted, so worker.ts releases rather
53
+ * than answers. Not a RealmFault: nothing is wrong. */
63
54
  export class Cancelled extends Error {
64
55
  constructor() {
65
56
  super("cancelled");
@@ -84,9 +75,8 @@ export async function evaluate(req: EvalRequest, signal?: AbortSignal): Promise<
84
75
  signal.addEventListener("abort", onAbort, { once: true });
85
76
  }
86
77
  worker.once("message", (reply: WorkerReply) => resolve(reply));
87
- // A script may end its own realm (`process.exit()`), which is not a throw and would
88
- // otherwise present as a hang until the budget expired. Our own terminate() raises
89
- // this too, by which time the promise has settled and the first result stands.
78
+ // A script may `process.exit()`, which would otherwise look like a hang until the budget.
79
+ // Our own terminate() fires this too, after the promise has settled.
90
80
  worker.once("exit", (code: number) => resolve(exited(code)));
91
81
  worker.once("error", (err: Error) => reject(new RealmFault(errorText(err))));
92
82
  worker.postMessage({ code: req.code, input: req.input } satisfies WorkerRequest);