Tianyi Cui
774d460889
The audit swept every packages/*/* plugin for the new AGENTS.md
convention (no hardcoded tunables in plugins) and exposes each finding
as a defaulted, validated Config field. Defaults are the previously
hardcoded values throughout, so no deployment or golden changes.
- tool-fs (had NO Config): readLimit, readMaxLineLength, readMaxBytes,
readStreamMinSize. The caps thread through ReadToolCaps/ReadWindow —
read-render already documented that the consumer applies the caps, so
they become explicit per-request fields.
- tool-web: searchMaxResults (WEB_SEARCH_MAX_RESULTS stays as the
schemastery default). Also fixes the stale GREP_LIMIT references in
search.ts and the web-capability-seam RFC (no such constant exists).
- bash-local: graceMs (SIGTERM->SIGKILL escalation grace). The
RunInternals.graceMs test seam is gone: graceMs is now a required
SpawnSpec field filled from config, so tests exercise the real
config path and the defaults live in exactly one place.
- subagent-acp: disposeEofGraceMs / disposeGraceMs. The AcpRunSpec
fields become required for the same one-defaulting-layer reason.
- session-persistence-sqlite: journalMode ('wal' default; the
rollback-journal modes serve filesystems where WAL's shared-memory
files do not work, e.g. network mounts).
- hooks-claude + hooks-codex: stderrSummaryMaxChars for the persisted
hook/result stderr summary. The duplicated summarize() helpers merge
into hook-protocol's summarizeStderr(stderr, maxChars), beside the
HookResultRecord field it feeds, with the bound parameterized the
same way runHook's defaultTimeoutMs already is.
- compact-basic: charsPerToken for the token estimator (default 4, the
English-text heuristic; CJK-heavy deployments need ~1-2 or compaction
fires far too late). Also corrects the BasicCompactService class doc,
which claimed defaults the required-field config never had.
- fs-local: deletes the dead STREAM_MIN_SIZE constant and the dead
FsIoInternals.streamMinSize seam — the read-routing bound lives in
the consumer (tool-fs), where it is now config. This is item 1 of
the proposed prune-write-only-fs-surface RFC, annotated accordingly.
Every new field gets range validation (following the existing
assertPositiveFinite pattern), a README row, and tests covering the
configured behavior, the schema default, and load-time rejection.
85 lines
3.4 KiB
TypeScript
85 lines
3.4 KiB
TypeScript
/**
|
|
* Append helpers for the log-only `hook/*` session events — the durable record
|
|
* that a hook ran and what it decided. Thin wrappers over `session.append` so a
|
|
* bridge does not hand-build the payloads (and so the `turn`-enclosure +
|
|
* invoked/result pairing stay consistent across both bridges).
|
|
*
|
|
* `hook/*` events are log-only (not {@link SurfaceEventType}), so they carry no
|
|
* `surfaceOp` and append with no surface intent — but, like every event, they
|
|
* must sit inside an OPEN turn (the invariants oracle rejects an un-enclosed
|
|
* event). The mid-turn hook points (`PreToolUse`/`PostToolUse`/`UserPromptSubmit`/
|
|
* `Stop`) fire inside the loop's open turn by construction; `SessionStart` is the
|
|
* exception (its injected `context/message` is the durable evidence instead), so
|
|
* a bridge does NOT write `hook/*` for session-start — see the hooks RFC.
|
|
*
|
|
* @module @deepseek-ai/dsh-hook-protocol/events
|
|
*/
|
|
|
|
import type { Session } from '@deepseek-ai/dsh-session'
|
|
import type { HookDialect } from './types.ts'
|
|
|
|
/** What identifies a hook invocation across its invoked/result pair. */
|
|
export interface HookInvocation {
|
|
/** The open turn the invocation lives inside. */
|
|
turn: number
|
|
/** The hook point (`PreToolUse`, `Stop`, …). */
|
|
point: string
|
|
/** The bridge dialect that ran it. */
|
|
dialect: HookDialect
|
|
/** A stable id correlating the invoked event with its result. */
|
|
handlerId: string
|
|
/** The matcher-group pattern that selected it (absent for match-all). */
|
|
matcher?: string
|
|
}
|
|
|
|
/** The decided outcome half of the pair. */
|
|
export interface HookResultRecord {
|
|
turn: number
|
|
point: string
|
|
handlerId: string
|
|
/** The dialect-neutral decision the bridge resolved (`deny`/`allow`/`block`/…). */
|
|
decision: string
|
|
/** The process exit code (absent when the hook could not run). */
|
|
exitCode?: number
|
|
/** A truncated stderr summary (the block-reason source on exit 2). */
|
|
stderrSummary?: string
|
|
/** Wall-clock duration of the run. */
|
|
durationMs: number
|
|
}
|
|
|
|
/** Append a `hook/invoked` provenance event to `session`. */
|
|
export function appendHookInvoked(session: Session, invocation: HookInvocation): void {
|
|
session.append('hook/invoked', {
|
|
turn: invocation.turn,
|
|
point: invocation.point,
|
|
dialect: invocation.dialect,
|
|
handlerId: invocation.handlerId,
|
|
...invocation.matcher !== undefined ? { matcher: invocation.matcher } : {},
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Truncate a hook's stderr for {@link HookResultRecord.stderrSummary}: trimmed,
|
|
* `undefined` when empty, cut at `maxChars` with an ellipsis when over. The
|
|
* bound is a parameter — like `runHook`'s `defaultTimeoutMs`, each bridge owns
|
|
* the config default and passes it in.
|
|
*/
|
|
export function summarizeStderr(stderr: string, maxChars: number): string | undefined {
|
|
const t = stderr.trim()
|
|
if (t.length === 0) return undefined
|
|
return t.length > maxChars ? t.slice(0, maxChars) + '…' : t
|
|
}
|
|
|
|
/** Append a `hook/result` outcome event to `session` (pairs with a prior `hook/invoked`). */
|
|
export function appendHookResult(session: Session, record: HookResultRecord): void {
|
|
session.append('hook/result', {
|
|
turn: record.turn,
|
|
point: record.point,
|
|
handlerId: record.handlerId,
|
|
decision: record.decision,
|
|
...record.exitCode !== undefined ? { exitCode: record.exitCode } : {},
|
|
...record.stderrSummary !== undefined ? { stderrSummary: record.stderrSummary } : {},
|
|
durationMs: record.durationMs,
|
|
})
|
|
}
|