Files
openclaw/src/gateway/openai-http.test.ts
2026-03-07 17:58:31 +00:00

751 lines
24 KiB
TypeScript

import { afterAll, beforeAll, describe, expect, it } from "vitest";
import { HISTORY_CONTEXT_MARKER } from "../auto-reply/reply/history.js";
import { CURRENT_MESSAGE_MARKER } from "../auto-reply/reply/mentions.js";
import { emitAgentEvent } from "../infra/agent-events.js";
import { buildAssistantDeltaResult } from "./test-helpers.agent-results.js";
import {
agentCommand,
getFreePort,
installGatewayTestHooks,
testState,
withGatewayServer,
} from "./test-helpers.js";
installGatewayTestHooks({ scope: "suite" });
let startGatewayServer: typeof import("./server.js").startGatewayServer;
let enabledServer: Awaited<ReturnType<typeof startServer>>;
let enabledPort: number;
beforeAll(async () => {
({ startGatewayServer } = await import("./server.js"));
enabledPort = await getFreePort();
enabledServer = await startServer(enabledPort);
});
afterAll(async () => {
await enabledServer.close({ reason: "openai http enabled suite done" });
});
async function startServerWithDefaultConfig(port: number) {
return await startGatewayServer(port, {
host: "127.0.0.1",
auth: { mode: "token", token: "secret" },
controlUiEnabled: false,
openAiChatCompletionsEnabled: false,
});
}
async function startServer(port: number, opts?: { openAiChatCompletionsEnabled?: boolean }) {
return await startGatewayServer(port, {
host: "127.0.0.1",
auth: { mode: "token", token: "secret" },
controlUiEnabled: false,
openAiChatCompletionsEnabled: opts?.openAiChatCompletionsEnabled ?? true,
});
}
async function postChatCompletions(port: number, body: unknown, headers?: Record<string, string>) {
const res = await fetch(`http://127.0.0.1:${port}/v1/chat/completions`, {
method: "POST",
headers: {
"content-type": "application/json",
authorization: "Bearer secret",
...headers,
},
body: JSON.stringify(body),
});
return res;
}
async function expectChatCompletionsDisabled(
start: (port: number) => Promise<{ close: (opts?: { reason?: string }) => Promise<void> }>,
) {
const port = await getFreePort();
const server = await start(port);
try {
const res = await postChatCompletions(port, {
model: "openclaw",
messages: [{ role: "user", content: "hi" }],
});
expect(res.status).toBe(404);
await res.text();
} finally {
await server.close({ reason: "test done" });
}
}
function parseSseDataLines(text: string): string[] {
return text
.split("\n")
.map((line) => line.trim())
.filter((line) => line.startsWith("data: "))
.map((line) => line.slice("data: ".length));
}
describe("OpenAI-compatible HTTP API (e2e)", () => {
it("rejects when disabled (default + config)", { timeout: 15_000 }, async () => {
await expectChatCompletionsDisabled(startServerWithDefaultConfig);
await expectChatCompletionsDisabled((port) =>
startServer(port, {
openAiChatCompletionsEnabled: false,
}),
);
});
it("handles request validation and routing", async () => {
const port = enabledPort;
const mockAgentOnce = (payloads: Array<{ text: string }>) => {
agentCommand.mockClear();
agentCommand.mockResolvedValueOnce({ payloads } as never);
};
const expectAgentSessionKeyMatch = async (request: {
body: unknown;
headers?: Record<string, string>;
matcher: RegExp;
}) => {
mockAgentOnce([{ text: "hello" }]);
const res = await postChatCompletions(port, request.body, request.headers);
expect(res.status).toBe(200);
expect(agentCommand).toHaveBeenCalledTimes(1);
const opts = (agentCommand.mock.calls[0] as unknown[] | undefined)?.[0];
expect((opts as { sessionKey?: string } | undefined)?.sessionKey ?? "").toMatch(
request.matcher,
);
await res.text();
};
const expectMessageContext = (
message: string,
expected: { history: string[]; current: string[] },
) => {
expect(message).toContain(HISTORY_CONTEXT_MARKER);
for (const line of expected.history) {
expect(message).toContain(line);
}
expect(message).toContain(CURRENT_MESSAGE_MARKER);
for (const line of expected.current) {
expect(message).toContain(line);
}
};
const getFirstAgentCall = () =>
(agentCommand.mock.calls[0] as unknown[] | undefined)?.[0] as
| {
sessionKey?: string;
message?: string;
extraSystemPrompt?: string;
images?: Array<{ type: string; data: string; mimeType: string }>;
}
| undefined;
const getFirstAgentMessage = () => getFirstAgentCall()?.message ?? "";
const expectInvalidRequestNoDispatch = async (messages: unknown[]) => {
agentCommand.mockClear();
const res = await postChatCompletions(port, {
model: "openclaw",
messages,
});
expect(res.status).toBe(400);
const json = (await res.json()) as Record<string, unknown>;
expect((json.error as Record<string, unknown> | undefined)?.type).toBe(
"invalid_request_error",
);
expect(agentCommand).toHaveBeenCalledTimes(0);
};
const postSyncUserMessage = async (message: string) => {
const res = await postChatCompletions(port, {
stream: false,
model: "openclaw",
messages: [{ role: "user", content: message }],
});
expect(res.status).toBe(200);
return (await res.json()) as Record<string, unknown>;
};
try {
{
const res = await fetch(`http://127.0.0.1:${port}/v1/chat/completions`, {
method: "GET",
headers: { authorization: "Bearer secret" },
});
expect(res.status).toBe(405);
await res.text();
}
{
const res = await fetch(`http://127.0.0.1:${port}/v1/chat/completions`, {
method: "POST",
headers: { "content-type": "application/json" },
body: JSON.stringify({ messages: [{ role: "user", content: "hi" }] }),
});
expect(res.status).toBe(401);
await res.text();
}
{
await expectAgentSessionKeyMatch({
body: { model: "openclaw", messages: [{ role: "user", content: "hi" }] },
headers: { "x-openclaw-agent-id": "beta" },
matcher: /^agent:beta:/,
});
}
{
await expectAgentSessionKeyMatch({
body: {
model: "openclaw:beta",
messages: [{ role: "user", content: "hi" }],
},
matcher: /^agent:beta:/,
});
}
{
await expectAgentSessionKeyMatch({
body: {
model: "openclaw:beta",
messages: [{ role: "user", content: "hi" }],
},
headers: { "x-openclaw-agent-id": "alpha" },
matcher: /^agent:alpha:/,
});
}
{
mockAgentOnce([{ text: "hello" }]);
const res = await postChatCompletions(
port,
{ model: "openclaw", messages: [{ role: "user", content: "hi" }] },
{
"x-openclaw-agent-id": "beta",
"x-openclaw-session-key": "agent:beta:openai:custom",
},
);
expect(res.status).toBe(200);
const opts = (agentCommand.mock.calls[0] as unknown[] | undefined)?.[0];
expect((opts as { sessionKey?: string } | undefined)?.sessionKey).toBe(
"agent:beta:openai:custom",
);
await res.text();
}
{
mockAgentOnce([{ text: "hello" }]);
const res = await postChatCompletions(port, {
user: "alice",
model: "openclaw",
messages: [{ role: "user", content: "hi" }],
});
expect(res.status).toBe(200);
const opts = (agentCommand.mock.calls[0] as unknown[] | undefined)?.[0];
expect((opts as { sessionKey?: string } | undefined)?.sessionKey ?? "").toContain(
"openai-user:alice",
);
await res.text();
}
{
mockAgentOnce([{ text: "hello" }]);
const res = await postChatCompletions(port, {
model: "openclaw",
messages: [
{
role: "user",
content: [
{ type: "text", text: "hello" },
{ type: "input_text", text: "world" },
],
},
],
});
expect(res.status).toBe(200);
const opts = (agentCommand.mock.calls[0] as unknown[] | undefined)?.[0];
expect((opts as { message?: string } | undefined)?.message).toBe("hello\nworld");
await res.text();
}
{
const imageData = "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAA";
mockAgentOnce([{ text: "looks good" }]);
const res = await postChatCompletions(port, {
model: "openclaw",
messages: [
{
role: "user",
content: [
{ type: "text", text: "describe this" },
{
type: "image_url",
image_url: { url: `data:image/png;base64,${imageData}` },
},
],
},
],
});
expect(res.status).toBe(200);
const firstCall = getFirstAgentCall();
expect(firstCall?.message).toBe("describe this");
expect(firstCall?.images).toEqual([
{ type: "image", data: imageData, mimeType: "image/png" },
]);
await res.text();
}
{
const imageData = "QUJDRA==";
mockAgentOnce([{ text: "supports data-uri params" }]);
const res = await postChatCompletions(port, {
model: "openclaw",
messages: [
{
role: "user",
content: [
{ type: "text", text: "with metadata params" },
{
type: "image_url",
image_url: { url: `data:image/png;charset=utf-8;base64,${imageData}` },
},
],
},
],
});
expect(res.status).toBe(200);
const firstCall = getFirstAgentCall();
expect(firstCall?.images).toEqual([
{ type: "image", data: imageData, mimeType: "image/png" },
]);
await res.text();
}
{
await expectInvalidRequestNoDispatch([
{
role: "user",
content: [
{
type: "image_url",
image_url: { url: "https://example.com/image.png" },
},
],
},
]);
}
{
mockAgentOnce([{ text: "I can see the image" }]);
const res = await postChatCompletions(port, {
model: "openclaw",
messages: [
{
role: "user",
content: [
{
type: "image_url",
image_url: { url: "data:image/jpeg;base64,QUJDRA==" },
},
],
},
],
});
expect(res.status).toBe(200);
const firstCall = getFirstAgentCall();
expect(firstCall?.message).toContain("User sent image(s) with no text.");
expect(firstCall?.images).toEqual([
{ type: "image", data: "QUJDRA==", mimeType: "image/jpeg" },
]);
await res.text();
}
{
mockAgentOnce([{ text: "follow up answer" }]);
const res = await postChatCompletions(port, {
model: "openclaw",
messages: [
{
role: "user",
content: [
{ type: "image_url", image_url: { url: "data:image/png;base64,QUJDRA==" } },
],
},
{ role: "assistant", content: "I can see it." },
{ role: "user", content: "What color was it?" },
],
});
expect(res.status).toBe(200);
const firstCall = getFirstAgentCall();
expect(firstCall?.images).toBeUndefined();
expect(firstCall?.message ?? "").not.toContain("User sent image(s) with no text.");
await res.text();
}
{
mockAgentOnce([{ text: "latest image only" }]);
const res = await postChatCompletions(port, {
model: "openclaw",
messages: [
{
role: "user",
content: [
{ type: "text", text: "first" },
{ type: "image_url", image_url: { url: "data:image/png;base64,QUFBQQ==" } },
],
},
{ role: "assistant", content: "noted" },
{
role: "user",
content: [
{ type: "text", text: "second" },
{ type: "image_url", image_url: { url: "data:image/png;base64,QkJCQg==" } },
],
},
],
});
expect(res.status).toBe(200);
const firstCall = getFirstAgentCall();
expect(firstCall?.images).toEqual([
{ type: "image", data: "QkJCQg==", mimeType: "image/png" },
]);
await res.text();
}
{
const largeMessage = "x".repeat(1_200_000);
mockAgentOnce([{ text: "accepted" }]);
const res = await postChatCompletions(port, {
model: "openclaw",
messages: [{ role: "user", content: largeMessage }],
});
expect(res.status).toBe(200);
await res.text();
}
{
await expectInvalidRequestNoDispatch([
{
role: "user",
content: [
{
type: "image_url",
image_url: { url: "data:application/pdf;base64,QUJDRA==" },
},
],
},
]);
}
{
const manyImageParts = Array.from({ length: 9 }).map(() => ({
type: "image_url",
image_url: { url: "data:image/png;base64,QUJDRA==" },
}));
await expectInvalidRequestNoDispatch([
{
role: "user",
content: manyImageParts,
},
]);
}
{
mockAgentOnce([{ text: "I am Claude" }]);
const res = await postChatCompletions(port, {
model: "openclaw",
messages: [
{ role: "system", content: "You are a helpful assistant." },
{ role: "user", content: "Hello, who are you?" },
{ role: "assistant", content: "I am Claude." },
{ role: "user", content: "What did I just ask you?" },
],
});
expect(res.status).toBe(200);
const message = getFirstAgentMessage();
expectMessageContext(message, {
history: ["User: Hello, who are you?", "Assistant: I am Claude."],
current: ["User: What did I just ask you?"],
});
await res.text();
}
{
mockAgentOnce([{ text: "hello" }]);
const res = await postChatCompletions(port, {
model: "openclaw",
messages: [
{ role: "system", content: "You are a helpful assistant." },
{ role: "user", content: "Hello" },
],
});
expect(res.status).toBe(200);
const message = getFirstAgentMessage();
expect(message).not.toContain(HISTORY_CONTEXT_MARKER);
expect(message).not.toContain(CURRENT_MESSAGE_MARKER);
expect(message).toBe("Hello");
await res.text();
}
{
mockAgentOnce([{ text: "hello" }]);
const res = await postChatCompletions(port, {
model: "openclaw",
messages: [
{ role: "developer", content: "You are a helpful assistant." },
{ role: "user", content: "Hello" },
],
});
expect(res.status).toBe(200);
const extraSystemPrompt = getFirstAgentCall()?.extraSystemPrompt ?? "";
expect(extraSystemPrompt).toBe("You are a helpful assistant.");
await res.text();
}
{
mockAgentOnce([{ text: "ok" }]);
const res = await postChatCompletions(port, {
model: "openclaw",
messages: [
{ role: "system", content: "You are a helpful assistant." },
{ role: "user", content: "What's the weather?" },
{ role: "assistant", content: "Checking the weather." },
{ role: "tool", content: "Sunny, 70F." },
],
});
expect(res.status).toBe(200);
const message = getFirstAgentMessage();
expectMessageContext(message, {
history: ["User: What's the weather?", "Assistant: Checking the weather."],
current: ["Tool: Sunny, 70F."],
});
await res.text();
}
{
mockAgentOnce([{ text: "tool follow-up ok" }]);
const res = await postChatCompletions(port, {
model: "openclaw",
messages: [
{
role: "user",
content: [
{ type: "text", text: "look at this" },
{ type: "image_url", image_url: { url: "https://example.com/image.png" } },
],
},
{ role: "assistant", content: "Checking the image." },
{ role: "tool", content: "Vision tool says it is blue." },
],
});
expect(res.status).toBe(200);
const firstCall = getFirstAgentCall();
expect(firstCall?.images).toBeUndefined();
const message = getFirstAgentMessage();
expectMessageContext(message, {
history: ["User: look at this", "Assistant: Checking the image."],
current: ["Tool: Vision tool says it is blue."],
});
expect(message).not.toContain("User sent image(s) with no text.");
await res.text();
}
{
mockAgentOnce([{ text: "hello" }]);
const json = await postSyncUserMessage("hi");
expect(json.object).toBe("chat.completion");
expect(Array.isArray(json.choices)).toBe(true);
const choice0 = (json.choices as Array<Record<string, unknown>>)[0] ?? {};
const msg = (choice0.message as Record<string, unknown> | undefined) ?? {};
expect(msg.role).toBe("assistant");
expect(msg.content).toBe("hello");
}
{
agentCommand.mockClear();
agentCommand.mockResolvedValueOnce({ payloads: [{ text: "" }] } as never);
const json = await postSyncUserMessage("hi");
const choice0 = (json.choices as Array<Record<string, unknown>>)[0] ?? {};
const msg = (choice0.message as Record<string, unknown> | undefined) ?? {};
expect(msg.content).toBe("No response from OpenClaw.");
}
{
const res = await postChatCompletions(port, {
model: "openclaw",
messages: [{ role: "system", content: "yo" }],
});
expect(res.status).toBe(400);
const missingUserJson = (await res.json()) as Record<string, unknown>;
expect((missingUserJson.error as Record<string, unknown> | undefined)?.type).toBe(
"invalid_request_error",
);
}
} finally {
// shared server
}
});
it("returns 429 for repeated failed auth when gateway.auth.rateLimit is configured", async () => {
testState.gatewayAuth = {
mode: "token",
token: "secret",
rateLimit: { maxAttempts: 1, windowMs: 60_000, lockoutMs: 60_000, exemptLoopback: false },
// oxlint-disable-next-line typescript/no-explicit-any
} as any;
await withGatewayServer(
async ({ port }) => {
const headers = {
"content-type": "application/json",
authorization: "Bearer wrong",
};
const body = {
model: "openclaw",
messages: [{ role: "user", content: "hi" }],
};
const first = await fetch(`http://127.0.0.1:${port}/v1/chat/completions`, {
method: "POST",
headers,
body: JSON.stringify(body),
});
expect(first.status).toBe(401);
const second = await fetch(`http://127.0.0.1:${port}/v1/chat/completions`, {
method: "POST",
headers,
body: JSON.stringify(body),
});
expect(second.status).toBe(429);
expect(second.headers.get("retry-after")).toBeTruthy();
},
{
serverOptions: {
host: "127.0.0.1",
controlUiEnabled: false,
openAiChatCompletionsEnabled: true,
},
},
);
});
it("streams SSE chunks when stream=true", async () => {
const port = enabledPort;
try {
{
agentCommand.mockClear();
agentCommand.mockImplementationOnce((async (opts: unknown) =>
buildAssistantDeltaResult({
opts,
emit: emitAgentEvent,
deltas: ["he", "llo"],
text: "hello",
})) as never);
const res = await postChatCompletions(port, {
stream: true,
model: "openclaw",
messages: [{ role: "user", content: "hi" }],
});
expect(res.status).toBe(200);
expect(res.headers.get("content-type") ?? "").toContain("text/event-stream");
const text = await res.text();
const data = parseSseDataLines(text);
expect(data[data.length - 1]).toBe("[DONE]");
const jsonChunks = data
.filter((d) => d !== "[DONE]")
.map((d) => JSON.parse(d) as Record<string, unknown>);
expect(jsonChunks.some((c) => c.object === "chat.completion.chunk")).toBe(true);
const allContent = jsonChunks
.flatMap((c) => (c.choices as Array<Record<string, unknown>> | undefined) ?? [])
.map((choice) => (choice.delta as Record<string, unknown> | undefined)?.content)
.filter((v): v is string => typeof v === "string")
.join("");
expect(allContent).toBe("hello");
}
{
agentCommand.mockClear();
agentCommand.mockImplementationOnce((async (opts: unknown) =>
buildAssistantDeltaResult({
opts,
emit: emitAgentEvent,
deltas: ["hi", "hi"],
text: "hihi",
})) as never);
const repeatedRes = await postChatCompletions(port, {
stream: true,
model: "openclaw",
messages: [{ role: "user", content: "hi" }],
});
expect(repeatedRes.status).toBe(200);
const repeatedText = await repeatedRes.text();
const repeatedData = parseSseDataLines(repeatedText);
const repeatedChunks = repeatedData
.filter((d) => d !== "[DONE]")
.map((d) => JSON.parse(d) as Record<string, unknown>);
const repeatedContent = repeatedChunks
.flatMap((c) => (c.choices as Array<Record<string, unknown>> | undefined) ?? [])
.map((choice) => (choice.delta as Record<string, unknown> | undefined)?.content)
.filter((v): v is string => typeof v === "string")
.join("");
expect(repeatedContent).toBe("hihi");
}
{
agentCommand.mockClear();
agentCommand.mockResolvedValueOnce({
payloads: [{ text: "hello" }],
} as never);
const fallbackRes = await postChatCompletions(port, {
stream: true,
model: "openclaw",
messages: [{ role: "user", content: "hi" }],
});
expect(fallbackRes.status).toBe(200);
const fallbackText = await fallbackRes.text();
expect(fallbackText).toContain("[DONE]");
expect(fallbackText).toContain("hello");
}
{
agentCommand.mockClear();
agentCommand.mockRejectedValueOnce(new Error("boom"));
const errorRes = await postChatCompletions(port, {
stream: true,
model: "openclaw",
messages: [{ role: "user", content: "hi" }],
});
expect(errorRes.status).toBe(200);
const errorText = await errorRes.text();
const errorData = parseSseDataLines(errorText);
expect(errorData[errorData.length - 1]).toBe("[DONE]");
const errorChunks = errorData
.filter((d) => d !== "[DONE]")
.map((d) => JSON.parse(d) as Record<string, unknown>);
const stopChoice = errorChunks
.flatMap((c) => (c.choices as Array<Record<string, unknown>> | undefined) ?? [])
.find((choice) => choice.finish_reason === "stop");
expect((stopChoice?.delta as Record<string, unknown> | undefined)?.content).toBe(
"Error: internal error",
);
}
} finally {
// shared server
}
});
});