//! Session- and turn-scoped helpers for talking to model provider APIs. //! //! `ModelClient` is intended to live for the lifetime of a Codex session and holds the stable //! configuration and state needed to talk to a provider (auth, provider selection, conversation id, //! and feature-gated request behavior). //! //! Per-turn settings (model selection, reasoning controls, telemetry context, and turn metadata) //! are passed explicitly to streaming and unary methods so that the turn lifetime is visible at the //! call site. //! //! A [`ModelClientSession`] is created per turn and is used to stream one or more Responses API //! requests during that turn. It caches a Responses WebSocket connection (opened lazily) and stores //! per-turn state such as the `x-codex-turn-state` token used for sticky routing. //! //! WebSocket prewarm is a v2-only `response.create` with `generate=false`; it waits for completion //! so the next request can reuse the same connection and `previous_response_id`. //! //! Turn execution performs prewarm as a best-effort step before the first stream request so the //! subsequent request can reuse the same connection. //! //! ## Retry-Budget Tradeoff //! //! WebSocket prewarm is treated as the first websocket connection attempt for a turn. If it //! fails, normal stream retry/fallback logic handles recovery on the same turn. use std::collections::HashMap; use std::sync::Arc; use std::sync::Mutex as StdMutex; use std::sync::OnceLock; use std::sync::atomic::AtomicBool; use std::sync::atomic::Ordering; use crate::api_bridge::CoreAuthProvider; use crate::api_bridge::auth_provider_from_auth; use crate::api_bridge::map_api_error; use crate::auth::UnauthorizedRecovery; use codex_api::CompactClient as ApiCompactClient; use codex_api::CompactionInput as ApiCompactionInput; use codex_api::MemoriesClient as ApiMemoriesClient; use codex_api::MemorySummarizeInput as ApiMemorySummarizeInput; use codex_api::MemorySummarizeOutput as ApiMemorySummarizeOutput; use codex_api::RawMemory as ApiRawMemory; use codex_api::RequestTelemetry; use codex_api::ReqwestTransport; use codex_api::ResponseCreateWsRequest; use codex_api::ResponsesApiRequest; use codex_api::ResponsesClient as ApiResponsesClient; use codex_api::ResponsesOptions as ApiResponsesOptions; use codex_api::ResponsesWebsocketClient as ApiWebSocketResponsesClient; use codex_api::ResponsesWebsocketConnection as ApiWebSocketConnection; use codex_api::SseTelemetry; use codex_api::TransportError; use codex_api::WebsocketTelemetry; use codex_api::build_conversation_headers; use codex_api::common::Reasoning; use codex_api::common::ResponsesWsRequest; use codex_api::create_text_param_for_request; use codex_api::error::ApiError; use codex_api::requests::responses::Compression; use codex_otel::OtelManager; use codex_protocol::ThreadId; use codex_protocol::config_types::ReasoningSummary as ReasoningSummaryConfig; use codex_protocol::config_types::ServiceTier; use codex_protocol::config_types::Verbosity as VerbosityConfig; use codex_protocol::models::ResponseItem; use codex_protocol::openai_models::ModelInfo; use codex_protocol::openai_models::ReasoningEffort as ReasoningEffortConfig; use codex_protocol::protocol::SessionSource; use eventsource_stream::Event; use eventsource_stream::EventStreamError; use futures::StreamExt; use http::HeaderMap as ApiHeaderMap; use http::HeaderValue; use http::StatusCode as HttpStatusCode; use reqwest::StatusCode; use std::time::Duration; use tokio::sync::mpsc; use tokio::sync::oneshot; use tokio::sync::oneshot::error::TryRecvError; use tokio_tungstenite::tungstenite::Error; use tokio_tungstenite::tungstenite::Message; use tracing::trace; use tracing::warn; use crate::AuthManager; use crate::auth::CodexAuth; use crate::auth::RefreshTokenError; use crate::client_common::Prompt; use crate::client_common::ResponseEvent; use crate::client_common::ResponseStream; use crate::config::Config; use crate::default_client::build_reqwest_client; use crate::error::CodexErr; use crate::error::Result; use crate::flags::CODEX_RS_SSE_FIXTURE; use crate::model_provider_info::ModelProviderInfo; use crate::model_provider_info::WireApi; use crate::tools::spec::create_tools_json_for_responses_api; pub const OPENAI_BETA_HEADER: &str = "OpenAI-Beta"; pub const X_CODEX_TURN_STATE_HEADER: &str = "x-codex-turn-state"; pub const X_CODEX_TURN_METADATA_HEADER: &str = "x-codex-turn-metadata"; pub const X_RESPONSESAPI_INCLUDE_TIMING_METRICS_HEADER: &str = "x-responsesapi-include-timing-metrics"; const RESPONSES_WEBSOCKETS_V2_BETA_HEADER_VALUE: &str = "responses_websockets=2026-02-06"; pub fn ws_version_from_features(config: &Config) -> bool { config .features .enabled(crate::features::Feature::ResponsesWebsockets) || config .features .enabled(crate::features::Feature::ResponsesWebsocketsV2) } /// Session-scoped state shared by all [`ModelClient`] clones. /// /// This is intentionally kept minimal so `ModelClient` does not need to hold a full `Config`. Most /// configuration is per turn and is passed explicitly to streaming/unary methods. #[derive(Debug)] struct ModelClientState { auth_manager: Option>, conversation_id: ThreadId, provider: ModelProviderInfo, session_source: SessionSource, model_verbosity: Option, responses_websockets_enabled_by_feature: bool, enable_request_compression: bool, include_timing_metrics: bool, beta_features_header: Option, disable_websockets: AtomicBool, cached_websocket_session: StdMutex, } /// Resolved API client setup for a single request attempt. /// /// Keeping this as a single bundle ensures prewarm and normal request paths /// share the same auth/provider setup flow. struct CurrentClientSetup { auth: Option, api_provider: codex_api::Provider, api_auth: CoreAuthProvider, } /// A session-scoped client for model-provider API calls. /// /// This holds configuration and state that should be shared across turns within a Codex session /// (auth, provider selection, conversation id, feature-gated request behavior, and transport /// fallback state). /// /// WebSocket fallback is session-scoped: once a turn activates the HTTP fallback, subsequent turns /// will also use HTTP for the remainder of the session. /// /// Turn-scoped settings (model selection, reasoning controls, telemetry context, and turn /// metadata) are passed explicitly to the relevant methods to keep turn lifetime visible at the /// call site. #[derive(Debug, Clone)] pub struct ModelClient { state: Arc, } /// A turn-scoped streaming session created from a [`ModelClient`]. /// /// The session establishes a Responses WebSocket connection lazily and reuses it across multiple /// requests within the turn. It also caches per-turn state: /// /// - The last full request, so subsequent calls can reuse incremental websocket request payloads /// only when the current request is an incremental extension of the previous one. /// - The `x-codex-turn-state` sticky-routing token, which must be replayed for all requests within /// the same turn. /// /// Create a fresh `ModelClientSession` for each Codex turn. Reusing it across turns would replay /// the previous turn's sticky-routing token into the next turn, which violates the client/server /// contract and can cause routing bugs. pub struct ModelClientSession { client: ModelClient, websocket_session: WebsocketSession, /// Turn state for sticky routing. /// /// This is an `OnceLock` that stores the turn state value received from the server /// on turn start via the `x-codex-turn-state` response header. Once set, this value /// should be sent back to the server in the `x-codex-turn-state` request header for /// all subsequent requests within the same turn to maintain sticky routing. /// /// This is a contract between the client and server: we receive it at turn start, /// keep sending it unchanged between turn requests (e.g., for retries, incremental /// appends, or continuation requests), and must not send it between different turns. turn_state: Arc>, } #[derive(Debug, Clone)] struct LastResponse { response_id: String, items_added: Vec, } #[derive(Debug, Default)] struct WebsocketSession { connection: Option, last_request: Option, last_response_rx: Option>, } enum WebsocketStreamOutcome { Stream(ResponseStream), FallbackToHttp, } impl ModelClient { #[allow(clippy::too_many_arguments)] /// Creates a new session-scoped `ModelClient`. /// /// All arguments are expected to be stable for the lifetime of a Codex session. Per-turn values /// are passed to [`ModelClientSession::stream`] (and other turn-scoped methods) explicitly. pub fn new( auth_manager: Option>, conversation_id: ThreadId, provider: ModelProviderInfo, session_source: SessionSource, model_verbosity: Option, responses_websockets_enabled_by_feature: bool, enable_request_compression: bool, include_timing_metrics: bool, beta_features_header: Option, ) -> Self { Self { state: Arc::new(ModelClientState { auth_manager, conversation_id, provider, session_source, model_verbosity, responses_websockets_enabled_by_feature, enable_request_compression, include_timing_metrics, beta_features_header, disable_websockets: AtomicBool::new(false), cached_websocket_session: StdMutex::new(WebsocketSession::default()), }), } } /// Creates a fresh turn-scoped streaming session. /// /// This constructor does not perform network I/O itself; the session opens a websocket lazily /// when the first stream request is issued. pub fn new_session(&self) -> ModelClientSession { ModelClientSession { client: self.clone(), websocket_session: self.take_cached_websocket_session(), turn_state: Arc::new(OnceLock::new()), } } fn take_cached_websocket_session(&self) -> WebsocketSession { let mut cached_websocket_session = self .state .cached_websocket_session .lock() .unwrap_or_else(std::sync::PoisonError::into_inner); std::mem::take(&mut *cached_websocket_session) } fn store_cached_websocket_session(&self, websocket_session: WebsocketSession) { *self .state .cached_websocket_session .lock() .unwrap_or_else(std::sync::PoisonError::into_inner) = websocket_session; } /// Compacts the current conversation history using the Compact endpoint. /// /// This is a unary call (no streaming) that returns a new list of /// `ResponseItem`s representing the compacted transcript. /// /// The model selection and telemetry context are passed explicitly to keep `ModelClient` /// session-scoped. pub async fn compact_conversation_history( &self, prompt: &Prompt, model_info: &ModelInfo, otel_manager: &OtelManager, ) -> Result> { if prompt.input.is_empty() { return Ok(Vec::new()); } let client_setup = self.current_client_setup().await?; let transport = ReqwestTransport::new(build_reqwest_client()); let request_telemetry = Self::build_request_telemetry(otel_manager); let client = ApiCompactClient::new(transport, client_setup.api_provider, client_setup.api_auth) .with_telemetry(Some(request_telemetry)); let instructions = prompt.base_instructions.text.clone(); let payload = ApiCompactionInput { model: &model_info.slug, input: &prompt.input, instructions: &instructions, }; let mut extra_headers = self.build_subagent_headers(); extra_headers.extend(build_conversation_headers(Some( self.state.conversation_id.to_string(), ))); client .compact_input(&payload, extra_headers) .await .map_err(map_api_error) } /// Builds memory summaries for each provided normalized raw memory. /// /// This is a unary call (no streaming) to `/v1/memories/trace_summarize`. /// /// The model selection, reasoning effort, and telemetry context are passed explicitly to keep /// `ModelClient` session-scoped. pub async fn summarize_memories( &self, raw_memories: Vec, model_info: &ModelInfo, effort: Option, otel_manager: &OtelManager, ) -> Result> { if raw_memories.is_empty() { return Ok(Vec::new()); } let client_setup = self.current_client_setup().await?; let transport = ReqwestTransport::new(build_reqwest_client()); let request_telemetry = Self::build_request_telemetry(otel_manager); let client = ApiMemoriesClient::new(transport, client_setup.api_provider, client_setup.api_auth) .with_telemetry(Some(request_telemetry)); let payload = ApiMemorySummarizeInput { model: model_info.slug.clone(), raw_memories, reasoning: effort.map(|effort| Reasoning { effort: Some(effort), summary: None, }), }; client .summarize_input(&payload, self.build_subagent_headers()) .await .map_err(map_api_error) } fn build_subagent_headers(&self) -> ApiHeaderMap { let mut extra_headers = ApiHeaderMap::new(); if let SessionSource::SubAgent(sub) = &self.state.session_source { let subagent = match sub { crate::protocol::SubAgentSource::Review => "review".to_string(), crate::protocol::SubAgentSource::Compact => "compact".to_string(), crate::protocol::SubAgentSource::MemoryConsolidation => { "memory_consolidation".to_string() } crate::protocol::SubAgentSource::ThreadSpawn { .. } => "collab_spawn".to_string(), crate::protocol::SubAgentSource::Other(label) => label.clone(), }; if let Ok(val) = HeaderValue::from_str(&subagent) { extra_headers.insert("x-openai-subagent", val); } } extra_headers } /// Builds request telemetry for unary API calls (e.g., Compact endpoint). fn build_request_telemetry(otel_manager: &OtelManager) -> Arc { let telemetry = Arc::new(ApiTelemetry::new(otel_manager.clone())); let request_telemetry: Arc = telemetry; request_telemetry } /// Returns whether the Responses-over-WebSocket transport is active for this session. /// /// This combines provider capability and feature gating; both must be true for websocket paths /// to be eligible. /// /// If websockets are only enabled via model preference (no explicit feature flag), prefer the /// current v2 behavior. pub fn responses_websocket_enabled(&self, model_info: &ModelInfo) -> bool { if !self.state.provider.supports_websockets || self.state.disable_websockets.load(Ordering::Relaxed) { return false; } self.state.responses_websockets_enabled_by_feature || model_info.prefer_websockets } /// Returns auth + provider configuration resolved from the current session auth state. /// /// This centralizes setup used by both prewarm and normal request paths so they stay in /// lockstep when auth/provider resolution changes. async fn current_client_setup(&self) -> Result { let auth = match self.state.auth_manager.as_ref() { Some(manager) => manager.auth().await, None => None, }; let api_provider = self .state .provider .to_api_provider(auth.as_ref().map(CodexAuth::auth_mode))?; let api_auth = auth_provider_from_auth(auth.clone(), &self.state.provider)?; Ok(CurrentClientSetup { auth, api_provider, api_auth, }) } /// Opens a websocket connection using the same header and telemetry wiring as normal turns. /// /// Both startup prewarm and in-turn `needs_new` reconnects call this path so handshake /// behavior remains consistent across both flows. async fn connect_websocket( &self, otel_manager: &OtelManager, api_provider: codex_api::Provider, api_auth: CoreAuthProvider, turn_state: Option>>, turn_metadata_header: Option<&str>, ) -> std::result::Result { let headers = self.build_websocket_headers(turn_state.as_ref(), turn_metadata_header); let websocket_telemetry = ModelClientSession::build_websocket_telemetry(otel_manager); ApiWebSocketResponsesClient::new(api_provider, api_auth) .connect( headers, crate::default_client::default_headers(), turn_state, Some(websocket_telemetry), ) .await } /// Builds websocket handshake headers for both prewarm and turn-time reconnect. /// /// Callers should pass the current turn-state lock when available so sticky-routing state is /// replayed on reconnect within the same turn. fn build_websocket_headers( &self, turn_state: Option<&Arc>>, turn_metadata_header: Option<&str>, ) -> ApiHeaderMap { let turn_metadata_header = parse_turn_metadata_header(turn_metadata_header); let mut headers = build_responses_headers( self.state.beta_features_header.as_deref(), turn_state, turn_metadata_header.as_ref(), ); headers.extend(build_conversation_headers(Some( self.state.conversation_id.to_string(), ))); headers.insert( OPENAI_BETA_HEADER, HeaderValue::from_static(RESPONSES_WEBSOCKETS_V2_BETA_HEADER_VALUE), ); if self.state.include_timing_metrics { headers.insert( X_RESPONSESAPI_INCLUDE_TIMING_METRICS_HEADER, HeaderValue::from_static("true"), ); } headers } } impl Drop for ModelClientSession { fn drop(&mut self) { let websocket_session = std::mem::take(&mut self.websocket_session); self.client .store_cached_websocket_session(websocket_session); } } impl ModelClientSession { fn activate_http_fallback(&self, websocket_enabled: bool) -> bool { websocket_enabled && !self .client .state .disable_websockets .swap(true, Ordering::Relaxed) } fn build_responses_request( &self, provider: &codex_api::Provider, prompt: &Prompt, model_info: &ModelInfo, effort: Option, summary: ReasoningSummaryConfig, service_tier: Option, ) -> Result { let instructions = &prompt.base_instructions.text; let input = prompt.get_formatted_input(); let tools = create_tools_json_for_responses_api(&prompt.tools)?; let default_reasoning_effort = model_info.default_reasoning_level; let reasoning = if model_info.supports_reasoning_summaries { Some(Reasoning { effort: effort.or(default_reasoning_effort), summary: if summary == ReasoningSummaryConfig::None { None } else { Some(summary) }, }) } else { None }; let include = if reasoning.is_some() { vec!["reasoning.encrypted_content".to_string()] } else { Vec::new() }; let verbosity = if model_info.support_verbosity { self.client .state .model_verbosity .or(model_info.default_verbosity) } else { if self.client.state.model_verbosity.is_some() { warn!( "model_verbosity is set but ignored as the model does not support verbosity: {}", model_info.slug ); } None }; let text = create_text_param_for_request(verbosity, &prompt.output_schema); let prompt_cache_key = Some(self.client.state.conversation_id.to_string()); let request = ResponsesApiRequest { model: model_info.slug.clone(), instructions: instructions.clone(), input, tools, tool_choice: "auto".to_string(), parallel_tool_calls: prompt.parallel_tool_calls, reasoning, store: provider.is_azure_responses_endpoint(), stream: true, include, service_tier: match service_tier { Some(ServiceTier::Fast) => Some("priority".to_string()), Some(service_tier) => Some(service_tier.to_string()), None => None, }, prompt_cache_key, text, }; Ok(request) } #[allow(clippy::too_many_arguments)] /// Builds shared Responses API transport options and request-body options. /// /// Keeping option construction in one place ensures request-scoped headers are consistent /// regardless of transport choice. fn build_responses_options( &self, turn_metadata_header: Option<&str>, compression: Compression, ) -> ApiResponsesOptions { let turn_metadata_header = parse_turn_metadata_header(turn_metadata_header); let conversation_id = self.client.state.conversation_id.to_string(); ApiResponsesOptions { conversation_id: Some(conversation_id), session_source: Some(self.client.state.session_source.clone()), extra_headers: build_responses_headers( self.client.state.beta_features_header.as_deref(), Some(&self.turn_state), turn_metadata_header.as_ref(), ), compression, turn_state: Some(Arc::clone(&self.turn_state)), } } fn get_incremental_items( &self, request: &ResponsesApiRequest, last_response: Option<&LastResponse>, allow_empty_delta: bool, ) -> Option> { // Checks whether the current request is an incremental extension of the previous request. // We only reuse an incremental input delta when non-input request fields are unchanged and // `input` is a strict // extension of the previous known input. Server-returned output items are treated as part // of the baseline so we do not resend them. let previous_request = self.websocket_session.last_request.as_ref()?; let mut previous_without_input = previous_request.clone(); previous_without_input.input.clear(); let mut request_without_input = request.clone(); request_without_input.input.clear(); if previous_without_input != request_without_input { trace!( "incremental request failed, properties didn't match {previous_without_input:?} != {request_without_input:?}" ); return None; } let mut baseline = previous_request.input.clone(); if let Some(last_response) = last_response { baseline.extend(last_response.items_added.clone()); } let baseline_len = baseline.len(); if request.input.starts_with(&baseline) && (allow_empty_delta || baseline_len < request.input.len()) { Some(request.input[baseline_len..].to_vec()) } else { trace!("incremental request failed, items didn't match"); None } } fn get_last_response(&mut self) -> Option { self.websocket_session .last_response_rx .take() .and_then(|mut receiver| match receiver.try_recv() { Ok(last_response) => Some(last_response), Err(TryRecvError::Closed) | Err(TryRecvError::Empty) => None, }) } fn prepare_websocket_request( &mut self, payload: ResponseCreateWsRequest, request: &ResponsesApiRequest, ) -> ResponsesWsRequest { let Some(last_response) = self.get_last_response() else { return ResponsesWsRequest::ResponseCreate(payload); }; let Some(incremental_items) = self.get_incremental_items(request, Some(&last_response), true) else { return ResponsesWsRequest::ResponseCreate(payload); }; if last_response.response_id.is_empty() { trace!("incremental request failed, no previous response id"); return ResponsesWsRequest::ResponseCreate(payload); } ResponsesWsRequest::ResponseCreate(ResponseCreateWsRequest { previous_response_id: Some(last_response.response_id), input: incremental_items, ..payload }) } /// Opportunistically preconnects a websocket for this turn-scoped client session. /// /// This performs only connection setup; it never sends prompt payloads. pub async fn preconnect_websocket( &mut self, otel_manager: &OtelManager, model_info: &ModelInfo, ) -> std::result::Result<(), ApiError> { if !self.client.responses_websocket_enabled(model_info) { return Ok(()); } if self.websocket_session.connection.is_some() { return Ok(()); } let client_setup = self.client.current_client_setup().await.map_err(|err| { ApiError::Stream(format!( "failed to build websocket prewarm client setup: {err}" )) })?; let connection = self .client .connect_websocket( otel_manager, client_setup.api_provider, client_setup.api_auth, Some(Arc::clone(&self.turn_state)), None, ) .await?; self.websocket_session.connection = Some(connection); Ok(()) } /// Returns a websocket connection for this turn. async fn websocket_connection( &mut self, otel_manager: &OtelManager, api_provider: codex_api::Provider, api_auth: CoreAuthProvider, turn_metadata_header: Option<&str>, options: &ApiResponsesOptions, ) -> std::result::Result<&ApiWebSocketConnection, ApiError> { let needs_new = match self.websocket_session.connection.as_ref() { Some(conn) => conn.is_closed().await, None => true, }; if needs_new { self.websocket_session.last_request = None; self.websocket_session.last_response_rx = None; let turn_state = options .turn_state .clone() .unwrap_or_else(|| Arc::clone(&self.turn_state)); let new_conn = self .client .connect_websocket( otel_manager, api_provider, api_auth, Some(turn_state), turn_metadata_header, ) .await?; self.websocket_session.connection = Some(new_conn); } self.websocket_session .connection .as_ref() .ok_or(ApiError::Stream( "websocket connection is unavailable".to_string(), )) } fn responses_request_compression(&self, auth: Option<&crate::auth::CodexAuth>) -> Compression { if self.client.state.enable_request_compression && auth.is_some_and(CodexAuth::is_chatgpt_auth) && self.client.state.provider.is_openai() { Compression::Zstd } else { Compression::None } } /// Streams a turn via the OpenAI Responses API. /// /// Handles SSE fixtures, reasoning summaries, verbosity, and the /// `text` controls used for output schemas. #[allow(clippy::too_many_arguments)] async fn stream_responses_api( &self, prompt: &Prompt, model_info: &ModelInfo, otel_manager: &OtelManager, effort: Option, summary: ReasoningSummaryConfig, service_tier: Option, turn_metadata_header: Option<&str>, ) -> Result { if let Some(path) = &*CODEX_RS_SSE_FIXTURE { warn!(path, "Streaming from fixture"); let stream = codex_api::stream_from_fixture( path, self.client.state.provider.stream_idle_timeout(), ) .map_err(map_api_error)?; let (stream, _last_request_rx) = map_response_stream(stream, otel_manager.clone()); return Ok(stream); } let auth_manager = self.client.state.auth_manager.clone(); let mut auth_recovery = auth_manager .as_ref() .map(super::auth::AuthManager::unauthorized_recovery); loop { let client_setup = self.client.current_client_setup().await?; let transport = ReqwestTransport::new(build_reqwest_client()); let (request_telemetry, sse_telemetry) = Self::build_streaming_telemetry(otel_manager); let compression = self.responses_request_compression(client_setup.auth.as_ref()); let options = self.build_responses_options(turn_metadata_header, compression); let request = self.build_responses_request( &client_setup.api_provider, prompt, model_info, effort, summary, service_tier, )?; let client = ApiResponsesClient::new( transport, client_setup.api_provider, client_setup.api_auth, ) .with_telemetry(Some(request_telemetry), Some(sse_telemetry)); let stream_result = client.stream_request(request, options).await; match stream_result { Ok(stream) => { let (stream, _) = map_response_stream(stream, otel_manager.clone()); return Ok(stream); } Err(ApiError::Transport( unauthorized_transport @ TransportError::Http { status, .. }, )) if status == StatusCode::UNAUTHORIZED => { handle_unauthorized(unauthorized_transport, &mut auth_recovery).await?; continue; } Err(err) => return Err(map_api_error(err)), } } } /// Streams a turn via the Responses API over WebSocket transport. #[allow(clippy::too_many_arguments)] async fn stream_responses_websocket( &mut self, prompt: &Prompt, model_info: &ModelInfo, otel_manager: &OtelManager, effort: Option, summary: ReasoningSummaryConfig, service_tier: Option, turn_metadata_header: Option<&str>, warmup: bool, ) -> Result { let auth_manager = self.client.state.auth_manager.clone(); let mut auth_recovery = auth_manager .as_ref() .map(super::auth::AuthManager::unauthorized_recovery); loop { let client_setup = self.client.current_client_setup().await?; let compression = self.responses_request_compression(client_setup.auth.as_ref()); let options = self.build_responses_options(turn_metadata_header, compression); let request = self.build_responses_request( &client_setup.api_provider, prompt, model_info, effort, summary, service_tier, )?; let mut ws_payload = ResponseCreateWsRequest { client_metadata: build_ws_client_metadata(turn_metadata_header), ..ResponseCreateWsRequest::from(&request) }; if warmup { ws_payload.generate = Some(false); } match self .websocket_connection( otel_manager, client_setup.api_provider, client_setup.api_auth, turn_metadata_header, &options, ) .await { Ok(_) => {} Err(ApiError::Transport(TransportError::Http { status, .. })) if status == StatusCode::UPGRADE_REQUIRED => { return Ok(WebsocketStreamOutcome::FallbackToHttp); } Err(ApiError::Transport( unauthorized_transport @ TransportError::Http { status, .. }, )) if status == StatusCode::UNAUTHORIZED => { handle_unauthorized(unauthorized_transport, &mut auth_recovery).await?; continue; } Err(err) => return Err(map_api_error(err)), } let ws_request = self.prepare_websocket_request(ws_payload, &request); self.websocket_session.last_request = Some(request); let stream_result = self .websocket_session .connection .as_ref() .ok_or_else(|| { map_api_error(ApiError::Stream( "websocket connection is unavailable".to_string(), )) })? .stream_request(ws_request) .await .map_err(map_api_error)?; let (stream, last_request_rx) = map_response_stream(stream_result, otel_manager.clone()); self.websocket_session.last_response_rx = Some(last_request_rx); return Ok(WebsocketStreamOutcome::Stream(stream)); } } /// Builds request and SSE telemetry for streaming API calls. fn build_streaming_telemetry( otel_manager: &OtelManager, ) -> (Arc, Arc) { let telemetry = Arc::new(ApiTelemetry::new(otel_manager.clone())); let request_telemetry: Arc = telemetry.clone(); let sse_telemetry: Arc = telemetry; (request_telemetry, sse_telemetry) } /// Builds telemetry for the Responses API WebSocket transport. fn build_websocket_telemetry(otel_manager: &OtelManager) -> Arc { let telemetry = Arc::new(ApiTelemetry::new(otel_manager.clone())); let websocket_telemetry: Arc = telemetry; websocket_telemetry } #[allow(clippy::too_many_arguments)] pub async fn prewarm_websocket( &mut self, prompt: &Prompt, model_info: &ModelInfo, otel_manager: &OtelManager, effort: Option, summary: ReasoningSummaryConfig, service_tier: Option, turn_metadata_header: Option<&str>, ) -> Result<()> { if !self.client.responses_websocket_enabled(model_info) { return Ok(()); } if self.websocket_session.last_request.is_some() { return Ok(()); } match self .stream_responses_websocket( prompt, model_info, otel_manager, effort, summary, service_tier, turn_metadata_header, true, ) .await { Ok(WebsocketStreamOutcome::Stream(mut stream)) => { // Wait for the v2 warmup request to complete before sending the first turn request. while let Some(event) = stream.next().await { match event { Ok(ResponseEvent::Completed { .. }) => break, Err(err) => return Err(err), _ => {} } } Ok(()) } Ok(WebsocketStreamOutcome::FallbackToHttp) => { self.try_switch_fallback_transport(otel_manager, model_info); Ok(()) } Err(err) => Err(err), } } #[allow(clippy::too_many_arguments)] /// Streams a single model request within the current turn. /// /// The caller is responsible for passing per-turn settings explicitly (model selection, /// reasoning settings, telemetry context, and turn metadata). This method will prefer the /// Responses WebSocket transport when enabled and healthy, and will fall back to the HTTP /// Responses API transport otherwise. pub async fn stream( &mut self, prompt: &Prompt, model_info: &ModelInfo, otel_manager: &OtelManager, effort: Option, summary: ReasoningSummaryConfig, service_tier: Option, turn_metadata_header: Option<&str>, ) -> Result { let wire_api = self.client.state.provider.wire_api; match wire_api { WireApi::Responses => { if self.client.responses_websocket_enabled(model_info) { match self .stream_responses_websocket( prompt, model_info, otel_manager, effort, summary, service_tier, turn_metadata_header, false, ) .await? { WebsocketStreamOutcome::Stream(stream) => return Ok(stream), WebsocketStreamOutcome::FallbackToHttp => { self.try_switch_fallback_transport(otel_manager, model_info); } } } self.stream_responses_api( prompt, model_info, otel_manager, effort, summary, service_tier, turn_metadata_header, ) .await } } } /// Permanently disables WebSockets for this Codex session and resets WebSocket state. /// /// This is used after exhausting the provider retry budget, to force subsequent requests onto /// the HTTP transport. /// /// Returns `true` if this call activated fallback, or `false` if fallback was already active. pub(crate) fn try_switch_fallback_transport( &mut self, otel_manager: &OtelManager, model_info: &ModelInfo, ) -> bool { let websocket_enabled = self.client.responses_websocket_enabled(model_info); let activated = self.activate_http_fallback(websocket_enabled); if activated { warn!("falling back to HTTP"); otel_manager.counter( "codex.transport.fallback_to_http", 1, &[("from_wire_api", "responses_websocket")], ); self.websocket_session.connection = None; self.websocket_session.last_request = None; self.websocket_session.last_response_rx = None; } activated } } /// Parses per-turn metadata into an HTTP header value. /// /// Invalid values are treated as absent so callers can compare and propagate /// metadata with the same sanitization path used when constructing headers. fn parse_turn_metadata_header(turn_metadata_header: Option<&str>) -> Option { turn_metadata_header.and_then(|value| HeaderValue::from_str(value).ok()) } fn build_ws_client_metadata(turn_metadata_header: Option<&str>) -> Option> { let turn_metadata_header = parse_turn_metadata_header(turn_metadata_header)?; let turn_metadata = turn_metadata_header.to_str().ok()?.to_string(); let mut client_metadata = HashMap::new(); client_metadata.insert(X_CODEX_TURN_METADATA_HEADER.to_string(), turn_metadata); Some(client_metadata) } /// Builds the extra headers attached to Responses API requests. /// /// These headers implement Codex-specific conventions: /// /// - `x-codex-beta-features`: comma-separated beta feature keys enabled for the session. /// - `x-codex-turn-state`: sticky routing token captured earlier in the turn. /// - `x-codex-turn-metadata`: optional per-turn metadata for observability. fn build_responses_headers( beta_features_header: Option<&str>, turn_state: Option<&Arc>>, turn_metadata_header: Option<&HeaderValue>, ) -> ApiHeaderMap { let mut headers = ApiHeaderMap::new(); if let Some(value) = beta_features_header && !value.is_empty() && let Ok(header_value) = HeaderValue::from_str(value) { headers.insert("x-codex-beta-features", header_value); } if let Some(turn_state) = turn_state && let Some(state) = turn_state.get() && let Ok(header_value) = HeaderValue::from_str(state) { headers.insert(X_CODEX_TURN_STATE_HEADER, header_value); } if let Some(header_value) = turn_metadata_header { headers.insert(X_CODEX_TURN_METADATA_HEADER, header_value.clone()); } headers } fn map_response_stream( api_stream: S, otel_manager: OtelManager, ) -> (ResponseStream, oneshot::Receiver) where S: futures::Stream> + Unpin + Send + 'static, { let (tx_event, rx_event) = mpsc::channel::>(1600); let (tx_last_response, rx_last_response) = oneshot::channel::(); tokio::spawn(async move { let mut logged_error = false; let mut tx_last_response = Some(tx_last_response); let mut items_added: Vec = Vec::new(); let mut api_stream = api_stream; while let Some(event) = api_stream.next().await { match event { Ok(ResponseEvent::OutputItemDone(item)) => { items_added.push(item.clone()); if tx_event .send(Ok(ResponseEvent::OutputItemDone(item))) .await .is_err() { return; } } Ok(ResponseEvent::Completed { response_id, token_usage, }) => { if let Some(usage) = &token_usage { otel_manager.sse_event_completed( usage.input_tokens, usage.output_tokens, Some(usage.cached_input_tokens), Some(usage.reasoning_output_tokens), usage.total_tokens, ); } if let Some(sender) = tx_last_response.take() { let _ = sender.send(LastResponse { response_id: response_id.clone(), items_added: std::mem::take(&mut items_added), }); } if tx_event .send(Ok(ResponseEvent::Completed { response_id, token_usage, })) .await .is_err() { return; } } Ok(event) => { if tx_event.send(Ok(event)).await.is_err() { return; } } Err(err) => { let mapped = map_api_error(err); if !logged_error { otel_manager.see_event_completed_failed(&mapped); logged_error = true; } if tx_event.send(Err(mapped)).await.is_err() { return; } } } } }); (ResponseStream { rx_event }, rx_last_response) } /// Handles a 401 response by optionally refreshing ChatGPT tokens once. /// /// When refresh succeeds, the caller should retry the API call; otherwise /// the mapped `CodexErr` is returned to the caller. async fn handle_unauthorized( transport: TransportError, auth_recovery: &mut Option, ) -> Result<()> { if let Some(recovery) = auth_recovery && recovery.has_next() { return match recovery.next().await { Ok(_) => Ok(()), Err(RefreshTokenError::Permanent(failed)) => Err(CodexErr::RefreshTokenFailed(failed)), Err(RefreshTokenError::Transient(other)) => Err(CodexErr::Io(other)), }; } Err(map_api_error(ApiError::Transport(transport))) } struct ApiTelemetry { otel_manager: OtelManager, } impl ApiTelemetry { fn new(otel_manager: OtelManager) -> Self { Self { otel_manager } } } impl RequestTelemetry for ApiTelemetry { fn on_request( &self, attempt: u64, status: Option, error: Option<&TransportError>, duration: Duration, ) { let error_message = error.map(std::string::ToString::to_string); self.otel_manager.record_api_request( attempt, status.map(|s| s.as_u16()), error_message.as_deref(), duration, ); } } impl SseTelemetry for ApiTelemetry { fn on_sse_poll( &self, result: &std::result::Result< Option>>, tokio::time::error::Elapsed, >, duration: Duration, ) { self.otel_manager.log_sse_event(result, duration); } } impl WebsocketTelemetry for ApiTelemetry { fn on_ws_request(&self, duration: Duration, error: Option<&ApiError>) { let error_message = error.map(std::string::ToString::to_string); self.otel_manager .record_websocket_request(duration, error_message.as_deref()); } fn on_ws_event( &self, result: &std::result::Result>, ApiError>, duration: Duration, ) { self.otel_manager.record_websocket_event(result, duration); } } #[cfg(test)] mod tests { use super::ModelClient; use codex_otel::OtelManager; use codex_protocol::ThreadId; use codex_protocol::openai_models::ModelInfo; use codex_protocol::protocol::SessionSource; use codex_protocol::protocol::SubAgentSource; use pretty_assertions::assert_eq; use serde_json::json; fn test_model_client(session_source: SessionSource) -> ModelClient { let provider = crate::model_provider_info::create_oss_provider_with_base_url( "https://example.com/v1", crate::model_provider_info::WireApi::Responses, ); ModelClient::new( None, ThreadId::new(), provider, session_source, None, false, false, false, None, ) } fn test_model_info() -> ModelInfo { serde_json::from_value(json!({ "slug": "gpt-test", "display_name": "gpt-test", "description": "desc", "default_reasoning_level": "medium", "supported_reasoning_levels": [ {"effort": "medium", "description": "medium"} ], "shell_type": "shell_command", "visibility": "list", "supported_in_api": true, "priority": 1, "upgrade": null, "base_instructions": "base instructions", "model_messages": null, "supports_reasoning_summaries": false, "support_verbosity": false, "default_verbosity": null, "apply_patch_tool_type": null, "truncation_policy": {"mode": "bytes", "limit": 10000}, "supports_parallel_tool_calls": false, "supports_image_detail_original": false, "context_window": 272000, "auto_compact_token_limit": null, "experimental_supported_tools": [] })) .expect("deserialize test model info") } fn test_otel_manager() -> OtelManager { OtelManager::new( ThreadId::new(), "gpt-test", "gpt-test", None, None, None, "test-originator".to_string(), false, "test-terminal".to_string(), SessionSource::Cli, ) } #[test] fn build_subagent_headers_sets_other_subagent_label() { let client = test_model_client(SessionSource::SubAgent(SubAgentSource::Other( "memory_consolidation".to_string(), ))); let headers = client.build_subagent_headers(); let value = headers .get("x-openai-subagent") .and_then(|value| value.to_str().ok()); assert_eq!(value, Some("memory_consolidation")); } #[tokio::test] async fn summarize_memories_returns_empty_for_empty_input() { let client = test_model_client(SessionSource::Cli); let model_info = test_model_info(); let otel_manager = test_otel_manager(); let output = client .summarize_memories(Vec::new(), &model_info, None, &otel_manager) .await .expect("empty summarize request should succeed"); assert_eq!(output.len(), 0); } }