Skip to content

The fastest, cheapest, most efficient open-source agent harness. Run more than 500 agents on a $10 VPS.

10.9 KB
Raw Blame
#!/usr/bin/env node
// Release a module from its own repository and re-pin the host to it
// (tinyhumansai/openhuman#7615, epic #7523). This automates Steps 3-4 of the
// migrate-to-submodule skill; the pins stay strict.
//
//   node scripts/modules/release-and-repin.mjs <id> [--bump patch|minor|major]
//                                              [--version X.Y.Z] [--yes]
//                                              [--owner <github-owner>]
//                                              [--ref <workflow-ref>]
//                                              [--workflow-input bump|tag]
//                                              [--dry-run] [--root <dir>]
//
// 1. dispatch `release.yml` in <owner>/<id> and watch it. The default owner
//    and `bump` input preserve the canonical flow; `tag` dispatches an
//    existing version tag, and `--ref` selects the workflow definition ref.
//    Publishing tags is hard to undo, so this ASKS FIRST (`--yes` answers it,
//    and a non-interactive shell without `--yes` refuses). With `--version`
//    the release already exists and nothing is dispatched.
// 2. download the release's `checksum.toml`.
// 3. rewrite the record in records_*.rs: `version`, `release_url` and every
//    asset `archive` + `sha256`, VERBATIM from checksum.toml. A digest is never
//    computed here, from a local build or anything else.
// 4. check out the tag in vendor/<sub> and stage the gitlink.
// 5. update the other pins that name the version (module-provider-pins.json for
//    a provider record; a now-stale module-pin-exemptions.json entry).
// 6. run check-module-pins.mjs and check-submodule-monotonic.mjs.
//
// It never commits and never pushes.
import { spawnSync } from "node:child_process";
import {
  existsSync,
  mkdtempSync,
  readdirSync,
  readFileSync,
  rmSync,
  writeFileSync,
} from "node:fs";
import { tmpdir } from "node:os";
import { dirname, join, resolve } from "node:path";
import { createInterface } from "node:readline/promises";
import { fileURLToPath, pathToFileURL } from "node:url";

import { parseRecords } from "../lib/module-pins.mjs";
import {
  bumpVersion,
  dropExemption,
  parseChecksumToml,
  rewriteRecord,
  unusedChecksums,
  updateProviderPins,
} from "../lib/module-repin.mjs";
import { parseSourceSpecs } from "../lib/module-sources.mjs";

const HERE = dirname(fileURLToPath(import.meta.url));
export const DEFAULT_ROOT = resolve(HERE, "..", "..");
const ORG = "tinyhumansai";

export function parseArgs(argv) {
  const opts = {
    bump: "patch",
    yes: false,
    dryRun: false,
    owner: ORG,
    workflowInput: "bump",
  };
  for (let i = 0; i < argv.length; i++) {
    const arg = argv[i];
    if (arg === "--bump") opts.bump = argv[++i];
    else if (arg === "--version") opts.version = argv[++i];
    else if (arg === "--owner") opts.owner = argv[++i];
    else if (arg === "--ref") opts.ref = argv[++i];
    else if (arg === "--workflow-input") opts.workflowInput = argv[++i];
    else if (arg === "--root") opts.root = argv[++i];
    else if (arg === "--yes") opts.yes = true;
    else if (arg === "--dry-run") opts.dryRun = true;
    else if (arg.startsWith("--")) throw new Error(`unknown option ${arg}`);
    else if (opts.id === undefined) opts.id = arg;
    else throw new Error(`unexpected argument ${arg}`);
  }
  if (!opts.id) throw new Error("usage: release-and-repin.mjs <id> [options]");
  bumpVersion("0.0.0", opts.bump); // validates --bump
  if (!/^[A-Za-z0-9-]+$/.test(opts.owner ?? "")) {
    throw new Error("--owner must be a GitHub account name");
  }
  if (opts.ref !== undefined && (!opts.ref || opts.ref.startsWith("-") || opts.ref.includes("\0"))) {
    throw new Error("--ref must be a non-empty git ref");
  }
  if (!["bump", "tag"].includes(opts.workflowInput)) {
    throw new Error("--workflow-input must be bump or tag");
  }
  if (opts.workflowInput === "tag" && !opts.version) {
    throw new Error("--workflow-input tag requires --version for an existing tag");
  }
  if (opts.version && !/^\d+\.\d+\.\d+$/.test(opts.version)) {
    throw new Error(`--version must be X.Y.Z, got ${opts.version}`);
  }
  return opts;
}

