Lightweight coding agent that runs in your terminal
Rust
Support request IDs in exec-server WebSocket handshakes (#52234)
mattj-openai54685110a730
diff --git a/codex-rs/app-server-protocol/schema/precomputed/app-server-exports-experimental.json.zst b/codex-rs/app-server-protocol/schema/precomputed/app-server-exports-experimental.json.zstindex 6d496070a3..c9b39369e9 100644Binary files a/codex-rs/app-server-protocol/schema/precomputed/app-server-exports-experimental.json.zst and b/codex-rs/app-server-protocol/schema/precomputed/app-server-exports-experimental.json.zst differdiff --git a/codex-rs/app-server-protocol/src/protocol/common.rs b/codex-rs/app-server-protocol/src/protocol/common.rsindex 3e73b44fff..4cc1fde439 100644--- a/codex-rs/app-server-protocol/src/protocol/common.rs+++ b/codex-rs/app-server-protocol/src/protocol/common.rs@@ -2590,6 +2590,7 @@ mod tests {params: v2::EnvironmentAddParams {skills: None,auth_bearer_token: None,+ websocket_request_id: None,environment_id: "remote-a".to_string(),exec_server_url: "ws://127.0.0.1:8765".to_string(),connect_timeout_ms: None,@@ -3845,6 +3846,7 @@ mod tests {params: v2::EnvironmentAddParams {skills: None,auth_bearer_token: Some("private-executor-token".into()),+ websocket_request_id: Some("caller-sample-id".to_string()),environment_id: "remote-a".to_string(),exec_server_url: "ws://127.0.0.1:8765".to_string(),connect_timeout_ms: Some(300_000),@@ -3860,6 +3862,7 @@ mod tests {"execServerUrl": "ws://127.0.0.1:8765","connectTimeoutMs": 300000,"authBearerToken": "private-executor-token",+ "websocketRequestId": "caller-sample-id","skills": null}}),@@ -4387,6 +4390,7 @@ mod tests {params: v2::EnvironmentAddParams {skills: None,auth_bearer_token: None,+ websocket_request_id: None,environment_id: "remote-a".to_string(),exec_server_url: "ws://127.0.0.1:8765".to_string(),connect_timeout_ms: None,diff --git a/codex-rs/app-server-protocol/src/protocol/v2/environment.rs b/codex-rs/app-server-protocol/src/protocol/v2/environment.rsindex 24cb1d5b51..3794780c18 100644--- a/codex-rs/app-server-protocol/src/protocol/v2/environment.rs+++ b/codex-rs/app-server-protocol/src/protocol/v2/environment.rs@@ -43,6 +43,10 @@ pub struct EnvironmentAddParams {#[ts(type = "string | null")]#[ts(optional = nullable)]pub auth_bearer_token: Option<RedactedString>,+ /// Optional X-Request-ID for the direct WebSocket upgrade, including reconnects.+ /// Requires a secure transport or a loopback destination.+ #[ts(optional = nullable)]+ pub websocket_request_id: Option<String>,/// Optional WebSocket connection timeout. The server default applies when omitted.#[ts(type = "number | null")]#[ts(optional = nullable)]diff --git a/codex-rs/app-server/src/request_processors/environment_processor.rs b/codex-rs/app-server/src/request_processors/environment_processor.rsindex 991de9b1c2..4bd80d12b4 100644--- a/codex-rs/app-server/src/request_processors/environment_processor.rs+++ b/codex-rs/app-server/src/request_processors/environment_processor.rs@@ -37,6 +37,11 @@ impl EnvironmentRequestProcessor {format!("Bearer {}", token.into_inner()),)})+ .chain(+ params+ .websocket_request_id+ .map(|request_id| ("X-Request-ID".to_string(), request_id)),+ ).collect(),};self.environment_managerdiff --git a/codex-rs/app-server/tests/suite/v2/environment_info.rs b/codex-rs/app-server/tests/suite/v2/environment_info.rsindex 4acc494493..20842a0470 100644--- a/codex-rs/app-server/tests/suite/v2/environment_info.rs+++ b/codex-rs/app-server/tests/suite/v2/environment_info.rs@@ -17,8 +17,11 @@ use serde_json::json;use tempfile::TempDir;use tokio::net::TcpListener;use tokio::time::timeout;-use tokio_tungstenite::accept_async;+use tokio_tungstenite::accept_hdr_async;use tokio_tungstenite::tungstenite::Message;+use tokio_tungstenite::tungstenite::handshake::server::Request as HandshakeRequest;+use tokio_tungstenite::tungstenite::handshake::server::Response as HandshakeResponse;+use tokio_tungstenite::tungstenite::http::HeaderValue;use super::exec_server_test_support::accept_exec_server_environment;use super::exec_server_test_support::read_exec_server_json;@@ -27,13 +30,27 @@ const RPC_TIMEOUT: Duration = Duration::from_secs(10);const INVALID_REQUEST_ERROR_CODE: i64 = -32600;const INTERNAL_ERROR_CODE: i64 = -32603;+#[test_case::test_case(None; "absent_websocket_request_id")]+#[test_case::test_case(Some("caller-sample-id"); "supplied_websocket_request_id")]#[tokio::test]-async fn environment_info_probes_executor_even_when_metadata_is_cached() -> Result<()> {+async fn environment_info_probes_executor_even_when_metadata_is_cached(+ websocket_request_id: Option<&'static str>,+) -> Result<()> {let listener = TcpListener::bind("127.0.0.1:0").await?;let exec_server_url = format!("ws://{}", listener.local_addr()?);let exec_server = tokio::spawn(async move {let (stream, _) = listener.accept().await?;- let mut websocket = accept_async(stream).await?;+ let mut websocket = accept_hdr_async(+ stream,+ move |request: &HandshakeRequest, response: HandshakeResponse| {+ assert_eq!(+ request.headers().get("x-request-id"),+ websocket_request_id.map(HeaderValue::from_static).as_ref()+ );+ Ok(response)+ },+ )+ .await?;let initialize = read_exec_server_json(&mut websocket).await?;assert_eq!(initialize["method"], "initialize");let response = json!({@@ -68,6 +85,7 @@ async fn environment_info_probes_executor_even_when_metadata_is_cached() -> Resu&mut app_server,&exec_server_url,/*connect_timeout_ms*/ None,+ websocket_request_id,).await?;@@ -123,6 +141,7 @@ async fn environment_info_returns_remote_environment_info() -> Result<()> {&mut app_server,&exec_server_url,/*connect_timeout_ms*/ None,+ /*websocket_request_id*/ None,).await?;@@ -175,6 +194,7 @@ async fn environment_info_accepts_missing_cwd() -> Result<()> {&mut app_server,&exec_server_url,/*connect_timeout_ms*/ None,+ /*websocket_request_id*/ None,).await?;@@ -249,7 +269,13 @@ async fn environment_info_reports_connection_failure() -> Result<()> {.build().await?;timeout(RPC_TIMEOUT, app_server.initialize()).await??;- add_environment(&mut app_server, &exec_server_url, Some(50)).await?;+ add_environment(+ &mut app_server,+ &exec_server_url,+ Some(50),+ /*websocket_request_id*/ None,+ )+ .await?;let request_id = app_server.send_raw_request(@@ -276,16 +302,18 @@ async fn add_environment(app_server: &mut TestAppServer,exec_server_url: &str,connect_timeout_ms: Option<u64>,+ websocket_request_id: Option<&str>,) -> Result<()> {+ let mut params = json!({+ "environmentId": "remote-a",+ "execServerUrl": exec_server_url,+ "connectTimeoutMs": connect_timeout_ms,+ });+ if let Some(websocket_request_id) = websocket_request_id {+ params["websocketRequestId"] = websocket_request_id.into();+ }let request_id = app_server- .send_raw_request(- "environment/add",- Some(json!({- "environmentId": "remote-a",- "execServerUrl": exec_server_url,- "connectTimeoutMs": connect_timeout_ms,- })),- )+ .send_raw_request("environment/add", Some(params)).await?;let response: JSONRPCResponse = timeout(RPC_TIMEOUT,diff --git a/codex-rs/app-server/tests/suite/v2/environment_status.rs b/codex-rs/app-server/tests/suite/v2/environment_status.rsindex 14d3abf440..a48ad134f2 100644--- a/codex-rs/app-server/tests/suite/v2/environment_status.rs+++ b/codex-rs/app-server/tests/suite/v2/environment_status.rs@@ -166,6 +166,7 @@ async fn add_environment(let params = EnvironmentAddParams {skills: None,auth_bearer_token: None,+ websocket_request_id: None,environment_id: environment_id.to_string(),exec_server_url: exec_server_url.to_string(),connect_timeout_ms: None,diff --git a/codex-rs/exec-server/src/server/transport.rs b/codex-rs/exec-server/src/server/transport.rsindex 94b48774d8..4bb1d1f120 100644--- a/codex-rs/exec-server/src/server/transport.rs+++ b/codex-rs/exec-server/src/server/transport.rs@@ -247,7 +247,7 @@ async fn websocket_upgrade_handler(return (err.status_code(), err.message()).into_response();}info!(%peer_addr, "exec-server websocket client connected");- websocket+ let mut response = websocket.on_upgrade(move |stream| async move {state.processor@@ -260,7 +260,13 @@ async fn websocket_upgrade_handler().await;})- .into_response()+ .into_response();+ if let Some(request_id) = headers.get("x-request-id") {+ response+ .headers_mut()+ .insert("x-request-id", request_id.clone());+ }+ response}#[cfg(test)]diff --git a/codex-rs/exec-server/tests/websocket.rs b/codex-rs/exec-server/tests/websocket.rsindex d4b0fd8adc..0c5acc2a71 100644--- a/codex-rs/exec-server/tests/websocket.rs+++ b/codex-rs/exec-server/tests/websocket.rs@@ -103,6 +103,26 @@ async fn exec_server_accepts_binary_websocket_json() -> anyhow::Result<()> {Ok(())}+#[tokio::test(flavor = "multi_thread", worker_threads = 2)]+async fn exec_server_echoes_request_id_in_websocket_handshake() -> anyhow::Result<()> {+ let mut server = exec_server().await?;+ for request_id in [Some(HeaderValue::from_static("opaque-request-id")), None] {+ let mut request = server.websocket_url().into_client_request()?;+ if let Some(request_id) = &request_id {+ request+ .headers_mut()+ .insert("x-request-id", request_id.clone());+ }++ let (stream, response) = connect_async(request).await?;+ assert_eq!(response.headers().get("x-request-id"), request_id.as_ref());+ drop(stream);+ }++ server.shutdown().await?;+ Ok(())+}+#[tokio::test(flavor = "multi_thread", worker_threads = 2)]async fn exec_server_rejects_browser_origin_websocket_handshake() -> anyhow::Result<()> {let mut server = exec_server().await?;