@intentius/chant 0.19.1 → 0.20.0

package/src/discovery/sandbox/run.ts

@@ -0,0 +1,196 @@
+import { fork } from "node:child_process";
+import { realpathSync, rmSync } from "node:fs";
+import { resolve } from "node:path";
+import type { Declarable } from "../../declarable";
+import { DiscoveryError, type DiscoveryErrorType } from "../../errors";
+import { decodeEntitySet, type EntitySetWire } from "../entity-wire-codec";
+import { bundleDriver } from "./bundle";
+import { classifyChildError } from "./child-errors";
+import { generateDriverSource } from "./driver";
+
+/**
+ * chant #1045 Phase 2 — runs every run-fallback file for a build TOGETHER, as
+ * one bundled module graph, inside one sandboxed child process, and returns
+ * the same shape `discover()`'s own in-process run path would have produced:
+ * a named, ref-resolved entities map plus any errors.
+ *
+ * Isolation mechanics (verified on Node v24.13.1 — see the chant#1045 PR
+ * description for the full write-up):
+ *  - `--permission --allow-fs-read=<bundle dir>,<project dir>[,<trusted
+ *    external package dirs>]` — no filesystem write, no child-process, no
+ *    worker-thread access. Bundling with esbuild first (not a packaging
+ *    change — see `./bundle.ts`) means the child needs NO TypeScript loader
+ *    (no `tsx`, so no `--allow-worker` and no writable temp dir either),
+ *    unlike the plain `tsx`-based run path. The "trusted external package
+ *    dirs" allowance is narrow and specific: `./bundle.ts` deliberately
+ *    leaves a couple of chant/lexicon-internal dependencies (`typescript`)
+ *    unbundled and resolves them to their real, fixed location instead —
+ *    project source never controls what's installed there.
+ *  - The env is a spawn-time scrub (`env: {}` below, plus `PATH` — see the
+ *    option below), not `--permission`: Node's Permission Model does not gate
+ *    `process.env` at all (confirmed: every key stays readable even under
+ *    `--permission`).
+ *  - Network egress is NOT addressed here — Node has no flag for it. See the
+ *    chant#1045 PR description / docs for the residual-risk statement and
+ *    deployment guidance (a container with no egress, a network namespace).
+ *    This function does not claim to close that gap.
+ *
+ * What does NOT run inside the child: fold (`tryFoldFile`, `../fold-import`)
+ * stays exactly where it is today, in the parent, unsandboxed — fold already
+ * executes zero of the file's own top-level code (chant #1022/#1023), so
+ * isolating it buys nothing and would only cost a bundle+spawn per build.
+ * Only genuine run-fallback files are handed to this function.
+ */
+
+export interface SandboxRunResult {
+  /** Named, ref-resolved entities from the run-fallback set — decoded from the child's `EntitySetWire` response, functionally indistinguishable from what `importModule` + `collectEntities` + `resolveAttrRefs` would have produced in-process for this same file set (see `../entity-wire.ts`'s `decodeEntitySet` doc). */
+  entities: Map<string, Declarable>;
+  /** Import/collection/resolution/permission errors, already chant-shaped (see `./child-errors.ts` — a permission denial names the file and the operation, never a raw `ERR_ACCESS_DENIED`). */
+  errors: DiscoveryError[];
+  /** esbuild bundling wall-clock time — chant#1045 asks this be measured, not silently accepted. */
+  bundleMs: number;
+  /** Bundle size in bytes. */
+  bundleBytes: number;
+  /**
+   * Entity name → declaring file, for every entity in {@link entities} whose
+   * provenance (`../../provenance.ts`) named one. The wire format itself
+   * doesn't carry this (`encodeEntitySet` intentionally drops build metadata,
+   * not declared configuration) — it rides back as a small side channel so a
+   * parent-side merge collision against the fold-only set (a bare name
+   * genuinely exported by both a folded and a run-fallback file in the same
+   * directory) can name the real file, not the entity name. See `../index.ts`.
+   */
+  provenanceByName: Record<string, string>;
+}
+
+interface ChildResponse {
+  entitySet: EntitySetWire;
+  errors: Array<{ name: string; file: string; message: string; type: DiscoveryErrorType }>;
+  provenanceByName?: Record<string, string>;
+  fatal?: boolean;
+}
+
+/** How long to wait for the sandboxed child to report back before treating it as hung and killing it. Generous: bundling+import+collect for a whole build's run-fallback set should be a small multiple of what the equivalent in-process run takes. */
+const CHILD_TIMEOUT_MS = 120_000;
+
+function isChildResponse(value: unknown): value is ChildResponse {
+  return typeof value === "object" && value !== null && "entitySet" in value && "errors" in value;
+}
+
+/**
+ * Run `files` (already decided "run" by `discover()`'s fold/taint pass)
+ * together, isolated, in one sandboxed child process. Returns the same
+ * `{ entities, errors }` shape the parent's own `collectEntities` +
+ * `resolveAttrRefs` would have — see `../index.ts`'s `discover()`, which
+ * merges this result into the entities it collected from folded files.
+ *
+ * @param files - Absolute paths to run-fallback files.
+ * @param buildRoot - The directory `discover()` was pointed at — threaded to
+ *   `collectEntities` inside the child (stack-prefix disambiguation, #932)
+ *   and used to compute the project-directory read allowance.
+ */
+export async function runFallbackFilesSandboxed(
+  files: readonly string[],
+  buildRoot: string,
+): Promise<SandboxRunResult> {
+  if (files.length === 0) {
+    return { entities: new Map(), errors: [], bundleMs: 0, bundleBytes: 0, provenanceByName: {} };
+  }
+
+  const driverSource = generateDriverSource({ files, buildRoot });
+  const { bundlePath, bundleDir, externalReadPaths, durationMs, bytes } = await bundleDriver(driverSource);
+
+  try {
+    let projectRealpath: string;
+    try {
+      projectRealpath = realpathSync(resolve(buildRoot));
+    } catch {
+      projectRealpath = resolve(buildRoot);
+    }
+
+    const response = await runChildProcess(bundlePath, bundleDir, projectRealpath, externalReadPaths);
+
+    const errors = (response.errors ?? []).map(
+      (e) => new DiscoveryError(e.file, e.message, e.type),
+    );
+    const provenanceByName = response.provenanceByName ?? {};
+    if (response.fatal) {
+      return { entities: new Map(), errors, bundleMs: durationMs, bundleBytes: bytes, provenanceByName };
+    }
+    const entities = decodeEntitySet(response.entitySet ?? { entities: [] });
+    return { entities, errors, bundleMs: durationMs, bundleBytes: bytes, provenanceByName };
+  } catch (err) {
+    return {
+      entities: new Map(),
+      errors: [classifyChildError("", err, "import")],
+      provenanceByName: {},
+      bundleMs: durationMs,
+      bundleBytes: bytes,
+    };
+  } finally {
+    rmSync(bundleDir, { recursive: true, force: true });
+  }
+}
+
+/** Fork the bundle under `--permission`, with a scrubbed environment, and resolve with its one IPC message (or reject on crash/timeout/fork error). */
+function runChildProcess(
+  bundlePath: string,
+  bundleDir: string,
+  projectRealpath: string,
+  externalReadPaths: readonly string[],
+): Promise<ChildResponse> {
+  return new Promise((resolvePromise, reject) => {
+    const readAllowances = [bundleDir, projectRealpath, ...externalReadPaths].map(
+      (p) => `--allow-fs-read=${p}`,
+    );
+    const child = fork(bundlePath, [], {
+      execArgv: ["--permission", ...readAllowances],
+      // chant #1045 Phase 2 — Node's Permission Model does not gate
+      // `process.env`; scrubbing it here is the only way to keep the ambient
+      // environment out of untrusted project source's reach. `PATH` is kept
+      // only because some platforms' module resolution/dynamic linking
+      // consults it; it carries no project secrets.
+      env: { PATH: process.env.PATH ?? "" },
+      stdio: ["ignore", "pipe", "pipe", "ipc"],
+    });
+
+    let settled = false;
+    let stderrBuf = "";
+
+    const timeout = setTimeout(() => {
+      if (settled) return;
+      settled = true;
+      child.kill();
+      reject(new Error(`sandboxed run timed out after ${CHILD_TIMEOUT_MS}ms`));
+    }, CHILD_TIMEOUT_MS);
+
+    child.stderr?.on("data", (chunk: Buffer) => {
+      stderrBuf += chunk.toString();
+    });
+
+    child.on("message", (msg: unknown) => {
+      if (settled || !isChildResponse(msg)) return;
+      settled = true;
+      clearTimeout(timeout);
+      resolvePromise(msg);
+    });
+
+    child.on("error", (err) => {
+      if (settled) return;
+      settled = true;
+      clearTimeout(timeout);
+      reject(err);
+    });
+
+    child.on("exit", (code, signal) => {
+      if (settled) return;
+      settled = true;
+      clearTimeout(timeout);
+      reject(
+        new Error(
+          `sandboxed child exited before reporting results (code ${code}, signal ${signal})${stderrBuf.trim() ? `: ${stderrBuf.trim()}` : ""}`,
+        ),
+      );
+    });
+  });
+}

package/src/errors.ts

@@ -2,7 +2,15 @@
  * Error types for chant discovery, build, and lint failures
  */
 
-export type DiscoveryErrorType = "import" | "resolution" | "circular";
+/**
+ * `"permission"` (chant #1045 Phase 2) — a run-fallback file executing inside
+ * the sandboxed child (`./discovery/sandbox/`) hit Node's Permission Model
+ * (`ERR_ACCESS_DENIED`) — filesystem, child-process, or worker-thread access
+ * outside the sandbox's allowlist. Distinct from `"import"` (a module simply
+ * failed to load/execute for an ordinary reason) so a permission denial is
+ * recognizable as a sandbox boundary hit, not a generic import failure.
+ */
+export type DiscoveryErrorType = "import" | "resolution" | "circular" | "permission";
 
 /**
  * Error during file discovery or module import