agent-trellis 0.14.1 → 0.15.0

package/dist/lib/workspaceMigrate.js

@@ -0,0 +1,423 @@
+/**
+ * `trellis migrate --workspace`'s scanner + planner (trellis-workspace-
+ * scope tasks 4.1–4.5): inventories every managed agent's project-level
+ * MCP config plus the root `AGENTS.md`, classifies each finding, and
+ * produces a pure plan — no writes anywhere, so `--dry-run` prints the
+ * byte-identical plan a real run would execute.
+ *
+ * Classification (one `action` per item):
+ * - `already-managed`     — the in-repo manifest (`.agents/.trellis-
+ *                           rendered.json`) records Trellis having rendered
+ *                           this entry, or `.agents/` already holds it
+ * - `skip-local`          — a `*.local.*` sibling of a scanned config path;
+ *                           listed, never read (task 4.5)
+ * - `skip-unsupported`    — malformed entry (e.g. stdio without command)
+ * - `extract-secret`      — a reject-pattern literal in `staticEnv`: value
+ *                           goes to the global secret store, the committed
+ *                           `.agents/config.json` only ever gets `${VAR}`
+ * - `identical-to-global` — deep-equal to the global canonical entry;
+ *                           default drop, `--dedup override` imports it as
+ *                           an intentional shadow (task 4.4)
+ * - `conflict`            — same name with differing defs across agents
+ *                           (task 4.3, resolved only by `--choose
+ *                           name=agentId`), or a reject-pattern literal in
+ *                           a field other than `staticEnv` (unlike the
+ *                           global migrate, `.agents/config.json` is
+ *                           COMMITTED — a plaintext literal must never be
+ *                           written into it)
+ * - `create`              — will import into `.agents/`
+ *
+ * Secret handling invariant (task 4.2): no literal secret value ever rides
+ * on a plan item — extraction re-reads the source file at apply time,
+ * exactly like the global migrate's design.md D9.
+ */
+import { execFileSync } from "node:child_process";
+import { existsSync, readFileSync } from "node:fs";
+import { basename, join } from "node:path";
+import { ALL_AGENTS } from "../core/types.js";
+import { loadCanonicalSource } from "../core/canonical.js";
+import { findLiteralSecret } from "../adapters/mcpPlan.js";
+import { fromServerDefYaml } from "../core/mcpServerDef.js";
+import { deepEqual } from "./deepEqual.js";
+import { fromRichJsonServerDef, readRichJsonMcpDefs } from "./mcpMigrateRead.js";
+import { findSection, readServerEnvTable } from "./tomlSection.js";
+import { loadWorkspaceRendered, workspaceMcpConfigPath } from "./workspaceMcp.js";
+import { readWorkspaceConfigJson, workspaceConfigPath, WORKSPACE_AGENTS_MD_TEMPLATE } from "./workspaceConfig.js";
+import { INSTRUCTIONS_MARKER } from "./workspaceFiles.js";
+const VAR_REF_RE = /^\$\{([A-Za-z_][A-Za-z0-9_]*)\}$/;
+/**
+ * Inverse of `renderServerSection` for a project-level `.codex/config.toml`
+ * (task 4.1): no TOML parser dependency exists in this repo (design D2,
+ * trellis-mcp-sync-p2), and the global codex reader shells out to `codex
+ * mcp list --json` — useless for an arbitrary project file. Hand-rolled
+ * against the exact bounded shape `renderServerSection` emits, tolerant of
+ * anything else (unknown keys skipped, malformed lines skipped).
+ */
+const CODEX_SERVER_HEADER_RE = /^\[mcp_servers\.((?:"(?:[^"\\]|\\.)*"|[A-Za-z0-9_-]+))\]\s*$/gm;
+const CODEX_KV_RE = /^([A-Za-z0-9_-]+)\s*=\s*(.+)$/;
+function readCodexTomlMcpDefs(configPath) {
+    const result = { entries: [], unsupported: [] };
+    if (!existsSync(configPath))
+        return result;
+    const content = readFileSync(configPath, "utf-8");
+    for (const match of content.matchAll(CODEX_SERVER_HEADER_RE)) {
+        const segment = match[1];
+        const name = segment.startsWith('"') ? JSON.parse(segment) : segment;
+        const range = findSection(content, `mcp_servers.${segment}`);
+        if (!range)
+            continue;
+        const fields = {};
+        for (const line of content.split("\n").slice(range.start + 1, range.end + 1)) {
+            const kv = CODEX_KV_RE.exec(line.trim());
+            if (!kv)
+                continue;
+            try {
+                fields[kv[1]] = JSON.parse(kv[2]);
+            }
+            catch {
+                // not a JSON-shaped literal (a date, a bare string…) — not a shape
+                // renderServerSection ever emits; skip the key, keep the rest
+            }
+        }
+        let def;
+        if (typeof fields.url === "string") {
+            def = { transport: "http", url: fields.url };
+            if (typeof fields.bearer_token_env_var === "string") {
+                def.headers = { Authorization: `Bearer \${${fields.bearer_token_env_var}}` };
+            }
+        }
+        else if (typeof fields.command === "string") {
+            def = { transport: "stdio", command: fields.command };
+            if (Array.isArray(fields.args) && fields.args.every((a) => typeof a === "string") && fields.args.length > 0) {
+                def.args = fields.args;
+            }
+            if (Array.isArray(fields.env_vars) && fields.env_vars.every((a) => typeof a === "string") && fields.env_vars.length > 0) {
+                def.env = fields.env_vars;
+            }
+        }
+        else {
+            result.unsupported.push({ name, reason: "entry has neither url nor command — malformed, skipped" });
+            continue;
+        }
+        // The adjacent `[mcp_servers.<name>.env]` table inverts to envAliases
+        // (`${VAR}`-shaped values) + staticEnv (everything else) — the exact
+        // split renderServerSection performs on the way out.
+        const envTable = readServerEnvTable(content, name);
+        for (const [key, value] of Object.entries(envTable ?? {})) {
+            const ref = VAR_REF_RE.exec(value);
+            if (ref) {
+                def.envAliases = { ...(def.envAliases ?? {}), [key]: ref[1] };
+            }
+            else {
+                def.staticEnv = { ...(def.staticEnv ?? {}), [key]: value };
+            }
+        }
+        result.entries.push({ name, def });
+    }
+    return result;
+}
+/** zcode's project config nests the rich-JSON shape under `mcp.servers`. */
+function readZcodeWorkspaceMcpDefs(configPath) {
+    const result = { entries: [], unsupported: [] };
+    if (!existsSync(configPath))
+        return result;
+    let parsed;
+    try {
+        parsed = JSON.parse(readFileSync(configPath, "utf-8"));
+    }
+    catch {
+        return result; // unparsable file — nothing to scan, the sync guard reports it
+    }
+    const servers = parsed?.mcp?.servers ?? {};
+    for (const [name, raw] of Object.entries(servers)) {
+        const def = fromRichJsonServerDef(raw);
+        if (def) {
+            result.entries.push({ name, def });
+        }
+        else {
+            result.unsupported.push({ name, reason: "stdio entry has no command — malformed, skipped" });
+        }
+    }
+    return result;
+}
+function readAgentProjectMcpDefs(agentId, configPath) {
+    if (!existsSync(configPath))
+        return { entries: [], unsupported: [] };
+    if (agentId === "codex")
+        return readCodexTomlMcpDefs(configPath);
+    if (agentId === "zcode")
+        return readZcodeWorkspaceMcpDefs(configPath);
+    return readRichJsonMcpDefs(configPath);
+}
+/** `.mcp.json` → `.mcp.local.json`; `config.toml` → `config.local.toml`. */
+function localSiblingPath(configPath) {
+    return configPath.replace(/\.(json|toml)$/, ".local.$1");
+}
+/**
+ * Apply-time re-read of one agent's project MCP defs (task 4.2, mirroring
+ * the global migrate's D9): an extraction's real value is recovered from
+ * the source file HERE, at apply time — it never rides on the plan object
+ * a `--json`/`--dry-run` caller might log or serialize.
+ */
+export function readWorkspaceAgentMcpDefsForApply(workspaceRoot, agentId) {
+    return readAgentProjectMcpDefs(agentId, workspaceMcpConfigPath(agentId, workspaceRoot));
+}
+/**
+ * Inventories all six agents' project-level MCP config paths (the same
+ * paths workspace delivery writes, so migration and delivery can never
+ * disagree about where an agent reads) plus their `*.local.*` siblings.
+ * Pure: reads files, writes nothing.
+ */
+export function scanWorkspaceMcp(workspaceRoot) {
+    const scan = { entries: [], unsupported: [], localFiles: [] };
+    for (const agentId of ALL_AGENTS) {
+        const configPath = workspaceMcpConfigPath(agentId, workspaceRoot);
+        const localPath = localSiblingPath(configPath);
+        if (existsSync(localPath))
+            scan.localFiles.push(localPath);
+        const { entries, unsupported } = readAgentProjectMcpDefs(agentId, configPath);
+        for (const { name, def } of entries)
+            scan.entries.push({ agent: agentId, name, def, sourcePath: configPath });
+        for (const { name, reason } of unsupported)
+            scan.unsupported.push({ agent: agentId, name, reason, sourcePath: configPath });
+    }
+    return scan;
+}
+/** `TRELLIS_<SERVER>_<KEY>` — the global migrate's D11 scheme, reused
+ * verbatim so a server extracted at either scope follows one convention. */
+function synthesizeVarName(serverName, key) {
+    const part = (s) => s.toUpperCase().replace(/[^A-Z0-9]+/g, "_").replace(/^_+|_+$/g, "") || "X";
+    return `TRELLIS_${part(serverName)}_${part(key)}`;
+}
+/** Moves `sourceKey` out of `staticEnv` into a name-only `env` reference —
+ * the same safe-def transform as the global migrate's `extractedMcpDef`. */
+function extractedWorkspaceMcpDef(def, sourceKey, varName) {
+    const remainingStaticEnv = { ...(def.staticEnv ?? {}) };
+    delete remainingStaticEnv[sourceKey];
+    const result = { ...def, env: [...(def.env ?? []), varName] };
+    if (Object.keys(remainingStaticEnv).length > 0) {
+        result.staticEnv = remainingStaticEnv;
+    }
+    else {
+        delete result.staticEnv;
+    }
+    return result;
+}
+/** Task 4.2: is this source file git-tracked? A literal secret in a
+ * tracked file has already been published to every clone — the report
+ * must advise rotation. Any failure (not a repo, git absent) means "not
+ * tracked", never an error. */
+function isGitTracked(workspaceRoot, path) {
+    try {
+        execFileSync("git", ["ls-files", "--error-unmatch", "--", path], { cwd: workspaceRoot, stdio: "pipe" });
+        return true;
+    }
+    catch {
+        return false;
+    }
+}
+export function collectWorkspaceMigratePlan(opts) {
+    const { workspaceRoot, homeDir, secretsPolicy } = opts;
+    const choose = opts.choose ?? {};
+    const dedup = opts.dedup ?? "drop";
+    const items = [];
+    const scan = scanWorkspaceMcp(workspaceRoot);
+    const manifest = loadWorkspaceRendered(workspaceRoot);
+    const workspaceConfig = readWorkspaceConfigJson(workspaceRoot);
+    const existingWorkspaceServers = workspaceConfig.mcp?.servers ?? {};
+    let globalServers = {};
+    try {
+        globalServers = loadCanonicalSource({ homeDir, workspaceDir: null }).mcp.servers;
+    }
+    catch {
+        // No usable global canonical — dedup simply has nothing to compare
+        // against; migration into `.agents/` still works.
+    }
+    for (const localPath of scan.localFiles) {
+        items.push({
+            kind: "mcp",
+            name: basename(localPath),
+            action: "skip-local",
+            detail: "personal local file — listed, never read into canonical",
+            sources: [],
+        });
+    }
+    for (const entry of scan.unsupported) {
+        items.push({
+            kind: "mcp",
+            name: entry.name,
+            action: "skip-unsupported",
+            detail: `${entry.agent}: ${entry.reason}`,
+            sources: [entry.agent],
+        });
+    }
+    // Group scanned entries by server name; classification then happens
+    // once per name, not once per (agent, name) pair.
+    const byName = new Map();
+    for (const entry of scan.entries) {
+        byName.set(entry.name, [...(byName.get(entry.name) ?? []), entry]);
+    }
+    for (const [name, entries] of [...byName.entries()].sort(([a], [b]) => a.localeCompare(b))) {
+        const sources = entries.map((e) => e.agent);
+        // Task 4.1: entries Trellis itself rendered (in-repo manifest) or
+        // already imported (`.agents/config.json`) need no migration.
+        const unrecorded = entries.filter((e) => manifest.mcp?.[e.agent]?.[e.name] === undefined);
+        if (unrecorded.length === 0) {
+            items.push({ kind: "mcp", name, action: "already-managed", detail: "Trellis-rendered already (in-repo manifest)", sources });
+            continue;
+        }
+        // Task 4.3: one name, differing defs across agents → the user must
+        // pick a side explicitly; the plan shows them side by side.
+        const distinct = unrecorded.filter((e, i) => unrecorded.findIndex((o) => deepEqual(o.def, e.def)) === i);
+        let chosen;
+        if (distinct.length > 1) {
+            const picked = choose[name];
+            const pickedEntry = picked !== undefined ? unrecorded.find((e) => e.agent === picked) : undefined;
+            if (!pickedEntry) {
+                const defs = {};
+                for (const e of distinct)
+                    defs[e.agent] = e.def;
+                items.push({
+                    kind: "mcp",
+                    name,
+                    action: "conflict",
+                    detail: `defined differently by ${distinct.map((e) => e.agent).join(" and ")} — no def is imported until one is chosen`,
+                    remediation: `re-run with \`--choose ${name}=<${distinct.map((e) => e.agent).join("|")}>\` after comparing the side-by-side definitions`,
+                    sources,
+                    defs,
+                });
+                continue;
+            }
+            chosen = pickedEntry;
+        }
+        else {
+            chosen = distinct[0];
+        }
+        const def = chosen.def;
+        const chosenSource = distinct.length > 1 ? chosen.agent : undefined;
+        // Already in `.agents/config.json` with an identical def → nothing to
+        // do. The file stores the snake_case yaml shape — convert before
+        // comparing against the scanned `McpServerDef`.
+        const existingYaml = existingWorkspaceServers[name];
+        if (existingYaml !== undefined && deepEqual(fromServerDefYaml(name, existingYaml, workspaceConfigPath(workspaceRoot)), def)) {
+            items.push({ kind: "mcp", name, action: "already-managed", detail: "already in .agents/config.json with an identical definition", sources, ...(chosenSource ? { chosenSource } : {}) });
+            continue;
+        }
+        // Task 4.2: reject-pattern literal interception. `staticEnv` has a
+        // natural extraction target (its own dict key → TRELLIS_<SERVER>_<KEY>
+        // in the global secret store); a literal anywhere else can never be
+        // written into the COMMITTED `.agents/config.json`, so it conflicts.
+        const secretMatch = findLiteralSecret(def);
+        if (secretMatch && secretMatch.field !== "staticEnv") {
+            items.push({
+                kind: "mcp",
+                name,
+                action: "conflict",
+                detail: `${secretMatch.field} holds a value matching a secrets reject pattern (${secretMatch.label}) — .agents/config.json is committed, so the literal is never written`,
+                remediation: `rotate the value, replace it with a \${VAR} reference in the source file, then re-run migrate`,
+                sources,
+                ...(chosenSource ? { chosenSource } : {}),
+            });
+            continue;
+        }
+        const tracked = isGitTracked(workspaceRoot, chosen.sourcePath);
+        const rotationAdvisory = secretMatch && tracked
+            ? `${chosen.sourcePath} is git-tracked — the ${secretMatch.label} value in it was already committed; rotate it`
+            : undefined;
+        if (secretMatch) {
+            const key = secretMatch.key;
+            const varName = synthesizeVarName(name, key);
+            items.push({
+                kind: "mcp",
+                name,
+                action: "extract-secret",
+                detail: `will extract "${key}" to the global secret store as "${varName}" and import the server with a \${${varName}} reference — the literal never lands under .agents/`,
+                sources,
+                ...(chosenSource ? { chosenSource } : {}),
+                mcpDef: extractedWorkspaceMcpDef(def, key, varName),
+                extractVarName: varName,
+                extractTargetPath: secretsPolicy.envFile ?? join(homeDir, ".trellis", "mcp", "servers.local.env"),
+                extractSourceKey: key,
+                extractSourceAgent: chosen.agent,
+                ...(rotationAdvisory ? { rotationAdvisory } : {}),
+            });
+            continue;
+        }
+        // Task 4.4: deep-equal to the global layer — importing would create a
+        // redundant shadow. Default drop; `--dedup override` records the
+        // intentional-shadow choice and imports anyway.
+        const global = globalServers[name];
+        if (global !== undefined && deepEqual(global, def)) {
+            if (dedup === "override") {
+                items.push({
+                    kind: "mcp",
+                    name,
+                    action: "create",
+                    detail: "identical to the global entry — imported anyway as an intentional shadow (--dedup override)",
+                    sources,
+                    ...(chosenSource ? { chosenSource } : {}),
+                    mcpDef: def,
+                    dedupChoice: "override",
+                });
+            }
+            else {
+                items.push({
+                    kind: "mcp",
+                    name,
+                    action: "identical-to-global",
+                    detail: "identical to the global entry — dropped (the global layer already provides it); re-run with --dedup override to import it as an intentional shadow",
+                    sources,
+                    dedupChoice: "drop",
+                });
+            }
+            continue;
+        }
+        items.push({
+            kind: "mcp",
+            name,
+            action: "create",
+            detail: `will import into .agents/config.json (from ${chosen.agent}${unrecorded.length > 1 ? "; other agents agree" : ""})`,
+            sources,
+            ...(chosenSource ? { chosenSource } : {}),
+            mcpDef: def,
+        });
+    }
+    // Root AGENTS.md → .agents/AGENTS.md. A marker-headed file is Trellis's
+    // own rendering — already managed. An unmarked one is imported, unless
+    // `.agents/AGENTS.md` already holds real (non-template) content.
+    const rootAgentsMd = join(workspaceRoot, "AGENTS.md");
+    if (existsSync(rootAgentsMd)) {
+        const content = readFileSync(rootAgentsMd, "utf-8");
+        if (content.startsWith(INSTRUCTIONS_MARKER)) {
+            items.push({ kind: "instructions", name: "AGENTS.md", action: "already-managed", detail: "root AGENTS.md is already Trellis-rendered", sources: [] });
+        }
+        else {
+            const targetPath = join(workspaceRoot, ".agents", "AGENTS.md");
+            const existingInstructions = existsSync(targetPath) ? readFileSync(targetPath, "utf-8") : undefined;
+            if (existingInstructions === content) {
+                items.push({ kind: "instructions", name: "AGENTS.md", action: "already-managed", detail: ".agents/AGENTS.md already holds the same content", sources: [] });
+            }
+            else if (existingInstructions !== undefined && existingInstructions !== WORKSPACE_AGENTS_MD_TEMPLATE) {
+                items.push({
+                    kind: "instructions",
+                    name: "AGENTS.md",
+                    action: "conflict",
+                    detail: "both root AGENTS.md and .agents/AGENTS.md hold real content — not merged automatically",
+                    remediation: "merge the two by hand into .agents/AGENTS.md, remove the root file, then re-run migrate",
+                    sources: [],
+                });
+            }
+            else {
+                items.push({
+                    kind: "instructions",
+                    name: "AGENTS.md",
+                    action: "create",
+                    detail: "will import root AGENTS.md into .agents/AGENTS.md and re-render the root file marker-headed",
+                    sources: [],
+                    sourceContent: content,
+                });
+            }
+        }
+    }
+    return { workspaceRoot, items };
+}