@outerlayer/cli 0.33.0 → 0.34.0-next.20261023233807

package/skill-pack/maintained/outerlayer-amend/scripts/rerecord-demo.mjs

@@ -1,187 +0,0 @@
-#!/usr/bin/env node
-// Records an item's demo again at the pull request's new head, after an
-// amend pushed. It reads the item's newest demo record, and records again
-// only a demo that was recorded at an earlier commit and names the test that
-// recorded it. Needs only Node.
-//
-//   node rerecord-demo.mjs --item <number> --pr <number> [--repository <owner/name>] [--project <playwright project>]
-//
-// Run it after the amend's last push, with the app running as the
-// repository's instructions say. It prints one line for the amend's report:
-// recorded again, current, or why not. It posts one comment on the item's
-// general thread when the demo is out of date and cannot be recorded again,
-// when a chapter failed its checks, or when the recording failed. It posts
-// nothing when the item has no demo, or the demo is current.
-import { spawnSync } from "node:child_process";
-import { existsSync, mkdtempSync, readdirSync, rmSync } from "node:fs";
-import { tmpdir } from "node:os";
-import { basename, dirname, isAbsolute, join, relative } from "node:path";
-import { pathToFileURL } from "node:url";
-
-const USAGE = "usage: rerecord-demo.mjs --item <number> --pr <number> [--repository <owner/name>] [--project <playwright project>]";
-const CONFIG_NAMES = ["ts", "js", "mjs", "cjs", "mts", "cts"].map((extension) => `playwright.config.${extension}`);
-
-/** The `spawnSync` that runs a program in `cwd`; tests pass a stand-in. */
-function runProgram(command, args, options) {
-  return spawnSync(command, args, { encoding: "utf8", maxBuffer: 256 * 1024 * 1024, ...options });
-}
-
-/** `owner/name` of a repository in any spelling the factory stores, lower-case. */
-function repositoryName(repository) {
-  return repository
-    .replace(/\.git$/, "")
-    .split("/")
-    .filter((part) => part !== "")
-    .slice(-2)
-    .join("/")
-    .toLowerCase();
-}
-
-/** A test path inside the repository, or `null` when the path is absolute or leaves it. */
-function insidePath(test) {
-  if (typeof test !== "string" || test === "" || isAbsolute(test) || test.split("/").includes("..")) return null;
-  return test;
-}
-
-/** The nearest folder from the test's own up to the root that holds a Playwright config, else the root. */
-function configFolder(root, testFile) {
-  let folder = dirname(testFile);
-  while (folder.startsWith(root)) {
-    if (CONFIG_NAMES.some((name) => existsSync(join(folder, name)))) return folder;
-    if (folder === root) break;
-    folder = dirname(folder);
-  }
-  return root;
-}
-
-/** Every `demo/manifest.json` under `folder`. */
-function findManifests(folder) {
-  const found = [];
-  for (const entry of readdirSync(folder, { withFileTypes: true })) {
-    const path = join(folder, entry.name);
-    if (entry.isDirectory()) found.push(...findManifests(path));
-    else if (entry.name === "manifest.json" && basename(folder) === "demo") found.push(path);
-  }
-  return found;
-}
-
-/** The last line of a command's output that parses as a JSON object, or `null`. */
-function lastJson(text) {
-  for (const line of String(text).split("\n").reverse()) {
-    try {
-      const value = JSON.parse(line);
-      if (value !== null && typeof value === "object") return value;
-    } catch {
-      // not the JSON line
-    }
-  }
-  return null;
-}
-
-/**
- * Records the demo again when it is out of date and names its test.
- * `spawn(command, args, { cwd })` returns `{ status, stdout, stderr }`.
- * Returns the outcome and the line for the amend's report.
- */
-export function rerecordDemo({ item, pr, repository, project, cwd, spawn = runProgram }) {
-  const cli = (args) => {
-    const result = spawn("outerlayer", args, { cwd });
-    // Without `outerlayer` on PATH, the CLI runs through npx.
-    return result.error?.code === "ENOENT" ? spawn("npx", ["-y", "@outerlayer/cli", ...args], { cwd }) : result;
-  };
-  // The line for the amend's report says so when a comment did not post, so nobody waits for it.
-  const comment = (body) => (cli(["work", "comment", "--item", String(item), "--body", body]).status === 0 ? "" : " The comment on the item's thread was not posted.");
-
-  const read = cli(["work", "demo", "--item", String(item), "--json"]);
-  const answer = read.status === 0 ? lastJson(read.stdout) : null;
-  if (answer === null) {
-    const detail = String(read.stderr ?? "").trim();
-    return { outcome: "error", line: `Demo: could not read the item's demo${detail === "" ? "" : ` (${detail})`}.` };
-  }
-  const demo = answer.demo ?? null;
-  if (demo === null) return { outcome: "none", line: "Demo: the item has no demo to record again." };
-  if (repository !== undefined && repositoryName(String(demo.repository ?? "")) !== repositoryName(repository)) {
-    return { outcome: "other-repository", line: `Demo: the item's demo is in ${demo.repository}, not ${repository}.` };
-  }
-
-  const head = String(spawn("git", ["rev-parse", "HEAD"], { cwd }).stdout ?? "").trim();
-  const short = (sha) => (sha === "" ? "an unknown commit" : sha.slice(0, 7));
-  if (demo.commitSha === head) return { outcome: "current", line: `Demo: current, recorded at ${short(head)}.` };
-
-  const byHand = `outerlayer emit demo <manifest> --item ${item} --pr ${pr} --replaces ${demo.artifactId}`;
-  const stale = `The demo is out of date: it was recorded at ${short(String(demo.commitSha ?? ""))}, and the branch is now at ${short(head)}.`;
-  const root = String(spawn("git", ["rev-parse", "--show-toplevel"], { cwd }).stdout ?? "").trim() || cwd;
-  if (demo.record === null) {
-    const why = "Its record cannot be read, so the amend cannot tell which test to run.";
-    const unposted = comment(`${stale} ${why} To record it again, run the demo test, then run \`${byHand}\`.`);
-    return { outcome: "not-recorded", line: `Demo: out of date at ${short(String(demo.commitSha ?? ""))}; ${why.charAt(0).toLowerCase()}${why.slice(1)}${unposted}` };
-  }
-  const test = insidePath(demo.record?.test);
-  const testFile = test === null ? null : join(root, test);
-
-  if (test === null || !existsSync(testFile)) {
-    const why =
-      demo.record?.test === undefined || demo.record?.test === null
-        ? "Its record names no test, so the amend cannot record it again."
-        : `The test ${demo.record.test} is not in the checkout, so the amend cannot record it again.`;
-    const unposted = comment(`${stale} ${why} To record it again, run the demo test, then run \`${byHand}\`.`);
-    return { outcome: "not-recorded", line: `Demo: out of date at ${short(String(demo.commitSha ?? ""))}; ${why.charAt(0).toLowerCase()}${why.slice(1)}${unposted}` };
-  }
-
-  const output = mkdtempSync(join(tmpdir(), "outerlayer-rerecord-"));
-  try {
-    const folder = configFolder(root, testFile);
-    // Playwright reads the filter as a regular expression, so a path such as app/[id]/x.spec.ts needs its characters escaped.
-    const filter = relative(folder, testFile).split("\\").join("/").replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
-    const run = spawn("npx", ["playwright", "test", filter, "--output", output, ...(project === undefined ? [] : ["--project", project])], { cwd: folder });
-    // A failed check still writes the manifest, and emit demo reports the failed chapter. Only a missing manifest stops here.
-    const manifests = existsSync(output) ? findManifests(output) : [];
-    if (manifests.length !== 1) {
-      const why =
-        manifests.length === 0
-          ? `Running ${test} left no demo manifest (exit ${run.status}).`
-          : `Running ${test} left ${manifests.length} demo manifests, so the amend cannot tell which to store. Pass --project <name> so the test runs once.`;
-      const unposted = comment(`${stale} ${why} To record it again, run the demo test, then run \`${byHand}\`.`);
-      return { outcome: "error", line: `Demo: out of date at ${short(String(demo.commitSha ?? ""))}; ${why}${unposted}` };
-    }
-
-    const emit = cli(["emit", "demo", manifests[0], "--item", String(item), "--pr", String(pr), "--replaces", demo.artifactId, "--json"]);
-    const result = emit.status === 0 || emit.status === 1 ? lastJson(emit.stdout) : null;
-    if (result === null) {
-      const why = `Storing the new demo failed: ${String(emit.stderr ?? "").trim().split("\n")[0] || `exit ${emit.status}`}.`;
-      const unposted = comment(`${stale} ${why} To record it again, run \`${byHand}\` on the manifest of a new run.`);
-      return { outcome: "error", line: `Demo: out of date at ${short(String(demo.commitSha ?? ""))}; ${why}${unposted}` };
-    }
-    const synced = cli(["sync"]);
-    const unsynced = synced.status === 0 ? "" : ` The sync failed (exit ${synced.status}), so the new demo is stored but the session record is not uploaded. Run \`outerlayer sync\`.`;
-    const failures = Array.isArray(result.failures) ? result.failures : [];
-    if (failures.length > 0) {
-      const unposted = comment(`The demo was recorded again at ${short(head)}, but a chapter failed its checks. A failed chapter is stored but not bound to its criterion:\n${failures.map((line) => `- ${line}`).join("\n")}`);
-      return { outcome: "failed-chapters", line: `Demo: recorded again at ${short(head)}, but ${failures.join("; ")}.${unsynced}${unposted}` };
-    }
-    if (unsynced !== "") return { outcome: "sync-failed", line: `Demo: recorded again at ${short(head)}.${unsynced}` };
-    return { outcome: "recorded", line: `Demo: recorded again at ${short(head)}.` };
-  } finally {
-    rmSync(output, { recursive: true, force: true });
-  }
-}
-
-/** The value after `flag`, or `undefined`. */
-function flagValue(argv, flag) {
-  const at = argv.indexOf(flag);
-  return at === -1 ? undefined : argv[at + 1];
-}
-
-function main(argv) {
-  const item = Number(flagValue(argv, "--item"));
-  const pr = Number(flagValue(argv, "--pr"));
-  if (!Number.isInteger(item) || item <= 0 || !Number.isInteger(pr) || pr <= 0) {
-    process.stderr.write(`${USAGE}\n`);
-    return 2;
-  }
-  const { line } = rerecordDemo({ item, pr, repository: flagValue(argv, "--repository"), project: flagValue(argv, "--project"), cwd: process.cwd() });
-  process.stdout.write(`${line}\n`);
-  return 0;
-}
-
-if (process.argv[1] && import.meta.url === pathToFileURL(process.argv[1]).href) process.exitCode = main(process.argv.slice(2));