File size: 19,145 Bytes
eb3f11e | 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 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 | /**
* Proxy stream function for apps that route LLM calls through a server.
* The server manages auth and proxies requests to LLM providers.
*/
import {
createToolArgumentPreviewSchedule,
createSseByteGuard,
parseStreamingJson,
parseTerminalToolCallArguments,
type SseByteGuard,
type ToolArgumentPreviewSchedule,
} from "@openclaw/ai/internal/runtime";
import { resolvePositiveTimerTimeoutMs } from "@openclaw/normalization-core/number-coercion";
import { readResponseWithLimit } from "../../infra/http-body.js";
// Internal import for JSON parsing utility
import type {
AssistantMessage,
AssistantMessageEvent,
Context,
Model,
SimpleStreamOptions,
StopReason,
ToolCall,
} from "../../llm/types.js";
import { EventStream } from "../../llm/utils/event-stream.js";
const PROXY_ERROR_BODY_MAX_BYTES = 16 * 1024 * 1024;
const PROXY_SSE_STREAM_MAX_BYTES = 16 * 1024 * 1024;
const PROXY_SSE_PENDING_BUFFER_MAX_BYTES = PROXY_SSE_STREAM_MAX_BYTES;
const PROXY_SSE_READ_IDLE_TIMEOUT_MS = 120_000;
type StreamingToolCall = ToolCall & {
partialJson: string;
};
// Create stream class matching ProxyMessageEventStream
class ProxyMessageEventStream extends EventStream<AssistantMessageEvent, AssistantMessage> {
constructor() {
super(
(event) => event.type === "done" || event.type === "error",
(event) => {
if (event.type === "done") {
return event.message;
}
if (event.type === "error") {
return event.error;
}
throw new Error("Unexpected event type");
},
);
}
}
/**
* Proxy event types - server sends these with partial field stripped to reduce bandwidth.
*/
export type ProxyAssistantMessageEvent =
| { type: "start" }
| { type: "text_start"; contentIndex: number; contentSignature?: string }
| { type: "text_delta"; contentIndex: number; delta: string }
| { type: "text_end"; contentIndex: number; contentSignature?: string }
| { type: "thinking_start"; contentIndex: number }
| { type: "thinking_delta"; contentIndex: number; delta: string }
| { type: "thinking_end"; contentIndex: number; contentSignature?: string }
| { type: "toolcall_start"; contentIndex: number; id: string; toolName: string }
| { type: "toolcall_delta"; contentIndex: number; delta: string }
| { type: "toolcall_end"; contentIndex: number }
| {
type: "done";
reason: Extract<StopReason, "stop" | "length" | "toolUse">;
usage: AssistantMessage["usage"];
}
| {
type: "error";
reason: Extract<StopReason, "aborted" | "error">;
errorMessage?: string;
usage: AssistantMessage["usage"];
};
type ProxySerializableStreamOptions = Pick<
SimpleStreamOptions,
| "temperature"
| "maxTokens"
| "reasoning"
| "cacheRetention"
| "sessionId"
| "promptCacheKey"
| "metadata"
| "transport"
| "thinkingBudgets"
| "maxRetryDelayMs"
| "timeoutMs"
>;
export interface ProxyStreamOptions extends ProxySerializableStreamOptions {
/** Local abort signal for the proxy request */
signal?: AbortSignal;
/** Auth token for the proxy server */
authToken: string;
/** Proxy server URL (e.g., "https://genai.example.com") */
proxyUrl: string;
}
/**
* Stream function that proxies through a server instead of calling LLM providers directly.
* The server strips the partial field from delta events to reduce bandwidth.
* We reconstruct the partial message client-side.
*
* Use this as the `streamFn` option when creating an Agent that needs to go through a proxy.
*
* @example
* ```typescript
* const agent = new Agent({
* streamFn: (model, context, options) =>
* streamProxy(model, context, {
* ...options,
* authToken: await getAuthToken(),
* proxyUrl: "https://genai.example.com",
* }),
* });
* ```
*/
function buildProxyRequestOptions(options: ProxyStreamOptions): ProxySerializableStreamOptions {
return {
temperature: options.temperature,
maxTokens: options.maxTokens,
reasoning: options.reasoning,
cacheRetention: options.cacheRetention,
sessionId: options.sessionId,
promptCacheKey: options.promptCacheKey,
metadata: options.metadata,
transport: options.transport,
thinkingBudgets: options.thinkingBudgets,
maxRetryDelayMs: options.maxRetryDelayMs,
timeoutMs: options.timeoutMs,
};
}
function sanitizeProxyModel(model: Model): Model {
const { headers: _headers, ...safeModel } = model;
return safeModel as Model;
}
function resolveProxyReadIdleTimeoutMs(timeoutMs: ProxyStreamOptions["timeoutMs"]): number {
return resolvePositiveTimerTimeoutMs(timeoutMs, PROXY_SSE_READ_IDLE_TIMEOUT_MS);
}
type ProxyRequestAbort = {
signal: AbortSignal;
clear: () => void;
};
function createProxyRequestTimeoutError(timeoutMs: number): Error {
const error = new Error(`Proxy request timed out after ${timeoutMs}ms`);
error.name = "TimeoutError";
return error;
}
function buildProxyRequestAbort(
callerSignal: AbortSignal | undefined,
timeoutMs: number,
): ProxyRequestAbort {
const timeoutController = new AbortController();
const timeoutId = setTimeout(() => {
timeoutController.abort(createProxyRequestTimeoutError(timeoutMs));
}, timeoutMs);
return {
signal: callerSignal
? AbortSignal.any([callerSignal, timeoutController.signal])
: timeoutController.signal,
clear: () => {
clearTimeout(timeoutId);
},
};
}
function isProxyRequestTimeoutError(params: {
error: unknown;
callerSignal: AbortSignal | undefined;
requestSignal: AbortSignal;
}): boolean {
if (params.callerSignal?.aborted || !params.requestSignal.aborted) {
return false;
}
if (!(params.error instanceof Error)) {
return false;
}
return (
params.error.name === "AbortError" ||
params.error.name === "TimeoutError" ||
params.error.message === "Request was aborted"
);
}
async function readProxyErrorData(
response: Response,
readIdleTimeoutMs: number,
): Promise<{ error?: string } | undefined> {
const bytes = await readResponseWithLimit(response, PROXY_ERROR_BODY_MAX_BYTES, {
onOverflow: ({ maxBytes }) => new Error(`Proxy error body exceeded ${maxBytes} bytes`),
chunkTimeoutMs: readIdleTimeoutMs,
onIdleTimeout: ({ chunkTimeoutMs }) =>
new Error(`Proxy error body stalled: no data received for ${chunkTimeoutMs}ms`),
});
return JSON.parse(new TextDecoder("utf-8", { fatal: true }).decode(bytes)) as { error?: string };
}
async function readProxySseChunk(
reader: Pick<SseByteGuard, "read">,
readIdleTimeoutMs: number,
cancel: (reason?: unknown) => Promise<void>,
): Promise<ReadableStreamReadResult<Uint8Array>> {
let timedOut = false;
return await new Promise((resolve, reject) => {
const timeoutError = new Error(
`Proxy SSE stream stalled: no data received for ${readIdleTimeoutMs}ms`,
);
const timeoutId = setTimeout(() => {
timedOut = true;
void cancel(timeoutError);
reject(timeoutError);
}, readIdleTimeoutMs);
void reader.read().then(
(result) => {
clearTimeout(timeoutId);
if (!timedOut) {
resolve(result);
}
},
(error: unknown) => {
clearTimeout(timeoutId);
if (!timedOut) {
reject(error instanceof Error ? error : new Error(String(error)));
}
},
);
});
}
function assertProxySsePendingBufferWithinLimit(buffer: string): void {
const size = new TextEncoder().encode(buffer).byteLength;
if (size <= PROXY_SSE_PENDING_BUFFER_MAX_BYTES) {
return;
}
throw new Error(`Proxy SSE pending buffer exceeded ${PROXY_SSE_PENDING_BUFFER_MAX_BYTES} bytes`);
}
export function streamProxy(
model: Model,
context: Context,
options: ProxyStreamOptions,
): ProxyMessageEventStream {
const stream = new ProxyMessageEventStream();
void (async () => {
// Initialize the partial message that we'll build up from events
const partial: AssistantMessage = {
role: "assistant",
stopReason: "stop",
content: [],
api: model.api,
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 },
},
timestamp: Date.now(),
};
let reader: ReadableStreamDefaultReader<Uint8Array> | undefined;
let readerReachedEof = false;
let cancellation: Promise<void> | undefined;
let cleanupReason: unknown;
const readIdleTimeoutMs = resolveProxyReadIdleTimeoutMs(options.timeoutMs);
const cancelReader = (reason?: unknown) =>
reader ? (cancellation ??= reader.cancel(reason).catch(() => undefined)) : Promise.resolve();
const abortHandler = () => void cancelReader("Request aborted by user");
options.signal?.addEventListener("abort", abortHandler);
try {
const requestAbort = buildProxyRequestAbort(options.signal, readIdleTimeoutMs);
const response = await fetch(`${options.proxyUrl}/api/stream`, {
method: "POST",
headers: {
Authorization: `Bearer ${options.authToken}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
model: sanitizeProxyModel(model),
context,
options: buildProxyRequestOptions(options),
}),
signal: requestAbort.signal,
})
.catch((error: unknown) => {
if (
isProxyRequestTimeoutError({
error,
callerSignal: options.signal,
requestSignal: requestAbort.signal,
})
) {
throw new Error(`Proxy request timed out after ${readIdleTimeoutMs}ms`, {
cause: error instanceof Error ? error : undefined,
});
}
throw error;
})
.finally(() => {
requestAbort.clear();
});
if (!response.ok) {
let errorMessage = `Proxy error: ${response.status} ${response.statusText}`;
try {
const errorData = await readProxyErrorData(response, readIdleTimeoutMs);
if (errorData?.error) {
errorMessage = `Proxy error: ${errorData.error}`;
}
} catch (error) {
if (error instanceof Error && error.message.startsWith("Proxy error body")) {
throw error;
}
}
throw new Error(errorMessage);
}
reader = response.body!.getReader();
const sseReader = createSseByteGuard(reader, {
maxBytes: PROXY_SSE_STREAM_MAX_BYTES,
onOverflow: ({ maxBytes }) => new Error(`Proxy SSE stream exceeded ${maxBytes} bytes`),
});
const decoder = new TextDecoder();
let buffer = "";
let terminalEventSeen = false;
const toolArgumentPreviewSchedules = new Map<number, ToolArgumentPreviewSchedule>();
const processSseLine = (line: string): boolean => {
// The SSE spec makes the space after "data:" optional; accept both
// `data:{...}` and `data: {...}`, mirroring provider-transport-fetch.
if (!line.startsWith("data:")) {
return false;
}
const data = line.slice("data:".length).trim();
if (!data) {
return false;
}
const proxyEvent = JSON.parse(data) as ProxyAssistantMessageEvent;
const event = processProxyEvent(proxyEvent, partial, toolArgumentPreviewSchedules);
if (!event) {
return false;
}
stream.push(event);
return event.type === "done" || event.type === "error";
};
while (!terminalEventSeen) {
const { done, value } = await readProxySseChunk(sseReader, readIdleTimeoutMs, cancelReader);
if (done) {
readerReachedEof = cancellation === undefined;
break;
}
if (options.signal?.aborted) {
throw new Error("Request aborted by user");
}
buffer += decoder.decode(value, { stream: true });
const lines = buffer.split("\n");
buffer = lines.pop() || "";
assertProxySsePendingBufferWithinLimit(buffer);
for (const line of lines) {
terminalEventSeen = processSseLine(line);
if (terminalEventSeen) {
break;
}
}
}
if (options.signal?.aborted) {
throw new Error("Request aborted by user");
}
if (readerReachedEof) {
buffer += decoder.decode();
if (buffer.trim()) {
terminalEventSeen = processSseLine(buffer);
}
}
if (!terminalEventSeen) {
throw new Error("Proxy stream ended before terminal event");
}
stream.end();
} catch (error) {
cleanupReason = error;
const errorMessage = error instanceof Error ? error.message : String(error);
const reason = options.signal?.aborted ? "aborted" : "error";
partial.stopReason = reason;
partial.errorMessage = errorMessage;
stream.push({
type: "error",
reason,
error: partial,
});
stream.end();
} finally {
try {
if (reader && !readerReachedEof) {
// Upstream cancellation may never settle; it must not prevent reader release.
void cancelReader(cleanupReason);
}
reader?.releaseLock();
} catch {
// Stream handling above already pushed the terminal proxy event;
// cleanup failures must not replace it with a secondary release error.
}
options.signal?.removeEventListener("abort", abortHandler);
}
})();
return stream;
}
/**
* Process a proxy event and update the partial message.
*/
function processProxyEvent(
proxyEvent: ProxyAssistantMessageEvent,
partial: AssistantMessage,
toolArgumentPreviewSchedules: Map<number, ToolArgumentPreviewSchedule>,
): AssistantMessageEvent | undefined {
switch (proxyEvent.type) {
case "start":
return { type: "start", partial };
case "text_start":
partial.content[proxyEvent.contentIndex] = {
type: "text",
text: "",
...(proxyEvent.contentSignature !== undefined
? { textSignature: proxyEvent.contentSignature }
: {}),
};
return { type: "text_start", contentIndex: proxyEvent.contentIndex, partial };
case "text_delta": {
const content = partial.content[proxyEvent.contentIndex];
if (content?.type === "text") {
content.text += proxyEvent.delta;
return {
type: "text_delta",
contentIndex: proxyEvent.contentIndex,
delta: proxyEvent.delta,
partial,
};
}
throw new Error("Received text_delta for non-text content");
}
case "text_end": {
const content = partial.content[proxyEvent.contentIndex];
if (content?.type === "text") {
if (proxyEvent.contentSignature !== undefined) {
content.textSignature = proxyEvent.contentSignature;
}
return {
type: "text_end",
contentIndex: proxyEvent.contentIndex,
content: content.text,
partial,
};
}
throw new Error("Received text_end for non-text content");
}
case "thinking_start":
partial.content[proxyEvent.contentIndex] = { type: "thinking", thinking: "" };
return { type: "thinking_start", contentIndex: proxyEvent.contentIndex, partial };
case "thinking_delta": {
const content = partial.content[proxyEvent.contentIndex];
if (content?.type === "thinking") {
content.thinking += proxyEvent.delta;
return {
type: "thinking_delta",
contentIndex: proxyEvent.contentIndex,
delta: proxyEvent.delta,
partial,
};
}
throw new Error("Received thinking_delta for non-thinking content");
}
case "thinking_end": {
const content = partial.content[proxyEvent.contentIndex];
if (content?.type === "thinking") {
content.thinkingSignature = proxyEvent.contentSignature;
return {
type: "thinking_end",
contentIndex: proxyEvent.contentIndex,
content: content.thinking,
partial,
};
}
throw new Error("Received thinking_end for non-thinking content");
}
case "toolcall_start": {
const content = {
type: "toolCall",
id: proxyEvent.id,
name: proxyEvent.toolName,
arguments: {},
partialJson: "",
} satisfies StreamingToolCall;
partial.content[proxyEvent.contentIndex] = content;
toolArgumentPreviewSchedules.set(
proxyEvent.contentIndex,
createToolArgumentPreviewSchedule(),
);
return { type: "toolcall_start", contentIndex: proxyEvent.contentIndex, partial };
}
case "toolcall_delta": {
const content = partial.content[proxyEvent.contentIndex];
if (content?.type === "toolCall") {
const streamingContent = content as StreamingToolCall;
streamingContent.partialJson += proxyEvent.delta;
const previewSchedule = toolArgumentPreviewSchedules.get(proxyEvent.contentIndex);
if (!previewSchedule) {
throw new Error("Received toolcall_delta without a preview schedule");
}
if (previewSchedule(streamingContent.partialJson.length)) {
content.arguments = parseStreamingJson(streamingContent.partialJson);
}
partial.content[proxyEvent.contentIndex] = { ...content }; // Trigger reactivity
return {
type: "toolcall_delta",
contentIndex: proxyEvent.contentIndex,
delta: proxyEvent.delta,
partial,
};
}
throw new Error("Received toolcall_delta for non-toolCall content");
}
case "toolcall_end": {
const content = partial.content[proxyEvent.contentIndex];
if (content?.type === "toolCall") {
const streamingContent = content as StreamingToolCall;
content.arguments = streamingContent.partialJson
? parseTerminalToolCallArguments(streamingContent.partialJson)
: {};
toolArgumentPreviewSchedules.delete(proxyEvent.contentIndex);
delete (content as Partial<StreamingToolCall>).partialJson;
return {
type: "toolcall_end",
contentIndex: proxyEvent.contentIndex,
toolCall: content,
partial,
};
}
return undefined;
}
case "done":
partial.stopReason = proxyEvent.reason;
partial.usage = proxyEvent.usage;
return { type: "done", reason: proxyEvent.reason, message: partial };
case "error":
partial.stopReason = proxyEvent.reason;
partial.errorMessage = proxyEvent.errorMessage;
partial.usage = proxyEvent.usage;
return { type: "error", reason: proxyEvent.reason, error: partial };
default: {
proxyEvent satisfies never;
console.warn(`Unhandled proxy event type: ${(proxyEvent as { type?: string }).type}`);
return undefined;
}
}
}
|