Kjell Tore Guttormsen
7a794b47eb
BREAKING CHANGE: the {NNN} in CA-{SCANNER}-{NNN} identifies the check that
produced the finding. It used to be the finding's position in that scanner's
output for that run, which made it unstable across CONFIGURATIONS, not just
across releases as STATE framed it. Measured on two fixtures: "No custom
subagents" was CA-GAP-007 on minimal-project and CA-GAP-004 on healthy-project.
A user who fixed an unrelated earlier gap silently renumbered every later one,
so a .config-audit-ignore pin retargeted to a neighbouring finding with no
version change at all.
Second measured arm: README already documented the opposite scheme. It and the
scanner headers describe ~20 numbers as check codes (CA-SKL-003 = oversized
body, CA-PLH-015 = folder shadowing, CA-TOK-006 = schema deferral), and the
counter could only produce those in the all-fire case -- source-order positions
are 4, 3 and 8. The documentation described the scheme; the implementation was
what was wrong. Every published number is preserved by construction and pinned
exhaustively in tests/lib/finding-codes.test.mjs.
scanners/lib/finding-codes.mjs is the single authority. Every finding() call
passes a `code`; an undeclared or missing one THROWS. No counter fallback --
that would reproduce D1's findGapId -> 'unknown' silent degradation and let a
half-converted scanner ship IDs that look valid. findingCounter/resetCounter
are deleted outright, not left as no-ops. Retirement is now a mechanism:
RETIRED_CODES tombstones a withdrawn key so its number is never reissued,
seeded with GAP t3_8 -- the D1 removal that opened this chunk.
IDs are consequently NOT unique per finding: one check failing in three files
emits three findings sharing an ID. That inverts which consumer is correct, so
every f.id/findingId site was classified before the change. diff-engine and
most of fix-engine already keyed on scanner+title+file (drift was never lying);
fix-engine's verification did not, and keyed on the ID alone -- fixing one of
two sibling instances marked both fixed, and the untouched one, still present
in the re-scan, was reported as a REGRESSION. Red test first, then keyed on
(findingId, file), which both planFixes and applyFixes already carry.
plugin-health's crossIds Set was measured and is a clean negative: cross
findings are allFindings.slice(crossPluginStart) and codes 18/19 are emitted
only in that tail, so the partition holds by construction.
unknownSuppressions() reports a pin that names no declared check, in the
--output-file payload (ux-rules rule 2 -- a stderr-only warning is invisible to
the commands) and only when one exists, so a clean config is byte-identical.
That is what makes the break safe: a stale pin goes loud instead of dying quiet.
Frozen tests/snapshots/v5.0.0/ untouched on disk. IDs are masked out of that
comparison (mask-finding-ids.mjs) rather than re-derived -- re-deriving
positional IDs would assert the retired scheme against itself, and #58's
isGapEntry off-by-one is the measured example of that misfiring. The dead
re-derivation is removed from strip-retired-gap.mjs. default-output snapshots
re-approved after confirming the diff is IDs and nothing else.
Guards, each seen red against its own defect: a missing code (scanner errors
out mid-sweep), an orphan declaration, a resurrected retired key, and a
documented ID naming no check. The sweep asserts the union across all 16
scanners, never per scanner -- a per-scanner assertion goes green on a partial
conversion.
Fasit written before implementation: docs/mbug28-id-semantics-fasit.local.md,
including one correction made before running (CML has 12 checks over 13 call
sites -- the anchored and calibrated char-budget arms are one check, which a
repeated-title sweep found and my call-site count had missed).
Suite 1535 -> 1573, 0 failing.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01MyqCQKK2ornJ1jFWwqx17E
47 lines
1.6 KiB
JavaScript
47 lines
1.6 KiB
JavaScript
/**
|
|
* Drop finding IDs from the frozen-baseline comparison (M-BUG-28).
|
|
*
|
|
* v5.0.0's baselines were captured when `{NNN}` came from an emission counter,
|
|
* so a frozen ID records where a finding happened to land in that run — not
|
|
* which check produced it. The ID now names the check, so those recorded
|
|
* numbers are not a contract the live output can or should reproduce.
|
|
*
|
|
* The alternative — re-deriving positional IDs on the frozen side, the way
|
|
* `strip-retired-gap.mjs` originally did — would assert the retired scheme
|
|
* against itself, and #58's `isGapEntry` off-by-one is the measured example of
|
|
* that misfiring. Both sides run through this normalizer, so masking (not
|
|
* deleting) keeps the key present: a finding that loses its `id` entirely still
|
|
* fails the comparison.
|
|
*
|
|
* What replaces the coverage: `tests/lib/finding-codes.test.mjs` pins every
|
|
* published check→number pair exhaustively, and
|
|
* `tests/scanners/finding-code-coverage.test.mjs` asserts no finding escapes the
|
|
* registry. Arithmetic and identity are each asserted where they belong.
|
|
*/
|
|
|
|
const CA_ID = /^CA-[A-Z]{2,4}-\d{3}$/;
|
|
const MASK = '<CA-ID>';
|
|
|
|
/**
|
|
* Replace every finding ID with a constant, in place.
|
|
* @template T
|
|
* @param {T} payload
|
|
* @returns {T}
|
|
*/
|
|
export function maskFindingIds(payload) {
|
|
walk(payload);
|
|
return payload;
|
|
}
|
|
|
|
function walk(node) {
|
|
if (Array.isArray(node)) {
|
|
for (const item of node) walk(item);
|
|
return;
|
|
}
|
|
if (!node || typeof node !== 'object') return;
|
|
|
|
for (const key of ['id', 'findingId']) {
|
|
if (typeof node[key] === 'string' && CA_ID.test(node[key])) node[key] = MASK;
|
|
}
|
|
for (const v of Object.values(node)) walk(v);
|
|
}
|