Files
adolf/packages/ai/src/providers/openai-chatgpt-responses.test.ts
alvis bedb527145
Some checks failed
ClawSweeper Dispatch / dispatch (push) Has been cancelled
CodeQL / Security High (actions) (push) Has been cancelled
CodeQL / Security High (channel-runtime-boundary) (push) Has been cancelled
CodeQL / Security High (core-auth-secrets) (push) Has been cancelled
CodeQL / Security High (mcp-process-tool-boundary) (push) Has been cancelled
CodeQL / Security High (network-ssrf-boundary) (push) Has been cancelled
CodeQL / Security High (plugin-trust-boundary) (push) Has been cancelled
CodeQL / Security High (process-exec-boundary) (push) Has been cancelled
Docs Sync Publish Repo / sync-publish-repo (push) Has been cancelled
Docs / docs (push) Has been cancelled
OpenClaw Stable Main Closeout / Resolve stable release closeout inputs (push) Has been cancelled
OpenClaw Stable Main Closeout / Verify stable main closeout (push) Has been cancelled
Workflow Sanity / no-tabs (push) Has been cancelled
Workflow Sanity / actionlint (push) Has been cancelled
Workflow Sanity / generated-doc-baselines (push) Has been cancelled
CI / runner-admission (push) Has been cancelled
CI / preflight (push) Has been cancelled
CI / security-fast (push) Has been cancelled
CI / pnpm-store-warmup (push) Has been cancelled
CI / build-artifacts (push) Has been cancelled
CI / native-i18n (push) Has been cancelled
CI / ${{ matrix.check_name }} (push) Has been cancelled
CI / ${{ matrix.checkName }} (push) Has been cancelled
CI / checks-node-compat-node22 (push) Has been cancelled
CI / check-bundled-channel-config-metadata (push) Has been cancelled
CI / check-dependencies (push) Has been cancelled
CI / check-guards (push) Has been cancelled
CI / check-lint (push) Has been cancelled
CI / check-prod-types (push) Has been cancelled
CI / check-shrinkwrap (push) Has been cancelled
CI / check-test-types (push) Has been cancelled
CI / check-additional-boundaries-a (push) Has been cancelled
CI / check-additional-boundaries-bcd (push) Has been cancelled
CI / check-additional-extension-bundled (push) Has been cancelled
CI / check-additional-extension-channels (push) Has been cancelled
CI / check-additional-extension-package-boundary (push) Has been cancelled
CI / check-additional-runtime-topology-architecture (push) Has been cancelled
CI / check-session-accessor-boundary (push) Has been cancelled
CI / check-session-transcript-reader-boundary (push) Has been cancelled
CI / check-docs (push) Has been cancelled
CI / skills-python (push) Has been cancelled
CI / macos-swift (push) Has been cancelled
CI / ios-build (push) Has been cancelled
CI / ci-timings-summary (push) Has been cancelled
Native App Locale Refresh / Refresh native fa (push) Has been cancelled
Native App Locale Refresh / Refresh native fr (push) Has been cancelled
Native App Locale Refresh / Refresh native hi (push) Has been cancelled
Native App Locale Refresh / Refresh native id (push) Has been cancelled
Native App Locale Refresh / Refresh native it (push) Has been cancelled
Native App Locale Refresh / Refresh native ja-JP (push) Has been cancelled
Control UI Locale Refresh / plan (push) Has been cancelled
Control UI Locale Refresh / Refresh ${{ matrix.locale }} (push) Has been cancelled
Control UI Locale Refresh / Commit control UI locale refresh (push) Has been cancelled
Live Media Runner Image / Build live media runner image (push) Has been cancelled
Native App Locale Refresh / Refresh native ar (push) Has been cancelled
Native App Locale Refresh / Refresh native de (push) Has been cancelled
Native App Locale Refresh / Refresh native es (push) Has been cancelled
Native App Locale Refresh / Refresh native ko (push) Has been cancelled
Native App Locale Refresh / Refresh native nl (push) Has been cancelled
Native App Locale Refresh / Refresh native pl (push) Has been cancelled
Native App Locale Refresh / Refresh native pt-BR (push) Has been cancelled
Native App Locale Refresh / Refresh native ru (push) Has been cancelled
Native App Locale Refresh / Refresh native sv (push) Has been cancelled
Native App Locale Refresh / Refresh native th (push) Has been cancelled
Native App Locale Refresh / Refresh native tr (push) Has been cancelled
Native App Locale Refresh / Refresh native uk (push) Has been cancelled
Native App Locale Refresh / Refresh native vi (push) Has been cancelled
Native App Locale Refresh / Refresh native zh-CN (push) Has been cancelled
Native App Locale Refresh / Refresh native zh-TW (push) Has been cancelled
Native App Locale Refresh / Commit native locale refresh (push) Has been cancelled
Plugin Init Scaffold Validation / Validate provider scaffold (push) Has been cancelled
Plugin NPM Release / preview_plugins_npm (push) Has been cancelled
Plugin NPM Release / Validate release publish approval (push) Has been cancelled
Plugin NPM Release / preview_plugin_pack (push) Has been cancelled
Plugin NPM Release / publish_plugins_npm (push) Has been cancelled
Sandbox Common Smoke / sandbox-common-smoke (push) Has been cancelled
Website Installer Sync / static (push) Has been cancelled
Website Installer Sync / linux-docker (push) Has been cancelled
Website Installer Sync / macos-installer (push) Has been cancelled
Website Installer Sync / windows-installer (push) Has been cancelled
Website Installer Sync / sync-website (push) Has been cancelled
Vendor OpenClaw source as Adolf fork baseline
Adolf is a fork/vendored clone of github.com/openclaw/openclaw (v2026.6.11),
free to diverge. Tree copied sans upstream .git; upstream remote added for
future syncs. Node pinned to 24 (.nvmrc); engines already require >=22.19.
Preserves docs/ARCHITECTURE.md.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01LeqyaxJF2nbRXJtae2kNB2
2026-07-05 09:36:54 +00:00

