Files
openclaw/src/agents/cli-runner.reliability.test.ts
Vincent Koc a9df801902 fix(skill-workshop): skip helper sessions during auto-capture (#93653)
* fix(skill-workshop): skip helper sessions during auto-capture

Co-authored-by: zhang-guiping <275915537+zhangguiping-xydt@users.noreply.github.com>

* fix(clownfish): address review for gitcrawl-164-autonomous-terminal-gap (1)

Co-authored-by: zhang-guiping <275915537+zhangguiping-xydt@users.noreply.github.com>

---------

Co-authored-by: openclaw-clownfish[bot] <280122609+openclaw-clownfish[bot]@users.noreply.github.com>
Co-authored-by: zhang-guiping <275915537+zhangguiping-xydt@users.noreply.github.com>
2026-06-16 22:05:23 +08:00

3212 lines
102 KiB
TypeScript

/** Tests CLI runner reliability paths for hooks, transcripts, failover, and reply ops. */
import fs from "node:fs";
import os from "node:os";
import path from "node:path";
import { afterEach, describe, expect, it, vi } from "vitest";
import { getReplyPayloadMetadata } from "../auto-reply/reply-payload.js";
import {
testing as replyRunTesting,
createReplyOperation,
replyRunRegistry,
} from "../auto-reply/reply/reply-run-registry.js";
import { SILENT_REPLY_TOKEN } from "../auto-reply/tokens.js";
import { CURRENT_SESSION_VERSION } from "../config/sessions/version.js";
import type { OpenClawConfig } from "../config/types.openclaw.js";
import {
markMcpLoopbackRequestClassified,
markMcpLoopbackRequestFinished,
markMcpLoopbackRequestStarted,
markMcpLoopbackToolCallFinished,
markMcpLoopbackToolCallStarted,
recordMcpLoopbackToolCallResult,
resolveMcpLoopbackYieldContext,
updateMcpLoopbackToolCallCapture,
} from "../gateway/mcp-http.loopback-runtime.js";
import { getGlobalHookRunner } from "../plugins/hook-runner-global.js";
import type { getProcessSupervisor } from "../process/supervisor/index.js";
import {
createUserTurnTranscriptRecorder,
type UserTurnTranscriptRecorder,
} from "../sessions/user-turn-transcript.js";
import { runSkillResearchAutoCapture } from "../skills/research/autocapture.js";
import { captureEnv, setTestEnvValue } from "../test-utils/env.js";
import { runPreparedCliAgent } from "./cli-runner.js";
import {
createManagedRun,
enqueueSystemEventMock,
requestHeartbeatMock,
supervisorSpawnMock,
} from "./cli-runner.test-support.js";
import { executePreparedCliRun } from "./cli-runner/execute.js";
import {
resolveCliNoOutputTimeoutMs,
resolveCliRunTimeoutOverrideMs,
} from "./cli-runner/helpers.js";
import { prepareCliRunContext } from "./cli-runner/prepare.js";
import * as sessionHistoryModule from "./cli-runner/session-history.js";
import { MAX_CLI_SESSION_HISTORY_MESSAGES } from "./cli-runner/session-history.js";
import type { PreparedCliRunContext } from "./cli-runner/types.js";
vi.mock("../plugins/hook-runner-global.js", () => ({
getGlobalHookRunner: vi.fn(() => null),
}));
vi.mock("../skills/research/autocapture.js", () => ({
runSkillResearchAutoCapture: vi.fn(async () => undefined),
}));
vi.mock("../tts/tts.js", () => ({
buildTtsSystemPromptHint: vi.fn(() => undefined),
}));
const mockGetGlobalHookRunner = vi.mocked(getGlobalHookRunner);
const mockAutoCapture = vi.mocked(runSkillResearchAutoCapture);
const hookRunnerGlobalStateKey = Symbol.for("openclaw.plugins.hook-runner-global-state");
let sessionFileEnvSnapshot: ReturnType<typeof captureEnv> | undefined;
type HookRunnerGlobalStateForTest = {
hookRunner: unknown;
registry: unknown;
};
function setHookRunnerForTest(hookRunner: unknown): void {
// Keep the module-level hook runner singleton aligned with the mocked getter.
mockGetGlobalHookRunner.mockReturnValue(hookRunner as never);
const globalStore = globalThis as Record<PropertyKey, unknown>;
const state = (globalStore[hookRunnerGlobalStateKey] as
| HookRunnerGlobalStateForTest
| undefined) ?? {
hookRunner: null,
registry: null,
};
state.hookRunner = hookRunner;
state.registry = null;
globalStore[hookRunnerGlobalStateKey] = state;
}
function createSessionFile(params?: { history?: Array<{ role: "user"; content: string }> }) {
// Session files use the real JSONL shape so transcript/history readers stay
// covered without spinning up a full CLI process.
const dir = fs.mkdtempSync(path.join(os.tmpdir(), "openclaw-cli-hooks-"));
sessionFileEnvSnapshot ??= captureEnv(["OPENCLAW_STATE_DIR"]);
setTestEnvValue("OPENCLAW_STATE_DIR", dir);
const sessionFile = path.join(dir, "agents", "main", "sessions", "s1.jsonl");
const storePath = path.join(path.dirname(sessionFile), "sessions.json");
fs.mkdirSync(path.dirname(sessionFile), { recursive: true });
fs.writeFileSync(
storePath,
JSON.stringify({
"agent:main:main": {
sessionId: "s1",
sessionFile,
updatedAt: Date.now(),
},
}),
"utf-8",
);
fs.writeFileSync(
sessionFile,
`${JSON.stringify({
type: "session",
version: CURRENT_SESSION_VERSION,
id: "session-test",
timestamp: new Date(0).toISOString(),
cwd: dir,
})}\n`,
"utf-8",
);
for (const [index, entry] of (params?.history ?? []).entries()) {
fs.appendFileSync(
sessionFile,
`${JSON.stringify({
type: "message",
id: `msg-${index}`,
parentId: index > 0 ? `msg-${index - 1}` : null,
timestamp: new Date(index + 1).toISOString(),
message: {
role: entry.role,
content: entry.content,
timestamp: index + 1,
},
})}\n`,
"utf-8",
);
}
return { dir, sessionFile, storePath };
}
function createCliUserTurnRecorder(params: {
text: string;
sessionFile: string;
sessionKey?: string;
workspaceDir: string;
}) {
return createUserTurnTranscriptRecorder({
input: { text: params.text },
target: {
transcriptPath: params.sessionFile,
sessionId: "s1",
...(params.sessionKey ? { sessionKey: params.sessionKey } : {}),
cwd: params.workspaceDir,
},
});
}
function buildPreparedContext(params?: {
sessionKey?: string;
cliSessionId?: string;
runId?: string;
lane?: string;
openClawHistoryPrompt?: string;
provider?: string;
model?: string;
executionMode?: PreparedCliRunContext["params"]["executionMode"];
allowEmptyAssistantReplyAsSilent?: boolean;
}): PreparedCliRunContext {
// Common prepared context fixture for runPreparedCliAgent reliability branches.
const provider = params?.provider ?? "codex-cli";
const model = params?.model ?? "gpt-5.4";
const backend = {
command: "codex",
args: ["exec", "--json"],
output: "text" as const,
input: "arg" as const,
modelArg: "--model",
sessionMode: "existing" as const,
serialize: true,
};
return {
params: {
sessionId: "s1",
sessionKey: params?.sessionKey,
sessionFile: "/tmp/session.jsonl",
workspaceDir: "/tmp",
prompt: "hi",
provider,
model,
thinkLevel: "low",
timeoutMs: 1_000,
runId: params?.runId ?? "run-2",
lane: params?.lane,
executionMode: params?.executionMode,
allowEmptyAssistantReplyAsSilent: params?.allowEmptyAssistantReplyAsSilent,
},
started: Date.now(),
workspaceDir: "/tmp",
backendResolved: {
id: provider,
config: backend,
bundleMcp: false,
pluginId: provider === "claude-cli" ? "anthropic" : "openai",
},
preparedBackend: {
backend,
env: {},
},
reusableCliSession: params?.cliSessionId ? { sessionId: params.cliSessionId } : {},
hadSessionFile: false,
contextEngineConfig: {},
modelId: model,
normalizedModel: model,
contextWindowInfo: {
tokens: 150_000,
referenceTokens: 200_000,
source: "agentContextTokens",
},
systemPrompt: "You are a helpful assistant.",
systemPromptReport: {} as PreparedCliRunContext["systemPromptReport"],
bootstrapPromptWarningLines: [],
...(params?.openClawHistoryPrompt
? { openClawHistoryPrompt: params.openClawHistoryPrompt }
: {}),
authEpochVersion: 2,
};
}
function requireRecord(value: unknown, label: string): Record<string, unknown> {
if (!value || typeof value !== "object") {
throw new Error(`expected ${label}`);
}
return value as Record<string, unknown>;
}
function requireArray(value: unknown, label: string): Array<unknown> {
expect(Array.isArray(value), label).toBe(true);
return value as Array<unknown>;
}
function callArg(
mock: { mock: { calls: Array<Array<unknown>> } },
callIndex: number,
argIndex: number,
label: string,
) {
const call = mock.mock.calls[callIndex];
if (!call) {
throw new Error(`Expected mock call: ${label}`);
}
if (argIndex >= call.length) {
throw new Error(`Expected mock call argument ${argIndex}: ${label}`);
}
return call[argIndex];
}
function firstSystemEventCall(): Array<unknown> {
const call = enqueueSystemEventMock.mock.calls[0];
if (!call) {
throw new Error("expected system event call");
}
return call;
}
async function expectFailoverAttribution(
run: Promise<unknown>,
expected: { sessionId: string; lane: string },
) {
try {
await run;
throw new Error("expected run to fail");
} catch (error) {
const failure = requireRecord(error, "failover error");
expect(failure.name).toBe("FailoverError");
expect(failure.sessionId).toBe(expected.sessionId);
expect(failure.lane).toBe(expected.lane);
}
}
function expectTextMessage(value: unknown, fields: { role: string; content: string }) {
const message = requireRecord(value, "message");
expect(message.role).toBe(fields.role);
expect(message.content).toBe(fields.content);
expect(message.timestamp).toBeTypeOf("number");
}
function readTranscriptMessages(sessionFile: string): unknown[] {
return fs
.readFileSync(sessionFile, "utf-8")
.trim()
.split("\n")
.map((line) => JSON.parse(line) as { message?: unknown })
.map((entry) => entry.message)
.filter(Boolean);
}
const CLI_RESEED_PROMPT =
"Continue this conversation using the OpenClaw transcript below as prior session history.\n\n<conversation_history>\nUser: earlier context\n</conversation_history>\n\n<next_user_message>\nhi\n</next_user_message>";
describe("runCliAgent reliability", () => {
afterEach(() => {
replyRunTesting.resetReplyRunRegistry();
mockGetGlobalHookRunner.mockReset();
mockAutoCapture.mockReset();
mockAutoCapture.mockResolvedValue(undefined);
setHookRunnerForTest(null);
vi.unstubAllEnvs();
sessionFileEnvSnapshot?.restore();
sessionFileEnvSnapshot = undefined;
});
it("fails with timeout when no-output watchdog trips", async () => {
supervisorSpawnMock.mockResolvedValueOnce(
createManagedRun({
reason: "no-output-timeout",
exitCode: null,
exitSignal: "SIGKILL",
durationMs: 200,
stdout: "",
stderr: "",
timedOut: true,
noOutputTimedOut: true,
}),
);
await expect(
executePreparedCliRun(
buildPreparedContext({ cliSessionId: "thread-123", runId: "run-2" }),
"thread-123",
),
).rejects.toThrow("produced no output");
});
it("adds request attribution to CLI watchdog failover errors", async () => {
supervisorSpawnMock.mockResolvedValueOnce(
createManagedRun({
reason: "no-output-timeout",
exitCode: null,
exitSignal: "SIGKILL",
durationMs: 200,
stdout: "",
stderr: "",
timedOut: true,
noOutputTimedOut: true,
}),
);
await expectFailoverAttribution(
executePreparedCliRun(
buildPreparedContext({
cliSessionId: "thread-123",
lane: "custom-lane",
runId: "run-attribution",
}),
"thread-123",
),
{ sessionId: "s1", lane: "custom-lane" },
);
});
it("enqueues a system event and heartbeat wake on no-output watchdog timeout for session runs", async () => {
supervisorSpawnMock.mockResolvedValueOnce(
createManagedRun({
reason: "no-output-timeout",
exitCode: null,
exitSignal: "SIGKILL",
durationMs: 200,
stdout: "",
stderr: "",
timedOut: true,
noOutputTimedOut: true,
}),
);
await expect(
executePreparedCliRun(
buildPreparedContext({
sessionKey: "agent:main:main",
cliSessionId: "thread-123",
runId: "run-2b",
}),
"thread-123",
),
).rejects.toThrow("produced no output");
expect(enqueueSystemEventMock).toHaveBeenCalledTimes(1);
const [notice, opts] = firstSystemEventCall();
expect(String(notice)).toContain("produced no output");
expect(String(notice)).toContain("interactive input or an approval prompt");
expect(requireRecord(opts, "system event options").sessionKey).toBe("agent:main:main");
expect(requestHeartbeatMock).toHaveBeenCalledWith({
source: "cli-watchdog",
intent: "event",
reason: "cli:watchdog:stall",
sessionKey: "agent:main:main",
});
});
it("does not enqueue watchdog system events for side-question no-output timeouts", async () => {
enqueueSystemEventMock.mockClear();
requestHeartbeatMock.mockClear();
supervisorSpawnMock.mockResolvedValueOnce(
createManagedRun({
reason: "no-output-timeout",
exitCode: null,
exitSignal: "SIGKILL",
durationMs: 200,
stdout: "",
stderr: "",
timedOut: true,
noOutputTimedOut: true,
}),
);
await expect(
executePreparedCliRun(
buildPreparedContext({
sessionKey: "agent:main:main",
cliSessionId: "thread-123",
executionMode: "side-question",
runId: "run-side-question-timeout",
}),
"thread-123",
),
).rejects.toThrow("produced no output");
expect(enqueueSystemEventMock).not.toHaveBeenCalled();
expect(requestHeartbeatMock).not.toHaveBeenCalled();
});
it("fails with timeout when overall timeout trips", async () => {
supervisorSpawnMock.mockResolvedValueOnce(
createManagedRun({
reason: "overall-timeout",
exitCode: null,
exitSignal: "SIGKILL",
durationMs: 200,
stdout: "",
stderr: "",
timedOut: true,
noOutputTimedOut: false,
}),
);
await expect(
executePreparedCliRun(
buildPreparedContext({ cliSessionId: "thread-123", runId: "run-3" }),
"thread-123",
),
).rejects.toThrow("exceeded timeout");
});
it("does not retry recoverable failover when no reusable CLI session was used", async () => {
supervisorSpawnMock.mockClear();
supervisorSpawnMock.mockResolvedValueOnce(
createManagedRun({
reason: "no-output-timeout",
exitCode: null,
exitSignal: "SIGKILL",
durationMs: 200,
stdout: "",
stderr: "",
timedOut: true,
noOutputTimedOut: true,
}),
);
await expect(
runPreparedCliAgent(
buildPreparedContext({
sessionKey: "agent:main:fresh",
runId: "run-fresh-timeout",
provider: "claude-cli",
model: "opus",
}),
),
).rejects.toThrow("produced no output");
expect(supervisorSpawnMock).toHaveBeenCalledTimes(1);
});
it("does not retry a resumed CLI session after the hard overall timeout", async () => {
supervisorSpawnMock.mockClear();
const clearBeforeRetry = vi.fn(async () => false);
supervisorSpawnMock.mockResolvedValueOnce(
createManagedRun({
reason: "overall-timeout",
exitCode: null,
exitSignal: "SIGKILL",
durationMs: 200,
stdout: "",
stderr: "",
timedOut: true,
noOutputTimedOut: false,
}),
);
const context = buildPreparedContext({
sessionKey: "agent:main:overall-timeout",
runId: "run-overall-timeout",
cliSessionId: "stale-cli-session",
provider: "claude-cli",
model: "opus",
});
await expect(
runPreparedCliAgent({
...context,
params: {
...context.params,
onBeforeFreshCliSessionRetry: clearBeforeRetry,
},
}),
).rejects.toThrow("exceeded timeout");
expect(supervisorSpawnMock).toHaveBeenCalledTimes(1);
expect(clearBeforeRetry).not.toHaveBeenCalled();
});
it("does not retry a resumed recoverable failover without a reseed prompt", async () => {
supervisorSpawnMock.mockClear();
const clearBeforeRetry = vi.fn(async () => false);
supervisorSpawnMock.mockResolvedValueOnce(
createManagedRun({
reason: "no-output-timeout",
exitCode: null,
exitSignal: "SIGKILL",
durationMs: 200,
stdout: "",
stderr: "",
timedOut: true,
noOutputTimedOut: true,
}),
);
const context = buildPreparedContext({
sessionKey: "agent:main:no-reseed",
runId: "run-no-reseed",
cliSessionId: "stale-cli-session",
provider: "claude-cli",
model: "opus",
});
await expect(
runPreparedCliAgent({
...context,
params: {
...context.params,
onBeforeFreshCliSessionRetry: clearBeforeRetry,
},
}),
).rejects.toThrow("produced no output");
expect(supervisorSpawnMock).toHaveBeenCalledTimes(1);
expect(clearBeforeRetry).not.toHaveBeenCalled();
});
it("preserves fresh retry for direct CLI callers without a pre-clear hook", async () => {
supervisorSpawnMock.mockClear();
supervisorSpawnMock.mockResolvedValueOnce(
createManagedRun({
reason: "exit",
exitCode: 1,
exitSignal: null,
durationMs: 150,
stdout: "",
stderr: "session expired",
timedOut: false,
noOutputTimedOut: false,
}),
);
supervisorSpawnMock.mockResolvedValueOnce(
createManagedRun({
reason: "exit",
exitCode: 0,
exitSignal: null,
durationMs: 50,
stdout: "hello from fresh cli",
stderr: "",
timedOut: false,
noOutputTimedOut: false,
}),
);
const context = buildPreparedContext({
sessionKey: "agent:main:direct",
runId: "run-direct-retry",
cliSessionId: "stale-cli-session",
provider: "claude-cli",
model: "opus",
openClawHistoryPrompt: CLI_RESEED_PROMPT,
});
const result = await runPreparedCliAgent(context);
expect(result.payloads).toEqual([{ text: "hello from fresh cli" }]);
expect(supervisorSpawnMock).toHaveBeenCalledTimes(2);
});
it("does not retry or fail over after a confirmed message send", async () => {
supervisorSpawnMock.mockClear();
supervisorSpawnMock.mockImplementationOnce(async (...args: unknown[]) => {
const input = args[0] as Parameters<ReturnType<typeof getProcessSupervisor>["spawn"]>[0];
const captureKey = input.env?.OPENCLAW_MCP_CLI_CAPTURE_KEY ?? "";
const captureHandle = markMcpLoopbackToolCallStarted({
captureKey,
toolName: "message",
args: {
action: "send",
channel: "telegram",
target: "chat123",
message: "done",
mediaUrl: "https://example.com/done.png",
},
});
if (!captureHandle) {
throw new Error("Expected message delivery capture");
}
setTimeout(() => {
recordMcpLoopbackToolCallResult({
captureHandle,
toolName: "message",
args: {
action: "send",
channel: "telegram",
target: "chat123",
message: "done",
mediaUrl: "https://example.com/done.png",
},
result: { status: "sent" },
isError: false,
});
markMcpLoopbackToolCallFinished(captureHandle);
}, 10);
return createManagedRun({
reason: "no-output-timeout",
exitCode: null,
exitSignal: "SIGKILL",
durationMs: 200,
stdout: "",
stderr: "",
timedOut: true,
noOutputTimedOut: true,
});
});
const context = buildPreparedContext({
sessionKey: "agent:main:delivered-timeout",
runId: "run-delivered-timeout",
cliSessionId: "stale-cli-session",
provider: "claude-cli",
model: "opus",
openClawHistoryPrompt: CLI_RESEED_PROMPT,
});
context.mcpDeliveryCapture = true;
const result = await runPreparedCliAgent(context);
expect(result.payloads).toBeUndefined();
expect(result.didSendViaMessagingTool).toBe(true);
expect(result.messagingToolSentTexts).toEqual(["done"]);
expect(result.messagingToolSentMediaUrls).toEqual(["https://example.com/done.png"]);
expect(result.messagingToolSentTargets).toEqual([
expect.objectContaining({ tool: "message", provider: "telegram", to: "chat123" }),
]);
expect(result.meta.executionTrace?.attempts?.[0]?.result).toBe("error");
expect(result.meta.agentMeta?.clearCliSessionBinding).toBe(true);
expect(supervisorSpawnMock).toHaveBeenCalledTimes(1);
});
it("preserves first-turn delivery through cleanup without binding the OpenClaw session id", async () => {
supervisorSpawnMock.mockClear();
supervisorSpawnMock.mockImplementationOnce(async (...args: unknown[]) => {
const input = args[0] as Parameters<ReturnType<typeof getProcessSupervisor>["spawn"]>[0];
const captureHandle = markMcpLoopbackToolCallStarted({
captureKey: input.env?.OPENCLAW_MCP_CLI_CAPTURE_KEY ?? "",
toolName: "message",
args: {
action: "send",
message: "sent before failure",
},
});
if (!captureHandle) {
throw new Error("Expected message delivery capture");
}
recordMcpLoopbackToolCallResult({
captureHandle,
toolName: "message",
args: {
action: "send",
message: "sent before failure",
},
result: {
details: {
deliveryStatus: "sent",
sourceReplySink: "internal-ui",
sourceReply: { text: "sent before failure" },
},
},
isError: false,
});
markMcpLoopbackToolCallFinished(captureHandle);
return createManagedRun({
reason: "no-output-timeout",
exitCode: null,
exitSignal: "SIGKILL",
durationMs: 200,
stdout: "",
stderr: "",
timedOut: true,
noOutputTimedOut: true,
});
});
const context = buildPreparedContext({
sessionKey: "agent:main:first-turn-delivered",
runId: "run-first-turn-delivered",
provider: "claude-cli",
model: "opus",
});
context.mcpDeliveryCapture = true;
context.params.sourceReplyDeliveryMode = "message_tool_only";
context.preparedBackend.cleanup = async () => {
throw new Error("cleanup failed");
};
const result = await runPreparedCliAgent(context);
expect(result.didSendViaMessagingTool).toBe(true);
expect(result.didDeliverSourceReplyViaMessageTool).toBe(true);
expect(result.messagingToolSourceReplyPayloads).toEqual([{ text: "sent before failure" }]);
expect(result.payloads).toEqual([{ text: "sent before failure" }]);
expect(getReplyPayloadMetadata(result.payloads?.[0] as object)).toMatchObject({
deliverDespiteSourceReplySuppression: true,
sourceReplyTranscriptMirror: {
sessionKey: "agent:main:first-turn-delivered",
text: "sent before failure",
idempotencyKey: "run-first-turn-delivered:internal-source-reply:0",
},
});
expect(result.meta.agentMeta?.sessionId).toBe("");
expect(result.meta.agentMeta?.clearCliSessionBinding).toBeUndefined();
expect(supervisorSpawnMock).toHaveBeenCalledTimes(1);
});
it("returns only the source-reply mirror after a successful CLI turn", async () => {
supervisorSpawnMock.mockClear();
supervisorSpawnMock.mockImplementationOnce(async (...args: unknown[]) => {
const input = args[0] as Parameters<ReturnType<typeof getProcessSupervisor>["spawn"]>[0];
const captureHandle = markMcpLoopbackToolCallStarted({
captureKey: input.env?.OPENCLAW_MCP_CLI_CAPTURE_KEY ?? "",
toolName: "message",
args: {
action: "send",
message: "sent through source reply",
},
});
if (!captureHandle) {
throw new Error("Expected message delivery capture");
}
recordMcpLoopbackToolCallResult({
captureHandle,
toolName: "message",
args: {
action: "send",
message: "sent through source reply",
},
result: {
details: {
deliveryStatus: "sent",
sourceReplySink: "internal-ui",
sourceReply: { text: "sent through source reply" },
},
},
isError: false,
});
markMcpLoopbackToolCallFinished(captureHandle);
return createManagedRun({
reason: "exit",
exitCode: 0,
exitSignal: null,
durationMs: 50,
stdout: "ordinary final should stay private",
stderr: "",
timedOut: false,
noOutputTimedOut: false,
});
});
const context = buildPreparedContext({
sessionKey: "agent:main:successful-source-reply",
runId: "run-successful-source-reply",
provider: "claude-cli",
model: "opus",
});
context.mcpDeliveryCapture = true;
context.params.sourceReplyDeliveryMode = "message_tool_only";
const result = await runPreparedCliAgent(context);
expect(result.payloads).toEqual([{ text: "sent through source reply" }]);
expect(getReplyPayloadMetadata(result.payloads?.[0] as object)).toMatchObject({
deliverDespiteSourceReplySuppression: true,
sourceReplyTranscriptMirror: {
sessionKey: "agent:main:successful-source-reply",
text: "sent through source reply",
idempotencyKey: "run-successful-source-reply:internal-source-reply:0",
},
});
expect(result.meta.finalAssistantVisibleText).toBe("sent through source reply");
});
it("hooks the visible source reply without pre-persisting its dispatch mirror", async () => {
const { dir, sessionFile, storePath } = createSessionFile();
const hookRunner = {
hasHooks: vi.fn((hookName: string) => ["llm_output", "agent_end"].includes(hookName)),
runLlmInput: vi.fn(async () => undefined),
runLlmOutput: vi.fn(async () => undefined),
runAgentEnd: vi.fn(async () => undefined),
};
setHookRunnerForTest(hookRunner);
supervisorSpawnMock.mockClear();
supervisorSpawnMock.mockImplementationOnce(async (...args: unknown[]) => {
const input = args[0] as Parameters<ReturnType<typeof getProcessSupervisor>["spawn"]>[0];
const captureHandle = markMcpLoopbackToolCallStarted({
captureKey: input.env?.OPENCLAW_MCP_CLI_CAPTURE_KEY ?? "",
toolName: "message",
args: {
action: "send",
message: "visible source reply",
},
});
if (!captureHandle) {
throw new Error("Expected message delivery capture");
}
recordMcpLoopbackToolCallResult({
captureHandle,
toolName: "message",
args: {
action: "send",
message: "visible source reply",
},
result: {
details: {
deliveryStatus: "sent",
sourceReplySink: "internal-ui",
sourceReply: { text: "visible source reply" },
},
},
isError: false,
});
markMcpLoopbackToolCallFinished(captureHandle);
return createManagedRun({
reason: "exit",
exitCode: 0,
exitSignal: null,
durationMs: 50,
stdout: "private terminal confirmation",
stderr: "",
timedOut: false,
noOutputTimedOut: false,
});
});
const context = buildPreparedContext({
sessionKey: "agent:main:main",
runId: "run-visible-source-reply",
provider: "claude-cli",
model: "opus",
});
context.mcpDeliveryCapture = true;
context.params.sourceReplyDeliveryMode = "message_tool_only";
context.params.sessionFile = sessionFile;
context.params.storePath = storePath;
context.params.persistAssistantTranscript = true;
try {
await runPreparedCliAgent(context);
const transcriptMessages = readTranscriptMessages(sessionFile);
expect(transcriptMessages).toHaveLength(0);
const llmOutputEvent = requireRecord(
callArg(hookRunner.runLlmOutput, 0, 0, "llm_output event"),
"llm_output event",
);
expect(llmOutputEvent.assistantTexts).toEqual(["visible source reply"]);
const agentEndEvent = requireRecord(
callArg(hookRunner.runAgentEnd, 0, 0, "agent_end event"),
"agent_end event",
);
const messages = requireArray(agentEndEvent.messages, "agent_end messages");
const lastMessage = requireRecord(messages.at(-1), "agent_end assistant message");
expect(lastMessage.role).toBe("assistant");
expect(lastMessage.content).toEqual([{ type: "text", text: "visible source reply" }]);
} finally {
fs.rmSync(dir, { recursive: true, force: true });
}
});
it("accepts empty terminal output after a confirmed message delivery", async () => {
supervisorSpawnMock.mockClear();
supervisorSpawnMock.mockImplementationOnce(async (...args: unknown[]) => {
const input = args[0] as Parameters<ReturnType<typeof getProcessSupervisor>["spawn"]>[0];
const captureHandle = markMcpLoopbackToolCallStarted({
captureKey: input.env?.OPENCLAW_MCP_CLI_CAPTURE_KEY ?? "",
toolName: "message",
args: {
action: "send",
channel: "telegram",
target: "chat123",
message: "sent without a terminal reply",
},
});
if (!captureHandle) {
throw new Error("Expected message delivery capture");
}
recordMcpLoopbackToolCallResult({
captureHandle,
toolName: "message",
args: {
action: "send",
channel: "telegram",
target: "chat123",
message: "sent without a terminal reply",
},
result: { status: "sent" },
isError: false,
});
markMcpLoopbackToolCallFinished(captureHandle);
input.onStdout?.(
`${JSON.stringify({ type: "result", session_id: "claude-session", result: "" })}\n`,
);
return createManagedRun({
reason: "exit",
exitCode: 0,
exitSignal: null,
durationMs: 50,
stdout: "",
stderr: "",
timedOut: false,
noOutputTimedOut: false,
});
});
const context = buildPreparedContext({
sessionKey: "agent:main:successful-empty-delivery",
runId: "run-successful-empty-delivery",
provider: "claude-cli",
model: "opus",
});
context.backendResolved.config.output = "jsonl";
context.mcpDeliveryCapture = true;
const result = await runPreparedCliAgent(context);
expect(result.payloads).toBeUndefined();
expect(result.didSendViaMessagingTool).toBe(true);
expect(result.meta.executionTrace?.attempts?.[0]?.result).toBe("success");
});
it("keeps unresolved internal source replies retryable", async () => {
vi.useFakeTimers();
supervisorSpawnMock.mockClear();
let captureStarted: (() => void) | undefined;
const captureStartedPromise = new Promise<void>((resolve) => {
captureStarted = resolve;
});
supervisorSpawnMock.mockImplementationOnce(async (...args: unknown[]) => {
const input = args[0] as Parameters<ReturnType<typeof getProcessSupervisor>["spawn"]>[0];
const captureHandle = markMcpLoopbackToolCallStarted({
captureKey: input.env?.OPENCLAW_MCP_CLI_CAPTURE_KEY ?? "",
toolName: "message",
args: {
action: "send",
message: "pending internal source reply",
},
});
if (!captureHandle) {
throw new Error("Expected internal source reply capture");
}
updateMcpLoopbackToolCallCapture(captureHandle, {
toolName: "message",
args: {
action: "send",
message: "pending internal source reply",
},
});
captureStarted?.();
return createManagedRun({
reason: "no-output-timeout",
exitCode: null,
exitSignal: "SIGKILL",
durationMs: 200,
stdout: "",
stderr: "",
timedOut: true,
noOutputTimedOut: true,
});
});
const context = buildPreparedContext({
sessionKey: "agent:main:unresolved-internal-source-reply",
runId: "run-unresolved-internal-source-reply",
provider: "claude-cli",
model: "opus",
});
context.mcpDeliveryCapture = true;
context.params.config = {};
context.params.messageChannel = "webchat";
context.params.sourceReplyDeliveryMode = "message_tool_only";
const resultPromise = runPreparedCliAgent(context);
const resultAssertion = expect(resultPromise).rejects.toThrow("CLI produced no output");
await captureStartedPromise;
await vi.runAllTimersAsync();
await resultAssertion;
expect(supervisorSpawnMock).toHaveBeenCalledTimes(1);
});
it("fails closed when an unresolved implicit send resolves to an external session route", async () => {
vi.useFakeTimers();
supervisorSpawnMock.mockClear();
let captureStarted: (() => void) | undefined;
const captureStartedPromise = new Promise<void>((resolve) => {
captureStarted = resolve;
});
supervisorSpawnMock.mockImplementationOnce(async (...args: unknown[]) => {
const input = args[0] as Parameters<ReturnType<typeof getProcessSupervisor>["spawn"]>[0];
const captureHandle = markMcpLoopbackToolCallStarted({
captureKey: input.env?.OPENCLAW_MCP_CLI_CAPTURE_KEY ?? "",
toolName: "message",
args: {
action: "send",
message: "pending external session reply",
},
});
if (!captureHandle) {
throw new Error("Expected external session reply capture");
}
updateMcpLoopbackToolCallCapture(captureHandle, {
toolName: "message",
args: {
action: "send",
message: "pending external session reply",
},
});
captureStarted?.();
return createManagedRun({
reason: "no-output-timeout",
exitCode: null,
exitSignal: "SIGKILL",
durationMs: 200,
stdout: "",
stderr: "",
timedOut: true,
noOutputTimedOut: true,
});
});
const context = buildPreparedContext({
sessionKey: "agent:main:telegram:direct:123456789",
runId: "run-unresolved-external-session-reply",
provider: "claude-cli",
model: "opus",
});
context.mcpDeliveryCapture = true;
context.params.config = {};
context.params.messageChannel = "webchat";
context.params.sourceReplyDeliveryMode = "message_tool_only";
const resultPromise = runPreparedCliAgent(context);
await captureStartedPromise;
await vi.runAllTimersAsync();
const result = await resultPromise;
expect(result.didSendViaMessagingTool).toBe(true);
expect(supervisorSpawnMock).toHaveBeenCalledTimes(1);
});
it("surfaces prepared backend cleanup failures when nothing was delivered", async () => {
supervisorSpawnMock.mockResolvedValueOnce(
createManagedRun({
reason: "exit",
exitCode: 0,
exitSignal: null,
durationMs: 50,
stdout: "ok",
stderr: "",
timedOut: false,
noOutputTimedOut: false,
}),
);
const context = buildPreparedContext({
sessionKey: "agent:main:cleanup-failure",
runId: "run-cleanup-failure",
});
context.preparedBackend.cleanup = async () => {
throw new Error("cleanup failed");
};
await expect(runPreparedCliAgent(context)).rejects.toThrow("cleanup failed");
});
it("bounds unresolved message sends and does not retry them", async () => {
vi.useFakeTimers();
supervisorSpawnMock.mockClear();
let captureStarted: (() => void) | undefined;
const captureStartedPromise = new Promise<void>((resolve) => {
captureStarted = resolve;
});
supervisorSpawnMock.mockImplementationOnce(async (...args: unknown[]) => {
const input = args[0] as Parameters<ReturnType<typeof getProcessSupervisor>["spawn"]>[0];
const captureHandle = markMcpLoopbackToolCallStarted({
captureKey: input.env?.OPENCLAW_MCP_CLI_CAPTURE_KEY ?? "",
toolName: "message",
args: {
action: "react",
channel: "telegram",
target: "chat123",
},
});
if (!captureHandle) {
throw new Error("Expected message delivery capture");
}
updateMcpLoopbackToolCallCapture(captureHandle, {
toolName: "message",
args: {
action: "send",
channel: "telegram",
target: "chat123",
message: "possibly sent",
},
});
captureStarted?.();
return createManagedRun({
reason: "no-output-timeout",
exitCode: null,
exitSignal: "SIGKILL",
durationMs: 200,
stdout: "",
stderr: "",
timedOut: true,
noOutputTimedOut: true,
});
});
const context = buildPreparedContext({
sessionKey: "agent:main:unresolved-send",
runId: "run-unresolved-send",
cliSessionId: "stale-cli-session",
provider: "claude-cli",
model: "opus",
openClawHistoryPrompt: CLI_RESEED_PROMPT,
});
context.mcpDeliveryCapture = true;
const resultPromise = runPreparedCliAgent(context);
await captureStartedPromise;
await vi.runAllTimersAsync();
const result = await resultPromise;
expect(result.payloads).toBeUndefined();
expect(result.didSendViaMessagingTool).toBe(true);
expect(supervisorSpawnMock).toHaveBeenCalledTimes(1);
});
it("bounds admitted requests that have not finished uploading", async () => {
vi.useFakeTimers();
supervisorSpawnMock.mockClear();
let captureStarted: (() => void) | undefined;
const captureStartedPromise = new Promise<void>((resolve) => {
captureStarted = resolve;
});
supervisorSpawnMock.mockImplementationOnce(async (...args: unknown[]) => {
const input = args[0] as Parameters<ReturnType<typeof getProcessSupervisor>["spawn"]>[0];
const captureHandle = markMcpLoopbackRequestStarted(
input.env?.OPENCLAW_MCP_CLI_CAPTURE_KEY ?? "",
);
if (!captureHandle) {
throw new Error("Expected request delivery capture");
}
captureStarted?.();
return createManagedRun({
reason: "no-output-timeout",
exitCode: null,
exitSignal: "SIGKILL",
durationMs: 200,
stdout: "",
stderr: "",
timedOut: true,
noOutputTimedOut: true,
});
});
const context = buildPreparedContext({
sessionKey: "agent:main:unresolved-request",
runId: "run-unresolved-request",
cliSessionId: "stale-cli-session",
provider: "claude-cli",
model: "opus",
openClawHistoryPrompt: CLI_RESEED_PROMPT,
});
context.mcpDeliveryCapture = true;
const resultPromise = runPreparedCliAgent(context);
await captureStartedPromise;
await vi.runAllTimersAsync();
const result = await resultPromise;
expect(result.payloads).toBeUndefined();
expect(result.didSendViaMessagingTool).toBe(true);
expect(supervisorSpawnMock).toHaveBeenCalledTimes(1);
});
it("does not treat classified non-message requests as delivery", async () => {
vi.useFakeTimers();
supervisorSpawnMock.mockClear();
let captureStarted: (() => void) | undefined;
const captureStartedPromise = new Promise<void>((resolve) => {
captureStarted = resolve;
});
supervisorSpawnMock.mockImplementationOnce(async (...args: unknown[]) => {
const input = args[0] as Parameters<ReturnType<typeof getProcessSupervisor>["spawn"]>[0];
const requestCaptureHandle = markMcpLoopbackRequestStarted(
input.env?.OPENCLAW_MCP_CLI_CAPTURE_KEY ?? "",
);
if (!requestCaptureHandle) {
throw new Error("Expected request delivery capture");
}
markMcpLoopbackToolCallStarted({
requestCaptureHandle,
toolName: "exec",
args: { command: "sleep 30" },
});
markMcpLoopbackRequestClassified(requestCaptureHandle);
captureStarted?.();
return createManagedRun({
reason: "no-output-timeout",
exitCode: null,
exitSignal: "SIGKILL",
durationMs: 200,
stdout: "",
stderr: "",
timedOut: true,
noOutputTimedOut: true,
});
});
const context = buildPreparedContext({
sessionKey: "agent:main:unresolved-non-message-request",
runId: "run-unresolved-non-message-request",
cliSessionId: "stale-cli-session",
provider: "claude-cli",
model: "opus",
openClawHistoryPrompt: CLI_RESEED_PROMPT,
});
context.mcpDeliveryCapture = true;
const resultPromise = runPreparedCliAgent(context);
const resultAssertion = expect(resultPromise).rejects.toThrow("produced no output");
await captureStartedPromise;
await vi.runAllTimersAsync();
await resultAssertion;
expect(supervisorSpawnMock).toHaveBeenCalledTimes(1);
});
it("fails normally after an unresolved prepared dry-run send", async () => {
vi.useFakeTimers();
supervisorSpawnMock.mockClear();
let captureStarted: (() => void) | undefined;
const captureStartedPromise = new Promise<void>((resolve) => {
captureStarted = resolve;
});
supervisorSpawnMock.mockImplementationOnce(async (...args: unknown[]) => {
const input = args[0] as Parameters<ReturnType<typeof getProcessSupervisor>["spawn"]>[0];
const captureHandle = markMcpLoopbackToolCallStarted({
captureKey: input.env?.OPENCLAW_MCP_CLI_CAPTURE_KEY ?? "",
toolName: "message",
args: {
action: "send",
channel: "telegram",
target: "chat123",
message: "preview",
},
});
updateMcpLoopbackToolCallCapture(captureHandle, {
toolName: "message",
args: {
action: "send",
channel: "telegram",
target: "chat123",
message: "preview",
dryRun: true,
},
});
captureStarted?.();
return createManagedRun({
reason: "no-output-timeout",
exitCode: null,
exitSignal: "SIGKILL",
durationMs: 200,
stdout: "",
stderr: "",
timedOut: true,
noOutputTimedOut: true,
});
});
const context = buildPreparedContext({
sessionKey: "agent:main:unresolved-dry-run",
runId: "run-unresolved-dry-run",
cliSessionId: "stale-cli-session",
provider: "claude-cli",
model: "opus",
openClawHistoryPrompt: CLI_RESEED_PROMPT,
});
context.mcpDeliveryCapture = true;
const resultPromise = runPreparedCliAgent(context);
const resultAssertion = expect(resultPromise).rejects.toThrow("produced no output");
await captureStartedPromise;
await vi.runAllTimersAsync();
await resultAssertion;
expect(supervisorSpawnMock).toHaveBeenCalledTimes(1);
});
it("does not retry an unclassified CLI failure with diagnostic output", async () => {
supervisorSpawnMock.mockClear();
const clearBeforeRetry = vi.fn(async () => true);
supervisorSpawnMock.mockResolvedValueOnce(
createManagedRun({
reason: "exit",
exitCode: 1,
exitSignal: null,
durationMs: 150,
stdout: "",
stderr: "worker crashed without details",
timedOut: false,
noOutputTimedOut: false,
}),
);
const context = buildPreparedContext({
sessionKey: "agent:main:unknown-output",
runId: "run-unknown-output",
cliSessionId: "stale-cli-session",
provider: "claude-cli",
model: "opus",
openClawHistoryPrompt: CLI_RESEED_PROMPT,
});
await expect(
runPreparedCliAgent({
...context,
params: {
...context.params,
onBeforeFreshCliSessionRetry: clearBeforeRetry,
},
}),
).rejects.toThrow("worker crashed without details");
expect(supervisorSpawnMock).toHaveBeenCalledTimes(1);
expect(clearBeforeRetry).not.toHaveBeenCalled();
});
it("does not fresh retry when the run timeout budget is exhausted", async () => {
supervisorSpawnMock.mockClear();
const clearBeforeRetry = vi.fn(async () => true);
supervisorSpawnMock.mockResolvedValueOnce(
createManagedRun({
reason: "no-output-timeout",
exitCode: null,
exitSignal: "SIGKILL",
durationMs: 1_000,
stdout: "",
stderr: "",
timedOut: true,
noOutputTimedOut: true,
}),
);
const context = buildPreparedContext({
sessionKey: "agent:main:expired-budget",
runId: "run-expired-budget",
cliSessionId: "stale-cli-session",
provider: "claude-cli",
model: "opus",
openClawHistoryPrompt: CLI_RESEED_PROMPT,
});
const expiredBudgetContext = {
...context,
started: Date.now() - context.params.timeoutMs - 1,
};
await expect(
runPreparedCliAgent({
...expiredBudgetContext,
params: {
...expiredBudgetContext.params,
onBeforeFreshCliSessionRetry: clearBeforeRetry,
},
}),
).rejects.toThrow("produced no output");
expect(supervisorSpawnMock).toHaveBeenCalledTimes(1);
expect(clearBeforeRetry).not.toHaveBeenCalled();
});
it("does not fresh retry a no-output timeout after CLI diagnostic output", async () => {
supervisorSpawnMock.mockClear();
enqueueSystemEventMock.mockClear();
const clearBeforeRetry = vi.fn(async () => true);
supervisorSpawnMock.mockResolvedValueOnce(
createManagedRun({
reason: "no-output-timeout",
exitCode: null,
exitSignal: "SIGKILL",
durationMs: 500,
stdout: "partial progress before the stall",
stderr: "",
timedOut: true,
noOutputTimedOut: true,
}),
);
const context = buildPreparedContext({
sessionKey: "agent:main:timeout-after-output",
runId: "run-timeout-after-output",
cliSessionId: "stale-cli-session",
provider: "claude-cli",
model: "opus",
openClawHistoryPrompt: CLI_RESEED_PROMPT,
});
await expect(
runPreparedCliAgent({
...context,
params: {
...context.params,
onBeforeFreshCliSessionRetry: clearBeforeRetry,
},
}),
).rejects.toThrow("produced no output");
expect(supervisorSpawnMock).toHaveBeenCalledTimes(1);
expect(clearBeforeRetry).not.toHaveBeenCalled();
expect(enqueueSystemEventMock).toHaveBeenCalledTimes(1);
});
it("does not fresh retry an empty supervisor cancellation", async () => {
supervisorSpawnMock.mockClear();
const clearBeforeRetry = vi.fn(async () => true);
supervisorSpawnMock.mockResolvedValueOnce(
createManagedRun({
reason: "manual-cancel",
exitCode: null,
exitSignal: null,
durationMs: 50,
stdout: "",
stderr: "",
timedOut: false,
noOutputTimedOut: false,
}),
);
const context = buildPreparedContext({
sessionKey: "agent:main:manual-cancel",
runId: "run-manual-cancel",
cliSessionId: "stale-cli-session",
provider: "claude-cli",
model: "opus",
openClawHistoryPrompt: CLI_RESEED_PROMPT,
});
await expect(
runPreparedCliAgent({
...context,
params: {
...context.params,
onBeforeFreshCliSessionRetry: clearBeforeRetry,
},
}),
).rejects.toThrow("CLI failed");
expect(supervisorSpawnMock).toHaveBeenCalledTimes(1);
expect(clearBeforeRetry).not.toHaveBeenCalled();
});
it.each(["timeout", "unknown"] as const)(
"retries a fresh CLI session after recoverable %s failover without a failed agent_end",
async (reason) => {
const hookRunner = {
hasHooks: vi.fn((hookName: string) =>
["llm_input", "llm_output", "agent_end"].includes(hookName),
),
runLlmInput: vi.fn(async () => undefined),
runLlmOutput: vi.fn(async () => undefined),
runAgentEnd: vi.fn(async () => undefined),
};
setHookRunnerForTest(hookRunner);
supervisorSpawnMock.mockClear();
enqueueSystemEventMock.mockClear();
requestHeartbeatMock.mockClear();
const events: string[] = [];
let spawnCount = 0;
supervisorSpawnMock.mockImplementation(async () => {
spawnCount += 1;
events.push(`spawn-${spawnCount}`);
if (spawnCount === 1 && reason === "timeout") {
return createManagedRun({
reason: "no-output-timeout",
exitCode: null,
exitSignal: "SIGKILL",
durationMs: 200,
stdout: "",
stderr: "",
timedOut: true,
noOutputTimedOut: true,
});
}
if (spawnCount === 1) {
return createManagedRun({
reason: "exit",
exitCode: 1,
exitSignal: null,
durationMs: 150,
stdout: "",
stderr: "",
timedOut: false,
noOutputTimedOut: false,
});
}
return createManagedRun({
reason: "exit",
exitCode: 0,
exitSignal: null,
durationMs: 50,
stdout: "hello from fresh cli",
stderr: "",
timedOut: false,
noOutputTimedOut: false,
});
});
const { dir, sessionFile } = createSessionFile({
history: [{ role: "user", content: "earlier context" }],
});
const clearBeforeRetry = vi.fn(async () => {
events.push(`clear-${reason}`);
return true;
});
try {
const context = buildPreparedContext({
sessionKey: "agent:main:subagent:retry",
runId: `run-retry-${reason}`,
cliSessionId: "stale-cli-session",
provider: "claude-cli",
model: "opus",
openClawHistoryPrompt: CLI_RESEED_PROMPT,
});
const result = await runPreparedCliAgent({
...context,
params: {
...context.params,
agentId: "main",
sessionFile,
workspaceDir: dir,
onBeforeFreshCliSessionRetry: clearBeforeRetry,
},
});
expect(result.payloads).toEqual([{ text: "hello from fresh cli" }]);
expect(supervisorSpawnMock).toHaveBeenCalledTimes(2);
expect(events).toEqual(["spawn-1", `clear-${reason}`, "spawn-2"]);
if (reason === "timeout") {
expect(enqueueSystemEventMock).not.toHaveBeenCalled();
expect(requestHeartbeatMock).not.toHaveBeenCalled();
}
expect(clearBeforeRetry).toHaveBeenCalledWith({
provider: "claude-cli",
reason,
sessionId: "stale-cli-session",
});
await vi.waitFor(() => {
expect(hookRunner.runLlmInput).toHaveBeenCalledTimes(1);
expect(hookRunner.runLlmOutput).toHaveBeenCalledTimes(1);
expect(hookRunner.runAgentEnd).toHaveBeenCalledTimes(1);
});
const agentEndEvent = requireRecord(
callArg(hookRunner.runAgentEnd, 0, 0, "agent_end event"),
"agent_end event",
);
expect(agentEndEvent.success).toBe(true);
expect(agentEndEvent.error).toBeUndefined();
} finally {
fs.rmSync(dir, { recursive: true, force: true });
}
},
);
it("rethrows the retry failure when session-expired recovery retry also fails", async () => {
const hookRunner = {
hasHooks: vi.fn((hookName: string) => ["llm_input", "agent_end"].includes(hookName)),
runLlmInput: vi.fn(async () => undefined),
runLlmOutput: vi.fn(async () => undefined),
runAgentEnd: vi.fn(async () => undefined),
};
setHookRunnerForTest(hookRunner);
supervisorSpawnMock.mockClear();
supervisorSpawnMock.mockResolvedValueOnce(
createManagedRun({
reason: "exit",
exitCode: 1,
exitSignal: null,
durationMs: 150,
stdout: "",
stderr: "session expired",
timedOut: false,
noOutputTimedOut: false,
}),
);
supervisorSpawnMock.mockResolvedValueOnce(
createManagedRun({
reason: "exit",
exitCode: 1,
exitSignal: null,
durationMs: 150,
stdout: "",
stderr: "rate limit exceeded",
timedOut: false,
noOutputTimedOut: false,
}),
);
const { dir, sessionFile } = createSessionFile({
history: [{ role: "user", content: "earlier context" }],
});
const context = buildPreparedContext({
sessionKey: "agent:main:subagent:retry",
runId: "run-retry-failure",
cliSessionId: "thread-123",
openClawHistoryPrompt: CLI_RESEED_PROMPT,
});
const clearBeforeRetry = vi.fn(async () => true);
try {
await expect(
runPreparedCliAgent({
...context,
params: {
...context.params,
agentId: "main",
sessionFile,
workspaceDir: dir,
onBeforeFreshCliSessionRetry: clearBeforeRetry,
},
}),
).rejects.toThrow("rate limit exceeded");
expect(supervisorSpawnMock).toHaveBeenCalledTimes(2);
await vi.waitFor(() => {
expect(hookRunner.runLlmInput).toHaveBeenCalledTimes(1);
expect(hookRunner.runAgentEnd).toHaveBeenCalledTimes(1);
});
const agentEndEvent = requireRecord(
callArg(hookRunner.runAgentEnd, 0, 0, "agent_end event"),
"agent_end event",
);
expect(agentEndEvent.success).toBe(false);
expect(agentEndEvent.error).toBe("rate limit exceeded");
const messages = requireArray(agentEndEvent.messages, "agent_end messages");
expect(messages).toHaveLength(2);
expectTextMessage(messages[0], { role: "user", content: "earlier context" });
expectTextMessage(messages[1], { role: "user", content: "hi" });
expect(callArg(hookRunner.runAgentEnd, 0, 1, "agent_end context")).toBeTypeOf("object");
} finally {
fs.rmSync(dir, { recursive: true, force: true });
}
});
it("returns the assembled CLI prompt in meta for raw trace consumers", async () => {
supervisorSpawnMock.mockResolvedValueOnce(
createManagedRun({
reason: "exit",
exitCode: 0,
exitSignal: null,
durationMs: 50,
stdout: "hello from cli",
stderr: "",
timedOut: false,
noOutputTimedOut: false,
}),
);
const result = await runPreparedCliAgent({
...buildPreparedContext(),
bootstrapPromptWarningLines: ["Warning: prompt budget low."],
});
expect(result.meta.finalPromptText).toContain("Warning: prompt budget low.");
expect(result.meta.finalPromptText).toContain("hi");
expect(result.meta.finalAssistantRawText).toBe("hello from cli");
const executionTrace = requireRecord(result.meta.executionTrace, "execution trace");
expect(executionTrace.winnerProvider).toBe("codex-cli");
expect(executionTrace.winnerModel).toBe("gpt-5.4");
expect(executionTrace.fallbackUsed).toBe(false);
expect(executionTrace.runner).toBe("cli");
expect(executionTrace.attempts).toEqual([
{ provider: "codex-cli", model: "gpt-5.4", result: "success" },
]);
const requestShaping = requireRecord(result.meta.requestShaping, "request shaping");
expect(requestShaping.thinking).toBe("low");
const completion = requireRecord(result.meta.completion, "completion");
expect(completion.finishReason).toBe("stop");
expect(completion.stopReason).toBe("completed");
expect(completion.refusal).toBe(false);
});
it("marks CLI runs as paused after sessions_yield", async () => {
supervisorSpawnMock.mockImplementationOnce(async (...args: unknown[]) => {
const input = args[0] as Parameters<ReturnType<typeof getProcessSupervisor>["spawn"]>[0];
const captureHandle = markMcpLoopbackRequestStarted(input.env?.OPENCLAW_MCP_CLI_CAPTURE_KEY);
await resolveMcpLoopbackYieldContext(captureHandle)?.onYield("waiting on subagents");
markMcpLoopbackRequestFinished(captureHandle);
input.onStdout?.("yield acknowledged");
return createManagedRun({
reason: "exit",
exitCode: 0,
exitSignal: null,
durationMs: 50,
stdout: "",
stderr: "",
timedOut: false,
noOutputTimedOut: false,
});
});
const context = buildPreparedContext();
context.mcpDeliveryCapture = true;
const result = await runPreparedCliAgent(context);
expect(result.meta).toMatchObject({
yielded: true,
livenessState: "paused",
stopReason: "end_turn",
completion: {
finishReason: "end_turn",
stopReason: "end_turn",
refusal: false,
},
});
});
it("seeds fresh CLI sessions from the OpenClaw transcript", async () => {
supervisorSpawnMock.mockResolvedValueOnce(
createManagedRun({
reason: "exit",
exitCode: 0,
exitSignal: null,
durationMs: 50,
stdout: "hello from cli",
stderr: "",
timedOut: false,
noOutputTimedOut: false,
}),
);
const result = await runPreparedCliAgent(
buildPreparedContext({
openClawHistoryPrompt:
"Continue this conversation using the OpenClaw transcript below.\n\nUser: earlier ask\n\nAssistant: earlier answer\n\n<next_user_message>\nhi\n</next_user_message>",
}),
);
expect(result.meta.finalPromptText).toContain("User: earlier ask");
expect(result.meta.finalPromptText).toContain("Assistant: earlier answer");
});
it("keeps resumed CLI sessions on native resume history", async () => {
supervisorSpawnMock.mockResolvedValueOnce(
createManagedRun({
reason: "exit",
exitCode: 0,
exitSignal: null,
durationMs: 50,
stdout: "hello from cli",
stderr: "",
timedOut: false,
noOutputTimedOut: false,
}),
);
const result = await runPreparedCliAgent(
buildPreparedContext({
cliSessionId: "cli-session",
openClawHistoryPrompt: "User: earlier ask",
}),
);
expect(result.meta.finalPromptText).not.toContain("User: earlier ask");
expect(result.meta.finalPromptText).toContain("hi");
});
it("reports CLI reply backends as streaming until the managed run finishes", async () => {
const operation = createReplyOperation({
sessionKey: "agent:main:main",
sessionId: "s1",
resetTriggered: false,
});
operation.setPhase("running");
let finishRun: (() => void) | undefined;
const waitForExit = new Promise<
Awaited<ReturnType<ReturnType<typeof createManagedRun>["wait"]>>
>((resolve) => {
finishRun = () => {
resolve({
reason: "exit",
exitCode: 0,
exitSignal: null,
durationMs: 50,
stdout: "hello from cli",
stderr: "",
timedOut: false,
noOutputTimedOut: false,
});
};
});
supervisorSpawnMock.mockResolvedValueOnce({
...createManagedRun({
reason: "exit",
exitCode: 0,
exitSignal: null,
durationMs: 50,
stdout: "unused",
stderr: "",
timedOut: false,
noOutputTimedOut: false,
}),
wait: vi.fn(() => waitForExit),
});
const run = executePreparedCliRun({
...buildPreparedContext({ sessionKey: "agent:main:main" }),
params: {
...buildPreparedContext({ sessionKey: "agent:main:main" }).params,
replyOperation: operation,
},
});
await vi.waitFor(() => {
expect(replyRunRegistry.isStreaming("agent:main:main")).toBe(true);
});
finishRun?.();
const result = await run;
expect(result.text).toBe("hello from cli");
expect(replyRunRegistry.isStreaming("agent:main:main")).toBe(false);
operation.complete();
});
it("keeps raw assistant output separate from transformed visible CLI output", async () => {
supervisorSpawnMock.mockResolvedValueOnce(
createManagedRun({
reason: "exit",
exitCode: 0,
exitSignal: null,
durationMs: 50,
stdout: "hello from cli",
stderr: "",
timedOut: false,
noOutputTimedOut: false,
}),
);
const result = await runPreparedCliAgent({
...buildPreparedContext(),
backendResolved: {
...buildPreparedContext().backendResolved,
textTransforms: {
output: [{ from: "hello", to: "goodbye" }],
},
},
});
expect(result.payloads).toEqual([{ text: "goodbye from cli" }]);
expect(result.meta.finalAssistantVisibleText).toBe("goodbye from cli");
expect(result.meta.finalAssistantRawText).toBe("hello from cli");
});
it("emits llm_input, llm_output, and agent_end hooks for successful CLI runs", async () => {
const hookRunner = {
hasHooks: vi.fn((hookName: string) =>
["llm_input", "llm_output", "agent_end"].includes(hookName),
),
runLlmInput: vi.fn(async () => undefined),
runLlmOutput: vi.fn(async () => undefined),
runAgentEnd: vi.fn(async () => undefined),
};
setHookRunnerForTest(hookRunner);
const { dir, sessionFile } = createSessionFile();
supervisorSpawnMock.mockResolvedValueOnce(
createManagedRun({
reason: "exit",
exitCode: 0,
exitSignal: null,
durationMs: 50,
stdout: "hello from cli",
stderr: "",
timedOut: false,
noOutputTimedOut: false,
}),
);
try {
await runPreparedCliAgent({
...buildPreparedContext(),
params: {
...buildPreparedContext().params,
sessionFile,
workspaceDir: dir,
sessionKey: "agent:main:main",
agentId: "main",
messageProvider: "acp",
messageChannel: "telegram",
trigger: "user",
},
});
await vi.waitFor(() => {
expect(hookRunner.runLlmInput).toHaveBeenCalledTimes(1);
expect(hookRunner.runLlmOutput).toHaveBeenCalledTimes(1);
expect(hookRunner.runAgentEnd).toHaveBeenCalledTimes(1);
});
const llmInputEvent = requireRecord(
callArg(hookRunner.runLlmInput, 0, 0, "llm_input event"),
"llm_input event",
);
expect(llmInputEvent.runId).toBe("run-2");
expect(llmInputEvent.sessionId).toBe("s1");
expect(llmInputEvent.provider).toBe("codex-cli");
expect(llmInputEvent.model).toBe("gpt-5.4");
expect(llmInputEvent.prompt).toBe("hi");
expect(llmInputEvent.systemPrompt).toBe("You are a helpful assistant.");
expect(Array.isArray(llmInputEvent.historyMessages)).toBe(true);
expect(llmInputEvent.imagesCount).toBe(0);
const llmInputContext = requireRecord(
callArg(hookRunner.runLlmInput, 0, 1, "llm_input context"),
"llm_input context",
);
expect(llmInputContext.runId).toBe("run-2");
expect(llmInputContext.agentId).toBe("main");
expect(llmInputContext.sessionKey).toBe("agent:main:main");
expect(llmInputContext.sessionId).toBe("s1");
expect(llmInputContext.workspaceDir).toBe(dir);
expect(llmInputContext.messageProvider).toBe("acp");
expect(llmInputContext.trigger).toBe("user");
expect(llmInputContext.channelId).toBe("telegram");
const llmOutputEvent = requireRecord(
callArg(hookRunner.runLlmOutput, 0, 0, "llm_output event"),
"llm_output event",
);
expect(llmOutputEvent.runId).toBe("run-2");
expect(llmOutputEvent.sessionId).toBe("s1");
expect(llmOutputEvent.provider).toBe("codex-cli");
expect(llmOutputEvent.model).toBe("gpt-5.4");
expect(llmOutputEvent.contextTokenBudget).toBe(150_000);
expect(llmOutputEvent.contextWindowSource).toBe("agentContextTokens");
expect(llmOutputEvent.contextWindowReferenceTokens).toBe(200_000);
expect(llmOutputEvent.assistantTexts).toEqual(["hello from cli"]);
const lastAssistant = requireRecord(llmOutputEvent.lastAssistant, "last assistant");
expect(lastAssistant.role).toBe("assistant");
expect(lastAssistant.content).toEqual([{ type: "text", text: "hello from cli" }]);
expect(lastAssistant.provider).toBe("codex-cli");
expect(lastAssistant.model).toBe("gpt-5.4");
const llmOutputContext = requireRecord(
callArg(hookRunner.runLlmOutput, 0, 1, "llm_output context"),
"llm_output context",
);
expect(llmOutputContext.contextTokenBudget).toBe(150_000);
expect(llmOutputContext.contextWindowSource).toBe("agentContextTokens");
expect(llmOutputContext.contextWindowReferenceTokens).toBe(200_000);
const agentEndEvent = requireRecord(
callArg(hookRunner.runAgentEnd, 0, 0, "agent_end event"),
"agent_end event",
);
expect(agentEndEvent.success).toBe(true);
const messages = requireArray(agentEndEvent.messages, "agent_end messages");
expect(messages).toHaveLength(2);
expectTextMessage(messages[0], { role: "user", content: "hi" });
const assistantMessage = requireRecord(messages[1], "assistant message");
expect(assistantMessage.role).toBe("assistant");
expect(assistantMessage.content).toEqual([{ type: "text", text: "hello from cli" }]);
expect(callArg(hookRunner.runAgentEnd, 0, 1, "agent_end context")).toBeTypeOf("object");
} finally {
fs.rmSync(dir, { recursive: true, force: true });
}
});
it("waits for agent_end hooks before resolving successful CLI runs", async () => {
let releaseAgentEnd: () => void = () => undefined;
const agentEndSettled = new Promise<void>((resolve) => {
releaseAgentEnd = resolve;
});
const hookRunner = {
hasHooks: vi.fn((hookName: string) => hookName === "agent_end"),
runLlmInput: vi.fn(async () => undefined),
runLlmOutput: vi.fn(async () => undefined),
runAgentEnd: vi.fn(() => agentEndSettled),
};
setHookRunnerForTest(hookRunner);
supervisorSpawnMock.mockResolvedValueOnce(
createManagedRun({
reason: "exit",
exitCode: 0,
exitSignal: null,
durationMs: 50,
stdout: "hello from cli",
stderr: "",
timedOut: false,
noOutputTimedOut: false,
}),
);
let resolved = false;
const run = runPreparedCliAgent(buildPreparedContext()).then((result) => {
resolved = true;
return result;
});
await vi.waitFor(() => {
expect(hookRunner.runAgentEnd).toHaveBeenCalledTimes(1);
});
await Promise.resolve();
expect(resolved).toBe(false);
releaseAgentEnd();
await expect(run).resolves.toMatchObject({
payloads: [{ text: "hello from cli" }],
});
expect(resolved).toBe(true);
});
it("waits for eligible Skill Research auto-capture before resolving direct CLI runs", async () => {
let releaseAutoCapture: () => void = () => undefined;
const autoCaptureSettled = new Promise<void>((resolve) => {
releaseAutoCapture = resolve;
});
mockAutoCapture.mockReturnValueOnce(autoCaptureSettled);
supervisorSpawnMock.mockResolvedValueOnce(
createManagedRun({
reason: "exit",
exitCode: 0,
exitSignal: null,
durationMs: 50,
stdout: "hello from cli",
stderr: "",
timedOut: false,
noOutputTimedOut: false,
}),
);
const context = buildPreparedContext({ sessionKey: "agent:main:main" });
let resolved = false;
const run = runPreparedCliAgent({
...context,
params: {
...context.params,
agentId: "main",
trigger: "user",
config: {
skills: {
workshop: {
autonomous: {
enabled: true,
},
},
},
},
},
}).then((result) => {
resolved = true;
return result;
});
await vi.waitFor(() => {
expect(mockAutoCapture).toHaveBeenCalledTimes(1);
});
await Promise.resolve();
expect(resolved).toBe(false);
expect(mockAutoCapture).toHaveBeenCalledWith(
expect.objectContaining({
ctx: expect.objectContaining({
agentId: "main",
sessionKey: "agent:main:main",
trigger: "user",
}),
}),
);
releaseAutoCapture();
await expect(run).resolves.toMatchObject({
payloads: [{ text: "hello from cli" }],
});
expect(resolved).toBe(true);
});
it("does not wait for agent_end hooks before resolving channel-backed CLI runs", async () => {
let releaseAgentEnd: () => void = () => undefined;
const agentEndSettled = new Promise<void>((resolve) => {
releaseAgentEnd = resolve;
});
const hookRunner = {
hasHooks: vi.fn((hookName: string) => hookName === "agent_end"),
runLlmInput: vi.fn(async () => undefined),
runLlmOutput: vi.fn(async () => undefined),
runAgentEnd: vi.fn(() => agentEndSettled),
};
setHookRunnerForTest(hookRunner);
supervisorSpawnMock.mockResolvedValueOnce(
createManagedRun({
reason: "exit",
exitCode: 0,
exitSignal: null,
durationMs: 50,
stdout: "hello from cli",
stderr: "",
timedOut: false,
noOutputTimedOut: false,
}),
);
const context = buildPreparedContext();
let resolved = false;
const run = runPreparedCliAgent({
...context,
params: {
...context.params,
messageProvider: "acp",
messageChannel: "telegram",
},
}).then((result) => {
resolved = true;
return result;
});
await vi.waitFor(() => {
expect(hookRunner.runAgentEnd).toHaveBeenCalledTimes(1);
});
await vi.waitFor(() => {
expect(resolved).toBe(true);
});
await expect(run).resolves.toMatchObject({
payloads: [{ text: "hello from cli" }],
});
expect(callArg(hookRunner.runAgentEnd, 0, 2, "agent_end options")).toEqual({
unrefTimeout: true,
});
releaseAgentEnd();
});
it("persists approved CLI user turns and successful assistant output", async () => {
supervisorSpawnMock.mockResolvedValueOnce(
createManagedRun({
reason: "exit",
exitCode: 0,
exitSignal: null,
durationMs: 50,
stdout: "hello from cli",
stderr: "",
timedOut: false,
noOutputTimedOut: false,
}),
);
const { dir, sessionFile, storePath } = createSessionFile();
const onUserMessagePersisted = vi.fn();
try {
const context = buildPreparedContext({
sessionKey: "agent:main:main",
runId: "run-persist-cli",
});
const result = await runPreparedCliAgent({
...context,
params: {
...context.params,
agentId: "main",
sessionFile,
workspaceDir: dir,
prompt: "runtime prompt",
persistAssistantTranscript: true,
storePath,
userTurnTranscriptRecorder: createCliUserTurnRecorder({
text: "display prompt",
sessionFile,
sessionKey: "agent:main:main",
workspaceDir: dir,
}),
onUserMessagePersisted,
},
});
expect(result.payloads).toEqual([{ text: "hello from cli" }]);
expect(getReplyPayloadMetadata(result.payloads?.[0] ?? {})).toMatchObject({
assistantTranscriptOwned: true,
});
expect(onUserMessagePersisted).toHaveBeenCalledOnce();
expect(onUserMessagePersisted).toHaveBeenCalledWith(
expect.objectContaining({
role: "user",
content: "display prompt",
}),
);
const messages = readTranscriptMessages(sessionFile);
expect(messages).toContainEqual(
expect.objectContaining({
role: "user",
content: "display prompt",
}),
);
expect(messages).toContainEqual(
expect.objectContaining({
role: "assistant",
content: [{ type: "text", text: "hello from cli" }],
api: "cli",
provider: "codex-cli",
model: "gpt-5.4",
idempotencyKey: "cli-assistant:run-persist-cli",
}),
);
expect(JSON.stringify(messages)).not.toContain("runtime prompt");
} finally {
fs.rmSync(dir, { recursive: true, force: true });
}
});
it("lets before_message_write block CLI assistant persistence without delivery fallback", async () => {
const hookRunner = {
hasHooks: vi.fn((hookName: string) => hookName === "before_message_write"),
runBeforeMessageWrite: vi.fn(() => ({ block: true })),
};
setHookRunnerForTest(hookRunner);
supervisorSpawnMock.mockResolvedValueOnce(
createManagedRun({
reason: "exit",
exitCode: 0,
exitSignal: null,
durationMs: 50,
stdout: "secret CLI output",
stderr: "",
timedOut: false,
noOutputTimedOut: false,
}),
);
const { dir, sessionFile, storePath } = createSessionFile();
try {
const context = buildPreparedContext({
sessionKey: "agent:main:main",
runId: "run-blocked-cli",
});
const result = await runPreparedCliAgent({
...context,
params: {
...context.params,
agentId: "main",
sessionFile,
workspaceDir: dir,
persistAssistantTranscript: true,
storePath,
},
});
expect(result.payloads).toEqual([{ text: "secret CLI output" }]);
expect(getReplyPayloadMetadata(result.payloads?.[0] ?? {})).toMatchObject({
assistantTranscriptOwned: true,
});
expect(readTranscriptMessages(sessionFile)).toEqual([]);
expect(hookRunner.runBeforeMessageWrite).toHaveBeenCalledOnce();
expect(
callArg(hookRunner.runBeforeMessageWrite, 0, 1, "before_message_write context"),
).toEqual({
agentId: "main",
sessionKey: "agent:main:main",
});
} finally {
fs.rmSync(dir, { recursive: true, force: true });
}
});
it("does not append late CLI output after the session key is rebound", async () => {
supervisorSpawnMock.mockResolvedValueOnce(
createManagedRun({
reason: "exit",
exitCode: 0,
exitSignal: null,
durationMs: 50,
stdout: "late CLI output",
stderr: "",
timedOut: false,
noOutputTimedOut: false,
}),
);
const { dir, sessionFile, storePath } = createSessionFile();
const replacementFile = path.join(path.dirname(sessionFile), "s2.jsonl");
fs.writeFileSync(
replacementFile,
`${JSON.stringify({
type: "session",
version: CURRENT_SESSION_VERSION,
id: "s2",
timestamp: new Date(0).toISOString(),
cwd: dir,
})}\n`,
"utf-8",
);
fs.writeFileSync(
storePath,
JSON.stringify({
"agent:main:main": {
sessionId: "s2",
sessionFile: replacementFile,
updatedAt: Date.now(),
},
}),
"utf-8",
);
try {
const context = buildPreparedContext({
sessionKey: "agent:main:main",
runId: "run-rebound-cli",
});
const result = await runPreparedCliAgent({
...context,
params: {
...context.params,
agentId: "main",
sessionFile,
workspaceDir: dir,
persistAssistantTranscript: true,
storePath,
},
});
expect(result.payloads).toEqual([{ text: "late CLI output" }]);
expect(getReplyPayloadMetadata(result.payloads?.[0] ?? {})).toMatchObject({
assistantTranscriptOwned: true,
});
expect(readTranscriptMessages(sessionFile)).toEqual([]);
expect(readTranscriptMessages(replacementFile)).toEqual([]);
} finally {
fs.rmSync(dir, { recursive: true, force: true });
}
});
it("does not persist private room-event assistant output", async () => {
supervisorSpawnMock.mockResolvedValueOnce(
createManagedRun({
reason: "exit",
exitCode: 0,
exitSignal: null,
durationMs: 50,
stdout: "private ambient output",
stderr: "",
timedOut: false,
noOutputTimedOut: false,
}),
);
const { dir, sessionFile, storePath } = createSessionFile();
try {
const context = buildPreparedContext({
sessionKey: "agent:main:main",
runId: "run-private-room-event",
});
const result = await runPreparedCliAgent({
...context,
params: {
...context.params,
agentId: "main",
sessionFile,
workspaceDir: dir,
persistAssistantTranscript: true,
storePath,
currentInboundEventKind: "room_event",
},
});
expect(result.payloads).toEqual([{ text: "private ambient output" }]);
expect(getReplyPayloadMetadata(result.payloads?.[0] ?? {})).toMatchObject({
assistantTranscriptOwned: true,
});
expect(readTranscriptMessages(sessionFile)).toEqual([]);
} finally {
fs.rmSync(dir, { recursive: true, force: true });
}
});
it("passes cwd to approved CLI user-turn persistence", async () => {
supervisorSpawnMock.mockResolvedValueOnce(
createManagedRun({
reason: "exit",
exitCode: 0,
exitSignal: null,
durationMs: 50,
stdout: "hello from cli",
stderr: "",
timedOut: false,
noOutputTimedOut: false,
}),
);
const { dir, sessionFile } = createSessionFile();
const taskDir = fs.mkdtempSync(path.join(os.tmpdir(), "openclaw-cli-persist-cwd-"));
let capturedTarget: unknown;
const recorder = {
message: undefined,
resolveMessage: vi.fn(async () => undefined),
markRuntimePersistencePending: vi.fn(),
markRuntimePersisted: vi.fn(),
markBlocked: vi.fn(),
hasPersisted: vi.fn(() => false),
isBlocked: vi.fn(() => false),
hasRuntimePersistencePending: vi.fn(() => false),
waitForRuntimePersistence: vi.fn(async () => undefined),
persistApproved: vi.fn(async (options?: { target?: unknown }) => {
capturedTarget =
typeof options?.target === "function" ? await options.target() : options?.target;
return {
sessionFile,
sessionEntry: undefined,
messageId: "message-1",
message: {
role: "user",
content: "display prompt",
},
};
}),
persistFallback: vi.fn(async () => undefined),
} as unknown as UserTurnTranscriptRecorder;
try {
const context = buildPreparedContext({
sessionKey: "agent:main:main",
runId: "run-persist-cli-cwd",
});
const result = await runPreparedCliAgent({
...context,
params: {
...context.params,
agentId: "main",
sessionFile,
workspaceDir: dir,
cwd: taskDir,
prompt: "runtime prompt",
userTurnTranscriptRecorder: recorder,
},
});
expect(result.payloads).toEqual([{ text: "hello from cli" }]);
expect(recorder.persistApproved).toHaveBeenCalledOnce();
expect(capturedTarget).toEqual(
expect.objectContaining({
transcriptPath: sessionFile,
sessionId: context.params.sessionId,
sessionKey: "agent:main:main",
cwd: taskDir,
}),
);
} finally {
fs.rmSync(taskDir, { recursive: true, force: true });
fs.rmSync(dir, { recursive: true, force: true });
}
});
it("uses an existing user-turn recorder for approved CLI persistence", async () => {
supervisorSpawnMock.mockResolvedValueOnce(
createManagedRun({
reason: "exit",
exitCode: 0,
exitSignal: null,
durationMs: 50,
stdout: "hello from cli",
stderr: "",
timedOut: false,
noOutputTimedOut: false,
}),
);
const { dir, sessionFile } = createSessionFile();
const recorder = createUserTurnTranscriptRecorder({
input: {
text: "recorder display prompt",
media: [{ path: "/tmp/image.png", contentType: "image/png" }],
timestamp: 123,
idempotencyKey: "cli-recorder:user",
},
target: {
transcriptPath: sessionFile,
sessionId: "session-1",
sessionKey: "agent:main:main",
cwd: dir,
},
updateMode: "none",
});
try {
const context = buildPreparedContext({
sessionKey: "agent:main:main",
runId: "run-persist-cli-recorder",
});
const result = await runPreparedCliAgent({
...context,
params: {
...context.params,
agentId: "main",
sessionFile,
workspaceDir: dir,
prompt: "runtime prompt",
userTurnTranscriptRecorder: recorder,
},
});
expect(result.payloads).toEqual([{ text: "hello from cli" }]);
expect(recorder.hasPersisted()).toBe(true);
const messages = readTranscriptMessages(sessionFile);
expect(messages).toEqual([
expect.objectContaining({
role: "user",
content: "recorder display prompt",
MediaPath: "/tmp/image.png",
MediaType: "image/png",
timestamp: 123,
idempotencyKey: "cli-recorder:user",
}),
]);
expect(JSON.stringify(messages)).not.toContain("legacy display prompt");
} finally {
fs.rmSync(dir, { recursive: true, force: true });
}
});
it("does not fail CLI execution when persistence notification fails", async () => {
supervisorSpawnMock.mockClear();
supervisorSpawnMock.mockResolvedValueOnce(
createManagedRun({
reason: "exit",
exitCode: 0,
exitSignal: null,
durationMs: 50,
stdout: "hello despite notification failure",
stderr: "",
timedOut: false,
noOutputTimedOut: false,
}),
);
const { dir, sessionFile } = createSessionFile();
try {
const context = buildPreparedContext({
sessionKey: "agent:main:main",
runId: "run-persist-notify-fail",
});
const result = await runPreparedCliAgent({
...context,
params: {
...context.params,
agentId: "main",
sessionFile,
workspaceDir: dir,
prompt: "runtime prompt",
userTurnTranscriptRecorder: createCliUserTurnRecorder({
text: "display prompt",
sessionFile,
sessionKey: "agent:main:main",
workspaceDir: dir,
}),
onUserMessagePersisted: () => {
throw new Error("notification failed");
},
},
});
expect(result.payloads).toEqual([{ text: "hello despite notification failure" }]);
expect(supervisorSpawnMock).toHaveBeenCalledOnce();
} finally {
fs.rmSync(dir, { recursive: true, force: true });
}
});
it("does not execute the CLI when approved user turn persistence fails", async () => {
supervisorSpawnMock.mockClear();
const dir = fs.mkdtempSync(path.join(os.tmpdir(), "openclaw-cli-persist-fail-"));
const blockedParent = path.join(dir, "not-a-directory");
fs.writeFileSync(blockedParent, "occupied", "utf-8");
const onUserMessagePersisted = vi.fn();
try {
const context = buildPreparedContext({
sessionKey: "agent:main:main",
runId: "run-persist-fails",
});
await expect(
runPreparedCliAgent({
...context,
params: {
...context.params,
agentId: "main",
sessionFile: path.join(blockedParent, "s1.jsonl"),
workspaceDir: dir,
prompt: "runtime prompt",
userTurnTranscriptRecorder: createCliUserTurnRecorder({
text: "display prompt",
sessionFile: path.join(blockedParent, "s1.jsonl"),
sessionKey: "agent:main:main",
workspaceDir: dir,
}),
onUserMessagePersisted,
},
}),
).rejects.toThrow();
expect(supervisorSpawnMock).not.toHaveBeenCalled();
expect(onUserMessagePersisted).not.toHaveBeenCalled();
} finally {
fs.rmSync(dir, { recursive: true, force: true });
}
});
it("blocks CLI runs before llm_input and model execution when before_agent_run blocks", async () => {
supervisorSpawnMock.mockClear();
const onUserMessagePersisted = vi.fn();
let releaseAgentEnd: () => void = () => undefined;
const agentEndSettled = new Promise<void>((resolve) => {
releaseAgentEnd = resolve;
});
const hookRunner = {
hasHooks: vi.fn((hookName: string) =>
["before_agent_run", "llm_input", "agent_end"].includes(hookName),
),
runBeforeAgentRun: vi.fn(async () => ({
pluginId: "policy-plugin",
decision: {
outcome: "block" as const,
reason: "matched secret prompt: secret prompt",
message: "The agent cannot read this message.",
},
})),
runLlmInput: vi.fn(async () => undefined),
runAgentEnd: vi.fn(() => agentEndSettled),
};
setHookRunnerForTest(hookRunner);
const { dir, sessionFile } = createSessionFile({
history: [{ role: "user", content: "earlier context" }],
});
try {
let resolved = false;
const context = buildPreparedContext({
sessionKey: "agent:main:main",
runId: "run-blocked-cli",
});
const run = runPreparedCliAgent({
...context,
params: {
...context.params,
agentId: "main",
sessionFile,
workspaceDir: dir,
prompt: "secret prompt",
userTurnTranscriptRecorder: createCliUserTurnRecorder({
text: "secret prompt",
sessionFile,
sessionKey: "agent:main:main",
workspaceDir: dir,
}),
onUserMessagePersisted,
},
}).then((result) => {
resolved = true;
return result;
});
await vi.waitFor(() => {
expect(hookRunner.runAgentEnd).toHaveBeenCalledTimes(1);
});
await Promise.resolve();
expect(resolved).toBe(false);
releaseAgentEnd();
const result = await run;
expect(result.payloads).toEqual([
{
text: "Your message could not be sent: The agent cannot read this message. (blocked by policy-plugin)",
isError: true,
},
]);
expect(result.meta.livenessState).toBe("blocked");
expect(supervisorSpawnMock).not.toHaveBeenCalled();
expect(hookRunner.runLlmInput).not.toHaveBeenCalled();
expect(onUserMessagePersisted).not.toHaveBeenCalled();
const beforeRunEvent = requireRecord(
callArg(hookRunner.runBeforeAgentRun, 0, 0, "before_agent_run event"),
"before_agent_run event",
);
expect(beforeRunEvent.prompt).toBe("secret prompt");
const beforeRunMessages = requireArray(beforeRunEvent.messages, "before_agent_run messages");
expect(
beforeRunMessages.some((message) => {
const record = requireRecord(message, "before_agent_run message");
return record.role === "user" && record.content === "earlier context";
}),
).toBe(true);
const beforeRunContext = requireRecord(
callArg(hookRunner.runBeforeAgentRun, 0, 1, "before_agent_run context"),
"before_agent_run context",
);
expect(beforeRunContext.runId).toBe("run-blocked-cli");
expect(beforeRunContext.agentId).toBe("main");
expect(beforeRunContext.sessionKey).toBe("agent:main:main");
expect(resolved).toBe(true);
const agentEndEvent = requireRecord(
callArg(hookRunner.runAgentEnd, 0, 0, "agent_end event"),
"agent_end event",
);
expect(agentEndEvent.success).toBe(false);
expect(agentEndEvent.error).toBe(
"Your message could not be sent: The agent cannot read this message. (blocked by policy-plugin)",
);
const agentEndMessages = requireArray(agentEndEvent.messages, "agent_end messages");
expect(
agentEndMessages.some((message) => {
const record = requireRecord(message, "agent_end message");
return (
record.role === "user" &&
record.content ===
"Your message could not be sent: The agent cannot read this message. (blocked by policy-plugin)"
);
}),
).toBe(true);
expect(callArg(hookRunner.runAgentEnd, 0, 1, "agent_end context")).toBeTypeOf("object");
expect(JSON.stringify(hookRunner.runAgentEnd.mock.calls)).not.toContain("secret prompt");
const lines = fs.readFileSync(sessionFile, "utf-8").trim().split("\n");
const blockedLine = JSON.parse(lines[lines.length - 1]);
expect(blockedLine.message.content[0].text).toBe(
"Your message could not be sent: The agent cannot read this message. (blocked by policy-plugin)",
);
expect(JSON.stringify(blockedLine)).not.toContain("secret prompt");
expect(JSON.stringify(blockedLine)).not.toContain("matched secret prompt");
expect(blockedLine.message["__openclaw"].beforeAgentRunBlocked.blockedBy).toBe(
"policy-plugin",
);
expect(blockedLine.message["__openclaw"].beforeAgentRunBlocked).not.toHaveProperty("reason");
expect(Object.hasOwn(blockedLine.message["__openclaw"], "beforeAgentRunBlocked")).toBe(true);
} finally {
fs.rmSync(dir, { recursive: true, force: true });
}
});
it("forwards channel identity context to CLI before_agent_run hooks", async () => {
supervisorSpawnMock.mockClear();
const hookRunner = {
hasHooks: vi.fn((hookName: string) => hookName === "before_agent_run"),
runBeforeAgentRun: vi.fn(async () => ({
pluginId: "policy-plugin",
decision: {
outcome: "block" as const,
reason: "sender scoped policy",
message: "The agent cannot read this message.",
},
})),
};
setHookRunnerForTest(hookRunner);
const { dir, sessionFile } = createSessionFile();
try {
const context = buildPreparedContext({
sessionKey: "agent:main:telegram:chat-1",
runId: "run-cli-channel-before-agent-run",
});
const result = await runPreparedCliAgent({
...context,
params: {
...context.params,
agentId: "main",
sessionFile,
workspaceDir: dir,
prompt: "sender scoped prompt",
messageChannel: "telegram",
messageProvider: "telegram",
currentChannelId: "telegram:chat-1",
senderId: "user-42",
senderIsOwner: true,
userTurnTranscriptRecorder: createCliUserTurnRecorder({
text: "sender scoped prompt",
sessionFile,
sessionKey: "agent:main:telegram:chat-1",
workspaceDir: dir,
}),
},
});
expect(result.payloads).toEqual([
{
text: "Your message could not be sent: The agent cannot read this message. (blocked by policy-plugin)",
isError: true,
},
]);
expect(supervisorSpawnMock).not.toHaveBeenCalled();
const beforeRunEvent = requireRecord(
callArg(hookRunner.runBeforeAgentRun, 0, 0, "before_agent_run event"),
"before_agent_run event",
);
expect(beforeRunEvent.channelId).toBe("chat-1");
expect(beforeRunEvent.senderId).toBe("user-42");
expect(beforeRunEvent.senderIsOwner).toBe(true);
const beforeRunContext = requireRecord(
callArg(hookRunner.runBeforeAgentRun, 0, 1, "before_agent_run context"),
"before_agent_run context",
);
expect(beforeRunContext.channel).toBe("telegram");
expect(beforeRunContext.chatId).toBe("chat-1");
expect(beforeRunContext.channelId).toBe("chat-1");
expect(beforeRunContext.senderId).toBe("user-42");
} finally {
fs.rmSync(dir, { recursive: true, force: true });
}
});
it("does not emit llm_output when the CLI run returns no assistant text", async () => {
const hookRunner = {
hasHooks: vi.fn((hookName: string) => hookName === "llm_output"),
runLlmInput: vi.fn(async () => undefined),
runLlmOutput: vi.fn(async () => undefined),
runAgentEnd: vi.fn(async () => undefined),
};
setHookRunnerForTest(hookRunner);
supervisorSpawnMock.mockResolvedValueOnce(
createManagedRun({
reason: "exit",
exitCode: 0,
exitSignal: null,
durationMs: 50,
stdout: " ",
stderr: "",
timedOut: false,
noOutputTimedOut: false,
}),
);
await expect(runPreparedCliAgent(buildPreparedContext())).rejects.toThrow(
"CLI backend returned an empty response.",
);
expect(hookRunner.runLlmOutput).not.toHaveBeenCalled();
});
it("returns silent payload for empty CLI output when silence is allowed", async () => {
const hookRunner = {
hasHooks: vi.fn((hookName: string) => hookName === "llm_output"),
runLlmInput: vi.fn(async () => undefined),
runLlmOutput: vi.fn(async () => undefined),
runAgentEnd: vi.fn(async () => undefined),
};
setHookRunnerForTest(hookRunner);
supervisorSpawnMock.mockResolvedValueOnce(
createManagedRun({
reason: "exit",
exitCode: 0,
exitSignal: null,
durationMs: 50,
stdout: " ",
stderr: "",
timedOut: false,
noOutputTimedOut: false,
}),
);
const result = await runPreparedCliAgent(
buildPreparedContext({
provider: "claude-cli",
model: "claude-sonnet-4-6",
allowEmptyAssistantReplyAsSilent: true,
}),
);
expect(result.payloads).toEqual([{ text: SILENT_REPLY_TOKEN }]);
expect(result.meta.executionTrace?.fallbackUsed).toBe(false);
expect(hookRunner.runLlmOutput).not.toHaveBeenCalled();
});
it("emits agent_end with failure details when the CLI run fails", async () => {
let releaseAgentEnd: () => void = () => undefined;
const agentEndSettled = new Promise<void>((resolve) => {
releaseAgentEnd = resolve;
});
const hookRunner = {
hasHooks: vi.fn((hookName: string) => ["llm_input", "agent_end"].includes(hookName)),
runLlmInput: vi.fn(async () => undefined),
runLlmOutput: vi.fn(async () => undefined),
runAgentEnd: vi.fn(() => agentEndSettled),
};
setHookRunnerForTest(hookRunner);
supervisorSpawnMock.mockResolvedValueOnce(
createManagedRun({
reason: "exit",
exitCode: 1,
exitSignal: null,
durationMs: 50,
stdout: "",
stderr: "rate limit exceeded",
timedOut: false,
noOutputTimedOut: false,
}),
);
let settled = false;
const run = runPreparedCliAgent(buildPreparedContext()).finally(() => {
settled = true;
});
await vi.waitFor(() => {
expect(hookRunner.runLlmInput).toHaveBeenCalledTimes(1);
expect(hookRunner.runLlmOutput).not.toHaveBeenCalled();
expect(hookRunner.runAgentEnd).toHaveBeenCalledTimes(1);
});
await Promise.resolve();
expect(settled).toBe(false);
releaseAgentEnd();
await expect(run).rejects.toThrow("rate limit exceeded");
expect(settled).toBe(true);
const agentEndEvent = requireRecord(
callArg(hookRunner.runAgentEnd, 0, 0, "agent_end event"),
"agent_end event",
);
expect(agentEndEvent.success).toBe(false);
expect(agentEndEvent.error).toBe("rate limit exceeded");
const messages = requireArray(agentEndEvent.messages, "agent_end messages");
expect(messages).toHaveLength(1);
expectTextMessage(messages[0], { role: "user", content: "hi" });
expect(callArg(hookRunner.runAgentEnd, 0, 1, "agent_end context")).toBeTypeOf("object");
});
it("does not emit duplicate llm_input when session-expired recovery succeeds", async () => {
const hookRunner = {
hasHooks: vi.fn((hookName: string) =>
["llm_input", "llm_output", "agent_end"].includes(hookName),
),
runLlmInput: vi.fn(async () => undefined),
runLlmOutput: vi.fn(async () => undefined),
runAgentEnd: vi.fn(async () => undefined),
};
setHookRunnerForTest(hookRunner);
const { dir, sessionFile } = createSessionFile({
history: Array.from({ length: MAX_CLI_SESSION_HISTORY_MESSAGES + 5 }, (_, index) => ({
role: "user" as const,
content: `history-${index}`,
})),
});
supervisorSpawnMock.mockResolvedValueOnce(
createManagedRun({
reason: "exit",
exitCode: 1,
exitSignal: null,
durationMs: 50,
stdout: "",
stderr: "session expired",
timedOut: false,
noOutputTimedOut: false,
}),
);
supervisorSpawnMock.mockResolvedValueOnce(
createManagedRun({
reason: "exit",
exitCode: 0,
exitSignal: null,
durationMs: 50,
stdout: "recovered output",
stderr: "",
timedOut: false,
noOutputTimedOut: false,
}),
);
const context = buildPreparedContext({
sessionKey: "agent:main:main",
runId: "run-retry-success",
cliSessionId: "thread-123",
openClawHistoryPrompt:
"Continue this conversation using the OpenClaw transcript below.\n\nUser: recovered history\n\n<next_user_message>\nhi\n</next_user_message>",
});
const clearBeforeRetry = vi.fn(async () => true);
try {
const result = await runPreparedCliAgent({
...context,
params: {
...context.params,
agentId: "main",
onBeforeFreshCliSessionRetry: clearBeforeRetry,
sessionFile,
workspaceDir: dir,
},
});
expect(result.payloads).toEqual([{ text: "recovered output" }]);
expect(result.meta.finalPromptText).toContain("User: recovered history");
expect(clearBeforeRetry).toHaveBeenCalledWith({
provider: "codex-cli",
reason: "session_expired",
sessionId: "thread-123",
});
await vi.waitFor(() => {
expect(hookRunner.runLlmInput).toHaveBeenCalledTimes(1);
expect(hookRunner.runLlmOutput).toHaveBeenCalledTimes(1);
expect(hookRunner.runAgentEnd).toHaveBeenCalledTimes(1);
});
const llmInputEvent = requireRecord(
callArg(hookRunner.runLlmInput, 0, 0, "llm_input event"),
"llm_input event",
);
const historyMessages = requireArray(llmInputEvent.historyMessages, "history messages");
expect(historyMessages).toHaveLength(MAX_CLI_SESSION_HISTORY_MESSAGES);
const firstHistoryMessage = requireRecord(historyMessages[0], "first history message");
expect(firstHistoryMessage.role).toBe("user");
expect(firstHistoryMessage.content).toBe(`history-5`);
} finally {
fs.rmSync(dir, { recursive: true, force: true });
}
});
it("skips transcript loading when only llm_output hooks are active", async () => {
const hookRunner = {
hasHooks: vi.fn((hookName: string) => hookName === "llm_output"),
runLlmInput: vi.fn(async () => undefined),
runLlmOutput: vi.fn(async () => undefined),
runAgentEnd: vi.fn(async () => undefined),
};
setHookRunnerForTest(hookRunner);
const historySpy = vi.spyOn(sessionHistoryModule, "loadCliSessionHistoryMessages");
supervisorSpawnMock.mockResolvedValueOnce(
createManagedRun({
reason: "exit",
exitCode: 0,
exitSignal: null,
durationMs: 50,
stdout: "hello from cli",
stderr: "",
timedOut: false,
noOutputTimedOut: false,
}),
);
try {
await runPreparedCliAgent(buildPreparedContext());
expect(historySpy).not.toHaveBeenCalled();
await vi.waitFor(() => {
expect(hookRunner.runLlmOutput).toHaveBeenCalledTimes(1);
});
} finally {
historySpy.mockRestore();
}
});
it("builds fresh-session history reseed prompts from hook-mutated prompts", async () => {
const { dir, sessionFile } = createSessionFile({
history: [{ role: "user", content: "earlier ask" }],
});
fs.appendFileSync(
sessionFile,
`${JSON.stringify({
type: "compaction",
id: "compaction-1",
parentId: "msg-0",
timestamp: new Date(2).toISOString(),
summary: "compacted earlier ask",
firstKeptEntryId: "msg-0",
tokensBefore: 10_000,
})}\n`,
"utf-8",
);
const config: OpenClawConfig = {
agents: {
defaults: {
workspace: dir,
cliBackends: {
"codex-cli": {
command: "codex",
args: ["exec"],
output: "text",
input: "arg",
sessionMode: "existing",
},
},
},
},
};
const hookRunner = {
hasHooks: vi.fn((hookName: string) => hookName === "before_prompt_build"),
runBeforePromptBuild: vi.fn(async () => ({ prependContext: "hook context" })),
runBeforeAgentStart: vi.fn(async () => undefined),
};
setHookRunnerForTest(hookRunner);
try {
const context = await prepareCliRunContext({
sessionId: "s1",
sessionFile,
workspaceDir: dir,
config,
prompt: "current ask",
provider: "codex-cli",
model: "gpt-5.4",
timeoutMs: 1_000,
runId: "run-history-hook",
});
expect(context.params.prompt).toBe("hook context\n\ncurrent ask");
expect(context.openClawHistoryPrompt).toContain("Compaction summary: compacted earlier ask");
expect(context.openClawHistoryPrompt).toContain("hook context");
expect(context.openClawHistoryPrompt).toContain("current ask");
} finally {
fs.rmSync(dir, { recursive: true, force: true });
}
});
});
describe("resolveCliNoOutputTimeoutMs", () => {
it("uses backend-configured resume watchdog override", () => {
const timeoutMs = resolveCliNoOutputTimeoutMs({
backend: {
command: "codex",
reliability: {
watchdog: {
resume: {
noOutputTimeoutMs: 42_000,
},
},
},
},
timeoutMs: 120_000,
useResume: true,
});
expect(timeoutMs).toBe(42_000);
});
it("lets explicit cron timeouts lift the default resume no-output ceiling", () => {
const timeoutMs = resolveCliNoOutputTimeoutMs({
backend: { command: "codex" },
timeoutMs: 600_000,
useResume: true,
trigger: "cron",
});
expect(timeoutMs).toBe(480_000);
});
it("lets explicit embedded run timeouts lift the default resume no-output ceiling", () => {
const timeoutMs = resolveCliNoOutputTimeoutMs({
backend: { command: "codex" },
timeoutMs: 600_000,
runTimeoutOverrideMs: 600_000,
useResume: true,
trigger: "user",
});
expect(timeoutMs).toBe(480_000);
});
it("lets configured agent default timeouts lift the default resume no-output ceiling", () => {
const timeoutMs = resolveCliNoOutputTimeoutMs({
backend: { command: "codex" },
timeoutMs: 600_000,
runTimeoutOverrideMs: 600_000,
useResume: true,
trigger: "user",
});
expect(timeoutMs).toBe(480_000);
});
it("keeps inherited user resume timeouts on the default resume no-output ceiling", () => {
const timeoutMs = resolveCliNoOutputTimeoutMs({
backend: { command: "codex" },
timeoutMs: 600_000,
useResume: true,
trigger: "user",
});
expect(timeoutMs).toBe(180_000);
});
});
describe("resolveCliRunTimeoutOverrideMs", () => {
it("preserves configured timeouts for normal channel runs", () => {
expect(
resolveCliRunTimeoutOverrideMs({
config: { agents: { defaults: { timeoutSeconds: 600 } } },
timeoutMs: 600_000,
}),
).toBe(600_000);
});
it("does not treat configured timeouts as subagent overrides", () => {
expect(
resolveCliRunTimeoutOverrideMs({
config: { agents: { defaults: { timeoutSeconds: 600 } } },
lane: "subagent",
timeoutMs: 600_000,
}),
).toBeUndefined();
});
});