scripts/inline-rollback-guard.mjs

Functions

Imports

It imports no other module of this repo. No module of this repo imports it.

Source

1#!/usr/bin/env node
2// Writes each script a shared workflow carries into its heredoc, so a caller that pins one devkit sha runs the script of that
3// same commit: scripts/rollback-guard.mjs into the "Write the rollback guard" step of worker-deploy.yml, and
4// scripts/strip-pr-footer.mjs into pr-footer.yml, and scripts/code-map.mjs into code-map.yml. Run it after any edit to one:
5//
6//   node scripts/inline-rollback-guard.mjs
7//
8// It replaces what sits between a heredoc's opening `<<'MARKER'` and its closing line, every line indented to the run
9// block. test/worker-deploy-workflow.test.mjs and test/pr-footer-workflow.test.mjs fail when a pair disagrees.
10
11import { readFileSync, writeFileSync } from "node:fs";
12import { pathToFileURL } from "node:url";
13
14const ROOT = new URL("..", import.meta.url);
15const INDENT = " ".repeat(10);
16const PAIRS = [
17  { workflow: ".github/workflows/worker-deploy.yml", script: "scripts/rollback-guard.mjs", marker: "ROLLBACK_GUARD" },
18  { workflow: ".github/workflows/pr-footer.yml", script: "scripts/strip-pr-footer.mjs", marker: "PR_FOOTER" },
19  { workflow: ".github/workflows/code-map.yml", script: "scripts/code-map.mjs", marker: "CODE_MAP" },
20];
21
22/** The heredoc's bounds in the workflow. @param {string} workflow @param {string} marker */
23function bounds(workflow, marker) {
24  const OPEN = `<<'${marker}'\n`;
25  const start = workflow.indexOf(OPEN);
26  const end = workflow.indexOf(`\n${INDENT}${marker}\n`, start);
27  if (start === -1 || end === -1) throw new Error(`the workflow has no ${marker} heredoc`);
28  return { from: start + OPEN.length, end };
29}
30
31/** The script as the workflow carries it, dedented. @param {string} workflow @param {string} [marker] */
32export function inlined(workflow, marker = "ROLLBACK_GUARD") {
33  const { from, end } = bounds(workflow, marker);
34  const block = workflow.slice(from, end);
35  return `${block.split("\n").map((line) => (line.startsWith(INDENT) ? line.slice(INDENT.length) : line)).join("\n")}\n`;
36}
37
38/** The workflow with the heredoc's body replaced by the script. @param {string} workflow @param {string} guard @param {string} [marker] */
39function inline(workflow, guard, marker = "ROLLBACK_GUARD") {
40  const { from, end } = bounds(workflow, marker);
41  const block = guard.replace(/\n$/, "").split("\n").map((line) => (line === "" ? "" : INDENT + line)).join("\n");
42  return workflow.slice(0, from) + block + workflow.slice(end);
43}
44
45if (process.argv[1] && import.meta.url === pathToFileURL(process.argv[1]).href) {
46  for (const { workflow, script, marker } of PAIRS) {
47    const file = new URL(workflow, ROOT);
48    writeFileSync(file, inline(readFileSync(file, "utf8"), readFileSync(new URL(script, ROOT), "utf8"), marker));
49  }
50}