Files
msd-core/tests/helpers/emitted-runtime.cjs
Tom Boucher 1c1af70a4b refactor(#2724): delete the committed golden fixtures and size baselines (#2767)
* test(#2724): delete golden-install-parity fixtures, test, and generator

Removes the 19 committed path->hash manifests, the two per-file size
baselines, tests/golden-install-parity.test.cjs, and
scripts/gen-golden-install-parity-zcode.cjs. These were pure functions
of the source tree (ADR-2719); the differential attribution check
(tests/emitted-attribution.test.cjs + tests/emitted-provenance.test.cjs)
is now the sole gate for emitted-artifact propagation.

tests/fixtures/install-tree/*.json and tests/golden-install-tree.test.cjs
are unchanged (ADR-2719 section 7 exception).

Follow-up commits fix the resulting bookkeeping: scripts/ci-test-scope.cjs's
existence guard, .gitattributes, package.json scripts, the emitted-provenance
totality guard's IO, the differential check's baseline acquisition, CI
wiring to publish/restore the baseline artifact, and docs.

* refactor(#2724): make the differential attribution check self-sufficient

Three fixes required to delete the golden fixtures without breaking CI:

- scripts/ci-test-scope.cjs: remove tests/golden-install-parity.test.cjs
  from the three rules that named it. #2759's missingRuleTestFiles guard
  hard-throws at module load if a rule names a test file absent from
  disk, which would break the changes job on every PR the moment the
  fixture-deletion commit landed.

- tests/helpers/emitted-provenance.cjs: loadManifests() read the
  committed golden fixture directory. With that directory deleted at
  every future ref, this would throw at module load forever, taking
  the Phase 2 totality guard down with it. Rebuilt from real installer
  spawns (MANIFEST_FAMILIES + runMinimalInstall + buildParityManifest),
  the same shape emitted-runtime.cjs's currentManifests() already uses.

- tests/emitted-attribution.test.cjs / tests/helpers/emitted-runtime.cjs:
  the real-tree test's baseline acquisition swaps from
  baselineManifestsAtRef(base) (git show at a ref that no longer carries
  fixtures) to resolveBaseline()'s documented precedence: env, then the
  on-disk cache, then an in-job build. The build fallback
  (buildBaselineAtRef, new) checks out base into a throwaway git
  worktree and runs the new scripts/gen-emitted-baseline.cjs there --
  no npm ci needed, since bin/install.js and the test helper shells are
  Node-builtins-only. That script also publishes the baseline artifact
  from CI's push-to-next job (wired in a follow-up commit).

* refactor(#2724): retire the merge-driver bridge and per-file size baselines

The Phase 1 bridge (#2721) is retired now that the artifacts it guarded
are deleted: scripts/git-merge-regen-driver.cjs, its test, and the
'setup:merge-driver' npm script are removed, and the .gitattributes
merge=gsd-regen/linguist-generated block for the three deleted-path
globs is dropped. tests/fixtures/install-tree/*.json keeps its normal
merge behavior, unchanged (ADR-2719 section 7).

scripts/update-size-baseline.cjs and its test are removed: their sole
purpose was regenerating tests/workflow-size-baseline.json and
tests/agent-size-baseline.json, both deleted. The 'size:baseline' npm
script and its step in 'regen:derived' go with it. The per-file
baseline describe blocks in tests/workflow-size-budget.test.cjs and
tests/agent-size-budget.test.cjs are removed for the same reason; the
independent loose-tier hard caps are untouched. The differential
attribution check's size ratchet (tests/emitted-diff.cjs, already
shipped in #2723) is the replacement anti-creep mechanism.

'npm run gen:golden' is replaced by 'npm run gen:install-tree', which
keeps regenerating tests/fixtures/install-tree/*.json (the one artifact
family ADR-2719 section 7 keeps committed); tests/golden-install-tree.test.cjs's
error messages point at the new command name.

tests/golden-parity-single-source.test.cjs's anti-divergence guard
(#2266) is retargeted from the two deleted golden-parity consumers to
their two replacements (tests/helpers/emitted-runtime.cjs and
tests/helpers/emitted-provenance.cjs), which import buildParityManifest
the same way — the divergence risk the guard exists for is unchanged.

Also wires CI: a new publish-emitted-baseline job runs
scripts/gen-emitted-baseline.cjs after a push to next and caches the
result keyed on the sha; the test and test-full jobs restore that cache
on pull_request events, keyed on the PR's base sha, and export
GSD_EMITTED_BASELINE for tests/emitted-attribution.test.cjs's real-tree
test to pick up.

* docs(#2724): flip ADR-2719 to Accepted and update contributor docs

Status: Proposed -> Accepted. Regenerated docs/adr/README.md index.

CONTRIBUTING.md, docs/TESTING-SUITES.md, and CONTEXT.md (RULESET.
EMITTED_ATTRIBUTION, RULESET.WORKFLOW_SIZE_BUDGET, RULESET.
AGENT_SIZE_BUDGET, and the Emitted Artifact Provenance glossary entry)
no longer point at the deleted golden-install-parity fixtures, size
baselines, gen:golden, UPDATE_GOLDEN, or the setup:merge-driver /
git-merge-regen-driver.cjs bridge. Editing shipped content now
requires zero manual fixture regeneration, documented against the
differential attribution check instead of the deleted commands.

* docs(#2724): add changeset for removed golden-parity commands

* fix(#2724): drop stale scripts/update-size-baseline.cjs glossary ref

check-glossary-refs.cjs verifies every backtick-wrapped scripts/*.cjs
token in CONTEXT.md resolves to a real file. The RULESET.
EMITTED_ATTRIBUTION rewrite named the deleted script inside backticks,
which the checker reads as a live reference, not historical prose.

* test(#2724): retarget ci-test-scope tests off the deleted golden test

tests/ci-test-scope.test.cjs asserted specific RULES entries select
tests/golden-install-parity.test.cjs, and that every rule selecting it
also selects both emitted gates. Both premises broke when the golden
test was deleted (#2724): the deleted filename never re-appears in
targeted_tests, and there was no longer a third file for the gates to
travel alongside. Retargeted the two selection describe blocks to
assert tests/emitted-provenance.test.cjs directly (the drift guard the
golden gate's rules were retargeted to), and simplified the third block
to assert the two emitted gates always travel together, without
reference to the golden filename.

* docs(#2724): repoint two contributor how-to guides at the differential check

Both guides told contributors to regenerate a baseline against
tests/golden-install-parity.test.cjs, which #2724 deletes. Repointed
at the differential attribution check (tests/emitted-attribution.test.cjs,
ADR-2719), which needs no manual regeneration step.

* fix(#2724): repair phase6-capstone-conformance's deleted-baseline read

An independent orthogonal review caught a real regression this branch
introduced into a test file the branch's diff never touched:
tests/phase6-capstone-conformance.test.cjs read
tests/workflow-size-baseline.json (deleted earlier in this branch) with
no fallback, so the whole suite would throw ENOENT the moment this
branch landed. The test's actual intent — prove the host-loop workflow
files are real, tracked, non-empty docs — is preserved by asserting the
live byte count via the same shared counter (scripts/workflow-size.cjs)
the size guards already use, instead of a committed snapshot.

Also, from the same review: a stale doc comment in
scripts/workflow-size.cjs still named the deleted
scripts/update-size-baseline.cjs as a consumer, and
buildBaselineAtRef's cleanup in tests/helpers/emitted-runtime.cjs left
two fs.rmSync calls unguarded against masking the primary result/error,
inconsistent with the try/catch already wrapping the git cleanup beside
them. Both fixed. A doc comment was added to baselineFamilyNamesAtRef
explaining why it (and its siblings) are kept despite having no
production caller post-cutover — they still answer real questions
about refs that predate the cutover.

* fix(#2724): repair three real regressions found by remote verification

1. tests/emitted-provenance.test.cjs's two hostile-input tests
   (non-object manifest, unreadable fixture) drove loadManifests(tmp)
   and monkeypatched fs.readFileSync, both premised on the deleted
   fixture-directory read this branch already replaced with real
   installer spawns -- the negative assertions silently stopped firing.
   loadManifests() now accepts injected {families, install, build,
   clean} (defaulting to production values), giving the tests a real
   seam to drive a bad build result and a build failure through the
   ACTUAL loader instead of a reimplementation, and added coverage that
   clean() still runs on both paths.

2. .github/workflows/test.yml's two 'Export GSD_EMITTED_BASELINE'
   steps hardcoded shell: bash, which is wrong on windows-latest (native
   pwsh) and on test-full's macos-latest legs (native zsh per that job's
   own matrix) -- the repo's H1 shell policy (tests/policy-shell-pinning
   .test.cjs) caught it. Replaced the inline bash script with
   scripts/ci-export-emitted-baseline-env.cjs, a plain Node script: a
   bare 'node <path>' command line has no shell-specific syntax, so it
   runs correctly under bash, zsh, and pwsh without a shell override.

tests/phase6-capstone-conformance.test.cjs's deleted-baseline read
(caught by the same remote run, at a commit prior to this one) was
already fixed in d0c3b1242 and is not touched here; verified still
passing after these changes.

* fix(#2724): revive ADR-1610's new-file size cap inside the differential

An isolated review caught a real regression: deleting
tests/workflow-size-baseline.json silently dropped NEW_FILE_CAP
(ADR-1610 Decision point 3, the Codex project_doc_max_bytes anchor)
with no successor. tests/helpers/emitted-diff.cjs's size ratchet
already 'continue's past any file absent from sizeBaseline -- exactly
the files this cap exists to bound -- so a brand-new workflow file
sized 32,769-40,960 bytes passed CI clean and shipped, then risked
silent truncation at the Codex anchor at runtime. ADR-1610 is Accepted
and never referenced anywhere in this branch.

Fix: NEW_FILE_CAP=32768 revived inside emitted-diff.cjs's own
size-ratchet loop, keyed off the SAME hasOwnProperty(sizeBaseline,
name) signal the growth check already computes -- 'new' is exactly
'present in sizeCurrent, absent from sizeBaseline'. Not ack-able,
matching the tier hard caps it sits beside: the fix is extraction, not
an acknowledgment entry. Documented, disclosed narrowing: the pure
differential module cannot see XL_WORKFLOWS/LARGE_WORKFLOWS tiering
(tests/workflow-size-budget.test.cjs's classification), so a
legitimately large new file must extract rather than tier in, one
release earlier than an existing file would need to. ADR-1610 itself is
left unamended -- this restores its decision rather than re-litigating
it.

Also fixes a stale comment plus a redundant real 19-installer-spawn
assertion left over from the pre-injection-seam version of
tests/emitted-provenance.test.cjs's build-failure test, and annotates
3 of 4 stale golden-fixture citations in
docs/reference/host-integration-capability-matrix.md as superseded
(the 4th is an accurate historical PR narrative, left alone).

* fix(#2724): repair three red CI defects on the golden-fixture cutover

Windows-only provenance false attribution (defect A): the `hooks-built`
provenance rule attributed `hooks/<name>.cmd` to itself. Those shims are
Windows-only installer output (ensureCodexHooksJsonSessionStart /
ensureCodexHooksJsonEvent, both in src/runtime-hooks-surface.cts) wrapping
the same-named `.js` hook — no `.cmd` file is ever tracked in the repo, so
the self-attribution resolved to a path that exists on no platform. Only
windows-latest ever emits the key, so this only failed there. Fixed by
special-casing `.cmd` inside the SAME `hooks-built` rule (not a dedicated
rule) — a dedicated rule would match zero paths, and therefore report as a
dead rule, on every non-Windows lane of the same totality guard. `sources`
already supported per-match functions; `transforms` is extended to support
the same shape so the attribution can vary by match within one rule.

Baseline bootstrap was structurally impossible (defect B): `buildBaselineAtRef`
ran `scripts/gen-emitted-baseline.cjs` from INSIDE the base-ref worktree, but
that script is new in this PR and therefore absent at any base ref that
predates it — every call failed closed with "Cannot find module". Fixed by
running the PR checkout's own generator against the worktree via a new `--dir`
parameter, decoupling "which copy of the script runs" from "which tree it
measures" (`currentManifests`/`currentSizes` gained a `repoRoot` override,
threaded down to `runMinimalInstall`'s new `installScript` override). This is
not just a bootstrap fix: a differential needs ONE measurement schema applied
to both sides, or the two stop being comparable the moment that schema
evolves — running each side's own copy would silently reintroduce that risk.
Verified locally end-to-end against real origin/next: resolves a valid
{version, sha, manifests, sizes} artifact with the correct sha and no leaked
worktree.

Changeset placeholder (defect C): `pr: 0` -> `pr: 2767`, which is what let
docs-lint evaluate the fragment for the first time; it already passes
(docs/TESTING-SUITES.md and friends already document the removed scripts).

Also fixed while in this file: an eslint no-unused-vars warning surfaced by
the changed lint run (unused `cleanup` import in
tests/emitted-provenance.test.cjs).

Added regression coverage for both A and B: a cross-platform spot-check that
drives the real hooks-built rule against `.cmd` keys directly (not through a
real Windows install), and a real-tree test that drives buildBaselineAtRef
against a base ref verified (via git cat-file) to lack the generator, both
skipping honestly rather than false-passing when their precondition does not
hold.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01W5kQs6ZufZDySC6zDJfYP6

* fix(#2724): repair false .cmd byte-provenance and a permanently-skipping regression test

Two isolated-review findings on PR #2767:

- `hooks-built`'s `.cmd` branch attributed the Windows shim's bytes to the
  wrapped `hooks/<name>.js` script, asserting a byte-provenance link that
  does not exist — traced against buildCodexHookWindowsShimIR
  (src/runtime-hooks-surface.cts), only the script's NAME (a literal in that
  same file) flows into the .cmd bytes, never its content. Point `sources`
  at HOOKS_WINDOWS_SHIM_SRC instead, matching the code-derived convention
  used elsewhere in the table. Since `sources` is checked before
  `transforms` in the differential, the wrong mapping silently excused any
  .cmd byte movement caused by editing the wrapped .js file.

- The `buildBaselineAtRef` regression test skipped unless a resolvable base
  ref still lacked scripts/gen-emitted-baseline.cjs — true only until this
  PR merges, after which every base ref carries the file and the test skips
  forever with zero ongoing coverage. Rebuilt hermetically: synthesize the
  missing-generator condition in-place via git plumbing (a throwaway commit,
  child of HEAD, with just that one file removed from a scratch index),
  never touching the real working tree, HEAD, or index, and never depending
  on ambient history or remotes.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01W5kQs6ZufZDySC6zDJfYP6

* fix(#2724): tolerate the remote runner's dubious-ownership git mount in the emitted baseline path

The runner container mounts the repo at a path owned by a different uid than
the process running the suite, so git's dubious-ownership protection refuses
every git operation there. GitHub Actions never hits this because
actions/checkout registers the workspace as safe automatically; this
runner's container does not.

buildBaselineAtRef is the production build-fallback the sole remaining
emitted gate depends on (resolveBaseline's in-job-build leg), not just a
test helper, so the fix is in the shared git() wrapper (emitted-runtime.cjs)
that every caller — resolveChangedPaths, resolveBase, buildBaselineAtRef's
worktree add/remove/prune, and the hermetic regression test added in the
prior commit — funnels through, plus gen-emitted-baseline.cjs's own
rev-parse (now reusing that same wrapper instead of a second execFileSync,
so the fix has one source of truth). Each call declares -c
safe.directory=<the exact directory it already operates on>, never the *
wildcard.

Audited every other helper on this surface (emitted-diff.cjs,
emitted-baseline.cjs, install-shared.cjs) for the same gap: none of them
shell out to git at all.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01W5kQs6ZufZDySC6zDJfYP6

---------

Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-07-28 15:41:43 -04:00

622 lines
28 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, '..', '..');
const ACK_PATH = path.join(REPO_ROOT, 'tests', 'emitted-drift-ack.json');
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();
}
/**
* 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,
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,
};