mirror of
https://github.com/openclaw/openclaw.git
synced 2026-07-09 08:43:59 +00:00
Merged via squash.
Prepared head SHA: 171165c3eb
Co-authored-by: harjothkhara <48686985+harjothkhara@users.noreply.github.com>
Co-authored-by: vincentkoc <25068+vincentkoc@users.noreply.github.com>
Reviewed-by: @vincentkoc
1144 lines
35 KiB
TypeScript
1144 lines
35 KiB
TypeScript
// End-to-end embedded-agent runner tests with mocked model/runtime seams.
|
|
import fs from "node:fs/promises";
|
|
import path from "node:path";
|
|
import "./test-helpers/fast-coding-tools.js";
|
|
import { afterAll, beforeAll, beforeEach, describe, expect, it, vi } from "vitest";
|
|
import {
|
|
buildEmbeddedRunnerAssistant,
|
|
cleanupEmbeddedAgentRunnerTestWorkspace,
|
|
createMockUsage,
|
|
createEmbeddedAgentRunnerOpenAiConfig,
|
|
createResolvedEmbeddedRunnerModel,
|
|
createEmbeddedAgentRunnerTestWorkspace,
|
|
type EmbeddedAgentRunnerTestWorkspace,
|
|
immediateEnqueue,
|
|
makeEmbeddedRunnerAttempt,
|
|
} from "./test-helpers/embedded-agent-runner-e2e-fixtures.js";
|
|
import {
|
|
installEmbeddedRunnerBaseE2eMocks,
|
|
installEmbeddedRunnerFastRunE2eMocks,
|
|
} from "./test-helpers/embedded-agent-runner-e2e-mocks.js";
|
|
|
|
type EmbeddedRunnerModelResolution =
|
|
| ReturnType<typeof createResolvedEmbeddedRunnerModel>
|
|
| {
|
|
model?: undefined;
|
|
error: string;
|
|
authStorage: { setRuntimeApiKey: () => undefined };
|
|
modelRegistry: Record<string, never>;
|
|
};
|
|
|
|
const runEmbeddedAttemptMock = vi.fn();
|
|
const disposeSessionMcpRuntimeMock = vi.fn<(sessionId: string) => Promise<void>>(async () => {
|
|
return undefined;
|
|
});
|
|
const resolveSessionKeyForRequestMock = vi.fn();
|
|
const resolveStoredSessionKeyForSessionIdMock = vi.fn();
|
|
const resolveModelAsyncMock = vi.fn(
|
|
async (provider: string, modelId: string): Promise<EmbeddedRunnerModelResolution> =>
|
|
createResolvedEmbeddedRunnerModel(provider, modelId),
|
|
);
|
|
const ensureOpenClawModelsJsonMock = vi.fn(async () => ({ wrote: false }));
|
|
const loggerWarnMock = vi.fn();
|
|
let refreshRuntimeAuthOnFirstPromptError = false;
|
|
let clearRuntimeConfigSnapshot: typeof import("../config/config.js").clearRuntimeConfigSnapshot;
|
|
let setRuntimeConfigSnapshot: typeof import("../config/config.js").setRuntimeConfigSnapshot;
|
|
|
|
vi.mock("openclaw/plugin-sdk/llm", async () => {
|
|
const actual =
|
|
await vi.importActual<typeof import("openclaw/plugin-sdk/llm")>("openclaw/plugin-sdk/llm");
|
|
|
|
const buildAssistantMessage = (model: { api: string; provider: string; id: string }) => ({
|
|
role: "assistant" as const,
|
|
content: [{ type: "text" as const, text: "ok" }],
|
|
stopReason: "stop" as const,
|
|
api: model.api,
|
|
provider: model.provider,
|
|
model: model.id,
|
|
usage: createMockUsage(1, 1),
|
|
timestamp: Date.now(),
|
|
});
|
|
|
|
const buildAssistantErrorMessage = (model: { api: string; provider: string; id: string }) => ({
|
|
role: "assistant" as const,
|
|
content: [],
|
|
stopReason: "error" as const,
|
|
errorMessage: "boom",
|
|
api: model.api,
|
|
provider: model.provider,
|
|
model: model.id,
|
|
usage: createMockUsage(0, 0),
|
|
timestamp: Date.now(),
|
|
});
|
|
|
|
return {
|
|
...actual,
|
|
complete: async (model: { api: string; provider: string; id: string }) => {
|
|
if (model.id === "mock-error") {
|
|
return buildAssistantErrorMessage(model);
|
|
}
|
|
return buildAssistantMessage(model);
|
|
},
|
|
completeSimple: async (model: { api: string; provider: string; id: string }) => {
|
|
if (model.id === "mock-error") {
|
|
return buildAssistantErrorMessage(model);
|
|
}
|
|
return buildAssistantMessage(model);
|
|
},
|
|
streamSimple: (model: { api: string; provider: string; id: string }) => {
|
|
const stream = actual.createAssistantMessageEventStream();
|
|
queueMicrotask(() => {
|
|
stream.push({
|
|
type: "done",
|
|
reason: "stop",
|
|
message:
|
|
model.id === "mock-error"
|
|
? buildAssistantErrorMessage(model)
|
|
: buildAssistantMessage(model),
|
|
});
|
|
stream.end();
|
|
});
|
|
return stream;
|
|
},
|
|
};
|
|
});
|
|
|
|
const installRunEmbeddedMocks = () => {
|
|
// Install only the runtime seams needed by runner orchestration so tests avoid
|
|
// loading real providers, MCP runtimes, or gateway side effects.
|
|
installEmbeddedRunnerBaseE2eMocks({ hookRunner: "full" });
|
|
installEmbeddedRunnerFastRunE2eMocks({
|
|
runEmbeddedAttempt: (params) => runEmbeddedAttemptMock(params),
|
|
});
|
|
vi.doMock("./command/session.js", async () => {
|
|
const actual =
|
|
await vi.importActual<typeof import("./command/session.js")>("./command/session.js");
|
|
return {
|
|
...actual,
|
|
resolveSessionKeyForRequest: (opts: unknown) => resolveSessionKeyForRequestMock(opts),
|
|
resolveStoredSessionKeyForSessionId: (opts: unknown) =>
|
|
resolveStoredSessionKeyForSessionIdMock(opts),
|
|
};
|
|
});
|
|
vi.doMock("./embedded-agent-runner/logger.js", async () => {
|
|
const actual = await vi.importActual<typeof import("./embedded-agent-runner/logger.js")>(
|
|
"./embedded-agent-runner/logger.js",
|
|
);
|
|
return {
|
|
...actual,
|
|
log: {
|
|
...actual.log,
|
|
warn: (...args: unknown[]) => loggerWarnMock(...args),
|
|
},
|
|
};
|
|
});
|
|
vi.doMock("./agent-bundle-mcp-tools.js", () => ({
|
|
disposeSessionMcpRuntime: (sessionId: string) => disposeSessionMcpRuntimeMock(sessionId),
|
|
retireSessionMcpRuntimeForSessionKey: () => Promise.resolve(false),
|
|
retireSessionMcpRuntime: ({ sessionId }: { sessionId?: string | null }) =>
|
|
sessionId ? disposeSessionMcpRuntimeMock(sessionId) : Promise.resolve(false),
|
|
}));
|
|
vi.doMock("./embedded-agent-runner/model.js", async () => {
|
|
const actual = await vi.importActual<typeof import("./embedded-agent-runner/model.js")>(
|
|
"./embedded-agent-runner/model.js",
|
|
);
|
|
return {
|
|
...actual,
|
|
resolveModelAsync: (...args: Parameters<typeof resolveModelAsyncMock>) =>
|
|
resolveModelAsyncMock(...args),
|
|
};
|
|
});
|
|
vi.doMock("./embedded-agent-runner/run/auth-controller.js", () => ({
|
|
createEmbeddedRunAuthController: () => ({
|
|
advanceAuthProfile: vi.fn(async () => false),
|
|
initializeAuthProfile: vi.fn(async () => undefined),
|
|
maybeRefreshRuntimeAuthForAuthError: vi.fn(async (_errorText: string, runtimeAuthRetry) => {
|
|
return refreshRuntimeAuthOnFirstPromptError && runtimeAuthRetry !== true;
|
|
}),
|
|
stopRuntimeAuthRefreshTimer: vi.fn(),
|
|
}),
|
|
}));
|
|
vi.doMock("./models-config.js", async () => {
|
|
const mod = await vi.importActual<typeof import("./models-config.js")>("./models-config.js");
|
|
return {
|
|
...mod,
|
|
ensureOpenClawModelsJson: (...args: Parameters<typeof ensureOpenClawModelsJsonMock>) =>
|
|
ensureOpenClawModelsJsonMock(...args),
|
|
};
|
|
});
|
|
};
|
|
|
|
let runEmbeddedAgent: typeof import("./embedded-agent-runner/run.js").runEmbeddedAgent;
|
|
let SessionManager: typeof import("openclaw/plugin-sdk/agent-sessions").SessionManager;
|
|
let e2eWorkspace: EmbeddedAgentRunnerTestWorkspace | undefined;
|
|
let agentDir: string;
|
|
let workspaceDir: string;
|
|
let sessionCounter = 0;
|
|
let runCounter = 0;
|
|
|
|
beforeAll(async () => {
|
|
vi.useRealTimers();
|
|
vi.resetModules();
|
|
installRunEmbeddedMocks();
|
|
({ clearRuntimeConfigSnapshot, setRuntimeConfigSnapshot } = await import("../config/config.js"));
|
|
({ runEmbeddedAgent } = await import("./embedded-agent-runner/run.js"));
|
|
({ SessionManager } = await import("openclaw/plugin-sdk/agent-sessions"));
|
|
e2eWorkspace = await createEmbeddedAgentRunnerTestWorkspace("openclaw-embedded-agent-");
|
|
({ agentDir, workspaceDir } = e2eWorkspace);
|
|
}, 180_000);
|
|
|
|
afterAll(async () => {
|
|
await cleanupEmbeddedAgentRunnerTestWorkspace(e2eWorkspace);
|
|
e2eWorkspace = undefined;
|
|
});
|
|
|
|
beforeEach(() => {
|
|
clearRuntimeConfigSnapshot();
|
|
vi.useRealTimers();
|
|
runEmbeddedAttemptMock.mockReset();
|
|
disposeSessionMcpRuntimeMock.mockReset();
|
|
resolveSessionKeyForRequestMock.mockReset();
|
|
resolveStoredSessionKeyForSessionIdMock.mockReset();
|
|
resolveModelAsyncMock.mockReset();
|
|
resolveModelAsyncMock.mockImplementation(async (provider: string, modelId: string) =>
|
|
createResolvedEmbeddedRunnerModel(provider, modelId),
|
|
);
|
|
ensureOpenClawModelsJsonMock.mockReset();
|
|
ensureOpenClawModelsJsonMock.mockResolvedValue({ wrote: false });
|
|
loggerWarnMock.mockReset();
|
|
refreshRuntimeAuthOnFirstPromptError = false;
|
|
runEmbeddedAttemptMock.mockImplementation(async () => {
|
|
throw new Error("unexpected extra runEmbeddedAttempt call");
|
|
});
|
|
});
|
|
|
|
const nextSessionFile = () => {
|
|
sessionCounter += 1;
|
|
return path.join(workspaceDir, `session-${sessionCounter}.jsonl`);
|
|
};
|
|
const nextRunId = (prefix = "run-embedded-test") => `${prefix}-${++runCounter}`;
|
|
const nextSessionKey = () => `agent:test:embedded:${nextRunId("session-key")}`;
|
|
|
|
const runWithOrphanedSingleUserMessage = async (text: string, sessionKey: string) => {
|
|
// Builds a session with an orphaned user message to exercise retry/resume
|
|
// cleanup paths from persisted JSONL.
|
|
const sessionFile = nextSessionFile();
|
|
const sessionManager = SessionManager.open(sessionFile);
|
|
sessionManager.appendMessage({
|
|
role: "user",
|
|
content: [{ type: "text", text }],
|
|
timestamp: Date.now(),
|
|
});
|
|
|
|
runEmbeddedAttemptMock.mockResolvedValueOnce(
|
|
makeEmbeddedRunnerAttempt({
|
|
assistantTexts: ["ok"],
|
|
lastAssistant: buildEmbeddedRunnerAssistant({
|
|
content: [{ type: "text", text: "ok" }],
|
|
}),
|
|
}),
|
|
);
|
|
|
|
const cfg = createEmbeddedAgentRunnerOpenAiConfig(["mock-1"]);
|
|
return await runEmbeddedAgent({
|
|
sessionId: "session:test",
|
|
sessionKey,
|
|
sessionFile,
|
|
workspaceDir,
|
|
config: cfg,
|
|
prompt: "hello",
|
|
provider: "openai",
|
|
model: "mock-1",
|
|
timeoutMs: 5_000,
|
|
agentDir,
|
|
runId: nextRunId("orphaned-user"),
|
|
enqueue: immediateEnqueue,
|
|
});
|
|
};
|
|
|
|
const textFromContent = (content: unknown) => {
|
|
if (typeof content === "string") {
|
|
return content;
|
|
}
|
|
if (Array.isArray(content) && content[0]?.type === "text") {
|
|
return (content[0] as { text?: string }).text;
|
|
}
|
|
return undefined;
|
|
};
|
|
|
|
const readSessionEntries = async (sessionFile: string) => {
|
|
const raw = await fs.readFile(sessionFile, "utf-8");
|
|
const entries: Array<{ type?: string; customType?: string; data?: unknown }> = [];
|
|
for (const line of raw.split(/\r?\n/)) {
|
|
if (line.length > 0) {
|
|
entries.push(JSON.parse(line) as { type?: string; customType?: string; data?: unknown });
|
|
}
|
|
}
|
|
return entries;
|
|
};
|
|
|
|
const readSessionMessages = async (sessionFile: string) => {
|
|
const entries = await readSessionEntries(sessionFile);
|
|
return entries
|
|
.filter((entry) => entry.type === "message")
|
|
.map(
|
|
(entry) => (entry as { message?: { role?: string; content?: unknown } }).message,
|
|
) as Array<{ role?: string; content?: unknown }>;
|
|
};
|
|
|
|
const runDefaultEmbeddedTurn = async (sessionFile: string, prompt: string, sessionKey: string) => {
|
|
const cfg = createEmbeddedAgentRunnerOpenAiConfig(["mock-error"]);
|
|
runEmbeddedAttemptMock.mockResolvedValueOnce(
|
|
makeEmbeddedRunnerAttempt({
|
|
assistantTexts: ["ok"],
|
|
lastAssistant: buildEmbeddedRunnerAssistant({
|
|
content: [{ type: "text", text: "ok" }],
|
|
}),
|
|
}),
|
|
);
|
|
await runEmbeddedAgent({
|
|
sessionId: "session:test",
|
|
sessionKey,
|
|
sessionFile,
|
|
workspaceDir,
|
|
config: cfg,
|
|
prompt,
|
|
provider: "openai",
|
|
model: "mock-error",
|
|
timeoutMs: 5_000,
|
|
agentDir,
|
|
runId: nextRunId("default-turn"),
|
|
enqueue: immediateEnqueue,
|
|
});
|
|
};
|
|
|
|
const addAnthropicProvider = (
|
|
cfg: ReturnType<typeof createEmbeddedAgentRunnerOpenAiConfig>,
|
|
modelIds: string[],
|
|
) => ({
|
|
...cfg,
|
|
models: {
|
|
providers: {
|
|
...cfg.models?.providers,
|
|
anthropic: {
|
|
api: "anthropic-messages" as const,
|
|
apiKey: "sk-test",
|
|
baseUrl: "https://example.com",
|
|
models: modelIds.map((id) => ({
|
|
id,
|
|
name: `Mock ${id}`,
|
|
reasoning: false,
|
|
input: ["text" as const],
|
|
cost: { input: 0, output: 0, cacheRead: 0, cacheWrite: 0 },
|
|
contextWindow: 16_000,
|
|
maxTokens: 2048,
|
|
})),
|
|
},
|
|
},
|
|
},
|
|
});
|
|
|
|
const mockSuccessfulEmbeddedAttempt = () => {
|
|
runEmbeddedAttemptMock.mockResolvedValueOnce(
|
|
makeEmbeddedRunnerAttempt({
|
|
assistantTexts: ["ok"],
|
|
lastAssistant: buildEmbeddedRunnerAssistant({
|
|
content: [{ type: "text", text: "ok" }],
|
|
}),
|
|
}),
|
|
);
|
|
};
|
|
|
|
function firstMockCall(mock: { mock: { calls: unknown[][] } }, label: string): unknown[] {
|
|
const call = mock.mock.calls[0];
|
|
if (!call) {
|
|
throw new Error(`Expected ${label} to be called`);
|
|
}
|
|
return call;
|
|
}
|
|
|
|
function firstRunEmbeddedAttemptParams(): { sessionKey?: string } {
|
|
return firstMockCall(runEmbeddedAttemptMock, "embedded attempt")[0] as { sessionKey?: string };
|
|
}
|
|
|
|
describe("runEmbeddedAgent", () => {
|
|
it("uses the configured default model when the caller omits provider and model", async () => {
|
|
const sessionFile = nextSessionFile();
|
|
const cfg = {
|
|
...createEmbeddedAgentRunnerOpenAiConfig([]),
|
|
agents: {
|
|
defaults: {
|
|
model: {
|
|
primary: "openrouter/global-default",
|
|
},
|
|
},
|
|
list: [{ id: "research", model: "openrouter/research-default" }],
|
|
},
|
|
};
|
|
mockSuccessfulEmbeddedAttempt();
|
|
|
|
await runEmbeddedAgent({
|
|
sessionId: "configured-default-model",
|
|
sessionFile,
|
|
workspaceDir,
|
|
config: cfg,
|
|
agentId: "research",
|
|
prompt: "hello",
|
|
timeoutMs: 5_000,
|
|
agentDir,
|
|
runId: nextRunId("configured-default-model"),
|
|
enqueue: immediateEnqueue,
|
|
});
|
|
|
|
expect(resolveModelAsyncMock).toHaveBeenNthCalledWith(
|
|
1,
|
|
"openrouter",
|
|
"openrouter/research-default",
|
|
agentDir,
|
|
cfg,
|
|
expect.objectContaining({ skipAgentDiscovery: true }),
|
|
);
|
|
});
|
|
|
|
it("uses runtime config for blank public runtime model overrides", async () => {
|
|
const sessionFile = nextSessionFile();
|
|
const cfg = {
|
|
...createEmbeddedAgentRunnerOpenAiConfig([]),
|
|
agents: {
|
|
defaults: {
|
|
model: {
|
|
primary: "openrouter/runtime-default",
|
|
},
|
|
},
|
|
},
|
|
};
|
|
setRuntimeConfigSnapshot(cfg);
|
|
mockSuccessfulEmbeddedAttempt();
|
|
|
|
await runEmbeddedAgent({
|
|
sessionId: "runtime-config-default-model",
|
|
sessionFile,
|
|
workspaceDir,
|
|
prompt: "hello",
|
|
provider: " ",
|
|
model: "",
|
|
timeoutMs: 5_000,
|
|
agentDir,
|
|
runId: nextRunId("runtime-config-default-model"),
|
|
enqueue: immediateEnqueue,
|
|
});
|
|
|
|
expect(resolveModelAsyncMock).toHaveBeenNthCalledWith(
|
|
1,
|
|
"openrouter",
|
|
"openrouter/runtime-default",
|
|
agentDir,
|
|
cfg,
|
|
expect.objectContaining({ skipAgentDiscovery: true }),
|
|
);
|
|
});
|
|
|
|
it("uses the session-key agent default when agentId is inferred", async () => {
|
|
const sessionFile = nextSessionFile();
|
|
const cfg = {
|
|
...addAnthropicProvider(createEmbeddedAgentRunnerOpenAiConfig(["mock-1"]), [
|
|
"claude-opus-4-7",
|
|
]),
|
|
agents: {
|
|
defaults: {
|
|
model: { primary: "openai/mock-1" },
|
|
},
|
|
list: [
|
|
{
|
|
id: "research",
|
|
model: { primary: "anthropic/claude-opus-4-7" },
|
|
},
|
|
],
|
|
},
|
|
};
|
|
mockSuccessfulEmbeddedAttempt();
|
|
|
|
await runEmbeddedAgent({
|
|
sessionId: "session-key-agent-default",
|
|
sessionKey: "agent:research:embedded:session-key-agent-default",
|
|
sessionFile,
|
|
workspaceDir,
|
|
config: cfg,
|
|
prompt: "hello",
|
|
timeoutMs: 5_000,
|
|
agentDir,
|
|
runId: nextRunId("session-key-agent-default"),
|
|
enqueue: immediateEnqueue,
|
|
});
|
|
|
|
expect(resolveModelAsyncMock).toHaveBeenNthCalledWith(
|
|
1,
|
|
"anthropic",
|
|
"claude-opus-4-7",
|
|
agentDir,
|
|
cfg,
|
|
expect.objectContaining({ skipAgentDiscovery: true }),
|
|
);
|
|
expect(
|
|
(firstRunEmbeddedAttemptParams() as { model?: { provider?: string; id?: string } }).model,
|
|
).toEqual(expect.objectContaining({ provider: "anthropic", id: "claude-opus-4-7" }));
|
|
});
|
|
|
|
it("resolves model-only provider refs instead of prefixing the default provider", async () => {
|
|
const sessionFile = nextSessionFile();
|
|
const cfg = addAnthropicProvider(createEmbeddedAgentRunnerOpenAiConfig(["mock-1"]), [
|
|
"claude-sonnet-4-6",
|
|
]);
|
|
mockSuccessfulEmbeddedAttempt();
|
|
|
|
await runEmbeddedAgent({
|
|
sessionId: "model-only-provider-ref",
|
|
sessionFile,
|
|
workspaceDir,
|
|
config: cfg,
|
|
prompt: "hello",
|
|
model: "anthropic/claude-sonnet-4-6",
|
|
timeoutMs: 5_000,
|
|
agentDir,
|
|
runId: nextRunId("model-only-provider-ref"),
|
|
enqueue: immediateEnqueue,
|
|
});
|
|
|
|
expect(resolveModelAsyncMock).toHaveBeenNthCalledWith(
|
|
1,
|
|
"anthropic",
|
|
"claude-sonnet-4-6",
|
|
agentDir,
|
|
cfg,
|
|
expect.objectContaining({ skipAgentDiscovery: true }),
|
|
);
|
|
expect(
|
|
(firstRunEmbeddedAttemptParams() as { model?: { provider?: string; id?: string } }).model,
|
|
).toEqual(expect.objectContaining({ provider: "anthropic", id: "claude-sonnet-4-6" }));
|
|
});
|
|
|
|
it("skips models.json generation when dynamic model resolution succeeds", async () => {
|
|
const sessionFile = nextSessionFile();
|
|
const cfg = createEmbeddedAgentRunnerOpenAiConfig([]);
|
|
runEmbeddedAttemptMock.mockResolvedValueOnce(
|
|
makeEmbeddedRunnerAttempt({
|
|
assistantTexts: ["ok"],
|
|
lastAssistant: buildEmbeddedRunnerAssistant({
|
|
content: [{ type: "text", text: "ok" }],
|
|
}),
|
|
}),
|
|
);
|
|
|
|
await runEmbeddedAgent({
|
|
sessionId: "dynamic-model",
|
|
sessionFile,
|
|
workspaceDir,
|
|
config: cfg,
|
|
prompt: "hello",
|
|
provider: "openrouter",
|
|
model: "openrouter/auto",
|
|
timeoutMs: 5_000,
|
|
agentDir,
|
|
runId: nextRunId("dynamic-model"),
|
|
enqueue: immediateEnqueue,
|
|
});
|
|
|
|
const resolveModelCall = firstMockCall(resolveModelAsyncMock, "model resolution");
|
|
expect(resolveModelCall?.[0]).toBe("openrouter");
|
|
expect(resolveModelCall?.[1]).toBe("openrouter/auto");
|
|
expect(resolveModelCall?.[2]).toBe(agentDir);
|
|
expect(resolveModelCall?.[3]).toBe(cfg);
|
|
expect(
|
|
(resolveModelCall?.[4] as { skipAgentDiscovery?: boolean } | undefined)?.skipAgentDiscovery,
|
|
).toBe(true);
|
|
expect(ensureOpenClawModelsJsonMock).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("resolves explicit OpenAI OpenClaw runs through Codex when auth order starts with Codex OAuth", async () => {
|
|
const sessionFile = nextSessionFile();
|
|
const baseConfig = createEmbeddedAgentRunnerOpenAiConfig(["mock-1"]);
|
|
const openAIProvider = baseConfig.models?.providers?.openai;
|
|
if (!openAIProvider) {
|
|
throw new Error("expected OpenAI provider test config");
|
|
}
|
|
const cfg = {
|
|
...baseConfig,
|
|
models: {
|
|
providers: {
|
|
openai: {
|
|
...openAIProvider,
|
|
baseUrl: "https://api.openai.com/v1",
|
|
},
|
|
},
|
|
},
|
|
agents: {
|
|
defaults: {
|
|
models: {
|
|
"openai/mock-1": {
|
|
agentRuntime: { id: "openclaw" },
|
|
},
|
|
},
|
|
},
|
|
},
|
|
auth: {
|
|
order: {
|
|
openai: ["openai:work", "openai:backup"],
|
|
},
|
|
},
|
|
};
|
|
runEmbeddedAttemptMock.mockResolvedValueOnce(
|
|
makeEmbeddedRunnerAttempt({
|
|
assistantTexts: ["ok"],
|
|
lastAssistant: buildEmbeddedRunnerAssistant({
|
|
content: [{ type: "text", text: "ok" }],
|
|
}),
|
|
}),
|
|
);
|
|
|
|
await runEmbeddedAgent({
|
|
sessionId: "codex-first-openclaw",
|
|
sessionFile,
|
|
workspaceDir,
|
|
config: cfg,
|
|
prompt: "hello",
|
|
provider: "openai",
|
|
model: "mock-1",
|
|
timeoutMs: 5_000,
|
|
agentDir,
|
|
runId: nextRunId("codex-first-openclaw"),
|
|
enqueue: immediateEnqueue,
|
|
});
|
|
|
|
expect(resolveModelAsyncMock).toHaveBeenNthCalledWith(
|
|
1,
|
|
"openai",
|
|
"mock-1",
|
|
agentDir,
|
|
cfg,
|
|
expect.objectContaining({ skipAgentDiscovery: true }),
|
|
);
|
|
expect(resolveModelAsyncMock).toHaveBeenCalledTimes(1);
|
|
expect(
|
|
(firstRunEmbeddedAttemptParams() as { model?: { provider?: string } }).model?.provider,
|
|
).toBe("openai");
|
|
});
|
|
|
|
it("resolves transport-owned OpenAI Codex runs against the runtime provider first", async () => {
|
|
const sessionFile = nextSessionFile();
|
|
const baseConfig = createEmbeddedAgentRunnerOpenAiConfig([]);
|
|
const openAIProvider = baseConfig.models?.providers?.openai;
|
|
if (!openAIProvider) {
|
|
throw new Error("expected OpenAI provider test config");
|
|
}
|
|
const cfg = {
|
|
...baseConfig,
|
|
models: {
|
|
providers: {
|
|
openai: {
|
|
...openAIProvider,
|
|
baseUrl: "https://api.openai.com/v1",
|
|
models: [],
|
|
},
|
|
},
|
|
},
|
|
agents: {
|
|
defaults: {
|
|
models: {
|
|
"openai/gpt-5.5": {
|
|
agentRuntime: { id: "codex" },
|
|
},
|
|
},
|
|
},
|
|
},
|
|
};
|
|
resolveModelAsyncMock.mockImplementation(async (provider: string, modelId: string) => {
|
|
if (provider === "openai" && modelId === "gpt-5.5") {
|
|
return createResolvedEmbeddedRunnerModel(provider, modelId);
|
|
}
|
|
return {
|
|
error: `Unknown model: ${provider}/${modelId}`,
|
|
authStorage: {
|
|
setRuntimeApiKey: () => undefined,
|
|
},
|
|
modelRegistry: {},
|
|
};
|
|
});
|
|
runEmbeddedAttemptMock.mockResolvedValueOnce(
|
|
makeEmbeddedRunnerAttempt({
|
|
assistantTexts: ["ok"],
|
|
lastAssistant: buildEmbeddedRunnerAssistant({
|
|
content: [{ type: "text", text: "ok" }],
|
|
}),
|
|
}),
|
|
);
|
|
|
|
await runEmbeddedAgent({
|
|
sessionId: "codex-runtime-model",
|
|
sessionFile,
|
|
workspaceDir,
|
|
config: cfg,
|
|
prompt: "hello",
|
|
provider: "openai",
|
|
model: "gpt-5.5",
|
|
timeoutMs: 5_000,
|
|
agentDir,
|
|
agentHarnessId: "codex",
|
|
runId: nextRunId("codex-runtime-model"),
|
|
enqueue: immediateEnqueue,
|
|
});
|
|
|
|
expect(resolveModelAsyncMock).toHaveBeenNthCalledWith(
|
|
1,
|
|
"openai",
|
|
"gpt-5.5",
|
|
agentDir,
|
|
cfg,
|
|
expect.objectContaining({ skipAgentDiscovery: true }),
|
|
);
|
|
expect(resolveModelAsyncMock).toHaveBeenCalledTimes(1);
|
|
expect(ensureOpenClawModelsJsonMock).not.toHaveBeenCalled();
|
|
expect(
|
|
(firstRunEmbeddedAttemptParams() as { model?: { provider?: string } }).model?.provider,
|
|
).toBe("openai");
|
|
});
|
|
|
|
it("resolves a transport-owned Codex model from the bundled static catalog in one resolver pass", async () => {
|
|
const sessionFile = nextSessionFile();
|
|
const baseConfig = createEmbeddedAgentRunnerOpenAiConfig([]);
|
|
const openAIProvider = baseConfig.models?.providers?.openai;
|
|
if (!openAIProvider) {
|
|
throw new Error("expected OpenAI provider test config");
|
|
}
|
|
const cfg = {
|
|
...baseConfig,
|
|
models: {
|
|
providers: {
|
|
openai: {
|
|
...openAIProvider,
|
|
baseUrl: "https://api.openai.com/v1",
|
|
models: [],
|
|
},
|
|
},
|
|
},
|
|
agents: {
|
|
defaults: {
|
|
models: {
|
|
"openai/gpt-5.3-codex": {
|
|
agentRuntime: { id: "codex" },
|
|
},
|
|
},
|
|
},
|
|
},
|
|
};
|
|
resolveModelAsyncMock.mockResolvedValueOnce(
|
|
createResolvedEmbeddedRunnerModel("openai", "gpt-5.3-codex"),
|
|
);
|
|
runEmbeddedAttemptMock.mockResolvedValueOnce(
|
|
makeEmbeddedRunnerAttempt({
|
|
assistantTexts: ["ok"],
|
|
lastAssistant: buildEmbeddedRunnerAssistant({
|
|
content: [{ type: "text", text: "ok" }],
|
|
}),
|
|
}),
|
|
);
|
|
|
|
await runEmbeddedAgent({
|
|
sessionId: "codex-static-catalog",
|
|
sessionFile,
|
|
workspaceDir,
|
|
config: cfg,
|
|
prompt: "hello",
|
|
provider: "openai",
|
|
model: "gpt-5.3-codex",
|
|
timeoutMs: 5_000,
|
|
agentDir,
|
|
agentHarnessId: "codex",
|
|
runId: nextRunId("codex-static-catalog"),
|
|
enqueue: immediateEnqueue,
|
|
});
|
|
|
|
expect(resolveModelAsyncMock).toHaveBeenCalledTimes(1);
|
|
expect(resolveModelAsyncMock).toHaveBeenNthCalledWith(
|
|
1,
|
|
"openai",
|
|
"gpt-5.3-codex",
|
|
agentDir,
|
|
cfg,
|
|
expect.objectContaining({
|
|
skipAgentDiscovery: true,
|
|
allowBundledStaticCatalogFallback: true,
|
|
preferBundledStaticCatalogTransport: true,
|
|
}),
|
|
);
|
|
expect(ensureOpenClawModelsJsonMock).not.toHaveBeenCalled();
|
|
expect(
|
|
(firstRunEmbeddedAttemptParams() as { model?: { provider?: string } }).model?.provider,
|
|
).toBe("openai");
|
|
});
|
|
|
|
it("backfills a trimmed session key from sessionId when the embedded run omits it", async () => {
|
|
const sessionFile = nextSessionFile();
|
|
const cfg = createEmbeddedAgentRunnerOpenAiConfig(["mock-1"]);
|
|
resolveSessionKeyForRequestMock.mockReturnValue({
|
|
sessionKey: "agent:test:resolved",
|
|
sessionStore: {},
|
|
storePath: "/tmp/session-store.json",
|
|
});
|
|
runEmbeddedAttemptMock.mockResolvedValueOnce(
|
|
makeEmbeddedRunnerAttempt({
|
|
assistantTexts: ["ok"],
|
|
lastAssistant: buildEmbeddedRunnerAssistant({
|
|
content: [{ type: "text", text: "ok" }],
|
|
}),
|
|
}),
|
|
);
|
|
|
|
await runEmbeddedAgent({
|
|
sessionId: "resume-123",
|
|
sessionKey: " ",
|
|
sessionFile,
|
|
workspaceDir,
|
|
config: cfg,
|
|
prompt: "hello",
|
|
provider: "openai",
|
|
model: "mock-1",
|
|
timeoutMs: 5_000,
|
|
agentDir,
|
|
runId: nextRunId("backfill"),
|
|
enqueue: immediateEnqueue,
|
|
});
|
|
|
|
expect(resolveSessionKeyForRequestMock).toHaveBeenCalledWith({
|
|
cfg,
|
|
sessionId: "resume-123",
|
|
agentId: undefined,
|
|
clone: false,
|
|
});
|
|
expect(firstRunEmbeddedAttemptParams().sessionKey).toBe("agent:test:resolved");
|
|
});
|
|
|
|
it("drops whitespace-only session keys when backfill cannot resolve a session key", async () => {
|
|
const sessionFile = nextSessionFile();
|
|
const cfg = createEmbeddedAgentRunnerOpenAiConfig(["mock-1"]);
|
|
resolveSessionKeyForRequestMock.mockReturnValue({
|
|
sessionKey: undefined,
|
|
sessionStore: {},
|
|
storePath: "/tmp/session-store.json",
|
|
});
|
|
runEmbeddedAttemptMock.mockResolvedValueOnce(
|
|
makeEmbeddedRunnerAttempt({
|
|
assistantTexts: ["ok"],
|
|
lastAssistant: buildEmbeddedRunnerAssistant({
|
|
content: [{ type: "text", text: "ok" }],
|
|
}),
|
|
}),
|
|
);
|
|
|
|
await runEmbeddedAgent({
|
|
sessionId: "resume-124",
|
|
sessionKey: " ",
|
|
sessionFile,
|
|
workspaceDir,
|
|
config: cfg,
|
|
prompt: "hello",
|
|
provider: "openai",
|
|
model: "mock-1",
|
|
timeoutMs: 5_000,
|
|
agentDir,
|
|
runId: nextRunId("backfill-empty"),
|
|
enqueue: immediateEnqueue,
|
|
});
|
|
|
|
expect(resolveSessionKeyForRequestMock).toHaveBeenCalledWith({
|
|
cfg,
|
|
sessionId: "resume-124",
|
|
agentId: undefined,
|
|
clone: false,
|
|
});
|
|
expect(firstRunEmbeddedAttemptParams().sessionKey).toBeUndefined();
|
|
});
|
|
|
|
it("logs when embedded session-key backfill resolution fails", async () => {
|
|
const sessionFile = nextSessionFile();
|
|
const cfg = createEmbeddedAgentRunnerOpenAiConfig(["mock-1"]);
|
|
resolveSessionKeyForRequestMock.mockImplementation(() => {
|
|
throw new Error("resolver exploded");
|
|
});
|
|
runEmbeddedAttemptMock.mockResolvedValueOnce(
|
|
makeEmbeddedRunnerAttempt({
|
|
assistantTexts: ["ok"],
|
|
lastAssistant: buildEmbeddedRunnerAssistant({
|
|
content: [{ type: "text", text: "ok" }],
|
|
}),
|
|
}),
|
|
);
|
|
|
|
await runEmbeddedAgent({
|
|
sessionId: "resume-456",
|
|
sessionFile,
|
|
workspaceDir,
|
|
config: cfg,
|
|
prompt: "hello",
|
|
provider: "openai",
|
|
model: "mock-1",
|
|
timeoutMs: 5_000,
|
|
agentDir,
|
|
runId: nextRunId("backfill-warn"),
|
|
enqueue: immediateEnqueue,
|
|
});
|
|
|
|
expect(
|
|
loggerWarnMock.mock.calls.some(([message]) =>
|
|
String(message ?? "").includes("[backfillSessionKey] Failed to resolve sessionKey"),
|
|
),
|
|
).toBe(true);
|
|
});
|
|
|
|
it("passes the current agentId when backfilling a session key", async () => {
|
|
const sessionFile = nextSessionFile();
|
|
const cfg = createEmbeddedAgentRunnerOpenAiConfig(["mock-1"]);
|
|
resolveStoredSessionKeyForSessionIdMock.mockReturnValue({
|
|
sessionKey: "agent:test:resolved",
|
|
sessionStore: {},
|
|
storePath: "/tmp/session-store.json",
|
|
});
|
|
runEmbeddedAttemptMock.mockResolvedValueOnce(
|
|
makeEmbeddedRunnerAttempt({
|
|
assistantTexts: ["ok"],
|
|
lastAssistant: buildEmbeddedRunnerAssistant({
|
|
content: [{ type: "text", text: "ok" }],
|
|
}),
|
|
}),
|
|
);
|
|
|
|
await runEmbeddedAgent({
|
|
sessionId: "resume-agent-1",
|
|
sessionKey: undefined,
|
|
sessionFile,
|
|
workspaceDir,
|
|
config: cfg,
|
|
prompt: "hello",
|
|
provider: "openai",
|
|
model: "mock-1",
|
|
timeoutMs: 5_000,
|
|
agentDir,
|
|
agentId: "embedded-agent",
|
|
runId: nextRunId("backfill-agent-scope"),
|
|
enqueue: immediateEnqueue,
|
|
});
|
|
|
|
expect(resolveStoredSessionKeyForSessionIdMock).toHaveBeenCalledWith({
|
|
cfg,
|
|
sessionId: "resume-agent-1",
|
|
agentId: "embedded-agent",
|
|
});
|
|
expect(resolveSessionKeyForRequestMock).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("disposes bundle MCP once when a one-shot local run completes", async () => {
|
|
const sessionFile = nextSessionFile();
|
|
const cfg = createEmbeddedAgentRunnerOpenAiConfig(["mock-1"]);
|
|
const sessionKey = nextSessionKey();
|
|
runEmbeddedAttemptMock.mockResolvedValueOnce(
|
|
makeEmbeddedRunnerAttempt({
|
|
assistantTexts: ["ok"],
|
|
lastAssistant: buildEmbeddedRunnerAssistant({
|
|
content: [{ type: "text", text: "ok" }],
|
|
}),
|
|
}),
|
|
);
|
|
|
|
await runEmbeddedAgent({
|
|
sessionId: "session:test",
|
|
sessionKey,
|
|
sessionFile,
|
|
workspaceDir,
|
|
config: cfg,
|
|
prompt: "hello",
|
|
provider: "openai",
|
|
model: "mock-1",
|
|
timeoutMs: 5_000,
|
|
agentDir,
|
|
runId: nextRunId("bundle-mcp-run-cleanup"),
|
|
enqueue: immediateEnqueue,
|
|
cleanupBundleMcpOnRunEnd: true,
|
|
});
|
|
|
|
expect(runEmbeddedAttemptMock).toHaveBeenCalledTimes(1);
|
|
expect(disposeSessionMcpRuntimeMock).toHaveBeenCalledTimes(1);
|
|
expect(disposeSessionMcpRuntimeMock).toHaveBeenCalledWith("session:test");
|
|
});
|
|
|
|
it("preserves bundle MCP state across retries within one local run", async () => {
|
|
refreshRuntimeAuthOnFirstPromptError = true;
|
|
const sessionFile = nextSessionFile();
|
|
const cfg = createEmbeddedAgentRunnerOpenAiConfig(["mock-1"]);
|
|
const sessionKey = nextSessionKey();
|
|
runEmbeddedAttemptMock
|
|
.mockImplementationOnce(async () => {
|
|
expect(disposeSessionMcpRuntimeMock).not.toHaveBeenCalled();
|
|
return makeEmbeddedRunnerAttempt({
|
|
promptError: new Error("401 unauthorized"),
|
|
});
|
|
})
|
|
.mockImplementationOnce(async () => {
|
|
expect(disposeSessionMcpRuntimeMock).not.toHaveBeenCalled();
|
|
return makeEmbeddedRunnerAttempt({
|
|
assistantTexts: ["ok"],
|
|
lastAssistant: buildEmbeddedRunnerAssistant({
|
|
content: [{ type: "text", text: "ok" }],
|
|
}),
|
|
});
|
|
});
|
|
|
|
const result = await runEmbeddedAgent({
|
|
sessionId: "session:test",
|
|
sessionKey,
|
|
sessionFile,
|
|
workspaceDir,
|
|
config: cfg,
|
|
prompt: "hello",
|
|
provider: "openai",
|
|
model: "mock-1",
|
|
timeoutMs: 5_000,
|
|
agentDir,
|
|
runId: nextRunId("bundle-mcp-retry"),
|
|
enqueue: immediateEnqueue,
|
|
cleanupBundleMcpOnRunEnd: true,
|
|
});
|
|
|
|
expect(runEmbeddedAttemptMock).toHaveBeenCalledTimes(2);
|
|
expect(result.payloads?.[0]?.text).toBe("ok");
|
|
expect(disposeSessionMcpRuntimeMock).toHaveBeenCalledTimes(1);
|
|
expect(disposeSessionMcpRuntimeMock).toHaveBeenCalledWith("session:test");
|
|
});
|
|
|
|
it("returns visible assistant prose without semantic retry classification", async () => {
|
|
const sessionFile = nextSessionFile();
|
|
const cfg = createEmbeddedAgentRunnerOpenAiConfig(["gpt-5.4"]);
|
|
const sessionKey = nextSessionKey();
|
|
|
|
runEmbeddedAttemptMock.mockImplementationOnce(async (params: unknown) => {
|
|
expect((params as { prompt?: string }).prompt).toMatch(/^ship it(?:\n\n|$)/);
|
|
return makeEmbeddedRunnerAttempt({
|
|
assistantTexts: ["I'll inspect the files, make the change, and run the checks."],
|
|
lastAssistant: buildEmbeddedRunnerAssistant({
|
|
model: "gpt-5.4",
|
|
content: [
|
|
{
|
|
type: "text",
|
|
text: "I'll inspect the files, make the change, and run the checks.",
|
|
},
|
|
],
|
|
}),
|
|
});
|
|
});
|
|
|
|
const result = await runEmbeddedAgent({
|
|
sessionId: "session:test",
|
|
sessionKey,
|
|
sessionFile,
|
|
workspaceDir,
|
|
config: cfg,
|
|
prompt: "ship it",
|
|
provider: "openai",
|
|
model: "gpt-5.4",
|
|
timeoutMs: 5_000,
|
|
agentDir,
|
|
runId: nextRunId("visible-prose"),
|
|
enqueue: immediateEnqueue,
|
|
});
|
|
|
|
expect(runEmbeddedAttemptMock).toHaveBeenCalledTimes(1);
|
|
expect(result.payloads?.[0]?.text).toBe(
|
|
"I'll inspect the files, make the change, and run the checks.",
|
|
);
|
|
});
|
|
|
|
it("handles prompt error paths without dropping user state", async () => {
|
|
const sessionFile = nextSessionFile();
|
|
const cfg = createEmbeddedAgentRunnerOpenAiConfig(["mock-error"]);
|
|
const sessionKey = nextSessionKey();
|
|
runEmbeddedAttemptMock.mockResolvedValueOnce(
|
|
makeEmbeddedRunnerAttempt({
|
|
promptError: new Error("boom"),
|
|
}),
|
|
);
|
|
await expect(
|
|
runEmbeddedAgent({
|
|
sessionId: "session:test",
|
|
sessionKey,
|
|
sessionFile,
|
|
workspaceDir,
|
|
config: cfg,
|
|
prompt: "boom",
|
|
provider: "openai",
|
|
model: "mock-error",
|
|
timeoutMs: 5_000,
|
|
agentDir,
|
|
runId: nextRunId("prompt-error"),
|
|
enqueue: immediateEnqueue,
|
|
}),
|
|
).rejects.toThrow("boom");
|
|
|
|
try {
|
|
const messages = await readSessionMessages(sessionFile);
|
|
const userIndex = messages.findIndex(
|
|
(message) => message?.role === "user" && textFromContent(message.content) === "boom",
|
|
);
|
|
expect(userIndex).toBeGreaterThanOrEqual(0);
|
|
} catch (err) {
|
|
if ((err as NodeJS.ErrnoException | undefined)?.code !== "ENOENT") {
|
|
throw err;
|
|
}
|
|
}
|
|
});
|
|
|
|
it(
|
|
"preserves existing transcript entries across an additional turn",
|
|
{ timeout: 7_000 },
|
|
async () => {
|
|
const sessionFile = nextSessionFile();
|
|
const sessionKey = nextSessionKey();
|
|
|
|
const sessionManager = SessionManager.open(sessionFile);
|
|
sessionManager.appendMessage({
|
|
role: "user",
|
|
content: [{ type: "text", text: "seed user" }],
|
|
timestamp: Date.now(),
|
|
});
|
|
sessionManager.appendMessage({
|
|
role: "assistant",
|
|
content: [{ type: "text", text: "seed assistant" }],
|
|
stopReason: "stop",
|
|
api: "openai-responses",
|
|
provider: "openai",
|
|
model: "mock-1",
|
|
usage: createMockUsage(1, 1),
|
|
timestamp: Date.now(),
|
|
});
|
|
|
|
await runDefaultEmbeddedTurn(sessionFile, "hello", sessionKey);
|
|
|
|
const messages = await readSessionMessages(sessionFile);
|
|
const seedUserIndex = messages.findIndex(
|
|
(message) => message?.role === "user" && textFromContent(message.content) === "seed user",
|
|
);
|
|
const seedAssistantIndex = messages.findIndex(
|
|
(message) =>
|
|
message?.role === "assistant" && textFromContent(message.content) === "seed assistant",
|
|
);
|
|
expect(seedUserIndex).toBeGreaterThanOrEqual(0);
|
|
expect(seedAssistantIndex).toBeGreaterThan(seedUserIndex);
|
|
expect(messages.length).toBeGreaterThanOrEqual(2);
|
|
},
|
|
);
|
|
|
|
it("repairs orphaned user messages and continues", async () => {
|
|
const result = await runWithOrphanedSingleUserMessage("orphaned user", nextSessionKey());
|
|
|
|
expect(result.meta.error).toBeUndefined();
|
|
expect(result.payloads?.[0]?.text).toBe("ok");
|
|
});
|
|
});
|