File size: 10,914 Bytes
064bfd6 | 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 | import { getSessionId } from '../../../bootstrap/state.js'
import type { ToolUseContext } from '../../../Tool.js'
import { formatAgentId, parseAgentId } from '../../../utils/agentId.js'
import { quote } from '../../../utils/bash/shellQuote.js'
import { registerCleanup } from '../../../utils/cleanupRegistry.js'
import { logForDebugging } from '../../../utils/debug.js'
import { jsonStringify } from '../../../utils/slowOperations.js'
import { writeToMailbox } from '../../../utils/teammateMailbox.js'
import {
buildInheritedCliFlags,
buildInheritedEnvVars,
getTeammateCommand,
} from '../spawnUtils.js'
import { assignTeammateColor } from '../teammateLayoutManager.js'
import { isInsideTmux } from './detection.js'
import type {
BackendType,
PaneBackend,
TeammateExecutor,
TeammateMessage,
TeammateSpawnConfig,
TeammateSpawnResult,
} from './types.js'
/**
* PaneBackendExecutor adapts a PaneBackend to the TeammateExecutor interface.
*
* This allows pane-based backends (tmux, iTerm2) to be used through the same
* TeammateExecutor abstraction as InProcessBackend, making getTeammateExecutor()
* return a meaningful executor regardless of execution mode.
*
* The adapter handles:
* - spawn(): Creates a pane and sends the Claude CLI command to it
* - sendMessage(): Writes to the teammate's file-based mailbox
* - terminate(): Sends a shutdown request via mailbox
* - kill(): Kills the pane via the backend
* - isActive(): Checks if the pane is still running
*/
export class PaneBackendExecutor implements TeammateExecutor {
readonly type: BackendType
private backend: PaneBackend
private context: ToolUseContext | null = null
/**
* Track spawned teammates by agentId -> paneId mapping.
* This allows us to find the pane for operations like kill/terminate.
*/
private spawnedTeammates: Map<string, { paneId: string; insideTmux: boolean }>
private cleanupRegistered = false
constructor(backend: PaneBackend) {
this.backend = backend
this.type = backend.type
this.spawnedTeammates = new Map()
}
/**
* Sets the ToolUseContext for this executor.
* Must be called before spawn() to provide access to AppState and permissions.
*/
setContext(context: ToolUseContext): void {
this.context = context
}
/**
* Checks if the underlying pane backend is available.
*/
async isAvailable(): Promise<boolean> {
return this.backend.isAvailable()
}
/**
* Spawns a teammate in a new pane.
*
* Creates a pane via the backend, builds the CLI command with teammate
* identity flags, and sends it to the pane.
*/
async spawn(config: TeammateSpawnConfig): Promise<TeammateSpawnResult> {
const agentId = formatAgentId(config.name, config.teamName)
if (!this.context) {
logForDebugging(
`[PaneBackendExecutor] spawn() called without context for ${config.name}`,
)
return {
success: false,
agentId,
error:
'PaneBackendExecutor not initialized. Call setContext() before spawn().',
}
}
try {
// Assign a unique color to this teammate
const teammateColor = config.color ?? assignTeammateColor(agentId)
// Create a pane in the swarm view
const { paneId, isFirstTeammate } =
await this.backend.createTeammatePaneInSwarmView(
config.name,
teammateColor,
)
// Check if we're inside tmux to determine how to send commands
const insideTmux = await isInsideTmux()
// Enable pane border status on first teammate when inside tmux
if (isFirstTeammate && insideTmux) {
await this.backend.enablePaneBorderStatus()
}
// Build the command to spawn Claude Code with teammate identity
const binaryPath = getTeammateCommand()
// Build teammate identity CLI args
const teammateArgs = [
`--agent-id ${quote([agentId])}`,
`--agent-name ${quote([config.name])}`,
`--team-name ${quote([config.teamName])}`,
`--agent-color ${quote([teammateColor])}`,
`--parent-session-id ${quote([config.parentSessionId || getSessionId()])}`,
config.planModeRequired ? '--plan-mode-required' : '',
]
.filter(Boolean)
.join(' ')
// Build CLI flags to propagate to teammate
const appState = this.context.getAppState()
let inheritedFlags = buildInheritedCliFlags({
planModeRequired: config.planModeRequired,
permissionMode: appState.toolPermissionContext.mode,
})
// If teammate has a custom model, add --model flag (or replace inherited one)
if (config.model) {
inheritedFlags = inheritedFlags
.split(' ')
.filter(
(flag, i, arr) => flag !== '--model' && arr[i - 1] !== '--model',
)
.join(' ')
inheritedFlags = inheritedFlags
? `${inheritedFlags} --model ${quote([config.model])}`
: `--model ${quote([config.model])}`
}
const flagsStr = inheritedFlags ? ` ${inheritedFlags}` : ''
const workingDir = config.cwd
// Build environment variables to forward to teammate
const envStr = buildInheritedEnvVars()
const spawnCommand = `cd ${quote([workingDir])} && env ${envStr} ${quote([binaryPath])} ${teammateArgs}${flagsStr}`
// Send the command to the new pane
// Use swarm socket when running outside tmux (external swarm session)
await this.backend.sendCommandToPane(paneId, spawnCommand, !insideTmux)
// Track the spawned teammate
this.spawnedTeammates.set(agentId, { paneId, insideTmux })
// Register cleanup to kill all panes on leader exit (e.g., SIGHUP)
if (!this.cleanupRegistered) {
this.cleanupRegistered = true
registerCleanup(async () => {
for (const [id, info] of this.spawnedTeammates) {
logForDebugging(
`[PaneBackendExecutor] Cleanup: killing pane for ${id}`,
)
await this.backend.killPane(info.paneId, !info.insideTmux)
}
this.spawnedTeammates.clear()
})
}
// Send initial instructions to teammate via mailbox
await writeToMailbox(
config.name,
{
from: 'team-lead',
text: config.prompt,
timestamp: new Date().toISOString(),
},
config.teamName,
)
logForDebugging(
`[PaneBackendExecutor] Spawned teammate ${agentId} in pane ${paneId}`,
)
return {
success: true,
agentId,
paneId,
}
} catch (error) {
const errorMessage =
error instanceof Error ? error.message : String(error)
logForDebugging(
`[PaneBackendExecutor] Failed to spawn ${agentId}: ${errorMessage}`,
)
return {
success: false,
agentId,
error: errorMessage,
}
}
}
/**
* Sends a message to a pane-based teammate via file-based mailbox.
*
* All teammates (pane and in-process) use the same mailbox mechanism.
*/
async sendMessage(agentId: string, message: TeammateMessage): Promise<void> {
logForDebugging(
`[PaneBackendExecutor] sendMessage() to ${agentId}: ${message.text.substring(0, 50)}...`,
)
const parsed = parseAgentId(agentId)
if (!parsed) {
throw new Error(
`Invalid agentId format: ${agentId}. Expected format: agentName@teamName`,
)
}
const { agentName, teamName } = parsed
await writeToMailbox(
agentName,
{
text: message.text,
from: message.from,
color: message.color,
timestamp: message.timestamp ?? new Date().toISOString(),
},
teamName,
)
logForDebugging(
`[PaneBackendExecutor] sendMessage() completed for ${agentId}`,
)
}
/**
* Gracefully terminates a pane-based teammate.
*
* For pane-based teammates, we send a shutdown request via mailbox and
* let the teammate process handle exit gracefully.
*/
async terminate(agentId: string, reason?: string): Promise<boolean> {
logForDebugging(
`[PaneBackendExecutor] terminate() called for ${agentId}: ${reason}`,
)
const parsed = parseAgentId(agentId)
if (!parsed) {
logForDebugging(
`[PaneBackendExecutor] terminate() failed: invalid agentId format`,
)
return false
}
const { agentName, teamName } = parsed
// Send shutdown request via mailbox
const shutdownRequest = {
type: 'shutdown_request',
requestId: `shutdown-${agentId}-${Date.now()}`,
from: 'team-lead',
reason,
}
await writeToMailbox(
agentName,
{
from: 'team-lead',
text: jsonStringify(shutdownRequest),
timestamp: new Date().toISOString(),
},
teamName,
)
logForDebugging(
`[PaneBackendExecutor] terminate() sent shutdown request to ${agentId}`,
)
return true
}
/**
* Force kills a pane-based teammate by killing its pane.
*/
async kill(agentId: string): Promise<boolean> {
logForDebugging(`[PaneBackendExecutor] kill() called for ${agentId}`)
const teammateInfo = this.spawnedTeammates.get(agentId)
if (!teammateInfo) {
logForDebugging(
`[PaneBackendExecutor] kill() failed: teammate ${agentId} not found in spawned map`,
)
return false
}
const { paneId, insideTmux } = teammateInfo
// Kill the pane via the backend
// Use external session socket when we spawned outside tmux
const killed = await this.backend.killPane(paneId, !insideTmux)
if (killed) {
this.spawnedTeammates.delete(agentId)
logForDebugging(`[PaneBackendExecutor] kill() succeeded for ${agentId}`)
} else {
logForDebugging(`[PaneBackendExecutor] kill() failed for ${agentId}`)
}
return killed
}
/**
* Checks if a pane-based teammate is still active.
*
* For pane-based teammates, we check if the pane still exists.
* This is a best-effort check - the pane may exist but the process inside
* may have exited.
*/
async isActive(agentId: string): Promise<boolean> {
logForDebugging(`[PaneBackendExecutor] isActive() called for ${agentId}`)
const teammateInfo = this.spawnedTeammates.get(agentId)
if (!teammateInfo) {
logForDebugging(
`[PaneBackendExecutor] isActive(): teammate ${agentId} not found`,
)
return false
}
// For now, assume active if we have a record of it
// A more robust check would query the backend for pane existence
// but that would require adding a new method to PaneBackend
return true
}
}
/**
* Creates a PaneBackendExecutor wrapping the given PaneBackend.
*/
export function createPaneBackendExecutor(
backend: PaneBackend,
): PaneBackendExecutor {
return new PaneBackendExecutor(backend)
}
|