* enhance(#3911): give hooks an exit seam that needs no build ADR-3889 Phase 7 foundation. The 19 shipped enforcement hooks hold 91 of the epic's 128 terminators and cannot reach `terminateNow` today. The obvious route — requiring `gsd-core/bin/lib/cli-exit.cjs`, as gsd-agent-isolation-guard.js already does for two other modules — is rejected. That precedent carries its own warning (#3582): those files are tsc output, gitignored and absent on a raw plugin-marketplace or git-clone install, so the hook must first call ensureRuntimeBuild() to self-heal. Making the module a hook needs IN ORDER TO TERMINATE depend on a build inverts the dependency, and its failure mode is precisely the fail-open this phase exists to remove: a guard that cannot terminate cannot deny. `lint-hooks-runtime-build-seam` already encodes that concern, and Design B would have had to add an ensureRuntimeBuild() call to all 19 hooks to satisfy it. So `hooks/lib/` becomes a third emit location for cli-exit and a fifth for the registry, preserving the invariant `src/cli-exit.cts`'s own header states: it imports nothing but node:fs and its sibling registry, and the generator dual-emits that sibling alongside each copy so a relative require resolves next to whichever copy loaded it. Shipping needed no change — build-hooks.js already declares HOOKS_SUBDIRS_TO_COPY = ['lib']. Proven, not asserted: the two files are copied into an otherwise-empty tmpdir and a child process requires them and terminates — PASS exits 0, HOOK_DENY exits 2 with the payload on both stdout and stderr. That test fails the moment the hooks copy gains a require reaching outside hooks/lib/. Also fixed inline: the registry's fifth target let any `--write` test overwrite the real committed hooks/lib/exit-code-registry.js, because the test helper derived only three of the other output paths. It now redirects all five, and a regression test asserts every committed artifact is byte-identical after a redirected write. Install-tree goldens pick up the two new shipped paths across 11 runtimes — insertions only, no removals. lint:ci was green while they were stale, so this was found by regenerating rather than by a gate. Verification runs on the remote runner. Refs #3911 * enhance(#3911): declare a crash policy, and migrate the write guard Adds `hooks/lib/hook-exit.js` — the hook-facing vocabulary over `terminateNow`, hand-written because the cli-exit copy beside it is generated: allow(payload) exit 0 deny(payload, stderr?) exit 2 crash(onCrash, payload) whichever the hook DECLARED `crash()` takes the policy as a required argument with no default, which is the whole mechanism: fail-open by accident stops being expressible. A hook must name ALLOW or DENY at the call site, and an unrecognized value terminates INTERNAL rather than guessing. Fail-open stays legal; fail-open by omission does not. `gsd-write-guard.js` is the first hook migrated, all 12 sites, and it exposed a gap in the seam. `terminateNow`'s doc comment justified its fd-2 write by citing this hook's `emitBlock` — but modeled it as sending the same bytes to both streams, when `emitBlock` actually sends full JSON to stdout and only the bare `reason` string to stderr, because Kimi's hook bus feeds stderr verbatim back to the model. Migrating as written would have turned a readable sentence into a JSON blob for Kimi-backed agents. #3911 requires both "all 19 hooks terminate through terminateNow" and "no hook's effective default changes". Those are jointly satisfiable only by teaching the seam to carry a distinct stderr payload, so `terminateNow` gains an optional third argument: omitted, behavior is byte-for-byte what it was; a string is written raw, which is exactly the Kimi case. The doc comment's inaccurate claim about emitBlock is corrected in place. Proven rather than asserted: the pre-migration file is reconstructed from HEAD and driven with the same catastrophic-shrink payload as the migrated one — exit code, stdout and stderr all byte-identical. Verification runs on the remote runner. Refs #3911 * enhance(#3911): all 19 hooks terminate through the seam Migrates the remaining 18 enforcement hooks onto allow/deny/crash. An AST walk now reports zero `process.exit(` call sites across every `hooks/*.js` — down from the 91 the census measured. Each hook with an outer catch declares its policy once, at module top, with the reason that policy is right for that specific guard: a read guard that cannot scan must not block the read; a statusline that renders every prompt must degrade rather than crash; an injection scanner must not retroactively block a result already returned. Those sentences are the deliverable — they are what turns fail-open-by-accident into fail-open-on-purpose. No hook's effective default changed. Wiring exposed two defects, both fixed here rather than noted. A SECOND stdout/stderr-splitting site turned up in `gsd-workflow-guard.js`'s `emitForceAddBlock`, matching the pattern already known from the write guard — full JSON to stdout, bare reason to stderr for the Kimi bus. It uses the `stderrPayload` argument added in the previous commit, which is now carrying its second real caller rather than one special case. More seriously, `terminateNow` emitted both streams inside ONE try, so a payload that failed to serialize aborted before the stderr write ever ran. The two windsurf guards write nothing to stdout on a block and only a reason string to stderr, so `deny(undefined, reason)` exited 2 with EMPTY stderr — a deny that silently loses its reason, which is the exact "fails with success" class this epic exists to close. The streams are now emitted independently, each with its own guard, and `undefined` means "nothing to write for this stream" rather than an error. Regression tests inject a throwing write on one fd and assert the other still receives its payload; they fail against the single-try version. Byte-identity was proven per hook, not assumed: each pre-change file is reconstructed from HEAD and driven side by side with the migrated one across its normal path, its deny path, malformed stdin and empty stdin — exit code, stdout and stderr compared. Verification runs on the remote runner. Refs #3911 * enhance(#3911): harden the three shell hooks, and pin every hook's policy `gsd-phase-boundary.sh`, `gsd-session-state.sh` and `gsd-validate-commit.sh` gain `set -euo pipefail`. The expected hazard did not materialize, and that is worth recording: every intentionally-non-zero command in all three is already the condition of an `if`/`elif`, which `set -e` never fires on, and none of them reads a possibly-unset variable or pipes through a grep that may legitimately match nothing. No `|| true` guards were needed. Each hook was still checked command-by-command before the flags went in rather than after. Twenty-one before/after cases across the three hooks — disabled and enabled, planning and non-planning, missing STATE.md, malformed JSON, the Kimi payload shape, quoted and unquoted `-m`, valid and over-long Conventional Commits — all match on exit code, stdout and stderr. The hardening is shown to actually fire, not merely added: with a stubbed `node` that fails at the JSON-emit step, phase-boundary and session-state go from silently exiting 0 with empty stdout to failing visibly with the error surfaced. No such case could be constructed for `gsd-validate-commit.sh`, whose every statement already sits inside an if-condition — recorded as unproven rather than claimed. `tests/hooks-crash-policy.test.cjs` adds the per-hook coverage the issue asks for, table-driven over all 19 hooks rather than 76 hand-written cases: normal allow, deny where a deny path exists, crash-honors-the-declared-policy, and an unclosed-stdin case — the one `process.exitCode` structurally cannot serve. The deny assertions encode each hook's ACTUAL stream split rather than a uniform shape, since four of the six deliberately differ. A drift guard enumerates `hooks/*.js` and fails if a terminating hook is ever added without a row. Writing those tests surfaced two hooks that emit a block decision in their JSON body and exit 0. Both were checked rather than assumed, and neither is a fails-with-success: `gsd-read-injection-scanner.js` is PostToolUse, where the tool has already run and exit 2 has no meaning, and `gsd-cursor-subagent-start.js` follows Cursor's JSON-body protocol. They are deliberately left alone — a mechanical sweep to `deny()` would have broken exactly these two. Verification runs on the remote runner. Refs #3911 * fix(#3838): the commit validator says when it could not validate #3911 claims to subsume #3838. Measurement said otherwise, so this closes it for real rather than by assertion. `set -euo pipefail`, added earlier on this branch, does NOT fix #3838: bash exempts a command used as an `if` condition from `set -e`, and all three of the hook's swallow-and-pass sites are exactly that shape. Verified against the hardened hook with a node shim that fails only the classifier call — a non-conforming commit still exited 0 with empty stdout AND empty stderr, indistinguishable from "your commit conforms". That is the defect verbatim. All three sites named in #3838 now capture the real exit status instead of consuming it as a condition, and each distinguishes its genuine negative from "could not run": - the classifier: 0 = is a git commit, 1 = genuinely not one, anything else = could not classify. Its `node -e` now wraps the require and the call in try/catch and exits 3 on a throw, so a broken require chain can never be mistaken for `isGitSubcommand` legitimately returning false — which is the arm that matters, since `token-scanner.cjs` is a gitignored build artifact and a fresh checkout lands there. - the opt-in config read and the JSON command extraction get the same treatment. On "could not run" the hook emits a diagnostic to stderr naming which check failed and why, then exits 0. The issue confirms this is safe — it is a PreToolUse hook, so stderr does not disturb the JSON protocol — and ranks it the smallest sufficient fix. The gate still fails open, but it can no longer do so silently, which is the whole complaint: a validator that disables itself quietly costs more than one that is absent, because it is trusted. Both controls are unchanged and pinned by tests: a conforming commit still passes silently, a non-conforming one still exits 2 with its existing block payload. The defect test asserts stderr is non-empty and names the failure; it fails against the pre-fix hook. Verification runs on the remote runner. Refs #3911, #3838 * docs(#3911): document the hook crash-policy contract Reference and Explanation via a new docs/features fragment (FEATURES.md is generated from it), INVENTORY rows for the three new hooks/lib files, and an ARCHITECTURE note on the hooks section. How-To: docs/how-to/declare-a-hook-crash-policy.md, indexed from docs/README.md — a hook author now has to choose and declare a crash policy, which is more than one step and crosses into which harness protocol their hook speaks. It covers allow/deny/crash, writing an ON_CRASH reason that is actually useful, when a deny needs a distinct stderr payload, the two hooks whose harness reads a JSON-body decision and must NOT use deny(), and what to do when a check cannot run at all — with #3838 as the worked example. Refs #3911 * test(#3911): prove the seam actually ships, and stop hand-rolling temp cleanup Two review findings. The acceptance criterion 'hooks/dist/** stays in parity via the build seam (lint:hooks-runtime-build-seam)' was misstated and unmet: that lint checks something else — that a hook requiring a compiled gsd-core/bin/lib module also calls ensureRuntimeBuild(). Nothing exercised that the three new hooks/lib files reach hooks/dist/lib at all. That gap is not theoretical: #770 is a recorded ship-blocking bug where a new hook never shipped because a copy list missed it. The suite now builds dist through the repo's own ensureBuiltHooks(), byte-compares each shipped copy against its source, and spawns a child that requires the SHIPPED dist copy and denies — which is what catches a copy that exists but cannot resolve its sibling registry. gsd-validate-commit.sh hand-duplicated mktemp/run/rm three times; one idempotent trap on EXIT replaces them, guarded so cleanup cannot alter the exit status. Behavior-neutral across five cases, with temp-file counts taken before and after each run. Refs #3911 * fix(#3911): stage transitive hook lib requires, not just one level The remote run returned 7 failures across 3 real causes. The important one is a PRODUCTION bug this phase exposed rather than caused. `writeCursorHooksJson` scanned each hook script for `./lib/X` requires exactly one level deep and never re-scanned the lib files it staged for their own sibling requires. Nothing had a transitive lib dependency before, so the gap was invisible. Adding hook-exit.js -> cli-exit.js -> exit-code-registry.js made real Cursor installs ship a bundle that dies at require time with MODULE_NOT_FOUND. It now walks to a fixed point, and a real installed Cursor hook runs to completion. The staging harness in shared-hooks-dir-resolution hand-copied its fixture, so the injection scanner crashed at require time and its exit-1 was being read as a policy decision. Migrated to copyScriptWithDeps, which walks the require graph — the repo's recorded rule for this class, since adding another copyFileSync keeps it alive for the next person. The missing-lib-source test in cursor-hook-workspace-roots hardcoded which lib file it expected to be named in the abort message; the same throw now fires for a different file first. Its assertion is unchanged in substance — staging still must abort rather than ship a broken hook — only the name is no longer pinned. The last one was my own test asserting an uppercase reason code. Measured against origin/next: the pre-change hook emits the same lowercase 'config_unreadable', so the test was wrong, not the migration. Corrected to the real value rather than making the code match the test. Verification runs on the remote runner. Refs #3911 * chore(#3911): regenerate the cursor install-tree golden The staging fix means a Cursor install now correctly carries the two transitive lib files it was silently missing. Additive only — no path was removed. The golden diff is the evidence the packaging defect was real. Refs #3911 * chore(#3911): backfill the changeset PR number Refs #3911 * fix(#3911): a git probe that timed out is not a negative A macOS CI lane failed three deny cases at 2084ms, 2112ms and 2177ms — just past the 2000ms budget these hooks give their git probes. The three that passed took 72ms, 595ms and 651ms. Under shard contention `git rev-parse` overruns, the hook reads the non-zero result as "not a git repo", and allows with exit 0 and empty stdout AND empty stderr. Under load, the guards silently stop guarding. That is ADR-3889's thesis exactly, sitting inside the security hooks this phase is about. The repo had already recognized the class in one place — gsd-cursor-subagent-start.js fail-closed-denies on `git_timed_out` (#3045) — but nowhere else. `hooks/lib/git-probe.js` classifies a probe's outcome, distinguishing a real non-zero exit from ETIMEDOUT, a signal kill, and a spawn failure, rather than folding all four into `status !== 0`. Three guards route their eight git probes through it. The resolution is the same shape #3838 took, and the same one that issue endorsed as smallest-sufficient: fail open, but loudly. **No exit code changes on any path** — a developer on a loaded machine is still not blocked, which keeps #3911's declaration-pass contract intact for exit codes. What changes is that the hook now says on stderr which probe could not answer, instead of presenting silence as a clean verdict. Scope was checked across every hooks/*.js, not just the three that failed: gsd-agent-isolation-guard spawns no git; gsd-statusline's two probes gate only a cosmetic display segment, not an allow/deny decision, and are left alone. The C2 deny assertion was a real-race test — it demanded exit 2 while a slow git legitimately yields 0. It now requires the hook to either deny, or allow with a diagnostic naming the probe that could not run; a silent allow still fails, so the assertion is not vacuous. A deterministic regression stubs git on PATH to sleep past the budget rather than waiting for load to reproduce it. Verification runs on the remote runner. Refs #3911 * test(#3911): a PATH shim cannot intercept the hooks' git spawn on Windows The deterministic timeout regression stubbed git on PATH and asserted the guard reports rather than silently allows. It passes on Linux and macOS and failed on Windows in 83ms and 176ms — the stub was never invoked at all. Mechanism: the hooks call spawnSync('git', args) with no shell:true, so on Windows CreateProcess resolves git.exe only and never a PATH .cmd shim. The git.cmd branch could not have worked and is removed rather than left implying a Windows path that does. Adding shell:true to the hooks to serve a test would change product behavior and widen an injection surface, so the case is skipped on win32 only, with the mechanism written into the skip reason so a future reader does not 'fix' it that way. Linux and macOS keep the coverage, and macOS is where the underlying fail-open was actually caught. Refs #3911 --------- Co-authored-by: sim <sim@local>
This commit is contained in:
173
docs/how-to/declare-a-hook-crash-policy.md
Normal file
173
docs/how-to/declare-a-hook-crash-policy.md
Normal file
@@ -0,0 +1,173 @@
|
||||
# Declare a hook's crash policy
|
||||
|
||||
A GSD enforcement hook (`hooks/*.js`, `hooks/*.sh`) ends every run by terminating
|
||||
the process — but "terminate" is not one decision, it is at least three: pass
|
||||
the tool call, block it, or explain what happens when the hook's *own* code
|
||||
breaks. Before ADR-3889 Phase 7 (#3911), each hook answered the third question
|
||||
with a bare `process.exit(0)` or `process.exit(2)` buried in an outer `catch`,
|
||||
so a reviewer had to read every hook's catch block to know its fail-open/
|
||||
fail-closed stance. `hooks/lib/hook-exit.js` names all three outcomes and makes
|
||||
the third one a declaration you write once, near the top of the file.
|
||||
|
||||
This page covers terminating a hook correctly, declaring and justifying
|
||||
`ON_CRASH`, the one case that needs a distinct stderr payload, the two hooks
|
||||
that must NOT use this vocabulary at all, and what to do when a check inside
|
||||
your hook cannot run rather than merely returning a negative.
|
||||
|
||||
## The three outcomes
|
||||
|
||||
```js
|
||||
const { HOOK_ON_CRASH, allow, deny, crash } = require('./lib/hook-exit.js');
|
||||
```
|
||||
|
||||
- **`allow(payload)`** — exit 0. The tool call proceeds. `payload` is optional;
|
||||
most no-op paths call `allow(undefined)`.
|
||||
- **`deny(payload, stderrPayload?)`** — exit 2, the Claude Code hook-protocol
|
||||
block code. `payload` is written to stdout; by default the same bytes go to
|
||||
stderr too. See "A deny needing a distinct stderr payload" below for when
|
||||
you pass `stderrPayload`.
|
||||
- **`crash(onCrash, payload)`** — dispatches to `allow`/`deny` per a policy
|
||||
YOU supply. There is no default: call `crash(ON_CRASH, payload)` from your
|
||||
outer catch, never a bare `crash(payload)`.
|
||||
|
||||
A real guard shape:
|
||||
|
||||
```js
|
||||
const ON_CRASH = HOOK_ON_CRASH.ALLOW; // declared once, near the top — see below
|
||||
|
||||
try {
|
||||
const data = JSON.parse(input);
|
||||
if (looksFine(data)) allow(undefined);
|
||||
emitBlock({ decision: 'block', reason: 'why this call is refused' });
|
||||
} catch {
|
||||
// Hook errors must never block a legitimate tool call.
|
||||
crash(ON_CRASH, undefined);
|
||||
}
|
||||
|
||||
function emitBlock(output) {
|
||||
deny(output, output.reason);
|
||||
}
|
||||
```
|
||||
|
||||
## Choosing and declaring `ON_CRASH`
|
||||
|
||||
`HOOK_ON_CRASH` has exactly two values, `ALLOW` and `DENY`. Ask: **if this
|
||||
hook's own code throws, is it safer for the tool call to proceed, or safer to
|
||||
block it?**
|
||||
|
||||
- **`ALLOW`** — the hook is advisory, or its enforcement is not the last line
|
||||
of defense. A crash here should not stop legitimate work. This is every
|
||||
migrated hook's policy today (19 of 19) — including the two hard-blocking
|
||||
guards (`gsd-write-guard.js`, `gsd-worktree-path-guard.js`): their threat
|
||||
model is a confused agent overwriting a file it can already reach by other
|
||||
means, not a determined adversary, so a hook bug is not treated as worse
|
||||
than the thing it protects against.
|
||||
- **`DENY`** — a crash inside a security-critical check is itself suspicious
|
||||
enough that refusing is the safer failure. Nothing in this repo declares
|
||||
`DENY` yet; if you are the first, that is a real decision, not a default —
|
||||
write the reason down (see below) and expect it to be scrutinized in
|
||||
review.
|
||||
|
||||
Declare it once, near your hook's imports, not inline at the call site:
|
||||
|
||||
```js
|
||||
// This guard's outer catch has always exited 0 (fail open — a hook error
|
||||
// must never block a legitimate tool call). Declared ONCE here so the outer
|
||||
// catch's crash() call states its policy explicitly rather than inheriting
|
||||
// a default (#3911).
|
||||
const ON_CRASH = HOOK_ON_CRASH.ALLOW;
|
||||
```
|
||||
|
||||
**A useful reason names the failure mode, not the mechanism.** "Fails open"
|
||||
restates what `ALLOW` already means. What the code cannot say is *why this
|
||||
hook, specifically*: what breaks if it fires wrongly (a legitimate call
|
||||
blocked) versus what breaks if it stays silent (a narrow threat model, a
|
||||
check that runs again downstream, an advisory that was never load-bearing).
|
||||
Write the trade-off, not the translation.
|
||||
|
||||
## A deny needing a distinct stderr payload
|
||||
|
||||
Most callers never pass `stderrPayload` — fd 2 gets the same bytes as fd 1,
|
||||
unchanged from before this migration. One shape needs it: `gsd-write-guard.js`
|
||||
guards a curated `.planning/` artifact, but Kimi's native hook bus reads
|
||||
**stderr verbatim back to the model** on exit 2. A full JSON object on stderr
|
||||
would show the model a data structure instead of a sentence, so this call
|
||||
site sends the complete decision to stdout and only the plain-text reason to
|
||||
stderr:
|
||||
|
||||
```js
|
||||
function emitBlock(output) {
|
||||
deny(output, output.reason);
|
||||
}
|
||||
```
|
||||
|
||||
`stderrPayload` is forwarded to `terminateNow` verbatim: a **string** is
|
||||
written raw (no `JSON.stringify`), anything else is JSON-stringified like the
|
||||
stdout payload. Reach for this only when a specific downstream reader needs
|
||||
plain text on stderr — most hooks have no such reader and should leave
|
||||
`stderrPayload` unset.
|
||||
|
||||
## The exception: two hooks that must NOT call `deny()`
|
||||
|
||||
`allow()`/`deny()`/`crash()` assume the host reads the **exit code** as the
|
||||
decision. Two shipped hooks have a different contract, where the decision
|
||||
lives in the **JSON response body** and the process still exits 0:
|
||||
|
||||
- **`gsd-read-injection-scanner.js`** (PostToolUse) — Claude Code's
|
||||
PostToolUse protocol reads `{ decision: "block", ... }` from stdout, not
|
||||
from the exit code; the tool call already completed by the time this hook
|
||||
runs, so there is no exit-code channel to block it through. It calls
|
||||
`process.stdout.write(JSON.stringify(output))` directly for its verdict,
|
||||
and uses `allow()`/`crash()` only for its true no-op and crash paths.
|
||||
- **`gsd-cursor-subagent-start.js`** (Cursor `subagentStart`) — Cursor's own
|
||||
hook protocol reads `{ permission: "deny", user_message, ... }` from the
|
||||
JSON body at exit 0; `"ask"` is not even a supported value, and there is no
|
||||
exit-2 convention here at all. Same split: `process.stdout.write(...)` for
|
||||
the decision, `allow()` only for its stdin-timeout no-op.
|
||||
|
||||
If you are writing a hook against a harness that reads its verdict from the
|
||||
response body, follow one of these two, not `deny()` — calling `deny()` there
|
||||
would exit 2 into a harness that is not listening on the exit code, turning a
|
||||
block into an unexplained crash.
|
||||
|
||||
## When a check cannot run at all
|
||||
|
||||
`crash()` covers your hook's own bugs. It does not cover the more common
|
||||
defect: a check inside a *working* hook that silently reads "could not run"
|
||||
as if it were "ran, found nothing" — passing every case it should have
|
||||
inspected. #3838 is the worked example: `gsd-validate-commit.sh` had three
|
||||
swallow-and-pass sites (the opt-in config read, JSON command extraction, and
|
||||
its `isGitSubcommand` classifier) where a failure and a genuine negative both
|
||||
fell through to the same `exit 0`, silently disabling commit validation on
|
||||
any of them. The fix distinguishes the two outcomes and says so on stderr
|
||||
before falling through:
|
||||
|
||||
```sh
|
||||
ENABLED=$(node -e "..." 2>"$ENABLED_ERR") || CONFIG_STATUS=$?
|
||||
CONFIG_STATUS=${CONFIG_STATUS:-0}
|
||||
if [ "$CONFIG_STATUS" != "0" ]; then
|
||||
# Could not determine the opt-in flag at all — distinct from
|
||||
# ".planning/config.json exists and legitimately disables the hook".
|
||||
echo "gsd-validate-commit.sh: could not read .planning/config.json (opt-in check) — validator disabled for this call. $(cat "$ENABLED_ERR")" >&2
|
||||
rm -f "$ENABLED_ERR"
|
||||
exit 0
|
||||
fi
|
||||
```
|
||||
|
||||
The exit code is unchanged (still 0, still a pass) — what changed is that the
|
||||
"could not run" case is no longer indistinguishable from a real negative: it
|
||||
is diagnosable on stderr instead of vanishing. Apply the same discipline
|
||||
inside your own hook: a `try { ... } catch { /* silently pass */ }` around a
|
||||
check is the shape to be suspicious of, whether or not it happens to route
|
||||
through `hook-exit.js` at all.
|
||||
|
||||
## Related
|
||||
|
||||
- [ADR-3889](../adr/3889-process-exit-contract.md) — the exit-code registry
|
||||
`hook-exit.js` is layered over, and the rationale for banding codes 0/1/2
|
||||
the way it does
|
||||
- [Hooks declare their crash policy](../features/hooks-declare-their-crash-policy.md) —
|
||||
the feature summary for this migration
|
||||
- [Resolve unreachable-guard findings](resolve-unreachable-guard-findings.md) —
|
||||
a sibling "the loop surfaced something, here is what to do with it" page,
|
||||
for the shell-guard-drift class rather than the exit-code class
|
||||
Reference in New Issue
Block a user