/** The records_*.rs file holding `id`, with its text. */
function findRecordFile(root, id) {
  const dir = join(root, "crates/openhuman-core/src/modules/registry");
  for (const name of readdirSync(dir).sort()) {
    if (!/^records_.*\.rs$/.test(name)) continue;
    const path = join(dir, name);
    const text = readFileSync(path, "utf8");
    for (const rec of parseRecords(text).values()) {
      if (rec.id === id) return { path, text, record: rec };
    }
  }
  throw new Error(`no registry record with id "${id}"`);
}

function defaultRun(cmd, args, { cwd, inherit = false } = {}) {
  const res = spawnSync(cmd, args, {
    cwd,
    encoding: "utf8",
    stdio: inherit ? "inherit" : ["ignore", "pipe", "pipe"],
  });
  if (res.error) throw res.error;
  return { code: res.status ?? 1, stdout: res.stdout ?? "", stderr: res.stderr ?? "" };
}

async function defaultConfirm(question) {
  if (!process.stdin.isTTY) return false;
  const rl = createInterface({ input: process.stdin, output: process.stderr });
  try {
    return /^y(es)?$/i.test((await rl.question(`${question} [y/N] `)).trim());
  } finally {
    rl.close();
  }
}

/**
 * Run the whole flow. `deps.run(cmd, args, {cwd})` and `deps.confirm(q)` are
 * injectable so tests never touch GitHub or git.
 */
