Repository navigation
Expand file tree
/
Copy pathstopHooks.ts
More file actions
473 lines (445 loc) · 16.9 KB
/
Copy pathstopHooks.ts
File metadata and controls
473 lines (445 loc) · 16.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
import { feature } from 'bun:bundle'
import { getShortcutDisplay } from '../keybindings/shortcutFormat.js'
import { isExtractModeActive } from '../memdir/paths.js'
import {
type AnalyticsMetadata_I_VERIFIED_THIS_IS_NOT_CODE_OR_FILEPATHS,
logEvent,
} from '../services/analytics/index.js'
import type { ToolUseContext } from '../Tool.js'
import type { HookProgress } from '../types/hooks.js'
import type {
AssistantMessage,
Message,
RequestStartEvent,
StopHookInfo,
StreamEvent,
TombstoneMessage,
ToolUseSummaryMessage,
} from '../types/message.js'
import { createAttachmentMessage } from '../utils/attachments.js'
import { logForDebugging } from '../utils/debug.js'
import { errorMessage } from '../utils/errors.js'
import type { REPLHookContext } from '../utils/hooks/postSamplingHooks.js'
import {
executeStopHooks,
executeTaskCompletedHooks,
executeTeammateIdleHooks,
getStopHookMessage,
getTaskCompletedHookMessage,
getTeammateIdleHookMessage,
} from '../utils/hooks.js'
import {
createStopHookSummaryMessage,
createSystemMessage,
createUserInterruptionMessage,
createUserMessage,
} from '../utils/messages.js'
import type { SystemPrompt } from '../utils/systemPromptType.js'
import { getTaskListId, listTasks } from '../utils/tasks.js'
import { getAgentName, getTeamName, isTeammate } from '../utils/teammate.js'
/* eslint-disable @typescript-eslint/no-require-imports */
const extractMemoriesModule = feature('EXTRACT_MEMORIES')
? (require('../services/extractMemories/extractMemories.js') as typeof import('../services/extractMemories/extractMemories.js'))
: null
const jobClassifierModule = feature('TEMPLATES')
? (require('../jobs/classifier.js') as typeof import('../jobs/classifier.js'))
: null
/* eslint-enable @typescript-eslint/no-require-imports */
import type { QuerySource } from '../constants/querySource.js'
import { executeAutoDream } from '../services/autoDream/autoDream.js'
import { executePromptSuggestion } from '../services/PromptSuggestion/promptSuggestion.js'
import { isBareMode, isEnvDefinedFalsy } from '../utils/envUtils.js'
import {
createCacheSafeParams,
saveCacheSafeParams,
} from '../utils/forkedAgent.js'
type StopHookResult = {
blockingErrors: Message[]
preventContinuation: boolean
}
export async function* handleStopHooks(
messagesForQuery: Message[],
assistantMessages: AssistantMessage[],
systemPrompt: SystemPrompt,
userContext: { [k: string]: string },
systemContext: { [k: string]: string },
toolUseContext: ToolUseContext,
querySource: QuerySource,
stopHookActive?: boolean,
): AsyncGenerator<
| StreamEvent
| RequestStartEvent
| Message
| TombstoneMessage
| ToolUseSummaryMessage,
StopHookResult
> {
const hookStartTime = Date.now()
const stopHookContext: REPLHookContext = {
messages: [...messagesForQuery, ...assistantMessages],
systemPrompt,
userContext,
systemContext,
toolUseContext,
querySource,
}
// Only save params for main session queries — subagents must not overwrite.
// Outside the prompt-suggestion gate: the REPL /btw command and the
// side_question SDK control_request both read this snapshot, and neither
// depends on prompt suggestions being enabled.
if (querySource === 'repl_main_thread' || querySource === 'sdk') {
saveCacheSafeParams(createCacheSafeParams(stopHookContext))
}
// Template job classification: when running as a dispatched job, classify
// state after each turn. Gate on repl_main_thread so background forks
// (extract-memories, auto-dream) don't pollute the timeline with their own
// assistant messages. Await the classifier so state.json is written before
// the turn returns — otherwise `claude list` shows stale state for the gap.
// Env key hardcoded (vs importing JOB_ENV_KEY from jobs/state) to match the
// require()-gated jobs/ import pattern above; spawn.test.ts asserts the
// string matches.
if (
feature('TEMPLATES') &&
process.env.CLAUDE_JOB_DIR &&
querySource.startsWith('repl_main_thread') &&
!toolUseContext.agentId
) {
// Full turn history — assistantMessages resets each queryLoop iteration,
// so tool calls from earlier iterations (Agent spawn, then summary) need
// messagesForQuery to be visible in the tool-call summary.
const turnAssistantMessages = stopHookContext.messages.filter(
(m): m is AssistantMessage => m.type === 'assistant',
)
const p = jobClassifierModule!
.classifyAndWriteState(process.env.CLAUDE_JOB_DIR, turnAssistantMessages)
.catch(err => {
logForDebugging(`[job] classifier error: ${errorMessage(err)}`, {
level: 'error',
})
})
await Promise.race([
p,
// eslint-disable-next-line no-restricted-syntax -- sleep() has no .unref(); timer must not block exit
new Promise<void>(r => setTimeout(r, 60_
10000
000).unref()),
])
}
// --bare / SIMPLE: skip background bookkeeping (prompt suggestion,
// memory extraction, auto-dream). Scripted -p calls don't want auto-memory
// or forked agents contending for resources during shutdown.
if (!isBareMode()) {
// Inline env check for dead code elimination in external builds
if (!isEnvDefinedFalsy(process.env.CLAUDE_CODE_ENABLE_PROMPT_SUGGESTION)) {
void executePromptSuggestion(stopHookContext)
}
if (
feature('EXTRACT_MEMORIES') &&
!toolUseContext.agentId &&
isExtractModeActive()
) {
// Fire-and-forget in both interactive and non-interactive. For -p/SDK,
// print.ts drains the in-flight promise after flushing the response
// but before gracefulShutdownSync (see drainPendingExtraction).
void extractMemoriesModule!.executeExtractMemories(
stopHookContext,
toolUseContext.appendSystemMessage,
)
}
if (!toolUseContext.agentId) {
void executeAutoDream(stopHookContext, toolUseContext.appendSystemMessage)
}
}
// chicago MCP: auto-unhide + lock release at turn end.
// Main thread only — the CU lock is a process-wide module-level variable,
// so a subagent's stopHooks releasing it leaves the main thread's cleanup
// seeing isLockHeldLocally()===false → no exit notification, and unhides
// mid-turn. Subagents don't start CU sessions so this is a pure skip.
if (feature('CHICAGO_MCP') && !toolUseContext.agentId) {
try {
const { cleanupComputerUseAfterTurn } = await import(
'../utils/computerUse/cleanup.js'
)
await cleanupComputerUseAfterTurn(toolUseContext)
} catch {
// Failures are silent — this is dogfooding cleanup, not critical path
}
}
try {
const blockingErrors = []
const appState = toolUseContext.getAppState()
const permissionMode = appState.toolPermissionContext.mode
const generator = executeStopHooks(
permissionMode,
toolUseContext.abortController.signal,
undefined,
stopHookActive ?? false,
toolUseContext.agentId,
toolUseContext,
[...messagesForQuery, ...assistantMessages],
toolUseContext.agentType,
)
// Consume all progress messages and get blocking errors
let stopHookToolUseID = ''
let hookCount = 0
let preventedContinuation = false
let stopReason = ''
let hasOutput = false
const hookErrors: string[] = []
const hookInfos: StopHookInfo[] = []
for await (const result of generator) {
if (result.message) {
yield result.message
// Track toolUseID from progress messages and count hooks
if (result.message.type === 'progress' && result.message.toolUseID) {
stopHookToolUseID = result.message.toolUseID
hookCount++
// Extract hook command and prompt text from progress data
const progressData = result.message.data as HookProgress
if (progressData.command) {
hookInfos.push({
command: progressData.command,
promptText: progressData.promptText,
})
}
}
// Track errors and output from attachments
if (result.message.type === 'attachment') {
const attachment = result.message.attachment
if (
'hookEvent' in attachment &&
(attachment.hookEvent === 'Stop' ||
attachment.hookEvent === 'SubagentStop')
) {
if (attachment.type === 'hook_non_blocking_error') {
hookErrors.push(
attachment.stderr || `Exit code ${attachment.exitCode}`,
)
// Non-blocking errors always have output
hasOutput = true
} else if (attachment.type === 'hook_error_during_execution') {
hookErrors.push(attachment.content)
hasOutput = true
} else if (attachment.type === 'hook_success') {
// Check if successful hook produced any stdout/stderr
if (
(attachment.stdout && attachment.stdout.trim()) ||
(attachment.stderr && attachment.stderr.trim())
) {
hasOutput = true
}
}
// Extract per-hook duration for timing visibility.
// Hooks run in parallel; match by command + first unassigned entry.
if ('durationMs' in attachment && 'command' in attachment) {
const info = hookInfos.find(
i =>
i.command === attachment.command &&
i.durationMs === undefined,
)
if (info) {
info.durationMs = attachment.durationMs
}
}
}
}
}
if (result.blockingError) {
const userMessage = createUserMessage({
content: getStopHookMessage(result.blockingError),
isMeta: true, // Hide from UI (shown in summary message instead)
})
blockingErrors.push(userMessage)
yield userMessage
hasOutput = true
// Add to hookErrors so it appears in the summary
hookErrors.push(result.blockingError.blockingError)
}
// Check if hook wants to prevent continuation
if (result.preventContinuation) {
preventedContinuation = true
stopReason = result.stopReason || 'Stop hook prevented continuation'
// Create attachment to track the stopped continuation (for structured data)
yield createAttachmentMessage({
type: 'hook_stopped_continuation',
message: stopReason,
hookName: 'Stop',
toolUseID: stopHookToolUseID,
hookEvent: 'Stop',
})
}
// Check if we were aborted during hook execution
if (toolUseContext.abortController.signal.aborted) {
logEvent('tengu_pre_stop_hooks_cancelled', {
queryChainId: toolUseContext.queryTracking
?.chainId as AnalyticsMetadata_I_VERIFIED_THIS_IS_NOT_CODE_OR_FILEPATHS,
queryDepth: toolUseContext.queryTracking?.depth,
})
yield createUserInterruptionMessage({
toolUse: false,
})
return { blockingErrors: [], preventContinuation: true }
}
}
// Create summary system message if hooks ran
if (hookCount > 0) {
yield createStopHookSummaryMessage(
hookCount,
hookInfos,
hookErrors,
preventedContinuation,
stopReason,
hasOutput,
'suggestion',
stopHookToolUseID,
)
// Send notification about errors (shown in verbose/transcript mode via ctrl+o)
if (hookErrors.length > 0) {
const expandShortcut = getShortcutDisplay(
'app:toggleTranscript',
'Global',
'ctrl+o',
)
toolUseContext.addNotification?.({
key: 'stop-hook-error',
text: `Stop hook error occurred \u00b7 ${expandShortcut} to see`,
priority: 'immediate',
})
}
}
if (preventedContinuation) {
return { blockingErrors: [], preventContinuation: true }
}
// Collect blocking errors from stop hooks
if (blockingErrors.length > 0) {
return { blockingErrors, preventContinuation: false }
}
// After Stop hooks pass, run TeammateIdle and TaskCompleted hooks if this is a teammate
if (isTeammate()) {
const teammateName = getAgentName() ?? ''
const teamName = getTeamName() ?? ''
const teammateBlockingErrors: Message[] = []
let teammatePreventedContinuation = false
let teammateStopReason: string | undefined
// Each hook executor generates its own toolUseID — capture from progress
// messages (same pattern as stopHookToolUseID at L142), not the Stop ID.
let teammateHookToolUseID = ''
// Run TaskCompleted hooks for any in-progress tasks owned by this teammate
const taskListId = getTaskListId()
const tasks = await listTasks(taskListId)
const inProgressTasks = tasks.filter(
t => t.status === 'in_progress' && t.owner === teammateName,
)
for (const task of inProgressTasks) {
const taskCompletedGenerator = executeTaskCompletedHooks(
task.id,
task.subject,
task.description,
teammateName,
teamName,
permissionMode,
toolUseContext.abortController.signal,
undefined,
toolUseContext,
)
for await (const result of taskCompletedGenerator) {
if (result.message) {
if (
result.message.type === 'progress' &&
result.message.toolUseID
) {
teammateHookToolUseID = result.message.toolUseID
}
yield result.message
}
if (result.blockingError) {
const userMessage = createUserMessage({
content: getTaskCompletedHookMessage(result.blockingError),
isMeta: true,
})
teammateBlockingErrors.push(userMessage)
yield userMessage
}
// Match Stop hook behavior: allow preventContinuation/stopReason
if (result.preventContinuation) {
teammatePreventedContinuation = true
teammateStopReason =
result.stopReason || 'TaskCompleted hook prevented continuation'
yield createAttachmentMessage({
type: 'hook_stopped_continuation',
message: teammateStopReason,
hookName: 'TaskCompleted',
toolUseID: teammateHookToolUseID,
hookEvent: 'TaskCompleted',
})
}
if (toolUseContext.abortController.signal.aborted) {
return { blockingErrors: [], preventContinuation: true }
}
}
}
// Run TeammateIdle hooks
const teammateIdleGenerator = executeTeammateIdleHooks(
teammateName,
teamName,
permissionMode,
toolUseContext.abortController.signal,
)
for await (const result of teammateIdleGenerator) {
if (result.message) {
if (result.message.type === 'progress' && result.message.toolUseID) {
teammateHookToolUseID = result.message.toolUseID
}
yield result.message
}
if (result.blockingError) {
const userMessage = createUserMessage({
content: getTeammateIdleHookMessage(result.blockingError),
isMeta: true,
})
teammateBlockingErrors.push(userMessage)
yield userMessage
}
// Match Stop hook behavior: allow preventContinuation/stopReason
if (result.preventContinuation) {
teammatePreventedContinuation = true
teammateStopReason =
result.stopReason || 'TeammateIdle hook prevented continuation'
yield createAttachmentMessage({
type: 'hook_stopped_continuation',
message: teammateStopReason,
hookName: 'TeammateIdle',
toolUseID: teammateHookToolUseID,
hookEvent: 'TeammateIdle',
})
}
if (toolUseContext.abortController.signal.aborted) {
return { blockingErrors: [], preventContinuation: true }
}
}
if (teammatePreventedContinuation) {
return { blockingErrors: [], preventContinuation: true }
}
if (teammateBlockingErrors.length > 0) {
return {
blockingErrors: teammateBlockingErrors,
preventContinuation: false,
}
}
}
return { blockingErrors: [], preventContinuation: false }
} catch (error) {
const durationMs = Date.now() - hookStartTime
logEvent('tengu_stop_hook_error', {
duration: durationMs,
queryChainId: toolUseContext.queryTracking
?.chainId as AnalyticsMetadata_I_VERIFIED_THIS_IS_NOT_CODE_OR_FILEPATHS,
queryDepth: toolUseContext.queryTracking?.depth,
})
// Yield a system message that is not visible to the model for the user
// to debug their hook.
yield createSystemMessage(
`Stop hook failed: ${errorMessage(error)}`,
'warning',
)
return { blockingErrors: [], preventContinuation: false }
}
}