mirror of
https://github.com/openai/codex.git
synced 2026-04-30 01:16:54 +00:00
What changed
- Added `outputSchema` support to the app-server APIs, mirroring `codex
exec --output-schema` behavior.
- V1 `sendUserTurn` now accepts `outputSchema` and constrains the final
assistant message for that turn.
- V2 `turn/start` now accepts `outputSchema` and constrains the final
assistant message for that turn (explicitly per-turn only).
Core behavior
- `Op::UserTurn` already supported `final_output_json_schema`; now V1
`sendUserTurn` forwards `outputSchema` into that field.
- `Op::UserInput` now carries `final_output_json_schema` for per-turn
settings updates; core maps it into
`SessionSettingsUpdate.final_output_json_schema` so it applies to the
created turn context.
- V2 `turn/start` does NOT persist the schema via `OverrideTurnContext`
(it’s applied only for the current turn). Other overrides
(cwd/model/etc) keep their existing persistent behavior.
API / docs
- `codex-rs/app-server-protocol/src/protocol/v1.rs`: add `output_schema:
Option<serde_json::Value>` to `SendUserTurnParams` (serialized as
`outputSchema`).
- `codex-rs/app-server-protocol/src/protocol/v2.rs`: add `output_schema:
Option<JsonValue>` to `TurnStartParams` (serialized as `outputSchema`).
- `codex-rs/app-server/README.md`: document `outputSchema` for
`turn/start` and clarify it applies only to the current turn.
- `codex-rs/docs/codex_mcp_interface.md`: document `outputSchema` for v1
`sendUserTurn` and v2 `turn/start`.
Tests added/updated
- New app-server integration tests asserting `outputSchema` is forwarded
into outbound `/responses` requests as `text.format`:
- `codex-rs/app-server/tests/suite/output_schema.rs`
- `codex-rs/app-server/tests/suite/v2/output_schema.rs`
- Added per-turn semantics tests (schema does not leak to the next
turn):
- `send_user_turn_output_schema_is_per_turn_v1`
- `turn_start_output_schema_is_per_turn_v2`
- Added protocol wire-compat tests for the merged op:
- serialize omits `final_output_json_schema` when `None`
- deserialize works when field is missing
- serialize includes `final_output_json_schema` when `Some(schema)`
Call site updates (high level)
- Updated all `Op::UserInput { .. }` constructions to include
`final_output_json_schema`:
- `codex-rs/app-server/src/codex_message_processor.rs`
- `codex-rs/core/src/codex_delegate.rs`
- `codex-rs/mcp-server/src/codex_tool_runner.rs`
- `codex-rs/tui/src/chatwidget.rs`
- `codex-rs/tui2/src/chatwidget.rs`
- plus impacted core tests.
Validation
- `just fmt`
- `cargo test -p codex-core`
- `cargo test -p codex-app-server`
- `cargo test -p codex-mcp-server`
- `cargo test -p codex-tui`
- `cargo test -p codex-tui2`
- `cargo test -p codex-protocol`
- `cargo clippy --all-features --tests --profile dev --fix -- -D
warnings`
80 lines
2.8 KiB
Rust
80 lines
2.8 KiB
Rust
#![cfg(not(target_os = "windows"))]
|
||
|
||
use std::os::unix::fs::PermissionsExt;
|
||
|
||
use codex_core::protocol::EventMsg;
|
||
use codex_core::protocol::Op;
|
||
use codex_protocol::user_input::UserInput;
|
||
use core_test_support::fs_wait;
|
||
use core_test_support::responses;
|
||
use core_test_support::skip_if_no_network;
|
||
use core_test_support::test_codex::TestCodex;
|
||
use core_test_support::test_codex::test_codex;
|
||
use core_test_support::wait_for_event;
|
||
use pretty_assertions::assert_eq;
|
||
use serde_json::Value;
|
||
use serde_json::json;
|
||
use tempfile::TempDir;
|
||
|
||
use responses::ev_assistant_message;
|
||
use responses::ev_completed;
|
||
use responses::sse;
|
||
use responses::start_mock_server;
|
||
use std::time::Duration;
|
||
|
||
#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
|
||
#[ignore = "flaky on ubuntu-24.04-arm - aarch64-unknown-linux-gnu"]
|
||
// The notify script gets far enough to create (and therefore surface) the file,
|
||
// but hasn’t flushed the JSON yet. Reading an empty file produces EOF while parsing
|
||
// a value at line 1 column 0. May be caused by a slow runner.
|
||
async fn summarize_context_three_requests_and_instructions() -> anyhow::Result<()> {
|
||
skip_if_no_network!(Ok(()));
|
||
|
||
let server = start_mock_server().await;
|
||
|
||
let sse1 = sse(vec![ev_assistant_message("m1", "Done"), ev_completed("r1")]);
|
||
|
||
responses::mount_sse_once(&server, sse1).await;
|
||
|
||
let notify_dir = TempDir::new()?;
|
||
// write a script to the notify that touches a file next to it
|
||
let notify_script = notify_dir.path().join("notify.sh");
|
||
std::fs::write(
|
||
¬ify_script,
|
||
r#"#!/bin/bash
|
||
set -e
|
||
echo -n "${@: -1}" > $(dirname "${0}")/notify.txt"#,
|
||
)?;
|
||
std::fs::set_permissions(¬ify_script, std::fs::Permissions::from_mode(0o755))?;
|
||
|
||
let notify_file = notify_dir.path().join("notify.txt");
|
||
let notify_script_str = notify_script.to_str().unwrap().to_string();
|
||
|
||
let TestCodex { codex, .. } = test_codex()
|
||
.with_config(move |cfg| cfg.notify = Some(vec![notify_script_str]))
|
||
.build(&server)
|
||
.await?;
|
||
|
||
// 1) Normal user input – should hit server once.
|
||
codex
|
||
.submit(Op::UserInput {
|
||
items: vec![UserInput::Text {
|
||
text: "hello world".into(),
|
||
}],
|
||
final_output_json_schema: None,
|
||
})
|
||
.await?;
|
||
wait_for_event(&codex, |ev| matches!(ev, EventMsg::TaskComplete(_))).await;
|
||
|
||
// We fork the notify script, so we need to wait for it to write to the file.
|
||
fs_wait::wait_for_path_exists(¬ify_file, Duration::from_secs(5)).await?;
|
||
let notify_payload_raw = tokio::fs::read_to_string(¬ify_file).await?;
|
||
let payload: Value = serde_json::from_str(¬ify_payload_raw)?;
|
||
|
||
assert_eq!(payload["type"], json!("agent-turn-complete"));
|
||
assert_eq!(payload["input-messages"], json!(["hello world"]));
|
||
assert_eq!(payload["last-assistant-message"], json!("Done"));
|
||
|
||
Ok(())
|
||
}
|