@genroc/eval-node 0.0.0-edge.121ed09 → 0.0.0-edge.24a07d0

package/dist/import.js

@@ -7,9 +7,10 @@
 // code; "build" typechecks and bundles. A separate types hook would mean a second `tsc`
 // over the same project.
 import { spawn } from "node:child_process";
+import { existsSync } from "node:fs";
 import { access, mkdir, writeFile } from "node:fs/promises";
 import { builtinModules } from "node:module";
-import { dirname, join, relative } from "node:path";
+import { dirname, join, relative, resolve } from "node:path";
 import { fileURLToPath } from "node:url";
 import commonjs from "@rollup/plugin-commonjs";
 import json from "@rollup/plugin-json";
@@ -112,21 +113,14 @@ function deref(s, defs) {
     }
     return cur;
 }
-/** The manifest's `input` is the type of the whole ACTION input — for /eval that is
- *  `{code, input, timeout_ms, …}`, and only its `input` field is bound as the script's
- *  parameter. genroc cannot know that; this file owns the evaluator's wire contract, so
- *  the navigation belongs here rather than in genctl. */
-function scriptInput(site, defs) {
-    const action = deref(site.input, defs);
-    const bound = action?.properties?.input;
-    return bound ?? site.input;
-}
 /** Emits one named type per reachable $def rather than inlining: a task output may
  *  reference itself (specs/recursive-type-inference.md) and inlining would not terminate. */
