omp-conductor 0.16.1 → 0.17.0

package/src/setup-answers.ts

@@ -0,0 +1,135 @@
+import { readFileSync, writeFileSync } from "node:fs";
+import { z } from "zod";
+
+import type { PromptOptions, SelectOptions, TerminalUi, WizardUi } from "./wizard-ui.ts";
+
+const answerFileSchema = z.record(z.string(), z.union([z.string(), z.boolean()]));
+
+export type SetupAnswerValues = Record<string, string | boolean>;
+
+function promptName(title: string, options: PromptOptions): string {
+  return `answer "${options.key}" for "${title}"`;
+}
+
+function requiredAnswer(answers: SetupAnswerValues, title: string, options: PromptOptions): string | boolean {
+  if (!Object.hasOwn(answers, options.key)) {
+    throw new Error(`missing ${promptName(title, options)}; add it to the --answers file`);
+  }
+  return answers[options.key]!;
+}
+
+/** A prompt-free WizardUi backed only by validated answers. */
+export function answersUi(
+  answers: SetupAnswerValues,
+  notify: WizardUi["notify"] = (message) => process.stdout.write(`${message}\n`),
+): TerminalUi {
+  return {
+    notify,
+    close: () => {},
+    async confirm(title, _message, options) {
+      const answer = requiredAnswer(answers, title, options);
+      if (typeof answer !== "boolean") {
+        throw new Error(`${promptName(title, options)} must be a boolean`);
+      }
+      return answer;
+    },
+    async input(title, _placeholder, options) {
+      const answer = requiredAnswer(answers, title, options);
+      if (typeof answer !== "string") {
+        throw new Error(`${promptName(title, options)} must be a string`);
+      }
+      return answer;
+    },
+    async select(title, choices, options) {
+      const answer = requiredAnswer(answers, title, options);
+      if (typeof answer !== "string") {
+        throw new Error(`${promptName(title, options)} must be a listed label`);
+      }
+      if (!choices.some((choice) => choice.label === answer)) {
+        throw new Error(`${promptName(title, options)} must be a listed label`);
+      }
+      return answer;
+    },
+  };
+}
+
+export function loadAnswersFile(path: string): SetupAnswerValues {
+  let raw: string;
+  try {
+    raw = readFileSync(path, "utf8");
+  } catch (err) {
+    throw new Error(`could not read answers file "${path}": ${err instanceof Error ? err.message : String(err)}`);
+  }
+
+  let decoded: unknown;
+  try {
+    decoded = JSON.parse(raw);
+  } catch (err) {
+    throw new Error(`answers file "${path}" is not valid JSON: ${err instanceof Error ? err.message : String(err)}`);
+  }
+  const parsed = answerFileSchema.safeParse(decoded);
+  if (!parsed.success) {
+    throw new Error(`answers file "${path}" must be a JSON object whose values are strings or booleans`);
+  }
+  return parsed.data;
+}
+
+export interface RecordedAnswersUi {
+  ui: TerminalUi;
+  answers: SetupAnswerValues;
+}
+
+type ClosableWizardUi = WizardUi & Partial<Pick<TerminalUi, "close">>;
+
+/** Decorates any driver and records only answers that were actually returned. */
+export function recordingAnswersUi(inner: ClosableWizardUi): RecordedAnswersUi {
+  const answers: SetupAnswerValues = {};
+  return {
+    answers,
+    ui: {
+      notify: (message, type) => inner.notify(message, type),
+      close: (message) => inner.close?.(message),
+      async confirm(title, message, options) {
+        const answer = await inner.confirm(title, message, options);
+        if (answer !== undefined) answers[options.key] = answer;
+        return answer;
+      },
+      async input(title, placeholder, options) {
+        const answer = await inner.input(title, placeholder, options);
+        if (answer !== undefined) answers[options.key] = answer;
+        return answer;
+      },
+      async select(title, choices, options) {
+        const answer = await inner.select(title, choices, options);
+        if (answer !== undefined) answers[options.key] = answer;
+        return answer;
+      },
+    },
+  };
+}
+
+export function saveAnswersFile(path: string, answers: SetupAnswerValues): void {
+  writeFileSync(path, `${JSON.stringify(answers, null, 2)}\n`, "utf8");
+}
+
+/** Turns exhausted scripted stdin into an actionable non-interactive failure. */
+export function guardNonInteractiveUi(inner: TerminalUi): TerminalUi {
+  const exhausted = (title: string, options: PromptOptions): never => {
+    throw new Error(
+      `stdin ended before ${promptName(title, options)}; provide more piped answers or use setup --answers FILE`,
+    );
+  };
+  return {
+    notify: (message, type) => inner.notify(message, type),
+    close: (message) => inner.close(message),
+    async confirm(title, message, options) {
+      return (await inner.confirm(title, message, options)) ?? exhausted(title, options);
+    },
+    async input(title, placeholder, options) {
+      return (await inner.input(title, placeholder, options)) ?? exhausted(title, options);
+    },
+    async select(title, choices, options: SelectOptions) {
+      return (await inner.select(title, choices, options)) ?? exhausted(title, options);
+    },
+  };
+}

