* test(#3942): failing-first suite for the emitted-drift ack commit trailer Binds 37 input classes from the phase test matrix to the behavior ADR-3942 specifies, before any of it exists. Stubs return benign empty values rather than throwing, deliberately: several rows assert that something DOES throw (cap overflow, uncomputable commit range), and a throwing stub would turn those green for the wrong reason and destroy the red. The two rows that carry the design's load: - merge-base semantics. The range is $(git merge-base base HEAD)..HEAD, not base..HEAD, because changedPaths comes from `git diff base...HEAD` (three dot). Two-dot would let the ack set and the change set disagree about which commits are this PR's. The fixture forks a topic branch, puts a trailer on each side, and asserts only the topic-side trailer is in range. - fail-closed on an uncomputable range. With fragments a depth-1 checkout passes VACUOUSLY, every fragment reading as brand-new. With trailers the range cannot be computed at all, and returning an empty set would silently disarm the gate, so it must throw. The fixture builds a genuine shallow clone rather than simulating one. Also covers the self-inflicted case: this change's own documentation quotes the trailer syntax, so an example landing at the end of a commit message would arm a live acknowledgment keyed on the literal placeholder text. Keys carrying angle brackets or whitespace are rejected. Authored per the phase artifacts 40-design.md and 50-test-matrix.md. Not yet run on the remote runner — this commit exists to be tested. Refs #3942 * chore(#3942): move the emitted-drift ack to a commit trailer Implements ADR-3942, superseding ADR-2719 section 3 and its #2789 amendment. Sections 1, 2 and 4-7 are retained: the conservation law is unchanged, only the storage of its escape hatch moved off the working tree. An acknowledgment explains one PR's ripple, and the moment that PR merges the ripple is in the base, so it can never clear anything again. It was stored in permanent shared state anyway, and every consequence of that mismatch had to be built and then maintained. The chain is #2789 -> #2914 -> #3078 -> #3842 -> #3823 -> #3875, each fix generating the next defect, ending in a scheduled sweeper whose own first PR could not merge itself. Added parseAckTrailers + renderAckTrailer (pure) and readAckTrailers (IO shell), reading Emitted-Drift-Ack-Hash: / Emitted-Drift-Ack-Growth: trailers over the merge-base range. tests/emitted-ack-trailer.test.cjs, 37 cases, written failing-first and confirmed red before any of this existed. Changed diffEmitted takes two structurally distinct key-space maps instead of one shared paths map. That closes a latent defect: the spaces were separated by convention only, so a growth key satisfied a hash lookup by naming coincidence. staleAcks now reports which space a key was declared in. REMEDIATION teaches the trailer, per space, with its example rendered through renderAckTrailer so the taught grammar cannot drift from what the parser accepts. Removed the sweep workflow, the guard-no-ack-on-next job, the standalone linter and its lint:ci entry, the fragment directory and its three spent fragments, the legacy single-file union, and the baseAck/spentAcks mechanism -- spentness is now structural, not computed. Two range properties carry the design and are pinned by tests rather than asserted: the range is merge-base scoped, matching git diff base...HEAD, so an already-merged trailer is out of range by construction; and an uncomputable range throws instead of reading as zero acknowledgments, which is the inverse of the fragment guard's vacuous pass. Three deliberate observable changes, each disclosed in the changeset: the unread runtime field is gone, the legacy file is no longer read, and cross-space excusal no longer works. Ten open PRs carry fragments and will meet a modify/delete conflict. Measured before landing and accepted deliberately; the one-line migration is in the PR body. Verified: lint:ci exit 0. Remote runner to follow on this exact sha. Refs #3942 * fix(#3942): silent trailer collapse, lost coverage, and an unbounded cap Six findings from the orthogonal review round, all fixed in place. BLOCKER -- two trailers of the same name on one commit collapsed silently. readAckTrailers built `separator=1d` where git needs `separator=%x1d`: the `separator=` value inside a %(trailers:...) placeholder is itself a pretty-format string, so the bare hex was emitted as two literal characters and the split on \x1d never matched. Two same-name trailers therefore joined into one value with errors empty -- the first reason absorbing the second entry's key. Silent truncation, the exact class MAX_ACK_TRAILERS throws to prevent. Confirmed with od -c against real git output before and after. The failing-first matrix did not catch it because its "both spaces coexist" row uses Hash plus Growth -- different trailer NAMES -- so the value separator was never exercised. Two regression tests now cover same-name trailers directly. Coverage recovered: normalizeAckReason and INVISIBLE stayed on the live path via parseAckTrailers but lost every test when the old suite was pruned. Back under test against the current surface -- all six invisible codepoints individually, whitespace collapse, trim, CRLF, and two seeded fast-check properties. Dropping any single codepoint now fails. MAX_ACK_TRAILERS counted raw trailers before de-duplication, so one trailer carried forward across rebased commits counted once per commit and could throw on a legitimate branch. Now counts distinct entries; 100 identical repeats dedupe to one. diffEmitted validated baseline, current and changedPaths but not the new ackHash/ackGrowth, so a bad shape raised an unhandled TypeError instead of an error verdict -- the same defect shape this file documents for #2778. Docs: CONTRIBUTING and TESTING-SUITES were rewritten only in their first sections; the later passages still taught fragments, git rm and the deleted guard, contradicting the new text directly above them. Finished. Also extends lint-removed-but-needed to exempt docs/adr and docs/research. That gate fails on any docs mention of a file deleted in the same diff, which makes it impossible to document a deletion in the PR performing it -- an ADR's whole job is naming what it retired. Exemption is narrow and comes with a test proving the gate still fires for a live consumer elsewhere under docs/. A guard that cannot fail is worse than no guard. Maintainer-approved. CONTEXT.md names the retired machinery by role rather than by filename: its generated projection lands in docs/, which that gate does scan. Adds docs/how-to/acknowledge-emitted-drift.md. The required docs set is Reference and Explanation, so the task quadrant can be empty with every gate green -- and this change has a real multi-step journey, including the fragment migration ten open PRs now need. lint:ci exit 0. Refs #3942 * docs(#3942): correct the duplicate-trailer rule in CONTRIBUTING Both axes of the code review independently flagged the same passage, without seeing each other's output. It claimed two declarations of the same key are always "a hard, loudly-reported error, not a silent last-wins". That is only half true, and the missing half is the one contributors hit: identical declarations -- same key, same reason -- dedupe silently, because a trailer legitimately survives a rebase and reappears on every rebased commit. Failing there would red a branch for doing nothing wrong, which is exactly why the dedup exists. Only a same-key/different-reason pair errors, and that one is a genuine ambiguity about which explanation holds. As written, the paragraph told a contributor that a rebase-carried trailer breaks the gate -- the opposite of the behavior. CONTEXT.md's parallel entry already stated it correctly; this brings CONTRIBUTING into line. Doc-only, root-level markdown. Refs #3942 * chore(#3942): backfill changeset PR number to 3954 --------- Co-authored-by: sim <sim@local>
855 lines
41 KiB
JavaScript
855 lines
41 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, runNpm } = require('../helpers.cjs');
|
|
const {
|
|
MANIFEST_FAMILIES,
|
|
MINIMUM_MANIFEST_FAMILIES,
|
|
runMinimalInstall,
|
|
buildParityManifest,
|
|
extraEmitRootsFor,
|
|
PKG_VERSION,
|
|
} = require('./install-shared.cjs');
|
|
const { ACK_TRAILER_HASH, ACK_TRAILER_GROWTH, parseAckTrailers } = require('./emitted-diff.cjs');
|
|
const { runGit, OUTCOME } = require('./process-seam.cjs');
|
|
|
|
const REPO_ROOT = path.join(__dirname, '..', '..');
|
|
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})
|
|
*/
|
|
const WORKTREE_TIMEOUT_MS = 60_000;
|
|
const BUILD_LIB_TIMEOUT_MS = 180_000;
|
|
// 360s for the generator step. NOT the 600000ms `local/no-unbounded-spawn`
|
|
// ceiling: `scripts/run-tests.cjs:973` bounds the WHOLE chunk at 600000ms, so a
|
|
// step bound equal to it loses the race — the chunk is killed first and the
|
|
// failure arrives as an opaque "no failed step" kill instead of the per-step
|
|
// message below. The bounds must escalate inward-out, and
|
|
// `emitted-runtime-bounds` in tests/emitted-attribution.test.cjs locks that.
|
|
//
|
|
// Measured for this step: ~22s idle in a container, ~142s with 8 CPU burners on
|
|
// 8 cores, 91.6s and 115.8s in the run that passed, and 300.1s in the run that
|
|
// timed out (censored — its real need is unknown). 360s is ~3x the passing
|
|
// observation and 20% above the censored one, while leaving 240s of chunk
|
|
// headroom for every other file sharing the chunk.
|
|
//
|
|
// The old 300s sat INSIDE that variance band. Under gsd-test this slow path runs
|
|
// on every verification, because the on-disk baseline cache is restored by
|
|
// actions/cache keyed on github.event.pull_request.base.sha — a key that exists
|
|
// only inside GitHub Actions. The real remedy is making that cache reachable from
|
|
// the remote runner so the in-job build returns to being the rare fallback
|
|
// ADR-2719 §5 describes; that is a gsd-test-runner change, not one this repo can
|
|
// make.
|
|
const BUILD_TIMEOUT_MS = 360_000;
|
|
// Mirrors `scripts/run-tests.cjs:973`'s default. Duplicated deliberately and
|
|
// narrowly: the bounds here must be checkable against it, and the alternative is
|
|
// reading that script's source, which `local/no-source-grep` bans. The lock test
|
|
// names this as the drift risk.
|
|
const CHUNK_TIMEOUT_CEILING_MS = 600_000;
|
|
|
|
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`);
|
|
|
|
// Per-step timings, carried into the thrown error. A bare "spawnSync ETIMEDOUT"
|
|
// names neither the step nor its elapsed time, which is exactly the information
|
|
// needed to tell a slow machine from a hung step — and the failure message is
|
|
// the only channel that survives into the remote runner's failures.json.
|
|
const timings = [];
|
|
const timed = (step, fn) => {
|
|
const started = Date.now();
|
|
try {
|
|
const value = fn();
|
|
timings.push(`${step}=${((Date.now() - started) / 1000).toFixed(1)}s`);
|
|
return value;
|
|
} catch (err) {
|
|
const elapsed = ((Date.now() - started) / 1000).toFixed(1);
|
|
timings.push(`${step}=FAILED@${elapsed}s`);
|
|
const partial = [
|
|
err && err.stdout ? `stdout tail: ${String(err.stdout).trim().slice(-400)}` : '',
|
|
err && err.stderr ? `stderr tail: ${String(err.stderr).trim().slice(-400)}` : '',
|
|
].filter(Boolean).join('\n ');
|
|
err.message =
|
|
`${step} failed after ${elapsed}s (bounds: worktree ${WORKTREE_TIMEOUT_MS}ms, ` +
|
|
`build:lib ${BUILD_LIB_TIMEOUT_MS}ms, generator ${BUILD_TIMEOUT_MS}ms). ` +
|
|
`Step timings: ${timings.join(' ')}. ${err.message}` +
|
|
(partial ? `\n ${partial}` : '');
|
|
throw err;
|
|
}
|
|
};
|
|
|
|
try {
|
|
timed('git-worktree-add', () =>
|
|
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');
|
|
}
|
|
|
|
timed('npm-run-build-lib', () =>
|
|
runNpm(['run', 'build:lib'], {
|
|
cwd: worktreeDir, 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.
|
|
timed('gen-emitted-baseline', () =>
|
|
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'] },
|
|
));
|
|
|
|
return timed('read-artifact', () => JSON.parse(fs.readFileSync(outFile, 'utf8')));
|
|
} 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;
|
|
}
|
|
|
|
/**
|
|
* The package version of the tree whose emitted output is about to be measured.
|
|
*
|
|
* `bin/install.js` bakes `{{GSD_VERSION}}` -> `pkg.version` into every emitted hook,
|
|
* and `buildParityManifest`'s `pkgVersion` normalization exists to collapse that stamp
|
|
* back to '<VERSION>' so a version bump alone never moves a hash. That normalization is
|
|
* only correct when `pkgVersion` matches the version of the tree that PRODUCED the
|
|
* content being hashed — for `repoRoot`-driven cross-tree measurement (#2767, #2891)
|
|
* that is NOT necessarily this checkout's own `PKG_VERSION`. This helper resolves the
|
|
* right version for whichever tree is actually being measured.
|
|
*
|
|
* Fails closed: a missing, unreadable, unparseable, or version-less `package.json` at
|
|
* `repoRoot` throws rather than silently falling back to this checkout's own version —
|
|
* a silent fallback here is exactly the cross-tree mis-attribution bug #2891 fixes
|
|
* (every emitted hook path would spuriously differ, and the differential attribution
|
|
* gate would blame nothing for it).
|
|
*
|
|
* @param {string} [repoRoot] - absolute path to the tree being measured. Only an
|
|
* OMITTED (or explicit `undefined`) repoRoot means "this checkout" and returns this
|
|
* module's own PKG_VERSION with no I/O. Any OTHER falsy value (`''`, `0`, `false`) is
|
|
* NOT treated as "this checkout" — it is a caller-side bug (e.g. an unresolved path
|
|
* variable) and must fail closed rather than silently measuring the wrong tree,
|
|
* consistent with `currentManifests`' `installScript` gate below and with how
|
|
* `buildParityManifest`'s `pkgVersion` treats an explicit-but-empty value as a caller
|
|
* error rather than a fallback trigger (#2891 review FINDING 7).
|
|
* @returns {string} non-empty package version string.
|
|
*/
|
|
function measuredPackageVersion(repoRoot) {
|
|
if (repoRoot === undefined) return PKG_VERSION;
|
|
if (!repoRoot) {
|
|
throw new Error(
|
|
`measuredPackageVersion: repoRoot must be a non-empty path or omitted entirely, got ${JSON.stringify(repoRoot)}. ` +
|
|
'An omitted/undefined repoRoot means "this checkout"; any other falsy value is treated as a caller error.'
|
|
);
|
|
}
|
|
|
|
const pkgPath = path.join(repoRoot, 'package.json');
|
|
let raw;
|
|
try {
|
|
raw = fs.readFileSync(pkgPath, 'utf8');
|
|
} catch (err) {
|
|
throw new Error(
|
|
`measuredPackageVersion: cannot read ${pkgPath} (${err.message}); cannot normalize ` +
|
|
'emitted version for the measured tree; a wrong version silently mis-attributes every hook.'
|
|
);
|
|
}
|
|
|
|
let parsed;
|
|
try {
|
|
parsed = JSON.parse(raw);
|
|
} catch (err) {
|
|
throw new Error(
|
|
`measuredPackageVersion: ${pkgPath} is not valid JSON (${err.message}); cannot normalize ` +
|
|
'emitted version for the measured tree; a wrong version silently mis-attributes every hook.'
|
|
);
|
|
}
|
|
|
|
const version = parsed && parsed.version;
|
|
if (typeof version !== 'string' || version.length === 0) {
|
|
throw new Error(
|
|
`measuredPackageVersion: ${pkgPath} has no non-empty string "version" field; cannot ` +
|
|
'normalize emitted version for the measured tree; a wrong version silently mis-attributes every hook.'
|
|
);
|
|
}
|
|
return version;
|
|
}
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* The version normalized into '<VERSION>' inside each manifest entry is resolved via
|
|
* `measuredPackageVersion(repoRoot)` — i.e. `<repoRoot>/package.json`'s own version,
|
|
* NOT this checkout's — since `<repoRoot>/bin/install.js` is what stamped the emitted
|
|
* content in the first place (#2891).
|
|
*/
|
|
function currentManifests({ repoRoot } = {}) {
|
|
// Gated the same way `measuredPackageVersion` gates its own repoRoot below: only an
|
|
// omitted/`undefined` repoRoot means "this checkout" (installScript stays the
|
|
// default). Any other falsy value falls through to `measuredPackageVersion`, which
|
|
// throws — this line never gets a chance to diverge from that same rule (#2891
|
|
// review FINDING 7).
|
|
const installScript = repoRoot !== undefined ? path.join(repoRoot, 'bin', 'install.js') : undefined;
|
|
const pkgVersion = measuredPackageVersion(repoRoot);
|
|
const manifests = {};
|
|
for (const { name, runtime, scope } of MANIFEST_FAMILIES) {
|
|
const { configDir, root } = runMinimalInstall({ runtime, scope, installScript });
|
|
try {
|
|
manifests[name] = buildParityManifest(configDir, root, {
|
|
pkgVersion,
|
|
// #3738: cover home-override emit roots outside configDir (antigravity
|
|
// → <HOME>/.gemini/config) so the differential keeps seeing them.
|
|
extraEmitRoots: extraEmitRootsFor(runtime, scope, 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;
|
|
}
|
|
|
|
/**
|
|
* Bounded git invocation for the #3942 commit-trailer ack reader, built on the
|
|
* never-throws process seam (`runGit`) rather than `git()` above: `readAckTrailers` must
|
|
* honor a PER-CALL `timeoutMs` (row 24's hostile-timeout row), and `git()` pins
|
|
* `GIT_TIMEOUT_MS` at import time with no per-call override. Throws on anything but a
|
|
* clean exit — same "a git failure is a hard error, never an empty result" law as
|
|
* `resolveChangedPaths` above.
|
|
*/
|
|
function ackTrailerGit(args, { cwd = REPO_ROOT, timeoutMs = GIT_TIMEOUT_MS } = {}) {
|
|
const result = runGit([...safeDirArgs(cwd), ...args], { cwd, timeoutMs });
|
|
if (result.outcome === OUTCOME.EXITED && result.exitCode === 0) {
|
|
return result.stdout;
|
|
}
|
|
throw new Error(
|
|
`emitted-ack-trailer: \`git ${args.join(' ')}\` failed — outcome=${result.outcome} `
|
|
+ `exitCode=${result.exitCode} stderr=${(result.stderr || '').trim()}`,
|
|
);
|
|
}
|
|
|
|
// Record/field/value separators for the `git log --format` trailer extraction below.
|
|
// ASCII control characters (RS/US/GS) so they can never collide with real trailer
|
|
// content, following the precedent at gsd-core/workflows/ship.md:312 (`%x1f`/`%x1e` for
|
|
// a different `%(trailers:...)` extraction in this same repo).
|
|
const ACK_TRAILER_RECORD_SEP = '\x1e'; // between commits
|
|
const ACK_TRAILER_FIELD_SEP = '\x1f'; // between the hash-space list and growth-space list
|
|
const ACK_TRAILER_VALUE_SEP = '\x1d'; // between multiple values of the SAME trailer key
|
|
|
|
/**
|
|
* Read #3942 commit-trailer acknowledgments over `<mergeBase>..<headRef>`.
|
|
*
|
|
* ── Why the merge-base is resolved here, not taken as `baseRef` verbatim ──────
|
|
* `changedPaths` (`resolveChangedPaths` above) is three-dot (merge-base) by construction,
|
|
* and 40-design.md's Correction 2 requires the trailer range to agree — otherwise a
|
|
* trailer could excuse a delta structurally outside the diff. Reading
|
|
* `<mergeBase>..<headRef>` (never `<baseRef>..<headRef>`) is what makes a trailer on the
|
|
* OTHER side of a fork correctly out of range (row 7/8 — structural spentness).
|
|
*
|
|
* ── Why an uncomputable range THROWS, never returns empty ─────────────────────
|
|
* A shallow clone (or any ref sharing no history with `headRef`) makes the merge-base
|
|
* uncomputable. Returning an empty result here would read as "no acks needed" — a false
|
|
* GREEN that silently disarms the gate. This is 40-design.md's Correction 1 (row 15/22):
|
|
* every failure path below throws, naming "range"/"merge-base"/"shallow".
|
|
*
|
|
* Trailer values are read with git's OWN trailer parser
|
|
* (`%(trailers:key=...,valueonly)`), never a regex over the message body, so a mid-body
|
|
* mention of the trailer syntax (row 32 — this PR's own docs teach the grammar) is
|
|
* correctly inert. `\r` is stripped from every value before parsing (row 27 — a CRLF
|
|
* commit message must parse identically to LF).
|
|
*
|
|
* @param {{baseRef: string, headRef?: string, cwd?: string, timeoutMs?: number}} opts
|
|
* @returns {{hash: Map<string, {reason: string}>, growth: Map<string, {reason: string}>, errors: string[]}}
|
|
*/
|
|
function readAckTrailers({ baseRef, headRef = 'HEAD', cwd = REPO_ROOT, timeoutMs = GIT_TIMEOUT_MS } = {}) {
|
|
let mergeBaseOut;
|
|
try {
|
|
mergeBaseOut = ackTrailerGit(['merge-base', baseRef, headRef], { cwd, timeoutMs });
|
|
} catch (err) {
|
|
throw new Error(
|
|
`emitted-ack-trailer: could not compute a merge-base range for "${baseRef}..${headRef}" `
|
|
+ '(a bad ref, a shallow clone with no common ancestor, or another git failure): '
|
|
+ err.message,
|
|
);
|
|
}
|
|
const mergeBase = mergeBaseOut.trim();
|
|
if (!/^[0-9a-f]{40}$/.test(mergeBase)) {
|
|
throw new Error(
|
|
`emitted-ack-trailer: git merge-base for "${baseRef}..${headRef}" returned no usable `
|
|
+ `commit (${JSON.stringify(mergeBase)}) — the range is structurally uncomputable `
|
|
+ '(possibly a shallow clone with no common ancestor).',
|
|
);
|
|
}
|
|
|
|
// `separator=` inside a `%(trailers:...)` placeholder is itself a PRETTY-FORMAT
|
|
// string, not a literal — git substitutes `%x<hex>` escapes within it (same as it
|
|
// does for the top-level `--format` string). The hex code alone (no `%x` prefix) is
|
|
// therefore emitted as its own two literal characters, never the control byte, and
|
|
// the `.split(ACK_TRAILER_VALUE_SEP)` below then never finds a real separator: two
|
|
// trailers of the SAME key on one commit collapse into a single joined value instead
|
|
// of splitting into separate entries (silent data loss — the exact failure class
|
|
// `MAX_ACK_TRAILERS` exists to prevent). Fixed by emitting the `%x` escape.
|
|
const ackValueSepHex = `%x${ACK_TRAILER_VALUE_SEP.codePointAt(0).toString(16).padStart(2, '0')}`;
|
|
const format =
|
|
`${ACK_TRAILER_RECORD_SEP}%(trailers:key=${ACK_TRAILER_HASH},valueonly,separator=${ackValueSepHex})`
|
|
+ `${ACK_TRAILER_FIELD_SEP}%(trailers:key=${ACK_TRAILER_GROWTH},valueonly,separator=${ackValueSepHex})`;
|
|
|
|
let raw;
|
|
try {
|
|
raw = ackTrailerGit(['log', `${mergeBase}..${headRef}`, `--format=${format}`], { cwd, timeoutMs });
|
|
} catch (err) {
|
|
throw new Error(`emitted-ack-trailer: could not read commit trailers over the range: ${err.message}`);
|
|
}
|
|
|
|
const normalized = raw.replace(/\r/g, '');
|
|
const hashValues = [];
|
|
const growthValues = [];
|
|
// index 0 is the (empty) text before the FIRST record separator — every real record
|
|
// starts with one, by construction of the `--format` string above.
|
|
const records = normalized.split(ACK_TRAILER_RECORD_SEP).slice(1);
|
|
for (const record of records) {
|
|
const [hashField = '', growthFieldRaw = ''] = record.split(ACK_TRAILER_FIELD_SEP);
|
|
const growthField = growthFieldRaw.replace(/\n+$/, ''); // git's own between-commit newline
|
|
for (const v of hashField.split(ACK_TRAILER_VALUE_SEP)) if (v !== '') hashValues.push(v);
|
|
for (const v of growthField.split(ACK_TRAILER_VALUE_SEP)) if (v !== '') growthValues.push(v);
|
|
}
|
|
|
|
return parseAckTrailers({ hash: hashValues, growth: growthValues });
|
|
}
|
|
|
|
module.exports = {
|
|
REPO_ROOT,
|
|
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,
|
|
measuredPackageVersion,
|
|
currentManifests,
|
|
currentSizes,
|
|
readAckTrailers,
|
|
WORKTREE_TIMEOUT_MS,
|
|
BUILD_LIB_TIMEOUT_MS,
|
|
BUILD_TIMEOUT_MS,
|
|
CHUNK_TIMEOUT_CEILING_MS,
|
|
};
|