feat(agents): integrate remote agent backgrounding with InjectionService

Register remote agent executions with ExecutionLifecycleService, enabling
backgrounding, subscription, and kill support. Provide a formatInjection
callback so completed background remote agent output is automatically
reinjected into the model conversation via InjectionService.
This commit is contained in:
Adam Weidman
2026-03-12 11:56:56 -04:00
parent 0215f0ddbd
commit 4f2a1ad214
2 changed files with 415 additions and 26 deletions
@@ -22,6 +22,7 @@ import type { RemoteAgentDefinition } from './types.js';
import { createMockMessageBus } from '../test-utils/mock-message-bus.js';
import { A2AAuthProviderFactory } from './auth-provider/factory.js';
import type { A2AAuthProvider } from './auth-provider/types.js';
import { ExecutionLifecycleService } from '../services/executionLifecycleService.js';
// Mock A2AClientManager
vi.mock('./a2a-client-manager.js', () => ({
@@ -58,6 +59,7 @@ describe('RemoteAgentInvocation', () => {
beforeEach(() => {
vi.clearAllMocks();
ExecutionLifecycleService.resetForTest();
(A2AClientManager.getInstance as Mock).mockReturnValue(mockClientManager);
(
RemoteAgentInvocation as unknown as {
@@ -685,4 +687,281 @@ describe('RemoteAgentInvocation', () => {
expect(result.returnDisplay).toContain('connection reset');
});
});
describe('ExecutionLifecycleService Integration', () => {
it('should register execution with lifecycle service and call setExecutionIdCallback', async () => {
mockClientManager.getClient.mockReturnValue({});
mockClientManager.sendMessageStream.mockImplementation(
async function* () {
yield {
kind: 'message',
messageId: 'msg-1',
role: 'agent',
parts: [{ kind: 'text', text: 'Done' }],
};
},
);
const setExecutionId = vi.fn();
const invocation = new RemoteAgentInvocation(
mockDefinition,
{ query: 'hi' },
mockMessageBus,
);
await invocation.execute(new AbortController().signal, undefined, {
setExecutionIdCallback: setExecutionId,
});
expect(setExecutionId).toHaveBeenCalledTimes(1);
const executionId = setExecutionId.mock.calls[0][0];
expect(typeof executionId).toBe('number');
// Execution should be completed (no longer active)
expect(ExecutionLifecycleService.isActive(executionId)).toBe(false);
});
it('should support backgrounding and return background result with correct label', async () => {
mockClientManager.getClient.mockReturnValue({});
// Create a stream that we can control
let resolveStream: () => void;
const streamBlocker = new Promise<void>((r) => {
resolveStream = r;
});
mockClientManager.sendMessageStream.mockImplementation(
async function* () {
yield {
kind: 'message',
messageId: 'msg-1',
role: 'agent',
parts: [{ kind: 'text', text: 'Working...' }],
};
await streamBlocker;
yield {
kind: 'message',
messageId: 'msg-2',
role: 'agent',
parts: [{ kind: 'text', text: 'Final result' }],
};
},
);
// Listen for background start events to verify label
const bgStartListener = vi.fn();
ExecutionLifecycleService.onBackground(bgStartListener);
let capturedExecutionId: number | undefined;
const invocation = new RemoteAgentInvocation(
mockDefinition,
{ query: 'hi' },
mockMessageBus,
);
// Start execution but don't await yet
const executePromise = invocation.execute(
new AbortController().signal,
undefined,
{
setExecutionIdCallback: (id) => {
capturedExecutionId = id;
},
},
);
// Wait a tick for the stream to start
await new Promise((r) => setTimeout(r, 50));
expect(capturedExecutionId).toBeDefined();
expect(ExecutionLifecycleService.isActive(capturedExecutionId!)).toBe(
true,
);
// Background the execution
ExecutionLifecycleService.background(capturedExecutionId!);
const result = await executePromise;
expect(result.data).toBeDefined();
expect(result.data?.['pid']).toBe(capturedExecutionId);
expect(result.returnDisplay).toContain('background');
// Verify the label from onBackground matches the agent's displayName
expect(bgStartListener).toHaveBeenCalledTimes(1);
const bgInfo = bgStartListener.mock.calls[0][0];
expect(bgInfo.label).toBe('Test Agent');
expect(bgInfo.executionMethod).toBe('remote_agent');
// Let the stream finish
resolveStream!();
// Wait for stream processing to complete
await new Promise((r) => setTimeout(r, 50));
ExecutionLifecycleService.offBackground(bgStartListener);
});
it('should fire onBackgroundComplete with formatted injection text', async () => {
mockClientManager.getClient.mockReturnValue({});
let resolveStream: () => void;
const streamBlocker = new Promise<void>((r) => {
resolveStream = r;
});
mockClientManager.sendMessageStream.mockImplementation(
async function* () {
yield {
kind: 'message',
messageId: 'msg-1',
role: 'agent',
parts: [{ kind: 'text', text: 'Agent result' }],
};
await streamBlocker;
},
);
const bgListener = vi.fn();
ExecutionLifecycleService.onBackgroundComplete(bgListener);
let capturedExecutionId: number | undefined;
const invocation = new RemoteAgentInvocation(
mockDefinition,
{ query: 'hi' },
mockMessageBus,
);
const executePromise = invocation.execute(
new AbortController().signal,
undefined,
{
setExecutionIdCallback: (id) => {
capturedExecutionId = id;
},
},
);
await new Promise((r) => setTimeout(r, 50));
ExecutionLifecycleService.background(capturedExecutionId!);
await executePromise;
// Let stream complete
resolveStream!();
await new Promise((r) => setTimeout(r, 50));
expect(bgListener).toHaveBeenCalledTimes(1);
const info = bgListener.mock.calls[0][0];
expect(info.executionId).toBe(capturedExecutionId);
expect(info.executionMethod).toBe('remote_agent');
expect(info.injectionText).toContain(
"Remote agent 'Test Agent' completed successfully",
);
expect(info.injectionText).toContain('Agent result');
ExecutionLifecycleService.offBackgroundComplete(bgListener);
});
it('should stop calling updateOutput after backgrounding', async () => {
mockClientManager.getClient.mockReturnValue({});
let resolveStream: () => void;
const streamBlocker = new Promise<void>((r) => {
resolveStream = r;
});
mockClientManager.sendMessageStream.mockImplementation(
async function* () {
yield {
kind: 'message',
messageId: 'msg-1',
role: 'agent',
parts: [{ kind: 'text', text: 'Before background' }],
};
await streamBlocker;
yield {
kind: 'message',
messageId: 'msg-2',
role: 'agent',
parts: [{ kind: 'text', text: 'After background' }],
};
},
);
let capturedExecutionId: number | undefined;
const updateOutput = vi.fn();
const invocation = new RemoteAgentInvocation(
mockDefinition,
{ query: 'hi' },
mockMessageBus,
);
const executePromise = invocation.execute(
new AbortController().signal,
updateOutput,
{
setExecutionIdCallback: (id) => {
capturedExecutionId = id;
},
},
);
await new Promise((r) => setTimeout(r, 50));
// Should have called updateOutput for first chunk
expect(updateOutput).toHaveBeenCalledWith('Before background');
const callCountBeforeBg = updateOutput.mock.calls.length;
// Background the execution
ExecutionLifecycleService.background(capturedExecutionId!);
await executePromise;
// Let stream finish
resolveStream!();
await new Promise((r) => setTimeout(r, 50));
// updateOutput should NOT have been called again after backgrounding
expect(updateOutput.mock.calls.length).toBe(callCountBeforeBg);
});
it('should support kill via lifecycle service', async () => {
mockClientManager.getClient.mockReturnValue({});
mockClientManager.sendMessageStream.mockImplementation(
async function* () {
yield {
kind: 'message',
messageId: 'msg-1',
role: 'agent',
parts: [{ kind: 'text', text: 'Working' }],
};
// Block forever - will be killed
await new Promise(() => {});
},
);
let capturedExecutionId: number | undefined;
const invocation = new RemoteAgentInvocation(
mockDefinition,
{ query: 'hi' },
mockMessageBus,
);
const executePromise = invocation.execute(
new AbortController().signal,
undefined,
{
setExecutionIdCallback: (id) => {
capturedExecutionId = id;
},
},
);
await new Promise((r) => setTimeout(r, 50));
expect(capturedExecutionId).toBeDefined();
// Kill the execution
ExecutionLifecycleService.kill(capturedExecutionId!);
const result = await executePromise;
expect(result.error).toBeDefined();
expect(result.error?.message).toContain('Operation cancelled');
});
});
});
+136 -26
View File
@@ -9,6 +9,8 @@ import {
type ToolConfirmationOutcome,
type ToolResult,
type ToolCallConfirmationDetails,
type BackgroundExecutionData,
type ExecuteOptions,
} from '../tools/tools.js';
import {
DEFAULT_QUERY_STRING,
@@ -28,6 +30,7 @@ import { safeJsonToMarkdown } from '../utils/markdownUtils.js';
import type { AnsiOutput } from '../utils/terminalSerializer.js';
import { A2AAuthProviderFactory } from './auth-provider/factory.js';
import { A2AAgentError } from './a2a-errors.js';
import { ExecutionLifecycleService } from '../services/executionLifecycleService.js';
/**
* A tool invocation that proxies to a remote A2A agent.
@@ -116,13 +119,122 @@ export class RemoteAgentInvocation extends BaseToolInvocation<
}
async execute(
_signal: AbortSignal,
signal: AbortSignal,
updateOutput?: (output: string | AnsiOutput) => void,
options?: ExecuteOptions,
): Promise<ToolResult> {
// 1. Ensure the agent is loaded (cached by manager)
// We assume the user has provided an access token via some mechanism (TODO),
// or we rely on ADC.
const { setExecutionIdCallback } = options ?? {};
// Create an AbortController for lifecycle kill support.
// Parent abort and lifecycle kill both funnel through this controller.
const executionAbortController = new AbortController();
if (signal.aborted) {
executionAbortController.abort();
} else {
signal.addEventListener('abort', () => executionAbortController.abort(), {
once: true,
});
}
// Register with lifecycle service as a virtual execution so this
// invocation can be backgrounded, subscribed to, and killed.
const agentLabel = this.definition.displayName ?? this.definition.name;
const handle = ExecutionLifecycleService.createExecution(
'',
() => executionAbortController.abort(),
'remote_agent',
(output, error) => {
const header = error
? `[Remote agent '${agentLabel}' completed with error: ${error.message}]`
: `[Remote agent '${agentLabel}' completed successfully]`;
return output ? `${header}\nOutput:\n${output}` : header;
},
agentLabel,
);
// createExecution always produces a valid numeric ID
const executionId = handle.pid!;
if (setExecutionIdCallback) {
setExecutionIdCallback(executionId);
}
// Guard: stop calling updateOutput after backgrounding since the
// tool call has already returned from the scheduler's perspective.
let backgrounded = false;
// Fire-and-forget: stream processing runs concurrently and settles the
// lifecycle execution on completion or error.
const streamingPromise = this.processStream(
executionId,
executionAbortController.signal,
(output) => {
if (!backgrounded && updateOutput) {
updateOutput(output);
}
},
);
// Errors are handled internally via completeExecution; prevent
// unhandled-rejection noise.
streamingPromise.catch(() => {});
// Resolves when either: (a) processStream completes/errors, or
// (b) the execution is backgrounded externally.
const result = await handle.result;
if (result.backgrounded) {
backgrounded = true;
const data: BackgroundExecutionData = {
pid: executionId,
command: `Remote agent: ${agentLabel}`,
initialOutput: result.output,
};
return {
llmContent: [
{
text: `Remote agent '${agentLabel}' moved to background (ID: ${executionId}). Use subscribe to view output.`,
},
],
returnDisplay: `Remote agent moved to background (ID: ${executionId}).`,
data,
};
}
// Error path — the lifecycle result carries the original Error instance.
if (result.error) {
const errorMessage = this.formatExecutionError(result.error);
const fullDisplay = result.output
? `${result.output}\n\n${errorMessage}`
: errorMessage;
return {
llmContent: [{ text: fullDisplay }],
returnDisplay: fullDisplay,
error: { message: errorMessage },
};
}
// Normal completion.
const finalOutput = result.output;
debugLogger.debug(
`[RemoteAgent] Final output from ${this.definition.name}: ${finalOutput.substring(0, 200)}`,
);
return {
llmContent: [{ text: finalOutput }],
returnDisplay: safeJsonToMarkdown(finalOutput),
};
}
/**
* Runs the A2A stream, feeding output deltas into the lifecycle service.
* On completion (or error) it settles the lifecycle execution so
* {@link execute}'s `handle.result` resolves.
*/
private async processStream(
executionId: number,
signal: AbortSignal,
updateOutput?: (output: string | AnsiOutput) => void,
): Promise<void> {
const reassembler = new A2AResultReassembler();
let previousOutputLength = 0;
try {
const priorState = RemoteAgentInvocation.sessionState.get(
this.definition.name,
@@ -150,21 +262,30 @@ export class RemoteAgentInvocation extends BaseToolInvocation<
{
contextId: this.contextId,
taskId: this.taskId,
signal: _signal,
signal,
},
);
let finalResponse: SendMessageResult | undefined;
for await (const chunk of stream) {
if (_signal.aborted) {
if (signal.aborted) {
throw new Error('Operation aborted');
}
finalResponse = chunk;
reassembler.update(chunk);
// Compute delta so lifecycle subscribers see incremental chunks.
const currentOutput = reassembler.toString();
const delta = currentOutput.substring(previousOutputLength);
previousOutputLength = currentOutput.length;
if (delta) {
ExecutionLifecycleService.appendOutput(executionId, delta);
}
if (updateOutput) {
updateOutput(reassembler.toString());
updateOutput(currentOutput);
}
const {
@@ -184,33 +305,22 @@ export class RemoteAgentInvocation extends BaseToolInvocation<
throw new Error('No response from remote agent.');
}
const finalOutput = reassembler.toString();
debugLogger.debug(
`[RemoteAgent] Final response from ${this.definition.name}:\n${JSON.stringify(finalResponse, null, 2)}`,
);
return {
llmContent: [{ text: finalOutput }],
returnDisplay: safeJsonToMarkdown(finalOutput),
};
ExecutionLifecycleService.completeExecution(executionId);
} catch (error: unknown) {
const partialOutput = reassembler.toString();
// Surface structured, user-friendly error messages.
const errorMessage = this.formatExecutionError(error);
const fullDisplay = partialOutput
? `${partialOutput}\n\n${errorMessage}`
: errorMessage;
return {
llmContent: [{ text: fullDisplay }],
returnDisplay: fullDisplay,
error: { message: errorMessage },
};
ExecutionLifecycleService.completeExecution(executionId, {
error: error instanceof Error ? error : new Error(String(error)),
});
} finally {
// Persist state even on partial failures or aborts to maintain conversational continuity.
// Persist conversational state. On abort/kill the task was interrupted
// so clear taskId (next invocation starts a fresh task), but keep
// contextId to maintain the conversation with the remote agent.
RemoteAgentInvocation.sessionState.set(this.definition.name, {
contextId: this.contextId,
taskId: this.taskId,
taskId: signal.aborted ? undefined : this.taskId,
});
}
}