* fix(#2789): scope the emitted-drift ack to the diff that introduced it Every input to `diffEmitted` is base-relative -- `baseline` vs `current`, `changedPaths` from `git diff base...HEAD` -- except the ack set, which was read absolutely, from the working tree only. A differential machine consulting a non-differential input. So `staleAcks` asks exactly one question, "did a delta consume you?", and that cannot distinguish an ack that never explained anything (an authoring mistake) from one whose ripple is now absorbed into the base (the ack's SUCCESS condition). After merge an ack is in the second state but reports as the first. The trigger is ordinary. Actions sets GITHUB_BASE_REF on pull_request events only, so a push to `next` falls through to origin/next -- the very commit under test. Both sides build identical content, no deltas remain, and every live ack is reported stale. PR #2768 acked a deliberate 40866 -> 42020 byte growth, was green on its own lane, and reddened `next` the moment it merged. It also reds every PR branching off the poisoned base, and since publish-emitted-baseline is gated on the test job, it blocked baseline publication too. Give the ack the base side it was missing. `diffEmitted` now takes `baseAck` -- the same document at the base ref, via `readAckFileAtRef`. An entry already present there is SPENT: it may no longer consume a delta and is never reported stale, only surfaced as `spentAcks` for tidying. An entry new or reworded in this diff stays live, and if nothing consumes it that genuinely fails, with blame on the author who just wrote it. This closes a hazard the IMPLEMENTATION named but could not prevent -- a leftover ack silently pre-clearing the next ripple on its path. (ADR-2719 §3 asserted only that TOUCHING the file is the alarm; its residual-risk list never covered pre-clearing, and §3 now carries an amendment.) Verified against the two-PR laundering sequence -- land an innocuous ack, then change the artifact -- which passed silently before and now fails on both the hash pass and the size ratchet. Three things the design has to get right, each of which was wrong first: - A read failure on the base document THROWS; only absence-at-the-ref returns null. Returning null on error LOOKS armed (every entry stays live) but a live entry's defining power is that it CONSUMES a delta, so null is armed on the staleness axis and DISARMED on consumption -- silently the whole pre-#2789 gate. `git show` cannot tell absence from fault, so absence is established with `ls-tree`. - Re-arming a spent ack costs actual PROSE. Internal whitespace and the zero-width family collapse, and `runtime` is not compared: a doubled space, an invisible character, or a decorative field would otherwise re-arm an ack whose justification still describes the previous ripple, showing a reviewer nothing. - `baseAck` is REQUIRED once an ack declares entries -- omission is an error, not a silent "inherit nothing" -- so a dropped argument fails loudly instead of quietly restoring this bug with the suite green. Because a corrupt document ON THE BASE is expensive (the loud base-side failure reds every ack-carrying PR), scripts/lint-emitted-drift-ack.cjs blocks one from landing. It is standalone rather than importing parseAck -- scripts/ ships in the npm package and tests/ does not -- so a parity test runs both surfaces over one corpus and fails on divergence; it caught one immediately, a `null` document, now classed as policy rather than schema. Deadlock is separately foreclosed: a tree carrying no ack never reads the base, so the PR that DELETES a corrupt file still lands. `readAckFileAtRef` takes an injected git runner so all four branches are tested deterministically; it never executes in the remote runner, where the real-tree test skips for want of a base ref. It also refuses an option-shaped ref, since execFileSync's array form stops shell metacharacters but not git's own option parsing. Rejected: skipping the differential when base == HEAD. It treats the symptom, costs real coverage on the push-to-next lane, and does nothing about the downstream PRs the same flaw was reddening. Deletes the now-spent tests/emitted-drift-ack.json, and updates the CONTEXT.md canon and ADR-2719 §3: presence is no longer the alarm -- a LIVE entry is, and a spent one is inert. Closes #2789 * chore(#2789): backfill changeset PR number
702 lines
32 KiB
JavaScript
702 lines
32 KiB
JavaScript
'use strict';
|
|
|
|
/**
|
|
* Real-world I/O shell for the differential attribution check (#2723, ADR-2719).
|
|
*
|
|
* `emitted-diff.cjs` holds the pure conservation law; this module is the only place
|
|
* that touches git, the filesystem, or the installer. Keeping them apart is what makes
|
|
* the law's acceptance criteria testable in milliseconds — but the shell still has to
|
|
* exist and actually run, or the phase ships as interface-only, which an isolated
|
|
* reviewer correctly called out on the first cut of this work.
|
|
*
|
|
* ── Baseline source during the dual-run window ───────────────────────────────
|
|
* The baseline is the emitted manifest set at `next` HEAD. During Phase 3 that is
|
|
* available for FREE and for REAL via `git show origin/next:<fixture>` — the committed
|
|
* golden fixtures ARE next's recorded emitted state, and CI keeps them current there.
|
|
* No worktree, no rebuild, no 19 installer spawns for the baseline side.
|
|
*
|
|
* Critically this is NOT the same as reading the fixtures from the WORKING TREE: those
|
|
* are whatever the PR author regenerated, so comparing against them would be vacuous
|
|
* (current vs. the author's own regeneration). Reading them at `origin/next` is what
|
|
* makes the comparison a real differential against upstream state.
|
|
*
|
|
* Phase 4 (#2724) deletes the fixtures, at which point `resolveBaseline`'s cache path
|
|
* (already implemented and tested in emitted-baseline.cjs) becomes the source. That
|
|
* swap is the only change Phase 4 needs here.
|
|
*
|
|
* The CURRENT side is built for real — 19 installer spawns via the same
|
|
* `runMinimalInstall` + `buildParityManifest` the golden harness uses. It is the
|
|
* expensive half on purpose: if a PR forgot to regenerate, current-real differs from
|
|
* next's recorded state and the attribution actually runs, which is the whole point.
|
|
*/
|
|
|
|
const fs = require('node:fs');
|
|
const os = require('node:os');
|
|
const path = require('node:path');
|
|
const crypto = require('node:crypto');
|
|
const { execFileSync } = require('node:child_process');
|
|
|
|
const { cleanup } = require('../helpers.cjs');
|
|
const {
|
|
MANIFEST_FAMILIES,
|
|
MINIMUM_MANIFEST_FAMILIES,
|
|
runMinimalInstall,
|
|
buildParityManifest,
|
|
} = require('./install-shared.cjs');
|
|
|
|
const REPO_ROOT = path.join(__dirname, '..', '..');
|
|
/**
|
|
* Repo-relative and POSIX-separated on every platform: this form is what `git show
|
|
* <ref>:<path>` requires, and git speaks only forward slashes regardless of host OS.
|
|
* `ACK_PATH` derives from it so the two can never name different files.
|
|
*/
|
|
const ACK_REPO_PATH = 'tests/emitted-drift-ack.json';
|
|
const ACK_PATH = path.join(REPO_ROOT, ...ACK_REPO_PATH.split('/'));
|
|
const FIXTURE_SUBDIR = 'tests/fixtures/golden-install-parity';
|
|
|
|
/**
|
|
* Repo paths whose presence in a PR diff attributes a CHANGE TO THE FAMILY SET —
|
|
* a runtime being added or removed — as opposed to a change in emitted content.
|
|
*
|
|
* Deliberately NARROW: only the two surfaces that actually define the family set —
|
|
* `RUNTIME_META`'s home, and a runtime's capability descriptor. Every extra path here
|
|
* widens what silently excuses an unattributed family delta, so adjacent surfaces that
|
|
* merely *accompany* a runtime addition (name-policy, capability registry) are left out
|
|
* on purpose. A PR that adds a runtime necessarily touches one of these two.
|
|
*
|
|
* Deliberately path-based rather than diff-hunk-parsing: asserting that a diff adds a
|
|
* specific `RUNTIME_META` key would be a source-grep test, which this repo prohibits.
|
|
* The residual — a PR touching one of these for an unrelated reason may permit an
|
|
* otherwise-unexplained family delta — is recorded in the ADR-2719 risk register and is
|
|
* one class weaker than the false-attribution risk already accepted there.
|
|
*/
|
|
const REGISTRY_SIGNAL_PATHS = [
|
|
'tests/helpers/install-shared.cjs',
|
|
];
|
|
|
|
/**
|
|
* A capability descriptor: `capabilities/<runtime>/capability.json`, exactly one segment deep.
|
|
*
|
|
* Anchored, with `[^/]+` for the runtime segment. A prefix+suffix pair is NOT equivalent and
|
|
* was wrong: `capabilities/capability.json` satisfies both `startsWith('capabilities/')` and
|
|
* `endsWith('/capability.json')` with no runtime segment at all, and
|
|
* `capabilities/a/b/capability.json` satisfies them at the wrong depth. Both would have
|
|
* excused an unattributed family delta.
|
|
*/
|
|
const REGISTRY_SIGNAL_PATTERN = /^capabilities\/[^/]+\/capability\.json$/;
|
|
|
|
/**
|
|
* Reason codes for family reconciliation.
|
|
*
|
|
* Frozen and asserted as a set, so adding a code is a coordinated three-part change
|
|
* (enum, emitter, the test that locks the key list). Tests assert on these codes, never
|
|
* on rendered prose — the repo prohibits raw text matching on produced output.
|
|
*/
|
|
const FAMILY_REASON = Object.freeze({
|
|
BELOW_FLOOR: 'below_floor',
|
|
FIXTURE_WITHOUT_RUNTIME: 'fixture_without_runtime',
|
|
RUNTIME_WITHOUT_FIXTURE: 'runtime_without_fixture',
|
|
ADDED_UNATTRIBUTED: 'added_unattributed',
|
|
DROPPED_UNATTRIBUTED: 'dropped_unattributed',
|
|
MISSING_CLAUDE_LOCAL: 'missing_claude_local',
|
|
BASELINE_UNUSABLE: 'baseline_unusable',
|
|
CURRENT_UNUSABLE: 'current_unusable',
|
|
DERIVED_UNUSABLE: 'derived_unusable',
|
|
FIXTURES_UNUSABLE: 'fixtures_unusable',
|
|
BAD_CHANGED_PATHS: 'bad_changed_paths',
|
|
});
|
|
|
|
/** Path separators normalize UNCONDITIONALLY — backslash paths arrive on Linux too. */
|
|
function toPosix(p) {
|
|
return String(p).replace(/\\/g, '/');
|
|
}
|
|
|
|
/** True when `changedPaths` plausibly alters the runtime registry. */
|
|
function touchesRuntimeRegistry(changedPaths) {
|
|
return changedPaths.some((raw) => {
|
|
const p = toPosix(raw);
|
|
return REGISTRY_SIGNAL_PATHS.includes(p) || REGISTRY_SIGNAL_PATTERN.test(p);
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Reconcile the emitted manifest FAMILY SET across the three independent signals.
|
|
*
|
|
* ── Why this is not a count ──────────────────────────────────────────────────
|
|
* #2723 shipped a single literal (`EXPECTED_MANIFEST_COUNT = 19`) asserted against both
|
|
* the baseline (built at the base ref) and the current tree (built at PR HEAD). Those
|
|
* two legitimately differ by one family whenever a PR adds or removes a runtime, so no
|
|
* value of that literal could satisfy both: 19 rejected the current side, 20 rejected
|
|
* the baseline side. Every PR adding a runtime was hard-blocked.
|
|
*
|
|
* Equally important, a count cannot see a MEMBERSHIP SWAP — add one family and remove
|
|
* another and the totals still match while both changes go unexamined. The contract is
|
|
* therefore set-based in both directions.
|
|
*
|
|
* ── The three signals ────────────────────────────────────────────────────────
|
|
* derived what the runtime registry says this tree emits (MANIFEST_FAMILIES)
|
|
* fixtures what this tree has recorded (the committed glob)
|
|
* baseline what existed before this PR (families at the base ref)
|
|
*
|
|
* derived-vs-fixtures catches drift on a single tree; baseline-vs-current catches an
|
|
* unexplained change to the set; and the floor catches the case neither can — a universe
|
|
* that shrank uniformly, which a same-count self-check passes vacuously.
|
|
*
|
|
* Pure and IO-free by construction: the real-tree caller skips wherever no base ref
|
|
* exists (the gsd-test runner shallow-clones, so `origin/*` is absent), which would make
|
|
* a regression written at that altitude silently skip instead of proving anything.
|
|
*
|
|
* @param {object} o
|
|
* @param {Array<{name:string}>} o.derived families the registry implies
|
|
* @param {string[]} o.fixtures family names recorded on this tree
|
|
* @param {object|null} o.baseline manifests at the base ref (keyed by family)
|
|
* @param {object|null} o.current manifests at PR HEAD (keyed by family)
|
|
* @param {string[]} o.changedPaths repo-relative paths this PR changed
|
|
* @param {number} [o.minimum] absolute floor
|
|
* @returns {{ok: boolean, errors: Array<{code: string, family?: string}>}}
|
|
*/
|
|
function reconcileFamilies({
|
|
derived,
|
|
fixtures,
|
|
baseline,
|
|
current,
|
|
changedPaths,
|
|
minimum = MINIMUM_MANIFEST_FAMILIES,
|
|
} = {}) {
|
|
const errors = [];
|
|
const add = (code, family) => errors.push(family ? { code, family } : { code });
|
|
|
|
// Hostile-input gates first, and EVERY input gets one. Each returns an explicit code —
|
|
// never a quiet ok (indistinguishable from "the tree is clean" for a gate) and never an
|
|
// unhandled TypeError, which would read as an infrastructure fault rather than a verdict.
|
|
if (!Array.isArray(changedPaths)) {
|
|
add(FAMILY_REASON.BAD_CHANGED_PATHS);
|
|
return { ok: false, errors };
|
|
}
|
|
if (!Array.isArray(derived) || derived.some((f) => !f || typeof f.name !== 'string')) {
|
|
add(FAMILY_REASON.DERIVED_UNUSABLE);
|
|
return { ok: false, errors };
|
|
}
|
|
if (!Array.isArray(fixtures) || fixtures.some((n) => typeof n !== 'string')) {
|
|
add(FAMILY_REASON.FIXTURES_UNUSABLE);
|
|
return { ok: false, errors };
|
|
}
|
|
if (baseline === null || baseline === undefined || typeof baseline !== 'object' || Array.isArray(baseline)) {
|
|
add(FAMILY_REASON.BASELINE_UNUSABLE);
|
|
return { ok: false, errors };
|
|
}
|
|
if (current === null || current === undefined || typeof current !== 'object' || Array.isArray(current)) {
|
|
add(FAMILY_REASON.CURRENT_UNUSABLE);
|
|
return { ok: false, errors };
|
|
}
|
|
|
|
const derivedNames = new Set(derived.map((f) => f.name));
|
|
const fixtureNames = new Set(fixtures);
|
|
const baselineNames = new Set(Object.keys(baseline));
|
|
const currentNames = new Set(Object.keys(current));
|
|
|
|
// The floor. Independent of every derivation, so a uniformly shrunken universe cannot
|
|
// satisfy it by moving both sides together.
|
|
if (derivedNames.size < minimum) add(FAMILY_REASON.BELOW_FLOOR);
|
|
|
|
// Single-tree drift: the registry and the recorded fixtures must describe one world.
|
|
for (const name of fixtureNames) {
|
|
if (!derivedNames.has(name)) add(FAMILY_REASON.FIXTURE_WITHOUT_RUNTIME, name);
|
|
}
|
|
for (const name of derivedNames) {
|
|
if (!fixtureNames.has(name)) add(FAMILY_REASON.RUNTIME_WITHOUT_FIXTURE, name);
|
|
}
|
|
|
|
// #2086: claude's local-scope layout is a family in its own right and was once dropped
|
|
// from both sides at once. Pinned by name on both, never inferred from a total.
|
|
if (!currentNames.has('claude-local')) add(FAMILY_REASON.MISSING_CLAUDE_LOCAL, 'claude-local');
|
|
if (!baselineNames.has('claude-local')) add(FAMILY_REASON.MISSING_CLAUDE_LOCAL, 'claude-local');
|
|
|
|
// Cross-tree set difference, both directions, with ONE permission path: the PR
|
|
// plausibly touched the runtime registry. Symmetric on purpose — an ack-style bypass on
|
|
// only one side would make removals easier to wave through than additions, and the
|
|
// drift-ack file exists for unattributable emitted-PATH deltas, not for family churn.
|
|
const attributed = touchesRuntimeRegistry(changedPaths);
|
|
|
|
if (!attributed) {
|
|
for (const name of currentNames) {
|
|
if (!baselineNames.has(name)) add(FAMILY_REASON.ADDED_UNATTRIBUTED, name);
|
|
}
|
|
for (const name of baselineNames) {
|
|
if (!currentNames.has(name)) add(FAMILY_REASON.DROPPED_UNATTRIBUTED, name);
|
|
}
|
|
}
|
|
|
|
return { ok: errors.length === 0, errors };
|
|
}
|
|
|
|
/** Bounded git invocation. CLAUDE.md → KNOWN DEFECTS: every git subprocess needs a
|
|
* timeout (5-30s); an unbounded execFileSync is an indefinite hang, and it is how
|
|
* macOS CI silently stops reporting. */
|
|
const GIT_TIMEOUT_MS = 30_000;
|
|
|
|
/**
|
|
* Prepend `-c safe.directory=<dir>` to a git argv.
|
|
*
|
|
* The remote test-runner container mounts the repository at a path owned by a
|
|
* different uid than the process running the suite; git's dubious-ownership
|
|
* protection then refuses EVERY operation there with "detected dubious ownership"
|
|
* (#2767 — surfaced when a previously-always-skipping regression test started
|
|
* actually executing in that container and its very first `git rev-parse HEAD`
|
|
* failed closed). GitHub Actions never hits this because `actions/checkout`
|
|
* registers the workspace as a safe directory automatically; this runner's
|
|
* container does not. `buildBaselineAtRef` is the PRODUCTION build-fallback path
|
|
* the sole remaining emitted gate depends on (`resolveBaseline`'s in-job-build leg,
|
|
* ADR-2719 §5) — not just a test helper — so the fix belongs here, not papered
|
|
* over by skipping the test that found it.
|
|
*
|
|
* Declares the SPECIFIC resolved directory each call site already operates on —
|
|
* never the `*` wildcard, which would mark every repository on the machine safe —
|
|
* so this cannot broaden trust beyond the one path the caller already intends to
|
|
* touch. Every git call in this module (and its production/test callers) passes
|
|
* through here so the fix cannot silently drift per call site.
|
|
*/
|
|
function safeDirArgs(dir) {
|
|
return ['-c', `safe.directory=${path.resolve(dir)}`];
|
|
}
|
|
|
|
function git(args, { cwd = REPO_ROOT } = {}) {
|
|
return execFileSync('git', [...safeDirArgs(cwd), ...args], {
|
|
cwd,
|
|
encoding: 'utf8',
|
|
timeout: GIT_TIMEOUT_MS,
|
|
maxBuffer: 64 * 1024 * 1024,
|
|
stdio: ['ignore', 'pipe', 'pipe'],
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Repo paths the PR changed, via the three-dot form so the comparison is against the
|
|
* merge base rather than the tip of `base`.
|
|
*
|
|
* A git failure THROWS. It must never degrade to an empty array: reading "git broke" as
|
|
* "nothing changed" would make every moved hash unattributable and produce a failure
|
|
* storm that reads exactly like a real finding.
|
|
*/
|
|
function resolveChangedPaths(base = 'origin/next') {
|
|
let out;
|
|
try {
|
|
out = git(['diff', '--name-only', `${base}...HEAD`]);
|
|
} catch (err) {
|
|
throw new Error(
|
|
`emitted-attribution: could not resolve changed paths from "${base}...HEAD": ${err.message}. ` +
|
|
'This is a hard error on purpose — treating it as "no changes" would mark every ' +
|
|
'moved emitted path unattributable.',
|
|
);
|
|
}
|
|
return out.split('\n').map((l) => l.trim()).filter(Boolean);
|
|
}
|
|
|
|
/** Resolve `base` to a 40-hex sha, for the baseline cache-key discipline (ADR §5). */
|
|
function resolveBaseSha(base = 'origin/next') {
|
|
return git(['rev-parse', base]).trim();
|
|
}
|
|
|
|
/**
|
|
* The acknowledgment document AS IT EXISTS AT `base` — the base side of the ack
|
|
* lifecycle (#2789). An entry already present there is SPENT: its ripple is absorbed
|
|
* into the base, so it may no longer clear a delta and is never reported stale.
|
|
*
|
|
* ── Why "inherit nothing" is NOT a safe default ──────────────────────────────
|
|
* Absent at that ref is the healthy steady state and returns `null`. Every OTHER failure
|
|
* THROWS, and the distinction is load-bearing in the direction that is easy to get
|
|
* backwards. Returning `null` on a read error looks armed — nothing is inherited, so
|
|
* every entry stays live — but a LIVE entry's defining power is that it CONSUMES a
|
|
* delta. So `null` is armed on the staleness axis and DISARMED on the consumption axis,
|
|
* which is the axis a gate over shipped artifacts actually cares about: a genuinely new,
|
|
* unexplained ripple on a path carrying an already-merged ack would come back `acked`
|
|
* instead of `unattributable`. That is silently the whole pre-#2789 behavior, including
|
|
* the pre-clearing hazard this change exists to close.
|
|
*
|
|
* So this follows the same law as `resolveChangedPaths` above — a failed git read is an
|
|
* ERROR, not an empty set — and matches the head-side `readAckFile`, which already
|
|
* throws on a document that exists but will not parse. Being more forgiving about the
|
|
* base copy of the same file would be strictly worse: it is the copy we cannot see in
|
|
* the diff.
|
|
*
|
|
* `git show` alone cannot make the distinction — a bogus ref and an absent path produce
|
|
* the same "does not exist in" message — so absence is established with `ls-tree`, which
|
|
* exits 0 with empty output when the path is simply not there and non-zero on a real
|
|
* fault.
|
|
*/
|
|
function readAckFileAtRef(base, { cwd = REPO_ROOT, run = git } = {}) {
|
|
// `execFileSync`'s array form stops SHELL metacharacters but not git's own option
|
|
// parsing: a ref beginning with `-` is read as an option token, and `git show` honors
|
|
// diff options including `--output=<file>`, which writes. Today every caller passes a
|
|
// resolved 40-hex sha, but this function is exported and validated nothing itself —
|
|
// the guard belonged with the argument, not with the one caller that happens to be safe.
|
|
if (typeof base !== 'string' || base === '' || base.startsWith('-')) {
|
|
throw new Error(
|
|
`emitted-attribution: refusing to read the ack at ${JSON.stringify(base)} — a base ref `
|
|
+ 'must be a non-empty string that does not begin with "-", which git would parse as an option.',
|
|
);
|
|
}
|
|
|
|
let listing;
|
|
try {
|
|
listing = run(['ls-tree', '--name-only', base, '--', ACK_REPO_PATH], { cwd });
|
|
} catch (err) {
|
|
throw new Error(
|
|
`emitted-attribution: could not list the ack at "${base}": ${err.message}. This is a `
|
|
+ 'hard error on purpose — treating an unreadable base as "nothing inherited" would '
|
|
+ 'leave every ack able to consume a delta, which is the pre-#2789 gate.',
|
|
);
|
|
}
|
|
if (listing.trim() === '') return null; // genuinely absent at that ref — the steady state
|
|
|
|
let raw;
|
|
try {
|
|
raw = run(['show', `${base}:${ACK_REPO_PATH}`], { cwd });
|
|
} catch (err) {
|
|
throw new Error(
|
|
`emitted-attribution: ${ACK_REPO_PATH} exists at "${base}" but could not be read: ${err.message}`,
|
|
);
|
|
}
|
|
if (raw.trim() === '') {
|
|
throw new Error(`emitted-attribution: ${ACK_REPO_PATH} is present at "${base}" but empty`);
|
|
}
|
|
try {
|
|
return JSON.parse(raw);
|
|
} catch (err) {
|
|
throw new Error(
|
|
`emitted-attribution: ${ACK_REPO_PATH} at "${base}" is not valid JSON: ${err.message}`,
|
|
);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Base-ref candidates, most-specific first.
|
|
*
|
|
* The differential needs a ref for `next`, and that ref is NOT universally present:
|
|
* - the gsd-test runner shallow-clones and merges base+head, so no `origin/*`
|
|
* remote-tracking refs exist in the container (verified: `git rev-parse
|
|
* origin/next` fails there, which is what turned this test red on its first run);
|
|
* - GitHub Actions' checkout does not create remote-tracking branches for OTHER
|
|
* branches by default, which is exactly why `changeset-required.yml` carries an
|
|
* explicit `git fetch origin "${BASE_REF}:refs/remotes/origin/${BASE_REF}"` step.
|
|
*
|
|
* `GSD_EMITTED_BASE` lets a lane name the ref (or sha) directly. `GITHUB_BASE_REF` is
|
|
* set by Actions on pull_request events.
|
|
*/
|
|
function baseRefCandidates(env = process.env) {
|
|
const candidates = [];
|
|
if (env.GSD_EMITTED_BASE) candidates.push(env.GSD_EMITTED_BASE);
|
|
if (env.GITHUB_BASE_REF) {
|
|
candidates.push(`origin/${env.GITHUB_BASE_REF}`, env.GITHUB_BASE_REF);
|
|
}
|
|
candidates.push('origin/next', 'next');
|
|
return [...new Set(candidates)];
|
|
}
|
|
|
|
/**
|
|
* First candidate base ref that actually resolves, or null when none do.
|
|
*
|
|
* Returning null is NOT a pass — the caller turns it into an explicit `t.skip()` with
|
|
* the full candidate list in the message, so an environment where the gate did not run
|
|
* says so out loud. A bare `return` there would be a PASS (ADR-2719 §6), and a hard
|
|
* failure would make the suite permanently red in the gsd-test container, where no
|
|
* base ref can exist by construction.
|
|
*/
|
|
function resolveBase(env = process.env) {
|
|
for (const candidate of baseRefCandidates(env)) {
|
|
try {
|
|
const sha = git(['rev-parse', '--verify', `${candidate}^{commit}`]).trim();
|
|
if (/^[0-9a-f]{40}$/.test(sha)) return { ref: candidate, sha };
|
|
} catch { /* try the next candidate */ }
|
|
}
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Family names present in the fixture directory AT `base`.
|
|
*
|
|
* Enumerated from the ref itself, NOT from `MANIFEST_FAMILIES` — that constant is
|
|
* imported at module load and therefore describes PR HEAD's registry. Deriving the
|
|
* baseline from it makes a REMOVED runtime invisible: the name is already gone from the
|
|
* current registry, so the loop never asks the base ref for it, `baseline` silently omits
|
|
* a family that genuinely existed, and the dropped-family check can never fire. Asking
|
|
* the ref what it actually contains is the only way the "before" side is really "before".
|
|
*
|
|
* NOT called by the real-tree test's production path as of #2724 (ADR-2719 Phase 4) —
|
|
* `buildBaselineAtRef` + `resolveBaseline()` replaced it, since the fixture directory
|
|
* this reads no longer exists at any ref from the cutover commit forward. Kept
|
|
* (alongside `baselineManifestsAtRef`/`baselineSizesAtRef` below) because it still
|
|
* answers a real question for a REF THAT PREDATES THE CUTOVER — bisecting into the
|
|
* dual-run window (#2723) or earlier — and its own regression test below pins a real
|
|
* property (the baseline must reflect the ref, not the current registry) that would
|
|
* otherwise go untested.
|
|
*/
|
|
function baselineFamilyNamesAtRef(base, { cwd = REPO_ROOT } = {}) {
|
|
let out;
|
|
try {
|
|
out = git(['ls-tree', '--name-only', base, `${FIXTURE_SUBDIR}/`], { cwd });
|
|
} catch {
|
|
return []; // fixtures absent at that ref (e.g. after Phase 4's cutover)
|
|
}
|
|
return out
|
|
.split('\n')
|
|
.map((line) => line.trim())
|
|
.filter((line) => line.endsWith('.json'))
|
|
.map((line) => line.slice(line.lastIndexOf('/') + 1).replace(/\.json$/, ''))
|
|
// These names become object keys below. They now come from git output rather than a
|
|
// trusted constant, so a fixture committed as `__proto__.json` would turn
|
|
// `manifests[name] = parsed` into a prototype write. Compared inline (not via a Set)
|
|
// because that is the form the prototype-pollution analysis recognizes.
|
|
.filter((name) => name !== '__proto__' && name !== 'constructor' && name !== 'prototype');
|
|
}
|
|
|
|
/**
|
|
* Emitted manifest set at `base`, read from the committed fixtures at that ref.
|
|
* Returns null when the fixtures are absent at `base` (i.e. after Phase 4's cutover),
|
|
* which is the signal to fall back to `resolveBaseline`'s cache path.
|
|
*/
|
|
function baselineManifestsAtRef(base = 'origin/next') {
|
|
const manifests = {};
|
|
let found = 0;
|
|
for (const name of baselineFamilyNamesAtRef(base)) {
|
|
let raw;
|
|
try {
|
|
raw = git(['show', `${base}:${FIXTURE_SUBDIR}/${name}.json`]);
|
|
} catch {
|
|
continue; // absent at that ref
|
|
}
|
|
let parsed;
|
|
try {
|
|
parsed = JSON.parse(raw);
|
|
} catch (err) {
|
|
throw new Error(`emitted-attribution: ${base}:${FIXTURE_SUBDIR}/${name}.json is not valid JSON: ${err.message}`);
|
|
}
|
|
if (parsed === null || typeof parsed !== 'object' || Array.isArray(parsed)) {
|
|
throw new Error(`emitted-attribution: ${base}:${FIXTURE_SUBDIR}/${name}.json must be an object of path->hash`);
|
|
}
|
|
manifests[name] = parsed;
|
|
found++;
|
|
}
|
|
return found === 0 ? null : manifests;
|
|
}
|
|
|
|
/**
|
|
* Build the baseline artifact at `ref` FOR REAL — a throwaway `git worktree` checked
|
|
* out at `ref`, MEASURED by `cwd`'s (the calling checkout's) OWN
|
|
* `scripts/gen-emitted-baseline.cjs` (#2724/#2767, ADR-2719 §5's "in-job build at
|
|
* origin/next" fallback).
|
|
*
|
|
* ── Why the generator runs from `cwd`, not from the worktree ─────────────────────
|
|
* `scripts/gen-emitted-baseline.cjs` was ADDED by the same PR that deleted the golden
|
|
* fixtures this fallback used to read instead (#2724). A base ref that predates that PR
|
|
* — which is every `next` this fallback is ever asked to measure, since the fallback
|
|
* only runs on a cache miss for a ref that has not been through the publish job yet —
|
|
* therefore never has the script at `<worktreeDir>/scripts/gen-emitted-baseline.cjs`,
|
|
* and invoking it there fails closed with `Cannot find module` on every single call: the
|
|
* fallback could never bootstrap. Running `cwd`'s copy instead, with `--dir worktreeDir`
|
|
* telling it WHICH tree's installer to measure, isn't merely the workaround for that —
|
|
* it is the more correct differential semantics regardless: a diff needs ONE measurement
|
|
* schema applied to BOTH sides, or the sides stop being comparable the moment that
|
|
* schema evolves (a new exclusion rule, a new manifest family) between the two commits.
|
|
* Letting each side measure itself with its own, potentially different, version of the
|
|
* script would silently reintroduce exactly that incomparability.
|
|
*
|
|
* This is the slow path, used only on a `resolveBaseline()` cache miss. The worktree
|
|
* needs no `npm ci`: `bin/install.js` and the `tests/helpers/*.cjs` real-tree shells are
|
|
* all Node-builtins-only (CONTRIBUTING.md's "No external dependencies in core"). It DOES
|
|
* need `npm run build:lib` run there first, though — `tests/helpers/install-shared.cjs`
|
|
* requires the TSC-COMPILED `gsd-core/bin/lib/runtime-artifact-layout.cjs`, which is
|
|
* gitignored, not committed, and therefore absent from a bare worktree checkout, and
|
|
* `<worktreeDir>/bin/install.js` (spawned BY `cwd`'s generator via `currentManifests`'s
|
|
* `repoRoot` override) needs its own compiled copy alongside it, not `cwd`'s. `node_modules`
|
|
* is symlinked in from the calling checkout (never copied — `npm ci` inside every
|
|
* fallback build would make an already-slow path far slower) so `tsc` is available
|
|
* without a second install; the worktree's OWN `src/*.cts` and `tsconfig.build.json`
|
|
* are what gets compiled, so the MEASURED installer reflects `ref`, not `cwd`'s tree —
|
|
* only the measurement CODE (the generator, install-shared.cjs, emitted-runtime.cjs)
|
|
* comes from `cwd`.
|
|
*
|
|
* Every subprocess is bounded. The worktree is always removed, success or failure —
|
|
* a leaked worktree would poison `git worktree list` for every subsequent run in the
|
|
* same checkout (CI runners reuse the same clone across jobs in some configurations).
|
|
*
|
|
* @param {string} ref the ref/sha to build at (e.g. `origin/next`, a 40-hex sha)
|
|
* @param {object} [o]
|
|
* @param {string} [o.cwd] repo to run `git worktree` from AND whose generator measures it
|
|
* @returns {object} the parsed baseline artifact ({version, sha, manifests, sizes})
|
|
*/
|
|
function buildBaselineAtRef(ref, { cwd = REPO_ROOT } = {}) {
|
|
const worktreeDir = fs.mkdtempSync(path.join(os.tmpdir(), 'gsd-emitted-baseline-wt-'));
|
|
// mkdtempSync already created the directory; `git worktree add` requires the
|
|
// target to not exist (or be empty) — remove it and let git recreate it.
|
|
fs.rmdirSync(worktreeDir);
|
|
const outFile = path.join(os.tmpdir(), `gsd-emitted-baseline-out-${crypto.randomBytes(8).toString('hex')}.json`);
|
|
|
|
const WORKTREE_TIMEOUT_MS = 60_000;
|
|
const BUILD_LIB_TIMEOUT_MS = 180_000;
|
|
const BUILD_TIMEOUT_MS = 300_000;
|
|
|
|
try {
|
|
execFileSync('git', [...safeDirArgs(cwd), 'worktree', 'add', '--detach', worktreeDir, ref], {
|
|
cwd, encoding: 'utf8', timeout: WORKTREE_TIMEOUT_MS, stdio: ['ignore', 'pipe', 'pipe'],
|
|
});
|
|
|
|
const sharedNodeModules = path.join(cwd, 'node_modules');
|
|
if (fs.existsSync(sharedNodeModules)) {
|
|
fs.symlinkSync(sharedNodeModules, path.join(worktreeDir, 'node_modules'), 'dir');
|
|
}
|
|
|
|
execFileSync('npm', ['run', 'build:lib'], {
|
|
cwd: worktreeDir, encoding: 'utf8', timeout: BUILD_LIB_TIMEOUT_MS, stdio: ['ignore', 'pipe', 'pipe'],
|
|
});
|
|
|
|
// Run `cwd`'s OWN generator (not the worktree's — see the function doc for why),
|
|
// pointed at the worktree as the tree to measure.
|
|
execFileSync(
|
|
process.execPath,
|
|
[path.join(cwd, 'scripts', 'gen-emitted-baseline.cjs'), '--dir', worktreeDir, '--out', outFile],
|
|
{ cwd, encoding: 'utf8', timeout: BUILD_TIMEOUT_MS, stdio: ['ignore', 'pipe', 'pipe'] },
|
|
);
|
|
|
|
const raw = fs.readFileSync(outFile, 'utf8');
|
|
return JSON.parse(raw);
|
|
} finally {
|
|
try {
|
|
execFileSync('git', [...safeDirArgs(cwd), 'worktree', 'remove', '--force', worktreeDir], {
|
|
cwd, encoding: 'utf8', timeout: WORKTREE_TIMEOUT_MS, stdio: ['ignore', 'pipe', 'pipe'],
|
|
});
|
|
} catch {
|
|
// Best-effort: the checkout may already be gone (e.g. the build step failed
|
|
// before writing anything). Prune stale admin data rather than leaving it.
|
|
try {
|
|
execFileSync('git', [...safeDirArgs(cwd), 'worktree', 'prune'], {
|
|
cwd, encoding: 'utf8', timeout: WORKTREE_TIMEOUT_MS, stdio: ['ignore', 'pipe', 'pipe'],
|
|
});
|
|
} catch { /* best-effort cleanup; never mask the primary result/error */ }
|
|
}
|
|
// Same guarantee as the git cleanup above: an EBUSY/EPERM here must not replace
|
|
// whatever the `try` block was about to return or throw.
|
|
try {
|
|
fs.rmSync(outFile, { force: true });
|
|
} catch { /* best-effort cleanup; never mask the primary result/error */ }
|
|
try {
|
|
fs.rmSync(worktreeDir, { recursive: true, force: true });
|
|
} catch { /* best-effort cleanup; never mask the primary result/error */ }
|
|
}
|
|
}
|
|
|
|
/** Size maps at `base`, for the ratchet half. Null when absent at that ref. */
|
|
function baselineSizesAtRef(base = 'origin/next') {
|
|
const sizes = {};
|
|
let found = 0;
|
|
for (const rel of ['tests/workflow-size-baseline.json', 'tests/agent-size-baseline.json']) {
|
|
try {
|
|
const parsed = JSON.parse(git(['show', `${base}:${rel}`]));
|
|
if (parsed && typeof parsed === 'object' && !Array.isArray(parsed)) {
|
|
Object.assign(sizes, parsed);
|
|
found++;
|
|
}
|
|
} catch { /* absent at that ref */ }
|
|
}
|
|
return found === 0 ? null : sizes;
|
|
}
|
|
|
|
/**
|
|
* Build the CURRENT emitted manifest set for real — one installer spawn per runtime.
|
|
* This is the expensive, honest half: it reflects what the tree actually emits now,
|
|
* not what the author regenerated into a fixture.
|
|
*
|
|
* @param {object} [opts]
|
|
* @param {string} [opts.repoRoot] - Measure a DIFFERENT checkout's installer instead of
|
|
* this one's (#2767). When set, `<repoRoot>/bin/install.js` is spawned rather than
|
|
* THIS checkout's `bin/install.js` — the measurement schema (this function, the
|
|
* exclusion rules in install-shared.cjs) stays fixed at the caller's version while the
|
|
* installer code being measured varies. This is what lets `gen-emitted-baseline.cjs`
|
|
* apply ONE definition of "the emitted manifest" to two different trees (PR HEAD and a
|
|
* base-ref worktree) so the two sides stay comparable even if the definition itself
|
|
* evolves — running the OTHER tree's own (older, or absent) copy of this function would
|
|
* defeat that.
|
|
*/
|
|
function currentManifests({ repoRoot } = {}) {
|
|
const installScript = repoRoot ? path.join(repoRoot, 'bin', 'install.js') : undefined;
|
|
const manifests = {};
|
|
for (const { name, runtime, scope } of MANIFEST_FAMILIES) {
|
|
const { configDir, root } = runMinimalInstall({ runtime, scope, installScript });
|
|
try {
|
|
manifests[name] = buildParityManifest(configDir, root);
|
|
} finally {
|
|
cleanup(root);
|
|
}
|
|
}
|
|
return manifests;
|
|
}
|
|
|
|
/**
|
|
* Current on-disk sizes for the workflow + agent families the ratchet covers.
|
|
* @param {object} [opts]
|
|
* @param {string} [opts.repoRoot] - Read `<repoRoot>/gsd-core/workflows` and
|
|
* `<repoRoot>/agents` instead of this checkout's own (#2767) — same rationale as
|
|
* `currentManifests`'s `repoRoot`.
|
|
*/
|
|
function currentSizes({ repoRoot = REPO_ROOT } = {}) {
|
|
const sizes = {};
|
|
for (const [dir, filter] of [
|
|
[path.join(repoRoot, 'gsd-core', 'workflows'), (f) => f.endsWith('.md')],
|
|
[path.join(repoRoot, 'agents'), (f) => f.endsWith('.md')],
|
|
]) {
|
|
if (!fs.existsSync(dir)) continue;
|
|
for (const entry of fs.readdirSync(dir, { withFileTypes: true })) {
|
|
if (!entry.isFile() || !filter(entry.name)) continue;
|
|
sizes[entry.name] = fs.statSync(path.join(dir, entry.name)).size;
|
|
}
|
|
}
|
|
return sizes;
|
|
}
|
|
|
|
/**
|
|
* Read `tests/emitted-drift-ack.json`.
|
|
* Absent is legal and means "no acks" — its PRESENCE is the alarm (ADR §3).
|
|
* A present-but-unreadable or unparseable file THROWS: silently treating it as absent
|
|
* would disarm the gate in the one case where someone is actively using it.
|
|
*/
|
|
function readAckFile(ackPath = ACK_PATH) {
|
|
if (!fs.existsSync(ackPath)) return null;
|
|
const raw = fs.readFileSync(ackPath, 'utf8');
|
|
if (raw.trim() === '') {
|
|
throw new Error(`emitted-attribution: ${path.basename(ackPath)} is present but empty`);
|
|
}
|
|
try {
|
|
return JSON.parse(raw);
|
|
} catch (err) {
|
|
throw new Error(`emitted-attribution: ${path.basename(ackPath)} is not valid JSON: ${err.message}`);
|
|
}
|
|
}
|
|
|
|
module.exports = {
|
|
REPO_ROOT,
|
|
ACK_PATH,
|
|
ACK_REPO_PATH,
|
|
readAckFileAtRef,
|
|
FIXTURE_SUBDIR,
|
|
MANIFEST_FAMILIES,
|
|
MINIMUM_MANIFEST_FAMILIES,
|
|
REGISTRY_SIGNAL_PATHS,
|
|
FAMILY_REASON,
|
|
touchesRuntimeRegistry,
|
|
reconcileFamilies,
|
|
GIT_TIMEOUT_MS,
|
|
safeDirArgs,
|
|
git,
|
|
resolveChangedPaths,
|
|
resolveBaseSha,
|
|
baseRefCandidates,
|
|
resolveBase,
|
|
baselineFamilyNamesAtRef,
|
|
baselineManifestsAtRef,
|
|
baselineSizesAtRef,
|
|
buildBaselineAtRef,
|
|
currentManifests,
|
|
currentSizes,
|
|
readAckFile,
|
|
};
|