fix(#3023): stage pi's shared hook bundle outside pi's reserved hooks/ directory (#3175)

* test(#3023): failing-first guard — pi must not stage hooks in its reserved dir

pi reserves <configDir>/hooks as its deprecated extension location and warns
on every startup when it exists. Assert a pi install stages the shared hook
bundle under gsd-hooks/ instead, manifests it there, and never creates hooks/.

Also adds pi to the local-scope dir table in install-shared.cjs: pi was in
RUNTIME_META but not LOCAL_DIR_NAME, so scope:'local' resolved
path.join(root, undefined) and no local pi install could be exercised.

Fails before the fix. Verified via the remote runner.

* fix(#3023): stage pi's shared hook bundle outside pi's reserved hooks/ dir

pi reserves <configDir>/hooks as its now-deprecated extension location and
warns on every startup when that directory merely exists — checkDeprecatedExtensionDirs()
guards the warning with a bare existsSync(), unlike its tools/ sibling. GSD staged
its shared hook bundle exactly there, and pi's advised remediation (move it to
extensions/) would break the adapter's paths and expose GSD's .js helpers to pi's
extension auto-discovery.

The bundle directory name is now runtime-descriptor-driven: hostBehaviors
.sharedHooksDirName, defaulting to 'hooks' so all 18 other runtimes are
byte-identical. pi sets 'gsd-hooks'. The name is validated as a single path
segment — separators, dot-only segments, trailing dots, absolute paths, NUL,
and Windows reserved device names all fall back to the default, because the
value is joined onto a user's config root and written to.

Renamed in place rather than relocated: hook scripts resolve siblings via
__dirname/.., so a depth change would silently break them.

- install / uninstall / manifest sites all read the resolved name
- pi/gsd.cjs probes gsd-hooks then hooks, so dev checkouts and half-upgraded
  trees still resolve; the never-throws contract is preserved
- new migration 009 retires the legacy pi hooks/ dir on upgrade, using a new
  non-recursive remove-empty-dir engine primitive (rmdirSync only,
  symlink-refusing, containment-guarded); ADR-0008 amended accordingly
- fixes two latent name-dependencies the rename exposed: the stale-hook scan
  and the injection scanner's self-exclusion both hardcoded 'hooks'

Verified on the remote runner.

Closes #3023

* fix(#3023): close review findings and align emitted provenance with the rename

Adversarial review found two defects, and the remote runner found four
failure clusters. All fixed here.

Review BLOCKER — detect-custom-files was blind to the renamed bundle.
GSD_PREFIX_MANAGED_DIRS in gsd-tools.cjs hardcoded 'hooks', so for pi the
whole gsd-hooks/ tree was invisible to the custom-file scan and user-added
files there were never backed up before the next update's clean-install wipe.
The dir set now resolves via the .gsd-runtime marker plus the shipped
capability registry (never bin/install.js, which is not shipped into installed
trees), and falls back to scanning every known candidate when the runtime
cannot be determined — over-scanning is safe, under-scanning is the data loss.

Review MAJOR — the pi adapter bound to an empty bundle. resolveSharedHooksDir
accepted any directory, so an interrupted install left gsd-hooks/ winning over
a fully-staged legacy hooks/ and every hook silently no-opped. A candidate now
qualifies only if it is non-empty.

Remote-runner clusters:
- emitted-provenance had no rule for the gsd-hooks/ family; added two pi-scoped
  rules pointing at the same sources the existing hooks/ rules use. The table is
  total, so an unattributed family is a hard failure by design.
- pi tests in install-minimal-hooks and the install integration suite asserted
  the old layout; updated to derive the dir name from the descriptor rather than
  hardcoding either name.
- 19 unrelated-looking failures on node22 only were a leaked fs mock: t.after()
  runs in registration order, cleanup was registered before mock.restoreAll(),
  and node22's JS rimraf calls the public fs.rmdirSync while node24's native
  path does not — so the EACCES stub leaked process-wide on one lane. Restore
  now runs first.

Verified on the remote runner.

* fix(#3023): honor PI_CODING_AGENT_DIR, ack the rename ripple, fix expandTilde

pi resolves its agent dir as PI_CODING_AGENT_DIR ?? ~/<CONFIG_DIR_NAME>/agent
(packages/coding-agent/src/config.ts). GSD's pi descriptor declared an empty
configHome.env, so a user with that variable set had GSD installed where pi
never looks. Added the env name; the dot-home-nested resolver already handled
the override, so no resolver logic changed.

Also fixes expandTilde in the shared runtime-homes resolver, found while adding
that: it hardcoded os.homedir() and ignored the opts.home every caller threads,
so EVERY runtime's tilde-valued env override (claude, antigravity, windsurf, pi)
silently resolved against the real home. That is a correctness bug and a
test-escape hazard — a sandboxed test asserting on a tilde override reached the
developer's actual home directory. Now threaded through every branch; behavior
with no injected home is unchanged.

Adds the emitted-drift ack fragment for the 58 pi paths whose emitted location
moved with the rename. The provenance rules satisfy the totality gate; the
differential gate needs the ack because the hook sources are byte-unchanged —
only the installer's target directory moved. The two hook files this branch
genuinely edits stay attributed and are not double-acked.

Note on piConfig.configDir: it is read from pi's OWN installed package.json
(getPackageDir walks up from pi's __dirname), alongside piConfig.name — a
white-label setting for a redistributed pi fork, not a per-project user setting.
Documented accordingly rather than treated as an unsupported override.

Verified on the remote runner.

* fix(#3023): reject blank env overrides, pin adapter/descriptor parity

Three review findings, all fixed.

A whitespace-only config-dir override was accepted verbatim: the guard was
`if (val)`, falsy only for the empty string, so PI_CODING_AGENT_DIR='   '
resolved to a literal three-space directory name instead of falling back to the
descriptor default. Fixed across every env-consuming branch — dot-home,
dot-home-nested, all three xdg steps, and generic-agents-root — not just pi's.
Non-blank values are still never trimmed, so '~/My Agent Dir' keeps working.

pi/gsd.cjs's probe list and the descriptor were two independent sources of truth
for the bundle directory name; a future rename would have desynced them silently
and left every pi hook quiet with no error. The probe list stays deliberate — it
must resolve in a dev checkout and a half-upgraded tree, where the registry's
answer would be wrong — so this adds the parity assertion the repo's
generative-fix-divergence rule calls for: the descriptor value must be the FIRST
candidate, and the default must remain present.

Changeset body rewritten to cover the two later user-facing fixes it had not
caught up with.

Verified on the remote runner.

* chore(#3023): backfill changeset PR number

* fix(#3023): anchor injection-scan patterns and fix a macOS detection hole

CI's security job flagged CONTEXT.md:124 — pre-existing prose reading 'not the
same fact as a genuinely empty or absent one'. The match was the 'act as a'
INSIDE 'f-act as a': the pattern had no left word boundary, so any word ending
in act tripped it (fact, impact, contract, artifact, interact, redact,
abstract). My four-line CONTEXT.md edit dragged the latent false positive into
this PR because the scan is diff-scoped by file but reads whole files. Anchored
with (^|[^[:alnum:]]) rather than rewording maintainer-owned prose, which would
have left the class alive for the next PR touching any file saying 'fact as a'.

Auditing the rest of the list for the same class surfaced a real detection hole:
the eval/exec/Function patterns matched a quote via \x27, a GNU-grep-only hex
escape. BSD/macOS grep reads it as four literal characters, so single-quoted
eval('...')/exec('...') payloads were NEVER detected there while passing on
GNU-grep CI. Replaced with a literal apostrophe class.

Boundaries were added only where a real word-suffix collision exists; exec,
jailbreak, developer mode and the role-manipulation family were audited and
deliberately left unanchored. 22 new cases cover both directions — the false
positives now scan clean, and every real payload still fires, including the
quote/punctuation/start-of-line boundary forms.

Also builds this branch's injection test fixture at runtime instead of carrying
the literal phrase, so the payload keeps its teeth without tripping the scan.

Verified on the remote runner.

---------

Co-authored-by: sim <sim@local>
This commit is contained in:
Tom Boucher
2026-08-07 13:41:21 -04:00
committed by GitHub
parent 86f72a57c3
commit 27aa40f65e
38 changed files with 3397 additions and 525 deletions

View File

@@ -1685,6 +1685,14 @@ test('shipped installer-migration checksums are locked to a committed baseline (
// Migration 008: retire Cursor's duplicate commands/ surface (#2644).
'2026-07-29-cursor-retire-commands-surface':
'sha256:d0b2b812a3f752650f2518b48280f74a5937c80ec8412bac493382dfa3db083f',
// Migration 009 (NEW, added here per this test's own sanctioned "adding a new
// migration" case — not a shipped-body edit): retire pi's reserved hooks/
// directory now that the shared hook bundle installs at gsd-hooks/ instead
// (#3023). pi warns on hooks/'s mere existence regardless of contents, so an
// upgraded install must have both the legacy files AND the emptied directory
// itself retired via the new remove-empty-dir action.
'2026-08-07-pi-retire-reserved-hooks-dir':
'sha256:34264415b00e15e5a1691eae3db9bd24dca11e5c04d78358420a7a8adf115f9e',
};
const { DEFAULT_MIGRATIONS_DIR, migrationChecksum: computeChecksum } = require('../gsd-core/bin/lib/installer-migrations.cjs');
@@ -1797,6 +1805,186 @@ test('reconciles a drifted applied-migration checksum into install state on appl
});
// ---------------------------------------------------------------------------
// remove-empty-dir action type (introduced with migration 009, #3023)
//
// Deliberately WEAKER than a recursive removal primitive: fs.rmdirSync only,
// never fs.rmSync / {recursive:true} / {force:true}. A non-empty directory is
// left in place as a successful no-op, not an error.
// ---------------------------------------------------------------------------
{
const { test, mock } = require('node:test');
const assert = require('node:assert/strict');
const fs = require('node:fs');
const path = require('node:path');
const {
applyInstallerMigrationPlan,
evaluateRemoveEmptyDir,
} = require('../gsd-core/bin/lib/installer-migrations.cjs');
const { cleanup, createTempDir } = require('./helpers.cjs');
test('evaluateRemoveEmptyDir removes a genuinely empty directory', (t) => {
const configDir = createTempDir('gsd-remove-empty-dir-');
t.after(() => cleanup(configDir));
const target = path.join(configDir, 'hooks');
fs.mkdirSync(target);
assert.equal(evaluateRemoveEmptyDir(configDir, target), 'removed');
assert.equal(fs.existsSync(target), false);
});
test('evaluateRemoveEmptyDir leaves a non-empty directory in place (planned-but-skipped, not an error)', (t) => {
const configDir = createTempDir('gsd-remove-empty-dir-');
t.after(() => cleanup(configDir));
const target = path.join(configDir, 'hooks');
fs.mkdirSync(target);
fs.writeFileSync(path.join(target, 'still-here.js'), '// user file\n', 'utf8');
assert.equal(evaluateRemoveEmptyDir(configDir, target), 'skipped-not-empty');
assert.equal(fs.existsSync(target), true);
assert.equal(fs.existsSync(path.join(target, 'still-here.js')), true);
});
test('evaluateRemoveEmptyDir refuses a symlinked directory (never follows it)', (t) => {
const configDir = createTempDir('gsd-remove-empty-dir-');
t.after(() => cleanup(configDir));
const realElsewhere = createTempDir('gsd-remove-empty-dir-elsewhere-');
t.after(() => cleanup(realElsewhere));
const linkPath = path.join(configDir, 'hooks');
fs.symlinkSync(realElsewhere, linkPath, 'dir');
assert.equal(evaluateRemoveEmptyDir(configDir, linkPath), 'left-in-place');
assert.equal(fs.lstatSync(linkPath).isSymbolicLink(), true, 'the symlink itself must survive untouched');
assert.equal(fs.existsSync(realElsewhere), true, 'the real target directory must never be removed through the link');
});
test('evaluateRemoveEmptyDir refuses a target outside configDir', (t) => {
const configDir = createTempDir('gsd-remove-empty-dir-');
t.after(() => cleanup(configDir));
const outside = createTempDir('gsd-remove-empty-dir-outside-');
t.after(() => cleanup(outside));
assert.equal(evaluateRemoveEmptyDir(configDir, outside), 'left-in-place');
assert.equal(fs.existsSync(outside), true);
});
test('evaluateRemoveEmptyDir refuses to remove configDir itself', (t) => {
const configDir = createTempDir('gsd-remove-empty-dir-');
t.after(() => cleanup(configDir));
assert.equal(evaluateRemoveEmptyDir(configDir, configDir), 'left-in-place');
assert.equal(fs.existsSync(configDir), true);
});
test('evaluateRemoveEmptyDir treats an already-absent directory as a clean no-op', (t) => {
const configDir = createTempDir('gsd-remove-empty-dir-');
t.after(() => cleanup(configDir));
const target = path.join(configDir, 'hooks');
assert.equal(fs.existsSync(target), false);
let outcome;
assert.doesNotThrow(() => { outcome = evaluateRemoveEmptyDir(configDir, target); });
assert.equal(outcome, 'missing');
});
test('evaluateRemoveEmptyDir degrades an EACCES from rmdirSync without throwing', (t) => {
const configDir = createTempDir('gsd-remove-empty-dir-');
const target = path.join(configDir, 'hooks');
fs.mkdirSync(target);
mock.method(fs, 'rmdirSync', () => {
const err = new Error('EACCES: permission denied');
err.code = 'EACCES';
throw err;
});
// Registered BEFORE the cleanup hook below — node:test runs `t.after`
// callbacks in REGISTRATION order, so this guarantees fs.rmdirSync is
// restored before cleanup() ever runs. That ordering is load-bearing on
// Node 22 (not Node 24): Node 22's recursive `fs.rmSync` still falls
// through to the JS rimraf implementation (internal/fs/rimraf.js), which
// calls the PUBLIC `fs.rmdirSync` this test mocks; Node 24's native
// recursive-rm implementation never touches it. With cleanup's `t.after`
// registered FIRST (as it was), cleanup() ran while the mock was still
// active on Node 22 — `fs.rmSync` threw the injected EACCES, that
// exception aborted the test's remaining `after` hooks before
// `mock.restoreAll()` could run, and the still-mocked `fs.rmdirSync` then
// poisoned `cleanup()` for every later test in this file for the rest of
// the Node 22 process (the node22-only "failed running afterEach/after
// hook" cascade across the Codex/migration-008/T3 tests below). Verified
// by reproducing both orderings against `node:22` and `node:24` directly.
t.after(() => mock.restoreAll());
t.after(() => cleanup(configDir));
let outcome;
assert.doesNotThrow(() => { outcome = evaluateRemoveEmptyDir(configDir, target); });
assert.equal(outcome, 'left-in-place');
assert.equal(fs.existsSync(target), true, 'directory must survive a failed rmdirSync');
});
test('applyInstallerMigrationPlan wires remove-empty-dir through to journal + disk removal', (t) => {
const configDir = createTempDir('gsd-remove-empty-dir-apply-');
t.after(() => cleanup(configDir));
const target = path.join(configDir, 'hooks');
fs.mkdirSync(target);
const result = applyInstallerMigrationPlan({
configDir,
plan: {
blocked: [],
actions: [{
migrationId: '2026-08-07-pi-retire-reserved-hooks-dir',
migrationChecksum: 'sha256:test',
type: 'remove-empty-dir',
relPath: 'hooks',
reason: 'retired reserved directory',
classification: 'managed-pristine',
originalHash: null,
currentHash: null,
}],
},
now: () => '2026-08-07T00:00:00.000Z',
});
assert.equal(fs.existsSync(target), false);
const journal = JSON.parse(fs.readFileSync(path.join(configDir, result.journalRelPath), 'utf8'));
assert.equal(journal.actions.length, 1);
assert.equal(journal.actions[0].status, 'removed');
assert.equal(journal.actions[0].type, 'remove-empty-dir');
});
test('applyInstallerMigrationPlan leaves a non-empty remove-empty-dir target on disk and journals it', (t) => {
const configDir = createTempDir('gsd-remove-empty-dir-apply-');
t.after(() => cleanup(configDir));
const target = path.join(configDir, 'hooks');
fs.mkdirSync(target);
fs.writeFileSync(path.join(target, 'user-file.js'), '// preserved\n', 'utf8');
const result = applyInstallerMigrationPlan({
configDir,
plan: {
blocked: [],
actions: [{
migrationId: '2026-08-07-pi-retire-reserved-hooks-dir',
migrationChecksum: 'sha256:test',
type: 'remove-empty-dir',
relPath: 'hooks',
reason: 'retired reserved directory',
classification: 'managed-pristine',
originalHash: null,
currentHash: null,
}],
},
now: () => '2026-08-07T00:00:01.000Z',
});
assert.equal(fs.existsSync(target), true);
assert.equal(fs.existsSync(path.join(target, 'user-file.js')), true);
const journal = JSON.parse(fs.readFileSync(path.join(configDir, result.journalRelPath), 'utf8'));
assert.equal(journal.actions[0].status, 'skipped-not-empty');
});
}
// ---------------------------------------------------------------------------
// Cursor duplicate commands-surface retirement (#2644)
// ---------------------------------------------------------------------------