* refactor(#455): implement typed surfaces to retire grep tests Production surfaces added: - hooks/managed-hooks-registry.cjs: new CJS module exporting MANAGED_HOOKS as a typed array; gsd-check-update-worker.js now requires it instead of declaring an inline array - bin/install.js: elevate inline gsdHooks to module-level GSD_UNINSTALL_HOOKS, export it alongside runtimeMap/allRuntimes (already exported) - scripts/build-hooks.js: export HOOKS_TO_COPY; guard build() behind require.main===module so tests can require the file without triggering a build - get-shit-done/bin/lib/init.cjs: add --json mode to agent-skills command, emitting typed IR { agent_type, block, skills_count } for test assertions - get-shit-done/bin/gsd-tools.cjs: wire --json flag for agent-skills dispatch Category-B source-grep migrations: - tests/managed-hooks.test.cjs: require MANAGED_HOOKS from registry, drop fs.readFileSync+regex - tests/orphaned-hooks.test.cjs: require MANAGED_HOOKS+HOOKS_TO_COPY as typed exports - tests/hooks-opt-in.test.cjs: replace gsdHooks regex-parse with GSD_UNINSTALL_HOOKS import - tests/install-minimal-hooks.test.cjs: replace gsdHooks regex-parse with GSD_UNINSTALL_HOOKS - tests/copilot-install.test.cjs: replace src.includes() checks with typed assertions on runtimeMap, allRuntimes, parseRuntimeInput, buildRuntimePromptText - tests/agent-skills.test.cjs: migrate to --json typed IR assertions pending-migration-to-typed-ir token cleared (87 of 87 files): - 78 files already had source-text-is-the-product; removed duplicate token - 5 files already used typed assertions; reclassified or annotated - 4 files required individual reclassification to source-text-is-the-product or architectural-invariant Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * fix(#455): update workflow-guard test to typed GSD_UNINSTALL_HOOKS import; isolate HOME in runtime-launcher (D) test Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * fix(#455): guard install.js main() behind require.main===module so the typed export is require-safe Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * docs(#455): document --json typed surfaces for agent-skills, progress, validate context Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * docs(#455): add changeset fragment for new --json surfaces Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * fix(#455): complete grep migration for files flagged by lint-tests The branch commit 4e630d99 stripped `allow-test-rule: pending-migration-to-typed-ir` from ~80 test files without replacing their assertions or adding the correct exemption annotation. The files were NOT source-grep tests — they read .md workflow/agent/command/reference files (source-text-is-the-product) or hook source files for structural invariants (structural-regression-guard). No assertion logic was changed; only the correct allow-test-rule annotation was added to each file per CONTRIBUTING.md exception matrix. 73 files: `source-text-is-the-product` — workflow/agent/command/reference .md 7 files: `structural-regression-guard` — hook .js / bin/install.js structural checks Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> --------- Co-authored-by: CI Rebase Check <ci@gsd-redux> Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
Tom Boucher
@@ -1,14 +1,18 @@
|
||||
// allow-test-rule: pending-migration-to-typed-ir [#2974]
|
||||
// Tracked in #2974 for migration to typed-IR assertions per CONTRIBUTING.md
|
||||
// "Prohibited: Raw Text Matching on Test Outputs". Per-file review may
|
||||
// reclassify some entries as source-text-is-the-product during migration.
|
||||
|
||||
// allow-test-rule: structural-regression-guard
|
||||
// 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 #1750: orphaned hook files from removed features
|
||||
* (e.g., gsd-intel-*.js) should NOT be flagged as stale by gsd-check-update.js.
|
||||
*
|
||||
* The stale hooks scanner should only check hooks that are part of the current
|
||||
* distribution, not every gsd-*.js file in the hooks directory.
|
||||
*
|
||||
* Migration note (#455): previously used fs.readFileSync + regex on the worker
|
||||
* and build-hooks source to extract arrays. Now imports typed exports directly:
|
||||
* - hooks/managed-hooks-registry.cjs → MANAGED_HOOKS
|
||||
* - scripts/build-hooks.js → HOOKS_TO_COPY
|
||||
*/
|
||||
|
||||
const { test, describe } = require('node:test');
|
||||
@@ -16,29 +20,41 @@ const assert = require('node:assert/strict');
|
||||
const fs = require('fs');
|
||||
const path = require('path');
|
||||
|
||||
// MANAGED_HOOKS lives in the worker file (extracted from inline -e code to eliminate
|
||||
// template-literal regex-escaping concerns). Tests read the worker directly.
|
||||
const CHECK_UPDATE_PATH = path.join(__dirname, '..', 'hooks', 'gsd-check-update.js');
|
||||
const WORKER_PATH = path.join(__dirname, '..', 'hooks', 'gsd-check-update-worker.js');
|
||||
const BUILD_HOOKS_PATH = path.join(__dirname, '..', 'scripts', 'build-hooks.js');
|
||||
const HOOKS_DIR = path.join(__dirname, '..', 'hooks');
|
||||
|
||||
// Typed imports — no source-grep needed (#455)
|
||||
const { MANAGED_HOOKS } = require(path.join(HOOKS_DIR, 'managed-hooks-registry.cjs'));
|
||||
const { HOOKS_TO_COPY } = require(path.join(__dirname, '..', 'scripts', 'build-hooks.js'));
|
||||
|
||||
describe('orphaned hooks stale detection (#1750)', () => {
|
||||
test('stale hook scanner uses an allowlist of managed hooks, not a wildcard', () => {
|
||||
const content = fs.readFileSync(WORKER_PATH, 'utf8');
|
||||
test('MANAGED_HOOKS is an array and does not use a broad gsd-* wildcard', () => {
|
||||
// The scanner must reference a known set of managed hook filenames,
|
||||
// not a broad startsWith('gsd-') filter that catches orphaned files.
|
||||
assert.ok(Array.isArray(MANAGED_HOOKS), 'MANAGED_HOOKS must be an array');
|
||||
// Each entry is a concrete filename string — no glob/wildcard patterns
|
||||
for (const entry of MANAGED_HOOKS) {
|
||||
assert.ok(typeof entry === 'string', `MANAGED_HOOKS entry must be a string, got ${typeof entry}`);
|
||||
assert.ok(!entry.includes('*'), `MANAGED_HOOKS entry '${entry}' must not contain wildcards`);
|
||||
assert.ok(entry.startsWith('gsd-'), `MANAGED_HOOKS entry '${entry}' must start with gsd-`);
|
||||
}
|
||||
});
|
||||
|
||||
// The scanner MUST NOT use a broad `startsWith('gsd-')` filter that catches
|
||||
// orphaned files from removed features (gsd-intel-index.js, gsd-intel-prune.js, etc.)
|
||||
// Instead, it should reference a known set of managed hook filenames.
|
||||
const hasBroadFilter = /readdirSync\([^)]+\)\.filter\([^)]*startsWith\('gsd-'\)\s*&&[^)]*endsWith\('\.js'\)/s.test(content);
|
||||
assert.ok(!hasBroadFilter,
|
||||
'scanner must NOT use broad startsWith("gsd-") && endsWith(".js") filter — ' +
|
||||
'this catches orphaned hooks from removed features (e.g., gsd-intel-index.js). ' +
|
||||
'Use a MANAGED_HOOKS allowlist instead.');
|
||||
test('gsd-check-update-worker.js imports managed-hooks-registry.cjs (not inline array)', () => {
|
||||
const content = fs.readFileSync(WORKER_PATH, 'utf8');
|
||||
assert.ok(
|
||||
content.includes('managed-hooks-registry.cjs'),
|
||||
'gsd-check-update-worker.js must require managed-hooks-registry.cjs'
|
||||
);
|
||||
// The inline MANAGED_HOOKS array must no longer be in the worker
|
||||
assert.ok(
|
||||
!content.includes('const MANAGED_HOOKS = ['),
|
||||
'gsd-check-update-worker.js must not define MANAGED_HOOKS inline — it should import from managed-hooks-registry.cjs'
|
||||
);
|
||||
});
|
||||
|
||||
test('gsd-check-update.js spawns the worker by file path (not inline -e code)', () => {
|
||||
// After the worker extraction, the main hook must spawn the worker file
|
||||
// rather than embedding all logic in a template literal.
|
||||
const content = fs.readFileSync(CHECK_UPDATE_PATH, 'utf8');
|
||||
assert.ok(
|
||||
content.includes('gsd-check-update-worker.js'),
|
||||
@@ -50,33 +66,20 @@ describe('orphaned hooks stale detection (#1750)', () => {
|
||||
);
|
||||
});
|
||||
|
||||
test('managed hooks list in worker matches build-hooks HOOKS_TO_COPY JS entries', () => {
|
||||
// Extract JS hooks from build-hooks.js HOOKS_TO_COPY
|
||||
const buildContent = fs.readFileSync(BUILD_HOOKS_PATH, 'utf8');
|
||||
const hooksArrayMatch = buildContent.match(/HOOKS_TO_COPY\s*=\s*\[([\s\S]*?)\]/);
|
||||
assert.ok(hooksArrayMatch, 'should find HOOKS_TO_COPY array');
|
||||
|
||||
const jsHooks = [];
|
||||
const hookEntries = hooksArrayMatch[1].matchAll(/'([^']+\.js)'/g);
|
||||
for (const m of hookEntries) {
|
||||
jsHooks.push(m[1]);
|
||||
}
|
||||
test('MANAGED_HOOKS includes each JS hook from HOOKS_TO_COPY', () => {
|
||||
assert.ok(Array.isArray(HOOKS_TO_COPY), 'HOOKS_TO_COPY must be an array');
|
||||
const jsHooks = HOOKS_TO_COPY.filter(h => h.endsWith('.js'));
|
||||
assert.ok(jsHooks.length >= 5, `expected at least 5 JS hooks in HOOKS_TO_COPY, got ${jsHooks.length}`);
|
||||
|
||||
// MANAGED_HOOKS in the worker must include each JS hook from HOOKS_TO_COPY
|
||||
const workerContent = fs.readFileSync(WORKER_PATH, 'utf8');
|
||||
for (const hook of jsHooks) {
|
||||
assert.ok(
|
||||
workerContent.includes(hook),
|
||||
`MANAGED_HOOKS in worker should include '${hook}' from HOOKS_TO_COPY`
|
||||
MANAGED_HOOKS.includes(hook),
|
||||
`MANAGED_HOOKS should include '${hook}' from HOOKS_TO_COPY`
|
||||
);
|
||||
}
|
||||
});
|
||||
|
||||
test('orphaned hook filenames are NOT in the MANAGED_HOOKS list', () => {
|
||||
const workerContent = fs.readFileSync(WORKER_PATH, 'utf8');
|
||||
|
||||
// These are real orphaned hooks from the removed intel feature
|
||||
test('orphaned hook filenames are NOT in MANAGED_HOOKS', () => {
|
||||
const orphanedHooks = [
|
||||
'gsd-intel-index.js',
|
||||
'gsd-intel-prune.js',
|
||||
@@ -85,8 +88,8 @@ describe('orphaned hooks stale detection (#1750)', () => {
|
||||
|
||||
for (const orphan of orphanedHooks) {
|
||||
assert.ok(
|
||||
!workerContent.includes(orphan),
|
||||
`orphaned hook '${orphan}' must NOT be in the MANAGED_HOOKS list`
|
||||
!MANAGED_HOOKS.includes(orphan),
|
||||
`orphaned hook '${orphan}' must NOT be in MANAGED_HOOKS`
|
||||
);
|
||||
}
|
||||
});
|
||||
|
||||
Reference in New Issue
Block a user