mirror of
https://github.com/garrytan/gstack.git
synced 2026-09-16 18:05:31 +02:00
feat(hooks): Stop hook closes dangling timeline entries — fail-open
The preamble writes event:'started' to the project timeline at every skill start, but the matching 'completed' write lives in prose at the END of the skill workflow — unenforceable. An interrupted session, a context blowout, or an agent that simply stops leaked started > completed forever, and the leak was unrepairable after the fact (observed live in #2553). New hosts/claude/hooks/timeline-stop-hook (+ .ts, question-log-hook shim pattern): on Claude Code's Stop event it appends event:'completed' with outcome 'unknown' and source 'stop-hook' for every 'started' entry in the project timeline that has no matching completion. setup registers it via gstack-settings-hook add-event (Stop was already an accepted event) under its own source tag, idempotently; --no-team and gstack-uninstall remove it. FAIL-OPEN contract (F5), pinned by tests: ALWAYS exits 0 — corrupt timeline (bad lines skipped individually, valid ones still repaired), missing timeline, garbage/empty stdin, bun missing from PATH (the shim '|| true's), and an over-cap timeline (10MB skip) all repair nothing and block nothing; errors land in ~/.gstack/hook-errors.log best-effort. The write path is append-only with a ~2s internal budget, and a second Stop is a no-op (already-closed entries never re-close). Correlation is project-scoped by design — the preamble's session id is shell-local, so a concurrent same-project session's entry may close early as a traceable source:'stop-hook' row rather than a silent leak; the header documents the trade-off. Fixes #2553 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
co-authored by
Claude Fable 5
parent
9c0de5fed1
commit
4d0e7b7c2a
Executable
+10
@@ -0,0 +1,10 @@
|
||||
#!/usr/bin/env bash
|
||||
# Bash shim — Claude Code hooks run `command` strings via /bin/sh, so this
|
||||
# wrapper makes the TypeScript hook executable via bun. Settings.json
|
||||
# references this file directly.
|
||||
#
|
||||
# FAIL-OPEN (F5): a Stop-event telemetry repair must never block the session.
|
||||
# Every failure path — bun missing, script crash — still exits 0.
|
||||
HERE="$(cd "$(dirname "$0")" && pwd)" || exit 0
|
||||
bun "$HERE/timeline-stop-hook.ts" || true
|
||||
exit 0
|
||||
Executable
+162
@@ -0,0 +1,162 @@
|
||||
#!/usr/bin/env bun
|
||||
/**
|
||||
* Stop hook: close dangling "started" timeline entries (#2553).
|
||||
*
|
||||
* The preamble writes {"skill":X,"event":"started",...} at every skill start;
|
||||
* the completion write lives in prose at the END of the skill workflow and is
|
||||
* unenforceable — an interrupted session, a context blowout, or an agent that
|
||||
* simply stops leaves started > completed forever, and the leak is
|
||||
* unrepairable after the fact. This hook runs on Claude Code's Stop event and
|
||||
* appends event:"completed" (outcome "unknown", source "stop-hook") for every
|
||||
* "started" entry in the project's timeline that has no matching "completed".
|
||||
*
|
||||
* FAIL-OPEN CONTRACT (F5) — a telemetry repair must never block a session:
|
||||
* - ALWAYS exits 0, whatever happens (corrupt timeline, missing file, bad
|
||||
* stdin, unreadable slug). Errors go to ~/.gstack/hook-errors.log,
|
||||
* best-effort.
|
||||
* - Internal time budget (~2s): work is bounded up front — the timeline is
|
||||
* skipped entirely over a size cap, and the deadline is re-checked before
|
||||
* the write. Claude Code's own hook timeout is the outer belt.
|
||||
* - Append-only: never rewrites timeline.jsonl.
|
||||
*
|
||||
* Correlation limits, on purpose: the preamble's session id is a shell-local
|
||||
* "$$-epoch", not the Claude session id this hook receives, so entries can't
|
||||
* be attributed to THIS session specifically. Closing every dangling entry in
|
||||
* the project is the repair semantics #2553 asks for; a concurrent session
|
||||
* mid-skill in the same project may get its entry closed early, which shows
|
||||
* up as a traceable source:"stop-hook" completion rather than a silent leak.
|
||||
*/
|
||||
import * as fs from 'fs';
|
||||
import * as os from 'os';
|
||||
import * as path from 'path';
|
||||
import { runBin } from './spawn-bin';
|
||||
|
||||
const DEADLINE_MS = 2000;
|
||||
const MAX_TIMELINE_BYTES = 10 * 1024 * 1024;
|
||||
const startedAt = Date.now();
|
||||
|
||||
function stateRoot(): string {
|
||||
return process.env.GSTACK_HOME || path.join(os.homedir(), '.gstack');
|
||||
}
|
||||
|
||||
function logHookError(msg: string): void {
|
||||
try {
|
||||
const root = stateRoot();
|
||||
fs.mkdirSync(root, { recursive: true });
|
||||
fs.appendFileSync(
|
||||
path.join(root, 'hook-errors.log'),
|
||||
`${new Date().toISOString()} timeline-stop-hook: ${msg}\n`,
|
||||
);
|
||||
} catch {
|
||||
// best-effort; never block the session because logging failed
|
||||
}
|
||||
}
|
||||
|
||||
interface TimelineEntry {
|
||||
skill?: string;
|
||||
event?: string;
|
||||
session?: string;
|
||||
branch?: string;
|
||||
ts?: string;
|
||||
}
|
||||
|
||||
function main(): void {
|
||||
let cwd = process.cwd();
|
||||
try {
|
||||
const stdin = fs.readFileSync(0, 'utf8');
|
||||
if (stdin.trim()) {
|
||||
const payload = JSON.parse(stdin) as { cwd?: string };
|
||||
if (payload.cwd && fs.existsSync(payload.cwd)) cwd = payload.cwd;
|
||||
}
|
||||
} catch {
|
||||
// Bad/absent stdin: fall through with process.cwd() — repair is still valid.
|
||||
}
|
||||
|
||||
// Resolve the project slug the same way the preamble did (GSTACK_PROJECT_SLUG
|
||||
// override, project-root walk, remote-derived slug).
|
||||
let slug = '';
|
||||
try {
|
||||
const r = runBin('gstack-slug', [], { cwd, encoding: 'utf8', timeout: DEADLINE_MS });
|
||||
const m = (r.stdout ?? '').toString().match(/^SLUG=([A-Za-z0-9._-]+)$/m);
|
||||
if (m) slug = m[1];
|
||||
} catch {
|
||||
// fall through
|
||||
}
|
||||
if (!slug) {
|
||||
logHookError('could not resolve project slug — nothing repaired');
|
||||
return;
|
||||
}
|
||||
|
||||
const timelinePath = path.join(stateRoot(), 'projects', slug, 'timeline.jsonl');
|
||||
let stat: fs.Stats;
|
||||
try {
|
||||
stat = fs.statSync(timelinePath);
|
||||
} catch {
|
||||
return; // no timeline — nothing to repair
|
||||
}
|
||||
if (stat.size === 0) return;
|
||||
if (stat.size > MAX_TIMELINE_BYTES) {
|
||||
logHookError(`timeline over size cap (${stat.size} bytes) — skipped (fail-open)`);
|
||||
return;
|
||||
}
|
||||
|
||||
let raw: string;
|
||||
try {
|
||||
raw = fs.readFileSync(timelinePath, 'utf8');
|
||||
} catch (err) {
|
||||
logHookError(`could not read timeline: ${err instanceof Error ? err.message : String(err)}`);
|
||||
return;
|
||||
}
|
||||
|
||||
// Corrupt LINES are skipped individually; a fully corrupt file repairs nothing.
|
||||
const started = new Map<string, TimelineEntry>();
|
||||
const completed = new Set<string>();
|
||||
for (const line of raw.split('\n')) {
|
||||
if (!line.trim()) continue;
|
||||
let entry: TimelineEntry;
|
||||
try {
|
||||
entry = JSON.parse(line) as TimelineEntry;
|
||||
} catch {
|
||||
continue;
|
||||
}
|
||||
if (!entry || typeof entry.skill !== 'string') continue;
|
||||
const key = `${entry.skill}\u0000${entry.session ?? ''}`;
|
||||
if (entry.event === 'started' && !started.has(key)) started.set(key, entry);
|
||||
if (entry.event === 'completed') completed.add(key);
|
||||
}
|
||||
|
||||
const dangling = [...started.entries()].filter(([key]) => !completed.has(key));
|
||||
if (dangling.length === 0) return;
|
||||
|
||||
if (Date.now() - startedAt > DEADLINE_MS) {
|
||||
logHookError('internal 2s budget exhausted before write — skipped (fail-open)');
|
||||
return;
|
||||
}
|
||||
|
||||
const now = new Date().toISOString();
|
||||
const lines = dangling
|
||||
.map(([, entry]) =>
|
||||
JSON.stringify({
|
||||
skill: entry.skill,
|
||||
event: 'completed',
|
||||
...(entry.branch ? { branch: entry.branch } : {}),
|
||||
outcome: 'unknown',
|
||||
source: 'stop-hook',
|
||||
...(entry.session ? { session: entry.session } : {}),
|
||||
ts: now,
|
||||
}),
|
||||
)
|
||||
.join('\n');
|
||||
try {
|
||||
fs.appendFileSync(timelinePath, lines + '\n');
|
||||
} catch (err) {
|
||||
logHookError(`could not append completions: ${err instanceof Error ? err.message : String(err)}`);
|
||||
}
|
||||
}
|
||||
|
||||
try {
|
||||
main();
|
||||
} catch (err) {
|
||||
logHookError(`unexpected: ${err instanceof Error ? (err.stack ?? err.message) : String(err)}`);
|
||||
}
|
||||
process.exit(0);
|
||||
Reference in New Issue
Block a user