package/src/setup-host.ts

@@ -211,6 +211,14 @@ export interface HostRuntimePlan {
    * the installed unit matched.
    */
   installedAction: PlannedWrite<string>["action"];
+  /**
+   * The installed destinations whose live bytes differ from this version's
+   * render — exactly the files the privileged steps would rewrite. `upgrade`
+   * names them after a release that re-rendered a template, and
+   * {@link currentInstall} is `true` iff this list is empty, so the two can
+   * never disagree (#598).
+   */
+  drift: readonly string[];
   /**
    * True when every file the privileged install steps would write is already
    * at its destination with the current bytes. `runHostInstall` uses it to
@@ -1285,18 +1293,27 @@ export function planHostRuntime(
   // nothing to restart. The herdr unit is absent on a host without herdr, and
   // an absent unit that would not be provisioned is nothing to do.
   const installedAction = actionFor(installedPath, serviceContent);
+  // The same comparison as a destination list, so `upgrade` can name the
+  // drifted files and `currentInstall` can never disagree with that list: a
+  // plan is current exactly when no installed destination differs from the
+  // render.
+  const drift: string[] = [];
+  const noteDrift = (path: string, content: string | undefined): void => {
+    if (content !== undefined && actionFor(path, content) !== "keep") drift.push(path);
+  };
+  noteDrift(installedPath, serviceContent);
+  noteDrift(join(unitDir, RECOVER_SERVICE_NAME), recoverUnitContent);
+  noteDrift(recoverScriptInstallPath, recoverScriptContent);
+  if (herdrUnit !== undefined) noteDrift(installedHerdr, herdrUnit.content);
+  // The pane-shell file is a destination like the units: a plan with all
+  // units current but the config merge still pending must not report
+  // "nothing to install" and skip the very write it exists to make.
+  if (herdrConfig !== undefined) noteDrift(herdrConfigPath, herdrConfig.content);
+  // Same for the herdr-conductor config.env: a pending env merge is pending
+  // work, not an already-current install.
+  if (herdrEnv !== undefined) noteDrift(herdrEnvTarget, herdrEnv.content);
   const currentInstall =
-    installedAction === "keep" &&
-    actionFor(join(unitDir, RECOVER_SERVICE_NAME), recoverUnitContent) === "keep" &&
-    actionFor(recoverScriptInstallPath, recoverScriptContent) === "keep" &&
-    (herdrUnit === undefined || actionFor(installedHerdr, herdrUnit.content) === "keep") &&
-    // The pane-shell file is a destination like the units: a re-run with all
-    // units current but the config merge still pending must not report
-    // "nothing to install" and skip the very write the plan exists to make.
-    (herdrConfig === undefined || actionFor(herdrConfigPath, herdrConfig.content) === "keep") &&
-    // Same for the herdr-conductor config.env: pending env merge is pending
-    // work, not an already-current install.
-    (herdrEnv === undefined || actionFor(herdrEnvTarget, herdrEnv.content) === "keep");
+    drift.length === 0;
   return {
     service,
     // The herdr unit and pane-shell config stand and fall together: no herdr, no
@@ -1349,6 +1366,7 @@ export function planHostRuntime(
     cliSource: runtime.cli === undefined ? "plugin" : "global",
     installedPath,
     installedAction,
+    drift,
     currentInstall,
   };
 }

package/src/setup-install.ts

@@ -275,6 +275,7 @@ export async function runHostInstall(
   const outcome = await runPrivileged(plan.steps, ui, {
     ...(deps.privileged === undefined ? {} : { deps: deps.privileged }),
     title: "Install and start the supervised session?",
+    answerKey: "install-host",
     preamble: [
       `Installs ${plan.service.path} as ${installed}, then enables and restarts it.`,
       ...(plan.herdrUnit === undefined
@@ -547,6 +548,7 @@ export async function runGraphInstall(
   const outcome = await runPrivileged([...clones, ...install], ui, {
     ...(options.privileged === undefined ? {} : { deps: options.privileged }),
     title: unitsCurrent ? "Clone the code-graph checkouts and seed them?" : "Clone, install and enable the code-graph timer?",
+    answerKey: `install-code-graph.${project.name}`,
     preamble: [
       `Staged: ${staged.written.join(", ")}.`,
       ...(clones.length === 0

package/src/setup-probe.ts

@@ -402,6 +402,7 @@ export async function probeProse(
   const keep = await ui.confirm(
     `Keep this ${heading}?`,
     "It becomes part of POLICY.md, which the orchestrator re-reads on every tick. You can edit that file afterwards. Declining keeps the stub.",
+    { key: `keep-probe.${name}` },
   );
   // A dismissed prompt is not a yes. `undefined` means the operator walked away.
   if (keep !== true) {