mirror of
https://github.com/deepseek-ai/deepseek-harness
synced 2026-08-15 21:04:50 +00:00
Codex's PR-E review found three protocol-fidelity blockers + two doc gaps, all
verified against ~/repos/refs:
- (A) Top-level `decision` accepted allow/deny/ask, but both reference schemas
reserve those for hookSpecificOutput.permissionDecision — the legacy top-level
decision is approve/block ONLY. Split topLevelDecisionOf (approve/block) from
permissionDecisionOf (allow/deny/ask), so an out-of-band {"decision":"deny"} is
now invalid and ignored instead of becoming a real blocking decision.
- (A) hookSpecificOutput was parsed without its hookEventName discriminator.
HookOutput now surfaces hookEventName so a bridge can discard a block whose
claimed event doesn't match the firing one (the schemas key the block by event).
- (A) runHook discarded raw stdout. HookOutput now carries `stdout` (trimmed,
verbatim) so a bridge can reproduce CC's plain-stdout rendering / Codex's
plain-stdout-as-additionalContext behavior.
- (B) hook/* SessionEventMap variants were only named in prose; added a payload/role
table to core-data-structures/session.md (a maintained catalog surface).
- (B) Removed PR-stack-position references (PR-F / "future bridge packages") from a
test comment and the RFC, per the current-state-wording rule.
New codec tests: top-level allow/deny/ask invalid+ignored, hookEventName capture,
raw stdout preserved on plain + JSON + empty stdout. 51 tests, per-file 100%.
135 lines
6.0 KiB
TypeScript
135 lines
6.0 KiB
TypeScript
import { describe, expect, it } from 'vitest'
|
|
import type { BashExecRequest, BashExecSpec, BashExecutor, BashRunResult } from '@deepseek-ai/dsh-bash'
|
|
import { runHook } from '@deepseek-ai/dsh-hook-protocol'
|
|
|
|
/**
|
|
* A minimal stand-in for the bits of {@link BashExecutor} that {@link runHook}
|
|
* actually calls (`resolve` then `run`). `runHook` is pure plumbing over those
|
|
* two methods, so a duck-typed recorder is the right test seam — the REAL
|
|
* executor (dsh-bash-local) is exercised end-to-end by the hook-bridge plugins
|
|
* that consume this library, not here.
|
|
*/
|
|
function recordingBash(run: (spec: BashExecSpec) => Promise<BashRunResult>): {
|
|
bash: BashExecutor
|
|
specs: BashExecSpec[]
|
|
} {
|
|
const specs: BashExecSpec[] = []
|
|
const bash = {
|
|
resolve(request: BashExecRequest): BashExecSpec {
|
|
// Carry the request through verbatim, defaulting the required spec fields —
|
|
// exactly what dsh-bash-local's resolve does for the fields runHook sets.
|
|
return {
|
|
command: request.command,
|
|
workdir: request.workdir ?? '/stub',
|
|
timeoutMs: request.timeoutMs ?? 0,
|
|
...request.signal ? { signal: request.signal } : {},
|
|
...request.stdin !== undefined ? { stdin: request.stdin } : {},
|
|
...request.env !== undefined ? { env: request.env } : {},
|
|
owner: request.owner,
|
|
}
|
|
},
|
|
async run(spec: BashExecSpec): Promise<BashRunResult> {
|
|
specs.push(spec)
|
|
return run(spec)
|
|
},
|
|
} as unknown as BashExecutor
|
|
return { bash, specs }
|
|
}
|
|
|
|
function result(over: Partial<BashRunResult> = {}): BashRunResult {
|
|
return {
|
|
exitCode: 0,
|
|
signal: null,
|
|
timedOut: false,
|
|
aborted: false,
|
|
timeoutMs: 1000,
|
|
stdout: { text: '', truncated: false },
|
|
stderr: { text: '', truncated: false },
|
|
...over,
|
|
}
|
|
}
|
|
|
|
const clock = () => { let t = 0; return () => (t += 5) } // +5ms per call → duration 5
|
|
|
|
describe('runHook — payload + env + stdin plumbing', () => {
|
|
it('serializes the payload to stdin (with trailing newline when requested)', async () => {
|
|
const { bash, specs } = recordingBash(async () => result({ stdout: { text: '', truncated: false } }))
|
|
await runHook(bash, { command: 'my-hook.sh' }, {
|
|
payload: { hook_event_name: 'PreToolUse', tool_name: 'Bash' },
|
|
defaultTimeoutMs: 60000,
|
|
trailingNewline: true,
|
|
}, clock())
|
|
expect(specs[0]!.stdin).toBe(JSON.stringify({ hook_event_name: 'PreToolUse', tool_name: 'Bash' }) + '\n')
|
|
expect(specs[0]!.command).toBe('my-hook.sh')
|
|
})
|
|
|
|
it('omits the trailing newline when trailingNewline is false (Codex)', async () => {
|
|
const { bash, specs } = recordingBash(async () => result())
|
|
await runHook(bash, { command: 'h' }, { payload: { a: 1 }, defaultTimeoutMs: 1000, trailingNewline: false }, clock())
|
|
expect(specs[0]!.stdin).toBe('{"a":1}')
|
|
})
|
|
|
|
it('threads env and cwd into the request', async () => {
|
|
const { bash, specs } = recordingBash(async () => result())
|
|
await runHook(bash, { command: 'h' }, {
|
|
payload: {}, env: { CLAUDE_PROJECT_DIR: '/proj' }, cwd: '/work',
|
|
defaultTimeoutMs: 1000, trailingNewline: true,
|
|
}, clock())
|
|
expect(specs[0]!.env).toEqual({ CLAUDE_PROJECT_DIR: '/proj' })
|
|
expect(specs[0]!.workdir).toBe('/work')
|
|
})
|
|
|
|
it('a per-hook timeoutSec (seconds) overrides the default (ms)', async () => {
|
|
const { bash, specs } = recordingBash(async () => result())
|
|
await runHook(bash, { command: 'h', timeoutSec: 3 }, { payload: {}, defaultTimeoutMs: 60000, trailingNewline: true }, clock())
|
|
expect(specs[0]!.timeoutMs).toBe(3000)
|
|
})
|
|
|
|
it('falls back to the default timeout when the hook sets none', async () => {
|
|
const { bash, specs } = recordingBash(async () => result())
|
|
await runHook(bash, { command: 'h' }, { payload: {}, defaultTimeoutMs: 60000, trailingNewline: true }, clock())
|
|
expect(specs[0]!.timeoutMs).toBe(60000)
|
|
})
|
|
|
|
it('passes the abort signal through', async () => {
|
|
const controller = new AbortController()
|
|
const { bash, specs } = recordingBash(async () => result())
|
|
await runHook(bash, { command: 'h' }, { payload: {}, signal: controller.signal, defaultTimeoutMs: 1000, trailingNewline: true }, clock())
|
|
expect(specs[0]!.signal).toBe(controller.signal)
|
|
})
|
|
})
|
|
|
|
describe('runHook — outcome decoding + duration', () => {
|
|
it('decodes a clean exit with structured stdout and reports a duration', async () => {
|
|
const { bash } = recordingBash(async () => result({
|
|
exitCode: 0, stdout: { text: JSON.stringify({ decision: 'block', reason: 'no' }), truncated: false },
|
|
}))
|
|
const { output, durationMs } = await runHook(bash, { command: 'h' }, { payload: {}, defaultTimeoutMs: 1000, trailingNewline: true }, clock())
|
|
expect(output.decision).toBe('block')
|
|
expect(output.reason).toBe('no')
|
|
expect(durationMs).toBe(5)
|
|
})
|
|
|
|
it('a signal death (exitCode null) decodes as undefined exit (non-blocking error)', async () => {
|
|
const { bash } = recordingBash(async () => result({ exitCode: null, signal: 'SIGKILL', stderr: { text: 'killed', truncated: false } }))
|
|
const { output } = await runHook(bash, { command: 'h' }, { payload: {}, defaultTimeoutMs: 1000, trailingNewline: true }, clock())
|
|
expect(output.exitCode).toBeUndefined()
|
|
expect(output.decision).toBeUndefined()
|
|
expect(output.stderr).toBe('killed')
|
|
})
|
|
|
|
it('an executor rejection (infra fault) becomes a non-blocking error, never throws', async () => {
|
|
const { bash } = recordingBash(async () => { throw new Error('bad workdir: ENOENT') })
|
|
const { output } = await runHook(bash, { command: 'h' }, { payload: {}, defaultTimeoutMs: 1000, trailingNewline: true }, clock())
|
|
expect(output.exitCode).toBeUndefined()
|
|
expect(output.stderr).toBe('bad workdir: ENOENT')
|
|
expect(output.decision).toBeUndefined()
|
|
})
|
|
|
|
it('a non-Error rejection is stringified onto stderr', async () => {
|
|
const { bash } = recordingBash(async () => { throw 'plain string fault' })
|
|
const { output } = await runHook(bash, { command: 'h' }, { payload: {}, defaultTimeoutMs: 1000, trailingNewline: true }, clock())
|
|
expect(output.stderr).toBe('plain string fault')
|
|
})
|
|
})
|