@intentius/chant-lexicon-terraform 0.124.31 → 0.124.32

package/dist/pin/edit-ts.js

@@ -0,0 +1,76 @@
+/**
+ * The pin edit for a root chant generates (#3189): move the pin in the
+ * module declaration of its TypeScript source, not in the `.tf` a build
+ * writes from it.
+ *
+ * A module declaration in TypeScript is an object literal with the same
+ * arguments the HCL block has: a `source` string, and a `version` string
+ * beside a registry source. Any object literal whose `source` is a plain
+ * string naming the module counts, whatever function or constructor receives
+ * it. The TypeScript compiler parses the file, so a `source:` inside a
+ * comment, a template with substitutions, or another string is never a
+ * match, and the edit replaces the string literal's content only. Every other
+ * byte of the file stays as it was.
+ *
+ * It needs the TypeScript compiler, so `./index.ts` (the bundled subpath,
+ * #3421) does not import it. The rollout takes it as `editTs`.
+ */
+import { ts } from "@intentius/chant/lint/typescript";
+import { movePin } from "./source.js";
+function propertyName(name) {
+    if (ts.isIdentifier(name) || ts.isStringLiteral(name) || ts.isNoSubstitutionTemplateLiteral(name))
+        return name.text;
+    return undefined;
+}
+function stringInitializer(obj, key) {
+    for (const p of obj.properties) {
+        if (!ts.isPropertyAssignment(p) || propertyName(p.name) !== key)
+            continue;
+        const init = p.initializer;
+        return ts.isStringLiteral(init) || ts.isNoSubstitutionTemplateLiteral(init) ? init : "expression";
+    }
+    return undefined;
+}
+/** Write a value as a literal with the same quote the old one used. */
+function quote(value, old, file) {
+    const q = old.getText(file)[0];
+    const escaped = value.replace(/\\/g, "\\\\").replaceAll(q, `\\${q}`);
+    return `${q}${q === "`" ? escaped.replace(/\$\{/g, "\\${") : escaped}${q}`;
+}
+/** Move `request.module`'s pin in one TypeScript file. */
+export function editPinsInTs(text, file, request) {
+    const sf = ts.createSourceFile(file, text, ts.ScriptTarget.Latest, true, file.endsWith(".tsx") ? ts.ScriptKind.TSX : ts.ScriptKind.TS);
+    const calls = [];
+    const splices = [];
+    const visit = (node) => {
+        if (ts.isObjectLiteralExpression(node)) {
+            const source = stringInitializer(node, "source");
+            const version = stringInitializer(node, "version");
+            if (source && source !== "expression") {
+                const call = `line ${sf.getLineAndCharacterOfPosition(node.getStart(sf)).line + 1}`;
+                const move = movePin(source.text, version && version !== "expression" ? version.text : undefined, request);
+                if (move) {
+                    if (version === "expression") {
+                        calls.push({ outcome: "refused", reason: "version is an expression, not a string literal", file, call });
+                    }
+                    else if (move.outcome === "moved") {
+                        if (move.source !== source.text)
+                            splices.push({ start: source.getStart(sf), end: source.getEnd(), text: quote(move.source, source, sf) });
+                        if (version && move.version !== undefined && move.version !== version.text)
+                            splices.push({ start: version.getStart(sf), end: version.getEnd(), text: quote(move.version, version, sf) });
+                        calls.push({ ...move, file, call });
+                    }
+                    else {
+                        calls.push({ ...move, file, call });
+                    }
+                }
+            }
+        }
+        ts.forEachChild(node, visit);
+    };
+    visit(sf);
+    let content = text;
+    for (const s of splices.sort((a, b) => b.start - a.start))
+        content = content.slice(0, s.start) + s.text + content.slice(s.end);
+    return { content, calls };
+}

package/dist/pin/edit.js

@@ -0,0 +1,118 @@
+/**
+ * The pin edit for hand-written HCL (#3189): move one module's pin from an old
+ * version to a new one in a `.tf` file or a `terragrunt.hcl`, and leave every
+ * other byte of the file as it was.
+ *
+ * Three steps, each one a check on the last:
+ *
+ * 1. The HCL reader (`@cdktn/hcl2json`, the parser the rest of this lexicon
+ *    reads `.tf` with) parses the file. Its tree says which calls exist and
+ *    what each one's `source` and `version` are: `module "<name>"` blocks in a
+ *    `.tf`, and the `terraform` block's `source` in a `terragrunt.hcl`.
+ * 2. `./source.ts` decides, per call, whether it names the module and how its
+ *    pin moves. `./scan.ts` finds the byte offsets of the literal to rewrite,
+ *    and its unescaped content has to equal the value the reader returned, or
+ *    the call is refused rather than guessed at.
+ * 3. The edited text is parsed again. Its tree has to equal the first tree
+ *    with only the moved values changed. Anything else throws, and nothing is
+ *    written.
+ *
+ * The parser is passed in rather than imported. It is a 1.8 MB wasm package
+ * that core loads lazily (`loadHcl2json`), and a caller that bundles this
+ * module (terragucci's `tf-rollout` stage, #3421) decides how it is loaded.
+ */
+import { movePin } from "./source.js";
+import { escapeHcl, scanBlocks, unescapeHcl } from "./scan.js";
+/** Whether a file is read as a Terragrunt configuration rather than a `.tf` file. */
+export function isTerragruntFile(file) {
+    return file === "terragrunt.hcl" || file.endsWith("/terragrunt.hcl");
+}
+function attr(block, name) {
+    return block.attributes.find((a) => a.name === name);
+}
+/** Pair each call in the reader's tree with the block the scanner found for it. */
+function sites(tree, blocks, terragrunt) {
+    const out = [];
+    if (terragrunt) {
+        const bodies = tree.terraform ?? [];
+        const scanned = blocks.filter((b) => b.type === "terraform" && b.labels.length === 0);
+        bodies.forEach((body, k) => {
+            if (scanned[k])
+                out.push({ call: "terraform", block: scanned[k], body });
+        });
+        return out;
+    }
+    const modules = tree.module ?? {};
+    for (const [name, bodies] of Object.entries(modules)) {
+        const scanned = blocks.filter((b) => b.type === "module" && b.labels.length === 1 && b.labels[0] === name);
+        bodies.forEach((body, k) => {
+            if (scanned[k])
+                out.push({ call: `module.${name}`, block: scanned[k], body });
+        });
+    }
+    return out.sort((a, b) => a.block.start - b.block.start);
+}
+/**
+ * Move `request.module`'s pin in one file. Calls that name another module are
+ * left alone and not reported. A call that names the module and cannot move
+ * is reported with its reason and left as it was.
+ */
+export async function editPins(text, file, request, parser) {
+    const terragrunt = isTerragruntFile(file);
+    const tree = (await parser.parse(file, text));
+    const blocks = scanBlocks(text, file);
+    const calls = [];
+    const splices = [];
+    const expected = structuredClone(tree);
+    const expectedSites = sites(expected, scanBlocks(text, file), terragrunt);
+    sites(tree, blocks, terragrunt).forEach((site, index) => {
+        const source = site.body.source;
+        const version = site.body.version;
+        if (typeof source !== "string")
+            return;
+        const move = movePin(source, typeof version === "string" ? version : undefined, request);
+        if (!move)
+            return;
+        const at = { file, call: site.call };
+        if (move.outcome !== "moved") {
+            calls.push({ ...move, ...at });
+            return;
+        }
+        const edits = [];
+        if (move.source !== source)
+            edits.push(["source", move.source]);
+        if (move.version !== undefined && move.version !== version)
+            edits.push(["version", move.version]);
+        for (const [name] of edits) {
+            const scanned = attr(site.block, name);
+            const was = site.body[name];
+            if (!scanned?.literal || unescapeHcl(scanned.literal.raw) !== was) {
+                calls.push({ outcome: "refused", reason: `${name} is not a plain string literal, so there is no one place to write the pin`, ...at });
+                return;
+            }
+        }
+        for (const [name, value] of edits) {
+            const literal = attr(site.block, name).literal;
+            splices.push({ start: literal.start, end: literal.end, text: rewriteLiteral(literal.raw, site.body[name], value) });
+            expectedSites[index].body[name] = value;
+        }
+        calls.push({ ...move, ...at });
+    });
+    let content = text;
+    for (const s of splices.sort((a, b) => b.start - a.start))
+        content = content.slice(0, s.start) + s.text + content.slice(s.end);
+    if (splices.length > 0) {
+        const reread = (await parser.parse(file, content));
+        if (JSON.stringify(reread) !== JSON.stringify(expected)) {
+            throw new Error(`${file}: the pin edit would change more than the pin, so nothing was written`);
+        }
+    }
+    return { content, calls };
+}
+/**
+ * The new literal content. When the old literal needed no escapes, the old
+ * value's text is replaced in place, so any spacing (`= 1.3.0`) survives.
+ */
+function rewriteLiteral(raw, was, value) {
+    return raw === was ? value : escapeHcl(value);
+}

package/dist/pin/forge.js

@@ -0,0 +1,65 @@
+/**
+ * What a pin-bump rollout asks the forge (#3189): find a wave's pull request
+ * by its branch, open one, and read the checks on the commit a merge made.
+ *
+ * The default answers through `gh`, the way core's `proposeWorkspaceUpgrade`
+ * (#2550) opens its pull request: `gh pr list --head`, `gh pr create`, and
+ * `gh api` for the commit's check runs and statuses. A test, or a caller with
+ * its own forge client, passes a {@link PinForge} instead.
+ *
+ * None of those calls names a host. The rollout's default runner hands `gh`
+ * the job's forge or `origin`'s host (core's `ghHostEnv`, #3798), so a GitHub
+ * Enterprise Server checkout is answered by its own instance. `gh pr` speaks
+ * GraphQL, which Forgejo does not serve, so a rollout on Forgejo passes its
+ * own {@link PinForge}.
+ */
+const CHECK_STATE = {
+    success: "success",
+    neutral: "success",
+    skipped: "success",
+    failure: "failure",
+    cancelled: "failure",
+    timed_out: "failure",
+    action_required: "failure",
+    startup_failure: "failure",
+    stale: "failure",
+    error: "failure",
+    pending: "pending",
+};
+/** A {@link PinForge} over `gh`, run in `repo`. */
+export function ghPinForge(run, repo) {
+    return {
+        async findPullRequest(branch) {
+            const out = await run("gh", ["pr", "list", "--head", branch, "--state", "all", "--limit", "1", "--json", "url,state,body,mergeCommit"], repo);
+            const list = JSON.parse(out || "[]");
+            const pr = list[0];
+            if (!pr)
+                return null;
+            const state = pr.state.toLowerCase() === "merged" ? "merged" : pr.state.toLowerCase() === "open" ? "open" : "closed";
+            return { url: pr.url, state, body: pr.body ?? "", ...(pr.mergeCommit?.oid ? { mergeCommit: pr.mergeCommit.oid } : {}) };
+        },
+        async createPullRequest({ base, head, title, body }) {
+            const out = await run("gh", ["pr", "create", "--base", base, "--head", head, "--title", title, "--body", body], repo);
+            return out.trim().split("\n").pop() ?? "";
+        },
+        async commitChecks(sha) {
+            const checks = [];
+            const runs = await run("gh", ["api", "--paginate", `repos/{owner}/{repo}/commits/${sha}/check-runs`, "--jq", ".check_runs[] | [.name, .status, (.conclusion // \"\")] | @tsv"], repo);
+            for (const line of runs.split("\n").filter(Boolean)) {
+                const [name, status, conclusion] = line.split("\t");
+                checks.push({ name: name, state: status === "completed" ? (CHECK_STATE[conclusion ?? ""] ?? "failure") : "pending" });
+            }
+            // Statuses come newest first; the first one per context is its state.
+            const statuses = await run("gh", ["api", "--paginate", `repos/{owner}/{repo}/commits/${sha}/statuses`, "--jq", ".[] | [.context, .state] | @tsv"], repo);
+            const seen = new Set();
+            for (const line of statuses.split("\n").filter(Boolean)) {
+                const [name, state] = line.split("\t");
+                if (seen.has(name))
+                    continue;
+                seen.add(name);
+                checks.push({ name: name, state: CHECK_STATE[state ?? ""] ?? "pending" });
+            }
+            return checks;
+        },
+    };
+}

package/dist/pin/index.js

@@ -0,0 +1,16 @@
+/**
+ * Pin-bump rollouts (#3189): the pin edit, the wave plan, and the run that
+ * opens one pull request per wave.
+ *
+ * This subpath, `@intentius/chant-lexicon-terraform/pin`, bundles without the
+ * TypeScript toolchain, zod, or chant's fold, lint and codegen modules, so
+ * terragucci's `tf-rollout` stage can run it from one bundled file (#3421).
+ * `./bundle.test.ts` holds it to that. The HCL parser is passed in, and the
+ * TypeScript editor for generated roots lives in `./edit-ts.ts`, which this
+ * index does not import.
+ */
+export { readModulePin, movePin, moduleOf, exactVersion, isPinValue, checkPinRequest } from "./source.js";
+export { editPins, isTerragruntFile } from "./edit.js";
+export { planPinWaves, wavesFromChoudoufu, restrictWaves, terragruntDependencies, PinWavePlanError } from "./waves.js";
+export { ghPinForge } from "./forge.js";
+export { runPinRollout, renderPinRollout, pinWaveBranch } from "./rollout.js";

package/dist/pin/rollout.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"rollout.d.ts","sourceRoot":"","sources":["../../src/pin/rollout.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AAOH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,qCAAqC,CAAC;AACpE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gDAAgD,CAAC;AAEpF,OAAO,EAAY,KAAK,aAAa,EAAE,KAAK,aAAa,EAAE,KAAK,UAAU,EAAE,MAAM,QAAQ,CAAC;AAE3F,OAAO,EAAuD,KAAK,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,SAAS,CAAC;AAC1G,OAAO,EAAc,KAAK,QAAQ,EAAE,MAAM,SAAS,CAAC;AAIpD,6FAA6F;AAC7F,MAAM,MAAM,WAAW,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,KAAK,aAAa,CAAC;AAE7F,MAAM,MAAM,cAAc,GAAG,QAAQ,GAAG,cAAc,CAAC;AAEvD,MAAM,WAAW,iBAAkB,SAAQ,UAAU;IACnD,yEAAyE;IACzE,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,0IAA0I;IAC1I,KAAK,CAAC,EAAE,OAAO,EAAE,CAAC;IAClB,8BAA8B;IAC9B,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,yGAAyG;IACzG,KAAK,CAAC,EAAE,OAAO,EAAE,CAAC;IAClB,gGAAgG;IAChG,IAAI,CAAC,EAAE,cAAc,CAAC;IACtB,mEAAmE;IACnE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,wBAAwB;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,+HAA+H;IAC/H,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,mFAAmF;IACnF,MAAM,EAAE,QAAQ,CAAC;IACjB,+CAA+C;IAC/C,KAAK,CAAC,EAAE,QAAQ,CAAC;IACjB,+DAA+D;IAC/D,GAAG,CAAC,EAAE,aAAa,CAAC;IACpB,gGAAgG;IAChG,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,2HAA2H;IAC3H,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;CAC9D;AAED,qDAAqD;AACrD,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,2GAA2G;IAC3G,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAC;IAC1D,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,KAAK,EAAE,aAAa,EAAE,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,MAAM,YAAY,GACpB,SAAS,GACT,iBAAiB,GACjB,QAAQ,GACR,YAAY,GACZ,MAAM,GACN,eAAe,GACf,QAAQ,GACR,QAAQ,GACR,aAAa,CAAC;AAElB,MAAM,WAAW,aAAc,SAAQ,OAAO;IAC5C,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,YAAY,CAAC;IACpB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,oDAAoD;IACpD,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,sCAAsC;IACtC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,+DAA+D;IAC/D,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB;AAED,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAClD,IAAI,EAAE,cAAc,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb;;;;;OAKG;IACH,MAAM,EAAE,UAAU,GAAG,QAAQ,GAAG,YAAY,GAAG,SAAS,GAAG,SAAS,CAAC;IACrE,KAAK,EAAE,YAAY,EAAE,CAAC;IACtB,KAAK,EAAE,aAAa,EAAE,CAAC;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;CACjB;AA+BD,6CAA6C;AAC7C,wBAAgB,aAAa,CAAC,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAEvE;AA4GD,4GAA4G;AAC5G,wBAAsB,aAAa,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAuJzF;AAcD,+CAA+C;AAC/C,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC,gBAAgB,EAAE,SAAS,CAAC,GAAG,MAAM,CAWlF"}
+{"version":3,"file":"rollout.d.ts","sourceRoot":"","sources":["../../src/pin/rollout.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AAOH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,qCAAqC,CAAC;AACpE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gDAAgD,CAAC;AAEpF,OAAO,EAAY,KAAK,aAAa,EAAE,KAAK,aAAa,EAAE,KAAK,UAAU,EAAE,MAAM,QAAQ,CAAC;AAE3F,OAAO,EAAuD,KAAK,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,SAAS,CAAC;AAC1G,OAAO,EAAc,KAAK,QAAQ,EAAE,MAAM,SAAS,CAAC;AAIpD,6FAA6F;AAC7F,MAAM,MAAM,WAAW,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,KAAK,aAAa,CAAC;AAE7F,MAAM,MAAM,cAAc,GAAG,QAAQ,GAAG,cAAc,CAAC;AAEvD,MAAM,WAAW,iBAAkB,SAAQ,UAAU;IACnD,yEAAyE;IACzE,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,0IAA0I;IAC1I,KAAK,CAAC,EAAE,OAAO,EAAE,CAAC;IAClB,8BAA8B;IAC9B,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,yGAAyG;IACzG,KAAK,CAAC,EAAE,OAAO,EAAE,CAAC;IAClB,gGAAgG;IAChG,IAAI,CAAC,EAAE,cAAc,CAAC;IACtB,mEAAmE;IACnE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,wBAAwB;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,+HAA+H;IAC/H,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,mFAAmF;IACnF,MAAM,EAAE,QAAQ,CAAC;IACjB,+CAA+C;IAC/C,KAAK,CAAC,EAAE,QAAQ,CAAC;IACjB,+DAA+D;IAC/D,GAAG,CAAC,EAAE,aAAa,CAAC;IACpB,gGAAgG;IAChG,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,2HAA2H;IAC3H,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;CAC9D;AAED,qDAAqD;AACrD,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,2GAA2G;IAC3G,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAC;IAC1D,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,KAAK,EAAE,aAAa,EAAE,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,MAAM,YAAY,GACpB,SAAS,GACT,iBAAiB,GACjB,QAAQ,GACR,YAAY,GACZ,MAAM,GACN,eAAe,GACf,QAAQ,GACR,QAAQ,GACR,aAAa,CAAC;AAElB,MAAM,WAAW,aAAc,SAAQ,OAAO;IAC5C,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,YAAY,CAAC;IACpB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,oDAAoD;IACpD,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,sCAAsC;IACtC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,+DAA+D;IAC/D,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB;AAED,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAClD,IAAI,EAAE,cAAc,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb;;;;;OAKG;IACH,MAAM,EAAE,UAAU,GAAG,QAAQ,GAAG,YAAY,GAAG,SAAS,GAAG,SAAS,CAAC;IACrE,KAAK,EAAE,YAAY,EAAE,CAAC;IACtB,KAAK,EAAE,aAAa,EAAE,CAAC;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;CACjB;AAgCD,6CAA6C;AAC7C,wBAAgB,aAAa,CAAC,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAEvE;AA4GD,4GAA4G;AAC5G,wBAAsB,aAAa,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAuJzF;AAcD,+CAA+C;AAC/C,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC,gBAAgB,EAAE,SAAS,CAAC,GAAG,MAAM,CAWlF"}