File size: 20,556 Bytes
67d18ac | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 | /**
* POST /v1/responses request handler.
*
* Pipeline:
* 1. Parse body + credential.
* 2. Resolve `previous_response_id` via `ResponseStore` (prepend stored history).
* 3. Translate Responses β Chat Completions (`responsesToChatCompletions`):
* - function / custom / namespace / tool_search tools β Chat tools.
* - web_search / web_search_preview / file_search / code_interpreter /
* computer_use / image_generation / mcp β stripped silently.
* 4. Apply the standard body transform (stream_options, user_id, start-plan system).
* 5. POST to the GLM Chat Completions upstream (reuse `buildUpstreamRequest`).
* 6. Translate the Chat response β Responses (`chatCompletionsToResponses`
* or `chatChunkToResponsesEvents` for streaming).
* 7. Store the new response under its id (unless `store:false`).
*
* State management: in-memory only (process restart clears the store); see
* `responses/store.ts`.
*/
import { transformRequestBody } from "./body-transformer.js";
import { getProvider } from "../provider/providers.js";
import type { ProxyConfig } from "../config/types.js";
import type { AuthManager } from "../auth/manager.js";
import { buildUpstreamRequest, buildUpstreamHeaderPairs, type UpstreamHeaderPair } from "./upstream.js";
import { isCaptchaChallenged, retryOnCaptchaChallenge } from "./captcha-retry.js";
import { dispatchWithConnectRetry } from "./handler.js";
import type * as CaptchaExports from "./captcha.js";
// Lazy, runtime-gated module load (exception to the static-import rule, same
// as handler.ts): pulling captcha.ts eagerly drags in the happy-dom solver, so
// only start-plan β the one plan whose upstream is captcha-gated β pays for it.
type CaptchaModule = typeof CaptchaExports;
let captchaModule: CaptchaModule | null = null;
async function loadCaptcha(): Promise<CaptchaModule> {
if (!captchaModule) captchaModule = await import("./captcha.js");
return captchaModule;
}
import { getDefaultEndpointRouting, type EndpointRoutingService } from "./endpoint-routing.js";
import { getDefaultClientSigning, sendWithClientSigning, type ClientSigningManager } from "./client-signing.js";
import { credentialString } from "../auth/types.js";
import { translateRequestOpenAIToAnthropic, translateResponseAnthropicToOpenAI } from "../translator/openai-to-anthropic.js";
import { anthropicSseToOpenaiSse } from "../translator/sse-translator.js";
import type { AnthropicMessagesRequest, AnthropicMessagesResponse } from "../translator/types.js";
import type { ProviderDef } from "../provider/types.js";
import {
responsesToChatCompletions,
ToolTranslationError,
} from "../translator/responses-to-chat.js";
import {
chatCompletionsToResponses,
chatChunkToResponsesEvents,
finalizeResponsesStream,
newResponsesStreamState,
responsesEventToSse,
} from "../translator/chat-to-responses.js";
import {
generateResponsesId,
type ResponsesInputItem,
type ResponsesRequest,
type ResponsesResponse,
type ResponsesStreamEvent,
type ResponsesOutputItem,
} from "../translator/responses-types.js";
import { ResponseStore, type StoredResponse } from "../responses/store.js";
import { errorResponse, readBody, InflatedBodyTooLargeError } from "./handler.js";
export interface ResponsesHandlerOptions {
config: ProxyConfig;
auth: AuthManager;
/** Response store; if absent, `previous_response_id` always 404s. */
responseStore?: ResponseStore;
/** DI seam for tests. */
fetchImpl?: typeof fetch;
/** Verbose per-request diagnostics. */
debug?: boolean;
/** Override the process-wide endpoint routing service (for testing). `null` disables. */
endpointRouting?: EndpointRoutingService | null;
/** Override the process-wide client signing manager (for testing). `null` disables. */
clientSigning?: ClientSigningManager | null;
/** Override the lazily-imported captcha module (for testing). */
captcha?: CaptchaModule;
}
/** Handle POST /v1/responses. */
export async function handleResponses(
clientReq: Request,
opts: ResponsesHandlerOptions,
): Promise<Response> {
const fetchImpl = opts.fetchImpl ?? fetch;
const debug = opts.debug === true;
const start = Date.now();
// ββ 1. parse body ββ
let rawBody: string;
try {
rawBody = (await readBody(clientReq)) ?? "";
} catch (err) {
if (err instanceof InflatedBodyTooLargeError) {
return errorResponse(413, "request_too_large", err.message);
}
return errorResponse(400, "invalid_request", `could not read request body: ${(err as Error).message}`);
}
let req: ResponsesRequest;
try {
req = JSON.parse(rawBody) as ResponsesRequest;
} catch (err) {
return errorResponse(400, "invalid_request", `request body is not valid JSON: ${(err as Error).message}`);
}
if (typeof req.input !== "string" && !Array.isArray(req.input)) {
return errorResponse(400, "invalid_request", "`input` must be a string or an array");
}
if (typeof req.model !== "string" || req.model.length === 0) {
return errorResponse(400, "invalid_request", "`model` is required");
}
const stream = req.stream === true;
// ββ 2. resolve previous_response_id ββ
let historyItems: ResponsesInputItem[] = [];
let prevId: string | undefined;
if (typeof req.previous_response_id === "string" && req.previous_response_id.length > 0) {
if (!opts.responseStore) {
return errorResponse(404, "response_store_disabled", "`previous_response_id` was supplied but the response store is not configured");
}
const prev = opts.responseStore.get(req.previous_response_id);
if (!prev) {
return errorResponse(404, "response_not_found", `previous_response_id ${req.previous_response_id} not found (response store is in-memory; entries are lost on restart and after the TTL)`);
}
prevId = req.previous_response_id;
historyItems = [...prev.input, ...outputItemsAsInputItems(prev.output)];
}
// ββ 3. translate Responses β Chat Completions ββ
const input: ResponsesInputItem[] = typeof req.input === "string"
? [...historyItems, { type: "message", role: "user", content: req.input }]
: [...historyItems, ...req.input];
const reqWithHistory: ResponsesRequest = {
...req,
input,
};
let translated;
try {
translated = responsesToChatCompletions(reqWithHistory);
} catch (err) {
if (err instanceof ToolTranslationError) {
return errorResponse(400, "tool_translation_error", err.message);
}
throw err;
}
const { chatRequest, customToolNames, namespaceMap, hasToolSearch } = translated;
// ββ 4. credential + provider ββ
let cred;
try {
cred = await opts.auth.getCredential();
} catch (err) {
return errorResponse(503, "credential_unavailable", (err as Error).message);
}
const providerDef = resolveProviderDef(opts.config);
// ββ 5. body transform (start-plan system / anthropic cache_control + user_id) ββ
// Both plans post Anthropic upstream (mirrors handler.ts): the start-plan
// OpenAI gateway was retired server-side (404 as of 2026-08-28), so the
// Responses β Chat β Anthropic translator chain runs unconditionally.
const startPlan = opts.config.plan === "start-plan";
const upstreamFormat: "openai" | "anthropic" = "anthropic";
let upstreamRequestBody: string;
{
let anthropicReq: AnthropicMessagesRequest;
try {
anthropicReq = translateRequestOpenAIToAnthropic(chatRequest);
} catch (err) {
return errorResponse(400, "translation_failed", `ChatβAnthropic translation failed: ${(err as Error).message}`);
}
// userId gating mirrors handler.ts: coding-plan injects the OAuth userId,
// start-plan omits it (internal consistency; the bundle is presence-gated
// with no plan concept β whether start-plan should carry it is not
// determinable from _reverse, kept aligned with the sibling path).
upstreamRequestBody = transformRequestBody(JSON.stringify(anthropicReq), {
format: "anthropic",
userId: startPlan ? undefined : cred.userId,
startPlan,
}) ?? JSON.stringify(anthropicReq);
}
const transformedBody = upstreamRequestBody;
// ββ 6. POST upstream ββ
// start-plan gates every upstream call behind an Aliyun captcha token. The
// Anthropic/OpenAI routes mint one in handler.ts; /v1/responses did not, so
// start-plan users got {"code":3007,"msg":"captcha verify failed"} surfaced
// as HTTP 400 upstream_error on every request.
let captchaHeaders: Record<string, string> | undefined;
if (startPlan) {
try {
const captcha = opts.captcha ?? (await loadCaptcha());
const token = await captcha.getCaptchaToken(opts.config.identity.appVersion);
captchaHeaders = { [captcha.RETRY_HEADERS.PARAM]: token.verifyParam, [captcha.RETRY_HEADERS.REGION]: token.region };
} catch {
// Fall through: the 3007 retry below solves on demand.
}
}
const upstreamHeaders = buildUpstreamHeaderPairs(clientReq, upstreamFormat, cred, opts.config.identity, opts.config.plan, captchaHeaders, undefined);
const upstreamReq = buildUpstreamRequest(clientReq, upstreamFormat, providerDef, cred, transformedBody, opts.config.identity, opts.config.plan, captchaHeaders, undefined);
if (debug) console.log(`[responses] β POST ${upstreamReq.url}`);
const routing = opts.endpointRouting !== undefined ? opts.endpointRouting : getDefaultEndpointRouting(opts.config);
const signer = opts.clientSigning !== undefined ? opts.clientSigning : getDefaultClientSigning(opts.config);
const dispatch = async (pairs: UpstreamHeaderPair[]): Promise<Response> => {
const routed = routing ? await routing.resolve(upstreamReq.url, credentialString(cred)) : null;
const sendUrl = routed?.routed ? routed.url : upstreamReq.url;
if (debug && routed?.routed) console.log(`[responses] endpoint routing: ${upstreamReq.url} -> ${sendUrl}`);
// signing decisions run against the PRE-routing provider URL (mirrors the
// client, whose signer wraps the routing transport)
return sendWithClientSigning(signer, {
url: upstreamReq.url,
headerPairs: pairs,
credential: credentialString(cred),
appVersion: opts.config.identity.appVersion,
debug: debug ? (message) => console.log(`[responses] ${message}`) : undefined,
send: (finalPairs) => {
const req = new Request(sendUrl, {
method: "POST",
headers: Object.fromEntries(finalPairs),
body: transformedBody ?? undefined,
});
return fetchImpl(req, { method: "POST", headers: Object.fromEntries(finalPairs), body: transformedBody ?? undefined, signal: clientReq.signal });
},
});
};
let upstreamResp: Response;
try {
// Connect-retry ladder mirrors the chat hot path (handler.ts): 3 attempts,
// fresh Request per dispatch (built inside `dispatch`), 500msΓattempt
// backoff, no retry once the client aborted.
upstreamResp = await dispatchWithConnectRetry(() => dispatch(upstreamHeaders), {
isAborted: () => clientReq.signal.aborted,
});
} catch (err) {
return errorResponse(502, "upstream_unreachable", (err as Error).message);
}
// Captcha challenge retry (mirrors handler.ts via the shared captcha-retry
// seam): the gateway signals it either through the captcha response header
// or as HTTP 400 with {"code":3007} in the body. The challenged token is
// already spent, so retry once with a fresh pooled one.
if (startPlan && !upstreamResp.ok) {
const captcha = opts.captcha ?? (await loadCaptcha());
if (await isCaptchaChallenged(upstreamResp, captcha)) {
if (debug) console.log("[responses] captcha challenge β re-solving and retrying once");
const outcome = await retryOnCaptchaChallenge({
captcha,
appVersion: opts.config.identity.appVersion,
challengedResp: upstreamResp,
debug: debug ? (message) => console.log(`[responses] ${message}`) : undefined,
solveAndRetry: (retryHeaders) => dispatch(
buildUpstreamHeaderPairs(clientReq, upstreamFormat, cred, opts.config.identity, opts.config.plan, retryHeaders, undefined),
),
mapError: (err, phase) =>
phase === "solver"
? errorResponse(503, "captcha_solver_failed", err.message)
: errorResponse(502, "upstream_unreachable", err.message),
});
if (!outcome.ok) return outcome.resp;
upstreamResp = outcome.resp;
}
}
if (!upstreamResp.ok) {
const errText = await upstreamResp.text().catch(() => "");
return errorResponse(upstreamResp.status, "upstream_error", errText.slice(0, 500) || `upstream returned ${upstreamResp.status}`);
}
if (upstreamFormat === "anthropic") {
// normalize the Anthropic upstream response into the OpenAI Chat shape the
// downstream Responses translators already consume (SSE + batch)
if (stream) {
if (!upstreamResp.body) {
return errorResponse(502, "translation_failed", "upstream returned no body for stream");
}
upstreamResp = new Response(anthropicSseToOpenaiSse(upstreamResp.body, req.model), {
status: upstreamResp.status,
headers: { "content-type": "text/event-stream" },
});
} else {
const rawAnthropic = await upstreamResp.text();
let parsedAnthropic: AnthropicMessagesResponse;
try {
parsedAnthropic = JSON.parse(rawAnthropic) as AnthropicMessagesResponse;
} catch (err) {
return errorResponse(502, "translation_failed", `upstream returned non-JSON body: ${(err as Error).message}`);
}
const openaiResp = translateResponseAnthropicToOpenAI(parsedAnthropic, req.model);
upstreamResp = new Response(JSON.stringify(openaiResp), {
status: upstreamResp.status,
headers: { "content-type": "application/json" },
});
}
}
// ββ 8. translate Chat β Responses ββ
const responseId = generateResponsesId();
const meta = { customToolNames, namespaceMap, hasToolSearch };
if (stream) {
return streamResponse(upstreamResp, { responseId, model: req.model, meta, request: req, input, options: opts });
}
const rawChatResp = await upstreamResp.text();
let chatRespJson;
try {
chatRespJson = JSON.parse(rawChatResp);
} catch (err) {
return errorResponse(502, "translation_failed", `upstream returned non-JSON body: ${(err as Error).message}`);
}
const responsesResp = chatCompletionsToResponses(chatRespJson, req.model, {
responseId,
meta,
...(typeof req.instructions === "string" ? { instructions: req.instructions } : {}),
...(prevId ? { previousResponseId: prevId } : {}),
});
// ββ 9. store the response (unless `store:false`) ββ
if (req.store !== false && opts.responseStore) {
const stored = buildStoredResponse(responsesResp, input, req.instructions);
opts.responseStore.set(stored);
}
if (debug) console.log(`[responses] β ${responsesResp.status} (${Date.now() - start}ms)`);
return new Response(JSON.stringify(responsesResp), {
status: 200,
headers: { "content-type": "application/json" },
});
}
// βββββββββββββββββββββββββββββββββββββββββββββ
// Streaming response
// βββββββββββββββββββββββββββββββββββββββββββββ
interface StreamResponseContext {
responseId: string;
model: string;
meta: { customToolNames: Set<string>; namespaceMap: Map<string, { namespace: string; name: string }>; hasToolSearch: boolean };
request: ResponsesRequest;
input: ResponsesInputItem[];
options: ResponsesHandlerOptions;
}
function streamResponse(upstreamResp: Response, context: StreamResponseContext): Response {
if (!upstreamResp.body) {
return errorResponse(502, "translation_failed", "upstream returned no body for stream");
}
const state = newResponsesStreamState(context.model, { meta: context.meta, responseId: context.responseId });
const stream = new ReadableStream<Uint8Array>({
async start(controller) {
const encoder = new TextEncoder();
const send = (evt: ResponsesStreamEvent) => controller.enqueue(encoder.encode(responsesEventToSse(evt)));
try {
const reader = upstreamResp.body!.getReader();
const decoder = new TextDecoder();
let buffer = "";
let errored = false;
for (;;) {
if (errored) break;
const { done, value } = await reader.read();
if (done) break;
buffer += decoder.decode(value, { stream: true });
// SSE chunks are separated by `\n\n`; process complete frames.
let nl: number;
while ((nl = buffer.indexOf("\n\n")) >= 0) {
const frame = buffer.slice(0, nl);
buffer = buffer.slice(nl + 2);
const dataLine = extractSseData(frame);
if (!dataLine || dataLine === "[DONE]") continue;
try {
const chunk = JSON.parse(dataLine);
for (const evt of chatChunkToResponsesEvents(chunk, state)) send(evt);
} catch (err) {
errored = true;
// Release the upstream reader too β without the cancel the
// upstream connection lingers until GC. Fire-and-forget so a
// slow cancel never delays the client-visible error. The
// errored-flag + early-return semantics (anti-pattern #24) are
// unchanged: no further reads, no finalize, no close().
reader.cancel().catch(() => {});
controller.error(err);
return;
}
}
}
const finalEvents = finalizeResponsesStream(state);
for (const evt of finalEvents) send(evt);
const finalEvent = finalEvents.find((evt) => evt.type === "response.completed" || evt.type === "response.incomplete");
if (finalEvent && context.request.store !== false && context.options.responseStore) {
context.options.responseStore.set(buildStoredResponse(finalEvent.response, context.input, context.request.instructions));
}
try { controller.close(); } catch {}
} catch (err) {
try { controller.error(err); } catch {}
}
},
cancel(reason) {
context.options.debug === true && console.log(`[responses] stream cancelled: ${String(reason)}`);
try { upstreamResp.body?.cancel(); } catch {}
},
});
return new Response(stream, {
status: 200,
headers: {
"content-type": "text/event-stream",
"cache-control": "no-cache",
connection: "keep-alive",
},
});
}
function extractSseData(frame: string): string | null {
for (const line of frame.split(/\r?\n/)) {
if (line.startsWith("data:")) return line.slice(5).replace(/^\s/, "");
}
return null;
}
// βββββββββββββββββββββββββββββββββββββββββββββ
// Helpers
// βββββββββββββββββββββββββββββββββββββββββββββ
function resolveProviderDef(config: ProxyConfig): ProviderDef & { openaiBaseURL: string; anthropicBaseURL: string } {
const base = getProvider(config.provider);
const endpoints = config.providers[config.provider];
return {
...base,
anthropicBaseURL: endpoints.anthropicBase,
openaiBaseURL: endpoints.openaiBase,
};
}
/**
* Cast stored output items back into input items so the next turn's history is
* a flat list the translator can walk. Responses output and input item shapes
* overlap enough that a structural cast is sound (the fields we read β `type`,
* `call_id`, `name`, `arguments`, `content`, `role` β are shared).
*/
function outputItemsAsInputItems(outputs: ResponsesOutputItem[]): ResponsesInputItem[] {
return outputs as unknown as ResponsesInputItem[];
}
function buildStoredResponse(
resp: ResponsesResponse,
input: ResponsesInputItem[],
instructions: string | undefined,
): StoredResponse {
return {
id: resp.id,
model: resp.model,
status: (resp.status === "completed" || resp.status === "incomplete" || resp.status === "failed" ? resp.status : "completed"),
input,
output: resp.output,
usage: resp.usage,
instructions,
createdAt: Date.now(),
lastAccessedAt: Date.now(),
};
}
|