Files
msd-core/tests/manifest-version-sync.test.cjs
Tom Boucher 107eb8c1d9 feat(#3753): run docs guards on the PR that changes the docs they read (#3787)
A PR whose diff is entirely under docs/ runs zero tests, so a guard whose INPUT
is shipped prose cannot protect the PR lane of the diffs it exists to check. Its
only firing opportunity is after merge, on the shared branch -- which is how next
went red on dacae9273 while the PR that caused it (#3746) was green on every
check.

The docs-lint job in .github/workflows/docs-required.yml -- an ALREADY-REQUIRED
context -- now selects and runs the docs guards that read the specific docs files
the PR changed.

  scripts/docs-guard-registry.cjs    test file -> the docs paths it reads (63)
  scripts/select-docs-guards.cjs     pure (changedPaths, registry) -> test files
  scripts/lint-docs-guard-registration.cjs   drift guard, wired into lint:ci

scripts/ci-test-scope.cjs is NOT touched -- `git diff origin/next --` on it is
empty -- so #764's saving stands and its 21 pinning tests are untouched.

Selection: exact path; trailing-slash directory prefix (boundary-checked --
docs/adrenaline.md does NOT match docs/adr/, which a naive startsWith gets
wrong); and '*' for the 6 entries that walk docs/ generally or read a computed
path. Unknown maps to '*' -- guessing narrow is how a guard silently stops
running. Measured: a typo fix selects 6 of 63; docs/AGENTS.md selects 12;
docs/COMMANDS.md selects 18.

Four things this got wrong first, each found by an independent reviewer or by
probe, and each having been asserted safe in a comment:

1. The registry started as a RULE in ci-test-scope.cjs's RULES, on the theory
   that classify()'s !codeChanged normalization made it inert. True for
   docs-ONLY diffs; false for MIXED docs+code diffs, where codeChanged is true
   and the normalization never runs:

     node scripts/ci-test-scope.cjs --files "docs/a.md src/semver.cts"
       with the RULE:  25 targeted_tests
       origin/next:     3 targeted_tests

   Category error: RULES is the scoped lane's input; a docs-guard registry is a
   lane manifest for a consumer that never calls classify(). Extracted; pinned
   by value.

2. The second attempt was a dedicated workflow with paths: [docs/**]. Such a
   workflow never reports on a non-docs PR, so it can never be a required
   context without hanging every non-docs PR -- and a non-required check does not
   block a merge, so the guard would have been advisory and #3753 unfixed.
   docs-required.yml already has no paths: filter, already supplies the required
   docs-lint context, already computes docs_changed, and already ran one docs
   guard gated on it. Generalizing that step needs no ruleset edit at all.

3. The registry and the drift lint were built from ONE path-segment heuristic, so
   both were blind identically -- and blind at the guard that motivated the issue.
   The reader-call regex required a character BEFORE its keyword, so a callee
   named exactly read( / load( / parse( / doc( / file( / content( could never
   match; and only an INLINE path.join(ROOT,'docs','X.md') argument was caught,
   missing the two-step-via-variable form -- the MAJORITY spelling -- plus
   template literals and concatenation. Detector 1 fired on 14 of ~450 files, so
   35 genuine guards sat unregistered while the lint reported 0 violations,
   including cursor-reviewer (reads docs/COMMANDS.md, asserts
   .includes('--cursor')) and inventory-headings-countfree. The "accepted blind
   spot" this shipped with was the common case, not a fringe.

4. With detection fixed the true population is 115 files: 63 genuine guards, 52
   incidental. Running all 63 in a REQUIRED check on a one-line typo fix is the
   cost #764 exists to avoid -- install.test.cjs is 7840 lines and reads exactly
   one docs file, docs/AGENTS.md, for its frontmatter. Dropping it reproduces the
   bug; running it for a typo elsewhere is waste. Hence the map.

Then a second review round found six more, all fixed here:

- fragment-single-edit-propagation.install.test.cjs was EXEMPTED as
  "overlay fixture only". False: it reads the real docs/registries/eos.json and
  asserts on a registry entry name, and reads the real ADR-0001 and asserts its
  H1. A docs-only PR touching either would have gone green and red next -- #3753
  shipping again, from inside the fix for it. Now registered against both paths,
  and all 52 remaining exemptions were re-audited one by one.
- The SUITES-collision guard compared RAW registry keys, but run-tests.cjs strips
  a leading `tests/` BEFORE its suite check. So it caught 'all' and missed
  'tests/all' -- the only spelling that can actually occur, since every key
  carries the prefix. One typo would have run all 824 test files inside the
  required job. Now normalized the same way run-tests.cjs normalizes.
- The lint failed OPEN on an unreadable tests dir or candidate file: 0 violations,
  ok:true. A guard that cannot read its input must never report success.
- The exemption ratchet gated identity only, so a baselined file that later
  STARTED asserting on shipped docs stayed exempt silently -- 52 permanently blind
  files. The baseline now fingerprints the docs paths each exempted file
  references and fails when that set changes, naming what changed.
- The exemption marker was still honored inside a multi-line template literal in
  the header window. The scanner now tracks template-literal and block-comment
  state.
- `git diff --name-only | grep '^docs/'` silently dropped C-quoted non-ASCII docs
  paths, making docs_changed=false a green zero-guard check. Both call sites now
  pass -c core.quotepath=false.
- The run step was gated on hashFiles(), which a force-committed
  .docs-guard-tests.txt would satisfy. The step now rm -f's both scratch files
  first and gates on an output it sets itself.

Three empty states, deliberately distinct, because conflating them rebuilds
#3753: an empty or malformed registry HARD-FAILS; docs changed with no guard
covering them logs and skips; no docs change is already gated. The middle state
must never be expressed as an empty --files-from, which prints `no tests in suite
"all"` and exits 0 -- a green check that guarded nothing. With the current
registry that state is unreachable, because the six '*' entries always match;
the branch is kept as defensive handling for a future registry and says so.

timeout-minutes: 15 bounds the required job against a hanging fork-supplied test;
it had none. npm ci was added because the job never installed dependencies -- the
previous single-file step got away without it, the registry does not.

docs/contributing/docs-guard-registration.md documents the rule, following its
sibling cross-platform-portability-rules.md, and CONTRIBUTING.md's CI Test
Quality Checks table links to it. It is also load-bearing: without a docs/ file
in the diff this PR would not have triggered its own lane, shipping an
unexercised change to a required check.

One unrelated fix, included because this PR surfaced it and CLAUDE.md forbids
deferring a defect found while working. On this branch's first CI run,
`full test (windows-latest, 24, shard 3/3)` was CANCELLED at exactly 30 minutes;
tests were still passing 0.8s before the cancel, so it is a wall-clock timeout,
not a hang, and a cancelled job reddens `Required tests`.

The cause is not this PR's test file, which costs ~60ms. Shard composition is
unstable: adding ONE file to the unit suite reshuffled 115 of 268 files between
shards, and shard 3 drew a heavier mix. Underneath that is a real pre-existing
defect. tests/ci-test-job-timeout-budget.test.cjs requires every lane's budget to
be >= 1.5x its MEASURED cost -- "a lane that got slower must be re-budgeted, not
excused" -- and its test-full entry recorded 19m from a windows-22 shard. That is
stale. Measured on `next` with none of this PR's changes present: 26m18s (run
32614439702, windows-latest/24 shard 3/3), 23m36s and 23m17s on shard 2/3. So the
lane costs ~26m and the 30-minute cap carried 1.14x headroom, not 1.5x. The gate
had been out of compliance with its own rule; this PR was merely the file
addition that reshuffled shard 3 past the cliff.

Fixed as that file prescribes: measuredMinutes 19 -> 27 with fresh evidence, and
test-full timeout-minutes 30 -> 45. The rule's minimum for 27m is 41; 45 is
deliberately above it because the reshuffle means per-shard worst case moves run
to run, and a budget pinned to the exact minimum would be re-breached by the next
test file anyone adds. Only that one job's timeout changed; test.yml's scope,
matrix and steps are untouched, so #764's saving is unaffected.

Raising that cap let the Windows shard finish (28m45s, inside 45) and uncovered
a real failure the 30-minute cancel had been masking:
`new quick-task branch branches off origin/main (#2916)` died with
`outcome=timed_out exitCode=null`, SIGTERM, at the 15000ms bound.

tests/quick-branching.test.cjs:149 `runStep` runs a `#!/usr/bin/env bash` script
executing MULTIPLE git commands, but was bound to GIT_TIMEOUT_MS (15000) -- the
norm for a SINGLE git plumbing call. tests/helpers/timeouts.cjs already documents
this exact failure and exists to fix it: HOOK_FANOUT_TIMEOUT_MS was created after
PR #3285 recorded "outcome=timed_out exitCode=null at exactly the 15000ms probe
bound while every other lane passed the same commit", and calls that "a bound
sized for the wrong class, not a slow machine". Our failure is that case
verbatim, so both sites move to the class norm rather than to a bigger number.

The same class also failed on `next` itself 21 hours earlier -- run 32608945654,
windows-latest/24 shard 1/3, `plan touching only src/ in a submodule project
keeps worktree isolation ENABLED` -- where tests/worktree-safety.test.cjs:5845
`runGate` fans out to `git config --file .gitmodules` under a hardcoded 30000.
Fixed too, since it is a defect in the tree regardless of which branch surfaced
it.

A survey of the whole tests/ tree found the same class-mismatch at further
bash fan-out sites bound under 60000ms, and the maintainer approved sweeping
them rather than leaving them latent to surface the same way one at a time. 16
fan-out sites across 16 files now use the class norm.

The sweep is class-correctness, not raising numbers until things pass. Sites
were moved ONLY where the bash body demonstrably spawns something (git, node,
npm, a CLI); self-contained shell snippets were left where they are, and are
listed as deliberately unchanged: pure if/printf bodies (copilot-install), pure
array/case builtins (code-review-pipeline-regression:638), a documented
pure-shell gsd_run stub (host-integration), single-process hook calls
(workflow-guard:222/271/302), and a deliberately tight 5000ms fast-check hook
(gsd-write-guard.property). Nothing was lowered. process-seam.test.cjs:513
(literal 300) is untouched on purpose -- it tests timeout BEHAVIOR, so raising
it would destroy what it asserts.

Shared file-level constants were the trap here, and were handled per file rather
than by redefinition: GIT_TIMEOUT_MS has ~15 users in git-base-branch and only 1
is a fan-out; WORKTREE_TIMEOUT_MS has 16 users in worktree.test.cjs and 3 are;
PROBE_TIMEOUT_MS has several in three more files. In each the CALL SITE was
changed and the constant left alone, so no single-plumbing-call site silently
inherited a 60s bound. The one exception is hooks-opt-in.test.cjs, where
HOOK_TIMEOUT_MS has exactly one consumer -- spawnHook, the fan-out itself -- so
redefining it is identical in effect and reads better.

Only two of these sites have actually been observed failing. The rest cite that
shared class and those two run ids rather than inventing evidence of their own.

Co-authored-by: sim <sim@local>
2026-08-23 21:21:21 -04:00

597 lines
27 KiB
JavaScript

// docs-guard-exempt: 'docs/' appears only as an excluded-prefix string in a guard's exclusion list, never read.
'use strict';
/**
* Regression tests for issue #844: manifest version sync.
*
* Verifies that `scripts/sync-manifest-versions.cjs` correctly stamps the
* package.json version into every registered runtime-integration manifest,
* and that all currently-tracked manifests are in sync.
*
* Key deliverable: the regression guard (test d) asserts that any committed
* JSON file with a top-level `version` field matching package.json is
* registered in VERSIONED_MANIFESTS — forcing explicit opt-in for future
* manifests.
*/
const { test, describe, before, after } = require('node:test');
const assert = require('node:assert/strict');
const fs = require('fs');
const os = require('os');
const path = require('path');
const { gitOrThrow } = require('./helpers/git-fixture.cjs');
const ROOT = path.resolve(__dirname, '..');
const helpers = require(path.join(__dirname, 'helpers.cjs'));
const {
VERSIONED_MANIFESTS,
VERSIONED_MANIFEST_PATHS,
getByPath,
setByPath,
syncManifestVersions,
getPackageVersion,
stageManifests,
listCapabilityManifests,
syncCapabilityVersions,
} = require(path.join(ROOT, 'scripts', 'sync-manifest-versions.cjs'));
// ─── A: RED→GREEN repro via temp fixture ─────────────────────────────────────
//
// Each test in this describe operates on a single per-describe tmpRoot that is
// created in before() and torn down in after(). There are no setup/cleanup
// test() nodes — order-independence is guaranteed by the lifecycle hooks.
describe('A: syncManifestVersions — temp fixture', () => {
let tmpRoot;
before(() => {
tmpRoot = fs.mkdtempSync(path.join(os.tmpdir(), 'gsd-844-'));
// Write tmp package.json
fs.writeFileSync(
path.join(tmpRoot, 'package.json'),
JSON.stringify({ name: 'x', version: '9.9.9-test.0' }, null, 2) + '\n'
);
// Copy real manifests into tmp, stamped at OLD version so tests can
// verify the pre-sync (stale) state and post-sync (updated) state.
for (const entry of VERSIONED_MANIFESTS) {
const realAbs = path.join(ROOT, entry.path);
const manifest = JSON.parse(fs.readFileSync(realAbs, 'utf8'));
setByPath(manifest, entry.versionKey, '0.0.0');
const destAbs = path.join(tmpRoot, entry.path);
const destDir = path.dirname(destAbs);
if (!fs.existsSync(destDir)) fs.mkdirSync(destDir, { recursive: true });
fs.writeFileSync(destAbs, JSON.stringify(manifest, null, 2) + '\n');
}
// Run the sync once so post-sync assertions are valid.
syncManifestVersions({ root: tmpRoot });
});
after(() => {
helpers.cleanup(tmpRoot);
tmpRoot = null;
});
test('pre-sync fixture had at least one stale manifest (version 0.0.0 != 9.9.9-test.0)', () => {
// The before() hook wrote 0.0.0 into every manifest before syncing.
// We verify the sync actually had work to do by checking that any manifest
// that now reads 9.9.9-test.0 was not already at that version (0.0.0 ≠ 9.9.9-test.0).
// The simplest red-check: the fixture started with 0.0.0, which != 9.9.9-test.0.
assert.ok(
VERSIONED_MANIFESTS.length > 0,
'VERSIONED_MANIFESTS must be non-empty for the fixture to be meaningful'
);
// Independently confirm the target version != the stale seed
assert.notEqual('0.0.0', '9.9.9-test.0',
'Stale seed 0.0.0 must differ from fixture package.json version 9.9.9-test.0');
});
test('syncManifestVersions stamps all manifests to package.json version', () => {
const pkgVersion = getPackageVersion(tmpRoot);
assert.equal(pkgVersion, '9.9.9-test.0');
for (const entry of VERSIONED_MANIFESTS) {
const abs = path.join(tmpRoot, entry.path);
const m = JSON.parse(fs.readFileSync(abs, 'utf8'));
assert.equal(
getByPath(m, entry.versionKey),
'9.9.9-test.0',
`${entry.path} version (${entry.versionKey}) should be 9.9.9-test.0 after sync`
);
}
});
test('syncManifestVersions reports at least one changed file on first run', () => {
// Run a fresh sync against a freshly-stale fixture to observe the changed list.
// Create a separate sub-fixture so this test does not rely on before()'s sync order.
const sub = fs.mkdtempSync(path.join(os.tmpdir(), 'gsd-844-chk-'));
try {
fs.writeFileSync(
path.join(sub, 'package.json'),
JSON.stringify({ name: 'x', version: '9.9.9-test.0' }, null, 2) + '\n'
);
for (const entry of VERSIONED_MANIFESTS) {
const manifest = JSON.parse(fs.readFileSync(path.join(ROOT, entry.path), 'utf8'));
setByPath(manifest, entry.versionKey, '0.0.0');
const destAbs = path.join(sub, entry.path);
const destDir = path.dirname(destAbs);
if (!fs.existsSync(destDir)) fs.mkdirSync(destDir, { recursive: true });
fs.writeFileSync(destAbs, JSON.stringify(manifest, null, 2) + '\n');
}
const changed = syncManifestVersions({ root: sub });
assert.ok(changed.length > 0, 'syncManifestVersions should report at least one changed file');
} finally {
helpers.cleanup(sub);
}
});
test('non-version fields are preserved after sync', () => {
for (const entry of VERSIONED_MANIFESTS) {
const rel = entry.path;
const real = JSON.parse(fs.readFileSync(path.join(ROOT, rel), 'utf8'));
const tmp = JSON.parse(fs.readFileSync(path.join(tmpRoot, rel), 'utf8'));
// Check that every non-version key from the real manifest exists in tmp.
// For nested versionKey manifests (e.g. marketplace plugins[0].version),
// the comparison is structural at the top level only — the version slot
// itself is the one field sync is allowed to change.
for (const key of Object.keys(real)) {
assert.ok(
Object.prototype.hasOwnProperty.call(tmp, key),
`${rel}: field "${key}" should be preserved after sync`
);
}
}
});
test('each synced file ends with a single trailing newline', () => {
for (const entry of VERSIONED_MANIFESTS) {
const rel = entry.path;
const raw = fs.readFileSync(path.join(tmpRoot, rel), 'utf8');
assert.ok(raw.endsWith('\n'), `${rel} must end with a trailing newline`);
assert.ok(!raw.endsWith('\n\n'), `${rel} must not end with a double newline`);
}
});
test('second syncManifestVersions call is idempotent (returns [])', () => {
// The before() already ran one sync. A second call must return [].
const changed = syncManifestVersions({ root: tmpRoot });
assert.deepEqual(changed, [], 'Second sync call should return [] (already in sync)');
});
});
// ─── B: Registry-in-sync: real manifests match package.json ──────────────────
describe('B: real manifests match package.json version', () => {
const pkgVersion = getPackageVersion(ROOT);
for (const entry of VERSIONED_MANIFESTS) {
const rel = entry.path;
test(`${rel} version (${entry.versionKey}) === ${pkgVersion}`, () => {
const abs = path.join(ROOT, rel);
assert.ok(fs.existsSync(abs), `${rel} must exist at ${abs}`);
const m = JSON.parse(fs.readFileSync(abs, 'utf8'));
assert.equal(
getByPath(m, entry.versionKey),
pkgVersion,
`${rel} version (${entry.versionKey} = ${getByPath(m, entry.versionKey)}) must match package.json version (${pkgVersion}). ` +
'Run `node scripts/sync-manifest-versions.cjs` to fix.'
);
});
}
});
// ─── B2: native capability manifests track package.json version (ADR-1244 D6) ─
describe('B2: native capability manifests match package.json version', () => {
const pkgVersion = getPackageVersion(ROOT);
const capManifests = listCapabilityManifests({ root: ROOT });
test('there is at least one native capability manifest', () => {
assert.ok(capManifests.length >= 30, `expected the native capability set, found ${capManifests.length}`);
});
for (const rel of capManifests) {
test(`${rel} version === ${pkgVersion}`, () => {
const m = JSON.parse(fs.readFileSync(path.join(ROOT, rel), 'utf8'));
assert.equal(
m.version,
pkgVersion,
`${rel} version (${m.version}) must match package.json version (${pkgVersion}). ` +
'Run `node scripts/sync-manifest-versions.cjs` to fix.'
);
});
}
});
// ─── B3: syncCapabilityVersions stamps + is idempotent (temp fixture) ─────────
describe('B3: syncCapabilityVersions — temp fixture', () => {
test('stamps stale capability manifests to package version, then is idempotent', () => {
const tmpRoot = fs.mkdtempSync(path.join(os.tmpdir(), 'gsd-844-cap-'));
try {
fs.writeFileSync(
path.join(tmpRoot, 'package.json'),
JSON.stringify({ name: 'x', version: '9.9.9-test.0' }, null, 2) + '\n'
);
// Two stale capability manifests.
for (const id of ['alpha', 'beta']) {
const dir = path.join(tmpRoot, 'capabilities', id);
fs.mkdirSync(dir, { recursive: true });
fs.writeFileSync(
path.join(dir, 'capability.json'),
JSON.stringify({ id, role: 'feature', version: '0.0.0', title: id }, null, 2) + '\n'
);
}
const found = listCapabilityManifests({ root: tmpRoot });
assert.equal(found.length, 2, 'should discover both capability manifests');
const changed = syncCapabilityVersions({ root: tmpRoot });
assert.equal(changed.length, 2, 'both manifests should be stamped on first run');
for (const rel of found) {
const m = JSON.parse(fs.readFileSync(path.join(tmpRoot, rel), 'utf8'));
assert.equal(m.version, '9.9.9-test.0', `${rel} should be stamped`);
assert.equal(m.title, m.id, `${rel} non-version fields preserved`);
}
// Idempotent second run.
assert.deepEqual(syncCapabilityVersions({ root: tmpRoot }), [], 'second run is a no-op');
} finally {
helpers.cleanup(tmpRoot);
}
});
test('listCapabilityManifests returns [] when there is no capabilities/ dir', () => {
const tmpRoot = fs.mkdtempSync(path.join(os.tmpdir(), 'gsd-844-nocaps-'));
try {
assert.deepEqual(listCapabilityManifests({ root: tmpRoot }), []);
} finally {
helpers.cleanup(tmpRoot);
}
});
});
// ─── C: Regression guard — all version-bearing JSON files are registered ──────
describe('C: regression guard — version-bearing JSON files must be registered', () => {
// package.json is the version source; package-lock.json is npm-managed.
// Both inherently track the version without the sync script.
// Native capability manifests (capabilities/<id>/capability.json) are
// version-swept by syncCapabilityVersions (ADR-1244 D6) — discovered by glob,
// so every one is "registered" without an explicit entry here.
const ALLOWED = new Set([
...VERSIONED_MANIFEST_PATHS,
...listCapabilityManifests({ root: ROOT }),
'package.json',
'package-lock.json',
]);
// Semver-ish: matches X.Y.Z with optional pre-release/build metadata.
const SEMVER = /^\d+\.\d+\.\d+(?:[-+].+)?$/;
// Paths to exclude from the guard
const EXCLUDED_PREFIXES = ['tests/', 'node_modules/', '.changeset/', 'docs/'];
test('every committed JSON with a semver top-level version is registered or explicitly allowed', (t) => {
// Enumerate committed JSON files via git (no pathspec to avoid recursion quirks;
// filter to .json in JS instead).
let lines;
try {
// `gitOrThrow` returns a string (the seam is always utf-8), so no
// `.toString()` is needed here — the original Buffer#toString() call
// this replaces was a no-op on the seam's already-string stdout.
const out = gitOrThrow(['ls-files'], { cwd: ROOT });
lines = out.split('\n').filter((f) => f.endsWith('.json'));
} catch (err) {
t.skip('git unavailable: ' + err.message);
return;
}
for (const rel of lines) {
if (ALLOWED.has(rel)) continue;
if (EXCLUDED_PREFIXES.some(prefix => rel.startsWith(prefix))) continue;
const abs = path.join(ROOT, rel);
let parsed;
try {
parsed = JSON.parse(fs.readFileSync(abs, 'utf8'));
} catch (_) {
continue; // skip invalid JSON (shouldn't exist, but be safe)
}
if (
parsed &&
typeof parsed === 'object' &&
!Array.isArray(parsed) &&
typeof parsed.version === 'string' &&
SEMVER.test(parsed.version)
) {
assert.ok(
ALLOWED.has(rel),
`${rel} has a semver top-level "version" but is not registered in ` +
'scripts/sync-manifest-versions.cjs VERSIONED_MANIFESTS (nor an npm-managed file). ' +
"Register it so 'npm version' keeps it in sync (issue #844)."
);
}
}
});
});
// ─── E: stageManifests in a non-git dir must not throw ───────────────────────
describe('E: stageManifests — non-git dir is a no-op, not a throw', () => {
test('stageManifests({root}) with a non-git tempdir warns and returns without throwing', () => {
const tmpRoot = fs.mkdtempSync(path.join(os.tmpdir(), 'gsd-844-nogit-'));
try {
// Write a minimal package.json so getPackageVersion doesn't error if called
fs.writeFileSync(
path.join(tmpRoot, 'package.json'),
JSON.stringify({ name: 'x', version: '0.0.0' }, null, 2) + '\n'
);
// Must not throw even though tmpRoot is not a git repo
assert.doesNotThrow(() => {
stageManifests({ root: tmpRoot });
}, 'stageManifests must not throw outside a git work tree');
} finally {
helpers.cleanup(tmpRoot);
}
});
});
// ─── D: CLI --check exits 0 when in sync ─────────────────────────────────────
// Moved to `npm run lint:generated-sync` (sync-manifest-versions.cjs --check),
// which runs against the committed manifests in both local and CI lint lanes
// instead of being masked by gsd-test's `npm run build` leg.
// ─── F: version script includes capability-registry regen (#1498) ─────────────
//
// Regression guard for #1498: the `npm version` lifecycle script must regenerate
// capability-registry.cjs after stamping capability manifests. Without this,
// `npm version X.Y.Z` leaves the committed registry stale (capability JSONs get
// new version strings but the registry still has the old ones), causing the
// `gen-capability-registry.cjs --check` test to fail in the RC workflow.
describe('F: npm version script includes gen-capability-registry --write (#1498)', () => {
test('package.json "version" script regenerates capability-registry.cjs after syncing manifests', () => {
const pkg = JSON.parse(fs.readFileSync(path.join(ROOT, 'package.json'), 'utf8'));
const versionScript = pkg.scripts && pkg.scripts.version;
assert.ok(
typeof versionScript === 'string',
'package.json must have a "version" script',
);
assert.ok(
versionScript.includes('gen-capability-registry.cjs --write'),
'package.json "version" script must include "gen-capability-registry.cjs --write" to keep the registry in sync after npm version bumps capability manifests. ' +
'Got: ' + JSON.stringify(versionScript),
);
assert.ok(
versionScript.includes('git add') && versionScript.includes('capability-registry.cjs'),
'package.json "version" script must stage capability-registry.cjs with "git add" so it is included in the version-bump commit. ' +
'Got: ' + JSON.stringify(versionScript),
);
});
});
// ────────────────────────────────────────────────────────────────────────
// Folded from tests/issue-1855-marketplace-manifest.test.cjs — H3 wave 5 (#3337)
// ────────────────────────────────────────────────────────────────────────
{
const { describe: __foldDescribe } = require('node:test');
__foldDescribe('folded:issue-1855-marketplace-manifest', () => {
// Regression tests for issue #1855: Claude plugin marketplace manifest.
//
// Asserts structural and semantic correctness of .claude-plugin/marketplace.json
// — the marketplace-discovery sibling of .claude-plugin/plugin.json (#766). The
// version that runtimes read lives at plugins[0].version (the canonical
// marketplace schema location), kept in sync with package.json by
// scripts/sync-manifest-versions.cjs via a nested versionKey descriptor.
const { test, describe } = require('node:test');
const assert = require('node:assert/strict');
const fs = require('fs');
const os = require('os');
const path = require('path');
const pkg = require(path.join(ROOT, 'package.json'));
const pluginJson = require(path.join(ROOT, '.claude-plugin', 'plugin.json'));
const MARKETPLACE_JSON_PATH = path.join(ROOT, '.claude-plugin', 'marketplace.json');
const MARKETPLACE_REL = '.claude-plugin/marketplace.json';
// ─── Section A2: marketplace.json structure ──────────────────────────────────
describe('A2: .claude-plugin/marketplace.json', () => {
let manifest;
test('exists and is valid JSON', () => {
assert.ok(fs.existsSync(MARKETPLACE_JSON_PATH), '.claude-plugin/marketplace.json must exist');
const raw = fs.readFileSync(MARKETPLACE_JSON_PATH, 'utf-8');
manifest = JSON.parse(raw); // throws on invalid JSON
assert.ok(typeof manifest === 'object' && manifest !== null, 'manifest must be a JSON object');
});
test('top-level name is a non-empty string', (t) => {
if (!manifest) { t.skip('manifest could not be parsed'); return; }
assert.ok(typeof manifest.name === 'string' && manifest.name.trim().length > 0, 'marketplace name must be a non-empty string');
});
test('top-level description is a non-empty string', (t) => {
if (!manifest) { t.skip('manifest could not be parsed'); return; }
assert.ok(typeof manifest.description === 'string' && manifest.description.trim().length > 0, 'marketplace description must be a non-empty string');
});
test('owner.{name,url} are non-empty strings', (t) => {
if (!manifest) { t.skip('manifest could not be parsed'); return; }
assert.ok(manifest.owner && typeof manifest.owner.name === 'string' && manifest.owner.name.trim().length > 0, 'owner.name must be a non-empty string');
assert.ok(typeof manifest.owner.url === 'string' && /^https?:\/\//.test(manifest.owner.url), 'owner.url must be an http(s) URL');
});
test('plugins[] is a non-empty array', (t) => {
if (!manifest) { t.skip('manifest could not be parsed'); return; }
assert.ok(Array.isArray(manifest.plugins) && manifest.plugins.length > 0, 'plugins must be a non-empty array');
});
test('plugins[0] has the gsd-core entry with source "./"', (t) => {
if (!manifest) { t.skip('manifest could not be parsed'); return; }
const entry = manifest.plugins[0];
assert.ok(entry && typeof entry === 'object', 'plugins[0] must be an object');
assert.equal(entry.name, pluginJson.name, `plugins[0].name (${entry && entry.name}) must equal plugin.json name (${pluginJson.name})`);
assert.equal(entry.source, './', 'plugins[0].source must be "./" (repo root, same as plugin.json relative refs)');
assert.ok(typeof entry.description === 'string' && entry.description.trim().length > 0, 'plugins[0].description must be a non-empty string');
});
test('plugins[0].author.{name,url} match plugin.json author / owner', (t) => {
if (!manifest) { t.skip('manifest could not be parsed'); return; }
const entry = manifest.plugins[0];
assert.ok(entry.author && typeof entry.author.name === 'string' && entry.author.name.trim().length > 0, 'plugins[0].author.name must be a non-empty string');
assert.equal(entry.author.name, pluginJson.author && pluginJson.author.name, 'plugins[0].author.name must match plugin.json author.name');
});
test('plugins[0].version matches package.json version (synced)', (t) => {
if (!manifest) { t.skip('manifest could not be parsed'); return; }
const entry = manifest.plugins[0];
assert.equal(
entry.version,
pkg.version,
`plugins[0].version (${entry.version}) must match package.json version (${pkg.version}). ` +
'Run `node scripts/sync-manifest-versions.cjs` to fix — the marketplace plugin version is stamped via a nested versionKey descriptor. (#1855)'
);
});
test('no plugins[0].$schema key (intentionally omitted, parity with plugin.json)', (t) => {
if (!manifest) { t.skip('manifest could not be parsed'); return; }
const entry = manifest.plugins[0];
assert.ok(!Object.prototype.hasOwnProperty.call(entry, '$schema'), 'plugins[0] must NOT contain a $schema key');
});
});
// ─── Section B4: registration in the version-sync registry ───────────────────
describe('B4: marketplace.json is registered for version sync', () => {
test('marketplace.json path appears in VERSIONED_MANIFESTS', () => {
const paths = VERSIONED_MANIFESTS.map((e) => (typeof e === 'string' ? e : e && e.path));
assert.ok(
paths.includes(MARKETPLACE_REL),
`VERSIONED_MANIFESTS must register ${MARKETPLACE_REL} so 'npm version' keeps plugins[0].version in sync (issue #844 / #1855). Got: ${JSON.stringify(paths)}`
);
});
test('marketplace.json entry uses the nested plugins.0.version key', () => {
const entry = VERSIONED_MANIFESTS.find((e) => (typeof e === 'string' ? e : e && e.path) === MARKETPLACE_REL);
// Nested dot-path is what makes the canonical marketplace version (plugins[0].version) the stamped field.
const versionKey = typeof entry === 'string' ? 'version' : entry && entry.versionKey;
assert.equal(
versionKey,
'plugins.0.version',
`${MARKETPLACE_REL} must be registered with versionKey 'plugins.0.version' (the schema-canonical location runtimes read). Got: ${JSON.stringify(entry)}`
);
});
test('marketplace.json is in the staging list (stageManifests derives from VERSIONED_MANIFEST_PATHS)', () => {
// stageManifests() git-adds [...VERSIONED_MANIFEST_PATHS, ...capabilities]. If
// marketplace.json were dropped from the paths list, `npm version` would stage
// every other manifest but silently skip it — so pin the path here too.
assert.ok(
VERSIONED_MANIFEST_PATHS.includes(MARKETPLACE_REL),
`VERSIONED_MANIFEST_PATHS must include ${MARKETPLACE_REL} so stageManifests() stages it on npm version. Got: ${JSON.stringify(VERSIONED_MANIFEST_PATHS)}`
);
});
});
// ─── Section D: nested-path helpers are prototype-pollution-safe ──────────────
describe('D: getByPath / setByPath reject reserved properties', () => {
test('plugins.0.version resolves a nested array-index path', () => {
const doc = { plugins: [{ version: '1.2.3' }] };
assert.equal(getByPath(doc, 'plugins.0.version'), '1.2.3');
});
test('getByPath returns undefined for a missing intermediate', () => {
assert.equal(getByPath({ plugins: [] }, 'plugins.0.version'), undefined);
});
for (const reserved of ['__proto__', 'constructor', 'prototype']) {
test(`getByPath refuses to traverse "${reserved}"`, () => {
assert.throws(
() => getByPath({}, `${reserved}.x`),
/refusing to traverse reserved property/,
`getByPath must reject the reserved "${reserved}" segment`
);
});
test(`setByPath refuses to assign through "${reserved}" (no prototype pollution)`, () => {
const target = {};
assert.throws(
() => setByPath(target, `${reserved}.polluted`, 'yes'),
/refusing to traverse reserved property/,
`setByPath must reject the reserved "${reserved}" segment`
);
// Confirm nothing leaked onto Object.prototype.
assert.ok(({}).polluted === undefined, 'Object.prototype must not be polluted');
});
}
});
// ─── Section C2: sync stamps the nested version (temp fixture, red→green) ────
describe('C2: syncManifestVersions stamps plugins[0].version (temp fixture)', () => {
test('stamps a stale marketplace plugins[0].version to the package version, then is idempotent', () => {
const tmpRoot = fs.mkdtempSync(path.join(os.tmpdir(), 'gsd-1855-'));
try {
fs.writeFileSync(
path.join(tmpRoot, 'package.json'),
JSON.stringify({ name: 'x', version: '9.9.9-test.0' }, null, 2) + '\n'
);
// Seed a stale marketplace.json with a nested plugins[0].version.
const destAbs = path.join(tmpRoot, MARKETPLACE_REL);
fs.mkdirSync(path.dirname(destAbs), { recursive: true });
const stale = JSON.parse(fs.readFileSync(MARKETPLACE_JSON_PATH, 'utf8'));
stale.plugins[0].version = '0.0.0';
fs.writeFileSync(destAbs, JSON.stringify(stale, null, 2) + '\n');
// Only sync the marketplace manifest in this fixture (other registered
// manifests are absent under tmpRoot). syncManifestVersions tolerates a
// missing manifest file by... it does NOT — it readJson-throws. So seed
// the other registered manifests too (stale) so the sync loop is happy.
for (const e of VERSIONED_MANIFESTS) {
const rel = typeof e === 'string' ? e : e.path;
if (rel === MARKETPLACE_REL) continue;
const realAbs = path.join(ROOT, rel);
if (!fs.existsSync(realAbs)) continue;
const other = JSON.parse(fs.readFileSync(realAbs, 'utf8'));
const vk = typeof e === 'string' ? 'version' : (e.versionKey || 'version');
__foldSetNested(other, vk, '0.0.0');
const d = path.join(tmpRoot, rel);
fs.mkdirSync(path.dirname(d), { recursive: true });
fs.writeFileSync(d, JSON.stringify(other, null, 2) + '\n');
}
const changed = syncManifestVersions({ root: tmpRoot });
assert.ok(changed.includes(MARKETPLACE_REL), `sync should report ${MARKETPLACE_REL} as changed`);
const synced = JSON.parse(fs.readFileSync(destAbs, 'utf8'));
assert.equal(synced.plugins[0].version, '9.9.9-test.0', 'plugins[0].version should be stamped to the package version');
// Idempotent second run does not re-report the marketplace manifest.
const changed2 = syncManifestVersions({ root: tmpRoot });
assert.ok(!changed2.includes(MARKETPLACE_REL), 'second sync should not re-report an already-synced marketplace manifest');
} finally {
helpers.cleanup(tmpRoot);
}
});
});
// Minimal nested dot-path setter mirroring the sync script's helper, for fixture seeding.
function __foldSetNested(obj, dotPath, value) {
const parts = String(dotPath).split('.');
let cur = obj;
for (let i = 0; i < parts.length - 1; i++) {
const k = parts[i];
cur = cur[k];
}
cur[parts[parts.length - 1]] = value;
}
});
}