feat(memory): mod skeleton with off switch and fail-open hooks
This commit is contained in:
1 parent
8e141feeb5
commit
f1d4f9de0a
5 files changed
+248
No files matched your search
@@ -0,0 +1,130 @@
|
||||
// memory: captures what fails in a session and offers it to the memory
|
||||
// registries. This file is the frame: the off switch, the fail-open hooks
|
||||
// and the per-session state. Every hook reads the session id and root at
|
||||
// the point of use, never from a cache. A hook that fails passes the event
|
||||
// through unchanged: the mod may never break a tool call or a prompt.
|
||||
import type { EngineInterface, On, Register } from 'claude-code'
|
||||
|
||||
type Api = EngineInterface
|
||||
|
||||
type State = {
|
||||
enabled: boolean | null // null: not read yet this session
|
||||
warned: Set<string>
|
||||
pending: string[] // milestones not yet shown in a note
|
||||
writes: Promise<void> // the one chain every store write runs on
|
||||
}
|
||||
|
||||
const SWITCH_FILE = '.claude/memory.json'
|
||||
const MAX_SWITCH_BYTES = 65536
|
||||
const TOOL = 'memory_pending'
|
||||
|
||||
function newState(): State {
|
||||
return {
|
||||
enabled: null,
|
||||
warned: new Set(),
|
||||
pending: [],
|
||||
writes: Promise.resolve(),
|
||||
}
|
||||
}
|
||||
|
||||
/** Logs a hook's fail-open once per session; never throws itself. */
|
||||
function warnOnce(st: State, $: Api, hook: string, kind: string): void {
|
||||
if (st.warned.has(hook)) return
|
||||
st.warned.add(hook)
|
||||
try {
|
||||
$.ui.log(`memory: ${hook} hook failed (${kind}); passed through`)
|
||||
} catch {
|
||||
// a failing log must not break the fail-open itself
|
||||
}
|
||||
}
|
||||
|
||||
/** True unless the user's switch file says `enabled: false`. */
|
||||
async function loadEnabled($: Api): Promise<boolean> {
|
||||
try {
|
||||
const home = await $.env.get('HOME')
|
||||
if (!home) return true
|
||||
const path = `${home}/${SWITCH_FILE}`
|
||||
const info = await $.fs.stat(path)
|
||||
if (info.kind !== 'file' || info.size > MAX_SWITCH_BYTES) return true
|
||||
const data: unknown = JSON.parse(await $.fs.read(path))
|
||||
if (typeof data !== 'object' || data === null) return true
|
||||
return (data as { enabled?: unknown }).enabled !== false
|
||||
} catch {
|
||||
return true
|
||||
}
|
||||
}
|
||||
|
||||
/** The tool the model calls to list the pending captures (body: later). */
|
||||
async function registerTool($: Api): Promise<void> {
|
||||
try {
|
||||
await $.tool.register({
|
||||
name: TOOL,
|
||||
description:
|
||||
'List the failures and milestones captured in this project and ' +
|
||||
'not yet written to the memory registries.',
|
||||
inputSchema: { type: 'object', additionalProperties: false },
|
||||
})
|
||||
} catch {
|
||||
$.ui.log('memory: tool not registered')
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Reads the switch on the first event of a session and caches it; each
|
||||
* read of `enabled: true` registers the tool again (a name registered
|
||||
* twice is replaced).
|
||||
*/
|
||||
async function ensureEnabled($: Api, st: State): Promise<boolean> {
|
||||
if (st.enabled !== null) return st.enabled
|
||||
st.enabled = await loadEnabled($)
|
||||
if (st.enabled) await registerTool($)
|
||||
return st.enabled
|
||||
}
|
||||
|
||||
function registerSession(on: On, st: State): void {
|
||||
on('session.start', async ($, e, next) => {
|
||||
await ensureEnabled($, st)
|
||||
return next(e)
|
||||
}).catch(($, e, next) => {
|
||||
warnOnce(st, $, 'session.start', next.error.kind)
|
||||
return next(e)
|
||||
})
|
||||
on('session.end', async ($, e, next) => {
|
||||
st.enabled = null
|
||||
st.pending = []
|
||||
return next(e)
|
||||
}).catch(($, e, next) => {
|
||||
warnOnce(st, $, 'session.end', next.error.kind)
|
||||
return next(e)
|
||||
})
|
||||
}
|
||||
|
||||
function registerBash(on: On, st: State): void {
|
||||
on('tool.call', { tool: 'Bash' }, async ($, e, next) => {
|
||||
if (!(await ensureEnabled($, st))) return next(e)
|
||||
// read before next: a failure here must not run the tool twice
|
||||
const root = await $.session.root()
|
||||
if (root === '') return next(e)
|
||||
return next(e) // capture comes with the store
|
||||
}).catch(($, e, next) => {
|
||||
warnOnce(st, $, 'Bash', next.error.kind)
|
||||
return next(e)
|
||||
})
|
||||
}
|
||||
|
||||
function registerPrompt(on: On, st: State): void {
|
||||
on('prompt.submit', async ($, e, next) => {
|
||||
await ensureEnabled($, st)
|
||||
return next(e)
|
||||
}).catch(($, e, next) => {
|
||||
warnOnce(st, $, 'prompt.submit', next.error.kind)
|
||||
return next(e)
|
||||
})
|
||||
}
|
||||
|
||||
export const register: Register = on => {
|
||||
const st = newState()
|
||||
registerSession(on, st)
|
||||
registerBash(on, st)
|
||||
registerPrompt(on, st)
|
||||
}
|
||||
Reference in new issue
Block a user