UNPKG

@bitkyc08/opencodex

Version:

Universal provider proxy for OpenAI Codex & Claude Code — use any LLM with Codex CLI/App/SDK and Claude Code

384 lines (356 loc) • 19.6 kB
import { MAX_CLIENT_SSE_FRAME_BYTES } from "../sse-frame-buffer"; import { markResponseNonReplayable, UPSTREAM_CLOSED_BEFORE_RESPONSE_CODE, UPSTREAM_NO_RESPONSE_CODE, } from "../../lib/upstream-retry"; import type { RequestFailureCause, RequestFailureStage } from "../../lib/request-failure-model"; import { packageVersion } from "../../lib/package-version"; // If the 101 never arrives (network black hole), give SSE a chance well before // the caller's connect timeout (default 200s) would fire. export const UPGRADE_DEADLINE_MS = 10_000; // Liveness while the exchange waits for its first response event. The proxy cannot know // how long the origin legitimately needs before `response.created` (a multi-image replay // spends that time in prefill; #4083 measured 30 s), and it is not the party that owns // the slowness policy — the client holds its own deadline and the operator holds // `connectTimeoutMs`. What the proxy can decide is whether the peer is still there, and // WebSocket has a native answer: ping. While waiting, the exchange pings every // CODEX_WS_LIVENESS_PING_INTERVAL_MS on sockets that expose `ping()`; any inbound frame // or pong resets the silence clock, and only CODEX_WS_RESPONSE_PRELUDE_TIMEOUT_MS of // nothing at all settles the exchange as an origin-silence 504. A peer that never pongs // keeps exactly the previous 90 s bound; a peer that does can never trip it while alive. export const CODEX_WS_LIVENESS_PING_INTERVAL_MS = 15_000; export const CODEX_WS_RESPONSE_PRELUDE_TIMEOUT_MS = 90_000; // Keep the push-based WS transport inside the same memory envelope as the // bounded SSE relays that consume this response. Unlike fetch response bodies, // a WebSocket cannot be paused when a ReadableStream applies backpressure, so // an upstream that outruns the consumer must be disconnected. export const MAX_CODEX_WS_FRAME_BYTES = MAX_CLIENT_SSE_FRAME_BYTES; export const MAX_CODEX_WS_QUEUE_BYTES = 8 * 1024 * 1024; // The backend drops any inbound message of 16 MiB or more: it closes the socket // (1009) without a Responses terminal event, which reaches clients as a bare // 502 upstream_server_error. Measured against the live endpoint 2026-08-23: // 16,777,000 B completed, 16,777,300 B closed in ~1s, every time. The same // request body succeeds over HTTP SSE, so the ceiling belongs to this transport // alone (see #2426). A full-replay thread reaches it with ~11 pasted // screenshots, and then never recovers, because each retry resends the frame. export const MAX_CODEX_WS_CREATE_FRAME_BYTES = 16 * 1024 * 1024; // Bun frames the payload it is handed, so the send-side budget is the JSON text // itself, and nothing is appended between the check and the send. The margin is // a conservative cushion, not a computed requirement: it covers RFC 6455 frame // overhead in case the backend counts it (14 bytes at this payload size — an // 8-byte extended length plus a 4-byte client mask, leaving ~65.5 KiB spare), // and it leaves room for a future caller that appends to the frame. const CODEX_WS_CREATE_FRAME_MARGIN_BYTES = 64 * 1024; export const CODEX_WS_CREATE_FRAME_LIMIT_BYTES = MAX_CODEX_WS_CREATE_FRAME_BYTES - CODEX_WS_CREATE_FRAME_MARGIN_BYTES; /** Close code the backend uses for an oversized message (RFC 6455 "message too big"). */ const WS_CLOSE_MESSAGE_TOO_BIG = 1009; const codexWsUpstreamResponses = new WeakSet<Response>(); const quotaObservedResponses = new WeakSet<Response>(); /** Quota arrived directly at its captured account; do not replay old HTTP prelude headers. */ export function isCodexWsQuotaObservedResponse(response: Response): boolean { return quotaObservedResponses.has(response); } /** True only for a successful Codex WebSocket upgrade, never an HTTP fallback. */ export function isCodexWsUpstreamResponse(response: Response): boolean { return codexWsUpstreamResponses.has(response); } export function markCodexWsResponse(response: Response, observed: boolean): void { codexWsUpstreamResponses.add(response); if (observed) quotaObservedResponses.add(response); } /** * The proxy's own version, stamped onto every stage record so a field report * can be tied to the exact build that produced it (#4191). Computed locally * with the same package.json IIFE management-api.ts / gui-static.ts use — * importing management-api from the transport layer would invert the * layering and pull the management surface into every WS exchange. */ const OCX_VERSION = packageVersion("0.0.0"); /** * The durable form of the stage counters, carried out of the exchange on the * resolved Response so the logging layer can persist it without the exchange * ever seeing a RequestLogContext (#4191). * * Everything here is a size, a count, a duration, a boolean, or a semver * string: no request body, no header, no account identifier, no conversation * text, and no close-reason text can reach a record built by the exchange. * `requestBytes` is null on a committed success because the happy path never * pays the UTF-8 walk of a megabyte replay frame; it is measured on failure, * where its size is the evidence. */ export type CodexWsStageRecord = Omit<CodexWsFailureStage, "requestBytes"> & { /** UTF-8 size of the create frame; null on the committed-success record. */ requestBytes: number | null; /** Numeric upstream close code when the socket closed; null otherwise. */ closeCode: number | null; /** True when the exchange ran on a pooled, previously used session. */ reused: boolean; /** OpenCodex version that produced this record. */ ocxVersion: string; /** Bun runtime version the exchange gated on. */ bunVersion: string; }; const codexWsStageByResponse = new WeakMap<Response, CodexWsStageRecord>(); export function markCodexWsStage(response: Response, record: CodexWsStageRecord): void { const current = codexWsStageByResponse.get(response); if (current) { Object.assign(current, record); return; } codexWsStageByResponse.set(response, record); } export function readCodexWsStage(response: Response): CodexWsStageRecord | undefined { return codexWsStageByResponse.get(response); } export function codexWsOcxVersion(): string { return OCX_VERSION; } /** * The honest settlement for an exchange that sent its create frame and never saw a * response event. * * Before this existed the relay committed a 200 SSE Response and errored its body, on the * reasoning that a 5xx could make the pre-stream retry wrapper resend the frame. That * reasoning was right about the resend and wrong about the status: it turned "no response" * into "a response that failed", removed the code a user agent uses for its own retry * policy, and neutered the client's first-byte timeout with chunked headers. The client * on the direct path receives a gateway status in this situation and retries under its own * policy; this response restores that equivalence. The resend is forbidden by the * non-replayable marker instead (see upstream-retry.ts), and the structured code lets the * combo failover reach the same verdict after it re-parses the body. * * 504 is the origin's silence (nothing at all, or nothing but liveness, for the tolerated * window); 502 is a transport that closed or misbehaved after the send. Both carry the * content-free stage detail in the message and the metadata snapshot in the headers, the * same way a refused create does, so quota captured during the prelude is not lost. */ export function codexWsPreResponseFailure(status: 502 | 504, message: string, prelude: Headers): Response { const headers = new Headers(prelude); headers.set("content-type", "application/json"); headers.set("cache-control", "no-store"); const code = status === 504 ? UPSTREAM_NO_RESPONSE_CODE : UPSTREAM_CLOSED_BEFORE_RESPONSE_CODE; const response = new Response(JSON.stringify({ error: { type: "upstream_error", code, message } }), { status, headers }); markResponseNonReplayable(response); return response; } const CLOSED_BEFORE_TERMINAL = "codex websocket closed before a Responses terminal event"; /** * Content-free stage record for an exchange that ended without a Responses * terminal event (#4191). * * The field report that drove this could not be told apart from a network * outage, because every such failure reached the user as one of two bare * sentences. Both are true of a socket that was never answered, a socket that * carried only quota control frames, and a socket that died mid-response — * three different upstream stories with three different owners. These counters * are the smallest set that separates them, and every one of them is a size, a * count, or a duration: no request body, no header, no account identifier, and * no conversation text can reach a message built from this record. */ export type CodexWsFailureStage = { /** UTF-8 size of the `response.create` frame this exchange dialled with. */ requestBytes: number; /** True once `ws.send()` returned, so the turn may be executing upstream. */ sent: boolean; /** Frames the socket delivered, of any kind, including ones that did not parse. */ upstreamFrames: number; /** Frames the metadata channel claimed (quota, response metadata). */ controlFrames: number; /** Responses events actually written to the downstream SSE body. */ relayedEvents: number; /** Milliseconds from send to the first upstream frame; null when none arrived. */ firstFrameMs: number | null; /** * Milliseconds from send to the first non-control Responses event (a * `response.*` or `error` frame the relay would hand downstream); null when * none arrived. `firstFrameMs` alone cannot separate "the peer answered with * quota metadata and went quiet" from "the peer was still working": the * first measures any frame, this one measures the turn's own start (#4191). */ firstResponseMs: number | null; /** Milliseconds from send to this failure; null when the failure predates the send. */ elapsedMs: number | null; /** Liveness pings the exchange sent while waiting for the first response event. */ pings: number; /** Pongs the peer answered with; zero on a peer that never answers pings. */ pongs: number; }; /** * Which upstream story the counters tell. Ordered by how much the upstream had * committed to, because that is what decides who owns the failure — and, for a * future maintainer reading #4191, it is deliberately NOT a fallback-eligibility * signal. `no-upstream-frame` does not mean the frame was not accepted; the * no-replay-after-send contract in `codex-ws-exchange.ts` stands regardless of * what this classifier says. */ export type CodexWsFailureCause = | "before-send" | "no-upstream-frame" | "no-response-event" | "after-response-started"; export function classifyCodexWsFailure(stage: CodexWsFailureStage): CodexWsFailureCause { if (!stage.sent) return "before-send"; if (stage.relayedEvents > 0) return "after-response-started"; if (stage.upstreamFrames === 0) return "no-upstream-frame"; return "no-response-event"; } /** * The same four outcomes said in the shared stage-and-cause vocabulary (#4191). * * A projection, not a second classifier: {@link classifyCodexWsFailure} stays the one place that * reads the counters, and this only restates its answer in the words the durable log, the metrics * projection and the HTTP path already use. Without it the WebSocket transport is the one surface * whose failures cannot be compared with anything else, which is the reported symptom -- every * such failure reached the user as one of two bare sentences. * * It does not relax the transport's own rule. The stage below reports where the exchange got to, * and `resendPermission` agrees that everything past `before-send` is refused. When a socket dies * under the send, this stage is what the resend gate is asked with (#4191), so the operator's * `retryOnReset` grant is the only way past that refusal, as it is for an HTTP reset. */ export const CODEX_WS_FAILURE_PROJECTION = { /** The create frame never left, so the origin provably never saw this turn. */ "before-send": { stage: "pre-header", cause: "transport-unsent" }, /** The frame left and the socket said nothing at all. The turn may be running upstream. */ "no-upstream-frame": { stage: "pre-header", cause: "transport-ambiguous" }, /** Control frames only: the peer is alive and answered, but no Responses event arrived. */ "no-response-event": { stage: "protocol-prelude", cause: "transport-ambiguous" }, /** Events already reached the caller, so a resend would duplicate output they have seen. */ "after-response-started": { stage: "semantic-output", cause: "transport-ambiguous" }, } as const satisfies Record<CodexWsFailureCause, { stage: RequestFailureStage; cause: RequestFailureCause }>; export function projectCodexWsFailure( stage: CodexWsFailureStage, ): { stage: RequestFailureStage; cause: RequestFailureCause } { return CODEX_WS_FAILURE_PROJECTION[classifyCodexWsFailure(stage)]; } const socketDeathStages = new WeakMap<Response, RequestFailureStage>(); /** * Record that a pre-response settle came from the socket closing or failing under the send (#4191), * rather than from silence, a refused frame or a local limit. * * A fact about how the exchange ended, not a grant. The settle is the same non-replayable 502 * either way; whether the turn may go out once more is the resend gate's question, and only the * operator's `retryOnReset` grant can answer it yes. */ export function markCodexWsSocketDeath(response: Response, stage: CodexWsFailureStage): void { socketDeathStages.set(response, projectCodexWsFailure(stage).stage); } /** * Where the send stood when its socket died: `pre-header` when nothing came back and * `protocol-prelude` when frames arrived but none was a Responses event. Undefined for every other * response. */ export function codexWsSocketDeathStage(response: Response): RequestFailureStage | undefined { return socketDeathStages.get(response); } /** * Render the stage as a suffix appended to an existing failure message. * * It is a suffix, not an interpolation, on purpose: the close-code tail these * messages already carry is matched as a contiguous substring by the callers * and tests that read it, so nothing may be inserted ahead of it. */ export function codexWsFailureDetail(stage: CodexWsFailureStage): string { const duration = (value: number | null): string => (value === null ? "n/a" : `${value}ms`); return ` [cause=${classifyCodexWsFailure(stage)} request=${stage.requestBytes}B` + ` sent=${stage.sent ? "yes" : "no"} frames=${stage.upstreamFrames}` + ` control=${stage.controlFrames} relayed=${stage.relayedEvents}` + ` first-frame=${duration(stage.firstFrameMs)} first-response=${duration(stage.firstResponseMs)}` + ` elapsed=${duration(stage.elapsedMs)}` + ` pings=${stage.pings} pongs=${stage.pongs}]`; } export type ResponsesWsRelayEvent = { type: string; text: string; payload: Record<string, unknown>; }; /** * Responses WebSocket uses `response.done` as its terminal event, while the * SSE Responses surface uses status-specific terminal events. Normalize the * WS-only discriminator before relaying so the existing SSE consumers can * settle the turn and the socket close cannot be mistaken for a drop. Unknown * or missing status values fail closed instead of being reported as success. */ export function normalizeResponsesWsRelayEvent(text: string): ResponsesWsRelayEvent | null { let payload: unknown; try { payload = JSON.parse(text); } catch { return null; } if (!payload || typeof payload !== "object" || Array.isArray(payload)) return null; const record = payload as Record<string, unknown>; if (typeof record.type !== "string") return null; // A native error may be pretty-printed JSON. SSE prefixes one data line; // embedded physical newlines would otherwise truncate the JSON for readers. if (record.type !== "response.done") return { type: record.type, text: /[\r\n]/.test(text) ? JSON.stringify(record) : text, payload: record, }; const response = record.response; const status = response && typeof response === "object" && !Array.isArray(response) ? (response as Record<string, unknown>).status : undefined; const type = status === "completed" ? "response.completed" : status === "failed" ? "response.failed" : status === "incomplete" || status === "cancelled" ? "response.incomplete" : "response.failed"; const normalizedRecord: Record<string, unknown> = { ...record, type }; if (type === "response.failed" && status !== "failed") { normalizedRecord.response = response && typeof response === "object" && !Array.isArray(response) ? { ...(response as Record<string, unknown>), status: "failed" } : { status: "failed" }; } return { type, text: JSON.stringify(normalizedRecord), payload: normalizedRecord }; } /** * The close code is the only thing that separates "the backend refused this * payload" from "the network dropped", and both used to reach the caller as the * same bare 502. Naming the oversized case here puts that distinction in the * message the client receives. * * It does NOT reach the request log as a typed code. The eager relay turns any * stream error into a generic `upstream_reset` synthetic terminal * (`relay.ts`, `relay-eager.ts`) without feeding that frame back through the * inspector, so `/api/logs` keeps neither this message nor a specific code — * only `streamAborted`. Machine-readable typing would mean changing the error * taxonomy, which is deliberately out of scope for this transport fix. * * When a stage is supplied its detail is appended last, after the close-code * tail, so the code and reason stay one contiguous substring. */ export function closedBeforeTerminalMessage(event: unknown, stage?: CodexWsFailureStage): string { const detail = event as { code?: unknown; reason?: unknown } | null | undefined; const code = typeof detail?.code === "number" ? detail.code : null; const reason = typeof detail?.reason === "string" ? detail.reason.trim() : ""; const stageDetail = stage ? codexWsFailureDetail(stage) : ""; if (code === null) return `${CLOSED_BEFORE_TERMINAL}${stageDetail}`; const suffix = reason ? ` ${code} ${reason}` : ` ${code}`; if (code === WS_CLOSE_MESSAGE_TOO_BIG) { return `codex websocket rejected the request frame as too large (close${suffix});` + ` requests at or above ${MAX_CODEX_WS_CREATE_FRAME_BYTES} bytes must use the HTTP SSE transport` + stageDetail; } return `${CLOSED_BEFORE_TERMINAL} (close${suffix})${stageDetail}`; } /** * True when the `response.create` frame is at or above the backend's inbound * message ceiling, so this turn must take the HTTP SSE path instead. * * Sizing a 16 MiB string should not cost a 16 MiB copy. UTF-8 never encodes * below one byte per UTF-16 code unit and never above three, so both tails are * settled from the string length alone; only the narrow band between them pays * for a real byte count, and `Buffer.byteLength` measures without allocating. */ export function codexWsCreateFrameExceedsLimit( frameText: string, limitBytes: number = CODEX_WS_CREATE_FRAME_LIMIT_BYTES, ): boolean { if (frameText.length >= limitBytes) return true; if (frameText.length * 3 < limitBytes) return false; return Buffer.byteLength(frameText, "utf8") >= limitBytes; }