Files
msd-core/tests/gsd-check-update-worker-platform-gate.test.cjs
Tom Boucher 15af0f5536 enhance(#3951): B6+B7 — widen two unreachable lint rules and make the guard ledger true (#3965)
* fix(#3951): two lint rules that could not reach the code they govern

B6 names two widenings. Measuring them first turned up a defect the criterion did
not know about, and refuted the reason it gave for one of them.

1. no-adhoc-markdown-parsing self-gates on its own filename.

   Lines 107-110 short-circuit create() to {} unless the path matches
   /(?:^|\/)src\/[^/]+\.cts$/. B6 says to widen the files: glob in
   eslint.config.mjs - but doing only that ships an INERT rule, because the gate
   still returns {} for every new path. Both halves have to change, and the gate
   is the load-bearing one.

   That same regex hides a live hole: [^/]+ is FLAT-ONLY, so it requires the file
   to sit directly in src/. The registered glob is src/**/*.cts, which includes
   subdirectories. 28 .cts files - health-diagnostic-rules/ (10),
   installer-migrations/ (11), observability/ (3), host-integration-adapters/ (2),
   vendor/ (2) - are inside the registered glob and silently skipped.

   Measured with the gate neutralized: 0 violations there today. The hole is
   hiding nothing right now, and is fixed anyway, because "no violations today" is
   not a property that keeps holding.

   The fix is not invented: require-subprocess-timeout.cjs:196 already carries the
   correct form of this guard, /(?:^|\/)src\/.*\.cts$/ with .*, one directory over.
   Checked the other 21 rules for the same bug - no-adhoc-regex-escape and
   no-private-binary-resolution short-circuit only to exempt their own seam file,
   which is the right shape, and no-crlf-fragile-split has no filename gate at
   all. This bug is unique to the one rule.

2. no-adhoc-regex-escape could not see the shape that actually occurs.

   Line 396 gated the whole UNSAFE-NEW-REGEXP arm on arg.type === 'Identifier'.
   Every check below it - the _SOURCE provenance check, the
   isSoleReturnOfOwnParameter shape - lives inside that branch, so
   new RegExp(obj['key']) and new RegExp(cfg.pattern) were never examined at all.
   Runtime data arrives as a property access far more often than as a bare
   identifier, which is exactly why this rule never fired on the #3477 ReDoS.

   Widened to MemberExpression, measured by AST walk across all five registered
   blocks rather than by grep. 27 sites, zero TSAsExpression:

     18  safe new RegExp(X.source, flags)  -> exempted, keyed strictly on the
         PROPERTY being `source`, never on the object. Keying on the object would
         wave through X.anything and buy nothing. B6 estimated ~10; that was an
         undercount.
      3  _SOURCE-suffixed constants reached through a required module namespace
         (phaseId.BRACKET_PHASE_TOKEN_SOURCE) -> the same provenance-exempt class
         the rule already recognizes for bare identifiers, extended to reach them.
         Without this the widening produces 3 false flags.
      6  real findings -> marked, each a test extracting a pattern from a shipped
         file at test time, where the runtime contract IS the product.

   Deliberately the NARROW MemberExpression form. The rule's own
   isSoleReturnOfOwnParameter doc comment records that an earlier broad
   "any non-literal identifier" heuristic produced ~25 false positives and was
   rejected; a re-run of the census after this change flags exactly the 6 above
   and nothing else.

Verified by execution, not by reading: the gate now accepts src/<subdir>/x.cts,
still accepts flat src/x.cts, and still exempts paths outside src/ - each pinned
by a test proven to fail against the old regex. build:lib, lint and lint:ci all
exit 0.

Refs #3951

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(#3951): give no-adhoc-markdown-parsing its reach, and fix the 80 parses it finds

The rule self-gates on filename AND is registered on one glob, so widening either
half alone is inert. Both move here: the gate now accepts tests/**/*.cjs and
scripts/**/*.cjs alongside src/**/*.cts, and eslint.config.mjs registers it on the
same two.

A test pins that the gate and the registration AGREE, in both directions. The
original defect was a gate narrower than its registration; the failure mode of
this fix is a gate wider than its registration. Both are silent, so the test
asserts the pair rather than either half.

80 violations across 43 files, all in tests/, zero in scripts/. 70 are routed
through the existing seams - scanFencedBlocks, collectSection, stripFencedCode,
tokenizeHeadings from markdown-sectionizer; splitTableRow, parseMarkdownTable,
findTableWithColumns from markdown-table. Headerless STATE.md tables use
splitTableRow per line, because parseMarkdownTable needs a real delimiter row.

10 are suppressed, 12.5%, well under the third that would have meant the rule is
mis-scoped for tests/ rather than the tests carrying debt. Each names its reason:
three regression guards (#3873 / bug-#21) are deliberately independent of the
generator's own fence handling, and routing them through the seam would have them
test the generator against itself; one is a negative-text probe that extracts
nothing; six are a shell-pipe-to-jq detector whose regex coincidentally matches the
table fingerprint and is not markdown parsing at all.

All ten sit in tests whose subject is .md content, which is normally a reason to
prefer the seam. The marker used is allow-adhoc-markdown, distinct from
no-source-grep's allow-test-rule, and lint:ci's lint-allow-test-rule-refs reports
the same 280/280 unverified count as before - checked rather than assumed, because
those two markers are easy to conflate.

The widening earned its keep immediately: it found a test that passed for the
wrong reason.

  tests/config-field-docs.test.cjs asserted notEqual(<cell>, '600') against the
  TYPE column instead of the DEFAULT column. notEqual('number', '600') is true
  forever, so the guard against workflow.subagent_timeout regressing to the old
  seconds default could never fire. docs/CONFIGURATION.md:434 is
  `| workflow.subagent_timeout | number | 300000 | ... |`, so the default is cell
  index 2; the assertion is now row-scoped through splitTableRow and reads 300000.

That is the argument for the widening in one case: the violation was invisible to
lint, the suite was green, and the assertion was vacuous. A rule that cannot reach
a file cannot tell you the file is lying.

Not fixed here, and recorded rather than assumed: #3426/#3239 are NOT reachable by
this widening. tests/package-legitimacy-gate.test.cjs yields zero violations even
with the gate bypassed - its hand-rolled scans are real, but built from line
filters and split('|') rather than the regex-literal fingerprints this rule
detects. They need new detectors. The epic assumed a wider glob would catch them.

build:lib, lint and lint:ci all exit 0; the post-fix census across tests/** and
scripts/** is 0 violations.

Refs #3951

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* fix(#3951): B7 — and #3356's defects were still live in the code

B7 asks that each closed child be driven fail-first with a behavioral identity
test at the CONSUMER's output. Four of eleven children had no test citing their
issue number. Auditing them by BEHAVIOR rather than by number-grep changed the
answer for three of the four.

#3364 and #2540 — traceability only. Both were implemented by #3941 and their
consumer-output tests exist and were shown failing-first; neither cited its
originating issue, so an audit that greps for the number reports them uncovered.
Tagged the specific asserting test in each file, following the citation form those
files already use.

#3372 — covered, but only at helper level, and the triage narrowed it. Of the four
commands the issue names, only estimate-cli's collectCalibrationSamples actually
enumerates phase dirs from disk; smart-entry, audit and roadmap-upgrade derive from
ROADMAP/body text and never reach the sentinel path, so they are benign by
construction and were left alone rather than "fixed" into churn. The existing #3882
rows asserted the helper's return value. Added a consumer-output test driving
`query estimate-calibrate` and asserting sample_count and the persisted document.
RED proof: reverted collectCalibrationSamples to a raw readdirSync and ran the real
CLI - sample_count 3, sentinel leaked; restored - sample_count 2.

#3356 — NOT covered, and BOTH halves of the defect were still live in source. The
issue is closed; the bug was not fixed. Fixed here rather than writing tests that
document a bug as correct.

  Defect 1, the contradicted row. quick.md:627 claimed
  `quick-tasks-append` performs "the equivalent write" to the Step 7c row. It did
  not: the `#` cell was a positional ordinal and `Directory` read `—`, because the
  route had no way to receive a quick id or task directory. Added OPTIONAL
  `--quick-id` / `--slug` / `--directory`. A caller with neither - fast.md, the
  original #2133 caller - omits them and gets the byte-identical prior row, so
  nothing existing changes. A caller that HAS a real id and directory now gets the
  canonical row quick.md:632 renders. The false-equivalence sentence itself is
  corrected rather than left to mislead the next reader.

  Defect 2, the forced re-derive. The route called readModifyWriteStateMd with no
  options, so a body-only append to the Quick Tasks table triggered a full
  re-derive of the disk-derived progress.* frontmatter. Every other body-only
  writer passes { resync: false } - src/state.cts's own docstring prescribes it -
  and this route was the lone outlier. RED proof: reverted the option, seeded a
  project with 2 real phase dirs and a curated total_phases of 25, ran
  quick-tasks-append; total_phases collapsed to 2. Restored; it stayed 25.

That second one is the shape this epic exists to close: a silent write that
replaces curated state with a re-derivation nobody asked for, exit 0 throughout.

build:lib, lint and lint:ci all exit 0.

Refs #3951

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* docs(#3951): amend B6's ledger to what was measured, and document the new flags

The ADR gains a ledger amendment in its own correction style - the sixth wrong
premise it records, found the same way as the other five, by measuring before
building.

B6 says the net guard count must fall. It rose: 62 -> 69, +7, measured from the
epic's filing commit to origin/next. The attribution is the point, though. Five of
the seven came from PRs unrelated to this epic, one was added by a phase of it, and
the epic did retire something sub-file - #3884 removed a detector with an explicit
"net: -1 detector, 0 added" ledger. Every named casualty is load-bearing, two
already carry retractions in this same document, and a sweep of all 22 rules plus
every scripts/lint-* found no provably dead guard. There is no honest way to make
the count fall; forcing it would trade coverage for a number, which is the Goodhart
outcome Decision 6 exists to prevent.

The amendment also records that B6's own prescribed fix for one widening was inert.
no-adhoc-markdown-parsing self-gates on its filename, so widening only the files:
glob - which is what the criterion says to do - ships a rule that still returns {}
for every new path. And #3426/#3239 are not reachable by that widening at all;
their scans use line filters and split('|'), not the regex fingerprints the rule
detects. The roster row tracked them against the wrong mechanism.

Three roster rows updated from aspiration to fact: the two widenings are DONE with
their measured counts, and lint-phase-enumeration-drift is marked RETAINED rather
than "expected casualty - verify before retiring", because Phase 5 verified it and
kept it.

The rule Decision 6 should carry forward is stated plainly: a guard ledger is a
claim about COVERAGE, not about COUNT. "Net count must fall" is measurable and
wrong. "Every guard is reachable, and each retirement names what makes its defect
unrepresentable" is the property that was actually wanted.

CLI-TOOLS.md documents the optional --quick-id/--slug/--directory flags and says
plainly that omitting them keeps the pre-#3356 row byte-identical, plus that the
append no longer re-derives progress frontmatter.

New features fragment (id 3951); FEATURES.md regenerated rather than hand-edited.
Changeset is Changed, pr:0 pending backfill.

Refs #3951

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* test(#3951): correct four rows that pinned the lint rule's old narrow reach

The remote suite came back RED with 5 failures, all in tests/eslint-rules.test.cjs.
They are stale tests, not a regression: four rows assert that
no-adhoc-markdown-parsing is inert outside src/*.cts, which is exactly the
contract this deliverable changes.

Confirmed by reading rather than inferred from the names - the row at :1981 used
filename: 'tests/some.test.cjs' and filename: 'scripts/helper.cjs', the two roots
the rule now covers on purpose.

Worth recording WHY local gates missed this. npm run lint and lint:ci were green,
and the touched test files passed standalone. Lint only reports violations in real
files; these rows assert the rule's REACH using synthetic RuleTester filenames, so
nothing but the full suite could see them. Local green on a rule change says
nothing about the rule's own tests.

Each row is rewritten with BOTH halves rather than flipped from valid to invalid:

  - the same fingerprint under tests/ or scripts/ is now flagged, with the right
    messageId
  - the negative space is preserved - the same fingerprint under a path outside
    all three roots (gsd-core/bin/lib/foo.cjs) is still NOT flagged

The second half is the one that matters. Without it the rule has no boundary and
nothing would catch an over-wide gate later, which is the mirror image of the bug
this deliverable just fixed.

Each row is renamed to state the current contract; the old names said
"non-src/*.cts ... is not flagged" and would have been actively misleading once
the bodies changed.

Proven to test the widening rather than restate it: every flagged half was run
against HEAD~2's pre-widening rule and does NOT fire there, then against the
current rule and does. 12/12 on that probe; the full file is 178/178.

Swept for the same staleness elsewhere and found none.
require-subprocess-timeout's own "inert outside src/*.cts" row is untouched -
that rule's gate was not widened here - and no-adhoc-regex-escape's test file
already carries correctly-targeted rows.

Refs #3951

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* test(#3951): acknowledge the quick.md growth the attribution guard reported

The full suite came back RED with one failure, and it is mine:

  1 file(s) grew without an acknowledgment:
    quick.md grew 364 bytes

gsd-core/workflows/quick.md is runtime-loaded emitted content, so correcting
its false 'performs the equivalent write' claim trips emitted-attribution by
construction. This is the acknowledgment, not a workaround - there is nothing
to regenerate.

The fragment names ONE path, which is the only one the guard reported. The four
spent acknowledgments it also listed (audit-uat, plan-phase, progress, review)
belong to other fragments whose ripple the base already absorbs; they are inert,
not failures, and are deliberately NOT copied here - naming paths I did not
change would make this record false in the other direction.

Byte figure corrected before committing: the guard reported 37220 -> 37584
(+364), but origin/next has since moved and quick.md is 37232 there now, so the
measured delta is +352. The reason text says so and names the base as a moving
figure rather than pinning a number that is already stale.

Refs #3951

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* test(#3951): move the quick.md growth ack to a trailer, delete the obsolete fragment

The acknowledgment mechanism changed under this branch. Merging next brought in
the redesign - it also deleted .github/workflows/ack-fragment-sweep.yml, which
was in the merge status and which I did not register at the time - and the guard
now says so directly:

  Add a trailer to a commit in this PR (never a new file).
    Emitted-Drift-Ack-Growth: quick.md - <why this growth is deliberate>

So tests/emitted-drift-acks/3951-quick-append-equivalence.json is obsolete on
arrival. A fragment file is no longer read by anything, and leaving it would be a
dead record that looks like an active one. It is deleted here rather than kept
"just in case".

The byte figure moved again with the merge: 37232 -> 37596, +364. The earlier
fragment said +352, measured before the merge auto-merged quick.md itself. The
trailer carries no number, which is the better design - the figure was stale
twice in two attempts.

Refs #3951

Emitted-Drift-Ack-Growth: quick.md — #3356/#3951 replaces a false claim with an accurate one. Line 627 said the `quick-tasks-append` shortcut "performs the equivalent write" to the Step 7c row rendered above it; it did not, and that was the documented half of #3356 — with no quick id or task directory the route emitted a positional ordinal in `#` and an em-dash in `Directory`, a visibly different row. The corrected sentence has to carry three facts the original elided: what the shortcut actually writes when it has neither input, that this is honest behavior for its real caller (`fast.md`, which has neither), and how a caller with both now gets the byte-identical canonical row via the new optional `--quick-id`/`--slug`/`--directory` flags. Prose is the product here — an executing agent reads this line to decide whether the shortcut is safe for its case, and a shorter correction would either drop the flags (leaving the reader unable to act on the fix) or drop the limitation (recreating the false claim in gentler words).
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* chore(#3951): backfill changeset pr number

Refs #3951

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

---------

Co-authored-by: sim <sim@local>
Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-08-27 23:10:49 -04:00

1099 lines
47 KiB
JavaScript

/**
* Tests for the Windows npm resolution platform gate.
*
* Background (issue #3103, PR #3102):
* On Windows, `npm` ships as `npm.cmd`. Node's spawn does not apply PATHEXT
* resolution and fails with ENOENT. The fix is to spawn through a shell on
* Windows (cmd.exe resolves npm.cmd via PATHEXT). On POSIX, `npm` resolves
* without a shell, so spawning `/bin/sh -c` is pure overhead and changes
* signal / exit-code semantics — undesirable.
*
* Relocation (#498): the SessionStart worker no longer spawns npm itself. It
* delegates the latest-version lookup to check-latest-version's
* `checkLatestVersion()`, which routes through `execNpm` in the shell-command
* projection seam. The PR #3102 contract therefore now lives on `execNpm`.
* This test locks it there, and additionally locks that the worker does NOT
* re-introduce a direct npm spawn (which would re-open the gate question in a
* second place).
*
* Source-grep policy: these structural assertions read source via readFileSync.
* The behavior (Windows-only shell resolution) is platform-gated at runtime and
* cannot be reached on POSIX CI without a Windows lane; a structural assertion
* is the minimum-cost contract.
*/
// allow-test-rule: structural-regression-guard
// structural assertion on spawn-options shape; the behavior
// (Windows-only shell resolution) is platform-gated at runtime and cannot be
// reached on POSIX CI without a Windows lane.
'use strict';
const { test, describe } = require('node:test');
const assert = require('node:assert/strict');
const fs = require('fs');
const path = require('path');
const { scanFencedBlocks } = require('../gsd-core/bin/lib/markdown-sectionizer.cjs');
const WORKER_PATH = path.join(__dirname, '..', 'hooks', 'gsd-check-update-worker.js');
const PROJECTION_PATH = path.join(
__dirname, '..', 'gsd-core', 'bin', 'lib', 'shell-command-projection.cjs',
);
function codeOnly(file) {
return fs.readFileSync(file, 'utf8')
// eslint-disable-next-line local/no-unbounded-quantifier -- parses this repo's own bounded hooks/lib source, not adversarial input
.replace(/\/\*[\s\S]*?\*\//g, '')
// eslint-disable-next-line local/no-unbounded-quantifier -- parses this repo's own bounded hooks source, not adversarial input
.replace(/(^|[^:])\/\/[^\r\n]*/g, '$1');
}
describe('execNpm: Windows npm spawn platform gate (PR #3102, relocated #498)', () => {
test('projection seam exists', () => {
assert.ok(fs.existsSync(PROJECTION_PATH), `not found at ${PROJECTION_PATH}`);
});
test('execNpm gates shell to process.platform === "win32"', () => {
assert.match(
codeOnly(PROJECTION_PATH),
/shell:\s*process\.platform\s*===\s*['"]win32['"]/,
[
'execNpm must gate shell to `process.platform === "win32"`.',
'A regression to `shell: true` would spawn /bin/sh -c on POSIX',
'(adds shell overhead, changes signal/exit semantics). See PR #3102.',
].join(' '),
);
});
test('no unconditional shell: true on the npm spawn', () => {
assert.doesNotMatch(
codeOnly(PROJECTION_PATH),
/shell\s*:\s*true\s*[,\s}]/,
'shell: true is forbidden — use the `process.platform === "win32"` gate.',
);
});
});
describe('worker delegates the npm spawn (does not re-open the gate, #498)', () => {
test('worker does NOT spawn npm directly', () => {
const code = codeOnly(WORKER_PATH);
assert.doesNotMatch(
code,
/(execFileSync|spawnSync|execSync|exec)\s*\(\s*['"]npm['"]/,
'Worker must delegate to checkLatestVersion(), not spawn npm itself.',
);
});
test('worker requires check-latest-version for the lookup', () => {
assert.match(codeOnly(WORKER_PATH), /check-latest-version/);
});
});
// ─── #3582: cold tree (no gsd-core/bin/lib/*.cjs) — degrade, not crash ─────
//
// gsd-core/bin/lib/semver-compare.cjs, package-identity.cjs, and (via
// check-latest-version.cjs's own transitive requires) gsd-core/bin/lib/
// cli-exit.cjs + shell-command-projection.cjs are tsc build artifacts
// (ADR-457), gitignored and absent on a raw plugin-marketplace / git-clone
// install that never ran `npm run build:lib`. This worker is a DETACHED
// SessionStart background process (spawned with stdio: 'ignore' by
// hooks/gsd-check-update.js) — before #3582 a missing library crashed the
// worker at module load with no visible signal (stderr discarded by the
// parent) and no cache-file write at all, so the statusline/banner would
// silently never see an update signal. The fix wraps ensureRuntimeBuild()
// and the three compiled-lib requires in one try/catch and degrades to
// no-signal fallbacks (isSemverNewer -> false, checkLatestVersion -> not ok,
// PACKAGE_NAME -> null) on failure — the worker still runs to completion and
// writes a result cache record. Simulated hermetically via a fixture install
// tree that copies hooks/ + the seam module but never gsd-core/bin/lib/ or
// tsconfig.build.json (tests/helpers/cold-runtime-lib-fixture.cjs) — the REAL
// gsd-core/bin/lib/ is never touched.
{
const { describe, test } = require('node:test');
const assert = require('node:assert/strict');
const fs = require('node:fs');
const path = require('node:path');
const { runHook: runHookSeam } = require('./helpers/process-seam.cjs');
const { buildColdInstallTree } = require('./helpers/cold-runtime-lib-fixture.cjs');
const { createTempDir, cleanup } = require('./helpers.cjs');
describe('gsd-check-update-worker.js: #3582 cold tree — degrade, not crash', () => {
test('missing compiled runtime library -> worker still writes a degraded result cache, no crash', (t) => {
const cold = buildColdInstallTree();
t.after(cold.cleanup);
const cacheDir = createTempDir('gsd-worker-cold-');
t.after(() => cleanup(cacheDir));
const cacheFile = path.join(cacheDir, 'cache.json');
const env = {
...process.env,
GSD_CACHE_FILE: cacheFile,
GSD_PROJECT_VERSION_FILE: path.join(cacheDir, 'no-such-project', 'VERSION'),
GSD_GLOBAL_VERSION_FILE: path.join(cacheDir, 'no-such-global', 'VERSION'),
};
const r = runHookSeam(path.join(cold.hooksDir, 'gsd-check-update-worker.js'), [], {
env,
timeoutMs: 8000,
});
assert.equal(r.exitCode, 0, `worker must exit 0 on a build failure; stderr: ${r.stderr}`);
assert.ok(fs.existsSync(cacheFile), 'worker must still reach the end and write a cache record');
const cache = JSON.parse(fs.readFileSync(cacheFile, 'utf8'));
assert.equal(cache.package_name, null, 'degraded package_name must be null (no-signal, never a stale/foreign value)');
assert.ok(!cache.update_available, 'degraded update_available must be falsy');
assert.equal(cache.installed, '0.0.0', 'installed detection is unaffected by the compiled-lib degrade');
});
});
}
// ─── #3582: cold-tree fixture must tolerate a concurrent build-hooks.js
// staging dir, without mutating the live hooks/ tree ─────────────────────
//
// scripts/build-hooks.js writes atomically via a per-PID staging dir
// (hooks/.dist-staging-<pid>) that it creates and removes; up to nine test
// files invoke it concurrently from their `before()` hooks, so the live
// hooks/ dir is never guaranteed stable during a test run. This is proven
// HERMETICALLY, against a fake source tree under a temp dir — planting a
// staging dir inside the REAL repo's hooks/ would itself be the exact
// shared-state race this fixture exists to guard against (other test files
// read hooks/ concurrently), and cleanup() (tests/helpers.cjs) deliberately
// refuses to remove any path outside the known temp roots, so a real-repo
// plant can never be cleaned up through it either.
{
const { describe, test } = require('node:test');
const assert = require('node:assert/strict');
const fs = require('node:fs');
const os = require('node:os');
const path = require('node:path');
const { buildColdInstallTree, REPO_ROOT, shouldCopyHookEntry } = require('./helpers/cold-runtime-lib-fixture.cjs');
const { cleanup } = require('./helpers.cjs');
describe('cold-runtime-lib-fixture.cjs: #3582 tolerates a concurrent hooks/.dist-staging-<pid> dir', () => {
test('a live .dist-staging-test-<random> dir does not break the fixture copy, and is excluded from it', (t) => {
// Build a hermetic fake source tree — never touch the real repo's hooks/.
const fakeRepoRoot = fs.mkdtempSync(path.join(os.tmpdir(), 'gsd-fake-repo-'));
t.after(() => cleanup(fakeRepoRoot));
const fakeHooksDir = path.join(fakeRepoRoot, 'hooks');
fs.mkdirSync(fakeHooksDir, { recursive: true });
// Representative real hook entries the fixture must still carry over.
fs.writeFileSync(path.join(fakeHooksDir, 'hooks.json'), '{}');
fs.writeFileSync(path.join(fakeHooksDir, 'top-level-hook.js'), '// fake hook\n');
fs.mkdirSync(path.join(fakeHooksDir, 'lib'), { recursive: true });
fs.writeFileSync(path.join(fakeHooksDir, 'lib', 'helper.js'), '// fake lib helper\n');
// Build output dir — must be excluded.
fs.mkdirSync(path.join(fakeHooksDir, 'dist'), { recursive: true });
fs.writeFileSync(path.join(fakeHooksDir, 'dist', 'built.js'), '// built output\n');
// Concurrent build-hooks.js staging dir — must be excluded, and must
// not break the copy even while "live".
const stagingName = `.dist-staging-99999`;
const stagingDir = path.join(fakeHooksDir, stagingName);
fs.mkdirSync(stagingDir);
fs.writeFileSync(path.join(stagingDir, 'scratch.txt'), 'transient build output');
// The fixture also copies gsd-core/bin/ensure-runtime-build.cjs — give
// the fake tree a real copy of it so buildColdInstallTree() succeeds.
const fakeBinDir = path.join(fakeRepoRoot, 'gsd-core', 'bin');
fs.mkdirSync(fakeBinDir, { recursive: true });
fs.copyFileSync(
path.join(REPO_ROOT, 'gsd-core', 'bin', 'ensure-runtime-build.cjs'),
path.join(fakeBinDir, 'ensure-runtime-build.cjs'),
);
// Filtered by shouldCopyHookEntry — the same predicate the fixture
// itself uses to decide what to copy. Up to nine other test files'
// before() hooks concurrently invoke scripts/build-hooks.js, which
// creates/removes hooks/.dist-staging-<pid> at unpredictable times, so
// a RAW (unfiltered) before/after listing comparison of the live
// hooks/ dir is itself racy — it can observe a sibling build's
// transient staging dir appear or vanish between the two snapshots and
// fail with no real defect. Filtering both snapshots the same way the
// fixture does preserves the actual intent (this test adds/removes no
// REAL entry in the repo's hooks/) while tolerating scratch that is
// not this test's doing and is excluded from the fixture anyway.
const realHooksBefore = fs
.readdirSync(path.join(REPO_ROOT, 'hooks'))
.filter(shouldCopyHookEntry)
.sort();
const cold = buildColdInstallTree({ repoRoot: fakeRepoRoot });
t.after(cold.cleanup);
const entries = fs.readdirSync(cold.hooksDir);
assert.ok(
!entries.some((e) => e.startsWith('.dist-staging')),
`fixture hooks/ must not contain any .dist-staging* entry, got: ${entries.join(', ')}`,
);
assert.ok(!entries.includes('dist'), `fixture hooks/ must not contain dist/, got: ${entries.join(', ')}`);
assert.ok(entries.includes('hooks.json'), 'fixture must still contain the representative hooks.json');
assert.ok(entries.includes('top-level-hook.js'), 'fixture must still contain the representative top-level hook');
assert.ok(
fs.existsSync(path.join(cold.hooksDir, 'lib', 'helper.js')),
'fixture must still contain the representative hooks/lib/ subdir file',
);
const realHooksAfter = fs
.readdirSync(path.join(REPO_ROOT, 'hooks'))
.filter(shouldCopyHookEntry)
.sort();
assert.deepEqual(
realHooksAfter,
realHooksBefore,
'the real repo hooks/ directory listing, filtered by shouldCopyHookEntry, must be unchanged by ' +
'this test (transient hooks/.dist-staging-<pid> entries from concurrent build-hooks.js runs are ' +
'excluded from the comparison since this test does not own them)',
);
});
});
// Direct pin on shouldCopyHookEntry() itself — the predicate IS the fix
// (exact 'dist' match plus a '.dist-staging' PREFIX, not a loose
// startsWith('dist')/includes('dist') substring match). Pinning it only
// indirectly, via the fixture-shape assertions above, would let a looser
// implementation (e.g. name.startsWith('dist')) pass every case above
// while still being wrong — this pins the exact rule.
describe('cold-runtime-lib-fixture.cjs: shouldCopyHookEntry() name-filter rule', () => {
const { shouldCopyHookEntry } = require('./helpers/cold-runtime-lib-fixture.cjs');
test('excludes the build output dir and any .dist-staging* prefix name', () => {
assert.equal(shouldCopyHookEntry('dist'), false);
assert.equal(shouldCopyHookEntry('.dist-staging-20836'), false);
assert.equal(shouldCopyHookEntry('.dist-staging-test-abc'), false);
assert.equal(shouldCopyHookEntry('.dist-staging'), false);
});
test('keeps real hook entries', () => {
assert.equal(shouldCopyHookEntry('hooks.json'), true);
assert.equal(shouldCopyHookEntry('lib'), true);
assert.equal(shouldCopyHookEntry('gsd-check-update.js'), true);
});
test('does not over-match on a bare "dist" substring/prefix', () => {
assert.equal(shouldCopyHookEntry('dist-staging-no-dot'), true);
assert.equal(shouldCopyHookEntry('distant.js'), true);
});
});
}
// ────────────────────────────────────────────────────────────────────────
// Folded from tests/bug-2992-check-latest-version.test.cjs — consolidation epic #1969 (B5 #1974)
// ────────────────────────────────────────────────────────────────────────
{
const { describe: __foldDescribe } = require('node:test');
__foldDescribe("folded:bug-2992-check-latest-version (consolidation epic #1969 B5 #1974)", () => {
'use strict';
process.env.GSD_TEST_MODE = '1';
const { test, describe } = require('node:test');
const assert = require('node:assert/strict');
const path = require('node:path');
const ROOT = path.join(__dirname, '..');
const { checkLatestVersion, CHECK_REASON, PACKAGE_NAME } = require(
path.join(ROOT, 'gsd-core', 'bin', 'check-latest-version.cjs'),
);
// checkLatestVersion is a pure-ish function: it spawns one fixed npm
// command, validates the output, and returns { ok, version | reason }.
// The package name is HARDCODED — not a free choice for the caller.
// Tests use a pluggable spawn so no real npm process is invoked.
describe('Bug #2992: deterministic latest-version check', () => {
test('PACKAGE_NAME is the constant @opengsd/gsd-core (no callers can override)', () => {
assert.equal(PACKAGE_NAME, '@opengsd/gsd-core');
});
test('CHECK_REASON enum exposes the documented codes', () => {
assert.deepEqual(
Object.keys(CHECK_REASON).sort(),
['FAIL_INVALID_OUTPUT', 'FAIL_NPM_FAILED', 'OK'].sort(),
);
});
test('returns { ok: true, version } when npm prints a valid semver', () => {
const fakeSpawn = () => ({ status: 0, stdout: '1.39.1\n', stderr: '' });
const r = checkLatestVersion({ spawn: fakeSpawn });
assert.deepEqual(r, { ok: true, version: '1.39.1', reason: CHECK_REASON.OK });
});
});
describe('Bug #2992: error paths', () => {
const { checkLatestVersion, CHECK_REASON } = require(require('node:path').join(__dirname, '..', 'gsd-core', 'bin', 'check-latest-version.cjs'));
test('FAIL_NPM_FAILED when npm exits non-zero (e.g. offline, 404)', () => {
const r = checkLatestVersion({
spawn: () => ({ status: 1, stdout: '', stderr: 'npm ERR! 404\n' }),
});
assert.equal(r.ok, false);
assert.equal(r.reason, CHECK_REASON.FAIL_NPM_FAILED);
assert.equal(r.detail, 'npm ERR! 404',
'detail should be the trimmed stderr when npm reports a real error');
});
// #2993 CR: distinguish timeout from genuine npm failure in `detail`.
// spawnSync sets status=null and signal='SIGTERM' on timeout; stderr is
// typically empty. Without the signal-first branch, both shape as
// 'npm exited non-zero' and the operator cannot tell timeout from failure.
test('FAIL_NPM_FAILED detail names the signal when spawn times out', () => {
const r = checkLatestVersion({
spawn: () => ({ status: null, signal: 'SIGTERM', stdout: '', stderr: '' }),
});
assert.equal(r.ok, false);
assert.equal(r.reason, CHECK_REASON.FAIL_NPM_FAILED);
assert.equal(r.detail, 'npm timed out (signal: SIGTERM)',
'detail should explicitly name the signal when status is null and signal is set');
});
test('FAIL_NPM_FAILED detail falls back to generic when neither stderr nor signal is present', () => {
const r = checkLatestVersion({
spawn: () => ({ status: 1, stdout: '', stderr: '' }),
});
assert.equal(r.detail, 'npm exited non-zero');
});
test('FAIL_INVALID_OUTPUT when npm prints something that is not a semver', () => {
// E.g. if a future npm version changes the output format, or if the
// network returns an HTML error page captured as stdout.
const r = checkLatestVersion({
spawn: () => ({ status: 0, stdout: '<html>not a version</html>\n', stderr: '' }),
});
assert.equal(r.ok, false);
assert.equal(r.reason, CHECK_REASON.FAIL_INVALID_OUTPUT);
});
test('FAIL_INVALID_OUTPUT when stdout is empty', () => {
const r = checkLatestVersion({
spawn: () => ({ status: 0, stdout: '', stderr: '' }),
});
assert.equal(r.ok, false);
assert.equal(r.reason, CHECK_REASON.FAIL_INVALID_OUTPUT);
});
test('accepts pre-release semver (e.g. 1.40.0-rc.1)', () => {
const r = checkLatestVersion({
spawn: () => ({ status: 0, stdout: '1.40.0-rc.1\n', stderr: '' }),
});
assert.deepEqual(r, { ok: true, version: '1.40.0-rc.1', reason: CHECK_REASON.OK });
});
});
describe('Issue #815: --next dist-tag support', () => {
const { buildViewArgs, resolveTag, ALLOWED_TAGS } = require(
path.join(ROOT, 'gsd-core', 'bin', 'check-latest-version.cjs'),
);
test('ALLOWED_TAGS is the sanctioned channel allowlist (latest, next)', () => {
assert.deepEqual([...ALLOWED_TAGS].sort(), ['latest', 'next']);
});
test('buildViewArgs() defaults to the bare latest spec (byte-for-byte unchanged)', () => {
assert.deepEqual(buildViewArgs(), ['view', '@opengsd/gsd-core', 'version']);
assert.deepEqual(buildViewArgs('latest'), ['view', '@opengsd/gsd-core', 'version']);
});
test('buildViewArgs("next") targets the @next dist-tag', () => {
assert.deepEqual(buildViewArgs('next'), ['view', '@opengsd/gsd-core@next', 'version']);
});
test('resolveTag defaults to latest when no --tag flag', () => {
assert.equal(resolveTag(['--json']), 'latest');
});
test('resolveTag reads --tag next', () => {
assert.equal(resolveTag(['--json', '--tag', 'next']), 'next');
});
test('resolveTag rejects an unknown tag (typo guard)', () => {
assert.throws(() => resolveTag(['--tag', 'nightly']), /invalid --tag 'nightly'/);
});
test('resolveTag rejects --tag with no value', () => {
assert.throws(() => resolveTag(['--tag']), /invalid --tag ''/);
});
test('checkLatestVersion accepts an RC under the next tag', () => {
const r = checkLatestVersion({ tag: 'next', spawn: () => ({ status: 0, stdout: '1.4.0-rc.1\n', stderr: '' }) });
assert.deepEqual(r, { ok: true, version: '1.4.0-rc.1', reason: CHECK_REASON.OK });
});
test('buildViewArgs rejects a tag outside the allowlist (exported-API guard)', () => {
assert.throws(() => buildViewArgs('nightly'), /invalid dist-tag 'nightly'/);
});
test('checkLatestVersion rejects an out-of-allowlist tag even with an injected spawn', () => {
assert.throws(
() => checkLatestVersion({ tag: 'nightly', spawn: () => ({ status: 0, stdout: '9.9.9\n', stderr: '' }) }),
/invalid dist-tag 'nightly'/,
);
});
test('resolveTag handles the --tag=next equals form', () => {
assert.equal(resolveTag(['--json', '--tag=next']), 'next');
});
test('resolveTag rejects an unknown --tag=value equals form (no silent fallback)', () => {
assert.throws(() => resolveTag(['--tag=nightly']), /invalid --tag 'nightly'/);
});
});
});
}
// ────────────────────────────────────────────────────────────────────────
// Folded from tests/bug-378-update-check-scoped-name.test.cjs — consolidation epic #1969 (B5 #1974)
// ────────────────────────────────────────────────────────────────────────
{
const { describe: __foldDescribe } = require('node:test');
__foldDescribe("folded:bug-378-update-check-scoped-name (consolidation epic #1969 B5 #1974)", () => {
/**
* Regression test for #378 / #498: the SessionStart update worker must end up
* querying the SCOPED package name (@opengsd/gsd-core) when it asks
* npm for the latest version.
*
* Background (#378): the worker once hardcoded the unscoped 'gsd-core',
* which 404s from the registry, leaving update_available permanently false.
*
* Original #378 fix derived the name from `require('../package.json').name`.
* That is broken at runtime (#498): no package.json in the installed tree
* carries a `.name`. It used to resolve to the synthetic `{"type":"commonjs"}`
* marker GSD wrote at the config root, so post-install the worker queried
* `npm view undefined version` → latest stayed null → update_available
* permanently false; since #2544 GSD writes no marker there at all, so the
* require would now fail to resolve outright. The old structural test passed
* only because it grepped the DEV tree, where package.json still has a name.
*
* New contract (#498): the worker no longer resolves the package name itself.
* It delegates the latest-version lookup to check-latest-version.cjs's
* `checkLatestVersion()`, whose `PACKAGE_NAME` is sourced from the baked Package
* Identity seam (`gsd-core/bin/lib/package-identity.cjs`). The seam's value
* is a build-time constant, correct in every install layout, so the
* undefined-at-runtime failure cannot recur. This test locks that contract:
*
* 1. Structural: worker must NOT contain the bare unscoped literal.
* 2. Structural: worker must NOT use `require(...package.json...).name`
* (the runtime-broken path).
* 3. Structural: worker delegates to check-latest-version's
* `checkLatestVersion` rather than calling `npm view` itself.
* 4. Single-source: check-latest-version's PACKAGE_NAME === the seam's
* packageName === the scoped '@opengsd/gsd-core'.
*
* Source-grep policy: this test reads hook source via readFileSync. The repo's
* lint-no-source-grep rule targets bin/lib/gsd-core — hooks/ is out of
* scope. The behavior (correct name → no E404) only manifests at runtime
* against the live registry; structural assertions are the minimum-cost
* contract for the worker, the same rationale #378 carried.
*/
// allow-test-rule: structural-regression-guard (see #378)
// structural assertion on hook delegation; the behavior being
// tested (correct package name → no E404) only manifests at runtime against the
// live npm registry, which CI does not call.
'use strict';
const { test, describe } = require('node:test');
const assert = require('node:assert/strict');
const fs = require('fs');
const path = require('path');
const WORKER_PATH = path.join(__dirname, '..', 'hooks', 'gsd-check-update-worker.js');
const PKG_PATH = path.join(__dirname, '..', 'package.json');
const SEAM = require('../gsd-core/bin/lib/package-identity.cjs');
const { PACKAGE_NAME } = require('../gsd-core/bin/check-latest-version.cjs');
function workerCodeOnly() {
const src = fs.readFileSync(WORKER_PATH, 'utf8');
return src
// eslint-disable-next-line local/no-unbounded-quantifier -- parses this repo's own bounded hooks source, not adversarial input
.replace(/\/\*[\s\S]*?\*\//g, '')
// eslint-disable-next-line local/no-unbounded-quantifier -- parses this repo's own bounded hooks source, not adversarial input
.replace(/(^|[^:])\/\/[^\r\n]*/g, '$1');
}
describe('bug #378 / #498: update worker queries the scoped name via the seam', () => {
test('worker file exists', () => {
assert.ok(fs.existsSync(WORKER_PATH), `worker not found at ${WORKER_PATH}`);
});
test('package.json name is the scoped @opengsd/gsd-core', () => {
const pkg = JSON.parse(fs.readFileSync(PKG_PATH, 'utf8'));
assert.equal(pkg.name, '@opengsd/gsd-core');
});
test('worker does NOT hardcode the unscoped gsd-core as a string literal', () => {
assert.doesNotMatch(
workerCodeOnly(),
/['"]gsd-core['"]/,
"Worker must not pass the unscoped 'gsd-core' to npm — it 404s.",
);
});
test('worker does NOT resolve the name via require(package.json).name (broken at runtime)', () => {
assert.doesNotMatch(
workerCodeOnly(),
/require\s*\(\s*['"][^'"]*package\.json['"]\s*\)\s*\.name/,
[
'require(package.json).name never yields a name in the installed tree —',
'GSD stages only {"type":"commonjs"} markers, and since #2544 none at the',
'config root. The worker must delegate to checkLatestVersion(), which',
'sources the name from the baked seam.',
].join(' '),
);
});
test('worker delegates the latest-version lookup to checkLatestVersion', () => {
const code = workerCodeOnly();
assert.match(
code,
/check-latest-version/,
'Worker must require check-latest-version.cjs and call checkLatestVersion().',
);
assert.match(code, /checkLatestVersion\s*\(/);
});
test('check-latest-version PACKAGE_NAME is single-sourced from the seam', () => {
assert.equal(PACKAGE_NAME, SEAM.packageName);
assert.equal(SEAM.packageName, '@opengsd/gsd-core');
});
});
});
}
// ────────────────────────────────────────────────────────────────────────
// Folded from tests/bug-2784-update-cache-clear-path.test.cjs — consolidation epic #1969 (B5 #1974)
// ────────────────────────────────────────────────────────────────────────
{
const { describe: __foldDescribe } = require('node:test');
__foldDescribe("folded:bug-2784-update-cache-clear-path (consolidation epic #1969 B5 #1974)", () => {
// allow-test-rule: structural-regression-guard (see #2784)
// Reads hook .js or bin/install.js source to assert structural invariants
// (search array order, function wiring, path constants) that cannot be
// verified by observing runtime outputs alone. Per CONTRIBUTING.md exception matrix.
/**
* Regression test for bug #2784
*
* /gsd-update cache-clear step only cleared per-runtime cache paths
* (e.g. ~/.claude/cache/gsd-update-check.json) but the SessionStart hook
* (hooks/gsd-check-update.js) writes to the shared tool-agnostic path
* ~/.cache/gsd/gsd-update-check.json. After a successful update, the statusline
* kept showing the stale "⬆ /gsd-update" indicator because the actual cache
* file was never deleted.
*
* Fix: add `rm -f "$HOME/.cache/gsd/gsd-update-check.json"` to the
* run_update step's cache-clear block in gsd-core/workflows/update.md.
*/
'use strict';
const { describe, test } = require('node:test');
const assert = require('node:assert/strict');
const fs = require('node:fs');
const path = require('node:path');
const REPO_ROOT = path.join(__dirname, '..');
const UPDATE_WORKFLOW = path.join(
REPO_ROOT,
'gsd-core',
'workflows',
'update.md'
);
const CHECK_UPDATE_HOOK = path.join(REPO_ROOT, 'hooks', 'gsd-check-update.js');
describe('bug-2784: update.md cache-clear covers shared cache path', () => {
test('gsd-check-update.js hook constructs cache dir from .cache and gsd path segments', () => {
const hookContent = fs.readFileSync(CHECK_UPDATE_HOOK, 'utf-8');
// Parse the path.join() call structurally rather than text-grepping.
// eslint-disable-next-line local/no-unbounded-quantifier -- parses this repo's own bounded hooks/gsd-check-update.js source, not adversarial input
const m = hookContent.match(/const cacheDir\s*=\s*path\.join\(([^)]+)\)/);
assert.ok(
m !== null,
'hook must assign cacheDir via path.join() with explicit path segments'
);
const segments = m[1].split(',').map((a) => a.trim().replace(/^['"]|['"]$/g, ''));
assert.ok(
segments.includes('.cache'),
`hook cacheDir path.join() must include '.cache' segment; got: ${JSON.stringify(segments)}`
);
assert.ok(
segments.includes('gsd'),
`hook cacheDir path.join() must include 'gsd' segment; got: ${JSON.stringify(segments)}`
);
});
test('update.md run_update bash commands include rm for shared gsd cache file', () => {
const workflowContent = fs.readFileSync(UPDATE_WORKFLOW, 'utf-8');
// Parse the step block structurally, then extract only bash fenced code lines.
// eslint-disable-next-line local/no-unbounded-quantifier -- parses this repo's own workflow .md content, fixed-size author-controlled content
const stepMatch = workflowContent.match(/<step name="run_update">[\s\S]*?<\/step>/);
assert.ok(stepMatch, 'update.md must have a <step name="run_update"> block');
const stepContent = stepMatch[0];
const bashLines = [];
const stepLines = stepContent.split(/\r?\n/);
for (const block of scanFencedBlocks(stepLines)) {
if (block.closeLineIdx === -1) continue;
const info = (block.infoString || '').trim();
if (info !== 'bash' && info !== 'sh') continue;
for (const line of stepLines.slice(block.openLineIdx + 1, block.closeLineIdx)) {
const trimmed = line.trim();
if (trimmed) bashLines.push(trimmed);
}
}
const sharedCacheClearCmds = bashLines.filter(
(line) => /^rm\b/.test(line) && line.includes('.cache/gsd/gsd-update-check') && line.includes('*.json')
);
assert.ok(
sharedCacheClearCmds.length > 0,
[
'run_update step bash blocks must include an `rm` command targeting .cache/gsd/gsd-update-check*.json (glob form clearing legacy + per-package variants).',
`Bash lines found: ${JSON.stringify(bashLines)}`,
].join('\n')
);
const hasHomeExpansion = sharedCacheClearCmds.some(
(line) => line.includes('$HOME') || line.includes('~/')
);
assert.ok(
hasHomeExpansion,
`shared cache rm command must use $HOME or ~/ expansion; found: ${JSON.stringify(sharedCacheClearCmds)}`
);
});
});
});
}
// ────────────────────────────────────────────────────────────────────────
// Folded from tests/feat-2795-update-banner.test.cjs — consolidation epic #1969 (B5 #1974)
// ────────────────────────────────────────────────────────────────────────
{
const { describe: __foldDescribe } = require('node:test');
__foldDescribe("folded:feat-2795-update-banner (consolidation epic #1969 B5 #1974)", () => {
/**
* Tests for gsd-update-banner.js (#2795).
*
* The banner hook is an opt-in SessionStart consumer of the update cache that
* gsd-check-update-worker.js writes. When a user declines GSD's statusline,
* install.js may register this hook so update availability still surfaces in
* runtimes that use a non-GSD statusline.
*
* Tests follow the typed-IR convention (CONTRIBUTING.md "Prohibited: Raw Text
* Matching on Test Outputs"): assert on parsed JSON envelopes, not on raw
* stdout substrings.
*/
'use strict';
const { test, describe } = require('node:test');
const assert = require('node:assert/strict');
const fs = require('node:fs');
const os = require('node:os');
const path = require('node:path');
const { runHook: seamRunHook } = require('./helpers/process-seam.cjs');
const { cleanup } = require('./helpers.cjs');
const HOOK_PATH = path.join(__dirname, '..', 'hooks', 'gsd-update-banner.js');
const {
buildBannerOutput,
shouldSuppressFailureWarning,
RATE_LIMIT_SECONDS,
} = require('../hooks/gsd-update-banner.js');
const { updateCacheFileName } = require('../gsd-core/bin/lib/package-identity.cjs');
// ─── Pure function: buildBannerOutput ───────────────────────────────────────
describe('buildBannerOutput', () => {
test('returns null when cache is missing', () => {
const out = buildBannerOutput({
cache: null,
parseError: false,
suppressFailureWarning: false,
});
assert.equal(out, null);
});
test('returns null when update_available is false', () => {
const out = buildBannerOutput({
cache: { update_available: false, installed: '1.40.0', latest: '1.40.0' },
parseError: false,
suppressFailureWarning: false,
});
assert.equal(out, null);
});
test('returns banner envelope when update_available is true', () => {
const out = buildBannerOutput({
cache: { update_available: true, installed: '1.39.0', latest: '1.40.0', package_name: '@opengsd/gsd-core' },
parseError: false,
suppressFailureWarning: false,
});
assert.ok(out, 'expected banner envelope');
assert.equal(typeof out.systemMessage, 'string');
assert.ok(
out.systemMessage.includes('1.39.0'),
'banner should name installed version'
);
assert.ok(
out.systemMessage.includes('1.40.0'),
'banner should name latest version'
);
assert.ok(
out.systemMessage.includes('/gsd:update'),
'banner should reference /gsd:update command'
);
});
test('returns failure diagnostic on parseError when not suppressed', () => {
const out = buildBannerOutput({
cache: null,
parseError: true,
suppressFailureWarning: false,
});
assert.ok(out, 'expected diagnostic envelope');
assert.equal(typeof out.systemMessage, 'string');
assert.ok(
/check failed/i.test(out.systemMessage),
'diagnostic should describe a failed check'
);
});
test('returns null on parseError when suppressed by rate limit', () => {
const out = buildBannerOutput({
cache: null,
parseError: true,
suppressFailureWarning: true,
});
assert.equal(out, null);
});
test('falls back to "unknown" when installed/latest missing', () => {
const out = buildBannerOutput({
cache: { update_available: true, package_name: '@opengsd/gsd-core' },
parseError: false,
suppressFailureWarning: false,
});
assert.ok(out);
assert.ok(
out.systemMessage.includes('unknown'),
'banner should degrade gracefully when versions are absent'
);
});
});
// ─── Pure function: shouldSuppressFailureWarning ────────────────────────────
describe('shouldSuppressFailureWarning', () => {
function tmpDir() {
return fs.mkdtempSync(path.join(os.tmpdir(), 'gsd-banner-supp-'));
}
test('returns false when sentinel file is missing', () => {
const dir = tmpDir();
try {
const result = shouldSuppressFailureWarning(
path.join(dir, 'no-such-file'),
100
);
assert.equal(result, false);
} finally {
cleanup(dir);
}
});
test('returns true within rate-limit window', () => {
const dir = tmpDir();
try {
const f = path.join(dir, 'sentinel');
fs.writeFileSync(f, '1000');
const result = shouldSuppressFailureWarning(f, 1000 + RATE_LIMIT_SECONDS - 1);
assert.equal(result, true);
} finally {
cleanup(dir);
}
});
test('returns false outside rate-limit window', () => {
const dir = tmpDir();
try {
const f = path.join(dir, 'sentinel');
fs.writeFileSync(f, '1000');
const result = shouldSuppressFailureWarning(f, 1000 + RATE_LIMIT_SECONDS + 1);
assert.equal(result, false);
} finally {
cleanup(dir);
}
});
test('returns false when sentinel content is non-numeric', () => {
const dir = tmpDir();
try {
const f = path.join(dir, 'sentinel');
fs.writeFileSync(f, 'garbage-not-a-number');
const result = shouldSuppressFailureWarning(f, 100);
assert.equal(result, false);
} finally {
cleanup(dir);
}
});
});
// ─── End-to-end: spawn the hook against fixture cache states ────────────────
describe('gsd-update-banner.js end-to-end', () => {
function setupHome() {
const home = fs.mkdtempSync(path.join(os.tmpdir(), 'gsd-banner-home-'));
fs.mkdirSync(path.join(home, '.cache', 'gsd'), { recursive: true });
return home;
}
function runHook(home) {
// 10000ms: previously UNBOUNDED (no `timeout` option passed to
// spawnSync). gsd-update-banner.js only reads a small cache file from
// disk and prints JSON — no subprocess/network work — so 10s is
// generous headroom over its sub-second worst case even on a
// contended CI runner.
const r = seamRunHook(HOOK_PATH, [], {
env: { ...process.env, HOME: home, USERPROFILE: home },
timeoutMs: 10_000,
});
return { status: r.exitCode, stdout: r.stdout, stderr: r.stderr };
}
function writeCache(home, contents) {
fs.writeFileSync(
path.join(home, '.cache', 'gsd', updateCacheFileName),
typeof contents === 'string' ? contents : JSON.stringify(contents)
);
}
test('exits 0 with empty stdout when cache file missing', () => {
const home = setupHome();
try {
const r = runHook(home);
assert.equal(r.status, 0, `expected exit 0, got ${r.status} stderr=${r.stderr}`);
assert.equal(r.stdout.trim(), '');
} finally {
cleanup(home);
}
});
test('emits valid SessionStart JSON when update_available=true', () => {
const home = setupHome();
try {
writeCache(home, {
update_available: true,
installed: '1.39.0',
latest: '1.40.0',
package_name: '@opengsd/gsd-core',
});
const r = runHook(home);
assert.equal(r.status, 0);
const parsed = JSON.parse(r.stdout);
assert.equal(typeof parsed.systemMessage, 'string');
assert.ok(parsed.systemMessage.includes('1.40.0'));
assert.ok(parsed.systemMessage.includes('/gsd:update'));
} finally {
cleanup(home);
}
});
test('exits silent when update_available=false', () => {
const home = setupHome();
try {
writeCache(home, {
update_available: false,
installed: '1.40.0',
latest: '1.40.0',
});
const r = runHook(home);
assert.equal(r.status, 0);
assert.equal(r.stdout.trim(), '');
} finally {
cleanup(home);
}
});
test('emits failure diagnostic when cache JSON is malformed', () => {
const home = setupHome();
try {
writeCache(home, 'not json {{{{');
const r = runHook(home);
assert.equal(r.status, 0);
const parsed = JSON.parse(r.stdout);
assert.equal(typeof parsed.systemMessage, 'string');
assert.ok(/check failed/i.test(parsed.systemMessage));
} finally {
cleanup(home);
}
});
test('suppresses repeat failure diagnostic within 24h via sentinel', () => {
const home = setupHome();
try {
writeCache(home, 'not json');
const r1 = runHook(home);
assert.equal(
r1.status,
0,
`expected exit 0, got ${r1.status} stderr=${r1.stderr}`
);
const parsed1 = JSON.parse(r1.stdout);
assert.ok(/check failed/i.test(parsed1.systemMessage));
// Sentinel should now exist so the next run is silent
const sentinel = path.join(home, '.cache', 'gsd', 'banner-failure-warned-at');
assert.ok(fs.existsSync(sentinel), 'first run must record the warning sentinel');
const r2 = runHook(home);
assert.equal(r2.status, 0);
assert.equal(
r2.stdout.trim(),
'',
'subsequent run within rate-limit window must stay silent'
);
} finally {
cleanup(home);
}
});
test('handles cache present but update_available field absent (older cache schema)', () => {
const home = setupHome();
try {
writeCache(home, { installed: '1.40.0', latest: '1.40.0' });
const r = runHook(home);
assert.equal(r.status, 0);
assert.equal(r.stdout.trim(), '');
} finally {
cleanup(home);
}
});
});
// ─── #3582: cold tree (no gsd-core/bin/lib/*.cjs) — degrade, not crash ─────
//
// gsd-core/bin/lib/package-identity.cjs is a tsc build artifact (ADR-457),
// gitignored and absent on a raw plugin-marketplace / git-clone install that
// never ran `npm run build:lib`. This is an opt-in SessionStart hook — a
// build failure must degrade (PACKAGE_NAME stays null), not crash session
// start. The DEGRADED VERDICT this locks: buildBannerOutput's own lineage
// guard (`!cache.package_name || cache.package_name !== PACKAGE_NAME`)
// unconditionally distrusts ANY cache once PACKAGE_NAME is null, so even a
// cache written by a healthy worker (real package_name, update_available:
// true) must be suppressed rather than surfaced — the hook stays SILENT
// (exit 0, empty stdout), never a crash and never a stale/wrong banner.
// Simulated hermetically via tests/helpers/cold-runtime-lib-fixture.cjs — the
// REAL gsd-core/bin/lib/ is never touched.
describe('gsd-update-banner.js: #3582 cold tree — degrades to silent, never crashes', () => {
const { buildColdInstallTree } = require('./helpers/cold-runtime-lib-fixture.cjs');
test('missing compiled runtime library -> exits 0 with empty stdout even for an otherwise-valid update-available cache', (t) => {
const cold = buildColdInstallTree();
t.after(cold.cleanup);
const home = fs.mkdtempSync(path.join(os.tmpdir(), 'gsd-banner-cold-home-'));
t.after(() => cleanup(home));
fs.mkdirSync(path.join(home, '.cache', 'gsd'), { recursive: true });
// The generic fallback filename the hook's own #3582 degrade uses when
// package-identity.cjs cannot be built (mirrors gsd-check-update.js's
// identical fallback literal) — this is the SAME cache path a degraded
// worker would also have written to.
fs.writeFileSync(
path.join(home, '.cache', 'gsd', 'gsd-update-check.json'),
JSON.stringify({
update_available: true,
installed: '1.39.0',
latest: '1.40.0',
package_name: '@opengsd/gsd-core',
}),
);
const r = seamRunHook(path.join(cold.hooksDir, 'gsd-update-banner.js'), [], {
env: { ...process.env, HOME: home, USERPROFILE: home },
timeoutMs: 10_000,
});
assert.equal(r.exitCode, 0, `hook must exit 0 on a build failure; stderr: ${r.stderr}`);
assert.equal(
r.stdout.trim(),
'',
'a cold tree must silently suppress the banner (PACKAGE_NAME degrades to null, ' +
'so the lineage guard distrusts every cache) rather than crash or print stale content',
);
});
});
// ─── Install.js wiring: prompt + SessionStart entry registration ────────────
//
// These tests load bin/install.js as a module via GSD_TEST_MODE and assert on
// pure exported helpers. The shape mirrors how runtime-prompt-builder /
// statusline tests interact with install.js.
describe('install.js update-banner wiring', () => {
process.env.GSD_TEST_MODE = '1';
// Re-require fresh so test-mode exports are populated.
const installPath = path.join(__dirname, '..', 'bin', 'install.js');
delete require.cache[installPath];
const installExports = require(installPath);
test('exports buildUpdateBannerPromptText for structural prompt assertions', () => {
assert.equal(
typeof installExports.buildUpdateBannerPromptText,
'function',
'install.js must export buildUpdateBannerPromptText so tests can assert without grepping source'
);
const text = installExports.buildUpdateBannerPromptText();
assert.equal(typeof text, 'string');
assert.ok(text.length > 0);
// Strip ANSI color escapes before structural assertions — the choice
// digits are wrapped in color codes so word-boundary regex against the
// raw text would miss them.
// eslint-disable-next-line no-control-regex -- \x1b (ESC) is the required leading byte of ANSI SGR color sequences; matching it is the purpose of stripping ANSI codes from captured CLI/console output
const stripped = text.replace(/\x1b\[[0-9;]*m/g, '');
// Prompt must offer at least two choices (default + opt-in).
assert.match(stripped, /\b1\b/);
assert.match(stripped, /\b2\b/);
});
test('parseUpdateBannerInput defaults to false on empty / "1"', () => {
assert.equal(typeof installExports.parseUpdateBannerInput, 'function');
assert.equal(installExports.parseUpdateBannerInput(''), false);
assert.equal(installExports.parseUpdateBannerInput(' '), false);
assert.equal(installExports.parseUpdateBannerInput('1'), false);
});
test('parseUpdateBannerInput returns true on "2"', () => {
assert.equal(installExports.parseUpdateBannerInput('2'), true);
assert.equal(installExports.parseUpdateBannerInput('2 '), true);
});
test('parseUpdateBannerInput accepts "y" / "yes" affirmative shortcuts', () => {
assert.equal(installExports.parseUpdateBannerInput('y'), true);
assert.equal(installExports.parseUpdateBannerInput('Y'), true);
assert.equal(installExports.parseUpdateBannerInput('yes'), true);
assert.equal(installExports.parseUpdateBannerInput('YES'), true);
});
test('buildUpdateBannerHookEntry produces a SessionStart hook entry', () => {
assert.equal(typeof installExports.buildUpdateBannerHookEntry, 'function');
const entry = installExports.buildUpdateBannerHookEntry(
'"/usr/local/bin/node" "/home/u/.claude/hooks/gsd-update-banner.js"'
);
assert.ok(entry, 'expected hook entry object');
assert.ok(Array.isArray(entry.hooks), 'entry.hooks must be an array');
assert.equal(entry.hooks.length, 1);
assert.equal(entry.hooks[0].type, 'command');
assert.ok(
entry.hooks[0].command.includes('gsd-update-banner.js'),
'command must reference the banner hook'
);
});
test('buildUpdateBannerHookEntry returns null on null command', () => {
assert.equal(installExports.buildUpdateBannerHookEntry(null), null);
assert.equal(installExports.buildUpdateBannerHookEntry(''), null);
});
});
});
}