clone/codex
1
0
Fork 0
mirror of https://github.com/openai/codex.git synced 2026-05-02 10:26:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

[codex-analytics] include user agent in default headers (#17689)

Browse Source 
## Summary
Adds the standard Codex `User-Agent` to shared default headers so the
responses-api WS handshake carries the same client OS and version
context as HTTP requests.

## Testing
- `cargo test -p codex-core
build_ws_client_metadata_includes_window_lineage_and_turn_metadata`
- `cargo test -p codex-core --test all responses_websocket`
This commit is contained in:
marksteinbrick-oai
2026-04-27 21:32:10 -07:00
committed by GitHub
parent c08177f7d0
commit 6a8df2b61d
2 changed files with 36 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
codex-rs/core/tests/suite/client_websockets.rs
View File

@@ -53,6 +53,7 @@ use tracing_test::traced_test;
const MODEL: &str = "gpt-5.3-codex";
const OPENAI_BETA_HEADER: &str = "OpenAI-Beta";
const USER_AGENT_HEADER: &str = "user-agent";
const WS_V2_BETA_HEADER_VALUE: &str = "responses_websockets=2026-02-06";
const X_CLIENT_REQUEST_ID_HEADER: &str = "x-client-request-id";
const TEST_INSTALLATION_ID: &str = "11111111-1111-4111-8111-111111111111";
@@ -126,6 +127,10 @@ async fn responses_websocket_streams_request() {
handshake.header(X_CLIENT_REQUEST_ID_HEADER),
Some(harness.conversation_id.to_string())
);
assert_eq!(
handshake.header(USER_AGENT_HEADER),
Some(codex_login::default_client::get_codex_user_agent())
);
assert_eq!(
body["client_metadata"]["x-codex-installation-id"].as_str(),
Some(TEST_INSTALLATION_ID)
@@ -197,6 +202,10 @@ async fn responses_websocket_reuses_connection_with_per_turn_trace_payloads() {
};
assert_eq!(server.handshakes().len(), 1);
assert_eq!(
server.single_handshake().header(USER_AGENT_HEADER),
Some(codex_login::default_client::get_codex_user_agent())
);
let connection = server.single_connection();
assert_eq!(connection.len(), 2);
@@ -282,7 +291,12 @@ async fn responses_websocket_preconnect_reuses_connection() {
stream_until_complete(&mut client_session, &harness, &prompt).await;
assert_eq!(server.handshakes().len(), 1);
assert_eq!(server.single_connection().len(), 1);
assert_eq!(
server.single_handshake().header(USER_AGENT_HEADER),
Some(codex_login::default_client::get_codex_user_agent())
);
let connection = server.single_connection();
assert_eq!(connection.len(), 1);
server.shutdown().await;
}
@@ -315,6 +329,10 @@ async fn responses_websocket_request_prewarm_reuses_connection() {
stream_until_complete(&mut client_session, &harness, &prompt).await;
assert_eq!(server.handshakes().len(), 1);
assert_eq!(
server.single_handshake().header(USER_AGENT_HEADER),
Some(codex_login::default_client::get_codex_user_agent())
);
let connection = server.single_connection();
assert_eq!(connection.len(), 2);
let warmup = connection
@@ -1151,6 +1169,18 @@ async fn responses_websocket_connection_limit_error_reconnects_and_completes() {
let total_websocket_requests: usize = server.connections().iter().map(Vec::len).sum();
assert_eq!(total_websocket_requests, 2);
let handshake_user_agents: Vec<_> = server
.handshakes()
.iter()
.map(|handshake| handshake.header(USER_AGENT_HEADER))
.collect();
assert_eq!(
handshake_user_agents,
vec![
Some(codex_login::default_client::get_codex_user_agent()),
Some(codex_login::default_client::get_codex_user_agent()),
]
);
server.shutdown().await;
}