954 lines
29 KiB
TypeScript

import { arch, platform, release } from "node:os";
import { zstdDecompressSync } from "node:zlib";
// ChatGPT Responses provider tests cover stream handling and timeout behavior.
import { MAX_TIMER_TIMEOUT_MS } from "@openclaw/normalization-core/number-coercion";
import { afterEach, describe, expect, it, vi } from "vitest";
import type { Context, Model } from "../types.js";
import { SYSTEM_PROMPT_CACHE_BOUNDARY } from "../utils/system-prompt-cache-boundary.js";
import {
closeOpenAICodexWebSocketSessions,
extractOpenAICodexAccountId,
parseSSEForTest,
resetOpenAICodexWebSocketDebugStats,
streamSimpleOpenAICodexResponses,
streamOpenAICodexResponses,
} from "./openai-chatgpt-responses.js";
function createJwt(payload: Record<string, unknown>): string {
const header = Buffer.from(JSON.stringify({ alg: "none", typ: "JWT" })).toString("base64url");
const body = Buffer.from(JSON.stringify(payload)).toString("base64url");
return `${header}.${body}.signature`;
}
function stubTimeoutSignal(timeoutMs: number): void {
vi.spyOn(AbortSignal, "timeout").mockImplementation((actualTimeoutMs) => {
expect(actualTimeoutMs).toBe(timeoutMs);
const controller = new AbortController();
queueMicrotask(() => {
controller.abort(new DOMException("timed out", "TimeoutError"));
});
return controller.signal;
});
}
function stubHangingFetch(timeoutMs: number): void {
stubTimeoutSignal(timeoutMs);
vi.stubGlobal(
"fetch",
vi.fn(
(_input: Parameters<typeof fetch>[0], init?: Parameters<typeof fetch>[1]) =>
new Promise<Response>((_resolve, reject) => {
const signal = init?.signal;
if (!signal) {
reject(new Error("missing abort signal"));
return;
}
const abort = () => {
reject(
signal.reason instanceof Error
? signal.reason
: new DOMException("aborted", "AbortError"),
);
};
if (signal.aborted) {
abort();
return;
}
signal.addEventListener("abort", abort, { once: true });
}),
),
);
}
function completedSseResponse(responseId = "resp_test"): Response {
const event = {
type: "response.completed",
response: {
id: responseId,
status: "completed",
output: [],
usage: { input_tokens: 5, output_tokens: 3, total_tokens: 8 },
},
};
return new Response(`data: ${JSON.stringify(event)}\n\n`, {
status: 200,
headers: { "content-type": "text/event-stream" },
});
}
describe("extractOpenAICodexAccountId", () => {
it("decodes URL-safe base64 JWT payloads", () => {
const accessToken = createJwt({
"https://api.openai.com/auth": {
chatgpt_account_id: "w_ébé_1fzcswWN6Pi5zL",
},
});
expect(accessToken.split(".")[1]).toContain("_");
expect(extractOpenAICodexAccountId(accessToken)).toBe("w_ébé_1fzcswWN6Pi5zL");
});
it("rejects tokens without a Codex account id", () => {
expect(() => extractOpenAICodexAccountId(createJwt({}))).toThrow(
"Failed to extract accountId from token",
);
});
});
describe("streamOpenAICodexResponses transport", () => {
afterEach(() => {
closeOpenAICodexWebSocketSessions();
vi.restoreAllMocks();
vi.unstubAllGlobals();
vi.useRealTimers();
resetOpenAICodexWebSocketDebugStats();
});
const model = {
id: "gpt-5.5",
name: "GPT-5.5",
api: "openai-chatgpt-responses",
provider: "openai",
baseUrl: "https://chatgpt.test/backend-api",
reasoning: true,
input: ["text"],
cost: { input: 0, output: 0, cacheRead: 0, cacheWrite: 0 },
contextWindow: 128_000,
maxTokens: 16_000,
} satisfies Model<"openai-chatgpt-responses">;
const context = {
messages: [{ role: "user", content: "hi", timestamp: 1 }],
} satisfies Context;
it("builds the first Node request with an OS-specific user agent", async () => {
vi.resetModules();
const freshProvider = await import("./openai-chatgpt-responses.js");
let userAgent: string | null = null;
vi.stubGlobal(
"fetch",
vi.fn(async (_input, init) => {
userAgent = new Headers(init?.headers).get("user-agent");
return completedSseResponse();
}),
);
await freshProvider
.streamOpenAICodexResponses(model, context, {
apiKey: createJwt({
"https://api.openai.com/auth": { chatgpt_account_id: "acct-1" },
}),
transport: "sse",
})
.result();
expect(userAgent).toBe(`openclaw (${platform()} ${release()}; ${arch()})`);
});
it("zstd-compresses SSE bodies without overriding an existing encoding", async () => {
const captured: Array<{ body: BodyInit | null | undefined; encoding: string | null }> = [];
vi.stubGlobal(
"fetch",
vi.fn(async (_input, init) => {
captured.push({
body: init?.body,
encoding: new Headers(init?.headers).get("content-encoding"),
});
return completedSseResponse(`resp_${captured.length}`);
}),
);
const apiKey = createJwt({
"https://api.openai.com/auth": { chatgpt_account_id: "acct-1" },
});
await streamOpenAICodexResponses(model, context, { apiKey, transport: "sse" }).result();
await streamOpenAICodexResponses(model, context, {
apiKey,
transport: "sse",
headers: { "content-encoding": "identity" },
}).result();
expect(captured[0]?.encoding).toBe("zstd");
expect(captured[0]?.body).toBeInstanceOf(Uint8Array);
const decoded = JSON.parse(
Buffer.from(zstdDecompressSync(captured[0]?.body as Uint8Array)).toString("utf8"),
) as { model?: string };
expect(decoded.model).toBe(model.id);
expect(captured[1]).toMatchObject({ encoding: "identity", body: expect.any(String) });
});
it("keeps JSON request bodies for custom ChatGPT relays", async () => {
let capturedBody: BodyInit | null | undefined;
let capturedEncoding: string | null = null;
vi.stubGlobal(
"fetch",
vi.fn(async (_input, init) => {
capturedBody = init?.body;
capturedEncoding = new Headers(init?.headers).get("content-encoding");
return completedSseResponse();
}),
);
await streamOpenAICodexResponses(
{ ...model, provider: "custom-relay", baseUrl: "https://relay.test/backend-api" },
context,
{
apiKey: createJwt({
"https://api.openai.com/auth": { chatgpt_account_id: "acct-1" },
}),
transport: "sse",
},
).result();
expect(capturedEncoding).toBeNull();
expect(capturedBody).toEqual(expect.any(String));
expect(JSON.parse(capturedBody as string)).toMatchObject({ model: model.id });
});
it("reconnects once when the websocket connection limit is reached", async () => {
let connections = 0;
class ConnectionLimitWebSocket extends EventTarget {
private readonly limitReached = connections++ === 0;
constructor() {
super();
queueMicrotask(() => this.dispatchEvent(new Event("open")));
}
send(): void {
const event = this.limitReached
? { type: "error", error: { code: "websocket_connection_limit_reached" } }
: {
type: "response.completed",
response: {
id: "resp_ws",
status: "completed",
output: [],
usage: { input_tokens: 5, output_tokens: 3, total_tokens: 8 },
},
};
queueMicrotask(() => {
this.dispatchEvent(Object.assign(new Event("message"), { data: JSON.stringify(event) }));
});
}
close(): void {}
}
const fetchMock = vi.fn();
vi.stubGlobal("WebSocket", ConnectionLimitWebSocket);
vi.stubGlobal("fetch", fetchMock);
const result = await streamOpenAICodexResponses(model, context, {
apiKey: createJwt({
"https://api.openai.com/auth": { chatgpt_account_id: "acct-1" },
}),
transport: "websocket",
}).result();
expect(result.stopReason).toBe("stop");
expect(connections).toBe(2);
expect(fetchMock).not.toHaveBeenCalled();
});
it("rotates cached websockets before the backend connection age limit", async () => {
vi.useFakeTimers();
const startedAt = new Date("2026-07-03T00:00:00Z");
vi.setSystemTime(startedAt);
let connections = 0;
const sentConnectionIds: number[] = [];
class AgedWebSocket extends EventTarget {
readonly connectionId = ++connections;
readyState = 1;
constructor() {
super();
queueMicrotask(() => this.dispatchEvent(new Event("open")));
}
send(): void {
sentConnectionIds.push(this.connectionId);
queueMicrotask(() => {
this.dispatchEvent(
Object.assign(new Event("message"), {
data: JSON.stringify({
type: "response.completed",
response: {
id: `resp_${this.connectionId}`,
status: "completed",
output: [],
usage: { input_tokens: 5, output_tokens: 3, total_tokens: 8 },
},
}),
}),
);
});
}
close(): void {
this.readyState = 3;
}
}
vi.stubGlobal("WebSocket", AgedWebSocket);
const apiKey = createJwt({
"https://api.openai.com/auth": { chatgpt_account_id: "acct-1" },
});
const sessionId = "aged-session";
await streamOpenAICodexResponses(model, context, {
apiKey,
sessionId,
transport: "websocket-cached",
}).result();
vi.setSystemTime(new Date(startedAt.getTime() + 56 * 60 * 1000));
await streamOpenAICodexResponses(model, context, {
apiKey,
sessionId,
transport: "websocket-cached",
}).result();
expect(sentConnectionIds).toEqual([1, 2]);
expect(connections).toBe(2);
});
it("preserves max for GPT-5.6 simple Codex Responses requests", async () => {
let capturedPayload: Record<string, unknown> | undefined;
const stream = streamSimpleOpenAICodexResponses(
{
...model,
id: "gpt-5.6-sol",
name: "GPT-5.6 Sol",
contextWindow: 372_000,
thinkingLevelMap: { xhigh: "xhigh", max: "max" },
},
context,
{
apiKey: createJwt({
"https://api.openai.com/auth": {
chatgpt_account_id: "acct-1",
},
}),
reasoning: "max",
transport: "sse",
onPayload: (payload) => {
capturedPayload = payload as Record<string, unknown>;
throw new Error("stop after payload");
},
},
);
await stream.result();
expect(capturedPayload).toMatchObject({
reasoning: { effort: "max", summary: "auto" },
});
});
it("does not fall back to SSE when websocket transport is explicit", async () => {
const fetchMock = vi.fn(async () => {
throw new Error("fetch should not run");
});
vi.stubGlobal("fetch", fetchMock);
class FailingWebSocket {
constructor() {
throw new Error("websocket connect failed");
}
send(): void {}
close(): void {}
addEventListener(): void {}
removeEventListener(): void {}
}
vi.stubGlobal("WebSocket", FailingWebSocket);
const stream = streamOpenAICodexResponses(model, context, {
apiKey: createJwt({
"https://api.openai.com/auth": {
chatgpt_account_id: "acct-1",
},
}),
sessionId: "session-explicit-websocket",
transport: "websocket",
});
const result = await stream.result();
expect(fetchMock).not.toHaveBeenCalled();
expect(result.stopReason).toBe("error");
expect(result.errorMessage).toContain("websocket connect failed");
});
it("honors timeoutMs for explicit SSE transport requests", async () => {
stubHangingFetch(5);
const stream = streamOpenAICodexResponses(model, context, {
apiKey: createJwt({
"https://api.openai.com/auth": {
chatgpt_account_id: "acct-1",
},
}),
timeoutMs: 5,
transport: "sse",
});
const result = await stream.result();
expect(result.stopReason).toBe("error");
expect(result.errorMessage).toContain("Request timed out after 5ms");
});
it("does not replay Responses item ids for store-disabled ChatGPT requests", async () => {
let capturedPayload:
| {
store?: unknown;
input?: Array<Record<string, unknown>>;
}
| undefined;
const stream = streamOpenAICodexResponses(
model,
{
messages: [
{
role: "assistant",
api: "openai-chatgpt-responses",
provider: model.provider,
model: model.id,
usage: {
input: 0,
output: 0,
cacheRead: 0,
cacheWrite: 0,
totalTokens: 0,
cost: { input: 0, output: 0, cacheRead: 0, cacheWrite: 0, total: 0 },
},
stopReason: "toolUse",
timestamp: 1,
content: [
{
type: "thinking",
thinking: "Need a tool.",
thinkingSignature: JSON.stringify({
type: "reasoning",
id: "rs_prior",
encrypted_content: "ciphertext",
}),
},
{
type: "text",
text: "Checking.",
textSignature: JSON.stringify({
v: 1,
id: "msg_prior",
phase: "commentary",
}),
},
{
type: "toolCall",
id: "call_abc|fc_prior",
name: "lookup",
arguments: {},
},
],
},
],
},
{
apiKey: createJwt({
"https://api.openai.com/auth": {
chatgpt_account_id: "acct-1",
},
}),
transport: "sse",
onPayload: (payload) => {
capturedPayload = payload as typeof capturedPayload;
throw new Error("stop after payload");
},
},
);
const result = await stream.result();
expect(result.stopReason).toBe("error");
expect(result.errorMessage).toBe("stop after payload");
expect(capturedPayload?.store).toBe(false);
const reasoningItem = capturedPayload?.input?.find((item) => item.type === "reasoning");
expect(reasoningItem).toMatchObject({
type: "reasoning",
encrypted_content: "ciphertext",
summary: [],
});
expect(reasoningItem).not.toHaveProperty("id");
const messageItem = capturedPayload?.input?.find((item) => item.type === "message");
expect(messageItem).toMatchObject({
type: "message",
phase: "commentary",
});
expect(messageItem).not.toHaveProperty("id");
const functionCall = capturedPayload?.input?.find((item) => item.type === "function_call");
expect(functionCall).toMatchObject({
type: "function_call",
call_id: "call_abc",
});
expect(functionCall).not.toHaveProperty("id");
});
it("omits ChatGPT tool controls when every tool schema is unreadable", async () => {
let capturedPayload: Record<string, unknown> | undefined;
const stream = streamOpenAICodexResponses(
model,
{
...context,
tools: [
{
name: "broken",
description: "Broken tool.",
get parameters(): never {
throw new Error("parameters exploded");
},
},
],
},
{
apiKey: createJwt({
"https://api.openai.com/auth": {
chatgpt_account_id: "acct-1",
},
}),
transport: "sse",
onPayload: (payload) => {
capturedPayload = payload as Record<string, unknown>;
throw new Error("stop after payload");
},
},
);
const result = await stream.result();
expect(result.stopReason).toBe("error");
expect(capturedPayload).not.toHaveProperty("tools");
expect(capturedPayload).not.toHaveProperty("tool_choice");
expect(capturedPayload).not.toHaveProperty("parallel_tool_calls");
});
it("does not reread an unreadable ChatGPT tool inventory length", async () => {
let capturedPayload: Record<string, unknown> | undefined;
const tools = new Proxy([], {
get(target, property, receiver) {
if (property === "length") {
throw new Error("length exploded");
}
return Reflect.get(target, property, receiver);
},
});
const stream = streamOpenAICodexResponses(model, { ...context, tools } as never, {
apiKey: createJwt({
"https://api.openai.com/auth": {
chatgpt_account_id: "acct-1",
},
}),
transport: "sse",
onPayload: (payload) => {
capturedPayload = payload as Record<string, unknown>;
throw new Error("stop after payload");
},
});
const result = await stream.result();
expect(result.stopReason).toBe("error");
expect(capturedPayload).not.toHaveProperty("tools");
expect(capturedPayload).not.toHaveProperty("tool_choice");
expect(capturedPayload).not.toHaveProperty("parallel_tool_calls");
});
it("caps oversized timeoutMs before creating request abort signals", async () => {
stubHangingFetch(MAX_TIMER_TIMEOUT_MS);
const stream = streamOpenAICodexResponses(model, context, {
apiKey: createJwt({
"https://api.openai.com/auth": {
chatgpt_account_id: "acct-1",
},
}),
timeoutMs: Number.MAX_SAFE_INTEGER,
transport: "sse",
});
const result = await stream.result();
expect(result.stopReason).toBe("error");
expect(result.errorMessage).toContain(`Request timed out after ${MAX_TIMER_TIMEOUT_MS}ms`);
});
it("honors timeoutMs for default websocket transport requests", async () => {
stubTimeoutSignal(5);
const fetchMock = vi.fn(async () => {
throw new Error("fetch should not run before websocket timeout");
});
class HangingWebSocket {
send = vi.fn();
close = vi.fn();
addEventListener(): void {}
removeEventListener(): void {}
}
vi.stubGlobal("fetch", fetchMock);
vi.stubGlobal("WebSocket", HangingWebSocket);
const stream = streamOpenAICodexResponses(model, context, {
apiKey: createJwt({
"https://api.openai.com/auth": {
chatgpt_account_id: "acct-1",
},
}),
timeoutMs: 5,
});
const result = await stream.result();
expect(fetchMock).not.toHaveBeenCalled();
expect(result.stopReason).toBe("error");
expect(result.errorMessage).toContain("Request timed out after 5ms");
});
it("times out default websocket streams when no first event arrives", async () => {
vi.useFakeTimers();
try {
const fetchMock = vi.fn(async () => {
throw new Error("fetch should not run after websocket first-event timeout");
});
const sendMock = vi.fn();
const closeMock = vi.fn();
class OpenNoMessageWebSocket {
send = sendMock;
close = closeMock;
addEventListener(type: string, listener: (event: unknown) => void): void {
if (type === "open") {
queueMicrotask(() => listener({}));
}
}
removeEventListener(): void {}
}
vi.stubGlobal("fetch", fetchMock);
vi.stubGlobal("WebSocket", OpenNoMessageWebSocket);
const onFirstEventTimeout = vi.fn();
const stream = streamOpenAICodexResponses(model, context, {
apiKey: createJwt({
"https://api.openai.com/auth": {
chatgpt_account_id: "acct-1",
},
}),
firstEventTimeoutMs: 5,
onFirstEventTimeout,
} as Parameters<typeof streamOpenAICodexResponses>[2] & {
firstEventTimeoutMs: number;
onFirstEventTimeout: (reason: Error) => void;
});
const resultPromise = stream.result();
await Promise.resolve();
await vi.advanceTimersByTimeAsync(5);
const result = await resultPromise;
expect(fetchMock).not.toHaveBeenCalled();
expect(sendMock).toHaveBeenCalledTimes(1);
expect(closeMock).toHaveBeenCalled();
expect(result.stopReason).toBe("error");
expect(result.errorMessage).toMatch(
/responses HTTP stream opened but did not deliver a first SSE event within 5ms/,
);
expect(onFirstEventTimeout).toHaveBeenCalledWith(expect.any(Error));
} finally {
vi.useRealTimers();
}
});
it("does not send websocket payload after timeout fires during connect", async () => {
let timeoutController: AbortController | undefined;
vi.spyOn(AbortSignal, "timeout").mockImplementation((actualTimeoutMs) => {
expect(actualTimeoutMs).toBe(5);
timeoutController = new AbortController();
return timeoutController.signal;
});
const sendMock = vi.fn();
class OpeningThenTimedOutWebSocket {
send = sendMock;
close = vi.fn();
addEventListener(type: string, listener: (event: unknown) => void): void {
if (type === "open") {
queueMicrotask(() => {
listener({});
timeoutController?.abort(new DOMException("timed out", "TimeoutError"));
});
}
}
removeEventListener(): void {}
}
vi.stubGlobal("WebSocket", OpeningThenTimedOutWebSocket);
const stream = streamOpenAICodexResponses(model, context, {
apiKey: createJwt({
"https://api.openai.com/auth": {
chatgpt_account_id: "acct-1",
},
}),
timeoutMs: 5,
});
const result = await stream.result();
expect(sendMock).not.toHaveBeenCalled();
expect(result.stopReason).toBe("error");
expect(result.errorMessage).toContain("Request timed out after 5ms");
});
it("strips the internal cache boundary marker from request instructions", async () => {
let capturedPayload: { instructions?: string } | undefined;
const stream = streamOpenAICodexResponses(
model,
{
systemPrompt: `Stable${SYSTEM_PROMPT_CACHE_BOUNDARY}Dynamic`,
messages: [{ role: "user", content: "hi", timestamp: 1 }],
},
{
apiKey: createJwt({
"https://api.openai.com/auth": {
chatgpt_account_id: "acct-1",
},
}),
transport: "sse",
onPayload: (payload) => {
capturedPayload = payload as typeof capturedPayload;
throw new Error("stop after payload");
},
},
);
const result = await stream.result();
expect(result.stopReason).toBe("error");
expect(capturedPayload?.instructions).toBe("Stable\nDynamic");
expect(JSON.stringify(capturedPayload)).not.toContain("OPENCLAW_CACHE_BOUNDARY");
});
it("falls back to the default instructions when no system prompt is set", async () => {
let capturedPayload: { instructions?: string } | undefined;
const stream = streamOpenAICodexResponses(
model,
{ messages: [{ role: "user", content: "hi", timestamp: 1 }] },
{
apiKey: createJwt({
"https://api.openai.com/auth": {
chatgpt_account_id: "acct-1",
},
}),
transport: "sse",
onPayload: (payload) => {
capturedPayload = payload as typeof capturedPayload;
throw new Error("stop after payload");
},
},
);
const result = await stream.result();
expect(result.stopReason).toBe("error");
expect(capturedPayload?.instructions).toBe("You are a helpful assistant.");
});
it("prefers promptCacheKey over sessionId for request cache affinity", async () => {
let payload: unknown;
vi.stubGlobal(
"fetch",
vi.fn(async () => {
throw new Error("usage limit: stop after payload");
}),
);
const stream = streamOpenAICodexResponses(model, context, {
apiKey: createJwt({
"https://api.openai.com/auth": {
chatgpt_account_id: "acct-1",
},
}),
sessionId: "run-session",
promptCacheKey: "stable-cache-key",
transport: "sse",
onPayload: (nextPayload) => {
payload = nextPayload;
},
});
await stream.result();
expect(payload).toMatchObject({ prompt_cache_key: "stable-cache-key" });
});
it.each(["1.5", "0x10"])(
"ignores invalid Retry-After header delay values: %s",
async (retryAfter) => {
const fetchMock = vi
.fn<typeof fetch>()
.mockResolvedValueOnce(
new Response("rate limited", {
status: 429,
headers: { "retry-after": retryAfter },
}),
)
.mockRejectedValueOnce(new Error("usage limit: stop after retry delay"));
vi.stubGlobal("fetch", fetchMock);
const setTimeoutSpy = vi
.spyOn(globalThis, "setTimeout")
.mockImplementation((callback: TimerHandler) => {
if (typeof callback === "function") {
callback();
}
return 0 as unknown as ReturnType<typeof setTimeout>;
});
const stream = streamOpenAICodexResponses(model, context, {
apiKey: createJwt({
"https://api.openai.com/auth": {
chatgpt_account_id: "acct-1",
},
}),
transport: "sse",
});
const result = await stream.result();
expect(result.stopReason).toBe("error");
expect(fetchMock).toHaveBeenCalledTimes(2);
expect(setTimeoutSpy).toHaveBeenCalledWith(expect.any(Function), 1000);
},
);
it("caps oversized Retry-After delays before sleeping", async () => {
const fetchMock = vi
.fn<typeof fetch>()
.mockResolvedValueOnce(
new Response("rate limited", {
status: 429,
headers: { "retry-after": String(Number.MAX_SAFE_INTEGER) },
}),
)
.mockRejectedValueOnce(new Error("usage limit: stop after retry delay"));
vi.stubGlobal("fetch", fetchMock);
const setTimeoutSpy = vi
.spyOn(globalThis, "setTimeout")
.mockImplementation((callback: TimerHandler) => {
if (typeof callback === "function") {
callback();
}
return 0 as unknown as ReturnType<typeof setTimeout>;
});
const stream = streamOpenAICodexResponses(model, context, {
apiKey: createJwt({
"https://api.openai.com/auth": {
chatgpt_account_id: "acct-1",
},
}),
transport: "sse",
});
const result = await stream.result();
expect(result.stopReason).toBe("error");
expect(fetchMock).toHaveBeenCalledTimes(2);
expect(setTimeoutSpy).toHaveBeenCalledWith(expect.any(Function), MAX_TIMER_TIMEOUT_MS);
});
it("bounds non-OK ChatGPT response bodies before formatting API errors", async () => {
const chunkSize = 1024 * 1024;
const totalChunks = 32;
const chunk = new TextEncoder()
.encode("usage limit ".repeat(Math.ceil(chunkSize / "usage limit ".length)))
.subarray(0, chunkSize);
let pullCount = 0;
let canceled = false;
const overflowing = new ReadableStream<Uint8Array>({
pull(controller) {
pullCount += 1;
if (pullCount > totalChunks) {
controller.close();
return;
}
controller.enqueue(chunk);
},
cancel() {
canceled = true;
},
});
const fetchMock = vi.fn<typeof fetch>().mockResolvedValueOnce(
new Response(overflowing, {
status: 400,
statusText: "Bad Request",
}),
);
vi.stubGlobal("fetch", fetchMock);
const stream = streamOpenAICodexResponses(model, context, {
apiKey: createJwt({
"https://api.openai.com/auth": {
chatgpt_account_id: "acct-1",
},
}),
transport: "sse",
});
const result = await stream.result();
expect(result.stopReason).toBe("error");
expect(result.errorMessage).toContain("usage limit");
expect(result.errorMessage?.length).toBeLessThanOrEqual(16 * 1024);
expect(canceled).toBe(true);
expect(pullCount).toBeGreaterThanOrEqual(1);
expect(pullCount).toBeLessThanOrEqual(3);
expect(fetchMock).toHaveBeenCalledTimes(1);
});
});
describe("parseSSEForTest", () => {
it("bounds streamed OpenAI ChatGPT Responses success bodies without content-length", async () => {
// 1 MiB chunks; cap is 16 MiB so the bounded reader cancels well before
// draining the full 32 MiB advertised body.
const CHUNK = 1024 * 1024;
const TOTAL = 32;
let pullCount = 0;
let cancelReason: unknown;
const overflowing = new ReadableStream<Uint8Array>({
pull(controller) {
pullCount += 1;
if (pullCount > TOTAL) {
controller.close();
return;
}
controller.enqueue(new Uint8Array(CHUNK));
},
cancel(reason) {
cancelReason = reason;
},
});
let caught: Error | null = null;
try {
// parseSSE expects a Response-like; pass the streaming body directly
// through a minimal Response shim that only exposes .body.
const response = { body: overflowing } as unknown as Response;
for await (const event of parseSSEForTest(response)) {
expect(event).toBeDefined();
}
} catch (err) {
caught = err as Error;
}
expect(caught?.message).toMatch(
/OpenAI ChatGPT Responses success body exceeded 16777216 bytes/,
);
expect(cancelReason).toBeInstanceOf(Error);
// 16 MiB + a couple of overshoot pulls, well under 32.
expect(pullCount).toBeGreaterThanOrEqual(17);
expect(pullCount).toBeLessThanOrEqual(20);
});
});