Lightweight coding agent that runs in your terminal
Rust
Preserve tool metadata for OpenAI provider endpoint overrides (#48344)
peilin-openaic9e25207073a
diff --git a/codex-rs/app-server/src/request_processors/thread_processor_tests.rs b/codex-rs/app-server/src/request_processors/thread_processor_tests.rsindex 44c29bda15..237c58e031 100644--- a/codex-rs/app-server/src/request_processors/thread_processor_tests.rs+++ b/codex-rs/app-server/src/request_processors/thread_processor_tests.rs@@ -612,6 +612,7 @@ mod thread_processor_behavior_tests {requires_openai_auth: false,supports_websockets: true,supports_standalone_web_search: false,+ include_internal_metadata: false,};let config_manager = ConfigManager::new(temp_dir.path().to_path_buf(),diff --git a/codex-rs/config/src/thread_config.rs b/codex-rs/config/src/thread_config.rsindex 61965e3431..0c1012f09b 100644--- a/codex-rs/config/src/thread_config.rs+++ b/codex-rs/config/src/thread_config.rs@@ -316,6 +316,7 @@ mod tests {requires_openai_auth: false,supports_websockets: true,supports_standalone_web_search: true,+ include_internal_metadata: false,}}}diff --git a/codex-rs/config/src/thread_config/remote.rs b/codex-rs/config/src/thread_config/remote.rsindex 16a937b414..1e16cc482b 100644--- a/codex-rs/config/src/thread_config/remote.rs+++ b/codex-rs/config/src/thread_config/remote.rs@@ -194,6 +194,7 @@ fn model_provider_from_proto(requires_openai_auth: provider.requires_openai_auth,supports_websockets: provider.supports_websockets,supports_standalone_web_search: provider.supports_standalone_web_search,+ include_internal_metadata: false,};Ok((id, info))}@@ -224,6 +225,7 @@ fn model_provider_to_proto(requires_openai_auth,supports_websockets,supports_standalone_web_search,+ include_internal_metadata: _,} = provider;proto::ModelProvider {@@ -579,6 +581,7 @@ mod tests {supports_standalone_web_search: true,gateway_oauth: None,aws: None,+ include_internal_metadata: false,}}diff --git a/codex-rs/core/src/client.rs b/codex-rs/core/src/client.rsindex 0bfd02f66e..a182bef7e6 100644--- a/codex-rs/core/src/client.rs+++ b/codex-rs/core/src/client.rs@@ -411,16 +411,6 @@ fn response_items_equal_ignoring_internal_metadata(previous == current}-/// Whether the resolved outbound Responses destination may receive internal tool metadata.-fn is_internal_metadata_destination(provider: &ApiProvider) -> bool {- url::Url::parse(&provider.base_url).ok().is_some_and(|url| {- url.scheme() == "https"- && url.host_str().is_some_and(|host| {- host == "api.openai.com" || codex_http_client::is_allowed_chatgpt_host(host)- })- })-}-impl WebsocketSession {fn reset(&mut self, reason: Option<&'static str>) {// Per-socket backend metrics call a resend after reconnect "initial".@@ -1674,7 +1664,11 @@ impl ModelClientSession {.client.current_client_setup(ClientRouting::Workspace).await?;- let include_internal = is_internal_metadata_destination(&client_setup.api_provider);+ let include_internal = self+ .client+ .state+ .provider+ .include_internal_metadata(&client_setup.api_provider);let responses_headers = self.client.responses_headers(client_setup.auth.as_ref(), &model_info.slug);@@ -1864,7 +1858,11 @@ impl ModelClientSession {.client.current_client_setup(ClientRouting::Workspace).await?;- let include_internal = is_internal_metadata_destination(&client_setup.api_provider);+ let include_internal = self+ .client+ .state+ .provider+ .include_internal_metadata(&client_setup.api_provider);let responses_headers = self.client.responses_headers(client_setup.auth.as_ref(), &model_info.slug);diff --git a/codex-rs/core/src/client_tests.rs b/codex-rs/core/src/client_tests.rsindex fc88e15ec8..ac3f943ed1 100644--- a/codex-rs/core/src/client_tests.rs+++ b/codex-rs/core/src/client_tests.rs@@ -486,7 +486,7 @@ fn output_with_tool_result_metadata(metadata: ToolResultMetadata) -> ResponseIte}#[tokio::test]-async fn responses_request_limits_internal_metadata_to_resolved_first_party_https_endpoint()+async fn responses_request_includes_internal_metadata_for_provider_grant_or_first_party_destination()-> anyhow::Result<()> {use crate::session::step_context::StepContext;use crate::tools::ExecutedToolCalls;@@ -548,13 +548,13 @@ async fn responses_request_limits_internal_metadata_to_resolved_first_party_http)]);without_omitted_metadata.mark_tool_calls_complete();- let provider =+ let mut provider =ModelProviderInfo::create_openai_provider(Some("https://api.openai.com/v1".to_string()));let mut api_provider = provider.to_api_provider(/*auth_mode*/ None)?;let mut client = test_model_client(SessionSource::Cli);Arc::get_mut(&mut client.state).expect("test client should have unique session state")- .provider = create_model_provider(provider, /*auth_manager*/ None);+ .provider = create_model_provider(provider.clone(), /*auth_manager*/ None);let output = output_with_tool_result_metadata(ToolResultMetadata::new(&json!({"private": { "resource": "raw-result-metadata" },})));@@ -582,19 +582,27 @@ async fn responses_request_limits_internal_metadata_to_resolved_first_party_httpTestCodexResponsesRequestKind::Turn,);responses_metadata.mcp_attribution = Some(attribution.clone());- for (base_url, allowed) in [- ("https://api.openai.com/v1", true),- ("https://chatgpt.com/backend-api/codex", true),- ("https://api.chatgpt-staging.com/v1", true),- ("https://proxy.example.com/v1", false),- ("http://api.openai.com/v1", false),- ("https://api.openai.com.evil.example/v1", false),- ("https://chatgpt.com.evil.example/v1", false),- ("https://[email protected]/v1", false),- ("not a URL", false),+ for (provider_grant, base_url, allowed) in [+ (false, "https://api.openai.com/v1", true),+ (false, "https://chatgpt.com/backend-api/codex", true),+ (false, "https://api.chatgpt-staging.com/v1", true),+ (false, "https://proxy.example.com/v1", false),+ (false, "http://api.openai.com/v1", false),+ (false, "https://api.openai.com.evil.example/v1", false),+ (false, "https://chatgpt.com.evil.example/v1", false),+ (false, "https://[email protected]/v1", false),+ (false, "not a URL", false),+ (true, "http://provider.example/v1", true),] {+ provider.include_internal_metadata = provider_grant;+ Arc::get_mut(&mut client.state)+ .expect("test client should have unique session state")+ .provider = create_model_provider(provider.clone(), /*auth_manager*/ None);api_provider.base_url = base_url.to_string();- let include_internal = super::is_internal_metadata_destination(&api_provider);+ let include_internal = client+ .state+ .provider+ .include_internal_metadata(&api_provider);for responses_lite in [false, true] {let mut model = test_model_info();model.use_responses_lite = responses_lite;@@ -776,7 +784,10 @@ fn responses_request_preserves_result_metadata_above_previous_aggregate_budget()codex_protocol::config_types::ReasoningSummary::None,/*service_tier*/ None,&responses_metadata,- super::is_internal_metadata_destination(&api_provider),+ client+ .state+ .provider+ .include_internal_metadata(&api_provider),)?;let body = serde_json::to_value(&request)?;// Whole-input equality covers bindings, arguments, results, sources and completion too.@@ -797,8 +808,10 @@ fn responses_request_preserves_result_metadata_above_previous_aggregate_budget()#[test]fn websocket_incremental_reuse_tracks_raw_result_metadata() -> anyhow::Result<()> {- let provider =- ModelProviderInfo::create_openai_provider(Some("https://api.openai.com/v1".to_string()));+ let provider = ModelProviderInfo {+ include_internal_metadata: false,+ ..ModelProviderInfo::create_openai_provider(Some("https://api.openai.com/v1".to_string()))+ };let mut api_provider = provider.to_api_provider(/*auth_mode*/ None)?;let mut client = test_model_client(SessionSource::Cli);Arc::get_mut(&mut client.state)@@ -869,7 +882,10 @@ fn websocket_incremental_reuse_tracks_raw_result_metadata() -> anyhow::Result<()previous_output.set_turn_id_if_missing("previous-turn");current_output.set_turn_id_if_missing("current-turn");api_provider.base_url = base_url.to_string();- let include_internal = super::is_internal_metadata_destination(&api_provider);+ let include_internal = client+ .state+ .provider+ .include_internal_metadata(&api_provider);let previous = client.build_responses_request(&Prompt {input: vec![previous_output],@@ -924,7 +940,7 @@ fn websocket_incremental_reuse_tracks_raw_result_metadata() -> anyhow::Result<()}#[tokio::test]-async fn responses_http_omits_raw_tool_metadata_for_openai_named_custom_endpoint()+async fn responses_http_preserves_raw_tool_metadata_for_openai_custom_endpoint()-> anyhow::Result<()> {let server = MockServer::start().await;Mock::given(method("POST"))@@ -986,12 +1002,7 @@ async fn responses_http_omits_raw_tool_metadata_for_openai_named_custom_endpointlet requests = server.received_requests().await.expect("received requests");assert_eq!(requests.len(), 1);let body: serde_json::Value = serde_json::from_slice(&requests[0].body)?;- assert_eq!(- body["input"],- serde_json::to_value(vec![output_with_tool_result_metadata(- ToolResultMetadata::default(),- )])?,- );+ assert_eq!(body["input"], serde_json::to_value(vec![output.clone()])?);assert_eq!(prompt.input, vec![output]);Ok(())}diff --git a/codex-rs/core/tests/responses_headers.rs b/codex-rs/core/tests/responses_headers.rsindex fe456c9a04..58e780b7e8 100644--- a/codex-rs/core/tests/responses_headers.rs+++ b/codex-rs/core/tests/responses_headers.rs@@ -92,6 +92,7 @@ async fn responses_stream_includes_subagent_header_on_review() {requires_openai_auth: false,supports_websockets: false,supports_standalone_web_search: false,+ include_internal_metadata: false,};let codex_home = TempDir::new().expect("failed to create TempDir");@@ -234,6 +235,7 @@ async fn responses_stream_includes_subagent_header_on_other() {requires_openai_auth: false,supports_websockets: false,supports_standalone_web_search: false,+ include_internal_metadata: false,};let codex_home = TempDir::new().expect("failed to create TempDir");@@ -357,6 +359,7 @@ async fn responses_respects_model_info_overrides_from_config() {requires_openai_auth: false,supports_websockets: false,supports_standalone_web_search: false,+ include_internal_metadata: false,};let codex_home = TempDir::new().expect("failed to create TempDir");diff --git a/codex-rs/core/tests/suite/client.rs b/codex-rs/core/tests/suite/client.rsindex a260ce8805..e37725f07e 100644--- a/codex-rs/core/tests/suite/client.rs+++ b/codex-rs/core/tests/suite/client.rs@@ -1658,6 +1658,7 @@ async fn send_provider_auth_request(server: &MockServer, auth: ModelProviderAuthrequires_openai_auth: false,supports_websockets: false,supports_standalone_web_search: false,+ include_internal_metadata: false,};send_request_with_provider(provider).await;@@ -3176,6 +3177,7 @@ async fn azure_responses_request_does_not_store_and_preserves_prefixed_item_ids(requires_openai_auth: false,supports_websockets: false,supports_standalone_web_search: false,+ include_internal_metadata: false,};let codex_home = TempDir::new().unwrap();@@ -3813,6 +3815,7 @@ async fn azure_overrides_assign_properties_used_for_responses_url() {requires_openai_auth: false,supports_websockets: false,supports_standalone_web_search: false,+ include_internal_metadata: false,};// Init session@@ -3899,6 +3902,7 @@ async fn env_var_overrides_loaded_auth() {requires_openai_auth: false,supports_websockets: false,supports_standalone_web_search: false,+ include_internal_metadata: false,};// Init sessiondiff --git a/codex-rs/core/tests/suite/client_websockets.rs b/codex-rs/core/tests/suite/client_websockets.rsindex f3a4212678..7dbcb21c25 100755--- a/codex-rs/core/tests/suite/client_websockets.rs+++ b/codex-rs/core/tests/suite/client_websockets.rs@@ -214,7 +214,7 @@ async fn responses_websocket_preserves_credit_usage_metadata() {}#[tokio::test(flavor = "multi_thread", worker_threads = 2)]-async fn responses_websocket_omits_raw_tool_metadata_for_openai_named_custom_endpoint() {+async fn responses_websocket_preserves_raw_tool_metadata_for_openai_custom_endpoint() {skip_if_no_network!();let server = start_websocket_server(vec![vec![vec![@@ -238,11 +238,7 @@ async fn responses_websocket_omits_raw_tool_metadata_for_openai_named_custom_endoutput.append_executed_tool_calls(vec![call]);output.mark_tool_calls_complete();let prompt = prompt_with_input(vec![output.clone()]);- let mut expected = serde_json::to_value(&output).unwrap();- expected["internal_chat_message_metadata_passthrough"]["executed_tool_calls"][0]- .as_object_mut()- .unwrap()- .remove("tool_result_metadata");+ let expected = serde_json::to_value(&output).unwrap();let mut client_session = harness.client.new_session();stream_until_complete_with_model_info(@@ -2643,6 +2639,7 @@ fn websocket_provider_with_connect_timeout(requires_openai_auth: false,supports_websockets: true,supports_standalone_web_search: false,+ include_internal_metadata: false,}}diff --git a/codex-rs/core/tests/suite/code_mode.rs b/codex-rs/core/tests/suite/code_mode.rsindex fd44103451..3773f265cc 100644--- a/codex-rs/core/tests/suite/code_mode.rs+++ b/codex-rs/core/tests/suite/code_mode.rs@@ -1991,6 +1991,8 @@ fn result_metadata_apps_builder(base_url: String, account_email: &str) -> TestCosearch_capable_apps_builder(base_url).with_auth(auth).with_config(|config| {+ // Keep this mock provider ungranted to cover custom-provider filtering.+ config.model_provider.include_internal_metadata = false;for feature in [Feature::CodeMode,Feature::CodeModeOnly,@@ -2490,7 +2492,7 @@ async fn result_metadata_preserves_results_within_request_budget();let captured = serde_json::to_value(captured)?;for (input, expected_metadata) in [- // Custom inference endpoints must strip raw metadata, including omission markers.+ // Ungranted custom inference endpoints strip raw metadata, including omission markers.(request.input(), None),(captured.as_array().unwrap().clone(),@@ -2684,7 +2686,7 @@ async fn result_metadata_follows_call_binding(assert_eq!(result.success, Some(!is_error));}if metadata_enabled {- // The custom inference endpoint gets no raw metadata; inspect capture independently.+ // The ungranted custom endpoint gets no raw metadata; inspect capture independently.assert_result_metadata_call(&output, &arguments, /*expected_metadata*/ None);let captured = serde_json::to_value(captured)?;let captured_output = captureddiff --git a/codex-rs/core/tests/suite/direct_tool_metadata.rs b/codex-rs/core/tests/suite/direct_tool_metadata.rsindex 7c52d6dcaf..f19cd36d60 100644--- a/codex-rs/core/tests/suite/direct_tool_metadata.rs+++ b/codex-rs/core/tests/suite/direct_tool_metadata.rs@@ -688,6 +688,7 @@ async fn direct_metadata_limit_retains_marker_without_sending_it_to_custom_provi).await;let mut builder = search_capable_apps_builder(apps.chatgpt_base_url).with_config(|config| {+ config.model_provider.include_internal_metadata = false;config.analytics_enabled = Some(true);config.features@@ -757,7 +758,7 @@ async fn direct_metadata_limit_retains_marker_without_sending_it_to_custom_provirecorded_metadata["executed_tool_calls"][0]["arguments"],json!({"query": query}));- // A custom Responses provider must never receive internal result metadata.+ // An ungranted custom Responses provider must not receive internal result metadata.assert!(wire_metadata["executed_tool_calls"][0].get("tool_result_metadata")diff --git a/codex-rs/core/tests/suite/rmcp_client.rs b/codex-rs/core/tests/suite/rmcp_client.rsindex cf5f6fe693..54d31beb9f 100644--- a/codex-rs/core/tests/suite/rmcp_client.rs+++ b/codex-rs/core/tests/suite/rmcp_client.rs@@ -696,20 +696,30 @@ async fn text_only_mcp_content_uses_content_items() -> anyhow::Result<()> {]));- let first_turn_id = request.body_json()["client_metadata"]["turn_id"].clone();+ let request_body = request.body_json();+ let first_turn_id = request_body["client_metadata"]["turn_id"].clone();assert!(first_turn_id.is_string());+ let expected_attribution = json!({+ "status": "complete",+ "sources": [{+ "server_name": "rmcp",+ "tool_name": "image_scenario",+ "first_turn_id": first_turn_id,+ }],+ });assert_eq!(serde_json::to_value(codex_core::test_support::mcp_attribution_snapshot(&fixture.codex))?,- json!({- "status": "complete",- "sources": [{- "server_name": "rmcp",- "tool_name": "image_scenario",- "first_turn_id": first_turn_id,- }],- })+ expected_attribution,+ );+ assert_eq!(+ serde_json::from_str::<serde_json::Value>(+ request_body["client_metadata"]["mcp_attribution"]+ .as_str()+ .context("MCP attribution should be included for the OpenAI provider")?,+ )?,+ expected_attribution,);server.verify().await;diff --git a/codex-rs/core/tests/suite/stream_error_allows_next_turn.rs b/codex-rs/core/tests/suite/stream_error_allows_next_turn.rsindex e46734522f..ea0a818b4c 100644--- a/codex-rs/core/tests/suite/stream_error_allows_next_turn.rs+++ b/codex-rs/core/tests/suite/stream_error_allows_next_turn.rs@@ -84,6 +84,7 @@ async fn continue_after_stream_error() {requires_openai_auth: false,supports_websockets: false,supports_standalone_web_search: false,+ include_internal_metadata: false,};let TestCodex { codex, .. } = test_codex()diff --git a/codex-rs/core/tests/suite/stream_no_completed.rs b/codex-rs/core/tests/suite/stream_no_completed.rsindex 676b5a9b3b..f163c27f82 100644--- a/codex-rs/core/tests/suite/stream_no_completed.rs+++ b/codex-rs/core/tests/suite/stream_no_completed.rs@@ -70,6 +70,7 @@ async fn retries_on_early_close() {requires_openai_auth: false,supports_websockets: false,supports_standalone_web_search: false,+ include_internal_metadata: false,};let TestCodex { codex, .. } = test_codex()diff --git a/codex-rs/login/src/auth_env_telemetry.rs b/codex-rs/login/src/auth_env_telemetry.rsindex b2d83bf175..0b6d741537 100644--- a/codex-rs/login/src/auth_env_telemetry.rs+++ b/codex-rs/login/src/auth_env_telemetry.rs@@ -79,6 +79,7 @@ mod tests {requires_openai_auth: false,supports_websockets: false,supports_standalone_web_search: false,+ include_internal_metadata: false,};let telemetry =diff --git a/codex-rs/model-provider-info/src/lib.rs b/codex-rs/model-provider-info/src/lib.rsindex e5d31ce3a9..c18ce6c322 100644--- a/codex-rs/model-provider-info/src/lib.rs+++ b/codex-rs/model-provider-info/src/lib.rs@@ -192,6 +192,11 @@ pub struct ModelProviderInfo {/// Whether this provider supports the standalone web-search endpoint.#[serde(default)]pub supports_standalone_web_search: bool,+ /// Runtime-only opt-in for internal metadata, independent of the destination check.+ /// This cannot be loaded from or written to serialized provider configuration.+ #[serde(skip)]+ #[schemars(skip)]+ pub include_internal_metadata: bool,}/// AWS SigV4 auth configuration for a model provider.@@ -547,6 +552,7 @@ other non-default provider fields are not supported"requires_openai_auth: true,supports_websockets: true,supports_standalone_web_search: true,+ include_internal_metadata: true,}}@@ -585,6 +591,7 @@ other non-default provider fields are not supported"requires_openai_auth: false,supports_websockets: false,supports_standalone_web_search: false,+ include_internal_metadata: false,}}@@ -757,6 +764,7 @@ pub fn create_oss_provider_with_base_url(base_url: &str, wire_api: WireApi) -> Mrequires_openai_auth: false,supports_websockets: false,supports_standalone_web_search: false,+ include_internal_metadata: false,}}diff --git a/codex-rs/model-provider-info/src/model_provider_info_tests.rs b/codex-rs/model-provider-info/src/model_provider_info_tests.rsindex 2929adfd98..3cbd8b2bac 100644--- a/codex-rs/model-provider-info/src/model_provider_info_tests.rs+++ b/codex-rs/model-provider-info/src/model_provider_info_tests.rs@@ -5,6 +5,22 @@ use pretty_assertions::assert_eq;use std::num::NonZeroU64;use tempfile::tempdir;+#[test]+fn runtime_internal_metadata_opt_in_is_not_serialized_or_configurable() {+ let trusted = ModelProviderInfo {+ include_internal_metadata: true,+ ..Default::default()+ };+ assert_eq!(+ toml::to_string(&trusted).unwrap(),+ toml::to_string(&ModelProviderInfo::default()).unwrap(),+ );+ assert_eq!(+ toml::from_str::<ModelProviderInfo>("include_internal_metadata = true").unwrap(),+ ModelProviderInfo::default(),+ );+}+#[test]fn test_api_provider_applies_current_managed_residency() {let info = ModelProviderInfo {@@ -80,6 +96,7 @@ base_url = "http://localhost:11434/v1"requires_openai_auth: false,supports_websockets: false,supports_standalone_web_search: false,+ include_internal_metadata: false,};let provider: ModelProviderInfo = toml::from_str(azure_provider_toml).unwrap();@@ -117,6 +134,7 @@ query_params = { api-version = "2025-04-01-preview" }requires_openai_auth: false,supports_websockets: false,supports_standalone_web_search: false,+ include_internal_metadata: false,};let provider: ModelProviderInfo = toml::from_str(azure_provider_toml).unwrap();@@ -158,6 +176,7 @@ supports_standalone_web_search = truerequires_openai_auth: false,supports_websockets: false,supports_standalone_web_search: true,+ include_internal_metadata: false,};let provider: ModelProviderInfo = toml::from_str(azure_provider_toml).unwrap();@@ -346,6 +365,7 @@ fn test_create_amazon_bedrock_provider() {requires_openai_auth: false,supports_websockets: false,supports_standalone_web_search: false,+ include_internal_metadata: false,});}diff --git a/codex-rs/model-provider/src/provider.rs b/codex-rs/model-provider/src/provider.rsindex 94bd3a835b..fa30479f7f 100644--- a/codex-rs/model-provider/src/provider.rs+++ b/codex-rs/model-provider/src/provider.rs@@ -142,6 +142,17 @@ pub trait ModelProvider: fmt::Debug + Send + Sync {/// Returns the configured provider metadata.fn info(&self) -> &ModelProviderInfo;+ /// Returns whether the resolved Responses provider may receive internal tool metadata.+ fn include_internal_metadata(&self, provider: &Provider) -> bool {+ self.info().include_internal_metadata+ || url::Url::parse(&provider.base_url).ok().is_some_and(|url| {+ url.scheme() == "https"+ && url.host_str().is_some_and(|host| {+ host == "api.openai.com" || codex_http_client::is_allowed_chatgpt_host(host)+ })+ })+ }+/// Returns the provider-owned capability upper bounds.fn capabilities(&self) -> ProviderCapabilities {ProviderCapabilities::default()@@ -697,6 +708,7 @@ mod tests {requires_openai_auth: false,supports_websockets: false,supports_standalone_web_search: false,+ include_internal_metadata: false,}}