mirror of
https://github.com/openai/codex.git
synced 2026-09-16 12:13:30 +00:00
## Summary This changes `custom_tool_call_output` to use the same output payload shape as `function_call_output`, so freeform tools can return either plain text or structured content items. The main goal is to let `js_repl` return image content from nested `view_image` calls in its own `custom_tool_call_output`, instead of relying on a separate injected message. ## What changed - Changed `custom_tool_call_output.output` from `string` to `FunctionCallOutputPayload` - Updated freeform tool plumbing to preserve structured output bodies - Updated `js_repl` to aggregate nested tool content items and attach them to the outer `js_repl` result - Removed the old `js_repl` special case that injected `view_image` results as a separate pending user image message - Updated normalization/history/truncation paths to handle multimodal `custom_tool_call_output` - Regenerated app-server protocol schema artifacts ## Behavior Direct `view_image` calls still return a `function_call_output` with image content. When `view_image` is called inside `js_repl`, the outer `js_repl` `custom_tool_call_output` now carries: - an `input_text` item if the JS produced text output - one or more `input_image` items from nested tool results So the nested image result now stays inside the `js_repl` tool output instead of being injected as a separate message. ## Compatibility This is intended to be backward-compatible for resumed conversations. Older histories that stored `custom_tool_call_output.output` as a plain string still deserialize correctly, and older histories that used the previous injected-image-message flow also continue to resume. Added regression coverage for resuming a pre-change rollout containing: - string-valued `custom_tool_call_output` - legacy injected image message history #### [git stack](https://github.com/magus/git-stack-cli) - 👉 `1` https://github.com/openai/codex/pull/12948
148 lines
5.2 KiB
Rust
148 lines
5.2 KiB
Rust
use std::sync::Arc;
|
|
use std::time::Instant;
|
|
|
|
use tokio::sync::RwLock;
|
|
use tokio_util::either::Either;
|
|
use tokio_util::sync::CancellationToken;
|
|
use tokio_util::task::AbortOnDropHandle;
|
|
use tracing::Instrument;
|
|
use tracing::instrument;
|
|
use tracing::trace_span;
|
|
|
|
use crate::codex::Session;
|
|
use crate::codex::TurnContext;
|
|
use crate::error::CodexErr;
|
|
use crate::function_tool::FunctionCallError;
|
|
use crate::tools::context::SharedTurnDiffTracker;
|
|
use crate::tools::context::ToolPayload;
|
|
use crate::tools::router::ToolCall;
|
|
use crate::tools::router::ToolRouter;
|
|
use codex_protocol::models::FunctionCallOutputBody;
|
|
use codex_protocol::models::FunctionCallOutputPayload;
|
|
use codex_protocol::models::ResponseInputItem;
|
|
|
|
#[derive(Clone)]
|
|
pub(crate) struct ToolCallRuntime {
|
|
router: Arc<ToolRouter>,
|
|
session: Arc<Session>,
|
|
turn_context: Arc<TurnContext>,
|
|
tracker: SharedTurnDiffTracker,
|
|
parallel_execution: Arc<RwLock<()>>,
|
|
}
|
|
|
|
impl ToolCallRuntime {
|
|
pub(crate) fn new(
|
|
router: Arc<ToolRouter>,
|
|
session: Arc<Session>,
|
|
turn_context: Arc<TurnContext>,
|
|
tracker: SharedTurnDiffTracker,
|
|
) -> Self {
|
|
Self {
|
|
router,
|
|
session,
|
|
turn_context,
|
|
tracker,
|
|
parallel_execution: Arc::new(RwLock::new(())),
|
|
}
|
|
}
|
|
|
|
#[instrument(level = "trace", skip_all, fields(call = ?call))]
|
|
pub(crate) fn handle_tool_call(
|
|
self,
|
|
call: ToolCall,
|
|
cancellation_token: CancellationToken,
|
|
) -> impl std::future::Future<Output = Result<ResponseInputItem, CodexErr>> {
|
|
let supports_parallel = self.router.tool_supports_parallel(&call.tool_name);
|
|
|
|
let router = Arc::clone(&self.router);
|
|
let session = Arc::clone(&self.session);
|
|
let turn = Arc::clone(&self.turn_context);
|
|
let tracker = Arc::clone(&self.tracker);
|
|
let lock = Arc::clone(&self.parallel_execution);
|
|
let started = Instant::now();
|
|
|
|
let dispatch_span = trace_span!(
|
|
"dispatch_tool_call",
|
|
otel.name = call.tool_name.as_str(),
|
|
tool_name = call.tool_name.as_str(),
|
|
call_id = call.call_id.as_str(),
|
|
aborted = false,
|
|
);
|
|
|
|
let handle: AbortOnDropHandle<Result<ResponseInputItem, FunctionCallError>> =
|
|
AbortOnDropHandle::new(tokio::spawn(async move {
|
|
tokio::select! {
|
|
_ = cancellation_token.cancelled() => {
|
|
let secs = started.elapsed().as_secs_f32().max(0.1);
|
|
dispatch_span.record("aborted", true);
|
|
Ok(Self::aborted_response(&call, secs))
|
|
},
|
|
res = async {
|
|
let _guard = if supports_parallel {
|
|
Either::Left(lock.read().await)
|
|
} else {
|
|
Either::Right(lock.write().await)
|
|
};
|
|
|
|
router
|
|
.dispatch_tool_call(
|
|
session,
|
|
turn,
|
|
tracker,
|
|
call.clone(),
|
|
crate::tools::router::ToolCallSource::Direct,
|
|
)
|
|
.instrument(dispatch_span.clone())
|
|
.await
|
|
} => res,
|
|
}
|
|
}));
|
|
|
|
async move {
|
|
match handle.await {
|
|
Ok(Ok(response)) => Ok(response),
|
|
Ok(Err(FunctionCallError::Fatal(message))) => Err(CodexErr::Fatal(message)),
|
|
Ok(Err(other)) => Err(CodexErr::Fatal(other.to_string())),
|
|
Err(err) => Err(CodexErr::Fatal(format!(
|
|
"tool task failed to receive: {err:?}"
|
|
))),
|
|
}
|
|
}
|
|
.in_current_span()
|
|
}
|
|
}
|
|
|
|
impl ToolCallRuntime {
|
|
fn aborted_response(call: &ToolCall, secs: f32) -> ResponseInputItem {
|
|
match &call.payload {
|
|
ToolPayload::Custom { .. } => ResponseInputItem::CustomToolCallOutput {
|
|
call_id: call.call_id.clone(),
|
|
output: FunctionCallOutputPayload {
|
|
body: FunctionCallOutputBody::Text(Self::abort_message(call, secs)),
|
|
..Default::default()
|
|
},
|
|
},
|
|
ToolPayload::Mcp { .. } => ResponseInputItem::McpToolCallOutput {
|
|
call_id: call.call_id.clone(),
|
|
result: Err(Self::abort_message(call, secs)),
|
|
},
|
|
_ => ResponseInputItem::FunctionCallOutput {
|
|
call_id: call.call_id.clone(),
|
|
output: FunctionCallOutputPayload {
|
|
body: FunctionCallOutputBody::Text(Self::abort_message(call, secs)),
|
|
..Default::default()
|
|
},
|
|
},
|
|
}
|
|
}
|
|
|
|
fn abort_message(call: &ToolCall, secs: f32) -> String {
|
|
match call.tool_name.as_str() {
|
|
"shell" | "container.exec" | "local_shell" | "shell_command" | "unified_exec" => {
|
|
format!("Wall time: {secs:.1} seconds\naborted by user")
|
|
}
|
|
_ => format!("aborted by user after {secs:.1}s"),
|
|
}
|
|
}
|
|
}
|