fix(openai): align Responses transport with Codex CLI 0.170.0

Fragment large text messages before permessage-deflate and keep one send acknowledgement per message. Pin the matching WebSocket forks and Linux OpenSSL bindings, and refresh the bundled CLI release.

Co-authored-by: Codex <noreply@openai.com>
This commit is contained in:
Zyy
2026-11-19 09:03:38 +08:00
co-authored by Codex
parent 38446e8a0c
commit 8d282dcdf9
9 changed files with 193 additions and 100 deletions
+6 -6
View File
@@ -3006,9 +3006,9 @@ checksum = "384b8ab6d37215f3c5301a95a4accb5d64aa607f1fcb26a11b5303878451b4fe"
[[package]]
name = "openssl"
version = "0.10.80"
version = "0.10.82"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "a45fa2aa886c42762255da344f0a0d313e254066c46aad76f300c3d3da62d967"
checksum = "4de8111e94a56adca7ebfe6c365b6d42f99deb69b74b6becacd4204e2f193aa2"
dependencies = [
"bitflags",
"cfg-if",
@@ -3052,9 +3052,9 @@ dependencies = [
[[package]]
name = "openssl-sys"
version = "0.9.116"
version = "0.9.118"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f28a22dc7140cda5f096e5e7724a6962ca81a7f8bfd2979f9b18c11af56318c4"
checksum = "19c413d6ec9ebaf5e1c829d355cb3e9f783778d700f135be0921d52fce3c60ae"
dependencies = [
"cc",
"libc",
@@ -4797,7 +4797,7 @@ dependencies = [
[[package]]
name = "tokio-tungstenite"
version = "0.28.0"
source = "git+https://github.com/openai-oss-forks/tokio-tungstenite?rev=0e5b2d73aa18dd9f0a50ee9ff199d5aef7594186#0e5b2d73aa18dd9f0a50ee9ff199d5aef7594186"
source = "git+https://github.com/openai-oss-forks/tokio-tungstenite?rev=7447c427513cfe685f236e1ac0513c4ea3dd9c0b#7447c427513cfe685f236e1ac0513c4ea3dd9c0b"
dependencies = [
"futures-util",
"log",
@@ -5006,7 +5006,7 @@ checksum = "e421abadd41a4225275504ea4d6566923418b7f05506fbc9c0fe86ba7396114b"
[[package]]
name = "tungstenite"
version = "0.27.0"
source = "git+https://github.com/openai-oss-forks/tungstenite-rs?rev=4fffad30fe373adbdcffab9545e9e9bf4f2fc19f#4fffad30fe373adbdcffab9545e9e9bf4f2fc19f"
source = "git+https://github.com/openai-oss-forks/tungstenite-rs?rev=bc589d684755a8c02da0fc7e58d0861cbfc306f1#bc589d684755a8c02da0fc7e58d0861cbfc306f1"
dependencies = [
"bytes",
"data-encoding",
+5 -5
View File
@@ -59,10 +59,10 @@ tokio-rustls = { version = "=0.26.4", default-features = false }
tokio-util = { version = "0.7.18", features = ["rt"] }
tower-service = "0.3.3"
tower-layer = "0.3.3"
# 官方 Codex WebSocket 需要上游尚未发布的 proxy 与 permessage-deflate 实现,固定到已审计提交。
tokio-tungstenite = { git = "https://github.com/openai-oss-forks/tokio-tungstenite", rev = "0e5b2d73aa18dd9f0a50ee9ff199d5aef7594186", features = ["proxy", "rustls-tls-native-roots"] }
# 官方 fork 支持代理连接和分帧消息的 permessage-deflate,两个提交须配套
tokio-tungstenite = { git = "https://github.com/openai-oss-forks/tokio-tungstenite", rev = "7447c427513cfe685f236e1ac0513c4ea3dd9c0b", features = ["proxy", "rustls-tls-native-roots"] }
tracing = "0.1.44"
tungstenite = { git = "https://github.com/openai-oss-forks/tungstenite-rs", rev = "4fffad30fe373adbdcffab9545e9e9bf4f2fc19f", features = ["deflate", "proxy"] }
tungstenite = { git = "https://github.com/openai-oss-forks/tungstenite-rs", rev = "bc589d684755a8c02da0fc7e58d0861cbfc306f1", features = ["deflate", "proxy"] }
url = "2.5.8"
uuid = { version = "1.23.3", features = ["v4", "v7"] }
# 静态链接 XZ 解码器,不要求部署环境安装 liblzma。
@@ -73,8 +73,8 @@ zstd = "=0.14.3"
zip = { version = "9.0.4", default-features = false, features = ["deflate-flate2"] }
[target.'cfg(target_os = "linux")'.dependencies]
openssl = "=0.10.80"
openssl-sys = { version = "=0.9.116", features = ["vendored"] }
openssl = "=0.10.82"
openssl-sys = { version = "=0.9.118", features = ["vendored"] }
[dev-dependencies]
gateway-host = { path = "../../gateway-host" }
@@ -56,10 +56,10 @@ pub(super) struct DesktopArtifact {
pub etag: &'static str,
}
// 官方 npm 稳定标签及六个平台依赖;核验于 2026-11-14T02:09:52Z
// 官方 npm 稳定版本及六个平台依赖,核验于 2026-11-19T00:51:11Z
pub(super) const CLI_RELEASE: CoreRelease = CoreRelease {
version: "0.169.0",
verified_at_millis: 1_794_622_192_000,
version: "0.170.0",
verified_at_millis: 1_795_049_471_000,
};
// macOS arm64 ZIP;核验于 2026-11-14T02:09:52Z
@@ -198,7 +198,7 @@ pub fn websocket_response_create_payload(request: &CodexResponsesRequest) -> Val
Value::Object(payload)
}
/// 借用原始 body 序列化 `response.create` 帧,不复制字段
/// 借用原始 body 序列化 `response.create` 消息,不复制字段
///
/// 输出与序列化 [`websocket_response_create_payload`] 的合并 Map 逐字节一致:
/// body 自带 `type` 键时以 body 值置于首位,其余字段按插入顺序原样透传
@@ -224,7 +224,7 @@ impl serde::Serialize for ResponseCreateFrame<'_> {
}
}
/// 生成 Responses WebSocket `response.create` 文本帧内容
/// 生成 Responses WebSocket `response.create` 消息的完整文本
pub fn websocket_response_create_payload_text(
request: &CodexResponsesRequest,
) -> Result<String, serde_json::Error> {
@@ -1,4 +1,4 @@
//! Responses WebSocket endpoint、opening handshake 与首帧发送
//! Responses WebSocket endpoint、opening handshake 与请求发送
use std::{error::Error as _, io, time::Duration};
@@ -95,7 +95,7 @@ impl CodexWebSocketConnection {
}
}
/// 构造 Responses WebSocket opening 与首个 `response.create` 文本帧
/// 构造 Responses WebSocket opening 与首条 `response.create` 消息
pub fn responses_create_request(
base_url: &str,
websocket_key: &str,
@@ -147,7 +147,7 @@ impl CodexWebSocketRequest {
&self.connection
}
/// 返回将要发送的首个文本帧
/// 返回将要发送的完整 `response.create` 文本
pub fn payload_text(&self) -> &str {
&self.payload_text
}
@@ -11,9 +11,13 @@ use std::sync::{
};
use std::time::Duration;
use bytes::Bytes;
use futures::{Sink, SinkExt, Stream, StreamExt};
use tokio::{sync::mpsc, task::JoinHandle, time::Instant};
use tokio_tungstenite::tungstenite::Message;
use tungstenite::{
Message,
protocol::frame::{Fragment, Frame, coding::Data},
};
use uuid::Uuid;
use super::{
@@ -311,7 +315,7 @@ impl PumpedWebSocket {
}
}
/// 通过 pump 发送一帧,区分未开始发送与底层传输失败
/// 通过 pump 发送一条消息,区分未开始发送与底层传输失败
pub(crate) async fn send(&self, message: Message) -> Result<(), CodexWebSocketExchangeError> {
if self.is_closed() {
return Err(CodexWebSocketExchangeError::SendNotStarted);
@@ -613,7 +617,7 @@ async fn handle_command(
return None;
}
let is_close = matches!(message, Message::Close(_));
let result = inner.send(message).await;
let result = write_message(inner, message).await;
let transport_error = result
.as_ref()
.err()
@@ -629,6 +633,31 @@ async fn handle_command(
}
}
/// 同一命令内逐帧写完大文本,保持一条消息的压缩上下文和发送回执
async fn write_message(
inner: &mut RawWsStream,
message: Message,
) -> Result<(), tungstenite::Error> {
const FRAGMENT_BYTES: usize = 1024 * 1024;
let mut remaining = match message {
Message::Text(text) if text.len() > FRAGMENT_BYTES => Bytes::from(text),
other => return inner.send(other).await,
};
let mut opcode = Data::Text;
while !remaining.is_empty() {
let payload = remaining.split_to(remaining.len().min(FRAGMENT_BYTES));
let fragment = if remaining.is_empty() {
Fragment::Final
} else {
Fragment::More
};
let frame = Frame::message_fragment(payload, opcode, fragment);
inner.send(Message::Frame(frame)).await?;
opcode = Data::Continue;
}
Ok(())
}
fn record_activity(lifecycle: &Mutex<PumpLifecycleState>, observed_at: Instant) {
lifecycle
.lock()
@@ -1,7 +1,9 @@
//! 验证 Codex WebSocket 线协议指纹
use std::io::Read as _;
use base64::{Engine as _, engine::general_purpose::STANDARD};
use flate2::{Decompress, FlushDecompress};
use flate2::read::DeflateDecoder;
use tokio_tungstenite::tungstenite::handshake::derive_accept_key;
use super::*;
@@ -16,41 +18,6 @@ struct ClientFrame {
#[tokio::test]
async fn official_websocket_wire_fingerprint_should_remain_aligned() {
let listener = TcpListener::bind("127.0.0.1:0")
.await
.expect("bind fingerprint server");
let address = listener.local_addr().expect("fingerprint server address");
let server = tokio::spawn(async move {
let (mut stream, _) = listener.accept().await.expect("accept fingerprint client");
let opening = read_http_request(&mut stream).await;
let websocket_key = read_header_value(&opening, "sec-websocket-key")
.expect("WebSocket key")
.to_owned();
let response = format!(
concat!(
"HTTP/1.1 101 Switching Protocols\r\n",
"Connection: Upgrade\r\n",
"Upgrade: websocket\r\n",
"Sec-WebSocket-Accept: {}\r\n",
"Sec-WebSocket-Extensions: permessage-deflate\r\n",
"\r\n"
),
derive_accept_key(websocket_key.as_bytes())
);
stream
.write_all(response.as_bytes())
.await
.expect("write upgrade response");
let frame = read_client_frame(&mut stream).await;
write_server_text_frame(
&mut stream,
&completed_websocket_response("resp_wire_fingerprint", 1, 1),
)
.await;
(opening, websocket_key, frame)
});
let mut request = encode_request_with_headers(
json!({
"model": "gpt-5.5",
@@ -77,36 +44,21 @@ async fn official_websocket_wire_fingerprint_should_remain_aligned() {
request.turn_metadata = Some(r#"{"kind":"fingerprint"}"#.to_owned());
request.version = Some("26.908.40834".to_owned());
request.codex_window_id = Some("window-fingerprint".to_owned());
let client = CodexBackendClient::new(
reqwest::Client::builder()
.no_proxy()
.build()
.expect("HTTP client"),
format!("http://{address}/backend-api"),
test_wire_profile(),
)
.with_websocket_pool(Arc::new(CodexWebSocketPool::new(Duration::from_mins(1))));
let result = client
.create_response(
&request,
CodexRequestContext {
response_control: None,
trace: None,
turn_metadata: request.turn_metadata.as_deref(),
version: request.version.as_deref(),
codex_window_id: request.codex_window_id.as_deref(),
session_id: Some("session-fingerprint"),
thread_id: Some("thread-fingerprint"),
client_request_id: Some("request-fingerprint"),
installation_id: Some("3b11bc82-c666-417d-b9ff-2a34fd040385"),
..request_context("req_wire_fingerprint", Some("account-fingerprint"))
},
)
.await;
result.unwrap_or_else(|error| panic!("fingerprint WebSocket response: {error}"));
let (opening, websocket_key, frame) = server.await.expect("fingerprint server task");
let context = CodexRequestContext {
turn_metadata: request.turn_metadata.as_deref(),
version: request.version.as_deref(),
codex_window_id: request.codex_window_id.as_deref(),
session_id: Some("session-fingerprint"),
thread_id: Some("thread-fingerprint"),
client_request_id: Some("request-fingerprint"),
installation_id: Some("3b11bc82-c666-417d-b9ff-2a34fd040385"),
..request_context("req_wire_fingerprint", Some("account-fingerprint"))
};
let (opening, frames) = capture_response_create(&request, context, true).await;
let [frame] = frames.as_slice() else {
panic!("expected a single text frame")
};
let websocket_key = read_header_value(&opening, "sec-websocket-key").unwrap();
assert_eq!(
opening.lines().next(),
Some("GET /backend-api/codex/responses HTTP/1.1")
@@ -206,6 +158,121 @@ async fn official_websocket_wire_fingerprint_should_remain_aligned() {
);
}
#[tokio::test]
async fn large_responses_use_continuation_frames_for_one_text_message() {
const MIB: usize = 1024 * 1024;
let make_request = |instructions: &str| {
let mut request = codex_request("gpt-test", instructions, Vec::new());
request.use_websocket = true;
request.local_conversation_id = Some("fragment-test".to_owned());
request
};
let context = request_context("fragment-test", Some("account-test"));
// 用实际序列化的空指令测量 JSON 开销,边界包含元数据
let (_, baseline) = capture_response_create(&make_request(""), context, false).await;
let empty_payload = std::str::from_utf8(&baseline[0].payload).unwrap();
let instructions_key = r#""instructions":""#;
let start = empty_payload.find(instructions_key).unwrap() + instructions_key.len();
// FIN 只在末帧,文本操作码和压缩标记只在首帧
for (size, deflate, headers) in [
(MIB, false, &[0x81][..]),
(MIB + 1, false, &[0x01, 0x80]),
(MIB + 1, true, &[0x41, 0x80]),
(2 * MIB + 1, true, &[0x41, 0x00, 0x80]),
] {
let mut instructions = "a".repeat(size - empty_payload.len());
if size > 2 * MIB {
// 分帧边界穿过一个 UTF-8 字符
instructions.replace_range(MIB - start - 1..MIB - start + 3, "🌱");
}
let request = make_request(&instructions);
let (_, frames) = capture_response_create(&request, context, deflate).await;
let actual_headers: Vec<_> = frames.iter().map(|frame| frame.first_byte).collect();
assert_eq!(actual_headers, headers);
let mut payload = Vec::new();
for (index, frame) in frames.iter().enumerate() {
assert!(frame.masked);
if !deflate {
assert_eq!(frame.payload.len(), (size - index * MIB).min(MIB));
}
payload.extend_from_slice(&frame.payload);
}
if deflate {
payload = decompress_permessage_deflate(&payload);
}
assert_eq!(payload.len(), size);
let decoded: Value = serde_json::from_slice(&payload).unwrap();
assert!(decoded["instructions"].as_str() == Some(&instructions));
}
}
async fn capture_response_create(
request: &CodexResponsesRequest,
context: CodexRequestContext<'_>,
deflate: bool,
) -> (String, Vec<ClientFrame>) {
let listener = TcpListener::bind("127.0.0.1:0")
.await
.expect("bind fingerprint server");
let address = listener.local_addr().expect("fingerprint server address");
let server = tokio::spawn(async move {
let (mut stream, _) = listener.accept().await.expect("accept fingerprint client");
let opening = read_http_request(&mut stream).await;
let websocket_key =
read_header_value(&opening, "sec-websocket-key").expect("WebSocket key");
let extension = if deflate {
"Sec-WebSocket-Extensions: permessage-deflate\r\n"
} else {
""
};
let response = format!(
concat!(
"HTTP/1.1 101 Switching Protocols\r\n",
"Connection: Upgrade\r\n",
"Upgrade: websocket\r\n",
"Sec-WebSocket-Accept: {}\r\n",
"{}",
"\r\n"
),
derive_accept_key(websocket_key.as_bytes()),
extension
);
stream
.write_all(response.as_bytes())
.await
.expect("write upgrade response");
let mut frames = Vec::new();
loop {
let frame = read_client_frame(&mut stream).await;
let finished = frame.first_byte & 0x80 != 0;
frames.push(frame);
if finished {
break;
}
}
write_server_text_frame(
&mut stream,
&completed_websocket_response("resp_wire_fingerprint", 1, 1),
)
.await;
(opening, frames)
});
let client = CodexBackendClient::new(
reqwest::Client::builder().no_proxy().build().unwrap(),
format!("http://{address}/backend-api"),
test_wire_profile(),
)
.with_websocket_pool(Arc::new(CodexWebSocketPool::new(Duration::from_mins(1))));
client
.create_response(request, context)
.await
.expect("fingerprint WebSocket response");
server.await.expect("fingerprint server task")
}
async fn read_client_frame(stream: &mut TcpStream) -> ClientFrame {
let first_byte = stream.read_u8().await.expect("frame first byte");
let second_byte = stream.read_u8().await.expect("frame second byte");
@@ -239,17 +306,13 @@ async fn read_client_frame(stream: &mut TcpStream) -> ClientFrame {
}
fn decompress_permessage_deflate(payload: &[u8]) -> Vec<u8> {
let mut compressed = Vec::with_capacity(payload.len() + 4);
compressed.extend_from_slice(payload);
compressed.extend_from_slice(&[0x00, 0x00, 0xff, 0xff]);
let mut output = vec![0_u8; 64 * 1024];
let mut decompressor = Decompress::new(false);
decompressor
.decompress(&compressed, &mut output, FlushDecompress::Sync)
.expect("decompress response.create frame");
output.truncate(
usize::try_from(decompressor.total_out()).expect("decompressed length fits usize"),
);
let mut compressed = payload.to_vec();
// 补回 permessage-deflate 的同步刷新尾部,再加空终止块供完整流解码器读取
compressed.extend_from_slice(&[0, 0, 0xff, 0xff, 1, 0, 0, 0xff, 0xff]);
let mut output = Vec::new();
DeflateDecoder::new(compressed.as_slice())
.read_to_end(&mut output)
.unwrap();
output
}
+2 -1
View File
@@ -652,7 +652,8 @@ OAuth 账号默认 `prefer_websocket`,客户端使用 HTTP/SSE 时仍可能选
客户端可跳过预热继续正式请求,外部插件 adapter 按各自的协议能力处理
OpenAI Responses 上游 WS 按握手响应头 `x-codex-websocket-max-message-bytes` 声明的上限,
检查最终 `response.create` 文本的 UTF-8 字节数。超过上限时,新链、持久化续接和未知外部 previous ID
检查最终 `response.create` 文本的 UTF-8 字节数。允许发送的文本超过 1 MiB 时,每 1 MiB 分一帧,接收方仍收到一条消息。
超过握手声明的消息上限时,新链、持久化续接和未知外部 previous ID
在上传正文前改用 HTTP/SSE;等于上限仍可发送。OAuth 和 API Key 账号、HTTP 和 WS 入站均适用。
该上限只属于当前上游连接;响应头缺失或无效时不预判超限。显式 warmup 保持 WS 合同,超限时
返回 `websocket_message_too_large`,不重复发送或改用 HTTP