From c8e7500321bbfae96e2cbed4c65d9f5066506636 Mon Sep 17 00:00:00 2001 From: Charles Cunningham Date: Fri, 6 Mar 2026 10:01:24 -0800 Subject: [PATCH] codex: clarify rollout request id field name Rename the response stream field to request_id_for_rollout_log so its purpose is explicit at the call sites. Co-authored-by: Codex --- codex-rs/codex-api/src/common.rs | 2 +- codex-rs/codex-api/src/endpoint/responses_websocket.rs | 2 +- codex-rs/codex-api/src/sse/responses.rs | 9 ++++++--- codex-rs/core/src/client.rs | 4 ++-- codex-rs/core/src/client_common.rs | 2 +- codex-rs/core/src/codex.rs | 2 +- 6 files changed, 12 insertions(+), 9 deletions(-) diff --git a/codex-rs/codex-api/src/common.rs b/codex-rs/codex-api/src/common.rs index b749e70852..95d7339922 100644 --- a/codex-rs/codex-api/src/common.rs +++ b/codex-rs/codex-api/src/common.rs @@ -249,7 +249,7 @@ pub fn create_text_param_for_request( pub struct ResponseStream { pub rx_event: mpsc::Receiver>, - pub rollout_request_id: Option, + pub request_id_for_rollout_log: Option, } impl Stream for ResponseStream { diff --git a/codex-rs/codex-api/src/endpoint/responses_websocket.rs b/codex-rs/codex-api/src/endpoint/responses_websocket.rs index aa6852dddb..2dc3624bc2 100644 --- a/codex-rs/codex-api/src/endpoint/responses_websocket.rs +++ b/codex-rs/codex-api/src/endpoint/responses_websocket.rs @@ -271,7 +271,7 @@ impl ResponsesWebsocketConnection { // Websocket upgrade response headers are scoped to the connection, not // individual `stream_request` calls, so they cannot be used as per-turn // request IDs in rollout metadata. - rollout_request_id: None, + request_id_for_rollout_log: None, }) } } diff --git a/codex-rs/codex-api/src/sse/responses.rs b/codex-rs/codex-api/src/sse/responses.rs index 4783631d5c..f9f517d1ac 100644 --- a/codex-rs/codex-api/src/sse/responses.rs +++ b/codex-rs/codex-api/src/sse/responses.rs @@ -49,7 +49,7 @@ pub fn stream_from_fixture( tokio::spawn(process_sse(Box::pin(stream), tx_event, idle_timeout, None)); Ok(ResponseStream { rx_event, - rollout_request_id: None, + request_id_for_rollout_log: None, }) } @@ -104,7 +104,7 @@ pub fn spawn_response_stream( ResponseStream { rx_event, - rollout_request_id: request_id, + request_id_for_rollout_log: request_id, } } @@ -895,7 +895,10 @@ mod tests { }; let stream = spawn_response_stream(stream_response, idle_timeout(), None, None); - assert_eq!(stream.rollout_request_id.as_deref(), Some("req_123")); + assert_eq!( + stream.request_id_for_rollout_log.as_deref(), + Some("req_123") + ); } #[tokio::test] diff --git a/codex-rs/core/src/client.rs b/codex-rs/core/src/client.rs index 4e9b6018c2..fa07428a8a 100644 --- a/codex-rs/core/src/client.rs +++ b/codex-rs/core/src/client.rs @@ -1100,7 +1100,7 @@ fn map_response_stream( ) -> (ResponseStream, oneshot::Receiver) { let (tx_event, rx_event) = mpsc::channel::>(1600); let (tx_last_response, rx_last_response) = oneshot::channel::(); - let rollout_request_id = api_stream.rollout_request_id.clone(); + let request_id_for_rollout_log = api_stream.request_id_for_rollout_log.clone(); tokio::spawn(async move { let mut logged_error = false; @@ -1171,7 +1171,7 @@ fn map_response_stream( ( ResponseStream { rx_event, - rollout_request_id, + request_id_for_rollout_log, }, rx_last_response, ) diff --git a/codex-rs/core/src/client_common.rs b/codex-rs/core/src/client_common.rs index 4fc7a8bad8..3ac5b6b3ac 100644 --- a/codex-rs/core/src/client_common.rs +++ b/codex-rs/core/src/client_common.rs @@ -223,7 +223,7 @@ pub(crate) mod tools { pub struct ResponseStream { pub(crate) rx_event: mpsc::Receiver>, - pub(crate) rollout_request_id: Option, + pub(crate) request_id_for_rollout_log: Option, } impl Stream for ResponseStream { diff --git a/codex-rs/core/src/codex.rs b/codex-rs/core/src/codex.rs index 2d7091bf33..6df82f005c 100644 --- a/codex-rs/core/src/codex.rs +++ b/codex-rs/core/src/codex.rs @@ -6340,7 +6340,7 @@ async fn try_run_sampling_request( } Err(codex_async_utils::CancelErr::Cancelled) => return Err(CodexErr::TurnAborted), }; - if let Some(request_id) = stream.rollout_request_id.clone() { + if let Some(request_id) = stream.request_id_for_rollout_log.clone() { sess.send_event( &turn_context, EventMsg::ResponseMetadata(ResponseMetadataEvent {