use anyhow::Result; use app_test_support::McpProcess; use app_test_support::to_response; use codex_app_server_protocol::JSONRPCResponse; use codex_app_server_protocol::RequestId; use codex_app_server_protocol::ThreadStartParams; use codex_app_server_protocol::ThreadStartResponse; use codex_app_server_protocol::TurnStartParams; use codex_app_server_protocol::TurnStartResponse; use codex_app_server_protocol::TurnSteerParams; use codex_app_server_protocol::TurnSteerResponse; use codex_app_server_protocol::UserInput as V2UserInput; use core_test_support::responses; use core_test_support::skip_if_no_network; use pretty_assertions::assert_eq; use std::collections::HashMap; use std::path::Path; use tempfile::TempDir; use tokio::time::timeout; const DEFAULT_READ_TIMEOUT: std::time::Duration = std::time::Duration::from_secs(10); #[tokio::test] async fn turn_start_forwards_client_metadata_to_responses_request_v2() -> Result<()> { skip_if_no_network!(Ok(())); let server = responses::start_mock_server().await; let response_mock = responses::mount_sse_once( &server, responses::sse(vec![ responses::ev_response_created("resp-1"), responses::ev_assistant_message("msg-1", "Done"), responses::ev_completed("resp-1"), ]), ) .await; let codex_home = TempDir::new()?; create_config_toml( codex_home.path(), &server.uri(), /*supports_websockets*/ false, )?; let mut mcp = McpProcess::new(codex_home.path()).await?; timeout(DEFAULT_READ_TIMEOUT, mcp.initialize()).await??; let thread_req = mcp .send_thread_start_request(ThreadStartParams::default()) .await?; let thread_resp: JSONRPCResponse = timeout( DEFAULT_READ_TIMEOUT, mcp.read_stream_until_response_message(RequestId::Integer(thread_req)), ) .await??; let ThreadStartResponse { thread, .. } = to_response::(thread_resp)?; let client_metadata = HashMap::from([ ("fiber_run_id".to_string(), "fiber-start-123".to_string()), ("origin".to_string(), "gaas".to_string()), ]); let turn_req = mcp .send_turn_start_request(TurnStartParams { thread_id: thread.id, input: vec![V2UserInput::Text { text: "Hello".to_string(), text_elements: Vec::new(), }], responsesapi_client_metadata: Some(client_metadata.clone()), ..Default::default() }) .await?; let turn_resp: JSONRPCResponse = timeout( DEFAULT_READ_TIMEOUT, mcp.read_stream_until_response_message(RequestId::Integer(turn_req)), ) .await??; let TurnStartResponse { turn } = to_response::(turn_resp)?; timeout( DEFAULT_READ_TIMEOUT, mcp.read_stream_until_notification_message("turn/completed"), ) .await??; let request = response_mock.single_request(); let metadata = request .header("x-codex-turn-metadata") .as_deref() .map(parse_json_header) .unwrap_or_else(|| panic!("missing x-codex-turn-metadata header")); assert_eq!(metadata["fiber_run_id"].as_str(), Some("fiber-start-123")); assert_eq!(metadata["origin"].as_str(), Some("gaas")); assert_eq!(metadata["turn_id"].as_str(), Some(turn.id.as_str())); assert!(metadata.get("session_id").is_some()); Ok(()) } #[tokio::test] async fn turn_steer_updates_client_metadata_on_follow_up_responses_request_v2() -> Result<()> { skip_if_no_network!(Ok(())); let codex_home = TempDir::new()?; let server = responses::start_mock_server().await; let first_response = responses::sse_response(responses::sse(vec![ responses::ev_response_created("resp-1"), responses::ev_assistant_message("msg-1", "Working"), responses::ev_completed("resp-1"), ])) .set_delay(std::time::Duration::from_secs(2)); let second_response = responses::sse_response(responses::sse(vec![ responses::ev_response_created("resp-2"), responses::ev_assistant_message("msg-2", "Done"), responses::ev_completed("resp-2"), ])); let request_log = responses::mount_response_sequence(&server, vec![first_response, second_response]).await; create_config_toml( codex_home.path(), &server.uri(), /*supports_websockets*/ false, )?; let mut mcp = McpProcess::new(codex_home.path()).await?; timeout(DEFAULT_READ_TIMEOUT, mcp.initialize()).await??; let thread_req = mcp .send_thread_start_request(ThreadStartParams::default()) .await?; let thread_resp: JSONRPCResponse = timeout( DEFAULT_READ_TIMEOUT, mcp.read_stream_until_response_message(RequestId::Integer(thread_req)), ) .await??; let ThreadStartResponse { thread, .. } = to_response::(thread_resp)?; let start_metadata = HashMap::from([("fiber_run_id".to_string(), "fiber-start-123".to_string())]); let turn_req = mcp .send_turn_start_request(TurnStartParams { thread_id: thread.id.clone(), input: vec![V2UserInput::Text { text: "Run sleep".to_string(), text_elements: Vec::new(), }], responsesapi_client_metadata: Some(start_metadata.clone()), ..Default::default() }) .await?; let turn_resp: JSONRPCResponse = timeout( DEFAULT_READ_TIMEOUT, mcp.read_stream_until_response_message(RequestId::Integer(turn_req)), ) .await??; let TurnStartResponse { turn } = to_response::(turn_resp)?; let turn_id = turn.id.clone(); timeout( DEFAULT_READ_TIMEOUT, mcp.read_stream_until_notification_message("turn/started"), ) .await??; wait_for_request_count(&request_log, /*expected*/ 1).await?; let steer_metadata = HashMap::from([ ("fiber_run_id".to_string(), "fiber-steer-456".to_string()), ("origin".to_string(), "gaas".to_string()), ]); let steer_req = mcp .send_turn_steer_request(TurnSteerParams { thread_id: thread.id.clone(), input: vec![V2UserInput::Text { text: "Focus on the failure".to_string(), text_elements: Vec::new(), }], responsesapi_client_metadata: Some(steer_metadata.clone()), expected_turn_id: turn_id.clone(), }) .await?; let steer_resp: JSONRPCResponse = timeout( DEFAULT_READ_TIMEOUT, mcp.read_stream_until_response_message(RequestId::Integer(steer_req)), ) .await??; let _turn: TurnSteerResponse = to_response::(steer_resp)?; timeout( DEFAULT_READ_TIMEOUT, mcp.read_stream_until_notification_message("turn/completed"), ) .await??; let requests = request_log.requests(); assert_eq!(requests.len(), 2); let first_metadata = requests[0] .header("x-codex-turn-metadata") .as_deref() .map(parse_json_header) .unwrap_or_else(|| panic!("missing first x-codex-turn-metadata header")); assert_eq!( first_metadata["fiber_run_id"].as_str(), Some("fiber-start-123") ); assert_eq!(first_metadata["turn_id"].as_str(), Some(turn_id.as_str())); let second_metadata = requests[1] .header("x-codex-turn-metadata") .as_deref() .map(parse_json_header) .unwrap_or_else(|| panic!("missing second x-codex-turn-metadata header")); assert_eq!( second_metadata["fiber_run_id"].as_str(), Some("fiber-steer-456") ); assert_eq!(second_metadata["origin"].as_str(), Some("gaas")); assert_eq!(second_metadata["turn_id"].as_str(), Some(turn_id.as_str())); Ok(()) } #[tokio::test] async fn turn_start_forwards_client_metadata_to_responses_websocket_request_body_v2() -> Result<()> { skip_if_no_network!(Ok(())); let websocket_server = responses::start_websocket_server(vec![vec![ vec![ responses::ev_response_created("warm-1"), responses::ev_completed("warm-1"), ], vec![ responses::ev_response_created("resp-1"), responses::ev_assistant_message("msg-1", "Done"), responses::ev_completed("resp-1"), ], ]]) .await; let codex_home = TempDir::new()?; create_config_toml( codex_home.path(), &websocket_server.uri().replacen("ws://", "http://", 1), /*supports_websockets*/ true, )?; let mut mcp = McpProcess::new(codex_home.path()).await?; timeout(DEFAULT_READ_TIMEOUT, mcp.initialize()).await??; let thread_req = mcp .send_thread_start_request(ThreadStartParams::default()) .await?; let thread_resp: JSONRPCResponse = timeout( DEFAULT_READ_TIMEOUT, mcp.read_stream_until_response_message(RequestId::Integer(thread_req)), ) .await??; let ThreadStartResponse { thread, .. } = to_response::(thread_resp)?; let client_metadata = HashMap::from([ ("fiber_run_id".to_string(), "fiber-start-123".to_string()), ("origin".to_string(), "gaas".to_string()), ]); let turn_req = mcp .send_turn_start_request(TurnStartParams { thread_id: thread.id, input: vec![V2UserInput::Text { text: "Hello".to_string(), text_elements: Vec::new(), }], responsesapi_client_metadata: Some(client_metadata), ..Default::default() }) .await?; let turn_resp: JSONRPCResponse = timeout( DEFAULT_READ_TIMEOUT, mcp.read_stream_until_response_message(RequestId::Integer(turn_req)), ) .await??; let TurnStartResponse { turn } = to_response::(turn_resp)?; timeout( DEFAULT_READ_TIMEOUT, mcp.read_stream_until_notification_message("turn/completed"), ) .await??; let warmup = websocket_server .wait_for_request(/*connection_index*/ 0, /*request_index*/ 0) .await .body_json(); let request = websocket_server .wait_for_request(/*connection_index*/ 0, /*request_index*/ 1) .await .body_json(); assert_eq!(warmup["type"].as_str(), Some("response.create")); assert_eq!(warmup["generate"].as_bool(), Some(false)); assert_eq!(request["type"].as_str(), Some("response.create")); assert_eq!(request["previous_response_id"].as_str(), Some("warm-1")); let metadata = request["client_metadata"]["x-codex-turn-metadata"] .as_str() .map(parse_json_header) .unwrap_or_else(|| panic!("missing websocket x-codex-turn-metadata client metadata")); assert_eq!(metadata["fiber_run_id"].as_str(), Some("fiber-start-123")); assert_eq!(metadata["origin"].as_str(), Some("gaas")); assert_eq!(metadata["turn_id"].as_str(), Some(turn.id.as_str())); assert!(metadata.get("session_id").is_some()); websocket_server.shutdown().await; Ok(()) } fn create_config_toml( codex_home: &Path, server_uri: &str, supports_websockets: bool, ) -> std::io::Result<()> { let config_toml = codex_home.join("config.toml"); std::fs::write( config_toml, format!( r#" model = "mock-model" approval_policy = "never" sandbox_mode = "read-only" model_provider = "mock_provider" [model_providers.mock_provider] name = "Mock provider for test" base_url = "{server_uri}/v1" wire_api = "responses" request_max_retries = 0 stream_max_retries = 0 supports_websockets = {supports_websockets} "# ), ) } fn parse_json_header(value: &str) -> serde_json::Value { match serde_json::from_str(value) { Ok(value) => value, Err(err) => panic!("metadata header should be valid json: {err}"), } } async fn wait_for_request_count( request_log: &core_test_support::responses::ResponseMock, expected: usize, ) -> Result<()> { timeout(DEFAULT_READ_TIMEOUT, async { loop { if request_log.requests().len() >= expected { return; } tokio::time::sleep(std::time::Duration::from_millis(10)).await; } }) .await?; Ok(()) }