-function declarations(site, defs) {
+function declarations(at) {
+    const { site, where } = at;
+    const defs = where.$defs ?? {};
     const used = new Set();
-    const input = tsType(scriptInput(site, defs), used);
-    const output = tsType(site.output, used);
+    const input = tsType(site.types?.Input, used);
+    const output = tsType(site.types?.Output, used);
     const emitted = [];
     const done = new Set();
     while (true) {
@@ -139,7 +133,7 @@ function declarations(site, defs) {
     }
     return [
         "// Generated by genroc. Do not edit - regenerate with `genctl types`.",
-        `// ${site.process}${site.task ? ` / ${site.task}` : ""}  (${site.pointer})`,
+        `// ${where.name}  (${address(site.pointer)})`,
         "",
         ...emitted,
         emitted.length ? "" : "",
@@ -167,7 +161,7 @@ async function nearestTsconfig(from, root) {
             return null;
     }
 }
-async function typecheck(root, sites) {
+async function typecheck(sites) {
     // NOT `.genroc`: that is the project config FILE, and a directory of the same name cannot
     // coexist with it. The suffix is what keeps the scratch area out of its way.
     const dir = join(root, ".genroc-cache");
@@ -175,13 +169,13 @@ async function typecheck(root, sites) {
     // One tsc per distinct base config: `extends` takes a single base, so merging two would
     // check each script under the other author's options.
     const groups = new Map();
-    for (const site of sites) {
-        const base = (await nearestTsconfig(dirname(site.path), root)) ?? "";
+    for (const at of sites) {
+        const base = (await nearestTsconfig(dirname(at.file), root)) ?? "";
         const group = groups.get(base);
         if (group)
-            group.push(site);
+            group.push(at);
         else
-            groups.set(base, [site]);
+            groups.set(base, [at]);
     }
     let n = 0;
     for (const [base, group] of groups) {
@@ -203,8 +197,8 @@ async function typecheck(root, sites) {
                 ...(base ? {} : { types: [] }),
             },
             files: group.flatMap((s) => [
-                relative(dir, s.path),
-                relative(dir, typesPathFor(s.path)),
+                relative(dir, s.file),
+                relative(dir, typesPathFor(s.file)),
             ]),
             // `files` overrides the base's, but a base `include` survives beside it and would
             // drag the author's whole tree in, to be checked under the worker lib.
@@ -287,15 +281,16 @@ function tsResolve(configPath) {
 /** 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. */
-async function bundle(site, root) {
+async function bundle(at) {
+    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.
     const built = await rollup({
-        input: site.path,
+        input: at.file,
         external: (id) => BUILTIN.has(id),
         plugins: [
-            tsResolve(await nearestTsconfig(dirname(site.path), root)),
+            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
@@ -305,10 +300,10 @@ async function bundle(site, root) {
         ],
         onwarn(warning) {
             if (warning.code === "UNRESOLVED_IMPORT") {
-                die(`${site.path}: cannot resolve ${warning.exporter ?? "an import"} — is it installed?`);
+                die(`${at.file}: cannot resolve ${warning.exporter ?? "an import"} — is it installed?`);
             }
         },
-    }).catch((e) => die(`${site.path}: ${e instanceof Error ? e.message : String(e)}`));
+    }).catch((e) => die(`${at.file}: ${e instanceof Error ? e.message : String(e)}`));
     const { output } = await built.generate({
         format: "es",
         inlineDynamicImports: true,
@@ -317,7 +312,7 @@ async function bundle(site, root) {
     // Refused here rather than in the realm: the evaluator can only report it against a running
     // instance, and the file it names is on this machine.
     if (!output[0].exports.includes("default")) {
-        die(`${site.path}: a script must \`export default\` the function to run`);
+        die(`${at.file}: a script must \`export default\` the function to run`);
     }
     return output[0].code;
 }
@@ -330,32 +325,73 @@ const stdin = await new Promise((resolve, reject) => {
     process.stdin.on("error", reject);
 });
 const manifest = JSON.parse(stdin);
-if (!manifest || !Array.isArray(manifest.sites))
+// genctl runs a resolver with the project root as its cwd, so the manifest need not say so.
+const root = process.cwd();
+if (!manifest || !Array.isArray(manifest.processes))
     die("stdin is not a genroc resolver manifest");
+/** A pointer as the address it is, so a generated comment or an error can be pasted into
+ *  `genctl schema`. A key no identifier can spell is bracketed, as the grammar spells it. */
+function address(pointer) {
+    return pointer
+        .map((seg) => typeof seg === "string" && /^[A-Za-z_][A-Za-z0-9_]*$/.test(seg)
+        ? `.${seg}`
+        : `[${JSON.stringify(seg)}]`)
+        .join("")
+        .replace(/^\./, "");
+}
+const located = manifest.processes.flatMap((where) => where.sites.map((site) => ({
+    site,
+    where,
+    file: resolve(where.dir, site.argument),
+})));
+// 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.
+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.
+    const kind = at.site.action ?? "";
+    const slot = at.site.pointer.slice(-2).join(".");
+    if ((kind !== "child" && kind !== "external") || slot !== "input.code") {
+        die(`${join(at.where.dir, at.where.file)}: ${address(at.site.pointer)}: an evaluated script ` +
+            "belongs in the `code` field of a child or external task's input, and this is " +
+            `${kind ? `a ${kind} task's ` : ""}\`${slot}\`.`);
+    }
+}
+// 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.
+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})`);
+    }
+}
 // One script at two sites with different input types is a refusal, not a union: the union
 // is sound and would typecheck a body that is wrong at one of the sites.
 const byPath = new Map();
-for (const site of manifest.sites) {
-    const seen = byPath.get(site.path);
-    const defsOf = (x) => (manifest.schemas[x.process]?.$defs ?? {});
+for (const at of located) {
+    const seen = byPath.get(at.file);
     if (seen &&
-        JSON.stringify(scriptInput(seen, defsOf(seen))) !==
-            JSON.stringify(scriptInput(site, defsOf(site)))) {
-        die(`${site.path} is imported at ${seen.pointer} and ${site.pointer} with different input types.\n` +
+        JSON.stringify(seen.site.types) !== JSON.stringify(at.site.types)) {
+        die(`${at.file} is imported at ${address(seen.site.pointer)} and ` +
+            `${address(at.site.pointer)} with different input types.\n` +
             "Split it into two scripts, or make the two call sites pass the same shape.");
     }
-    byPath.set(site.path, site);
+    byPath.set(at.file, at);
 }
-for (const site of byPath.values()) {
-    const defs = (manifest.schemas[site.process]?.$defs ?? {});
-    await write(typesPathFor(site.path), declarations(site, defs));
+for (const at of byPath.values()) {
+    await write(typesPathFor(at.file), declarations(at));
 }
 if (manifest.mode === "types") {
+    console.log(JSON.stringify(manifest, null, 2));
     process.exit(0);
 }
-await typecheck(manifest.root, [...byPath.values()]);
+await typecheck([...byPath.values()]);
 const code = [];
-for (const site of manifest.sites) {
-    code.push(await bundle(site, manifest.root));
+for (const at of located) {
+    code.push(await bundle(at));
 }
 process.stdout.write(JSON.stringify({ code }));

package/import.ts

@@ -8,9 +8,10 @@
 // over the same project.
 
 import { spawn } from "node:child_process";
+import { existsSync } from "node:fs";
 import { access, mkdir, writeFile } from "node:fs/promises";
 import { builtinModules } from "node:module";
-import { dirname, join, relative } from "node:path";
+import { dirname, join, relative, resolve } from "node:path";
 import { fileURLToPath } from "node:url";
 
 import commonjs from "@rollup/plugin-commonjs";
@@ -22,20 +23,35 @@ import ts from "typescript";
 type Schema = Record<string, any>;
 
 type Site = {
-  resolver: string;
-  process: string;
   task?: string;
-  pointer: string;
-  path: string;
-  input?: Schema;
-  output?: Schema;
+  // What the site IS: the task's action type, and the process a child action calls.
+  action?: string;
+  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;
+  // 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>;
+};
+
+type ManifestProcess = {
+  name: string;
+  // The definition's own location, split because a relative argument is relative to the
+  // DIRECTORY — joining is ours to do, and this is the base.
+  dir: string;
+  file: string;
+  sites: Site[];
+  // Only what this process's fragments reach — a `$ref` in `types` points here.
+  $defs?: Record<string, Schema>;
 };
 
 type Manifest = {
   mode: "types" | "build";
   root: string;
-  schemas: Record<string, Schema>;
-  sites: Site[];
+  processes: ManifestProcess[];
 };
 
 function die(message: string): never {
@@ -150,25 +166,14 @@ function deref(
   return cur;
 }
 
-/** The manifest's `input` is the type of the whole ACTION input — for /eval that is
- *  `{code, input, timeout_ms, …}`, and only its `input` field is bound as the script's
- *  parameter. genroc cannot know that; this file owns the evaluator's wire contract, so
- *  the navigation belongs here rather than in genctl. */
-function scriptInput(
-  site: Site,
-  defs: Record<string, Schema>,
-): Schema | undefined {
-  const action = deref(site.input, defs);
-  const bound = action?.properties?.input;
-  return bound ?? site.input;
-}
-
 /** Emits one named type per reachable $def rather than inlining: a task output may
  *  reference itself (specs/recursive-type-inference.md) and inlining would not terminate. */
-function declarations(site: Site, defs: Record<string, Schema>): string {
+function declarations(at: Located): string {
+  const { site, where } = at;
+  const defs = where.$defs ?? {};
   const used = new Set<string>();
-  const input = tsType(scriptInput(site, defs), used);
-  const output = tsType(site.output, used);
+  const input = tsType(site.types?.Input, used);
+  const output = tsType(site.types?.Output, used);
 
   const emitted: string[] = [];
   const done = new Set<string>();
@@ -182,7 +187,7 @@ function declarations(site: Site, defs: Record<string, Schema>): string {
 
   return [
     "// Generated by genroc. Do not edit - regenerate with `genctl types`.",
-    `// ${site.process}${site.task ? ` / ${site.task}` : ""}  (${site.pointer})`,
+    `// ${where.name}  (${address(site.pointer)})`,
     "",
     ...emitted,
     emitted.length ? "" : "",
@@ -215,7 +220,7 @@ async function nearestTsconfig(
   }
 }
 
-async function typecheck(root: string, sites: Site[]): Promise<void> {
+async function typecheck(sites: Located[]): Promise<void> {
   // NOT `.genroc`: that is the project config FILE, and a directory of the same name cannot
   // coexist with it. The suffix is what keeps the scratch area out of its way.
   const dir = join(root, ".genroc-cache");
@@ -223,12 +228,12 @@ async function typecheck(root: string, sites: Site[]): Promise<void> {
 
   // One tsc per distinct base config: `extends` takes a single base, so merging two would
   // check each script under the other author's options.
-  const groups = new Map<string, Site[]>();
-  for (const site of sites) {
-    const base = (await nearestTsconfig(dirname(site.path), root)) ?? "";
+  const groups = new Map<string, Located[]>();
+  for (const at of sites) {
+    const base = (await nearestTsconfig(dirname(at.file), root)) ?? "";
     const group = groups.get(base);
-    if (group) group.push(site);
-    else groups.set(base, [site]);
+    if (group) group.push(at);
+    else groups.set(base, [at]);
   }
 
   let n = 0;
@@ -251,8 +256,8 @@ async function typecheck(root: string, sites: Site[]): Promise<void> {
         ...(base ? {} : { types: [] }),
       },
       files: group.flatMap((s) => [
-        relative(dir, s.path),
-        relative(dir, typesPathFor(s.path)),
+        relative(dir, s.file),
+        relative(dir, typesPathFor(s.file)),
       ]),
       // `files` overrides the base's, but a base `include` survives beside it and would
       // drag the author's whole tree in, to be checked under the worker lib.
@@ -351,15 +356,16 @@ 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. */
-async function bundle(site: Site, root: string): Promise<string> {
+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.
   const built = await rollup({
-    input: site.path,
+    input: at.file,
     external: (id) => BUILTIN.has(id),
     plugins: [
-      tsResolve(await nearestTsconfig(dirname(site.path), root)),
+      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
@@ -370,12 +376,12 @@ async function bundle(site: Site, root: string): Promise<string> {
     onwarn(warning) {
       if (warning.code === "UNRESOLVED_IMPORT") {
         die(
-          `${site.path}: cannot resolve ${warning.exporter ?? "an import"} — is it installed?`,
+          `${at.file}: cannot resolve ${warning.exporter ?? "an import"} — is it installed?`,
         );
       }
     },
   }).catch((e: unknown) =>
-    die(`${site.path}: ${e instanceof Error ? e.message : String(e)}`),
+    die(`${at.file}: ${e instanceof Error ? e.message : String(e)}`),
   );
 
   const { output } = await built.generate({
@@ -386,7 +392,7 @@ async function bundle(site: Site, root: string): Promise<string> {
   // Refused here rather than in the realm: the evaluator can only report it against a running
   // instance, and the file it names is on this machine.
   if (!output[0].exports.includes("default")) {
-    die(`${site.path}: a script must \`export default\` the function to run`);
+    die(`${at.file}: a script must \`export default\` the function to run`);
   }
   return output[0].code;
 }
@@ -401,45 +407,99 @@ const stdin: string = await new Promise((resolve, reject) => {
   process.stdin.on("error", reject);
 });
 const manifest = JSON.parse(stdin) as Manifest;
-if (!manifest || !Array.isArray(manifest.sites))
+// genctl runs a resolver with the project root as its cwd, so the manifest need not say so.
+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. */
+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
+ *  `genctl schema`. A key no identifier can spell is bracketed, as the grammar spells it. */
+function address(pointer: (string | number)[]): string {
+  return pointer
+    .map((seg) =>
+      typeof seg === "string" && /^[A-Za-z_][A-Za-z0-9_]*$/.test(seg)
+        ? `.${seg}`
+        : `[${JSON.stringify(seg)}]`,
+    )
+    .join("")
+    .replace(/^\./, "");
+}
+const located: Located[] = manifest.processes.flatMap((where) =>
+  where.sites.map((site) => ({
+    site,
+    where,
+    file: resolve(where.dir, site.argument),
+  })),
+);
+
+// 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.
+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.
+  const kind = at.site.action ?? "";
+  const slot = at.site.pointer.slice(-2).join(".");
+  if ((kind !== "child" && kind !== "external") || slot !== "input.code") {
+    die(
+      `${join(at.where.dir, at.where.file)}: ${address(at.site.pointer)}: an evaluated script ` +
+        "belongs in the `code` field of a child or external task's input, and this is " +
+        `${kind ? `a ${kind} task's ` : ""}\`${slot}\`.`,
+    );
+  }
+}
+
+// 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.
+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})`,
+    );
+  }
+}
+
 // One script at two sites with different input types is a refusal, not a union: the union
 // is sound and would typecheck a body that is wrong at one of the sites.
-const byPath = new Map<string, Site>();
-for (const site of manifest.sites) {
-  const seen = byPath.get(site.path);
-  const defsOf = (x: Site) =>
-    (manifest.schemas[x.process]?.$defs ?? {}) as Record<string, Schema>;
+const byPath = new Map<string, Located>();
+for (const at of located) {
+  const seen = byPath.get(at.file);
   if (
     seen &&
-    JSON.stringify(scriptInput(seen, defsOf(seen))) !==
-      JSON.stringify(scriptInput(site, defsOf(site)))
+    JSON.stringify(seen.site.types) !== JSON.stringify(at.site.types)
   ) {
     die(
-      `${site.path} is imported at ${seen.pointer} and ${site.pointer} with different input types.\n` +
+      `${at.file} is imported at ${address(seen.site.pointer)} and ` +
+        `${address(at.site.pointer)} with different input types.\n` +
         "Split it into two scripts, or make the two call sites pass the same shape.",
     );
   }
-  byPath.set(site.path, site);
+  byPath.set(at.file, at);
 }
 
-for (const site of byPath.values()) {
-  const defs = (manifest.schemas[site.process]?.$defs ?? {}) as Record<
-    string,
-    Schema
-  >;
-  await write(typesPathFor(site.path), declarations(site, defs));
+for (const at of byPath.values()) {
+  await write(typesPathFor(at.file), declarations(at));
 }
 
 if (manifest.mode === "types") {
+  console.log(JSON.stringify(manifest, null, 2));
   process.exit(0);
 }
 
-await typecheck(manifest.root, [...byPath.values()]);
+await typecheck([...byPath.values()]);
 
 const code: string[] = [];
-for (const site of manifest.sites) {
-  code.push(await bundle(site, manifest.root));
+for (const at of located) {
+  code.push(await bundle(at));
 }
 process.stdout.write(JSON.stringify({ code }));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@genroc/eval-node",
-  "version": "0.0.0-edge.121ed09",
+  "version": "0.0.0-edge.24a07d0",
   "type": "module",
   "engines": {
     "node": ">=24"