collapseBackgroundBashNotifications.ts
utils/collapseBackgroundBashNotifications.ts
No strong subsystem tag
85
Lines
2750
Bytes
1
Exports
5
Imports
10
Keywords
What this is
This page documents one file from the repository and includes its full source so you can read it without leaving the docs site.
Beginner explanation
This file is one piece of the larger system. Its name, directory, imports, and exports show where it fits. Start by reading the exports and related files first.
How it is used
Start from the exports list and related files. Those are the easiest clues for where this file fits into the system.
Expert explanation
Architecturally, this file intersects with general runtime concerns. It contains 85 lines, 5 detected imports, and 1 detected exports.
Important relationships
Detected exports
collapseBackgroundBashNotifications
Keywords
messagescontenttextrenderablemessageresultstatus_tagsummary_tagtask_notification_tagcompletedcount
Detected imports
../constants/xml.js../tasks/LocalShellTask/LocalShellTask.js../types/message.js./fullscreen.js./messages.js
Source notes
This page embeds the full file contents. Small or leaf files are still indexed honestly instead of being over-explained.
Full source
import {
STATUS_TAG,
SUMMARY_TAG,
TASK_NOTIFICATION_TAG,
} from '../constants/xml.js'
import { BACKGROUND_BASH_SUMMARY_PREFIX } from '../tasks/LocalShellTask/LocalShellTask.js'
import type {
NormalizedUserMessage,
RenderableMessage,
} from '../types/message.js'
import { isFullscreenEnvEnabled } from './fullscreen.js'
import { extractTag } from './messages.js'
function isCompletedBackgroundBash(
msg: RenderableMessage,
): msg is NormalizedUserMessage {
if (msg.type !== 'user') return false
const content = msg.message.content[0]
if (content?.type !== 'text') return false
if (!content.text.includes(`<${TASK_NOTIFICATION_TAG}`)) return false
// Only collapse successful completions — failed/killed stay visible individually.
if (extractTag(content.text, STATUS_TAG) !== 'completed') return false
// The prefix constant distinguishes bash-kind LocalShellTask completions from
// agent/workflow/monitor notifications. Monitor-kind completions have their
// own summary wording and deliberately don't collapse here.
return (
extractTag(content.text, SUMMARY_TAG)?.startsWith(
BACKGROUND_BASH_SUMMARY_PREFIX,
) ?? false
)
}
/**
* Collapses consecutive completed-background-bash task-notifications into a
* single synthetic "N background commands completed" notification. Failed/killed
* tasks and agent/workflow notifications are left alone. Monitor stream
* events (enqueueStreamEvent) have no <status> tag and never match.
*
* Pass-through in verbose mode so ctrl+O shows each completion.
*/
export function collapseBackgroundBashNotifications(
messages: RenderableMessage[],
verbose: boolean,
): RenderableMessage[] {
if (!isFullscreenEnvEnabled()) return messages
if (verbose) return messages
const result: RenderableMessage[] = []
let i = 0
while (i < messages.length) {
const msg = messages[i]!
if (isCompletedBackgroundBash(msg)) {
let count = 0
while (i < messages.length && isCompletedBackgroundBash(messages[i]!)) {
count++
i++
}
if (count === 1) {
result.push(msg)
} else {
// Synthesize a task-notification that UserAgentNotificationMessage
// already knows how to render — no new renderer needed.
result.push({
...msg,
message: {
role: 'user',
content: [
{
type: 'text',
text: `<${TASK_NOTIFICATION_TAG}><${STATUS_TAG}>completed</${STATUS_TAG}><${SUMMARY_TAG}>${count} background commands completed</${SUMMARY_TAG}></${TASK_NOTIFICATION_TAG}>`,
},
],
},
})
}
} else {
result.push(msg)
i++
}
}
return result
}