mirror of
https://github.com/pchuan98/codex.git
synced 2026-07-01 00:31:56 +08:00
## Summary
- Fix `js_repl` so `await codex.tool("view_image", { path })` actually
attaches the image to the active turn when called from inside the JS
REPL.
- Restore the behavior expected by the existing `js_repl`
image-attachment test.
- This is a follow-up to
[#12553](https://github.com/openai/codex/pull/12553), which changed
`view_image` to return structured image content.
## Root Cause
- [#12553](https://github.com/openai/codex/pull/12553) changed
`view_image` from directly injecting a pending user image message to
returning structured `function_call_output` content items.
- The nested tool-call bridge inside `js_repl` serialized that tool
response back to the JS runtime, but it did not mirror returned image
content into the active turn.
- As a result, `view_image` appeared to succeed inside `js_repl`, but no
`input_image` was actually attached for the outer turn.
## What Changed
- Updated the nested tool-call path in `js_repl` to inspect function
tool responses for structured content items.
- When a nested tool response includes `input_image` content, `js_repl`
now injects a corresponding user `Message` into the active turn before
returning the raw tool result back to the JS runtime.
- Kept the normal JSON result flow intact, so `codex.tool(...)` still
returns the original tool output object to JavaScript.
## Why
- `js_repl` documentation and tests already assume that `view_image` can
be used from inside the REPL to attach generated images to the model.
- Without this fix, the nested call path silently dropped that
attachment behavior.
332 lines
11 KiB
Rust
332 lines
11 KiB
Rust
use crate::client_common::tools::ToolSpec;
|
|
use crate::codex::Session;
|
|
use crate::codex::TurnContext;
|
|
use crate::function_tool::FunctionCallError;
|
|
use crate::mcp_connection_manager::ToolInfo;
|
|
use crate::sandboxing::SandboxPermissions;
|
|
use crate::tools::context::SharedTurnDiffTracker;
|
|
use crate::tools::context::ToolInvocation;
|
|
use crate::tools::context::ToolPayload;
|
|
use crate::tools::registry::ConfiguredToolSpec;
|
|
use crate::tools::registry::ToolRegistry;
|
|
use crate::tools::spec::ToolsConfig;
|
|
use crate::tools::spec::build_specs;
|
|
use codex_protocol::dynamic_tools::DynamicToolSpec;
|
|
use codex_protocol::models::FunctionCallOutputBody;
|
|
use codex_protocol::models::LocalShellAction;
|
|
use codex_protocol::models::ResponseInputItem;
|
|
use codex_protocol::models::ResponseItem;
|
|
use codex_protocol::models::ShellToolCallParams;
|
|
use rmcp::model::Tool;
|
|
use std::collections::HashMap;
|
|
use std::sync::Arc;
|
|
use tracing::instrument;
|
|
|
|
pub use crate::tools::context::ToolCallSource;
|
|
|
|
#[derive(Clone, Debug)]
|
|
pub struct ToolCall {
|
|
pub tool_name: String,
|
|
pub call_id: String,
|
|
pub payload: ToolPayload,
|
|
}
|
|
|
|
pub struct ToolRouter {
|
|
registry: ToolRegistry,
|
|
specs: Vec<ConfiguredToolSpec>,
|
|
}
|
|
|
|
impl ToolRouter {
|
|
pub fn from_config(
|
|
config: &ToolsConfig,
|
|
mcp_tools: Option<HashMap<String, Tool>>,
|
|
app_tools: Option<HashMap<String, ToolInfo>>,
|
|
dynamic_tools: &[DynamicToolSpec],
|
|
) -> Self {
|
|
let builder = build_specs(config, mcp_tools, app_tools, dynamic_tools);
|
|
let (specs, registry) = builder.build();
|
|
|
|
Self { registry, specs }
|
|
}
|
|
|
|
pub fn specs(&self) -> Vec<ToolSpec> {
|
|
self.specs
|
|
.iter()
|
|
.map(|config| config.spec.clone())
|
|
.collect()
|
|
}
|
|
|
|
pub fn tool_supports_parallel(&self, tool_name: &str) -> bool {
|
|
self.specs
|
|
.iter()
|
|
.filter(|config| config.supports_parallel_tool_calls)
|
|
.any(|config| config.spec.name() == tool_name)
|
|
}
|
|
|
|
#[instrument(level = "trace", skip_all, err)]
|
|
pub async fn build_tool_call(
|
|
session: &Session,
|
|
item: ResponseItem,
|
|
) -> Result<Option<ToolCall>, FunctionCallError> {
|
|
match item {
|
|
ResponseItem::FunctionCall {
|
|
name,
|
|
arguments,
|
|
call_id,
|
|
..
|
|
} => {
|
|
if let Some((server, tool)) = session.parse_mcp_tool_name(&name).await {
|
|
Ok(Some(ToolCall {
|
|
tool_name: name,
|
|
call_id,
|
|
payload: ToolPayload::Mcp {
|
|
server,
|
|
tool,
|
|
raw_arguments: arguments,
|
|
},
|
|
}))
|
|
} else {
|
|
Ok(Some(ToolCall {
|
|
tool_name: name,
|
|
call_id,
|
|
payload: ToolPayload::Function { arguments },
|
|
}))
|
|
}
|
|
}
|
|
ResponseItem::CustomToolCall {
|
|
name,
|
|
input,
|
|
call_id,
|
|
..
|
|
} => Ok(Some(ToolCall {
|
|
tool_name: name,
|
|
call_id,
|
|
payload: ToolPayload::Custom { input },
|
|
})),
|
|
ResponseItem::LocalShellCall {
|
|
id,
|
|
call_id,
|
|
action,
|
|
..
|
|
} => {
|
|
let call_id = call_id
|
|
.or(id)
|
|
.ok_or(FunctionCallError::MissingLocalShellCallId)?;
|
|
|
|
match action {
|
|
LocalShellAction::Exec(exec) => {
|
|
let params = ShellToolCallParams {
|
|
command: exec.command,
|
|
workdir: exec.working_directory,
|
|
timeout_ms: exec.timeout_ms,
|
|
sandbox_permissions: Some(SandboxPermissions::UseDefault),
|
|
additional_permissions: None,
|
|
prefix_rule: None,
|
|
justification: None,
|
|
};
|
|
Ok(Some(ToolCall {
|
|
tool_name: "local_shell".to_string(),
|
|
call_id,
|
|
payload: ToolPayload::LocalShell { params },
|
|
}))
|
|
}
|
|
}
|
|
}
|
|
_ => Ok(None),
|
|
}
|
|
}
|
|
|
|
#[instrument(level = "trace", skip_all, err)]
|
|
pub async fn dispatch_tool_call(
|
|
&self,
|
|
session: Arc<Session>,
|
|
turn: Arc<TurnContext>,
|
|
tracker: SharedTurnDiffTracker,
|
|
call: ToolCall,
|
|
source: ToolCallSource,
|
|
) -> Result<ResponseInputItem, FunctionCallError> {
|
|
let ToolCall {
|
|
tool_name,
|
|
call_id,
|
|
payload,
|
|
} = call;
|
|
let payload_outputs_custom = matches!(payload, ToolPayload::Custom { .. });
|
|
let failure_call_id = call_id.clone();
|
|
|
|
if source == ToolCallSource::Direct
|
|
&& turn.tools_config.js_repl_tools_only
|
|
&& !matches!(tool_name.as_str(), "js_repl" | "js_repl_reset")
|
|
{
|
|
let err = FunctionCallError::RespondToModel(
|
|
"direct tool calls are disabled; use js_repl and codex.tool(...) instead"
|
|
.to_string(),
|
|
);
|
|
return Ok(Self::failure_response(
|
|
failure_call_id,
|
|
payload_outputs_custom,
|
|
err,
|
|
));
|
|
}
|
|
|
|
let invocation = ToolInvocation {
|
|
session,
|
|
turn,
|
|
tracker,
|
|
call_id,
|
|
tool_name,
|
|
payload,
|
|
};
|
|
|
|
match self.registry.dispatch(invocation).await {
|
|
Ok(response) => Ok(response),
|
|
Err(FunctionCallError::Fatal(message)) => Err(FunctionCallError::Fatal(message)),
|
|
Err(err) => Ok(Self::failure_response(
|
|
failure_call_id,
|
|
payload_outputs_custom,
|
|
err,
|
|
)),
|
|
}
|
|
}
|
|
|
|
fn failure_response(
|
|
call_id: String,
|
|
payload_outputs_custom: bool,
|
|
err: FunctionCallError,
|
|
) -> ResponseInputItem {
|
|
let message = err.to_string();
|
|
if payload_outputs_custom {
|
|
ResponseInputItem::CustomToolCallOutput {
|
|
call_id,
|
|
output: message,
|
|
}
|
|
} else {
|
|
ResponseInputItem::FunctionCallOutput {
|
|
call_id,
|
|
output: codex_protocol::models::FunctionCallOutputPayload {
|
|
body: FunctionCallOutputBody::Text(message),
|
|
success: Some(false),
|
|
},
|
|
}
|
|
}
|
|
}
|
|
}
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use std::sync::Arc;
|
|
|
|
use crate::codex::make_session_and_context;
|
|
use crate::tools::context::ToolPayload;
|
|
use crate::turn_diff_tracker::TurnDiffTracker;
|
|
use codex_protocol::models::ResponseInputItem;
|
|
|
|
use super::ToolCall;
|
|
use super::ToolCallSource;
|
|
use super::ToolRouter;
|
|
|
|
#[tokio::test]
|
|
async fn js_repl_tools_only_blocks_direct_tool_calls() -> anyhow::Result<()> {
|
|
let (session, mut turn) = make_session_and_context().await;
|
|
turn.tools_config.js_repl_tools_only = true;
|
|
|
|
let session = Arc::new(session);
|
|
let turn = Arc::new(turn);
|
|
let mcp_tools = session
|
|
.services
|
|
.mcp_connection_manager
|
|
.read()
|
|
.await
|
|
.list_all_tools()
|
|
.await;
|
|
let app_tools = Some(mcp_tools.clone());
|
|
let router = ToolRouter::from_config(
|
|
&turn.tools_config,
|
|
Some(
|
|
mcp_tools
|
|
.into_iter()
|
|
.map(|(name, tool)| (name, tool.tool))
|
|
.collect(),
|
|
),
|
|
app_tools,
|
|
turn.dynamic_tools.as_slice(),
|
|
);
|
|
|
|
let call = ToolCall {
|
|
tool_name: "shell".to_string(),
|
|
call_id: "call-1".to_string(),
|
|
payload: ToolPayload::Function {
|
|
arguments: "{}".to_string(),
|
|
},
|
|
};
|
|
let tracker = Arc::new(tokio::sync::Mutex::new(TurnDiffTracker::new()));
|
|
let response = router
|
|
.dispatch_tool_call(session, turn, tracker, call, ToolCallSource::Direct)
|
|
.await?;
|
|
|
|
match response {
|
|
ResponseInputItem::FunctionCallOutput { output, .. } => {
|
|
let content = output.text_content().unwrap_or_default();
|
|
assert!(
|
|
content.contains("direct tool calls are disabled"),
|
|
"unexpected tool call message: {content}",
|
|
);
|
|
}
|
|
other => panic!("expected function call output, got {other:?}"),
|
|
}
|
|
|
|
Ok(())
|
|
}
|
|
|
|
#[tokio::test]
|
|
async fn js_repl_tools_only_allows_js_repl_source_calls() -> anyhow::Result<()> {
|
|
let (session, mut turn) = make_session_and_context().await;
|
|
turn.tools_config.js_repl_tools_only = true;
|
|
|
|
let session = Arc::new(session);
|
|
let turn = Arc::new(turn);
|
|
let mcp_tools = session
|
|
.services
|
|
.mcp_connection_manager
|
|
.read()
|
|
.await
|
|
.list_all_tools()
|
|
.await;
|
|
let app_tools = Some(mcp_tools.clone());
|
|
let router = ToolRouter::from_config(
|
|
&turn.tools_config,
|
|
Some(
|
|
mcp_tools
|
|
.into_iter()
|
|
.map(|(name, tool)| (name, tool.tool))
|
|
.collect(),
|
|
),
|
|
app_tools,
|
|
turn.dynamic_tools.as_slice(),
|
|
);
|
|
|
|
let call = ToolCall {
|
|
tool_name: "shell".to_string(),
|
|
call_id: "call-2".to_string(),
|
|
payload: ToolPayload::Function {
|
|
arguments: "{}".to_string(),
|
|
},
|
|
};
|
|
let tracker = Arc::new(tokio::sync::Mutex::new(TurnDiffTracker::new()));
|
|
let response = router
|
|
.dispatch_tool_call(session, turn, tracker, call, ToolCallSource::JsRepl)
|
|
.await?;
|
|
|
|
match response {
|
|
ResponseInputItem::FunctionCallOutput { output, .. } => {
|
|
let content = output.text_content().unwrap_or_default();
|
|
assert!(
|
|
!content.contains("direct tool calls are disabled"),
|
|
"js_repl source should bypass direct-call policy gate"
|
|
);
|
|
}
|
|
other => panic!("expected function call output, got {other:?}"),
|
|
}
|
|
|
|
Ok(())
|
|
}
|
|
}
|