Spaces:
Running
Running
File size: 27,282 Bytes
98c9143 | 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 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 | import consola from "consola"
import { events } from "fetch-event-stream"
import { createHash } from "node:crypto"
import { WebSocket } from "undici"
import type { SubagentMarker } from "~/lib/subagent"
import {
copilotBaseUrl,
copilotHeaders,
copilotWebSocketHeaders,
prepareForCompact,
prepareInteractionHeaders,
} from "~/lib/api-config"
import { COMPACT_REQUEST, type CompactType } from "~/lib/compact"
import {
logCopilotQuotaSnapshots,
logCopilotRateLimits,
type CopilotQuotaSnapshot,
} from "~/lib/copilot-rate-limit"
import { HTTPError } from "~/lib/error"
import { getProxyEnvDispatcher } from "~/lib/proxy"
import { state } from "~/lib/state"
export interface ResponsesPayload {
model: string
instructions?: string | null
input?: string | Array<ResponseInputItem>
tools?: Array<Tool> | null
tool_choice?: ToolChoiceOptions | ToolChoiceFunction
temperature?: number | null
top_p?: number | null
max_output_tokens?: number | null
metadata?: Metadata | null
stream?: boolean | null
safety_identifier?: string | null
prompt_cache_key?: string | null
prompt_cache_retention?: "in_memory" | "24h" | null
parallel_tool_calls?: boolean | null
store?: boolean | null
reasoning?: Reasoning | null
context_management?: Array<ResponseContextManagementItem> | null
include?: Array<ResponseIncludable>
service_tier?: string | null // NOTE: Unsupported by GitHub Copilot
[key: string]: unknown
}
export type ToolChoiceOptions = "none" | "auto" | "required"
export type ToolSearchExecution = "client" | "server"
export interface ToolChoiceFunction {
name: string
type: "function"
}
export type Tool =
| FunctionTool
| ToolSearchTool
| NamespaceTool
| Record<string, unknown>
export interface FunctionTool {
name: string
parameters: { [key: string]: unknown } | null
strict: boolean | null
type: "function"
description?: string | null
defer_loading?: boolean | null
}
export interface ToolSearchTool {
type: "tool_search"
execution?: ToolSearchExecution | null
description?: string | null
parameters?: { [key: string]: unknown } | null
}
export interface NamespaceTool {
type: "namespace"
name: string
description?: string | null
tools: Array<FunctionTool>
}
export type ResponseIncludable =
| "file_search_call.results"
| "message.input_image.image_url"
| "computer_call_output.output.image_url"
| "reasoning.encrypted_content"
| "code_interpreter_call.outputs"
export interface Reasoning {
effort?: "none" | "minimal" | "low" | "medium" | "high" | "xhigh" | null
summary?: "auto" | "concise" | "detailed" | null
}
export interface ResponseContextManagementCompactionItem {
type: "compaction"
compact_threshold: number
}
export type ResponseContextManagementItem =
ResponseContextManagementCompactionItem
export interface ResponseInputMessage {
type?: "message"
role: "user" | "assistant" | "system" | "developer"
content?: string | Array<ResponseInputContent>
status?: string
phase?: "commentary" | "final_answer"
}
export interface ResponseFunctionToolCallItem {
type: "function_call"
call_id: string
name: string
arguments: string
status?: "in_progress" | "completed" | "incomplete"
namespace?: string | null
}
export interface ResponseFunctionCallOutputItem {
type: "function_call_output"
call_id: string
output: string | Array<ResponseInputContent>
status?: "in_progress" | "completed" | "incomplete"
}
export interface ResponseToolSearchCallItem {
type: "tool_search_call"
call_id: string
arguments: Record<string, unknown> | string
execution?: ToolSearchExecution | null
status?: "in_progress" | "completed" | "incomplete"
}
export interface ResponseToolSearchOutputItem {
type: "tool_search_output"
call_id: string
tools: Array<Tool>
execution?: ToolSearchExecution | null
status?: "in_progress" | "completed" | "incomplete"
}
export interface ResponseInputReasoning {
id?: string
type: "reasoning"
summary: Array<{
type: "summary_text"
text: string
}>
encrypted_content: string
}
export interface ResponseInputCompaction {
id: string
type: "compaction"
encrypted_content: string
}
export type ResponseInputItem =
| ResponseInputMessage
| ResponseFunctionToolCallItem
| ResponseFunctionCallOutputItem
| ResponseToolSearchCallItem
| ResponseToolSearchOutputItem
| ResponseInputReasoning
| ResponseInputCompaction
| Record<string, unknown>
export type ResponseInputContent =
| ResponseInputText
| ResponseInputImage
| ResponseInputFile
| Record<string, unknown>
export interface ResponseInputText {
type: "input_text" | "output_text"
text: string
}
export interface ResponseInputImage {
type: "input_image"
image_url?: string | null
file_id?: string | null
detail: "low" | "high" | "auto"
}
export interface ResponseInputFile {
type: "input_file"
file_data?: string | null
file_id?: string | null
filename?: string | null
}
export interface ResponsesResult {
id: string
object: "response"
created_at: number
model: string
output: Array<ResponseOutputItem>
output_text: string
status: string
usage?: ResponseUsage | null
error: ResponseError | null
incomplete_details: IncompleteDetails | null
instructions: string | null
metadata: Metadata | null
parallel_tool_calls: boolean
temperature: number | null
tool_choice: unknown
tools: Array<Tool>
top_p: number | null
}
export type Metadata = { [key: string]: string }
export interface IncompleteDetails {
reason?: "max_output_tokens" | "content_filter"
}
export interface ResponseError {
message: string
}
export type ResponseOutputItem =
| ResponseOutputMessage
| ResponseOutputReasoning
| ResponseOutputFunctionCall
| ResponseOutputToolSearchCall
| ResponseOutputToolSearchOutput
| ResponseOutputCompaction
export interface ResponseOutputMessage {
id: string
type: "message"
role: "assistant"
status: "completed" | "in_progress" | "incomplete"
content?: Array<ResponseOutputContentBlock>
}
export interface ResponseOutputReasoning {
id: string
type: "reasoning"
summary?: Array<ResponseReasoningBlock>
encrypted_content?: string
status?: "completed" | "in_progress" | "incomplete"
}
export interface ResponseReasoningBlock {
type: string
text?: string
}
export interface ResponseOutputFunctionCall {
id?: string
type: "function_call"
call_id: string
name: string
arguments: string
status?: "in_progress" | "completed" | "incomplete"
namespace?: string | null
}
export interface ResponseOutputToolSearchCall {
id?: string
type: "tool_search_call"
call_id: string
arguments: Record<string, unknown> | string
execution?: ToolSearchExecution | null
status?: "in_progress" | "completed" | "incomplete"
}
export interface ResponseOutputToolSearchOutput {
id?: string
type: "tool_search_output"
call_id: string
tools: Array<Tool>
execution?: ToolSearchExecution | null
status?: "in_progress" | "completed" | "incomplete"
}
export interface ResponseOutputCompaction {
id: string
type: "compaction"
encrypted_content: string
}
export type ResponseOutputContentBlock =
| ResponseOutputText
| ResponseOutputRefusal
| Record<string, unknown>
export interface ResponseOutputText {
type: "output_text"
text: string
annotations: Array<unknown>
}
export interface ResponseOutputRefusal {
type: "refusal"
refusal: string
}
export interface ResponseUsage {
input_tokens: number
output_tokens?: number
total_tokens: number
input_tokens_details?: {
cached_tokens: number
}
output_tokens_details?: {
reasoning_tokens: number
}
}
export type ResponseStreamEvent =
| ResponseCompletedEvent
| ResponseIncompleteEvent
| ResponseCreatedEvent
| ResponseErrorEvent
| ResponseFunctionCallArgumentsDeltaEvent
| ResponseFunctionCallArgumentsDoneEvent
| ResponseFailedEvent
| ResponseOutputItemAddedEvent
| ResponseOutputItemDoneEvent
| ResponseReasoningSummaryTextDeltaEvent
| ResponseReasoningSummaryTextDoneEvent
| ResponseTextDeltaEvent
| ResponseTextDoneEvent
export interface ResponseCompletedEvent {
copilot_quota_snapshots?: Record<string, CopilotQuotaSnapshot>
response: ResponsesResult
sequence_number: number
type: "response.completed"
}
export interface ResponseIncompleteEvent {
response: ResponsesResult
sequence_number: number
type: "response.incomplete"
}
export interface ResponseCreatedEvent {
response: ResponsesResult
sequence_number: number
type: "response.created"
}
export interface ResponseErrorEvent {
code: string | null
message: string
param: string | null
sequence_number: number
type: "error"
}
export interface ResponseFunctionCallArgumentsDeltaEvent {
delta: string
item_id: string
output_index: number
sequence_number: number
type: "response.function_call_arguments.delta"
}
export interface ResponseFunctionCallArgumentsDoneEvent {
arguments: string
item_id: string
name: string
output_index: number
sequence_number: number
type: "response.function_call_arguments.done"
}
export interface ResponseFailedEvent {
response: ResponsesResult
sequence_number: number
type: "response.failed"
}
export interface ResponseOutputItemAddedEvent {
item: ResponseOutputItem
output_index: number
sequence_number: number
type: "response.output_item.added"
}
export interface ResponseOutputItemDoneEvent {
item: ResponseOutputItem
output_index: number
sequence_number: number
type: "response.output_item.done"
}
export interface ResponseReasoningSummaryTextDeltaEvent {
delta: string
item_id: string
output_index: number
sequence_number: number
summary_index: number
type: "response.reasoning_summary_text.delta"
}
export interface ResponseReasoningSummaryTextDoneEvent {
item_id: string
output_index: number
sequence_number: number
summary_index: number
text: string
type: "response.reasoning_summary_text.done"
}
export interface ResponseTextDeltaEvent {
content_index: number
delta: string
item_id: string
output_index: number
sequence_number: number
type: "response.output_text.delta"
}
export interface ResponseTextDoneEvent {
content_index: number
item_id: string
output_index: number
sequence_number: number
text: string
type: "response.output_text.done"
}
export type ResponsesStream = ReturnType<typeof events>
export type CreateResponsesReturn = ResponsesResult | ResponsesStream
export type ResponsesTransport = "http" | "websocket"
interface ResponsesRequestOptions {
vision: boolean
initiator: "agent" | "user"
subagentMarker?: SubagentMarker | null
requestId: string
sessionId?: string
compactType?: CompactType
transport?: ResponsesTransport
}
const RESPONSES_WEBSOCKET_IDLE_TIMEOUT_MS = 60_000
export const createResponses = async (
payload: ResponsesPayload,
{
vision,
initiator,
subagentMarker,
requestId,
sessionId,
compactType,
transport = "http",
}: ResponsesRequestOptions,
): Promise<CreateResponsesReturn> => {
if (!state.copilotToken) throw new Error("Copilot token not found")
const headers: Record<string, string> = {
...copilotHeaders(state, requestId, vision),
"x-initiator": initiator,
}
prepareInteractionHeaders(sessionId, Boolean(subagentMarker), headers)
prepareForCompact(headers, compactType)
// service_tier is not supported by github copilot
payload.service_tier = undefined
consola.log(`<-- model: ${payload.model}`)
const effectiveTransport =
compactType === COMPACT_REQUEST ? "http" : transport
if (effectiveTransport === "websocket") {
const websocketRequest = prepareResponsesWebSocketRequest(
payload,
headers,
{
requestId,
subagentMarker,
},
)
const stream = createPooledResponsesWebSocketStream(websocketRequest)
if (payload.stream) {
return stream
}
return await consumeResponsesWebSocketStream(stream)
}
return await createHttpResponses(payload, headers)
}
const createHttpResponses = async (
payload: ResponsesPayload,
headers: Record<string, string>,
): Promise<CreateResponsesReturn> => {
const response = await fetch(`${copilotBaseUrl(state)}/responses`, {
method: "POST",
headers,
body: JSON.stringify(payload),
})
logCopilotRateLimits(response.headers)
if (!response.ok) {
consola.error("Failed to create responses", response)
throw new HTTPError("Failed to create responses", response)
}
if (payload.stream) {
return events(response)
}
return (await response.json()) as ResponsesResult
}
type ResponsesWebSocketPayload = ResponsesPayload & {
type: "response.create"
initiator: "agent" | "user"
}
interface ResponsesWebSocketRequest {
headers: Record<string, string>
poolKey: string
payload: ResponsesWebSocketPayload
}
type ResponsesWebSocketErrorEvent = Parameters<
NonNullable<InstanceType<typeof WebSocket>["onerror"]>
>[0]
export const prepareResponsesWebSocketRequest = (
payload: ResponsesPayload,
preparedHeaders: Record<string, string>,
options: {
requestId: string
subagentMarker?: SubagentMarker | null
},
): ResponsesWebSocketRequest => {
const initiator = getResponsesWebSocketInitiator(preparedHeaders)
return {
headers: copilotWebSocketHeaders(preparedHeaders),
poolKey: buildResponsesWebSocketPoolKey(payload, options),
payload: buildResponsesWebSocketPayload(payload, initiator),
}
}
export const buildResponsesWebSocketPoolKey = (
payload: ResponsesPayload,
{
requestId,
subagentMarker,
}: {
requestId: string
subagentMarker?: SubagentMarker | null
},
): string => {
const tokenFingerprint =
state.copilotToken ?
createHash("sha256").update(state.copilotToken).digest("hex").slice(0, 16)
: "missing-token"
const subagentKey =
subagentMarker ?
[
subagentMarker.session_id,
subagentMarker.agent_id,
subagentMarker.agent_type,
].join(":")
: "main"
return [tokenFingerprint, payload.model, requestId, subagentKey]
.map(encodePoolKeyPart)
.join("|")
}
export const getResponsesWebSocketInitiator = (
preparedHeaders: Record<string, string>,
): "agent" | "user" => {
const initiator = getHeaderValue(preparedHeaders, "x-initiator")
return initiator?.toLowerCase() === "agent" ? "agent" : "user"
}
const createPooledResponsesWebSocketStream = (
request: ResponsesWebSocketRequest,
): ResponsesStream => runResponsesWebSocketRequest(request)
export const buildResponsesWebSocketPayload = (
payload: ResponsesPayload,
initiator: "agent" | "user",
): ResponsesWebSocketPayload => {
const websocketPayload: ResponsesWebSocketPayload = {
...payload,
type: "response.create",
initiator,
}
delete websocketPayload.stream
delete websocketPayload["background"]
delete websocketPayload.service_tier
return websocketPayload
}
export const buildResponsesWebSocketUrl = (baseUrl: string): string => {
const url = new URL(`${baseUrl.replace(/\/+$/u, "")}/responses`)
if (url.protocol === "https:") {
url.protocol = "wss:"
} else if (url.protocol === "http:") {
url.protocol = "ws:"
}
return url.toString()
}
const responsesWebSocketPool = new Map<string, ResponsesWebSocketEntry>()
const responsesWebSocketActiveRequests = new Map<string, number>()
interface ResponsesWebSocketEntry {
closed: boolean
idleTimer: ReturnType<typeof setTimeout> | null
requestCount: number
websocketPromise: Promise<InstanceType<typeof WebSocket>>
}
interface ResponsesWebSocketRequestTarget {
entry: ResponsesWebSocketEntry
pooled: boolean
}
const runResponsesWebSocketRequest = async function* (
request: ResponsesWebSocketRequest,
): ResponsesStream {
const { entry, pooled } = getResponsesWebSocketRequestTarget(request)
const release = acquireResponsesWebSocketEntry(request.poolKey, entry, pooled)
try {
const websocket = await getReadyResponsesWebSocket(
request.poolKey,
entry,
pooled,
)
websocket.send(JSON.stringify(request.payload))
for await (const data of createWebSocketMessageStream(websocket)) {
const chunk = createResponsesWebSocketStreamChunk(data)
yield chunk
if (isTerminalResponsesStreamChunk(chunk)) {
return
}
}
removeResponsesWebSocketPoolEntry(request.poolKey, entry)
throw new Error("Responses websocket ended without a terminal response")
} catch (error) {
removeResponsesWebSocketPoolEntry(request.poolKey, entry)
throw toError(error)
} finally {
release()
}
}
const getResponsesWebSocketRequestTarget = (
request: ResponsesWebSocketRequest,
): ResponsesWebSocketRequestTarget => {
if (getResponsesWebSocketActiveRequestCount(request.poolKey) > 0) {
return {
entry: createResponsesWebSocketEntry(request),
pooled: false,
}
}
const existing = responsesWebSocketPool.get(request.poolKey)
if (existing && !existing.closed) {
clearResponsesWebSocketIdleTimer(existing)
return {
entry: existing,
pooled: true,
}
}
const entry = createResponsesWebSocketEntry(request)
responsesWebSocketPool.set(request.poolKey, entry)
return {
entry,
pooled: true,
}
}
const createResponsesWebSocketEntry = (
request: ResponsesWebSocketRequest,
): ResponsesWebSocketEntry => {
const entry: ResponsesWebSocketEntry = {
closed: false,
idleTimer: null,
requestCount: 0,
websocketPromise: openResponsesWebSocket({
headers: request.headers,
url: buildResponsesWebSocketUrl(copilotBaseUrl(state)),
}),
}
entry.websocketPromise
.then((websocket) => {
websocket.addEventListener("close", () => {
removeResponsesWebSocketPoolEntry(request.poolKey, entry)
})
websocket.addEventListener("error", () => {
removeResponsesWebSocketPoolEntry(request.poolKey, entry)
})
})
.catch(() => {
removeResponsesWebSocketPoolEntry(request.poolKey, entry)
})
return entry
}
const acquireResponsesWebSocketEntry = (
poolKey: string,
entry: ResponsesWebSocketEntry,
pooled: boolean,
): (() => void) => {
clearResponsesWebSocketIdleTimer(entry)
incrementResponsesWebSocketActiveRequestCount(poolKey)
entry.requestCount += 1
let released = false
return () => {
if (released) {
return
}
released = true
entry.requestCount -= 1
decrementResponsesWebSocketActiveRequestCount(poolKey)
if (entry.closed || entry.requestCount > 0) {
return
}
if (pooled && responsesWebSocketPool.get(poolKey) === entry) {
scheduleResponsesWebSocketIdleClose(poolKey, entry)
return
}
removeResponsesWebSocketPoolEntry(poolKey, entry)
}
}
const getReadyResponsesWebSocket = async (
poolKey: string,
entry: ResponsesWebSocketEntry,
pooled: boolean,
): Promise<InstanceType<typeof WebSocket>> => {
if (entry.closed) {
throw new Error(
"Responses websocket became unavailable before the request started",
)
}
const websocket = await entry.websocketPromise
if (
entry.closed
|| (pooled && responsesWebSocketPool.get(poolKey) !== entry)
) {
throw new Error(
"Responses websocket became unavailable before the request started",
)
}
if (websocket.readyState !== WebSocket.OPEN) {
removeResponsesWebSocketPoolEntry(poolKey, entry)
throw new Error(
"Responses websocket became unavailable before the request started",
)
}
return websocket
}
const scheduleResponsesWebSocketIdleClose = (
poolKey: string,
entry: ResponsesWebSocketEntry,
): void => {
clearResponsesWebSocketIdleTimer(entry)
entry.idleTimer = setTimeout(() => {
removeResponsesWebSocketPoolEntry(poolKey, entry)
}, RESPONSES_WEBSOCKET_IDLE_TIMEOUT_MS)
unrefTimer(entry.idleTimer)
}
const clearResponsesWebSocketIdleTimer = (
entry: ResponsesWebSocketEntry,
): void => {
if (entry.idleTimer) {
clearTimeout(entry.idleTimer)
entry.idleTimer = null
}
}
const getResponsesWebSocketActiveRequestCount = (poolKey: string): number =>
responsesWebSocketActiveRequests.get(poolKey) ?? 0
const incrementResponsesWebSocketActiveRequestCount = (
poolKey: string,
): void => {
responsesWebSocketActiveRequests.set(
poolKey,
getResponsesWebSocketActiveRequestCount(poolKey) + 1,
)
}
const decrementResponsesWebSocketActiveRequestCount = (
poolKey: string,
): void => {
const nextCount = getResponsesWebSocketActiveRequestCount(poolKey) - 1
if (nextCount <= 0) {
responsesWebSocketActiveRequests.delete(poolKey)
return
}
responsesWebSocketActiveRequests.set(poolKey, nextCount)
}
const removeResponsesWebSocketPoolEntry = (
poolKey: string,
entry: ResponsesWebSocketEntry,
): void => {
if (responsesWebSocketPool.get(poolKey) === entry) {
responsesWebSocketPool.delete(poolKey)
}
if (entry.closed) {
return
}
entry.closed = true
clearResponsesWebSocketIdleTimer(entry)
entry.websocketPromise.then(closeResponsesWebSocket).catch(() => {})
}
const unrefTimer = (timer: ReturnType<typeof setTimeout>): void => {
if (
typeof timer === "object"
&& "unref" in timer
&& typeof timer.unref === "function"
) {
timer.unref()
}
}
const createResponsesWebSocketError = (
message: string,
event?: Pick<ResponsesWebSocketErrorEvent, "error" | "message">,
): Error => {
const reason = event?.error ?? event?.message
if (reason === undefined || reason === "") {
return new Error(message)
}
const cause = toError(reason)
return new Error(`${message}: ${cause.message}`, { cause })
}
const openResponsesWebSocket = async ({
headers,
url,
}: {
headers: Record<string, string>
url: string
}): Promise<InstanceType<typeof WebSocket>> =>
await new Promise((resolve, reject) => {
const dispatcher = getProxyEnvDispatcher()
const init = dispatcher ? { dispatcher, headers } : { headers }
const websocket = new WebSocket(url, init)
const cleanup = () => {
websocket.removeEventListener("open", onOpen)
websocket.removeEventListener("error", onError)
}
const onOpen = () => {
cleanup()
resolve(websocket)
}
const onError = (event: ResponsesWebSocketErrorEvent) => {
cleanup()
reject(
createResponsesWebSocketError(
"Failed to create responses websocket",
event,
),
)
}
websocket.addEventListener("open", onOpen)
websocket.addEventListener("error", onError)
})
const createWebSocketMessageStream = async function* (
websocket: InstanceType<typeof WebSocket>,
): AsyncIterable<string> {
const queue: Array<Promise<string>> = []
let closed = false
let error: Error | null = null
let notify: (() => void) | null = null
const wake = () => {
notify?.()
notify = null
}
const onMessage = (event: { data: unknown }) => {
queue.push(normalizeWebSocketMessageData(event.data))
wake()
}
const onClose = () => {
closed = true
wake()
}
const onError = (event: ResponsesWebSocketErrorEvent) => {
error = createResponsesWebSocketError(
"Responses websocket stream error",
event,
)
wake()
}
websocket.addEventListener("message", onMessage)
websocket.addEventListener("close", onClose)
websocket.addEventListener("error", onError)
try {
while (true) {
const item = queue.shift()
if (item) {
yield await item
continue
}
if (error) {
throw toError(error)
}
if (closed) {
break
}
await new Promise<void>((resolve) => {
notify = resolve
})
}
} finally {
websocket.removeEventListener("message", onMessage)
websocket.removeEventListener("close", onClose)
websocket.removeEventListener("error", onError)
}
}
const normalizeWebSocketMessageData = async (
data: unknown,
): Promise<string> => {
if (typeof data === "string") {
return data
}
if (data instanceof ArrayBuffer) {
return new TextDecoder().decode(data)
}
if (ArrayBuffer.isView(data)) {
const view = data
return new TextDecoder().decode(
new Uint8Array(
view.buffer as ArrayBuffer,
view.byteOffset,
view.byteLength,
),
)
}
if (isTextReadable(data)) {
return await data.text()
}
return String(data)
}
const isTextReadable = (
value: unknown,
): value is { text: () => Promise<string> } => {
if (!value || typeof value !== "object" || !("text" in value)) {
return false
}
return typeof (value as { text?: unknown }).text === "function"
}
const toError = (value: unknown): Error => {
if (value instanceof Error) {
return value
}
return new Error(String(value))
}
const getHeaderValue = (
headers: Record<string, string>,
headerName: string,
): string | undefined => {
const normalizedHeaderName = headerName.toLowerCase()
const match = Object.entries(headers).find(
([key]) => key.toLowerCase() === normalizedHeaderName,
)
return match?.[1]
}
const encodePoolKeyPart = (value: string): string => encodeURIComponent(value)
const createResponsesWebSocketStreamChunk = (
data: string,
): { data?: string; event?: string; id?: string } => {
if (data === "[DONE]") {
return { data }
}
try {
const parsed = JSON.parse(data) as {
copilot_quota_snapshots?: Record<string, CopilotQuotaSnapshot>
id?: unknown
type?: unknown
}
if (parsed.type === "response.completed") {
logCopilotQuotaSnapshots(parsed.copilot_quota_snapshots)
}
return {
data: JSON.stringify(parsed),
event: typeof parsed.type === "string" ? parsed.type : undefined,
id: typeof parsed.id === "string" ? parsed.id : undefined,
}
} catch {
return { data }
}
}
const isTerminalResponsesStreamChunk = (chunk: { data?: string }): boolean => {
if (!chunk.data || chunk.data === "[DONE]") {
return false
}
try {
const parsed = JSON.parse(chunk.data) as { type?: unknown }
return (
parsed.type === "response.completed"
|| parsed.type === "response.failed"
|| parsed.type === "response.incomplete"
|| parsed.type === "error"
)
} catch {
return false
}
}
const consumeResponsesWebSocketStream = async (
stream: ResponsesStream,
): Promise<ResponsesResult> => {
for await (const chunk of stream) {
if (!chunk.data || chunk.data === "[DONE]") {
continue
}
const event = JSON.parse(chunk.data) as ResponseStreamEvent
if (event.type === "error") {
throw new Error(event.message)
}
if (
event.type === "response.completed"
|| event.type === "response.failed"
|| event.type === "response.incomplete"
) {
return event.response
}
}
throw new Error("Responses websocket ended without a terminal response")
}
const closeResponsesWebSocket = (
websocket: InstanceType<typeof WebSocket>,
): void => {
if (
websocket.readyState === WebSocket.CONNECTING
|| websocket.readyState === WebSocket.OPEN
) {
websocket.close()
}
}
|