@genroc/eval-node 0.15.0 → 0.17.0

package/import.ts

@@ -1,11 +1,7 @@
 #!/usr/bin/env node
-// The code-phase resolver: manifest on stdin, `{"code": [...]}` on stdout, non-zero exit
-// with the diagnostic on stderr. genctl never parses TypeScript and this never parses YAML
-// — the manifest is the whole contract. See specs/source-resolution.md.
-//
-// Two modes, one binary: "types" writes the declarations an editor needs and returns no
-// code; "build" typechecks and bundles. A separate types hook would mean a second `tsc`
-// over the same project.
+// The typed-phase resolver: manifest on stdin, `{"values": [...]}` on stdout, diagnostic on stderr
+// with a non-zero exit (specs/source-resolution.md). Two modes share one `tsc` pass: "generate"
+// writes declarations only, "resolve" typechecks and bundles.
 
 import { existsSync } from "node:fs";
 import { access, writeFile } from "node:fs/promises";
@@ -29,9 +25,9 @@ type Site = {
   child?: string;
   // The slot as a path of keys and indices, so nothing has to unescape a JSON Pointer.
   pointer: (string | number)[];
-  // Everything after `$<resolver>:`, verbatim. genctl does not read it as a path — that is
-  // this resolver's reading of it.
-  argument: string;
+  // The argument's words, split as sh splits single quotes. genctl does not read them as paths —
+  // that is this resolver's reading of them.
+  args: string[];
   // What .genroc asked genctl to type, keyed by the name it chose. This resolver reads Input
   // and Output; which ADDRESS each came from is the config's business, not ours.
   types?: Record<string, Schema>;
@@ -49,8 +45,7 @@ type ManifestProcess = {
 };
 
 type Manifest = {
-  mode: "types" | "build";
-  root: string;
+  mode: "generate" | "resolve";
   processes: ManifestProcess[];
 };
 
@@ -174,7 +169,7 @@ function declarations(at: Located): string {
   }
 
   return [
-    "// Generated by genroc. Do not edit - regenerate with `genctl types`.",
+    "// Generated by genroc. Do not edit - regenerate with `genctl generate`.",
     `// ${where.name}  (${address(site.pointer)})`,
     "",
     ...emitted,
@@ -194,9 +189,8 @@ function typesPathFor(scriptPath: string): string {
 
 // ── typecheck ──────────────────────────────────────────────────────────────────
 
-/** The nearest tsconfig above the script — the one the author's editor already reads. Two
- *  different configs mean a red editor over a clean apply, or the reverse. The walk stops at
- *  the project root: above it is not this project. */
+/** The tsconfig the author's editor reads, so editor and apply agree. Stops at the project
+ *  root. */
 async function nearestTsconfig(
   from: string,
   root: string,
@@ -233,9 +227,8 @@ async function typecheck(sites: Located[]): Promise<void> {
         // `lib` DESCRIBES the realm and is written after `extends` so a base cannot widen it:
         // a worker thread has no document, whatever an author's config claims.
         lib: ["esnext", "webworker"],
-        // `types` is the author's, and it is how a script opts into the node globals —
-        // the worker realm has them, so refusing the declarations would only lie. With no
-        // base config there is nothing to opt in with, so the default stays none.
+        // `types` is the author's opt-in to node globals, which the realm has. With no base
+        // config there is nothing to opt in with, so it stays none.
         ...(base ? {} : { types: [] }),
       },
       files: group.flatMap((s) => [s.file, typesPathFor(s.file)]),
@@ -243,13 +236,14 @@ async function typecheck(sites: Located[]): Promise<void> {
       // drag the author's whole tree in, to be checked under the worker lib.
       include: [],
     };
-    // Never written: the name only anchors `@types` lookup at the root, where a real one would sit.
+    // Never written; anchors `@types` lookup at the root. Not `tsconfig.json`: that is often the
+    // base it extends, and tsc refuses a circular extends.
     const parsed = ts.parseJsonConfigFileContent(
       config,
       ts.sys,
       root,
       undefined,
-      join(root, "tsconfig.json"),
+      join(root, "tsconfig.genroc.json"),
     );
     const program = ts.createProgram({
       rootNames: parsed.fileNames,
@@ -301,11 +295,9 @@ const BUILTIN = new Set([
   ...builtinModules.map((m) => `node:${m}`),
 ]);
 
-/** Resolves imports through TYPESCRIPT, using the same config the typecheck ran under, so a
- *  `paths` alias that compiles also bundles. Reimplementing `paths` here would be a second
- *  resolver to keep in agreement with tsc; this one cannot disagree.
- *  A package resolving to a `.d.ts` is declined — that is a type, not the implementation —
- *  which leaves node_modules to nodeResolve. */
+/** Resolves through TYPESCRIPT under the typecheck's config, so a `paths` alias that compiles
+ *  also bundles. A `.d.ts` resolution is declined (a type, not code), leaving node_modules to
+ *  nodeResolve. */
 function tsResolve(configPath: string | null): Plugin {
   let options: ts.CompilerOptions = {};
   if (configPath) {
@@ -335,14 +327,12 @@ function tsResolve(configPath: string | null): Plugin {
   };
 }
 
-/** Bundles to a self-contained ES module, which is what the evaluator imports: the default
- *  export it calls is the author's own, so nothing wraps or rewrites the code between the two.
- *  Bundling is entirely the importer's job, so a definition version pins its code forever. */
+/** A self-contained ES module whose default export is the author's own, unwrapped. Bundling here
+ *  means a definition version pins its code forever. */
 async function bundle(at: Located): Promise<string> {
   const site = at.site;
-  // Builtins are EXTERNALISED as imports the realm resolves natively. Anything else
-  // unresolved is a REFUSAL, not an external: rollup's default is to leave it as an import
-  // of a module that will not be there, which bundles clean and fails at runtime.
+  // Builtins are externalised; anything else unresolved is a REFUSAL, since rollup's default
+  // leaves an import that bundles clean and fails at runtime.
   const built = await rollup({
     input: at.file,
     external: (id) => BUILTIN.has(id),
@@ -350,8 +340,7 @@ async function bundle(at: Located): Promise<string> {
       tsResolve(await nearestTsconfig(dirname(at.file), root)),
       nodeResolve({ extensions: [".ts", ".tsx", ".mjs", ".js", ".json"] }),
       commonjs(),
-      // A `.json` import is a data file inlined at build time, which the previous bundler
-      // did natively; without it rollup hands the JSON to the JS parser.
+      // Inlines `.json` imports; without it rollup hands JSON to the JS parser.
       json(),
       transpile,
     ],
@@ -394,10 +383,8 @@ const root = process.cwd();
 if (!manifest || !Array.isArray(manifest.processes))
   die("stdin is not a genroc resolver manifest");
 
-/** Every site with the process it sits in and the file its argument names, in the manifest's own
- *  order — which is the order `code` must answer in. genctl passes the argument verbatim, so
- *  joining it to the definition's directory is this resolver's business: only it knows the
- *  argument is a path at all. */
+/** Sites in manifest order, the order `code` must answer in. The argument is joined to the
+ *  definition's directory here: only this resolver knows it is a path. */
 type Located = { site: Site; where: ManifestProcess; file: string };
 
 /** A pointer as the address it is, so a generated comment or an error can be pasted into
@@ -413,22 +400,22 @@ function address(pointer: (string | number)[]): string {
     .replace(/^\./, "");
 }
 const located: Located[] = manifest.processes.flatMap((where) =>
-  where.sites.map((site) => ({
-    site,
-    where,
-    file: resolve(where.dir, site.argument),
-  })),
+  where.sites.map((site) => {
+    const [script, ...rest] = site.args;
+    if (script === undefined || rest.length > 0) {
+      die(
+        `${join(where.dir, where.file)}: ${address(site.pointer)}: $import takes one script, ` +
+          `and is given ${site.args.length} arguments`,
+      );
+    }
+    return { site, where, file: resolve(where.dir, script) };
+  }),
 );
 
-// genctl is agnostic about what a script is for; the contract that an evaluation request carries
-// its module in `code` is THIS resolver's, so it is the one that checks a directive landed there.
-// `child` is the shape the scaffold uses — a call to a process that forwards to the evaluator —
-// and `external` is the same request made directly.
+// The `code`-field contract is this resolver's, not genctl's, so it checks the directive landed
+// there: in a child call (the scaffold's shape) or an external task's input.
 for (const at of located) {
-  // Two halves, from the two places that carry them: the action's KIND is a field, and WHERE in
-  // it the directive sits is the pointer. A child call is the shape the scaffold generates — to a
-  // process that forwards to the evaluator — and an external task is the same request made
-  // directly.
+  // The action's kind is a field; where in it the directive sits is the pointer.
   const kind = at.site.level === "action" ? (at.site.action ?? "") : "";
   const slot = at.site.pointer.slice(-2).join(".");
   if ((kind !== "child" && kind !== "external") || slot !== "input.code") {
@@ -440,13 +427,12 @@ for (const at of located) {
   }
 }
 
-// genctl no longer stats the argument — it does not know it is a file — so the resolver that
-// does is the one that must say when it is not there.
+// genctl does not know the argument is a file, so this resolver reports a missing one.
 for (const at of located) {
   if (!existsSync(at.file)) {
     die(
       `${join(at.where.dir, at.where.file)}: ${address(at.site.pointer)}: ` +
-        `"$import: ${at.site.argument}" names no file (looked at ${at.file})`,
+        `"$import: ${at.site.args[0]}" names no file (looked at ${at.file})`,
     );
   }
 }
@@ -473,15 +459,14 @@ for (const at of byPath.values()) {
   await writeFile(typesPathFor(at.file), declarations(at));
 }
 
-if (manifest.mode === "types") {
-  console.log(JSON.stringify(manifest, null, 2));
+if (manifest.mode === "generate") {
   process.exit(0);
 }
 
 await typecheck([...byPath.values()]);
 
-const code: string[] = [];
+const values: string[] = [];
 for (const at of located) {
-  code.push(await bundle(at));
+  values.push(await bundle(at));
 }
-process.stdout.write(JSON.stringify({ code }));
+process.stdout.write(JSON.stringify({ values }));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@genroc/eval-node",
-  "version": "0.15.0",
+  "version": "0.17.0",
   "type": "module",
   "engines": {
     "node": ">=24"

package/realm.ts

@@ -1,18 +1,13 @@
-// The evaluation realm. One Worker per execution: a fresh global object per script, and a
-// thread the host can kill mid-loop — the only thing that bounds a synchronous busy loop.
-// eval.ts owns the budget and does the killing; nothing here knows about time.
-//
-// Everything that touches the script's VALUE lives on this side of the boundary — loading,
-// classifying, serialising — because this is the only realm the value exists in.
+// The evaluation realm: one Worker per execution, killable mid-loop by eval.ts, which owns the
+// budget. Everything touching the script's VALUE lives here, the only realm it exists in.
 
 import { registerHooks } from "node:module";
 import { parentPort } from "node:worker_threads";
 
 import type { EvalFailure, FailureKind, WorkerReply, WorkerRequest } from "./eval.ts";
 
-// The script is IMPORTED as a module under a URL of our own, not compiled from a string: its
-// frames then carry the author's own line numbers, and an `import` of a node builtin resolves
-// the way it does everywhere else.
+// IMPORTED under our own URL rather than compiled from a string, so frames carry the author's
+// line numbers and builtin imports resolve normally.
 const SCRIPT_URL = "script:main";
 const STACK_BYTES = 2_048;
 
@@ -54,9 +49,8 @@ function safeText(v: unknown): string {
   }
 }
 
-/** A module that will not parse, or names an import nothing resolves, is broken code — only
- *  editing it helps. Anything else thrown by the import is the module's top level running,
- *  which is the script throwing. */
+/** Unparseable code or an unresolvable import is broken code; anything else the import throws is
+ *  the module's top level running, i.e. the script throwing. */
 function unloadable(err: unknown): boolean {
   const code = (err as { code?: unknown } | null)?.code;
   return err instanceof SyntaxError || (typeof code === "string" && code.startsWith("ERR_MODULE"));
@@ -99,10 +93,8 @@ async function run(req: WorkerRequest): Promise<WorkerReply> {
   }
 }
 
-// The realm's stdio is a pipe to the host thread, and eval.ts terminates this thread the moment
-// the reply lands — so whatever a script wrote last is still in the pipe when it dies. An empty
-// write's callback fires once the queue ahead of it has drained, which makes the reply a barrier
-// for `console` and a direct process.stdout.write alike: both are this stream.
+// eval.ts terminates this thread the moment the reply lands, while stdio may still be in the
+// pipe. An empty write's callback fires once the queue drains, making the reply a barrier.
 function flush(stream: NodeJS.WriteStream): Promise<void> {
   return new Promise((resolve) => stream.write("", () => resolve()));
 }

package/worker.ts

@@ -1,34 +1,21 @@
 #!/usr/bin/env node
-// The queue worker: claims parked `external` script tasks from genroc, evaluates each in its
-// own realm, and answers. This is the whole genroc-facing half — eval.ts and realm.ts know
-// nothing about the queue, which is what keeps the containment strategy swappable.
-//
-// See README.md for the contract, and specs/external-task-queue.md for the queue itself.
+// The queue worker: claims parked `external` script tasks, evaluates each in its own realm, and
+// answers. The only genroc-facing half (README.md; specs/external-task-queue.md).
 
 import { readFileSync } from "node:fs";
 import { Cancelled, evaluate, type EvalRequest, type FailureKind } from "./eval.ts";
 
 const SERVER = (process.env.GENROC_SERVER ?? "http://localhost:8448").replace(/\/$/, "");
 const WORKER_ID = process.env.WORKER_ID ?? `evaluator-${process.pid}`;
-// The credential, when the server runs with --auth token. A worker needs exactly the `worker`
-// permission — the four queue verbs plus GET /api/objects — so mint it scoped rather than
-// handing a worker an admin token: this is the credential most likely to sit on a machine you
-// trust least. specs/api-auth.md §5.
-//
-// Sent as a header rather than in the URL because Node's fetch REFUSES a URL carrying
-// credentials ("Request cannot be constructed from a URL that includes credentials"), so the
-// basic-auth-in-the-URL trick that works for genctl is not available here.
-// GENROC_TOKEN_FILE is the mounted-secret shape: a credential in a file rather than an
-// environment variable, so it stays out of `docker inspect` and out of the process environment
-// any child inherits. The inline variable wins when both are set.
+// Needs only the `worker` permission (specs/api-auth.md §5): this credential sits on the machine
+// you trust least. A header, because Node's fetch refuses credentials in a URL. The file form
+// keeps it out of `docker inspect` and child environments; the inline variable wins.
 const TOKEN =
   process.env.GENROC_TOKEN ??
   (process.env.GENROC_TOKEN_FILE ? readFileSync(process.env.GENROC_TOKEN_FILE, "utf8").trim() : "");
 const authHeaders: Record<string, string> = TOKEN ? { authorization: `Bearer ${TOKEN}` } : {};
-// Concurrency is the worker's to set, and that is the point of pulling: under the old fetch
-// shape genroc decided how many scripts ran at once (--max-concurrent, default 200) and the
-// evaluator accepted every one of them. Here it claims what it can run and no more, so a
-// backlog is a queue rather than 200 threads fighting over a core.
+// The worker claims only what it can run, so a backlog is a queue rather than threads fighting
+// over a core.
 const CONCURRENCY = Number(process.env.CONCURRENCY ?? 4);
 const POLL_MS = Number(process.env.POLL_MS ?? 250);
 // The visibility timeout. Short, and renewed while work is in flight: a worker that dies
@@ -49,17 +36,15 @@ type QueueTask = {
   raises?: Record<string, unknown>;
 };
 
-// Values too large to ship inline are listed rather than carried, and a bundle is exactly that:
-// one object shared by every instance of a definition version, fetched once instead of copied
-// into each task. A ref is a content hash, so it is immutable — the cache never invalidates.
+// Large values arrive as refs; a bundle is one object per definition version, fetched once.
+// Refs are content hashes, so the cache never invalidates.
 const objectCache = new Map<string, unknown>();
 
 async function fetchObject(ref: string): Promise<unknown> {
   const cached = objectCache.get(ref);
   if (cached !== undefined) return cached;
-  // Left to throw on purpose: this runs while a task is IN FLIGHT, and a task whose input
-  // cannot be fetched must fail rather than silently run against a missing value. The caller
-  // releases the claim, so the task returns to the queue.
+  // Left to throw: a task whose input cannot be fetched must not run against a missing value.
+  // The caller releases the claim.
   const res = await fetch(`${SERVER}/api/objects/${encodeURIComponent(ref)}`, { headers: authHeaders });
   if (!res.ok) throw new Error(`fetch object ${ref}: HTTP ${res.status}`);
   const { data } = (await res.json()) as { data: string };
@@ -97,10 +82,8 @@ async function resolveObjects(job: QueueTask): Promise<unknown> {
 }
 
 async function call(path: string, body: unknown): Promise<{ ok: boolean; status: number; data: any }> {
-  // A network error is a REPLY, not a throw. A worker outlives the server it polls — a
-  // restart, a rolling deploy, a container coming up before genroc is listening — and an
-  // unhandled rejection here kills it for a condition the next poll would clear. Status 0
-  // says "never reached the server", which is distinct from anything genroc answers.
+  // A network error is a REPLY (status 0, "never reached the server"), not a throw: a worker
+  // outlives restarts and deploys, and an unhandled rejection would kill it.
   let res: Response;
   try {
     res = await fetch(SERVER + path, {
@@ -121,9 +104,8 @@ async function call(path: string, body: unknown): Promise<{ ok: boolean; status:
   return { ok: res.ok, status: res.status, data };
 }
 
-/** The task input IS an EvalRequest: `code` required, `input` and `timeout_ms` optional. A task
- *  whose input is not that shape is the definition's fault, not the script's, and is reported
- *  as a compile_error — the nearest permanent kind, since no retry can fix the definition. */
+/** A task input that is not an EvalRequest is the definition's fault, reported as compile_error:
+ *  the nearest permanent kind, since no retry fixes the definition. */
 function asEvalRequest(input: unknown): EvalRequest | string {
   if (typeof input !== "object" || input === null) return "the task input is not an object";
   const r = input as Record<string, unknown>;
@@ -135,18 +117,15 @@ function asEvalRequest(input: unknown): EvalRequest | string {
   };
 }
 
-/** A claim this worker is currently serving. The controller is how the renewal loop reaches
- *  the evaluation: genroc cannot call us, so a cancellation arrives as an answer to our own
- *  heartbeat and has to be delivered inward from there. */
+/** genroc cannot call us, so a cancellation arrives on our own heartbeat and reaches the
+ *  evaluation through the controller. */
 type Running = { job: QueueTask; abort: AbortController };
 
 const inFlight = new Map<string, Running>();
 let running = true;
 
-// Whether the last claim reached genroc. A worker polls several times a second, so an
-// unreachable server would otherwise emit a line per poll — thousands during a restart, which
-// buries the one line that mattered. Announce the TRANSITIONS instead: going away, and coming
-// back. Silence in between is the report that nothing changed.
+// Announce reachability TRANSITIONS only: polling several times a second would otherwise emit
+// thousands of lines during a restart.
 let serverReachable = true;
 
 async function claim(n: number): Promise<QueueTask[]> {
@@ -158,9 +137,8 @@ async function claim(n: number): Promise<QueueTask[]> {
     ...(TASK_FILTER ? { task: TASK_FILTER } : {}),
   });
   if (!ok) {
-    // A credential problem is not transient, and polling through it looks like a healthy
-    // worker that never picks anything up — the worst shape for an operator to debug. Exit
-    // instead, so a supervisor restarts it and the failure is visible where it happened.
+    // A credential problem is not transient, and polling through it looks like a healthy idle
+    // worker. Exit, so a supervisor restarts it visibly.
     if (status === 401 || status === 403) {
       console.error(
         `claim rejected (${status}): ${JSON.stringify(data)}\n` +
@@ -169,9 +147,7 @@ async function claim(n: number): Promise<QueueTask[]> {
       );
       process.exit(1);
     }
-    // status 0 is "never reached the server" (see call): a restart, a rolling deploy, a
-    // network blip. Not an error to act on — the next poll clears it — so it is reported once
-    // and then waited out.
+    // status 0 (see call): a restart or blip the next poll clears, so it is reported once.
     if (status === 0) {
       if (serverReachable) {
         serverReachable = false;
@@ -197,10 +173,8 @@ async function release(token: string): Promise<void> {
   if (!ok) console.error(`release failed: ${JSON.stringify(data)}`);
 }
 
-/** answer submits the outcome. A refusal is NOT retried with a different one: the definition
- *  declared a contract this worker does not satisfy (an undeclared code, a payload that does
- *  not fit `raises`), and guessing again would only pick a second wrong answer. Release it, so
- *  the task returns to the queue and an operator sees it waiting rather than silently gone. */
+/** A refused outcome is not retried with another: the worker does not satisfy the declared
+ *  contract. Released, so an operator sees the task waiting rather than gone. */
 async function answer(token: string, outcome: Record<string, unknown>): Promise<void> {
   const { ok, data } = await call("/api/external-tasks/resolve", { token, ...outcome });
   if (ok) return;
@@ -231,18 +205,15 @@ async function run(job: QueueTask, signal: AbortSignal): Promise<void> {
   try {
     result = await evaluate(req, signal);
   } catch (err) {
-    // Cancelled is not a fault: the process was stopped while this ran. The claim still goes
-    // back — the row is terminal, so nothing re-claims it, and the release is what stops it
-    // waiting out a lease nobody is serving.
+    // Cancelled is not a fault. Still released: the row is terminal so nothing re-claims it,
+    // but the release stops it waiting out a lease nobody serves.
     if (err instanceof Cancelled) {
       console.log(`cancelled: ${job.token}`);
       await release(job.token);
       return;
     }
-    // The RUNNER faulted, not the script — the one class where a retry can help. There is no
-    // error code for it on purpose: releasing the claim is how a queue spells "retryable", and
-    // it puts the task in front of a different worker instead of burning the definition's
-    // on_error budget on this one's bad day.
+    // The RUNNER faulted, the one retryable class. Releasing is how a queue spells "retryable",
+    // and it reaches another worker without spending the definition's on_error budget.
     console.error(`evaluator fault on ${job.token}: ${err instanceof Error ? err.message : String(err)}`);
     await release(job.token);
     return;
@@ -278,17 +249,13 @@ async function renewLoop(): Promise<void> {
     });
     if (!ok) continue;
 
-    // Cancelled: the process was stopped, so the evaluation is abandoned and the claim handed
-    // back. Aborting first is the point of the list — waiting for the script to finish would
-    // keep burning a core on work an operator has already stopped. The release rides run()'s
-    // own catch, so nothing is released twice.
+    // Abort first rather than let a stopped script burn a core; the release rides run()'s
+    // catch, so nothing is released twice.
     for (const token of (data?.cancelled ?? []) as string[]) {
       inFlight.get(token)?.abort.abort();
     }
-    // Lost: someone else holds this claim now. The work continues and its answer will be
-    // refused — that is not fixable here — but say so, because it is the signal that LEASE_MS
-    // is too short for what these scripts actually take. Deliberately NOT released: the claim
-    // is the new holder's, and releasing would bump the epoch out from under it.
+    // Lost: another worker holds it now and our answer will be refused; logged as the sign that
+    // LEASE_MS is too short. NOT released: that would bump the epoch out from under the holder.
     const lost = (data?.lost ?? []) as string[];
     if (lost.length) {
       console.error(`lost ${lost.length}/${tokens.length} claims; a lease lapsed under load`);