export async function repin(opts, deps = {}) {
  opts = {
    ...opts,
    owner: opts.owner ?? ORG,
    workflowInput: opts.workflowInput ?? "bump",
  };
  const root = resolve(opts.root ?? DEFAULT_ROOT);
  const run = deps.run ?? defaultRun;
  const confirm = deps.confirm ?? defaultConfirm;
  const log = deps.log ?? ((m) => process.stderr.write(`${m}\n`));
  const must = (cmd, args, o) => {
    const res = run(cmd, args, o);
    if (res.code !== 0) {
      throw new Error(
        `\`${cmd} ${args.join(" ")}\` failed: ${(res.stderr || res.stdout).trim().split("\n")[0]}`,
      );
    }
    return res.stdout.trim();
  };

  const file = findRecordFile(root, opts.id);
  const registrySrc = readFileSync(file.path, "utf8");
  const spec = parseSourceSpecs(registrySrc).get(opts.id);
  if (!spec) throw new Error(`${opts.id}: record has no SourceSpec submodule`);
  const repo = `${opts.owner}/${spec.submodule}`;
  const subPath = `vendor/${spec.submodule}`;
  const subDir = join(root, subPath);
  const current = file.record.version;
  const dispatch = opts.workflowInput === "tag" || !opts.version;

  let version = opts.version;
  if (opts.dryRun) {
    log(
      `[dry-run] ${opts.id}: registry ${current}; ` +
        (version
          ? opts.workflowInput === "tag"
            ? `would dispatch release.yml in ${repo} (tag=v${version}${opts.ref ? `, ref=${opts.ref}` : ""}) after confirmation`
            : `would re-pin to existing release v${version} in ${repo}`
          : `would dispatch release.yml in ${repo} (bump=${opts.bump}${opts.ref ? `, ref=${opts.ref}` : ""}) after confirmation`) +
        `; would check out the tag in ${subPath}`,
    );
    return { version: version ?? null, dryRun: true };
  }

  if (dispatch) {
    const workflowValue = opts.workflowInput === "tag" ? `v${version}` : opts.bump;
    const ok =
      opts.yes ||
      (await confirm(
        `Dispatch release.yml in ${repo} with ${opts.workflowInput}=${workflowValue}${opts.ref ? ` on ref ${opts.ref}` : ""}? This publishes release artifacts and may publish a tag, which is hard to undo.`,
      ));
    if (!ok) throw new Error("release not confirmed; nothing was dispatched");
    const dispatchArgs = ["workflow", "run", "release.yml", "-R", repo];
    if (opts.ref) dispatchArgs.push("--ref", opts.ref);
    dispatchArgs.push("-f", `${opts.workflowInput}=${workflowValue}`);
    must("gh", dispatchArgs);
    log(`dispatched release.yml in ${repo}; waiting for the run`);
    const listArgs = [
      "run", "list", "-R", repo, "-w", "release.yml", "-L", "1",
      "--json", "databaseId", "-q", ".[0].databaseId",
    ];
    if (opts.ref) listArgs.splice(8, 0, "--branch", opts.ref);
    const runId = must("gh", listArgs);
    must("gh", ["run", "watch", runId, "-R", repo, "--exit-status"], { inherit: true });
    if (opts.workflowInput === "bump") {
      const tag = must("gh", ["release", "view", "-R", repo, "--json", "tagName", "-q", ".tagName"]);
      version = tag.replace(/^v/, "");
    } else {
      must("gh", ["release", "view", `v${version}`, "-R", repo, "--json", "tagName", "-q", ".tagName"]);
    }
  }
  const tag = `v${version}`;

  const scratch = mkdtempSync(join(tmpdir(), "repin-"));
  let checksums;
  try {
    must("gh", ["release", "download", tag, "-R", repo, "-p", "checksum.toml", "-D", scratch, "--clobber"]);
    checksums = parseChecksumToml(readFileSync(join(scratch, "checksum.toml"), "utf8"));
  } finally {
    rmSync(scratch, { recursive: true, force: true });
  }

  const releaseUrl = `https://github.com/${repo}/releases/tag/${tag}`;
  const rewritten = rewriteRecord(file.text, opts.id, version, checksums, releaseUrl);
  for (const extra of unusedChecksums(rewritten.src, opts.id, checksums)) {
    log(`note: ${tag} publishes ${extra}, which no registry asset uses`);
  }
  writeFileSync(file.path, rewritten.src);
  log(`rewrote ${opts.id} ${current} -> ${version} from checksum.toml`);

  must("git", ["fetch", "--tags"], { cwd: subDir });
  must("git", ["checkout", tag], { cwd: subDir });
  must("git", ["add", subPath], { cwd: root });
  const head = must("git", ["rev-parse", "HEAD"], { cwd: subDir });

  const providersPath = join(root, "scripts/ci/module-provider-pins.json");
  const providers = updateProviderPins(JSON.parse(readFileSync(providersPath, "utf8")), opts.id, version, head);
  if (providers.changed) {
    writeFileSync(providersPath, `${JSON.stringify(providers.json, null, 2)}\n`);
    log("updated scripts/ci/module-provider-pins.json");
  }
  const exemptPath = join(root, "scripts/ci/module-pin-exemptions.json");
  if (existsSync(exemptPath)) {
    const ex = dropExemption(JSON.parse(readFileSync(exemptPath, "utf8")), opts.id);
    if (ex.changed) {
      writeFileSync(exemptPath, `${JSON.stringify(ex.json, null, 2)}\n`);
      log(`dropped the now-stale ${opts.id} entry from module-pin-exemptions.json`);
    }
  }

  // The monotonic gate takes a base ref (default origin/main), not a root.
  const checks = [
    ["check-module-pins.mjs", [root]],
    ["check-submodule-monotonic.mjs", []],
  ];
  const failed = [];
  for (const [script, args] of checks) {
    const res = run("node", [join("scripts/ci", script), ...args], { cwd: root });
    log(`${script}: ${res.code === 0 ? "ok" : "FAILED"}`);
    if (res.code !== 0) {
      failed.push(script);
      log((res.stderr || res.stdout).trim());
    }
  }
  return { version, failed, dryRun: false };
}

if (import.meta.url === pathToFileURL(process.argv[1] ?? "").href) {
  try {
    const res = await repin(parseArgs(process.argv.slice(2)));
    process.exit(res.failed?.length ? 1 : 0);
  } catch (error) {
    process.stderr.write(`release-and-repin: ${error.message}\n`);
    process.exit(1);
  }
}