Repository navigation
Expand file tree
/
Copy pathresponses_websocket.rs
More file actions
1627 lines (1526 loc) · 61 KB
/
Copy pathresponses_websocket.rs
File metadata and controls
1627 lines (1526 loc) · 61 KB
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
use crate::RESPONSES_PATH;
use crate::auth::SharedAuthProvider;
use crate::common::ResponseEvent;
use crate::common::ResponseInterrupt;
use crate::common::ResponseStream;
use crate::common::ResponsesWsRequest;
use crate::common::SafetyBufferingTreatment;
use crate::common::WS_REQUEST_HEADER_TRACEPARENT_CLIENT_METADATA_KEY;
use crate::endpoint::responses_websocket_probe::ResponsesWebsocketClose;
use crate::endpoint::responses_websocket_probe::ResponsesWebsocketProbe;
use crate::endpoint::responses_websocket_probe::ResponsesWebsocketProbeError;
use crate::endpoint::responses_websocket_probe::ResponsesWebsocketProbeFailureStage;
use crate::error::ApiError;
use crate::provider::Provider;
use crate::rate_limits::parse_rate_limit_event;
use crate::responses_headers::json_headers_to_http_headers;
use crate::safety_buffering::treatment_from_headers;
use crate::sse::ResponsesStreamEvent;
use crate::sse::process_responses_event;
use crate::telemetry::WebsocketTelemetry;
use bytes::Bytes;
use codex_client::TransportError;
use codex_http_client::HttpClientFactory;
use codex_http_client::RetryAfter;
use codex_websocket_client::WebSocketConnection;
use codex_websocket_client::WebSocketConnector;
use futures::FutureExt;
use futures::SinkExt;
use futures::StreamExt;
use http::HeaderMap;
use http::StatusCode;
use serde::Deserialize;
use serde_json::Value;
use serde_json::map::Map as JsonMap;
use std::future::Future;
use std::sync::Arc;
use std::sync::OnceLock;
use std::time::Duration;
use tokio::sync::Mutex;
use tokio::sync::mpsc;
use tokio::sync::oneshot;
use tokio::time::Instant;
use tokio_tungstenite::tungstenite::Error as WsError;
use tokio_tungstenite::tungstenite::Message;
use tokio_tungstenite::tungstenite::Utf8Bytes;
use tokio_tungstenite::tungstenite::client::IntoClientRequest;
use tokio_tungstenite::tungstenite::handshake::client::Response;
use tokio_tungstenite::tungstenite::protocol::CloseFrame;
use tokio_tungstenite::tungstenite::protocol::frame::Fragment;
use tokio_tungstenite::tungstenite::protocol::frame::Frame;
use tokio_tungstenite::tungstenite::protocol::frame::coding::CloseCode;
use tokio_tungstenite::tungstenite::protocol::frame::coding::Data;
use tracing::Instrument;
use tracing::Span;
use tracing::debug;
use tracing::error;
use tracing::info;
use tracing::instrument;
use tungstenite::extensions::ExtensionsConfig;
use tungstenite::extensions::compression::deflate::DeflateConfig;
use tungstenite::protocol::WebSocketConfig;
use url::Url;
struct WsStream {
max_message_bytes: Option<usize>,
routing_affinity: Option<codex_http_client::ChatGptRoutingAffinity>,
tx_command: mpsc::Sender<WsCommand>,
rx_message: mpsc::UnboundedReceiver<Result<Message, WsError>>,
pump_task: tokio::task::JoinHandle<()>,
}
enum WsCommand {
Send {
message: Message,
tx_result: oneshot::Sender<Result<(), WsError>>,
},
}
/// Send large Responses turns as one text message with backpressure between frames.
async fn send_message(
socket: &mut (impl futures::Sink<Message, Error = WsError> + Unpin),
message: Message,
) -> Result<(), WsError> {
const FRAGMENT_SIZE: usize = 1024 * 1024;
let Message::Text(text) = message else {
return socket.send(message).await;
};
if text.len() <= FRAGMENT_SIZE {
return socket.send(Message::Text(text)).await;
}
let mut data = Bytes::from(text);
let mut opcode = Data::Text;
while !data.is_empty() {
let payload = data.split_to(data.len().min(FRAGMENT_SIZE));
let fragment = if data.is_empty() {
Fragment::Final
} else {
Fragment::More
};
let frame = Frame::message_fragment(payload, opcode, fragment);
socket.send(Message::Frame(frame)).await?;
opcode = Data::Continue;
}
Ok(())
}
impl WsStream {
fn new(inner: WebSocketConnection, max_message_bytes: Option<usize>) -> Self {
let routing_affinity = inner.routing_affinity().cloned();
let (tx_command, mut rx_command) = mpsc::channel::<WsCommand>(32);
let (tx_message, rx_message) = mpsc::unbounded_channel::<Result<Message, WsError>>();
let pump_task = tokio::spawn(async move {
let mut inner = inner;
loop {
tokio::select! {
command = rx_command.recv() => {
let Some(command) = command else {
break;
};
match command {
WsCommand::Send { message, tx_result } => {
let result = send_message(&mut inner, message).await;
let should_break = result.is_err();
let _ = tx_result.send(result);
if should_break {
break;
}
}
}
}
message = inner.next() => {
let Some(message) = message else {
break;
};
match message {
Ok(Message::Ping(payload)) => {
if let Err(err) = inner.send(Message::Pong(payload)).await {
let _ = tx_message.send(Err(err));
break;
}
}
Ok(Message::Pong(_)) => {}
Ok(message @ (Message::Text(_)
| Message::Binary(_)
| Message::Close(_)
| Message::Frame(_))) => {
let is_close = matches!(message, Message::Close(_));
if tx_message.send(Ok(message)).is_err() {
break;
}
if is_close {
break;
}
}
Err(err) => {
let _ = tx_message.send(Err(err));
break;
}
}
}
}
}
});
Self {
max_message_bytes,
routing_affinity,
tx_command,
rx_message,
pump_task,
}
}
async fn request(
&mut self,
make_command: impl FnOnce(oneshot::Sender<Result<(), WsError>>) -> WsCommand,
) -> Result<(), WsError> {
let (tx_result, rx_result) = oneshot::channel();
if self.tx_command.send(make_command(tx_result)).await.is_ok()
&& let Ok(result) = rx_result.await
{
return result;
}
while let Some(message) = self.rx_message.recv().await {
message?;
}
Err(WsError::ConnectionClosed)
}
async fn send(&mut self, message: Message) -> Result<(), WsError> {
self.request(|tx_result| WsCommand::Send { message, tx_result })
.await
}
async fn next(&mut self) -> Option<Result<Message, WsError>> {
self.rx_message.recv().await
}
}
impl Drop for WsStream {
fn drop(&mut self) {
self.pump_task.abort();
}
}
const X_CODEX_TURN_STATE_HEADER: &str = "x-codex-turn-state";
const X_CODEX_WEBSOCKET_MAX_MESSAGE_BYTES_HEADER: &str = "x-codex-websocket-max-message-bytes";
const X_MODELS_ETAG_HEADER: &str = "x-models-etag";
const X_REASONING_INCLUDED_HEADER: &str = "x-reasoning-included";
const OPENAI_MODEL_HEADER: &str = "openai-model";
const WEBSOCKET_CONNECTION_LIMIT_REACHED_CODE: &str = "websocket_connection_limit_reached";
const WEBSOCKET_CONNECTION_LIMIT_REACHED_MESSAGE: &str = "Responses websocket connection limit reached (60 minutes). Create a new websocket connection to continue.";
const PREVIOUS_RESPONSE_NOT_FOUND_CODE: &str = "previous_response_not_found";
const PREVIOUS_RESPONSE_NOT_FOUND_MESSAGE: &str =
"Previous response was not found. Retrying the full request.";
const RESPONSES_WEBSOCKET_TIMING_KIND: &str = "responsesapi.websocket_timing";
const RESPONSES_WEBSOCKET_TIMING_EVENT_TARGET: &str = "codex_api::responses_websocket_timing";
const SESSION_ID_CLIENT_METADATA_KEY: &str = "session_id";
const THREAD_ID_CLIENT_METADATA_KEY: &str = "thread_id";
const TURN_ID_CLIENT_METADATA_KEY: &str = "turn_id";
const WS_STREAM_REQUEST_START_MS_CLIENT_METADATA_KEY: &str = "x-codex-ws-stream-request-start-ms";
struct ResponsesWebsocketTimingLogContext {
model: String,
session_id: Option<String>,
thread_id: Option<String>,
turn_id: Option<String>,
traceparent: Option<String>,
previous_response_id: Option<String>,
request_start_ms: Option<String>,
warmup: bool,
connection_reused: bool,
}
pub struct ResponsesWebsocketConnection {
routing_affinity: Option<codex_http_client::ChatGptRoutingAffinity>,
stream: Arc<Mutex<Option<WsStream>>>,
// TODO (pakrym): is this the right place for timeout?
idle_timeout: Duration,
server_reasoning_included: bool,
server_model: Option<String>,
telemetry: Option<Arc<dyn WebsocketTelemetry>>,
}
impl std::fmt::Debug for ResponsesWebsocketConnection {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.debug_struct("ResponsesWebsocketConnection")
.field("stream", &"<ws-stream>")
.field("idle_timeout", &self.idle_timeout)
.field("server_reasoning_included", &self.server_reasoning_included)
.field("server_model", &self.server_model)
.field("telemetry", &self.telemetry.as_ref().map(|_| "<telemetry>"))
.finish()
}
}
impl ResponsesWebsocketConnection {
fn new(
mut stream: WsStream,
idle_timeout: Duration,
server_reasoning_included: bool,
server_model: Option<String>,
telemetry: Option<Arc<dyn WebsocketTelemetry>>,
) -> Self {
let routing_affinity = stream.routing_affinity.take();
Self {
stream: Arc::new(Mutex::new(Some(stream))),
idle_timeout,
server_reasoning_included,
server_model,
telemetry,
routing_affinity,
}
}
pub async fn is_closed(&self) -> bool {
self.stream
.lock()
.await
.as_ref()
.is_none_or(|stream| stream.pump_task.is_finished())
}
pub async fn stream_request(
&self,
request: ResponsesWsRequest<'_>,
connection_reused: bool,
turn_state: Option<Arc<OnceLock<String>>>,
) -> Result<ResponseStream, ApiError> {
self.stream_request_with_observer(request, connection_reused, turn_state, |_| {})
.await
}
/// Gives the observer a shared copy of the exact JSON before transport dispatch.
#[instrument(
name = "responses_websocket.stream_request",
level = "info",
skip_all,
fields(transport = "responses_websocket", api.path = "/responses")
)]
pub async fn stream_request_with_observer(
&self,
request: ResponsesWsRequest<'_>,
connection_reused: bool,
turn_state: Option<Arc<OnceLock<String>>>,
on_encoded: impl FnOnce(&bytes::Bytes),
) -> Result<ResponseStream, ApiError> {
let (tx_event, rx_event) =
mpsc::channel::<std::result::Result<ResponseEvent, ApiError>>(1600);
let (tx_interrupt, rx_interrupt) = oneshot::channel();
let stream = Arc::clone(&self.stream);
let idle_timeout = self.idle_timeout;
let server_reasoning_included = self.server_reasoning_included;
let server_model = self.server_model.clone();
let telemetry = self.telemetry.clone();
let ResponsesWsRequest::ResponseCreate(ws_request) = &request;
let client_metadata = ws_request.client_metadata.as_ref();
let timing_log_context = ResponsesWebsocketTimingLogContext {
model: ws_request.model.to_string(),
session_id: client_metadata
.and_then(|metadata| metadata.get(SESSION_ID_CLIENT_METADATA_KEY))
.cloned(),
thread_id: client_metadata
.and_then(|metadata| metadata.get(THREAD_ID_CLIENT_METADATA_KEY))
.cloned(),
turn_id: client_metadata
.and_then(|metadata| metadata.get(TURN_ID_CLIENT_METADATA_KEY))
.cloned(),
traceparent: client_metadata
.and_then(|metadata| {
metadata.get(WS_REQUEST_HEADER_TRACEPARENT_CLIENT_METADATA_KEY)
})
.cloned(),
previous_response_id: ws_request.previous_response_id.clone(),
request_start_ms: client_metadata
.and_then(|metadata| metadata.get(WS_STREAM_REQUEST_START_MS_CLIENT_METADATA_KEY))
.cloned(),
warmup: ws_request.generate == Some(false),
connection_reused,
};
let request_text = Utf8Bytes::from(serialize_websocket_request(&request)?);
on_encoded(request_text.as_ref());
let current_span = Span::current();
tokio::spawn(
#[expect(
clippy::await_holding_invalid_type,
reason = "the guard serializes exclusive use of the websocket stream for the lifetime of the response stream"
)]
async move {
if let Some(model) = server_model {
let _ = tx_event.send(Ok(ResponseEvent::ServerModel(model))).await;
}
if server_reasoning_included {
let _ = tx_event
.send(Ok(ResponseEvent::ServerReasoningIncluded(true)))
.await;
}
// Abandoned work has a cleanup deadline; ordinary steering preserves the response.
let interrupt = async move {
match rx_interrupt.await {
Ok(interrupt) => interrupt,
Err(_) => std::future::pending().await,
}
}
.shared();
let interrupt_timeout = async {
match interrupt.clone().await {
ResponseInterrupt::Drain => std::future::pending().await,
ResponseInterrupt::Cancel { deadline } => {
tokio::time::sleep_until(deadline).await;
}
}
};
tokio::pin!(interrupt_timeout);
let mut guard = tokio::select! {
biased;
_ = tx_event.closed() => return,
() = &mut interrupt_timeout => {
let _ = tx_event.send(Err(ApiError::Stream(
"timed out draining interrupted response".into(),
))).await;
return;
}
guard = stream.lock() => guard,
};
if tx_event.is_closed() {
return;
}
let Some(mut ws_stream) = guard.take() else {
let _ = tx_event
.send(Err(ApiError::Stream(
"websocket connection is closed".to_string(),
)))
.await;
return;
};
let mut completion = None;
let result = {
let response = run_websocket_response_stream(
&mut ws_stream,
tx_event.clone(),
request_text,
idle_timeout,
telemetry,
turn_state.as_deref(),
&timing_log_context,
interrupt.clone(),
&mut completion,
);
tokio::pin!(response);
tokio::select! {
biased;
result = &mut response => result,
() = &mut interrupt_timeout => Err(ApiError::Stream(
"timed out draining interrupted response".into(),
)),
() = tx_event.closed() => {
// Release the lock so later requests can open a new connection
// while this task finishes cleanup on the detached socket.
drop(guard);
if matches!(
interrupt.clone().now_or_never(),
Some(ResponseInterrupt::Cancel { .. })
) {
tokio::select! {
_ = &mut response => {}
() = &mut interrupt_timeout => {}
}
}
return;
}
}
};
if let Err(err) = result {
// A terminal stream error should reach the caller immediately. Waiting for a
// graceful close handshake here can stall indefinitely and mask the error.
drop(guard);
drop(ws_stream);
// Failed cancellation retires the socket while preserving any received
// completion and its usage for the abandoned classifier's cleanup.
let event = completion.map_or_else(|| Err(err), Ok);
let _ = tx_event.send(event).await;
} else {
*guard = Some(ws_stream);
if let Some(completed) = completion {
// The handshake is finished. Consumer backpressure must not let the
// interruption deadline discard completion or its usage accounting.
drop(guard);
let _ = tx_event.send(Ok(completed)).await;
}
}
}
.instrument(current_span),
);
Ok(ResponseStream {
rx_event,
upstream_request_id: None,
routing_affinity: self.routing_affinity.clone(),
interrupt: Some(tx_interrupt),
})
}
}
mod connector;
/// Client for connecting to the Responses WebSocket endpoint for one provider.
pub struct ResponsesWebsocketClient {
provider: Provider,
auth: SharedAuthProvider,
}
impl ResponsesWebsocketClient {
/// Creates a Responses WebSocket client for an already-resolved provider and auth source.
pub fn new(provider: Provider, auth: SharedAuthProvider) -> Self {
Self { provider, auth }
}
pub async fn connect(
&self,
http_client_factory: &HttpClientFactory,
extra_headers: HeaderMap,
default_headers: HeaderMap,
turn_state: Option<Arc<OnceLock<String>>>,
telemetry: Option<Arc<dyn WebsocketTelemetry>>,
) -> Result<ResponsesWebsocketConnection, ApiError> {
let connector = WebSocketConnector::new(http_client_factory)
.map_err(|err| ApiError::Stream(format!("failed to configure websocket TLS: {err}")))?;
self.connect_with_connector(
&connector,
extra_headers,
default_headers,
turn_state,
telemetry,
)
.await
}
/// Opens a WebSocket connection long enough to validate the upgrade response.
///
/// The probe uses the same URL construction, headers, authentication, TLS,
/// and custom-CA path as a real Responses WebSocket connection, but it does
/// not send a request frame. After the HTTP 101 upgrade succeeds, it waits
/// briefly for an immediate server close frame so diagnostics can distinguish
/// a usable connection from a policy rejection that closes right away.
pub async fn probe_handshake(
&self,
http_client_factory: &HttpClientFactory,
extra_headers: HeaderMap,
default_headers: HeaderMap,
immediate_close_timeout: Duration,
) -> Result<ResponsesWebsocketProbe, ResponsesWebsocketProbeError> {
let ws_url = self
.provider
.websocket_url_for_path(RESPONSES_PATH)
.map_err(|err| {
ResponsesWebsocketProbeError::before_upgrade(
ApiError::Stream(format!("failed to build websocket URL: {err}")),
ResponsesWebsocketProbeFailureStage::Unknown,
)
})?;
let headers = merge_request_headers(&self.provider.headers, extra_headers, default_headers);
let headers = self.auth.apply_auth_headers(headers).await.map_err(|err| {
ResponsesWebsocketProbeError::before_upgrade(
err.into(),
ResponsesWebsocketProbeFailureStage::Unknown,
)
})?;
let connector = WebSocketConnector::new(http_client_factory).map_err(|err| {
ResponsesWebsocketProbeError::before_upgrade(
ApiError::Stream(format!("failed to configure websocket TLS: {err}")),
ResponsesWebsocketProbeFailureStage::Tls,
)
})?;
let (mut stream, response, reasoning_included, server_model) = connect_websocket(
ws_url.clone(),
headers,
&connector,
/*turn_state*/ None,
)
.await?;
let status = response.status();
let mut headers = HeaderMap::new();
for name in [
"x-request-id",
"x-oai-request-id",
"cf-ray",
"x-ms-request-id",
] {
for value in response.headers().get_all(name) {
headers.append(name, value.clone());
}
}
let immediate_close = tokio::time::timeout(immediate_close_timeout, stream.next())
.await
.ok()
.flatten()
.transpose()
.map_err(|error| ResponsesWebsocketProbeError {
error: Box::new(map_ws_stream_error(error)),
stage: ResponsesWebsocketProbeFailureStage::Unknown,
status: Some(status),
headers: Some(headers.clone()),
})?
.and_then(immediate_close_from_message);
Ok(ResponsesWebsocketProbe {
url: ws_url.to_string(),
status,
headers,
reasoning_included,
server_model_present: server_model.is_some(),
immediate_close,
})
}
}
fn immediate_close_from_message(message: Message) -> Option<ResponsesWebsocketClose> {
let Message::Close(frame) = message else {
return None;
};
Some(match frame {
Some(frame) => close_frame_to_probe(frame),
None => ResponsesWebsocketClose {
code: "1005".to_string(),
reason: String::new(),
},
})
}
fn close_frame_to_probe(frame: CloseFrame) -> ResponsesWebsocketClose {
ResponsesWebsocketClose {
code: frame.code.to_string(),
reason: frame.reason.to_string(),
}
}
fn merge_request_headers(
provider_headers: &HeaderMap,
extra_headers: HeaderMap,
default_headers: HeaderMap,
) -> HeaderMap {
let mut headers = provider_headers.clone();
headers.extend(extra_headers);
for (name, value) in &default_headers {
if let http::header::Entry::Vacant(entry) = headers.entry(name) {
entry.insert(value.clone());
}
}
headers
}
async fn connect_websocket(
url: Url,
headers: HeaderMap,
connector: &WebSocketConnector,
turn_state: Option<Arc<OnceLock<String>>>,
) -> Result<(WsStream, Response, bool, Option<String>), ResponsesWebsocketProbeError> {
info!("connecting to Responses WebSocket");
let mut request = url.as_str().into_client_request().map_err(|err| {
ResponsesWebsocketProbeError::before_upgrade(
ApiError::Stream(format!("failed to build websocket request: {err}")),
ResponsesWebsocketProbeFailureStage::Unknown,
)
})?;
request.headers_mut().extend(headers);
let response = connector.connect(request, websocket_config()).await;
let (stream, response) = match response {
Ok((stream, response)) => {
info!(
status = response.status().as_u16(),
"successfully connected to Responses WebSocket"
);
(stream, response)
}
Err(err) => {
// Tokio-rustls wraps certificate failures in I/O errors.
let is_tls = match &err {
WsError::Tls(_) => true,
WsError::Io(error) => {
matches!(error.get_ref(), Some(source) if source.is::<rustls::Error>())
}
_ => false,
};
let stage = if is_tls {
ResponsesWebsocketProbeFailureStage::Tls
} else {
ResponsesWebsocketProbeFailureStage::Unknown
};
error!(?stage, "failed to connect to Responses WebSocket");
return Err(ResponsesWebsocketProbeError::before_upgrade(
map_ws_error(err, &url),
stage,
));
}
};
let max_message_bytes = response
.headers()
.get(X_CODEX_WEBSOCKET_MAX_MESSAGE_BYTES_HEADER)
.and_then(|value| value.to_str().ok())
.and_then(|value| value.parse::<usize>().ok());
let reasoning_included = response.headers().contains_key(X_REASONING_INCLUDED_HEADER);
let server_model = response
.headers()
.get(OPENAI_MODEL_HEADER)
.and_then(|value| value.to_str().ok())
.map(ToString::to_string);
if let Some(turn_state) = turn_state
&& let Some(header_value) = response
.headers()
.get(X_CODEX_TURN_STATE_HEADER)
.and_then(|value| value.to_str().ok())
{
let _ = turn_state.set(header_value.to_string());
}
Ok((
WsStream::new(stream, max_message_bytes),
response,
reasoning_included,
server_model,
))
}
fn websocket_config() -> WebSocketConfig {
let mut extensions = ExtensionsConfig::default();
extensions.permessage_deflate = Some(DeflateConfig::default());
let mut config = WebSocketConfig::default();
config.extensions = extensions;
config
}
fn map_ws_stream_error(error: WsError) -> ApiError {
match codex_websocket_client::network_policy_denial(&error) {
Some(denied) => ApiError::Transport(TransportError::Policy(denied)),
None => ApiError::Stream(error.to_string()),
}
}
fn map_ws_error(err: WsError, url: &Url) -> ApiError {
if let Some(denied) = codex_websocket_client::network_policy_denial(&err) {
return ApiError::Transport(TransportError::Policy(denied));
}
match err {
WsError::Http(response) => {
let status = response.status();
let headers = response.headers().clone();
let retry_after = RetryAfter::from_headers(&headers);
let body = response
.body()
.as_ref()
.and_then(|bytes| String::from_utf8(bytes.clone()).ok());
ApiError::Transport(TransportError::Http {
status,
url: Some(url.to_string()),
headers: Some(headers),
body,
retry_after,
})
}
WsError::ConnectionClosed | WsError::AlreadyClosed => {
ApiError::Stream("websocket closed".to_string())
}
WsError::Io(err) => ApiError::Transport(TransportError::Network(err.to_string())),
other => ApiError::Transport(TransportError::Network(other.to_string())),
}
}
#[derive(Debug, Deserialize)]
struct WrappedWebsocketError {
code: Option<String>,
message: Option<String>,
#[serde(default)]
headers: Option<Value>,
}
#[derive(Debug, Deserialize)]
struct WrappedWebsocketErrorEvent {
#[serde(rename = "type")]
kind: String,
#[serde(alias = "status_code")]
status: Option<u16>,
#[serde(default)]
error: Option<WrappedWebsocketError>,
#[serde(default)]
headers: Option<JsonMap<String, Value>>,
}
fn parse_wrapped_websocket_error_event(payload: &str) -> Option<WrappedWebsocketErrorEvent> {
let event: WrappedWebsocketErrorEvent = serde_json::from_str(payload).ok()?;
if event.kind != "error" {
return None;
}
Some(event)
}
fn map_wrapped_websocket_error_event(
event: WrappedWebsocketErrorEvent,
original_payload: String,
) -> Option<ApiError> {
let WrappedWebsocketErrorEvent {
status,
error,
headers,
..
} = event;
let retry_after = [
error
.as_ref()
.and_then(|error| error.headers.as_ref())
.and_then(Value::as_object),
headers.as_ref(),
]
.into_iter()
.flatten()
.find_map(|headers| RetryAfter::from_headers(&json_headers_to_http_headers(headers)));
if let Some(error) = error.as_ref()
&& let Some(code) = error.code.as_deref()
&& let Some(fallback_message) = match code {
WEBSOCKET_CONNECTION_LIMIT_REACHED_CODE => {
Some(WEBSOCKET_CONNECTION_LIMIT_REACHED_MESSAGE)
}
PREVIOUS_RESPONSE_NOT_FOUND_CODE => Some(PREVIOUS_RESPONSE_NOT_FOUND_MESSAGE),
_ => None,
}
{
return Some(ApiError::Retryable {
message: error
.message
.clone()
.unwrap_or_else(|| fallback_message.to_string()),
retry_after,
});
}
let status = StatusCode::from_u16(status?).ok()?;
if status.is_success() {
return None;
}
Some(ApiError::Transport(TransportError::Http {
status,
url: None,
headers: headers.as_ref().map(json_headers_to_http_headers),
body: Some(original_payload),
retry_after,
}))
}
#[derive(Deserialize)]
struct InterruptAcknowledgement {
response_id: String,
}
fn is_websocket_receive_failure(
response: &Result<Option<Result<Message, WsError>>, ApiError>,
) -> bool {
match response {
Ok(Some(Ok(message))) => match message {
Message::Text(_) | Message::Ping(_) | Message::Pong(_) => false,
Message::Binary(_) | Message::Close(_) | Message::Frame(_) => true,
},
Ok(Some(Err(_))) | Ok(None) | Err(_) => true,
}
}
#[allow(clippy::too_many_arguments)]
async fn run_websocket_response_stream(
ws_stream: &mut WsStream,
tx_event: mpsc::Sender<std::result::Result<ResponseEvent, ApiError>>,
request_text: Utf8Bytes,
idle_timeout: Duration,
telemetry: Option<Arc<dyn WebsocketTelemetry>>,
turn_state: Option<&OnceLock<String>>,
timing_log_context: &ResponsesWebsocketTimingLogContext,
interrupt: impl Future<Output = ResponseInterrupt> + Clone + Unpin,
completion: &mut Option<ResponseEvent>,
) -> Result<(), ApiError> {
let mut last_server_model: Option<String> = None;
let mut safety_buffering_treatment = SafetyBufferingTreatment::default();
if matches!(
interrupt.clone().now_or_never(),
Some(ResponseInterrupt::Cancel { .. })
) {
// No request reached the backend, so this socket is still reusable.
return Ok(());
}
send_websocket_request(
ws_stream,
request_text,
idle_timeout,
telemetry.as_ref(),
timing_log_context.connection_reused,
)
.await?;
// A response owns its interrupt, and create must be sent before interrupt.
let mut interrupt_request = interrupt.clone().fuse();
let mut interruption = None;
let mut response_id = None;
let mut received_text = false;
let mut awaiting_interrupt_ack = false;
loop {
let poll_start = Instant::now();
let response = tokio::select! {
response = tokio::time::timeout(idle_timeout, ws_stream.next()) => {
response.map_err(|_| ApiError::Stream("idle timeout waiting for websocket".into()))
}
request = &mut interrupt_request, if response_id.is_some() => {
interruption = Some(request);
send_websocket_request(
ws_stream,
serde_json::json!({
"type": "response.interrupt",
"response_id": response_id,
"mode": "discard_partial_items",
}).to_string().into(),
idle_timeout,
/*telemetry*/ None,
timing_log_context.connection_reused,
)
.await?;
awaiting_interrupt_ack = matches!(request, ResponseInterrupt::Cancel { .. });
continue;
}
};
let poll_duration = poll_start.elapsed();
if let Some(telemetry) = &telemetry
&& is_websocket_receive_failure(&response)
{
telemetry.on_ws_receive_failure(poll_duration);
}
let message = match response {
Ok(Some(Ok(msg))) => msg,
Ok(Some(Err(err))) => {
return Err(map_ws_stream_error(err));
}
Ok(None) => {
return Err(ApiError::Stream(
"stream closed before response.completed".into(),
));
}
Err(err) => {
return Err(err);
}
};
match message {
Message::Text(text) => {
received_text = true;
let event = serde_json::from_str::<ResponsesStreamEvent>(&text);
let kind = event.as_ref().ok().map(ResponsesStreamEvent::kind);
if let Some(t) = telemetry.as_ref() {
t.on_ws_text_event(&text, kind, poll_duration);
}
// A wrapped error can still be valid when an unrelated stream field is malformed.
if matches!(kind, Some("error") | None)
&& let Some(wrapped_error) = parse_wrapped_websocket_error_event(&text)
&& let Some(error) =
map_wrapped_websocket_error_event(wrapped_error, text.to_string())
{
return Err(error);
}
let event = match event {
Ok(event) => event,
Err(err) => {
debug!("failed to parse websocket event: {err}, data: {text}");
continue;
}
};
if matches!(interruption, Some(ResponseInterrupt::Cancel { .. }))
&& matches!(
event.kind(),
"response.interrupt.accepted" | "response.interrupt.failed"
)
{
let acknowledgement: InterruptAcknowledgement = serde_json::from_str(&text)
.map_err(|_| {
ApiError::Stream("invalid interruption acknowledgement".into())
})?;
if !awaiting_interrupt_ack
|| response_id.as_ref() != Some(&acknowledgement.response_id)
{
return Err(ApiError::Stream(
"unexpected interruption acknowledgement".into(),
));
}
if event.kind() == "response.interrupt.failed" {
return Err(ApiError::Stream(
"response interruption was rejected".into(),
));
}
awaiting_interrupt_ack = false;
if completion.is_some() {
break;
}
continue;
}
emit_responses_websocket_timing_event(
event.kind(),
text.as_str(),
timing_log_context,
);
if event.kind() == "codex.response.metadata"
&& let Some(etag) =
event
.headers
.as_ref()
.and_then(Value::as_object)
.and_then(|headers| {
json_headers_to_http_headers(headers)
.get(X_MODELS_ETAG_HEADER)
.and_then(|value| value.to_str().ok())
.map(str::to_string)
})
{
let _ = tx_event.send(Ok(ResponseEvent::ModelsEtag(etag))).await;
}
if let Some(response_turn_state) = event.turn_state()
&& let Some(turn_state) = turn_state
{
let _ = turn_state.set(response_turn_state);
}
let safety_buffering =
safety_buffering_for_event(&event, &mut safety_buffering_treatment);
let metadata_events = event.metadata_events(safety_buffering);