coding-agent-harness 1.0.2 → 1.0.5

package/scripts/lib/preset-engine.mjs

@@ -0,0 +1,494 @@
+import fs from "node:fs";
+import path from "node:path";
+import crypto from "node:crypto";
+import { spawnSync } from "node:child_process";
+import { readJsonSafe, repoRoot, taskContractMarker, toPosix, visualMapFile } from "./core-shared.mjs";
+import { verifyMigrationSession } from "./migration-planner.mjs";
+import { buildPresetAudit, renderPresetTemplate } from "./preset-registry.mjs";
+
+export function resolvePresetInputs(preset, { cliArgs = [], fromSession = "", targetInput = "" } = {}) {
+  const inputs = {};
+  let targetFromInput = "";
+  for (const [name, declaration] of Object.entries(preset.inputs || {})) {
+    const rawValue = inputValue(declaration, { cliArgs, fromSession });
+    if ((rawValue == null || rawValue === "") && declaration.required) {
+      throw new Error(`Missing required preset input ${declaration.flag || name}`);
+    }
+    if (declaration.type === "flag") {
+      inputs[name] = rawValue === true;
+      continue;
+    }
+    if (declaration.type === "json-file") {
+      if (rawValue == null || rawValue === "") {
+        inputs[name] = null;
+        continue;
+      }
+      const filePath = path.resolve(String(rawValue));
+      if (!fs.existsSync(filePath)) throw new Error(`Preset input file not found for ${declaration.flag || name}: ${rawValue}`);
+      let readError = null;
+      const value = readJsonSafe(filePath, null, { onError: (error) => { readError = error; } });
+      if (value === null) throw new Error(`Invalid preset JSON input ${declaration.flag || name}: ${readError?.message || "unknown parse error"}`);
+      if (declaration.validateOperation && value.operation !== declaration.validateOperation) {
+        throw new Error(`${preset.id} preset requires ${declaration.flag || name} operation ${declaration.validateOperation}`);
+      }
+      if (declaration.rejectPlanOnly && value.planOnly) throw new Error(`${preset.id} preset cannot use plan-only session evidence`);
+      if (declaration.requireTarget && (!value.target || !fs.existsSync(value.target))) throw new Error(`Preset input target missing: ${value.target || "(none)"}`);
+      if (declaration.targetFromSession) targetFromInput = value.target || targetFromInput;
+      inputs[name] = { ...value, sourcePath: filePath };
+      continue;
+    }
+    inputs[name] = rawValue == null || rawValue === "" ? declaration.default || "" : String(rawValue);
+  }
+  return {
+    inputs,
+    targetInput: targetFromInput || targetInput,
+  };
+}
+
+export function evaluateTemplateValues(preset, resolvedInputs, { taskId = "", taskTitle = "", moduleKey = "" } = {}) {
+  const computed = computedValues(preset, resolvedInputs);
+  const base = {
+    inputs: resolvedInputs,
+    computed,
+    preset: {
+      id: preset.id,
+      version: String(preset.version),
+      source: preset.source,
+    },
+    task: {
+      id: taskId,
+      title: taskTitle,
+      moduleKey,
+      kind: preset.task?.kind || "general",
+    },
+  };
+  const values = {
+    preset: preset.id,
+    presetVersion: String(preset.version),
+    kind: preset.task?.kind || "general",
+    ...computed,
+  };
+  for (const [name, declaration] of Object.entries(preset.templateValues || {})) {
+    if (Object.prototype.hasOwnProperty.call(declaration, "from")) {
+      values[name] = getPath(base, declaration.from);
+    } else if (Object.prototype.hasOwnProperty.call(declaration, "value")) {
+      values[name] = declaration.value;
+    } else if (Object.prototype.hasOwnProperty.call(declaration, "default")) {
+      values[name] = declaration.default;
+    }
+  }
+  return values;
+}
+
+export function buildPresetContext(preset, { target, taskDir, taskId, taskTitle, resolvedInputs, evaluatedValues }) {
+  const taskRelativeDir = toPosix(path.relative(target.projectRoot, taskDir));
+  const evidenceBundle = presetEvidenceBundle(preset, { target, taskDir, evaluatedValues });
+  const audit = buildPresetAudit(preset, {
+    taskId,
+    targetRoot: target.projectRoot,
+    entrypoint: "newTask",
+  });
+  const context = {
+    kind: evaluatedValues.kind || preset.task?.kind || "general",
+    preset: preset.id,
+    presetVersion: String(preset.version),
+    presetPackage: preset,
+    audit,
+    resolvedInputs,
+    taskId,
+    taskTitle,
+    taskRelativeDir,
+    values: {
+      ...evaluatedValues,
+      evidenceBundle,
+    },
+    migrationTargetLevel: evaluatedValues.migrationTargetLevel || "",
+    migrationAchievedLevel: evaluatedValues.migrationAchievedLevel || "",
+    evidenceBundle,
+  };
+  context.evidenceFiles = generateEvidenceFiles(preset, { target, taskDir, context });
+  const resources = generateResourceFiles(preset, { context });
+  context.resourceFiles = resources.files;
+  context.resourceIndexRows = resources.indexRows;
+  return context;
+}
+
+export function renderPresetTaskTemplate(destination, content, presetContext) {
+  if (!presetContext) return content;
+  let next = String(content);
+  if (destination === "task_plan.md" || destination === "task_plan") {
+    next = renderPresetMetadata(next, presetContext);
+  }
+  const templateKey = {
+    task_plan: "taskPlanAppend",
+    "task_plan.md": "taskPlanAppend",
+    execution_strategy: "executionStrategyAppend",
+    "execution_strategy.md": "executionStrategyAppend",
+    findings: "findingsSeed",
+    "findings.md": "findingsSeed",
+    review: "reviewSeed",
+    "review.md": "reviewSeed",
+    [visualMapFile]: "visualMapAppend",
+  }[destination];
+  const templatePath = presetContext.presetPackage?.newTaskTemplates?.[templateKey];
+  if (templatePath) {
+    next = `${next.trimEnd()}\n\n${renderPresetTemplate(presetContext.presetPackage, templatePath, presetContext.values).trimEnd()}\n`;
+  }
+  if (destination === "task_plan.md" || destination === "task_plan") {
+    next = appendPresetRequiredReads(next, presetContext);
+  }
+  return next;
+}
+
+export function renderPresetResourceIndex(content, kind, rows) {
+  if (!rows.length) return content;
+  const renderedRows = rows.map((row) => kind === "references"
+    ? `| ${markdownTableCell(row.id)} | ${markdownTableCell(row.type || "preset")} | ${markdownTableCell(row.path)} | ${markdownTableCell(row.summary)} | ${markdownTableCell(row.usedBy || "coordinator")} |`
+    : `| ${markdownTableCell(row.id)} | ${markdownTableCell(row.type || "preset")} | ${markdownTableCell(row.path)} | ${markdownTableCell(row.summary)} | ${markdownTableCell(row.producedBy || "preset")} |`);
+  const base = String(content || "").trim() ? String(content || "") : presetIndexSkeleton(kind);
+  const lines = base.trimEnd().split(/\r?\n/);
+  const separatorIndex = lines.findIndex((line) => /^\|\s*---/.test(line));
+  if (separatorIndex >= 0) {
+    lines.splice(separatorIndex + 1, 0, ...renderedRows);
+    return `${lines.join("\n")}\n`;
+  }
+  return `${String(content || "").trimEnd()}\n${renderedRows.join("\n")}\n`;
+}
+
+export function assertPresetWriteScope(preset, relativePath) {
+  const normalized = toPosix(path.normalize(relativePath));
+  if (normalized.startsWith("../") || path.isAbsolute(normalized)) {
+    throw new Error(`Preset write scope violation for ${relativePath}`);
+  }
+  if (!preset.writeScopes.some((scope) => matchesScope(scope.path, normalized))) {
+    throw new Error(`Preset write scope violation for ${normalized}`);
+  }
+}
+
+function inputValue(declaration, { cliArgs, fromSession }) {
+  if (declaration.flag === "--from-session" && fromSession) return fromSession;
+  if (!declaration.flag) return declaration.default;
+  const index = cliArgs.indexOf(declaration.flag);
+  if (index < 0) return declaration.default;
+  if (declaration.type === "flag") return true;
+  const value = cliArgs[index + 1];
+  if (!value || value.startsWith("--")) return "";
+  return value;
+}
+
+function computedValues(preset, inputs) {
+  const values = {};
+  const migrationSession = Object.values(inputs).find((value) => value && typeof value === "object" && value.operation === "migrate-run");
+  if (migrationSession) {
+    values.migrationTargetLevel = preset.task?.migrationTargetLevel || "migration-baseline";
+    values.migrationAchievedLevel = migrationSession.strictDeferred ? "migration-deferred" : migrationSession.result === "complete" ? "migration-full-cutover" : "migration-baseline";
+    values.strictDeferred = migrationSession.strictDeferred ? "yes" : "no";
+    values.fullCutoverClaimAllowed = values.migrationAchievedLevel === "migration-full-cutover" ? "yes" : "no";
+    values.warnings = migrationSession.plan?.summary?.warnings || 0;
+    values.taskActions = migrationSession.plan?.summary?.taskActions || 0;
+    values.legacyResiduals = migrationSession.plan?.summary?.legacyResiduals || 0;
+    values.generatedAt = migrationSession.generatedAt || "";
+  }
+  return values;
+}
+
+function presetEvidenceBundle(preset, { target, taskDir, evaluatedValues }) {
+  const bundleDir = String(preset.evidence?.bundleDir || "artifacts/preset").trim();
+  const stampSource = evaluatedValues.generatedAt || new Date().toISOString();
+  const stamp = String(stampSource).replace(/[^0-9A-Za-z-]+/g, "-").replace(/-+$/g, "");
+  const relativeTaskDir = toPosix(path.relative(target.projectRoot, taskDir));
+  return toPosix(path.join(relativeTaskDir, bundleDir, stamp || "generated"));
+}
+
+function generateEvidenceFiles(preset, { target, context }) {
+  const files = [];
+  const add = (relativePath, source, content) => {
+    assertPresetWriteScope(preset, relativePath);
+    files.push({ relativePath, source, content });
+  };
+  const evidenceFiles = preset.evidence?.files || {};
+  for (const [name, declaration] of Object.entries(evidenceFiles)) {
+    addEvidenceFile({ name, declaration, preset, target, context, add });
+  }
+  for (const name of preset.audit.evidenceFiles || []) {
+    if (files.some((file) => path.basename(file.relativePath) === name)) continue;
+    addAuditFile({ name, preset, context, add });
+  }
+  return files;
+}
+
+function generateResourceFiles(preset, { context }) {
+  const files = [];
+  const indexRows = { references: [], artifacts: [] };
+  const add = (relativePath, source, content) => {
+    assertPresetWriteScope(preset, relativePath);
+    files.push({ relativePath, source, content });
+  };
+  for (const resource of Object.values(preset.resources?.references || {})) {
+    const relativePath = toPosix(path.join(context.taskRelativeDir, resource.path));
+    add(relativePath, resource.source || resource.template, renderResourceContent(preset, resource, context));
+    indexRows.references.push(renderReferenceIndexRow(resource, relativePath, context.values));
+  }
+  for (const resource of Object.values(preset.resources?.artifacts || {})) {
+    const relativePath = toPosix(path.join(context.taskRelativeDir, resource.path));
+    add(relativePath, resource.source || resource.template, renderResourceContent(preset, resource, context));
+    indexRows.artifacts.push(renderArtifactIndexRow(resource, relativePath, context.values));
+  }
+  return { files, indexRows };
+}
+
+function renderResourceContent(preset, resource, context) {
+  if (resource.template) return renderPresetTemplate(preset, resource.template, context.values);
+  return fs.readFileSync(path.join(preset.directory, resource.source), "utf8");
+}
+
+function renderReferenceIndexRow(resource, relativePath, values) {
+  return {
+    id: resource.index.id,
+    type: renderInline(resource.index.type, values),
+    path: `TARGET:${relativePath}`,
+    summary: renderInline(resource.index.summary, values),
+    usedBy: renderInline(resource.index.usedBy, values),
+  };
+}
+
+function renderArtifactIndexRow(resource, relativePath, values) {
+  return {
+    id: resource.index.id,
+    type: renderInline(resource.index.type, values),
+    path: `TARGET:${relativePath}`,
+    summary: renderInline(resource.index.summary, values),
+    producedBy: renderInline(resource.index.producedBy || "preset", values),
+  };
+}
+
+function appendPresetRequiredReads(content, context) {
+  const requiredReads = context.presetPackage?.context?.requiredReads || [];
+  if (!requiredReads.length) return content;
+  const rowsById = new Map((context.resourceIndexRows?.references || []).map((row) => [row.id, row]));
+  const rows = requiredReads.map((id) => {
+    const row = rowsById.get(id);
+    return `| ${markdownTableCell(id)} | ${markdownTableCell(row?.path || "references/INDEX.md")} | ${markdownTableCell(row?.summary || "Preset-provided reference")} |`;
+  });
+  return `${content.trimEnd()}\n\n## Preset Required Reads\n\nOpen \`references/INDEX.md\`, then read these preset-provided references before implementation.\n\n| Reference | Path | Why |\n| --- | --- | --- |\n${rows.join("\n")}\n`;
+}
+
+function addEvidenceFile({ name, declaration, preset, target, context, add }) {
+  const fileName = declaration.path || `${name}.txt`;
+  const relativePath = toPosix(path.join(context.evidenceBundle, fileName));
+  const type = declaration.type || "text";
+  if (type === "input-json") {
+    add(relativePath, declaration.value || "input-json", `${JSON.stringify(getPath({ inputs: context.resolvedInputs }, declaration.value || ""), null, 2)}\n`);
+  } else if (type === "json") {
+    add(relativePath, declaration.value || "json", `${JSON.stringify(getPath({ inputs: context.resolvedInputs, values: context.values }, declaration.value || ""), null, 2)}\n`);
+  } else if (type === "text") {
+    add(relativePath, declaration.value || "text", `${String(getPath({ inputs: context.resolvedInputs, values: context.values }, declaration.value || "") || "").trim()}\n`);
+  } else if (type === "migration-verify") {
+    const session = migrationSession(context);
+    add(relativePath, "migrate-verify", `${JSON.stringify(verifyMigrationSession(session.sourcePath, { fullCutover: false }), null, 2)}\n`);
+  } else if (type === "migration-ledger") {
+    const session = migrationSession(context);
+    const verifyResult = verifyMigrationSession(session.sourcePath, { fullCutover: false });
+    add(relativePath, "preset-ledger", `${JSON.stringify(migrationLedger({ session, preset, verifyResult }), null, 2)}\n`);
+  } else if (type === "preset-manifest") {
+    add(relativePath, "preset.yaml", `${JSON.stringify(presetManifestSnapshot(preset), null, 2)}\n`);
+  } else if (type === "preset-audit") {
+    add(relativePath, "preset-audit", `${JSON.stringify(context.audit, null, 2)}\n`);
+  } else if (type === "write-scope") {
+    add(relativePath, "preset.yaml", `${JSON.stringify({ preset: preset.id, scopes: preset.writeScopes, entrypointScopes: context.audit.writeScopes }, null, 2)}\n`);
+  } else if (type === "dashboard-hash") {
+    add(relativePath, "dashboard", `${dashboardHash(migrationSession(context).dashboard?.indexPath || "")}\n`);
+  } else if (type === "target-git-status") {
+    add(relativePath, "session.git.after", `${JSON.stringify(migrationSession(context).git?.after || {}, null, 2)}\n`);
+  } else if (type === "target-commit") {
+    add(relativePath, "git", `${targetCommit(target.projectRoot)}\n`);
+  } else if (type === "harness-version") {
+    add(relativePath, "package.json", `${packageVersion()}\n`);
+  } else if (type === "generated-at") {
+    add(relativePath, "generated", `${new Date().toISOString()}\n`);
+  } else {
+    throw new Error(`Unsupported preset evidence type: ${type}`);
+  }
+}
+
+function addAuditFile({ name, preset, context, add }) {
+  const relativePath = toPosix(path.join(context.evidenceBundle, name));
+  if (name === "preset-manifest.json") {
+    add(relativePath, "preset.yaml", `${JSON.stringify(presetManifestSnapshot(preset), null, 2)}\n`);
+  } else if (name === "preset-audit.json") {
+    add(relativePath, "preset-audit", `${JSON.stringify(context.audit, null, 2)}\n`);
+  } else if (name === "write-scope.json") {
+    add(relativePath, "preset.yaml", `${JSON.stringify({ preset: preset.id, scopes: preset.writeScopes, entrypointScopes: context.audit.writeScopes }, null, 2)}\n`);
+  } else {
+    add(relativePath, "preset-audit", `${JSON.stringify({ preset: preset.id, generatedAt: new Date().toISOString() }, null, 2)}\n`);
+  }
+}
+
+function renderPresetMetadata(content, context) {
+  const metadata = [
+    context.kind && context.kind !== "general" ? `Task Kind: ${context.kind}` : "",
+    `Task Preset: ${context.preset}`,
+    `Preset Version: ${context.presetVersion}`,
+    context.migrationTargetLevel ? `Migration Target Level: ${context.migrationTargetLevel}` : "",
+    context.migrationAchievedLevel ? `Migration Achieved Level: ${context.migrationAchievedLevel}` : "",
+    context.evidenceBundle ? `Evidence Bundle: ${context.evidenceBundle}` : "",
+    ...declaredMetadataLines(context),
+  ].filter(Boolean).join("\n");
+  let next = String(content).replace(new RegExp(`^(${escapeRegExp(taskContractMarker)}\\s*)$`, "im"), `$1\n${metadata}`);
+  const outcome = context.presetPackage.task?.defaultOutcome || "";
+  if (outcome) {
+    next = next
+      .replace("[State the outcome this task must deliver in one sentence.]", outcome)
+      .replace("[用一句话说明本任务完成后应达到的状态。]", outcome);
+  }
+  return next;
+}
+
+function declaredMetadataLines(context) {
+  const base = {
+    inputs: context.resolvedInputs || {},
+    values: context.values || {},
+    preset: {
+      id: context.preset,
+      version: context.presetVersion,
+    },
+    task: {
+      id: context.taskId,
+      title: context.taskTitle,
+      kind: context.kind,
+    },
+  };
+  return Object.entries(context.presetPackage?.metadata || {}).map(([name, declaration]) => {
+    const label = declaration.label || name;
+    let value = "";
+    if (Object.prototype.hasOwnProperty.call(declaration, "from")) {
+      value = getPath(base, declaration.from);
+    } else if (Object.prototype.hasOwnProperty.call(declaration, "value")) {
+      value = declaration.value;
+    } else if (Object.prototype.hasOwnProperty.call(declaration, "default")) {
+      value = declaration.default;
+    }
+    return value == null || value === "" ? "" : `${label}: ${value}`;
+  });
+}
+
+function migrationSession(context) {
+  const session = Object.values(context.resolvedInputs || {}).find((value) => value && typeof value === "object" && value.operation === "migrate-run");
+  if (!session) throw new Error("Preset evidence requires migrate-run session input");
+  return session;
+}
+
+function migrationLedger({ session, preset, verifyResult }) {
+  const summary = session.plan?.summary || {};
+  return {
+    schemaVersion: "legacy-migration-ledger/v2",
+    preset: preset.id,
+    presetVersion: preset.version,
+    staticDashboardRole: "evidence-snapshot",
+    workbenchRole: "human-confirmation-control-plane",
+    phases: [
+      { id: "baseline", state: verifyResult.status === "pass" ? "done" : "blocked", evidence: ["session.json", "migrate-plan.json", "normal-check.json", "strict-check.json", "migrate-verify.json"] },
+      {
+        id: "mechanical-scaffold",
+        state: "planned",
+        automationAllowed: true,
+        outputPolicy: "May add missing task contract files and placeholders, but must not mark semantic reconstruction complete.",
+        counters: {
+          taskActions: Number(summary.taskActions || 0),
+          reviewSchemaGaps: Number(summary.reviewSchemaGaps || 0),
+          legacyReferenceGaps: Number(summary.legacyReferenceGaps || 0),
+        },
+      },
+      {
+        id: "semantic-reconstruction",
+        state: "planned",
+        automationAllowed: false,
+        evidenceLedgerRequired: true,
+        requiredEvidenceSources: ["task_plan.md", "progress.md", "review.md", "walkthrough", "Harness-Ledger", "git"],
+        completionRule: "Each task needs explicit evidenceSources and reviewState before semantic completion.",
+      },
+      { id: "cutover-review", state: "planned", humanConfirmationRequired: true, workbenchQueueRequired: true, staticDashboardRole: "evidence-snapshot" },
+    ],
+    counters: {
+      warnings: Number(summary.warnings || 0),
+      taskActions: Number(summary.taskActions || 0),
+      reviewSchemaGaps: Number(summary.reviewSchemaGaps || 0),
+      legacyReferenceGaps: Number(summary.legacyReferenceGaps || 0),
+      legacyResiduals: Number(summary.legacyResiduals || 0),
+      fullCutoverEligible: summary.fullCutoverEligible === true,
+    },
+    queue: [],
+  };
+}
+
+function presetManifestSnapshot(preset) {
+  return {
+    id: preset.id,
+    version: preset.version,
+    manifestPath: preset.manifestRelativePath,
+    manifestSha256: preset.manifestSha256,
+    compatibleBudgets: preset.compatibleBudgets,
+    entrypoints: preset.entrypoints,
+    audit: preset.audit,
+    writeScopes: preset.writeScopes,
+    inputs: preset.inputs,
+    templateValues: preset.templateValues,
+    metadata: preset.metadata,
+    resources: preset.resources,
+    context: preset.context,
+  };
+}
+
+function matchesScope(scope, relativePath) {
+  const normalizedScope = toPosix(String(scope || ""));
+  if (normalizedScope.endsWith("/**")) {
+    const prefix = normalizedScope.slice(0, -3);
+    return relativePath === prefix || relativePath.startsWith(`${prefix}/`);
+  }
+  return relativePath === normalizedScope;
+}
+
+function dashboardHash(indexPath) {
+  if (!indexPath || !fs.existsSync(indexPath)) return "missing";
+  return `sha256:${crypto.createHash("sha256").update(fs.readFileSync(indexPath)).digest("hex")}`;
+}
+
+function targetCommit(projectRoot) {
+  const result = spawnSync("git", ["-C", projectRoot, "rev-parse", "HEAD"], { encoding: "utf8" });
+  return result.status === 0 ? result.stdout.trim() : "n/a";
+}
+
+function packageVersion() {
+  try {
+    return readJsonSafe(path.join(repoRoot, "package.json"), {}).version || "unknown";
+  } catch {
+    return "unknown";
+  }
+}
+
+function getPath(values, key) {
+  if (!key) return values;
+  return String(key).split(".").reduce((cursor, part) => (cursor && Object.prototype.hasOwnProperty.call(cursor, part) ? cursor[part] : undefined), values);
+}
+
+function renderInline(value, values) {
+  return String(value || "").replace(/\{\{\s*([A-Za-z0-9_.-]+)\s*\}\}/g, (_match, key) => {
+    const result = getPath(values, key);
+    return result == null ? "" : String(result);
+  });
+}
+
+function markdownTableCell(value) {
+  return String(value || "").replace(/\r?\n/g, " ").replaceAll("|", "&#124;").trim();
+}
+
+function presetIndexSkeleton(kind) {
+  if (kind === "references") {
+    return "# References Index\n\n| ID | Type | Path | Summary | Used By |\n| --- | --- | --- | --- | --- |\n";
+  }
+  return "# Artifacts Index\n\n| ID | Type | Path | Summary | Produced By |\n| --- | --- | --- | --- | --- |\n";
+}
+
+function escapeRegExp(value) {
+  return String(value).replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+}