mirror of
https://github.com/openai/codex.git
synced 2026-11-15 21:50:46 +00:00
Preserve one-shot exec when unified exec is disabled (#41393)
## Why Managed configuration can disable resumable unified execution while leaving shell tools enabled. This should not remove command execution entirely or grant access to retained processes. ## What changed - Keep `exec_command` available in completion-only mode when `unified_exec` is disabled. - Remove `tty`, `yield_time_ms`, `session_id`, and `write_stdin` from that mode, and add a `timeout_ms` argument. - Terminate one-shot commands on timeout or turn cancellation, reporting timed-out commands with exit code 124. ## Testing Added integration coverage for tool availability, timeout cleanup, and interruption cleanup under managed configuration. GitOrigin-RevId: a382d34f922fdc4ba52889272c6db985abd42e47
This commit is contained in:
@@ -36,6 +36,8 @@ pub(crate) struct ExecCommandArgs {
|
||||
#[serde(default = "default_exec_yield_time_ms")]
|
||||
yield_time_ms: u64,
|
||||
#[serde(default)]
|
||||
timeout_ms: Option<u64>,
|
||||
#[serde(default)]
|
||||
max_output_tokens: Option<usize>,
|
||||
#[serde(default)]
|
||||
sandbox_permissions: Option<SandboxPermissions>,
|
||||
|
||||
@@ -1,6 +1,8 @@
|
||||
use std::path::Path;
|
||||
use std::sync::Arc;
|
||||
use std::time::Duration;
|
||||
|
||||
use crate::exec::DEFAULT_EXEC_COMMAND_TIMEOUT_MS;
|
||||
use crate::exec_policy::prompt_is_rejected_by_policy;
|
||||
use crate::function_tool::FunctionCallError;
|
||||
use crate::maybe_emit_implicit_skill_invocation;
|
||||
@@ -35,6 +37,7 @@ use codex_sandboxing::SandboxManager;
|
||||
use codex_sandboxing::SandboxType;
|
||||
use codex_sandboxing::SandboxablePreference;
|
||||
use codex_shell_command::shell_detect::detect_shell_type;
|
||||
use codex_tools::JsonSchema;
|
||||
use codex_tools::ToolName;
|
||||
use codex_tools::ToolSpec;
|
||||
use codex_utils_output_truncation::approx_token_count;
|
||||
@@ -57,13 +60,21 @@ pub(crate) struct ExecCommandHandlerOptions {
|
||||
pub(crate) include_windows_shell_guidance: bool,
|
||||
}
|
||||
|
||||
#[derive(Clone, Copy)]
|
||||
enum ExecCommandLifetime {
|
||||
Interactive,
|
||||
OneShot,
|
||||
}
|
||||
|
||||
pub struct ExecCommandHandler {
|
||||
options: ExecCommandHandlerOptions,
|
||||
lifetime: ExecCommandLifetime,
|
||||
}
|
||||
|
||||
impl Default for ExecCommandHandler {
|
||||
fn default() -> Self {
|
||||
Self {
|
||||
lifetime: ExecCommandLifetime::Interactive,
|
||||
options: ExecCommandHandlerOptions {
|
||||
allow_login_shell: false,
|
||||
exec_permission_approvals_enabled: false,
|
||||
@@ -77,7 +88,17 @@ impl Default for ExecCommandHandler {
|
||||
|
||||
impl ExecCommandHandler {
|
||||
pub(crate) fn new(options: ExecCommandHandlerOptions) -> Self {
|
||||
Self { options }
|
||||
Self {
|
||||
options,
|
||||
lifetime: ExecCommandLifetime::Interactive,
|
||||
}
|
||||
}
|
||||
|
||||
pub(crate) fn one_shot(options: ExecCommandHandlerOptions) -> Self {
|
||||
Self {
|
||||
options,
|
||||
lifetime: ExecCommandLifetime::OneShot,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -87,7 +108,7 @@ impl ToolExecutor<ToolInvocation> for ExecCommandHandler {
|
||||
}
|
||||
|
||||
fn spec(&self) -> ToolSpec {
|
||||
create_exec_command_tool_with_environment_id(
|
||||
let spec = create_exec_command_tool_with_environment_id(
|
||||
CommandToolOptions {
|
||||
allow_login_shell: self.options.allow_login_shell,
|
||||
exec_permission_approvals_enabled: self.options.exec_permission_approvals_enabled,
|
||||
@@ -95,7 +116,11 @@ impl ToolExecutor<ToolInvocation> for ExecCommandHandler {
|
||||
self.options.include_environment_id,
|
||||
self.options.include_shell_parameter,
|
||||
self.options.include_windows_shell_guidance,
|
||||
)
|
||||
);
|
||||
match self.lifetime {
|
||||
ExecCommandLifetime::Interactive => spec,
|
||||
ExecCommandLifetime::OneShot => one_shot_exec_command_spec(spec),
|
||||
}
|
||||
}
|
||||
|
||||
fn supports_parallel_tool_calls(&self) -> bool {
|
||||
@@ -253,8 +278,9 @@ impl ExecCommandHandler {
|
||||
let command_for_display = codex_shell_command::parse_command::shlex_join(&command);
|
||||
|
||||
let ExecCommandArgs {
|
||||
tty,
|
||||
mut tty,
|
||||
yield_time_ms,
|
||||
timeout_ms,
|
||||
max_output_tokens,
|
||||
sandbox_permissions: _,
|
||||
additional_permissions,
|
||||
@@ -262,6 +288,15 @@ impl ExecCommandHandler {
|
||||
prefix_rule,
|
||||
..
|
||||
} = args;
|
||||
let completion_timeout = match self.lifetime {
|
||||
ExecCommandLifetime::Interactive => None,
|
||||
ExecCommandLifetime::OneShot => {
|
||||
tty = false;
|
||||
Some(Duration::from_millis(
|
||||
timeout_ms.unwrap_or(DEFAULT_EXEC_COMMAND_TIMEOUT_MS),
|
||||
))
|
||||
}
|
||||
};
|
||||
|
||||
let exec_permission_approvals_enabled =
|
||||
session.features().enabled(Feature::ExecPermissionApprovals);
|
||||
@@ -356,32 +391,34 @@ impl ExecCommandHandler {
|
||||
}
|
||||
|
||||
emit_unified_exec_tty_metric(&turn.session_telemetry, tty);
|
||||
match manager
|
||||
.exec_command(
|
||||
ExecCommandRequest {
|
||||
command,
|
||||
shell_type,
|
||||
hook_command: hook_command.clone(),
|
||||
process_id,
|
||||
yield_time_ms,
|
||||
max_output_tokens,
|
||||
cwd,
|
||||
sandbox_cwd: native_environment_cwd,
|
||||
turn_environment: turn_environment.clone(),
|
||||
shell_mode,
|
||||
network: context.step_context.turn.network.clone(),
|
||||
tty,
|
||||
sandbox_permissions: effective_additional_permissions.sandbox_permissions,
|
||||
additional_permissions: normalized_additional_permissions,
|
||||
additional_permissions_preapproved: effective_additional_permissions
|
||||
.permissions_preapproved,
|
||||
justification,
|
||||
prefix_rule,
|
||||
},
|
||||
&context,
|
||||
)
|
||||
.await
|
||||
{
|
||||
let request = ExecCommandRequest {
|
||||
command,
|
||||
shell_type,
|
||||
hook_command: hook_command.clone(),
|
||||
process_id,
|
||||
yield_time_ms,
|
||||
max_output_tokens,
|
||||
cwd,
|
||||
sandbox_cwd: native_environment_cwd,
|
||||
turn_environment: turn_environment.clone(),
|
||||
shell_mode,
|
||||
network: context.step_context.turn.network.clone(),
|
||||
tty,
|
||||
sandbox_permissions: effective_additional_permissions.sandbox_permissions,
|
||||
additional_permissions: normalized_additional_permissions,
|
||||
additional_permissions_preapproved: effective_additional_permissions
|
||||
.permissions_preapproved,
|
||||
justification,
|
||||
prefix_rule,
|
||||
};
|
||||
let result = match completion_timeout {
|
||||
Some(timeout) => {
|
||||
UnifiedExecProcessManager::exec_command_to_completion(request, &context, timeout)
|
||||
.await
|
||||
}
|
||||
None => manager.exec_command(request, &context).await,
|
||||
};
|
||||
match result {
|
||||
Ok(response) => Ok(boxed_tool_output(response)),
|
||||
Err(UnifiedExecError::SandboxDenied {
|
||||
output,
|
||||
@@ -415,6 +452,35 @@ impl ExecCommandHandler {
|
||||
}
|
||||
}
|
||||
|
||||
fn one_shot_exec_command_spec(spec: ToolSpec) -> ToolSpec {
|
||||
let ToolSpec::Function(mut spec) = spec else {
|
||||
unreachable!("exec_command has a function schema");
|
||||
};
|
||||
spec.description = spec.description.replacen(
|
||||
"Runs a command in a PTY, returning output or a session ID for ongoing interaction.",
|
||||
"Runs a command to completion and returns its output. The process is terminated on timeout or cancellation and cannot be resumed.",
|
||||
1,
|
||||
);
|
||||
let properties = spec.parameters.properties.get_or_insert_default();
|
||||
properties.remove("tty");
|
||||
properties.remove("yield_time_ms");
|
||||
properties.insert(
|
||||
"timeout_ms".to_string(),
|
||||
JsonSchema::number(Some(
|
||||
"Maximum command runtime. Defaults to 10000 ms.".to_string(),
|
||||
)),
|
||||
);
|
||||
if let Some(output_properties) = spec
|
||||
.output_schema
|
||||
.as_mut()
|
||||
.and_then(|schema| schema.get_mut("properties"))
|
||||
.and_then(serde_json::Value::as_object_mut)
|
||||
{
|
||||
output_properties.remove("session_id");
|
||||
}
|
||||
ToolSpec::Function(spec)
|
||||
}
|
||||
|
||||
impl CoreToolRuntime for ExecCommandHandler {
|
||||
fn matches_kind(&self, payload: &ToolPayload) -> bool {
|
||||
matches!(payload, ToolPayload::Function { .. })
|
||||
|
||||
@@ -1084,7 +1084,6 @@ fn add_shell_tools(context: &CoreToolPlanContext<'_>, registry: &mut ToolRegistr
|
||||
let environment_mode = tool_environment_mode(context.environments);
|
||||
if !environment_mode.has_environment()
|
||||
|| !features.enabled(Feature::ShellTool)
|
||||
|| !features.enabled(Feature::UnifiedExec)
|
||||
|| matches!(context.model_info.shell_type, ConfigShellToolType::Disabled)
|
||||
{
|
||||
return;
|
||||
@@ -1093,7 +1092,7 @@ fn add_shell_tools(context: &CoreToolPlanContext<'_>, registry: &mut ToolRegistr
|
||||
let allow_login_shell = any_environment_allows_login_shell(context.environments);
|
||||
let exec_permission_approvals_enabled = features.enabled(Feature::ExecPermissionApprovals);
|
||||
let include_environment_id = matches!(environment_mode, ToolEnvironmentMode::Multiple);
|
||||
registry.add(ExecCommandHandler::new(ExecCommandHandlerOptions {
|
||||
let options = ExecCommandHandlerOptions {
|
||||
allow_login_shell,
|
||||
exec_permission_approvals_enabled,
|
||||
include_environment_id,
|
||||
@@ -1102,8 +1101,16 @@ fn add_shell_tools(context: &CoreToolPlanContext<'_>, registry: &mut ToolRegistr
|
||||
context.environments,
|
||||
),
|
||||
include_windows_shell_guidance: should_include_windows_shell_guidance(context.environments),
|
||||
}));
|
||||
registry.add(WriteStdinHandler);
|
||||
};
|
||||
if features.enabled(Feature::UnifiedExec) {
|
||||
registry.add(ExecCommandHandler::new(options));
|
||||
registry.add(WriteStdinHandler);
|
||||
} else {
|
||||
// Managed requirements are the only configuration path that can keep
|
||||
// unified exec disabled. Preserve command execution without exposing a
|
||||
// resumable process or write_stdin authority prohibited by policy.
|
||||
registry.add(ExecCommandHandler::one_shot(options));
|
||||
}
|
||||
}
|
||||
|
||||
fn unified_exec_should_include_shell_parameter(
|
||||
|
||||
Reference in New Issue
Block a user