openclaw/src/agents/subagent-announce.format.te...

1878 lines
67 KiB
TypeScript

import { afterAll, beforeAll, beforeEach, describe, expect, it, vi } from "vitest";
import { SILENT_REPLY_TOKEN } from "../auto-reply/tokens.js";
import {
__testing as sessionBindingServiceTesting,
registerSessionBindingAdapter,
} from "../infra/outbound/session-binding-service.js";
type AgentCallRequest = { method?: string; params?: Record<string, unknown> };
type RequesterResolution = {
requesterSessionKey: string;
requesterOrigin?: Record<string, unknown>;
} | null;
type SubagentDeliveryTargetResult = {
origin?: {
channel?: string;
accountId?: string;
to?: string;
threadId?: string | number;
};
};
const agentSpy = vi.fn(async (_req: AgentCallRequest) => ({ runId: "run-main", status: "ok" }));
const sendSpy = vi.fn(async (_req: AgentCallRequest) => ({ runId: "send-main", status: "ok" }));
const sessionsDeleteSpy = vi.fn((_req: AgentCallRequest) => undefined);
const readLatestAssistantReplyMock = vi.fn(
async (_sessionKey?: string): Promise<string | undefined> => "raw subagent reply",
);
const embeddedRunMock = {
isEmbeddedPiRunActive: vi.fn(() => false),
isEmbeddedPiRunStreaming: vi.fn(() => false),
queueEmbeddedPiMessage: vi.fn(() => false),
waitForEmbeddedPiRunEnd: vi.fn(async () => true),
};
const subagentRegistryMock = {
isSubagentSessionRunActive: vi.fn(() => true),
countActiveDescendantRuns: vi.fn((_sessionKey: string) => 0),
resolveRequesterForChildSession: vi.fn((_sessionKey: string): RequesterResolution => null),
};
const subagentDeliveryTargetHookMock = vi.fn(
async (_event?: unknown, _ctx?: unknown): Promise<SubagentDeliveryTargetResult | undefined> =>
undefined,
);
let hasSubagentDeliveryTargetHook = false;
const hookRunnerMock = {
hasHooks: vi.fn(
(hookName: string) => hookName === "subagent_delivery_target" && hasSubagentDeliveryTargetHook,
),
runSubagentDeliveryTarget: vi.fn((event: unknown, ctx: unknown) =>
subagentDeliveryTargetHookMock(event, ctx),
),
};
const chatHistoryMock = vi.fn(async (_sessionKey?: string) => ({
messages: [] as Array<unknown>,
}));
let sessionStore: Record<string, Record<string, unknown>> = {};
let configOverride: ReturnType<(typeof import("../config/config.js"))["loadConfig"]> = {
session: {
mainKey: "main",
scope: "per-sender",
},
};
const defaultOutcomeAnnounce = {
task: "do thing",
timeoutMs: 10,
cleanup: "keep" as const,
waitForCompletion: false,
startedAt: 10,
endedAt: 20,
outcome: { status: "ok" } as const,
};
async function getSingleAgentCallParams() {
expect(agentSpy).toHaveBeenCalledTimes(1);
const call = agentSpy.mock.calls[0]?.[0] as { params?: Record<string, unknown> };
return call?.params ?? {};
}
function loadSessionStoreFixture(): Record<string, Record<string, unknown>> {
return new Proxy(sessionStore, {
get(target, key: string | symbol) {
if (typeof key === "string" && !(key in target) && key.includes(":subagent:")) {
return { inputTokens: 1, outputTokens: 1, totalTokens: 2 };
}
return target[key as keyof typeof target];
},
});
}
vi.mock("../gateway/call.js", () => ({
callGateway: vi.fn(async (req: unknown) => {
const typed = req as { method?: string; params?: { message?: string; sessionKey?: string } };
if (typed.method === "agent") {
return await agentSpy(typed);
}
if (typed.method === "send") {
return await sendSpy(typed);
}
if (typed.method === "agent.wait") {
return { status: "error", startedAt: 10, endedAt: 20, error: "boom" };
}
if (typed.method === "chat.history") {
return await chatHistoryMock(typed.params?.sessionKey);
}
if (typed.method === "sessions.patch") {
return {};
}
if (typed.method === "sessions.delete") {
sessionsDeleteSpy(typed);
return {};
}
return {};
}),
}));
vi.mock("./tools/agent-step.js", () => ({
readLatestAssistantReply: readLatestAssistantReplyMock,
}));
vi.mock("../config/sessions.js", () => ({
loadSessionStore: vi.fn(() => loadSessionStoreFixture()),
resolveAgentIdFromSessionKey: () => "main",
resolveStorePath: () => "/tmp/sessions.json",
resolveMainSessionKey: () => "agent:main:main",
readSessionUpdatedAt: vi.fn(() => undefined),
recordSessionMetaFromInbound: vi.fn().mockResolvedValue(undefined),
}));
vi.mock("./pi-embedded.js", () => embeddedRunMock);
vi.mock("./subagent-registry.js", () => subagentRegistryMock);
vi.mock("../plugins/hook-runner-global.js", () => ({
getGlobalHookRunner: () => hookRunnerMock,
}));
vi.mock("../config/config.js", async (importOriginal) => {
const actual = await importOriginal<typeof import("../config/config.js")>();
return {
...actual,
loadConfig: () => configOverride,
};
});
describe("subagent announce formatting", () => {
let previousFastTestEnv: string | undefined;
let runSubagentAnnounceFlow: (typeof import("./subagent-announce.js"))["runSubagentAnnounceFlow"];
beforeAll(async () => {
({ runSubagentAnnounceFlow } = await import("./subagent-announce.js"));
previousFastTestEnv = process.env.OPENCLAW_TEST_FAST;
});
afterAll(() => {
if (previousFastTestEnv === undefined) {
delete process.env.OPENCLAW_TEST_FAST;
return;
}
process.env.OPENCLAW_TEST_FAST = previousFastTestEnv;
});
beforeEach(() => {
vi.stubEnv("OPENCLAW_TEST_FAST", "1");
agentSpy
.mockClear()
.mockImplementation(async (_req: AgentCallRequest) => ({ runId: "run-main", status: "ok" }));
sendSpy
.mockClear()
.mockImplementation(async (_req: AgentCallRequest) => ({ runId: "send-main", status: "ok" }));
sessionsDeleteSpy.mockClear().mockImplementation((_req: AgentCallRequest) => undefined);
embeddedRunMock.isEmbeddedPiRunActive.mockClear().mockReturnValue(false);
embeddedRunMock.isEmbeddedPiRunStreaming.mockClear().mockReturnValue(false);
embeddedRunMock.queueEmbeddedPiMessage.mockClear().mockReturnValue(false);
embeddedRunMock.waitForEmbeddedPiRunEnd.mockClear().mockResolvedValue(true);
subagentRegistryMock.isSubagentSessionRunActive.mockClear().mockReturnValue(true);
subagentRegistryMock.countActiveDescendantRuns.mockClear().mockReturnValue(0);
subagentRegistryMock.resolveRequesterForChildSession.mockClear().mockReturnValue(null);
hasSubagentDeliveryTargetHook = false;
hookRunnerMock.hasHooks.mockClear();
hookRunnerMock.runSubagentDeliveryTarget.mockClear();
subagentDeliveryTargetHookMock.mockReset().mockResolvedValue(undefined);
readLatestAssistantReplyMock.mockClear().mockResolvedValue("raw subagent reply");
chatHistoryMock.mockReset().mockResolvedValue({ messages: [] });
sessionStore = {};
sessionBindingServiceTesting.resetSessionBindingAdaptersForTests();
configOverride = {
session: {
mainKey: "main",
scope: "per-sender",
},
};
});
it("sends instructional message to main agent with status and findings", async () => {
sessionStore = {
"agent:main:subagent:test": {
sessionId: "child-session-123",
inputTokens: 1,
outputTokens: 1,
totalTokens: 2,
},
};
await runSubagentAnnounceFlow({
childSessionKey: "agent:main:subagent:test",
childRunId: "run-123",
requesterSessionKey: "agent:main:main",
requesterDisplayKey: "main",
task: "do thing",
timeoutMs: 1000,
cleanup: "keep",
waitForCompletion: true,
startedAt: 10,
endedAt: 20,
});
expect(agentSpy).toHaveBeenCalled();
const call = agentSpy.mock.calls[0]?.[0] as {
params?: { message?: string; sessionKey?: string };
};
const msg = call?.params?.message as string;
expect(call?.params?.sessionKey).toBe("agent:main:main");
expect(msg).toContain("[System Message]");
expect(msg).toContain("[sessionId: child-session-123]");
expect(msg).toContain("subagent task");
expect(msg).toContain("failed");
expect(msg).toContain("boom");
expect(msg).toContain("Result:");
expect(msg).toContain("raw subagent reply");
expect(msg).toContain("Stats:");
expect(msg).toContain("A completed subagent task is ready for user delivery.");
expect(msg).toContain("Convert the result above into your normal assistant voice");
expect(msg).toContain("Keep this internal context private");
});
it("includes success status when outcome is ok", async () => {
// Use waitForCompletion: false so it uses the provided outcome instead of calling agent.wait
await runSubagentAnnounceFlow({
childSessionKey: "agent:main:subagent:test",
childRunId: "run-456",
requesterSessionKey: "agent:main:main",
requesterDisplayKey: "main",
...defaultOutcomeAnnounce,
});
const call = agentSpy.mock.calls[0]?.[0] as { params?: { message?: string } };
const msg = call?.params?.message as string;
expect(msg).toContain("completed successfully");
});
it("uses child-run announce identity for direct idempotency", async () => {
await runSubagentAnnounceFlow({
childSessionKey: "agent:main:subagent:worker",
childRunId: "run-direct-idem",
requesterSessionKey: "agent:main:main",
requesterDisplayKey: "main",
...defaultOutcomeAnnounce,
});
const call = agentSpy.mock.calls[0]?.[0] as { params?: Record<string, unknown> };
expect(call?.params?.idempotencyKey).toBe(
"announce:v1:agent:main:subagent:worker:run-direct-idem",
);
});
it.each([
{ role: "toolResult", toolOutput: "tool output line 1", childRunId: "run-tool-fallback-1" },
{ role: "tool", toolOutput: "tool output line 2", childRunId: "run-tool-fallback-2" },
] as const)(
"falls back to latest $role output when assistant reply is empty",
async (testCase) => {
chatHistoryMock.mockResolvedValueOnce({
messages: [
{
role: "assistant",
content: [{ type: "text", text: "" }],
},
{
role: testCase.role,
content: [{ type: "text", text: testCase.toolOutput }],
},
],
});
readLatestAssistantReplyMock.mockResolvedValue("");
await runSubagentAnnounceFlow({
childSessionKey: "agent:main:subagent:worker",
childRunId: testCase.childRunId,
requesterSessionKey: "agent:main:main",
requesterDisplayKey: "main",
...defaultOutcomeAnnounce,
waitForCompletion: false,
});
const call = agentSpy.mock.calls[0]?.[0] as { params?: { message?: string } };
const msg = call?.params?.message as string;
expect(msg).toContain(testCase.toolOutput);
},
);
it("uses latest assistant text when it appears after a tool output", async () => {
chatHistoryMock.mockResolvedValueOnce({
messages: [
{
role: "tool",
content: [{ type: "text", text: "tool output line" }],
},
{
role: "assistant",
content: [{ type: "text", text: "assistant final line" }],
},
],
});
readLatestAssistantReplyMock.mockResolvedValue("");
await runSubagentAnnounceFlow({
childSessionKey: "agent:main:subagent:worker",
childRunId: "run-latest-assistant",
requesterSessionKey: "agent:main:main",
requesterDisplayKey: "main",
...defaultOutcomeAnnounce,
waitForCompletion: false,
});
const call = agentSpy.mock.calls[0]?.[0] as { params?: { message?: string } };
const msg = call?.params?.message as string;
expect(msg).toContain("assistant final line");
});
it("keeps full findings and includes compact stats", async () => {
sessionStore = {
"agent:main:subagent:test": {
sessionId: "child-session-usage",
inputTokens: 12,
outputTokens: 1000,
totalTokens: 197000,
},
};
readLatestAssistantReplyMock.mockResolvedValue(
Array.from({ length: 140 }, (_, index) => `step-${index}`).join(" "),
);
await runSubagentAnnounceFlow({
childSessionKey: "agent:main:subagent:test",
childRunId: "run-usage",
requesterSessionKey: "agent:main:main",
requesterDisplayKey: "main",
...defaultOutcomeAnnounce,
});
const call = agentSpy.mock.calls[0]?.[0] as { params?: { message?: string } };
const msg = call?.params?.message as string;
expect(msg).toContain("Result:");
expect(msg).toContain("Stats:");
expect(msg).toContain("tokens 1.0k (in 12 / out 1.0k)");
expect(msg).toContain("prompt/cache 197.0k");
expect(msg).toContain("[sessionId: child-session-usage]");
expect(msg).toContain("A completed subagent task is ready for user delivery.");
expect(msg).toContain(
`Reply ONLY: ${SILENT_REPLY_TOKEN} if this exact result was already delivered to the user in this same turn.`,
);
expect(msg).toContain("step-0");
expect(msg).toContain("step-139");
});
it("sends deterministic completion message directly for manual spawn completion", async () => {
sessionStore = {
"agent:main:subagent:test": {
sessionId: "child-session-direct",
inputTokens: 12,
outputTokens: 34,
totalTokens: 46,
},
"agent:main:main": {
sessionId: "requester-session",
},
};
chatHistoryMock.mockResolvedValueOnce({
messages: [{ role: "assistant", content: [{ type: "text", text: "final answer: 2" }] }],
});
readLatestAssistantReplyMock.mockResolvedValue("");
const didAnnounce = await runSubagentAnnounceFlow({
childSessionKey: "agent:main:subagent:test",
childRunId: "run-direct-completion",
requesterSessionKey: "agent:main:main",
requesterDisplayKey: "main",
requesterOrigin: { channel: "discord", to: "channel:12345", accountId: "acct-1" },
...defaultOutcomeAnnounce,
expectsCompletionMessage: true,
});
expect(didAnnounce).toBe(true);
expect(sendSpy).toHaveBeenCalledTimes(1);
expect(agentSpy).not.toHaveBeenCalled();
const call = sendSpy.mock.calls[0]?.[0] as { params?: Record<string, unknown> };
const rawMessage = call?.params?.message;
const msg = typeof rawMessage === "string" ? rawMessage : "";
expect(call?.params?.channel).toBe("discord");
expect(call?.params?.to).toBe("channel:12345");
expect(call?.params?.sessionKey).toBe("agent:main:main");
expect(msg).toContain("✅ Subagent main finished");
expect(msg).toContain("final answer: 2");
expect(msg).not.toContain("Convert the result above into your normal assistant voice");
});
it("suppresses completion delivery when subagent reply is ANNOUNCE_SKIP", async () => {
const didAnnounce = await runSubagentAnnounceFlow({
childSessionKey: "agent:main:subagent:test",
childRunId: "run-direct-completion-skip",
requesterSessionKey: "agent:main:main",
requesterDisplayKey: "main",
requesterOrigin: { channel: "discord", to: "channel:12345", accountId: "acct-1" },
...defaultOutcomeAnnounce,
expectsCompletionMessage: true,
roundOneReply: "ANNOUNCE_SKIP",
});
expect(didAnnounce).toBe(true);
expect(sendSpy).not.toHaveBeenCalled();
expect(agentSpy).not.toHaveBeenCalled();
});
it("suppresses announce flow for whitespace-padded ANNOUNCE_SKIP and still runs cleanup", async () => {
const didAnnounce = await runSubagentAnnounceFlow({
childSessionKey: "agent:main:subagent:test",
childRunId: "run-direct-skip-whitespace",
requesterSessionKey: "agent:main:main",
requesterDisplayKey: "main",
...defaultOutcomeAnnounce,
cleanup: "delete",
roundOneReply: " ANNOUNCE_SKIP ",
});
expect(didAnnounce).toBe(true);
expect(sendSpy).not.toHaveBeenCalled();
expect(agentSpy).not.toHaveBeenCalled();
expect(sessionsDeleteSpy).toHaveBeenCalledTimes(1);
});
it("suppresses completion delivery when subagent reply is NO_REPLY", async () => {
const didAnnounce = await runSubagentAnnounceFlow({
childSessionKey: "agent:main:subagent:test",
childRunId: "run-direct-completion-no-reply",
requesterSessionKey: "agent:main:main",
requesterDisplayKey: "main",
requesterOrigin: { channel: "slack", to: "channel:C123", accountId: "acct-1" },
...defaultOutcomeAnnounce,
expectsCompletionMessage: true,
roundOneReply: " NO_REPLY ",
});
expect(didAnnounce).toBe(true);
expect(sendSpy).not.toHaveBeenCalled();
expect(agentSpy).not.toHaveBeenCalled();
});
it("retries completion direct send on transient channel-unavailable errors", async () => {
sendSpy
.mockRejectedValueOnce(new Error("Error: No active WhatsApp Web listener (account: default)"))
.mockRejectedValueOnce(new Error("UNAVAILABLE: listener reconnecting"))
.mockResolvedValueOnce({ runId: "send-main", status: "ok" });
const didAnnounce = await runSubagentAnnounceFlow({
childSessionKey: "agent:main:subagent:test",
childRunId: "run-direct-completion-retry",
requesterSessionKey: "agent:main:main",
requesterDisplayKey: "main",
requesterOrigin: { channel: "whatsapp", to: "+15550000000", accountId: "default" },
...defaultOutcomeAnnounce,
expectsCompletionMessage: true,
roundOneReply: "final answer",
});
expect(didAnnounce).toBe(true);
expect(sendSpy).toHaveBeenCalledTimes(3);
expect(agentSpy).not.toHaveBeenCalled();
});
it("does not retry completion direct send on permanent channel errors", async () => {
sendSpy.mockRejectedValueOnce(new Error("unsupported channel: telegram"));
const didAnnounce = await runSubagentAnnounceFlow({
childSessionKey: "agent:main:subagent:test",
childRunId: "run-direct-completion-no-retry",
requesterSessionKey: "agent:main:main",
requesterDisplayKey: "main",
requesterOrigin: { channel: "telegram", to: "telegram:1234" },
...defaultOutcomeAnnounce,
expectsCompletionMessage: true,
roundOneReply: "final answer",
});
expect(didAnnounce).toBe(false);
expect(sendSpy).toHaveBeenCalledTimes(1);
expect(agentSpy).not.toHaveBeenCalled();
});
it("retries direct agent announce on transient channel-unavailable errors", async () => {
agentSpy
.mockRejectedValueOnce(new Error("No active WhatsApp Web listener (account: default)"))
.mockRejectedValueOnce(new Error("UNAVAILABLE: delivery temporarily unavailable"))
.mockResolvedValueOnce({ runId: "run-main", status: "ok" });
const didAnnounce = await runSubagentAnnounceFlow({
childSessionKey: "agent:main:subagent:test",
childRunId: "run-direct-agent-retry",
requesterSessionKey: "agent:main:main",
requesterDisplayKey: "main",
requesterOrigin: { channel: "whatsapp", to: "+15551112222", accountId: "default" },
...defaultOutcomeAnnounce,
roundOneReply: "worker result",
});
expect(didAnnounce).toBe(true);
expect(agentSpy).toHaveBeenCalledTimes(3);
expect(sendSpy).not.toHaveBeenCalled();
});
it("keeps completion-mode delivery coordinated when sibling runs are still active", async () => {
sessionStore = {
"agent:main:subagent:test": {
sessionId: "child-session-coordinated",
},
"agent:main:main": {
sessionId: "requester-session-coordinated",
},
};
chatHistoryMock.mockResolvedValueOnce({
messages: [{ role: "assistant", content: [{ type: "text", text: "final answer: 2" }] }],
});
subagentRegistryMock.countActiveDescendantRuns.mockImplementation((sessionKey: string) =>
sessionKey === "agent:main:main" ? 1 : 0,
);
const didAnnounce = await runSubagentAnnounceFlow({
childSessionKey: "agent:main:subagent:test",
childRunId: "run-direct-coordinated",
requesterSessionKey: "agent:main:main",
requesterDisplayKey: "main",
requesterOrigin: { channel: "discord", to: "channel:12345", accountId: "acct-1" },
...defaultOutcomeAnnounce,
expectsCompletionMessage: true,
});
expect(didAnnounce).toBe(true);
expect(sendSpy).not.toHaveBeenCalled();
expect(agentSpy).toHaveBeenCalledTimes(1);
const call = agentSpy.mock.calls[0]?.[0] as { params?: Record<string, unknown> };
const rawMessage = call?.params?.message;
const msg = typeof rawMessage === "string" ? rawMessage : "";
expect(call?.params?.channel).toBe("discord");
expect(call?.params?.to).toBe("channel:12345");
expect(msg).toContain("There are still 1 active subagent run for this session.");
expect(msg).toContain(
"If they are part of the same workflow, wait for the remaining results before sending a user update.",
);
});
it("keeps session-mode completion delivery on the bound destination when sibling runs are active", async () => {
sessionStore = {
"agent:main:subagent:test": {
sessionId: "child-session-bound",
},
"agent:main:main": {
sessionId: "requester-session-bound",
},
};
chatHistoryMock.mockResolvedValueOnce({
messages: [{ role: "assistant", content: [{ type: "text", text: "bound answer: 2" }] }],
});
subagentRegistryMock.countActiveDescendantRuns.mockImplementation((sessionKey: string) =>
sessionKey === "agent:main:main" ? 1 : 0,
);
registerSessionBindingAdapter({
channel: "discord",
accountId: "acct-1",
listBySession: (targetSessionKey: string) =>
targetSessionKey === "agent:main:subagent:test"
? [
{
bindingId: "discord:acct-1:thread-bound-1",
targetSessionKey,
targetKind: "subagent",
conversation: {
channel: "discord",
accountId: "acct-1",
conversationId: "thread-bound-1",
parentConversationId: "parent-main",
},
status: "active",
boundAt: Date.now(),
},
]
: [],
resolveByConversation: () => null,
});
const didAnnounce = await runSubagentAnnounceFlow({
childSessionKey: "agent:main:subagent:test",
childRunId: "run-session-bound-direct",
requesterSessionKey: "agent:main:main",
requesterDisplayKey: "main",
requesterOrigin: { channel: "discord", to: "channel:12345", accountId: "acct-1" },
...defaultOutcomeAnnounce,
expectsCompletionMessage: true,
spawnMode: "session",
});
expect(didAnnounce).toBe(true);
expect(sendSpy).toHaveBeenCalledTimes(1);
expect(agentSpy).not.toHaveBeenCalled();
const call = sendSpy.mock.calls[0]?.[0] as { params?: Record<string, unknown> };
expect(call?.params?.channel).toBe("discord");
expect(call?.params?.to).toBe("channel:thread-bound-1");
});
it("does not duplicate to main channel when two active bound sessions complete from the same requester channel", async () => {
sessionStore = {
"agent:main:subagent:child-a": {
sessionId: "child-session-a",
},
"agent:main:subagent:child-b": {
sessionId: "child-session-b",
},
"agent:main:main": {
sessionId: "requester-session-main",
},
};
// Simulate active sibling runs so non-bound paths would normally coordinate via agent().
subagentRegistryMock.countActiveDescendantRuns.mockImplementation((sessionKey: string) =>
sessionKey === "agent:main:main" ? 2 : 0,
);
registerSessionBindingAdapter({
channel: "discord",
accountId: "acct-1",
listBySession: (targetSessionKey: string) => {
if (targetSessionKey === "agent:main:subagent:child-a") {
return [
{
bindingId: "discord:acct-1:thread-child-a",
targetSessionKey,
targetKind: "subagent",
conversation: {
channel: "discord",
accountId: "acct-1",
conversationId: "thread-child-a",
parentConversationId: "main-parent-channel",
},
status: "active",
boundAt: Date.now(),
},
];
}
if (targetSessionKey === "agent:main:subagent:child-b") {
return [
{
bindingId: "discord:acct-1:thread-child-b",
targetSessionKey,
targetKind: "subagent",
conversation: {
channel: "discord",
accountId: "acct-1",
conversationId: "thread-child-b",
parentConversationId: "main-parent-channel",
},
status: "active",
boundAt: Date.now(),
},
];
}
return [];
},
resolveByConversation: () => null,
});
await Promise.all([
runSubagentAnnounceFlow({
childSessionKey: "agent:main:subagent:child-a",
childRunId: "run-child-a",
requesterSessionKey: "agent:main:main",
requesterDisplayKey: "main",
requesterOrigin: {
channel: "discord",
to: "channel:main-parent-channel",
accountId: "acct-1",
},
...defaultOutcomeAnnounce,
expectsCompletionMessage: true,
spawnMode: "session",
}),
runSubagentAnnounceFlow({
childSessionKey: "agent:main:subagent:child-b",
childRunId: "run-child-b",
requesterSessionKey: "agent:main:main",
requesterDisplayKey: "main",
requesterOrigin: {
channel: "discord",
to: "channel:main-parent-channel",
accountId: "acct-1",
},
...defaultOutcomeAnnounce,
expectsCompletionMessage: true,
spawnMode: "session",
}),
]);
expect(sendSpy).toHaveBeenCalledTimes(2);
expect(agentSpy).not.toHaveBeenCalled();
const directTargets = sendSpy.mock.calls.map(
(call) => (call?.[0] as { params?: { to?: string } })?.params?.to,
);
expect(directTargets).toEqual(
expect.arrayContaining(["channel:thread-child-a", "channel:thread-child-b"]),
);
expect(directTargets).not.toContain("channel:main-parent-channel");
});
it("uses completion direct-send headers for error and timeout outcomes", async () => {
const cases = [
{
childSessionId: "child-session-direct-error",
requesterSessionId: "requester-session-error",
childRunId: "run-direct-completion-error",
replyText: "boom details",
outcome: { status: "error", error: "boom" } as const,
expectedHeader: "❌ Subagent main failed this task (session remains active)",
excludedHeader: "✅ Subagent main",
spawnMode: "session" as const,
},
{
childSessionId: "child-session-direct-timeout",
requesterSessionId: "requester-session-timeout",
childRunId: "run-direct-completion-timeout",
replyText: "partial output",
outcome: { status: "timeout" } as const,
expectedHeader: "⏱️ Subagent main timed out",
excludedHeader: "✅ Subagent main finished",
spawnMode: undefined,
},
] as const;
for (const testCase of cases) {
sendSpy.mockClear();
sessionStore = {
"agent:main:subagent:test": {
sessionId: testCase.childSessionId,
},
"agent:main:main": {
sessionId: testCase.requesterSessionId,
},
};
chatHistoryMock.mockResolvedValueOnce({
messages: [{ role: "assistant", content: [{ type: "text", text: testCase.replyText }] }],
});
readLatestAssistantReplyMock.mockResolvedValue("");
const didAnnounce = await runSubagentAnnounceFlow({
childSessionKey: "agent:main:subagent:test",
childRunId: testCase.childRunId,
requesterSessionKey: "agent:main:main",
requesterDisplayKey: "main",
requesterOrigin: { channel: "discord", to: "channel:12345", accountId: "acct-1" },
...defaultOutcomeAnnounce,
outcome: testCase.outcome,
expectsCompletionMessage: true,
...(testCase.spawnMode ? { spawnMode: testCase.spawnMode } : {}),
});
expect(didAnnounce).toBe(true);
expect(sendSpy).toHaveBeenCalledTimes(1);
const call = sendSpy.mock.calls[0]?.[0] as { params?: Record<string, unknown> };
const rawMessage = call?.params?.message;
const msg = typeof rawMessage === "string" ? rawMessage : "";
expect(msg).toContain(testCase.expectedHeader);
expect(msg).toContain(testCase.replyText);
expect(msg).not.toContain(testCase.excludedHeader);
}
});
it("routes manual completion direct-send using requester thread hints", async () => {
const cases = [
{
childSessionId: "child-session-direct-thread",
requesterSessionId: "requester-session-thread",
childRunId: "run-direct-stale-thread",
requesterOrigin: { channel: "discord", to: "channel:12345", accountId: "acct-1" },
requesterSessionMeta: {
lastChannel: "discord",
lastTo: "channel:stale",
lastThreadId: 42,
},
expectedThreadId: undefined,
},
{
childSessionId: "child-session-direct-thread-pass",
requesterSessionId: "requester-session-thread-pass",
childRunId: "run-direct-thread-pass",
requesterOrigin: {
channel: "discord",
to: "channel:12345",
accountId: "acct-1",
threadId: 99,
},
requesterSessionMeta: {},
expectedThreadId: "99",
},
] as const;
for (const testCase of cases) {
sendSpy.mockClear();
agentSpy.mockClear();
sessionStore = {
"agent:main:subagent:test": {
sessionId: testCase.childSessionId,
},
"agent:main:main": {
sessionId: testCase.requesterSessionId,
...testCase.requesterSessionMeta,
},
};
chatHistoryMock.mockResolvedValueOnce({
messages: [{ role: "assistant", content: [{ type: "text", text: "done" }] }],
});
const didAnnounce = await runSubagentAnnounceFlow({
childSessionKey: "agent:main:subagent:test",
childRunId: testCase.childRunId,
requesterSessionKey: "agent:main:main",
requesterDisplayKey: "main",
requesterOrigin: testCase.requesterOrigin,
...defaultOutcomeAnnounce,
expectsCompletionMessage: true,
});
expect(didAnnounce).toBe(true);
expect(sendSpy).toHaveBeenCalledTimes(1);
expect(agentSpy).not.toHaveBeenCalled();
const call = sendSpy.mock.calls[0]?.[0] as { params?: Record<string, unknown> };
expect(call?.params?.channel).toBe("discord");
expect(call?.params?.to).toBe("channel:12345");
expect(call?.params?.threadId).toBe(testCase.expectedThreadId);
}
});
it("routes manual completion direct-send for telegram forum topics", async () => {
sendSpy.mockClear();
agentSpy.mockClear();
sessionStore = {
"agent:main:subagent:test": {
sessionId: "child-session-telegram-topic",
},
"agent:main:main": {
sessionId: "requester-session-telegram-topic",
lastChannel: "telegram",
lastTo: "123:topic:999",
lastThreadId: 999,
},
};
chatHistoryMock.mockResolvedValueOnce({
messages: [{ role: "assistant", content: [{ type: "text", text: "done" }] }],
});
const didAnnounce = await runSubagentAnnounceFlow({
childSessionKey: "agent:main:subagent:test",
childRunId: "run-direct-telegram-topic",
requesterSessionKey: "agent:main:main",
requesterDisplayKey: "main",
requesterOrigin: {
channel: "telegram",
to: "123",
threadId: 42,
},
...defaultOutcomeAnnounce,
expectsCompletionMessage: true,
});
expect(didAnnounce).toBe(true);
expect(sendSpy).toHaveBeenCalledTimes(1);
expect(agentSpy).not.toHaveBeenCalled();
const call = sendSpy.mock.calls[0]?.[0] as { params?: Record<string, unknown> };
expect(call?.params?.channel).toBe("telegram");
expect(call?.params?.to).toBe("123");
expect(call?.params?.threadId).toBe("42");
});
it("uses hook-provided thread target across requester thread variants", async () => {
const cases = [
{
childRunId: "run-direct-thread-bound",
requesterOrigin: {
channel: "discord",
to: "channel:12345",
accountId: "acct-1",
threadId: "777",
},
},
{
childRunId: "run-direct-thread-bound-single",
requesterOrigin: {
channel: "discord",
to: "channel:12345",
accountId: "acct-1",
},
},
{
childRunId: "run-direct-thread-no-match",
requesterOrigin: {
channel: "discord",
to: "channel:12345",
accountId: "acct-1",
threadId: "999",
},
},
] as const;
for (const testCase of cases) {
sendSpy.mockClear();
hasSubagentDeliveryTargetHook = true;
subagentDeliveryTargetHookMock.mockResolvedValueOnce({
origin: {
channel: "discord",
accountId: "acct-1",
to: "channel:777",
threadId: "777",
},
});
const didAnnounce = await runSubagentAnnounceFlow({
childSessionKey: "agent:main:subagent:test",
childRunId: testCase.childRunId,
requesterSessionKey: "agent:main:main",
requesterDisplayKey: "main",
requesterOrigin: testCase.requesterOrigin,
...defaultOutcomeAnnounce,
expectsCompletionMessage: true,
spawnMode: "session",
});
expect(didAnnounce).toBe(true);
expect(subagentDeliveryTargetHookMock).toHaveBeenCalledWith(
{
childSessionKey: "agent:main:subagent:test",
requesterSessionKey: "agent:main:main",
requesterOrigin: testCase.requesterOrigin,
childRunId: testCase.childRunId,
spawnMode: "session",
expectsCompletionMessage: true,
},
{
runId: testCase.childRunId,
childSessionKey: "agent:main:subagent:test",
requesterSessionKey: "agent:main:main",
},
);
expect(sendSpy).toHaveBeenCalledTimes(1);
const call = sendSpy.mock.calls[0]?.[0] as { params?: Record<string, unknown> };
expect(call?.params?.channel).toBe("discord");
expect(call?.params?.to).toBe("channel:777");
expect(call?.params?.threadId).toBe("777");
const message = typeof call?.params?.message === "string" ? call.params.message : "";
expect(message).toContain("completed this task (session remains active)");
expect(message).not.toContain("finished");
}
});
it.each([
{
name: "delivery-target hook returns no override",
childRunId: "run-direct-thread-persisted",
hookResult: undefined,
},
{
name: "delivery-target hook returns non-deliverable channel",
childRunId: "run-direct-thread-multi-no-origin",
hookResult: {
origin: {
channel: "webchat",
to: "conversation:123",
},
},
},
])("keeps requester origin when $name", async ({ childRunId, hookResult }) => {
hasSubagentDeliveryTargetHook = true;
subagentDeliveryTargetHookMock.mockResolvedValueOnce(hookResult);
const didAnnounce = await runSubagentAnnounceFlow({
childSessionKey: "agent:main:subagent:test",
childRunId,
requesterSessionKey: "agent:main:main",
requesterDisplayKey: "main",
requesterOrigin: {
channel: "discord",
to: "channel:12345",
accountId: "acct-1",
},
...defaultOutcomeAnnounce,
expectsCompletionMessage: true,
spawnMode: "session",
});
expect(didAnnounce).toBe(true);
expect(sendSpy).toHaveBeenCalledTimes(1);
const call = sendSpy.mock.calls[0]?.[0] as { params?: Record<string, unknown> };
expect(call?.params?.channel).toBe("discord");
expect(call?.params?.to).toBe("channel:12345");
expect(call?.params?.threadId).toBeUndefined();
});
it("steers announcements into an active run when queue mode is steer", async () => {
embeddedRunMock.isEmbeddedPiRunActive.mockReturnValue(true);
embeddedRunMock.isEmbeddedPiRunStreaming.mockReturnValue(true);
embeddedRunMock.queueEmbeddedPiMessage.mockReturnValue(true);
sessionStore = {
"agent:main:main": {
sessionId: "session-123",
lastChannel: "whatsapp",
lastTo: "+1555",
queueMode: "steer",
},
};
const didAnnounce = await runSubagentAnnounceFlow({
childSessionKey: "agent:main:subagent:test",
childRunId: "run-789",
requesterSessionKey: "main",
requesterDisplayKey: "main",
...defaultOutcomeAnnounce,
});
expect(didAnnounce).toBe(true);
expect(embeddedRunMock.queueEmbeddedPiMessage).toHaveBeenCalledWith(
"session-123",
expect.stringContaining("[System Message]"),
);
expect(agentSpy).not.toHaveBeenCalled();
});
it("queues announce delivery with origin account routing", async () => {
embeddedRunMock.isEmbeddedPiRunActive.mockReturnValue(true);
embeddedRunMock.isEmbeddedPiRunStreaming.mockReturnValue(false);
sessionStore = {
"agent:main:main": {
sessionId: "session-456",
lastChannel: "whatsapp",
lastTo: "+1555",
lastAccountId: "kev",
queueMode: "collect",
queueDebounceMs: 0,
},
};
const didAnnounce = await runSubagentAnnounceFlow({
childSessionKey: "agent:main:subagent:test",
childRunId: "run-999",
requesterSessionKey: "main",
requesterDisplayKey: "main",
...defaultOutcomeAnnounce,
});
expect(didAnnounce).toBe(true);
const params = await getSingleAgentCallParams();
expect(params.channel).toBe("whatsapp");
expect(params.to).toBe("+1555");
expect(params.accountId).toBe("kev");
});
it("keeps queued idempotency unique for same-ms distinct child runs", async () => {
embeddedRunMock.isEmbeddedPiRunActive.mockReturnValue(true);
embeddedRunMock.isEmbeddedPiRunStreaming.mockReturnValue(false);
sessionStore = {
"agent:main:main": {
sessionId: "session-followup",
lastChannel: "whatsapp",
lastTo: "+1555",
queueMode: "followup",
queueDebounceMs: 0,
},
};
const nowSpy = vi.spyOn(Date, "now").mockReturnValue(1_700_000_000_000);
try {
await runSubagentAnnounceFlow({
childSessionKey: "agent:main:subagent:worker",
childRunId: "run-1",
requesterSessionKey: "main",
requesterDisplayKey: "main",
...defaultOutcomeAnnounce,
task: "first task",
});
await runSubagentAnnounceFlow({
childSessionKey: "agent:main:subagent:worker",
childRunId: "run-2",
requesterSessionKey: "main",
requesterDisplayKey: "main",
...defaultOutcomeAnnounce,
task: "second task",
});
} finally {
nowSpy.mockRestore();
}
expect(agentSpy).toHaveBeenCalledTimes(2);
const idempotencyKeys = agentSpy.mock.calls
.map((call) => (call[0] as { params?: Record<string, unknown> })?.params?.idempotencyKey)
.filter((value): value is string => typeof value === "string");
expect(idempotencyKeys).toContain("announce:v1:agent:main:subagent:worker:run-1");
expect(idempotencyKeys).toContain("announce:v1:agent:main:subagent:worker:run-2");
expect(new Set(idempotencyKeys).size).toBe(2);
});
it("prefers direct delivery first for completion-mode and then queues on direct failure", async () => {
embeddedRunMock.isEmbeddedPiRunActive.mockReturnValue(true);
embeddedRunMock.isEmbeddedPiRunStreaming.mockReturnValue(false);
sessionStore = {
"agent:main:main": {
sessionId: "session-collect",
lastChannel: "whatsapp",
lastTo: "+1555",
queueMode: "collect",
queueDebounceMs: 0,
},
};
sendSpy.mockRejectedValueOnce(new Error("direct delivery unavailable"));
const didAnnounce = await runSubagentAnnounceFlow({
childSessionKey: "agent:main:subagent:worker",
childRunId: "run-completion-direct-fallback",
requesterSessionKey: "main",
requesterDisplayKey: "main",
expectsCompletionMessage: true,
...defaultOutcomeAnnounce,
});
expect(didAnnounce).toBe(true);
expect(sendSpy).toHaveBeenCalledTimes(1);
expect(agentSpy).toHaveBeenCalledTimes(1);
expect(sendSpy.mock.calls[0]?.[0]).toMatchObject({
method: "send",
params: { sessionKey: "agent:main:main" },
});
expect(agentSpy.mock.calls[0]?.[0]).toMatchObject({
method: "agent",
params: { sessionKey: "agent:main:main" },
});
expect(agentSpy.mock.calls[0]?.[0]).toMatchObject({
method: "agent",
params: { channel: "whatsapp", to: "+1555", deliver: true },
});
});
it("falls back to internal requester-session injection when completion route is missing", async () => {
embeddedRunMock.isEmbeddedPiRunActive.mockReturnValue(false);
embeddedRunMock.isEmbeddedPiRunStreaming.mockReturnValue(false);
sessionStore = {
"agent:main:main": {
sessionId: "requester-session-no-route",
},
};
agentSpy.mockImplementationOnce(async (req: AgentCallRequest) => {
const deliver = req.params?.deliver;
const channel = req.params?.channel;
if (deliver === true && typeof channel !== "string") {
throw new Error("Channel is required when deliver=true");
}
return { runId: "run-main", status: "ok" };
});
const didAnnounce = await runSubagentAnnounceFlow({
childSessionKey: "agent:main:subagent:worker",
childRunId: "run-completion-missing-route",
requesterSessionKey: "main",
requesterDisplayKey: "main",
expectsCompletionMessage: true,
...defaultOutcomeAnnounce,
});
expect(didAnnounce).toBe(true);
expect(sendSpy).toHaveBeenCalledTimes(0);
expect(agentSpy).toHaveBeenCalledTimes(1);
expect(agentSpy.mock.calls[0]?.[0]).toMatchObject({
method: "agent",
params: {
sessionKey: "agent:main:main",
deliver: false,
},
});
});
it("uses direct completion delivery when explicit channel+to route is available", async () => {
sessionStore = {
"agent:main:main": {
sessionId: "requester-session-direct-route",
},
};
agentSpy.mockImplementationOnce(async () => {
throw new Error("agent fallback should not run when direct route exists");
});
const didAnnounce = await runSubagentAnnounceFlow({
childSessionKey: "agent:main:subagent:worker",
childRunId: "run-completion-explicit-route",
requesterSessionKey: "main",
requesterDisplayKey: "main",
requesterOrigin: { channel: "discord", to: "channel:12345", accountId: "acct-1" },
expectsCompletionMessage: true,
...defaultOutcomeAnnounce,
});
expect(didAnnounce).toBe(true);
expect(sendSpy).toHaveBeenCalledTimes(1);
expect(agentSpy).toHaveBeenCalledTimes(0);
expect(sendSpy.mock.calls[0]?.[0]).toMatchObject({
method: "send",
params: {
sessionKey: "agent:main:main",
channel: "discord",
to: "channel:12345",
},
});
});
it("returns failure for completion-mode when direct delivery fails and queue fallback is unavailable", async () => {
embeddedRunMock.isEmbeddedPiRunActive.mockReturnValue(false);
embeddedRunMock.isEmbeddedPiRunStreaming.mockReturnValue(false);
sessionStore = {
"agent:main:main": {
sessionId: "session-direct-only",
lastChannel: "whatsapp",
lastTo: "+1555",
},
};
sendSpy.mockRejectedValueOnce(new Error("direct delivery unavailable"));
const didAnnounce = await runSubagentAnnounceFlow({
childSessionKey: "agent:main:subagent:worker",
childRunId: "run-completion-direct-fail",
requesterSessionKey: "main",
requesterDisplayKey: "main",
expectsCompletionMessage: true,
...defaultOutcomeAnnounce,
});
expect(didAnnounce).toBe(false);
expect(sendSpy).toHaveBeenCalledTimes(1);
expect(agentSpy).toHaveBeenCalledTimes(0);
});
it("uses assistant output for completion-mode when latest assistant text exists", async () => {
chatHistoryMock.mockResolvedValueOnce({
messages: [
{
role: "toolResult",
content: [{ type: "text", text: "old tool output" }],
},
{
role: "assistant",
content: [{ type: "text", text: "assistant completion text" }],
},
],
});
readLatestAssistantReplyMock.mockResolvedValue("");
const didAnnounce = await runSubagentAnnounceFlow({
childSessionKey: "agent:main:subagent:worker",
childRunId: "run-completion-assistant-output",
requesterSessionKey: "agent:main:main",
requesterDisplayKey: "main",
requesterOrigin: { channel: "discord", to: "channel:12345", accountId: "acct-1" },
expectsCompletionMessage: true,
...defaultOutcomeAnnounce,
});
expect(didAnnounce).toBe(true);
expect(sendSpy).toHaveBeenCalledTimes(1);
const call = sendSpy.mock.calls[0]?.[0] as { params?: { message?: string } };
const msg = call?.params?.message as string;
expect(msg).toContain("assistant completion text");
expect(msg).not.toContain("old tool output");
});
it("falls back to latest tool output for completion-mode when assistant output is empty", async () => {
chatHistoryMock.mockResolvedValueOnce({
messages: [
{
role: "assistant",
content: [{ type: "text", text: "" }],
},
{
role: "toolResult",
content: [{ type: "text", text: "tool output only" }],
},
],
});
readLatestAssistantReplyMock.mockResolvedValue("");
const didAnnounce = await runSubagentAnnounceFlow({
childSessionKey: "agent:main:subagent:worker",
childRunId: "run-completion-tool-output",
requesterSessionKey: "agent:main:main",
requesterDisplayKey: "main",
requesterOrigin: { channel: "discord", to: "channel:12345", accountId: "acct-1" },
expectsCompletionMessage: true,
...defaultOutcomeAnnounce,
});
expect(didAnnounce).toBe(true);
expect(sendSpy).toHaveBeenCalledTimes(1);
const call = sendSpy.mock.calls[0]?.[0] as { params?: { message?: string } };
const msg = call?.params?.message as string;
expect(msg).toContain("tool output only");
});
it("ignores user text when deriving fallback completion output", async () => {
chatHistoryMock.mockResolvedValueOnce({
messages: [
{
role: "user",
content: [{ type: "text", text: "user prompt should not be announced" }],
},
],
});
readLatestAssistantReplyMock.mockResolvedValue("");
const didAnnounce = await runSubagentAnnounceFlow({
childSessionKey: "agent:main:subagent:worker",
childRunId: "run-completion-ignore-user",
requesterSessionKey: "agent:main:main",
requesterDisplayKey: "main",
requesterOrigin: { channel: "discord", to: "channel:12345", accountId: "acct-1" },
expectsCompletionMessage: true,
...defaultOutcomeAnnounce,
});
expect(didAnnounce).toBe(true);
expect(sendSpy).toHaveBeenCalledTimes(1);
const call = sendSpy.mock.calls[0]?.[0] as { params?: { message?: string } };
const msg = call?.params?.message as string;
expect(msg).toContain("✅ Subagent main finished");
expect(msg).not.toContain("user prompt should not be announced");
});
it("queues announce delivery back into requester subagent session", async () => {
embeddedRunMock.isEmbeddedPiRunActive.mockReturnValue(true);
embeddedRunMock.isEmbeddedPiRunStreaming.mockReturnValue(false);
sessionStore = {
"agent:main:subagent:orchestrator": {
sessionId: "session-orchestrator",
spawnDepth: 1,
queueMode: "collect",
queueDebounceMs: 0,
},
};
const didAnnounce = await runSubagentAnnounceFlow({
childSessionKey: "agent:main:subagent:worker",
childRunId: "run-worker-queued",
requesterSessionKey: "agent:main:subagent:orchestrator",
requesterDisplayKey: "agent:main:subagent:orchestrator",
requesterOrigin: { channel: "whatsapp", to: "+1555", accountId: "acct" },
...defaultOutcomeAnnounce,
});
expect(didAnnounce).toBe(true);
expect(agentSpy).toHaveBeenCalledTimes(1);
const call = agentSpy.mock.calls[0]?.[0] as { params?: Record<string, unknown> };
expect(call?.params?.sessionKey).toBe("agent:main:subagent:orchestrator");
expect(call?.params?.deliver).toBe(false);
expect(call?.params?.channel).toBeUndefined();
expect(call?.params?.to).toBeUndefined();
});
it.each([
{
testName: "includes threadId when origin has an active topic/thread",
childRunId: "run-thread",
expectedThreadId: "42",
requesterOrigin: undefined,
},
{
testName: "prefers requesterOrigin.threadId over session entry threadId",
childRunId: "run-thread-override",
expectedThreadId: "99",
requesterOrigin: {
channel: "telegram",
to: "telegram:123",
threadId: 99,
},
},
] as const)("thread routing: $testName", async (testCase) => {
embeddedRunMock.isEmbeddedPiRunActive.mockReturnValue(true);
embeddedRunMock.isEmbeddedPiRunStreaming.mockReturnValue(false);
sessionStore = {
"agent:main:main": {
sessionId: "session-thread",
lastChannel: "telegram",
lastTo: "telegram:123",
lastThreadId: 42,
queueMode: "collect",
queueDebounceMs: 0,
},
};
const didAnnounce = await runSubagentAnnounceFlow({
childSessionKey: "agent:main:subagent:test",
childRunId: testCase.childRunId,
requesterSessionKey: "main",
requesterDisplayKey: "main",
...(testCase.requesterOrigin ? { requesterOrigin: testCase.requesterOrigin } : {}),
...defaultOutcomeAnnounce,
});
expect(didAnnounce).toBe(true);
const params = await getSingleAgentCallParams();
expect(params.channel).toBe("telegram");
expect(params.to).toBe("telegram:123");
expect(params.threadId).toBe(testCase.expectedThreadId);
});
it("splits collect-mode queues when accountId differs", async () => {
embeddedRunMock.isEmbeddedPiRunActive.mockReturnValue(true);
embeddedRunMock.isEmbeddedPiRunStreaming.mockReturnValue(false);
sessionStore = {
"agent:main:main": {
sessionId: "session-acc-split",
lastChannel: "whatsapp",
lastTo: "+1555",
queueMode: "collect",
queueDebounceMs: 0,
},
};
await Promise.all([
runSubagentAnnounceFlow({
childSessionKey: "agent:main:subagent:test-a",
childRunId: "run-a",
requesterSessionKey: "main",
requesterDisplayKey: "main",
requesterOrigin: { accountId: "acct-a" },
...defaultOutcomeAnnounce,
}),
runSubagentAnnounceFlow({
childSessionKey: "agent:main:subagent:test-b",
childRunId: "run-b",
requesterSessionKey: "main",
requesterDisplayKey: "main",
requesterOrigin: { accountId: "acct-b" },
...defaultOutcomeAnnounce,
}),
]);
await vi.waitFor(() => {
expect(agentSpy).toHaveBeenCalledTimes(2);
});
const accountIds = agentSpy.mock.calls.map(
(call) => (call?.[0] as { params?: { accountId?: string } })?.params?.accountId,
);
expect(accountIds).toEqual(expect.arrayContaining(["acct-a", "acct-b"]));
});
it.each([
{
testName: "uses requester origin for direct announce when not queued",
childRunId: "run-direct",
requesterOrigin: { channel: "whatsapp", accountId: "acct-123" },
expectedChannel: "whatsapp",
expectedAccountId: "acct-123",
},
{
testName: "normalizes requesterOrigin for direct announce delivery",
childRunId: "run-direct-origin",
requesterOrigin: { channel: " whatsapp ", accountId: " acct-987 " },
expectedChannel: "whatsapp",
expectedAccountId: "acct-987",
},
] as const)("direct announce: $testName", async (testCase) => {
embeddedRunMock.isEmbeddedPiRunActive.mockReturnValue(false);
embeddedRunMock.isEmbeddedPiRunStreaming.mockReturnValue(false);
const didAnnounce = await runSubagentAnnounceFlow({
childSessionKey: "agent:main:subagent:test",
childRunId: testCase.childRunId,
requesterSessionKey: "agent:main:main",
requesterOrigin: testCase.requesterOrigin,
requesterDisplayKey: "main",
...defaultOutcomeAnnounce,
});
expect(didAnnounce).toBe(true);
const call = agentSpy.mock.calls[0]?.[0] as {
params?: Record<string, unknown>;
expectFinal?: boolean;
};
expect(call?.params?.channel).toBe(testCase.expectedChannel);
expect(call?.params?.accountId).toBe(testCase.expectedAccountId);
expect(call?.expectFinal).toBe(true);
});
it("injects direct announce into requester subagent session instead of chat channel", async () => {
embeddedRunMock.isEmbeddedPiRunActive.mockReturnValue(false);
embeddedRunMock.isEmbeddedPiRunStreaming.mockReturnValue(false);
const didAnnounce = await runSubagentAnnounceFlow({
childSessionKey: "agent:main:subagent:worker",
childRunId: "run-worker",
requesterSessionKey: "agent:main:subagent:orchestrator",
requesterOrigin: { channel: "whatsapp", accountId: "acct-123", to: "+1555" },
requesterDisplayKey: "agent:main:subagent:orchestrator",
...defaultOutcomeAnnounce,
});
expect(didAnnounce).toBe(true);
const call = agentSpy.mock.calls[0]?.[0] as { params?: Record<string, unknown> };
expect(call?.params?.sessionKey).toBe("agent:main:subagent:orchestrator");
expect(call?.params?.deliver).toBe(false);
expect(call?.params?.channel).toBeUndefined();
expect(call?.params?.to).toBeUndefined();
});
it("keeps completion-mode announce internal for nested requester subagent sessions", async () => {
embeddedRunMock.isEmbeddedPiRunActive.mockReturnValue(false);
embeddedRunMock.isEmbeddedPiRunStreaming.mockReturnValue(false);
const didAnnounce = await runSubagentAnnounceFlow({
childSessionKey: "agent:main:subagent:orchestrator:subagent:worker",
childRunId: "run-worker-nested-completion",
requesterSessionKey: "agent:main:subagent:orchestrator",
requesterOrigin: { channel: "whatsapp", accountId: "acct-123", to: "+1555" },
requesterDisplayKey: "agent:main:subagent:orchestrator",
expectsCompletionMessage: true,
...defaultOutcomeAnnounce,
});
expect(didAnnounce).toBe(true);
expect(sendSpy).not.toHaveBeenCalled();
const call = agentSpy.mock.calls[0]?.[0] as { params?: Record<string, unknown> };
expect(call?.params?.sessionKey).toBe("agent:main:subagent:orchestrator");
expect(call?.params?.deliver).toBe(false);
expect(call?.params?.channel).toBeUndefined();
expect(call?.params?.to).toBeUndefined();
const message = typeof call?.params?.message === "string" ? call.params.message : "";
expect(message).toContain(
"Convert this completion into a concise internal orchestration update for your parent agent",
);
});
it("retries reading subagent output when early lifecycle completion had no text", async () => {
embeddedRunMock.isEmbeddedPiRunActive.mockReturnValueOnce(true).mockReturnValue(false);
embeddedRunMock.waitForEmbeddedPiRunEnd.mockResolvedValue(true);
readLatestAssistantReplyMock
.mockResolvedValueOnce(undefined)
.mockResolvedValueOnce("Read #12 complete.");
sessionStore = {
"agent:main:subagent:test": {
sessionId: "child-session-1",
inputTokens: 1,
outputTokens: 1,
totalTokens: 2,
},
};
await runSubagentAnnounceFlow({
childSessionKey: "agent:main:subagent:test",
childRunId: "run-child",
requesterSessionKey: "agent:main:main",
requesterDisplayKey: "main",
task: "context-stress-test",
timeoutMs: 1000,
cleanup: "keep",
waitForCompletion: false,
startedAt: 10,
endedAt: 20,
outcome: { status: "ok" },
});
expect(embeddedRunMock.waitForEmbeddedPiRunEnd).toHaveBeenCalledWith("child-session-1", 1000);
const call = agentSpy.mock.calls[0]?.[0] as { params?: { message?: string } };
expect(call?.params?.message).toContain("Read #12 complete.");
expect(call?.params?.message).not.toContain("(no output)");
});
it("uses advisory guidance when sibling subagents are still active", async () => {
subagentRegistryMock.countActiveDescendantRuns.mockImplementation((sessionKey: string) =>
sessionKey === "agent:main:main" ? 2 : 0,
);
await runSubagentAnnounceFlow({
childSessionKey: "agent:main:subagent:test",
childRunId: "run-child",
requesterSessionKey: "agent:main:main",
requesterDisplayKey: "main",
...defaultOutcomeAnnounce,
});
const call = agentSpy.mock.calls[0]?.[0] as { params?: { message?: string } };
const msg = call?.params?.message as string;
expect(msg).toContain("There are still 2 active subagent runs for this session.");
expect(msg).toContain(
"If they are part of the same workflow, wait for the remaining results before sending a user update.",
);
expect(msg).toContain("If they are unrelated, respond normally using only the result above.");
});
it("defers announce while finished runs still have active descendants", async () => {
const cases = [
{
childRunId: "run-parent",
expectsCompletionMessage: false,
},
{
childRunId: "run-parent-completion",
expectsCompletionMessage: true,
},
] as const;
for (const testCase of cases) {
agentSpy.mockClear();
sendSpy.mockClear();
subagentRegistryMock.countActiveDescendantRuns.mockImplementation((sessionKey: string) =>
sessionKey === "agent:main:subagent:parent" ? 1 : 0,
);
const didAnnounce = await runSubagentAnnounceFlow({
childSessionKey: "agent:main:subagent:parent",
childRunId: testCase.childRunId,
requesterSessionKey: "agent:main:main",
requesterDisplayKey: "main",
...(testCase.expectsCompletionMessage ? { expectsCompletionMessage: true } : {}),
...defaultOutcomeAnnounce,
});
expect(didAnnounce).toBe(false);
expect(agentSpy).not.toHaveBeenCalled();
expect(sendSpy).not.toHaveBeenCalled();
}
});
it("waits for updated synthesized output before announcing nested subagent completion", async () => {
let historyReads = 0;
chatHistoryMock.mockImplementation(async () => {
historyReads += 1;
if (historyReads < 3) {
return {
messages: [{ role: "assistant", content: "Waiting for child output..." }],
};
}
return {
messages: [{ role: "assistant", content: "Final synthesized answer." }],
};
});
readLatestAssistantReplyMock.mockResolvedValue(undefined);
const didAnnounce = await runSubagentAnnounceFlow({
childSessionKey: "agent:main:subagent:parent",
childRunId: "run-parent-synth",
requesterSessionKey: "agent:main:subagent:orchestrator",
requesterDisplayKey: "agent:main:subagent:orchestrator",
...defaultOutcomeAnnounce,
timeoutMs: 100,
});
expect(didAnnounce).toBe(true);
const call = agentSpy.mock.calls[0]?.[0] as { params?: { message?: string } };
const msg = call?.params?.message ?? "";
expect(msg).toContain("Final synthesized answer.");
expect(msg).not.toContain("Waiting for child output...");
});
it("bubbles child announce to parent requester when requester subagent already ended", async () => {
subagentRegistryMock.isSubagentSessionRunActive.mockReturnValue(false);
subagentRegistryMock.resolveRequesterForChildSession.mockReturnValue({
requesterSessionKey: "agent:main:main",
requesterOrigin: { channel: "whatsapp", to: "+1555", accountId: "acct-main" },
});
const didAnnounce = await runSubagentAnnounceFlow({
childSessionKey: "agent:main:subagent:leaf",
childRunId: "run-leaf",
requesterSessionKey: "agent:main:subagent:orchestrator",
requesterDisplayKey: "agent:main:subagent:orchestrator",
...defaultOutcomeAnnounce,
});
expect(didAnnounce).toBe(true);
const call = agentSpy.mock.calls[0]?.[0] as { params?: Record<string, unknown> };
expect(call?.params?.sessionKey).toBe("agent:main:main");
expect(call?.params?.deliver).toBe(true);
expect(call?.params?.channel).toBe("whatsapp");
expect(call?.params?.to).toBe("+1555");
expect(call?.params?.accountId).toBe("acct-main");
});
it("keeps announce retryable when ended requester subagent has no fallback requester", async () => {
subagentRegistryMock.isSubagentSessionRunActive.mockReturnValue(false);
subagentRegistryMock.resolveRequesterForChildSession.mockReturnValue(null);
const didAnnounce = await runSubagentAnnounceFlow({
childSessionKey: "agent:main:subagent:leaf",
childRunId: "run-leaf-missing-fallback",
requesterSessionKey: "agent:main:subagent:orchestrator",
requesterDisplayKey: "agent:main:subagent:orchestrator",
...defaultOutcomeAnnounce,
cleanup: "delete",
});
expect(didAnnounce).toBe(false);
expect(subagentRegistryMock.resolveRequesterForChildSession).toHaveBeenCalledWith(
"agent:main:subagent:orchestrator",
);
expect(agentSpy).not.toHaveBeenCalled();
expect(sessionsDeleteSpy).not.toHaveBeenCalled();
});
it("defers announce when child run stays active after settle timeout", async () => {
const cases = [
{
childRunId: "run-child-active",
task: "context-stress-test",
expectsCompletionMessage: false,
},
{
childRunId: "run-child-active-completion",
task: "completion-context-stress-test",
expectsCompletionMessage: true,
},
] as const;
for (const testCase of cases) {
agentSpy.mockClear();
sendSpy.mockClear();
embeddedRunMock.isEmbeddedPiRunActive.mockReturnValue(true);
embeddedRunMock.waitForEmbeddedPiRunEnd.mockResolvedValue(false);
sessionStore = {
"agent:main:subagent:test": {
sessionId: "child-session-active",
},
};
const didAnnounce = await runSubagentAnnounceFlow({
childSessionKey: "agent:main:subagent:test",
childRunId: testCase.childRunId,
requesterSessionKey: "agent:main:main",
requesterDisplayKey: "main",
...defaultOutcomeAnnounce,
task: testCase.task,
...(testCase.expectsCompletionMessage ? { expectsCompletionMessage: true } : {}),
});
expect(didAnnounce).toBe(false);
expect(agentSpy).not.toHaveBeenCalled();
expect(sendSpy).not.toHaveBeenCalled();
}
});
it("prefers requesterOrigin channel over stale session lastChannel in queued announce", async () => {
embeddedRunMock.isEmbeddedPiRunActive.mockReturnValue(true);
embeddedRunMock.isEmbeddedPiRunStreaming.mockReturnValue(false);
// Session store has stale whatsapp channel, but the requesterOrigin says bluebubbles.
sessionStore = {
"agent:main:main": {
sessionId: "session-stale",
lastChannel: "whatsapp",
queueMode: "collect",
queueDebounceMs: 0,
},
};
const didAnnounce = await runSubagentAnnounceFlow({
childSessionKey: "agent:main:subagent:test",
childRunId: "run-stale-channel",
requesterSessionKey: "main",
requesterOrigin: { channel: "telegram", to: "telegram:123" },
requesterDisplayKey: "main",
...defaultOutcomeAnnounce,
});
expect(didAnnounce).toBe(true);
expect(agentSpy).toHaveBeenCalledTimes(1);
const call = agentSpy.mock.calls[0]?.[0] as { params?: Record<string, unknown> };
// The channel should match requesterOrigin, NOT the stale session entry.
expect(call?.params?.channel).toBe("telegram");
expect(call?.params?.to).toBe("telegram:123");
});
it("routes or falls back for ended parent subagent sessions (#18037)", async () => {
const cases = [
{
name: "routes to parent when parent session still exists",
childSessionKey: "agent:main:subagent:newton:subagent:birdie",
childRunId: "run-birdie",
requesterSessionKey: "agent:main:subagent:newton",
requesterDisplayKey: "subagent:newton",
sessionStoreFixture: {
"agent:main:subagent:newton": {
sessionId: "newton-session-id-alive",
inputTokens: 100,
outputTokens: 50,
},
"agent:main:subagent:newton:subagent:birdie": {
sessionId: "birdie-session-id",
inputTokens: 20,
outputTokens: 10,
},
},
expectedSessionKey: "agent:main:subagent:newton",
expectedDeliver: false,
expectedChannel: undefined,
},
{
name: "falls back when parent session is deleted",
childSessionKey: "agent:main:subagent:birdie",
childRunId: "run-birdie-orphan",
requesterSessionKey: "agent:main:subagent:newton",
requesterDisplayKey: "subagent:newton",
sessionStoreFixture: {
"agent:main:subagent:birdie": {
sessionId: "birdie-session-id",
inputTokens: 20,
outputTokens: 10,
},
},
expectedSessionKey: "agent:main:main",
expectedDeliver: true,
expectedChannel: "discord",
},
{
name: "falls back when parent sessionId is blank",
childSessionKey: "agent:main:subagent:newton:subagent:birdie",
childRunId: "run-birdie-empty-parent",
requesterSessionKey: "agent:main:subagent:newton",
requesterDisplayKey: "subagent:newton",
sessionStoreFixture: {
"agent:main:subagent:newton": {
sessionId: " ",
inputTokens: 100,
outputTokens: 50,
},
"agent:main:subagent:newton:subagent:birdie": {
sessionId: "birdie-session-id",
inputTokens: 20,
outputTokens: 10,
},
},
expectedSessionKey: "agent:main:main",
expectedDeliver: true,
expectedChannel: "discord",
},
] as const;
for (const testCase of cases) {
agentSpy.mockClear();
embeddedRunMock.isEmbeddedPiRunActive.mockReturnValue(false);
embeddedRunMock.isEmbeddedPiRunStreaming.mockReturnValue(false);
subagentRegistryMock.isSubagentSessionRunActive.mockReturnValue(false);
sessionStore = testCase.sessionStoreFixture as Record<string, Record<string, unknown>>;
subagentRegistryMock.resolveRequesterForChildSession.mockReturnValue({
requesterSessionKey: "agent:main:main",
requesterOrigin: { channel: "discord", accountId: "jaris-account" },
});
const didAnnounce = await runSubagentAnnounceFlow({
childSessionKey: testCase.childSessionKey,
childRunId: testCase.childRunId,
requesterSessionKey: testCase.requesterSessionKey,
requesterDisplayKey: testCase.requesterDisplayKey,
...defaultOutcomeAnnounce,
task: "QA task",
});
expect(didAnnounce, testCase.name).toBe(true);
const call = agentSpy.mock.calls[0]?.[0] as { params?: Record<string, unknown> };
expect(call?.params?.sessionKey, testCase.name).toBe(testCase.expectedSessionKey);
expect(call?.params?.deliver, testCase.name).toBe(testCase.expectedDeliver);
expect(call?.params?.channel, testCase.name).toBe(testCase.expectedChannel);
}
});
});