Files
dbx/crates/dbx-core/src/ai_codex_cli.rs
T

1795 lines
71 KiB
Rust

use crate::agent_events::AgentEvent;
use crate::ai::{
AiCapabilitySource, AiConfig, AiEffortCapability, AiEffortSelection, AiModelInfo, AiReasoningLevel,
AiTestConnectionResult,
};
use crate::ai_cli_agent::{
append_config_overrides, build_cli_agent_prompt, cli_command, dbx_mcp_enabled_tools, dbx_mcp_scope_env,
model_infos, parse_cli_jsonl_event, run_cli_jsonl_agent, toml_string, toml_string_array, CliAgentCommandSpec,
CliAgentJsonlDialect, CliAgentProcessSpec, CliAgentRunOptions,
};
use base64::Engine;
use serde_json::{json, Value};
use std::collections::hash_map::DefaultHasher;
use std::collections::{BTreeMap, BTreeSet};
use std::env;
use std::future::Future;
use std::hash::{Hash, Hasher};
use std::path::{Path, PathBuf};
use std::process::Stdio;
use std::sync::LazyLock;
use std::time::{Duration, Instant};
use tokio::io::{AsyncBufReadExt, AsyncWriteExt, BufReader};
use tokio::sync::{Mutex, Notify};
const DEFAULT_CODEX_MODELS: &[&str] = &["default", "gpt-5.5", "gpt-5.4-mini"];
const CODEX_MODEL_SUCCESS_CACHE_TTL: Duration = Duration::from_secs(5 * 60);
const CODEX_MODEL_COMPATIBILITY_CACHE_TTL: Duration = Duration::from_secs(30);
const CODEX_MODEL_NEGATIVE_CACHE_TTL: Duration = Duration::from_secs(10);
// Codex app-server and npm-installed CLI can take several seconds to cold-start,
// especially on Windows. Keep discovery bounded while allowing capability metadata
// to be returned before falling back to the static catalog.
const CODEX_MODEL_DISCOVERY_TIMEOUT: Duration = Duration::from_secs(15);
const CODEX_MODEL_COMPATIBILITY_TIMEOUT: Duration = Duration::from_secs(10);
#[cfg(not(windows))]
const CODEX_PATH_MARKER: &str = "__DBX_CODEX_PATH__";
#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord)]
enum CodexModelCacheClass {
StaticFallback,
CompatibilityFallback,
Capability,
}
impl CodexModelCacheClass {
fn ttl(self) -> Duration {
match self {
Self::Capability => CODEX_MODEL_SUCCESS_CACHE_TTL,
Self::CompatibilityFallback => CODEX_MODEL_COMPATIBILITY_CACHE_TTL,
Self::StaticFallback => CODEX_MODEL_NEGATIVE_CACHE_TTL,
}
}
}
#[derive(Clone)]
struct CodexModelDiscovery {
class: CodexModelCacheClass,
models: Vec<AiModelInfo>,
}
#[derive(Clone)]
struct CachedCodexModels {
key: u64,
loaded_at: Instant,
class: CodexModelCacheClass,
models: Vec<AiModelInfo>,
}
impl CachedCodexModels {
fn is_fresh(&self, key: u64, now: Instant) -> bool {
self.key == key && now.saturating_duration_since(self.loaded_at) < self.class.ttl()
}
}
static CODEX_MODEL_CACHE: LazyLock<Mutex<Option<CachedCodexModels>>> = LazyLock::new(|| Mutex::new(None));
pub type CodexRunOptions = CliAgentRunOptions;
pub type CodexCommandSpec = CliAgentCommandSpec;
fn codex_program(config: &AiConfig) -> String {
config.codex_cli_path.as_deref().map(str::trim).filter(|path| !path.is_empty()).unwrap_or("codex").to_string()
}
async fn resolve_codex_command(config: &AiConfig) -> CodexCommandSpec {
let configured = codex_program(config);
if is_path_like_program(&configured) {
let expanded = expand_tilde(&configured);
return codex_command_for_program(direct_program_path(&expanded).unwrap_or(expanded));
}
if let Some(path) = resolve_program_path(&configured).await {
codex_command_for_program(path)
} else {
CodexCommandSpec { program: configured, args: Vec::new() }
}
}
fn codex_command_for_program(program: String) -> CodexCommandSpec {
#[cfg(windows)]
if let Some(command) = windows_npm_codex_shim_command(&program) {
return command;
}
CodexCommandSpec { program, args: Vec::new() }
}
#[cfg(windows)]
fn windows_npm_codex_shim_command(program: &str) -> Option<CodexCommandSpec> {
let path = Path::new(program);
let extension = path.extension()?.to_str()?.to_ascii_lowercase();
if extension != "cmd" && extension != "bat" {
return None;
}
let parent = path.parent()?;
let codex_js = parent.join("node_modules").join("@openai").join("codex").join("bin").join("codex.js");
if !codex_js.is_file() {
return None;
}
let bundled_node = parent.join("node.exe");
let node = if bundled_node.is_file() { bundled_node.to_string_lossy().to_string() } else { "node".to_string() };
Some(CodexCommandSpec { program: node, args: vec![codex_js.to_string_lossy().to_string()] })
}
fn codex_process_env(config: &AiConfig, command: &CodexCommandSpec) -> Result<Vec<(String, String)>, String> {
let inherited_env_keys = env::vars_os().map(|(key, _)| key.to_string_lossy().into_owned()).collect::<Vec<_>>();
codex_process_env_with_system_proxy(
config,
command,
crate::update::system_proxy_url().as_deref(),
&inherited_env_keys,
)
}
fn codex_process_env_with_system_proxy(
config: &AiConfig,
command: &CodexCommandSpec,
system_proxy: Option<&str>,
inherited_env_keys: &[String],
) -> Result<Vec<(String, String)>, String> {
let mut env = BTreeMap::from_iter(codex_cli_env(config)?);
if let Some(proxy) = system_proxy.filter(|proxy| !proxy.trim().is_empty()) {
insert_env_if_absent(&mut env, inherited_env_keys, "HTTP_PROXY", proxy);
insert_env_if_absent(&mut env, inherited_env_keys, "HTTPS_PROXY", proxy);
}
if let Some(dir) = command.parent_dir() {
let user_path = env.get("PATH").map(String::as_str);
env.insert("PATH".to_string(), merged_path_with_dir(&dir, user_path));
}
Ok(env.into_iter().collect())
}
fn insert_env_if_absent(env: &mut BTreeMap<String, String>, inherited_env_keys: &[String], key: &str, value: &str) {
// Child processes inherit the parent environment, so an inherited lowercase proxy must also block uppercase injection.
let is_present = env.keys().chain(inherited_env_keys).any(|existing| existing.eq_ignore_ascii_case(key));
if !is_present {
env.insert(key.to_string(), value.to_string());
}
}
trait CommandParentDir {
fn parent_dir(&self) -> Option<String>;
}
impl CommandParentDir for CodexCommandSpec {
fn parent_dir(&self) -> Option<String> {
Path::new(&self.program)
.parent()
.filter(|parent| !parent.as_os_str().is_empty())
.map(|parent| parent.to_string_lossy().to_string())
}
}
async fn resolve_program_path(program: &str) -> Option<String> {
if let Some(path) = direct_program_path(program) {
return Some(path);
}
if let Some(path) = common_program_path(program) {
return Some(path);
}
shell_program_path(program).await
}
fn direct_program_path(program: &str) -> Option<String> {
let path = Path::new(program);
if !path.is_absolute() {
return None;
}
if path.is_dir() {
return launchable_program_in_dir(path, "codex");
}
if path.is_file() {
#[cfg(windows)]
return windows_launchable_program_path(path);
#[cfg(not(windows))]
return Some(path.to_string_lossy().to_string());
}
None
}
fn launchable_program_in_dir(dir: &Path, program: &str) -> Option<String> {
program_path_candidates(dir, program)
.into_iter()
.find(|candidate| is_launchable_program_path(candidate) && candidate.is_file())
.map(|path| path.to_string_lossy().to_string())
}
#[cfg(windows)]
fn windows_launchable_program_path(path: &Path) -> Option<String> {
if is_windows_launchable_program(path) {
return Some(path.to_string_lossy().to_string());
}
let parent = path.parent()?;
let stem = path.file_name()?.to_str()?;
program_path_candidates(parent, stem)
.into_iter()
.find(|candidate| is_windows_launchable_program(candidate))
.and_then(|candidate| candidate.is_file().then(|| candidate.to_string_lossy().to_string()))
}
#[cfg(windows)]
fn is_windows_launchable_program(path: &Path) -> bool {
matches!(
path.extension().and_then(|extension| extension.to_str()).map(str::to_ascii_lowercase).as_deref(),
Some("exe" | "cmd" | "bat" | "com")
)
}
fn common_program_path(program: &str) -> Option<String> {
common_executable_dirs()
.into_iter()
.flat_map(|dir| program_path_candidates(&dir, program))
.filter(|path| is_launchable_program_path(path))
.find(|path| path.is_file())
.map(|path| path.to_string_lossy().to_string())
}
#[cfg(not(windows))]
fn is_launchable_program_path(_path: &Path) -> bool {
true
}
#[cfg(windows)]
fn is_launchable_program_path(path: &Path) -> bool {
is_windows_launchable_program(path)
}
#[cfg(not(windows))]
fn program_path_candidates(dir: &Path, program: &str) -> Vec<PathBuf> {
vec![dir.join(program)]
}
#[cfg(windows)]
fn program_path_candidates(dir: &Path, program: &str) -> Vec<PathBuf> {
let path = Path::new(program);
if path.extension().is_some() {
return vec![dir.join(program)];
}
[".cmd", ".exe", ".bat", ".com", "", ".ps1"]
.iter()
.map(|extension| dir.join(format!("{program}{extension}")))
.collect()
}
#[cfg(not(windows))]
async fn shell_program_path(program: &str) -> Option<String> {
let script = shell_resolve_script(program);
let mut command = cli_command(user_shell());
command.args(user_shell_args(&script));
command.stdin(Stdio::null()).stdout(Stdio::piped()).stderr(Stdio::null());
let output = command.output().await.ok()?;
output.status.success().then_some(())?;
let stdout = String::from_utf8_lossy(&output.stdout);
stdout
.find(CODEX_PATH_MARKER)
.and_then(|index| {
stdout[index + CODEX_PATH_MARKER.len()..].lines().map(str::trim).find(|line| !line.is_empty())
})
.filter(|path| Path::new(path).is_file())
.map(ToString::to_string)
}
#[cfg(windows)]
async fn shell_program_path(program: &str) -> Option<String> {
let script = format!("(Get-Command -All {} -ErrorAction SilentlyContinue).Source", windows_shell_quote(program));
let mut command = cli_command("powershell.exe");
command.args(["-NoProfile", "-Command", &script]);
command.stdin(Stdio::null()).stdout(Stdio::piped()).stderr(Stdio::null());
let output = command.output().await.ok()?;
output.status.success().then_some(())?;
let stdout = String::from_utf8_lossy(&output.stdout);
first_windows_program_path(&stdout)
}
#[cfg(windows)]
fn first_windows_program_path(value: &str) -> Option<String> {
let paths = value.lines().map(str::trim).filter(|line| !line.is_empty()).collect::<Vec<_>>();
paths
.into_iter()
.find(|path| is_windows_launchable_program(Path::new(path)) && Path::new(path).is_file())
.map(ToOwned::to_owned)
}
#[cfg(windows)]
fn windows_shell_quote(value: &str) -> String {
format!("'{}'", value.replace('\'', "''"))
}
fn is_path_like_program(program: &str) -> bool {
program.contains('/') || program.contains('\\') || program.starts_with('~')
}
fn expand_tilde(path: &str) -> String {
crate::path_utils::expand_tilde(path)
}
fn common_executable_dirs() -> Vec<PathBuf> {
let mut dirs = Vec::new();
if let Ok(path) = env::var("PATH") {
dirs.extend(env::split_paths(&path));
}
#[cfg(windows)]
{
if let Ok(app_data) = env::var("APPDATA") {
dirs.push(PathBuf::from(app_data).join("npm"));
}
}
#[cfg(not(windows))]
{
dirs.extend([
PathBuf::from("/opt/homebrew/bin"),
PathBuf::from("/usr/local/bin"),
PathBuf::from("/usr/bin"),
PathBuf::from("/bin"),
PathBuf::from("/usr/sbin"),
PathBuf::from("/sbin"),
]);
}
dirs
}
fn merged_path_with_dir(dir: &str, user_path: Option<&str>) -> String {
let mut seen = BTreeSet::new();
let mut dirs = vec![PathBuf::from(dir)];
if let Some(path) = user_path {
dirs.extend(env::split_paths(path));
}
dirs.extend(common_executable_dirs());
let paths = dirs.into_iter().filter(|path| seen.insert(path.clone())).collect::<Vec<_>>();
env::join_paths(paths).unwrap_or_default().to_string_lossy().to_string()
}
#[cfg(not(windows))]
fn user_shell() -> String {
env::var("SHELL").ok().filter(|value| !value.trim().is_empty()).unwrap_or_else(|| {
if Path::new("/bin/zsh").exists() {
"/bin/zsh".to_string()
} else {
"/bin/sh".to_string()
}
})
}
#[cfg(not(windows))]
fn user_shell_args(script: &str) -> Vec<String> {
let shell = user_shell();
let shell_name = Path::new(&shell).file_name().and_then(|value| value.to_str()).unwrap_or_default();
match shell_name {
"fish" => vec!["-l".to_string(), "-i".to_string(), "-c".to_string(), script.to_string()],
"bash" => vec![
"--noprofile".to_string(),
"--norc".to_string(),
"-i".to_string(),
"-c".to_string(),
bash_login_script(script),
],
"sh" | "dash" => vec!["-ic".to_string(), script.to_string()],
"zsh" => vec!["-ilc".to_string(), script.to_string()],
_ => vec!["-lc".to_string(), script.to_string()],
}
}
#[cfg(not(windows))]
fn bash_login_script(script: &str) -> String {
format!(
"for dbx_profile in ~/.bash_profile ~/.bash_login ~/.profile ~/.bashrc; do \
[ -r \"$dbx_profile\" ] && . \"$dbx_profile\"; \
done; unset dbx_profile; {script}"
)
}
#[cfg(not(windows))]
fn shell_resolve_script(program: &str) -> String {
format!("printf '%s\\n' {}; command -v {}", shell_quote(CODEX_PATH_MARKER), shell_quote(program))
}
#[cfg(not(windows))]
fn shell_quote(value: &str) -> String {
if value.is_empty() {
return "''".to_string();
}
format!("'{}'", value.replace('\'', "'\"'\"'"))
}
fn validate_codex_program(config: &AiConfig) -> Result<String, String> {
let program = codex_program(config);
if starts_with_env_assignment(&program) {
return Err("[codexCliPathInvalid] Codex CLI path should contain only the executable path. Add environment variables in the Codex CLI environment variables section.".to_string());
}
if is_path_like_program(&program) {
let expanded = expand_tilde(&program);
let path = Path::new(&expanded);
if path.is_dir() && direct_program_path(&expanded).is_none() {
return Err("[codexCliPathInvalid] Codex CLI path should point to the Codex executable or a directory containing codex.".to_string());
}
}
Ok(program)
}
pub fn codex_cli_env(config: &AiConfig) -> Result<Vec<(String, String)>, String> {
let mut env = BTreeMap::new();
for (key, value) in &config.codex_cli_env {
let key = key.trim();
if key.is_empty() {
continue;
}
if !is_env_var_name(key) {
return Err(format!(
"[codexEnvInvalid] Invalid Codex CLI environment variable name `{key}`. Use names like HTTPS_PROXY."
));
}
if is_reserved_dbx_mcp_env_name(key) {
return Err(format!(
"[codexEnvReserved] `{key}` is managed by DBX for the scoped MCP server and cannot be set here."
));
}
env.insert(key.to_string(), value.clone());
}
Ok(env.into_iter().collect())
}
fn starts_with_env_assignment(program: &str) -> bool {
let Some(first_token) = program.split_whitespace().next() else {
return false;
};
let Some((key, _)) = first_token.split_once('=') else {
return false;
};
is_env_var_name(key)
}
fn is_env_var_name(name: &str) -> bool {
let mut chars = name.chars();
let Some(first) = chars.next() else {
return false;
};
(first == '_' || first.is_ascii_alphabetic()) && chars.all(|ch| ch == '_' || ch.is_ascii_alphanumeric())
}
fn is_reserved_dbx_mcp_env_name(name: &str) -> bool {
name.to_ascii_uppercase().starts_with("DBX_MCP_")
}
pub fn codex_enabled_tools(agent_mode: bool) -> Vec<&'static str> {
dbx_mcp_enabled_tools(agent_mode)
}
fn codex_mcp_config_overrides(options: &CodexRunOptions) -> Vec<String> {
let mcp_command =
options.mcp_server_command.as_ref().map(|command| command.program.as_str()).unwrap_or("dbx-mcp-server");
let mut overrides = vec![
format!("mcp_servers.dbx.command={}", toml_string(mcp_command)),
"mcp_servers.dbx.required=true".to_string(),
"mcp_servers.dbx.startup_timeout_sec=20".to_string(),
"mcp_servers.dbx.tool_timeout_sec=120".to_string(),
"mcp_servers.dbx.default_tools_approval_mode=\"approve\"".to_string(),
format!("mcp_servers.dbx.enabled_tools={}", toml_string_array(&dbx_mcp_enabled_tools(options.agent_mode))),
];
if let Some(command) = options.mcp_server_command.as_ref().filter(|command| !command.args.is_empty()) {
let args = command.args.iter().map(String::as_str).collect::<Vec<_>>();
overrides.push(format!("mcp_servers.dbx.args={}", toml_string_array(&args)));
}
overrides.extend(
dbx_mcp_scope_env(options)
.into_iter()
.map(|(name, value)| format!("mcp_servers.dbx.env.{name}={}", toml_string(&value))),
);
overrides
}
pub fn build_codex_exec_command(config: &AiConfig, _prompt: &str, options: &CodexRunOptions) -> CodexCommandSpec {
let mut args = vec![
"exec".to_string(),
"--json".to_string(),
"--skip-git-repo-check".to_string(),
"--sandbox".to_string(),
"read-only".to_string(),
];
let mut config_overrides = vec!["features.shell_tool=false".to_string(), "web_search=\"disabled\"".to_string()];
let reasoning_effort = match config.runtime_effort.as_ref() {
Some(effort) => effort.cli_value(),
None => config.reasoning_level.as_codex_effort().map(ToString::to_string),
};
if let Some(reasoning_effort) = reasoning_effort {
config_overrides.push(format!("model_reasoning_effort={}", toml_string(&reasoning_effort)));
}
append_config_overrides(&mut args, config_overrides.into_iter().chain(codex_mcp_config_overrides(options)));
let model = config.model.trim();
if !model.is_empty() && !model.eq_ignore_ascii_case("default") {
args.push("--model".to_string());
args.push(model.to_string());
}
args.push("-".to_string());
CodexCommandSpec { program: codex_program(config), args }
}
pub fn build_codex_prompt(system_prompt: &str, messages: &[crate::ai::AiMessage], allow_write_sql: bool) -> String {
build_cli_agent_prompt("Codex", system_prompt, messages, allow_write_sql)
}
fn materialize_codex_images(
images: &[crate::ai::AiInlineImage],
) -> Result<(Option<tempfile::TempDir>, Vec<PathBuf>), String> {
const MAX_CODEX_IMAGE_BASE64_CHARS: usize = 7 * 1024 * 1024;
if images.is_empty() {
return Ok((None, Vec::new()));
}
let directory = tempfile::Builder::new().prefix("dbx-ai-images-").tempdir().map_err(|error| {
format!("[codexImageAttachmentFailed] Could not create image attachment directory: {error}")
})?;
let mut paths = Vec::with_capacity(images.len());
for (index, image) in images.iter().enumerate() {
if image.data.is_empty() || image.data.len() > MAX_CODEX_IMAGE_BASE64_CHARS {
return Err("[codexImageAttachmentFailed] Image attachment exceeds the supported size limit".to_string());
}
let extension = match image.media_type.as_str() {
"image/png" => "png",
"image/jpeg" => "jpg",
"image/gif" => "gif",
"image/webp" => "webp",
_ => {
return Err(format!("[codexImageAttachmentFailed] Unsupported image media type: {}", image.media_type))
}
};
let bytes = base64::engine::general_purpose::STANDARD
.decode(&image.data)
.map_err(|error| format!("[codexImageAttachmentFailed] Could not decode image attachment: {error}"))?;
let path = directory.path().join(format!("attachment-{}.{}", index + 1, extension));
std::fs::write(&path, bytes)
.map_err(|error| format!("[codexImageAttachmentFailed] Could not write image attachment: {error}"))?;
paths.push(path);
}
Ok((Some(directory), paths))
}
fn attach_codex_images(command: &mut CodexCommandSpec, image_paths: &[PathBuf]) {
let prompt_index = command.args.iter().rposition(|arg| arg == "-").unwrap_or(command.args.len());
let args = image_paths
.iter()
.flat_map(|path| ["--image".to_string(), path.to_string_lossy().into_owned()])
.collect::<Vec<_>>();
command.args.splice(prompt_index..prompt_index, args);
}
pub async fn list_codex_models(config: &AiConfig) -> Result<Vec<AiModelInfo>, String> {
validate_codex_program(config)?;
let command = resolve_codex_command(config).await;
let process_env = codex_process_env(config, &command)?;
let cache_key = codex_model_cache_key(&command, &process_env);
Ok(list_codex_models_cached(&CODEX_MODEL_CACHE, cache_key, || async {
list_codex_models_uncached(&command, &process_env).await
})
.await)
}
async fn list_codex_models_cached<F, Fut>(
cache: &Mutex<Option<CachedCodexModels>>,
cache_key: u64,
discover: F,
) -> Vec<AiModelInfo>
where
F: FnOnce() -> Fut,
Fut: Future<Output = CodexModelDiscovery>,
{
let now = Instant::now();
if let Some(models) = {
let cache = cache.lock().await;
cache.as_ref().filter(|entry| entry.is_fresh(cache_key, now)).map(|entry| entry.models.clone())
} {
return models;
}
let discovery = discover().await;
let loaded_at = Instant::now();
let mut cache = cache.lock().await;
if let Some(entry) = cache.as_ref().filter(|entry| entry.is_fresh(cache_key, loaded_at)) {
if entry.class >= discovery.class {
return entry.models.clone();
}
}
*cache =
Some(CachedCodexModels { key: cache_key, loaded_at, class: discovery.class, models: discovery.models.clone() });
discovery.models
}
fn codex_model_cache_key(command: &CodexCommandSpec, process_env: &[(String, String)]) -> u64 {
let mut hasher = DefaultHasher::new();
command.program.hash(&mut hasher);
command.args.hash(&mut hasher);
process_env.hash(&mut hasher);
for name in [
"CODEX_HOME",
"OPENAI_API_KEY",
"CODEX_API_KEY",
"OPENAI_BASE_URL",
"OPENAI_ORGANIZATION",
"OPENAI_PROJECT",
"HOME",
"USERPROFILE",
"PATH",
"HTTP_PROXY",
"HTTPS_PROXY",
"NO_PROXY",
"http_proxy",
"https_proxy",
"no_proxy",
] {
name.hash(&mut hasher);
env::var_os(name).hash(&mut hasher);
}
hasher.finish()
}
async fn list_codex_models_uncached(
command: &CodexCommandSpec,
process_env: &[(String, String)],
) -> CodexModelDiscovery {
if let Ok(models) = list_codex_models_via_app_server(command, process_env).await {
return CodexModelDiscovery { class: CodexModelCacheClass::Capability, models };
}
let mut compatibility_command = cli_command(&command.program);
compatibility_command
.args(command.args.iter().map(String::as_str))
.args(["debug", "models"])
.envs(process_env.iter().map(|(key, value)| (key.as_str(), value.as_str())))
.kill_on_drop(true);
let output = with_codex_model_discovery_timeout(CODEX_MODEL_COMPATIBILITY_TIMEOUT, async move {
compatibility_command.output().await.map_err(|error| error.to_string())
})
.await;
let Ok(output) = output else {
return CodexModelDiscovery {
class: CodexModelCacheClass::StaticFallback,
models: model_infos(DEFAULT_CODEX_MODELS),
};
};
if !output.status.success() {
return CodexModelDiscovery {
class: CodexModelCacheClass::StaticFallback,
models: model_infos(DEFAULT_CODEX_MODELS),
};
}
match parse_codex_models(&String::from_utf8_lossy(&output.stdout)) {
Some(models) => CodexModelDiscovery { class: CodexModelCacheClass::CompatibilityFallback, models },
None => CodexModelDiscovery {
class: CodexModelCacheClass::StaticFallback,
models: model_infos(DEFAULT_CODEX_MODELS),
},
}
}
async fn list_codex_models_via_app_server(
command: &CodexCommandSpec,
process_env: &[(String, String)],
) -> Result<Vec<AiModelInfo>, String> {
with_codex_model_discovery_timeout(
CODEX_MODEL_DISCOVERY_TIMEOUT,
list_codex_models_via_app_server_inner(command, process_env),
)
.await
}
async fn with_codex_model_discovery_timeout<T, F>(timeout: Duration, discovery: F) -> Result<T, String>
where
F: Future<Output = Result<T, String>>,
{
tokio::time::timeout(timeout, discovery).await.map_err(|_| "Codex model discovery timed out".to_string())?
}
async fn list_codex_models_via_app_server_inner(
command: &CodexCommandSpec,
process_env: &[(String, String)],
) -> Result<Vec<AiModelInfo>, String> {
let mut process = cli_command(&command.program);
process
.args(command.args.iter().map(String::as_str))
.arg("app-server")
.envs(process_env.iter().map(|(key, value)| (key.as_str(), value.as_str())))
.stdin(Stdio::piped())
.stdout(Stdio::piped())
.stderr(Stdio::null())
.kill_on_drop(true);
let mut child = process.spawn().map_err(|error| error.to_string())?;
let mut stdin = child.stdin.take().ok_or_else(|| "Codex app-server stdin is unavailable".to_string())?;
let stdout = child.stdout.take().ok_or_else(|| "Codex app-server stdout is unavailable".to_string())?;
let mut lines = BufReader::new(stdout).lines();
let mut model_values = Vec::new();
let mut model_list_request_id = 2;
write_codex_app_server_message(
&mut stdin,
&json!({
"method": "initialize",
"id": 1,
"params": {
"clientInfo": {
"name": "dbx",
"title": "DBX",
"version": env!("CARGO_PKG_VERSION")
}
}
}),
)
.await?;
while let Some(line) = lines.next_line().await.map_err(|error| error.to_string())? {
let Ok(message) = serde_json::from_str::<Value>(&line) else {
continue;
};
match message.get("id").and_then(Value::as_u64) {
Some(1) => {
if let Some(error) = message.get("error") {
return Err(format!("Codex app-server initialization failed: {error}"));
}
write_codex_app_server_message(&mut stdin, &json!({ "method": "initialized" })).await?;
write_codex_model_list_request(&mut stdin, model_list_request_id, None).await?;
}
Some(id) if id == model_list_request_id => {
if let Some(error) = message.get("error") {
return Err(format!("Codex model/list failed: {error}"));
}
let page = message
.pointer("/result/data")
.or_else(|| message.pointer("/result/models"))
.and_then(Value::as_array)
.ok_or_else(|| "Codex model/list returned an invalid response".to_string())?;
model_values.extend(page.iter().cloned());
let next_cursor = message
.pointer("/result/nextCursor")
.or_else(|| message.pointer("/result/next_cursor"))
.and_then(Value::as_str)
.map(str::trim)
.filter(|cursor| !cursor.is_empty());
if let Some(next_cursor) = next_cursor {
model_list_request_id += 1;
write_codex_model_list_request(&mut stdin, model_list_request_id, Some(next_cursor)).await?;
continue;
}
return parse_codex_app_server_models(&json!({ "result": { "data": model_values } }))
.ok_or_else(|| "Codex model/list returned no models".to_string());
}
_ => {}
}
}
Err("Codex app-server exited before model/list completed".to_string())
}
async fn write_codex_app_server_message(stdin: &mut tokio::process::ChildStdin, message: &Value) -> Result<(), String> {
let mut payload = serde_json::to_vec(message).map_err(|error| error.to_string())?;
payload.push(b'\n');
stdin.write_all(&payload).await.map_err(|error| error.to_string())?;
stdin.flush().await.map_err(|error| error.to_string())
}
async fn write_codex_model_list_request(
stdin: &mut tokio::process::ChildStdin,
request_id: u64,
cursor: Option<&str>,
) -> Result<(), String> {
let params = cursor.map_or_else(|| json!({}), |cursor| json!({ "cursor": cursor }));
write_codex_app_server_message(stdin, &json!({ "method": "model/list", "id": request_id, "params": params })).await
}
fn parse_codex_app_server_models(message: &Value) -> Option<Vec<AiModelInfo>> {
let models =
message.pointer("/result/data").or_else(|| message.pointer("/result/models")).and_then(Value::as_array)?;
let mut default_capability = None;
let mut concrete_models = Vec::new();
for model in models {
let Some(id) = model
.get("id")
.and_then(Value::as_str)
.or_else(|| model.get("model").and_then(Value::as_str))
.map(str::trim)
.filter(|id| !id.is_empty())
else {
continue;
};
if concrete_models.iter().any(|existing: &AiModelInfo| existing.id == id) {
continue;
}
let display_name = model
.get("displayName")
.or_else(|| model.get("display_name"))
.and_then(Value::as_str)
.map(str::trim)
.filter(|name| !name.is_empty())
.map(ToString::to_string);
let levels = model
.get("supportedReasoningEfforts")
.or_else(|| model.get("supported_reasoning_efforts"))
.and_then(Value::as_array)
.into_iter()
.flatten()
.filter_map(|level| {
level
.as_str()
.or_else(|| level.get("reasoningEffort").and_then(Value::as_str))
.or_else(|| level.get("reasoning_effort").and_then(Value::as_str))
.or_else(|| level.get("effort").and_then(Value::as_str))
});
let capability = crate::ai_effort::dynamic_enum_capability(levels, AiCapabilitySource::LocalCli);
if model.get("isDefault").or_else(|| model.get("is_default")).and_then(Value::as_bool).unwrap_or(false) {
default_capability = capability.clone();
}
let mut info = AiModelInfo::new(id, display_name);
info.effort_capability = capability;
concrete_models.push(info);
}
if concrete_models.is_empty() {
return None;
}
let mut default_model = AiModelInfo::new("default", Some("Default".to_string()));
default_model.effort_capability = default_capability;
let mut result = Vec::with_capacity(concrete_models.len() + 1);
result.push(default_model);
result.extend(concrete_models);
Some(result)
}
fn parse_codex_models(stdout: &str) -> Option<Vec<AiModelInfo>> {
let json_start = stdout.find('{')?;
let data = serde_json::from_str::<Value>(&stdout[json_start..]).ok()?;
let models = data.get("models").and_then(Value::as_array)?;
let mut result = vec![AiModelInfo::new("default", Some("Default".to_string()))];
for model in models {
let Some(id) = model
.get("slug")
.and_then(Value::as_str)
.or_else(|| model.get("id").and_then(Value::as_str))
.map(str::trim)
.filter(|id| !id.is_empty())
else {
continue;
};
if result.iter().any(|existing| existing.id == id) {
continue;
}
let display_name = model
.get("display_name")
.and_then(Value::as_str)
.map(str::trim)
.filter(|name| !name.is_empty())
.map(ToString::to_string);
let mut info = AiModelInfo::new(id, display_name);
let levels = model
.get("supported_reasoning_levels")
.or_else(|| model.get("supportedReasoningLevels"))
.and_then(Value::as_array)
.into_iter()
.flatten()
.filter_map(|level| {
level
.as_str()
.or_else(|| level.get("effort").and_then(Value::as_str))
.or_else(|| level.get("value").and_then(Value::as_str))
});
info.effort_capability = crate::ai_effort::dynamic_enum_capability(levels, AiCapabilitySource::LocalCli);
result.push(info);
}
(result.len() > 1).then_some(result)
}
fn capability_supports_effort(capability: &AiEffortCapability, effort: &str) -> bool {
let AiEffortCapability::Enum { options, .. } = capability else {
return false;
};
options.iter().any(|option| option.selection.explicit_string() == Some(effort))
}
fn legacy_minimal_effort(capability: Option<&AiEffortCapability>) -> &'static str {
let Some(capability) = capability else {
return "minimal";
};
if capability_supports_effort(capability, "minimal") {
"minimal"
} else if capability_supports_effort(capability, "low") {
"low"
} else {
"minimal"
}
}
async fn capability_aware_codex_config(config: &AiConfig) -> AiConfig {
if config.runtime_effort.is_some() || config.reasoning_level != AiReasoningLevel::Minimal {
return config.clone();
}
let mut effective = config.clone();
let selected_model = config.model.trim();
let selected_model = if selected_model.is_empty() || selected_model.eq_ignore_ascii_case("default") {
"default"
} else {
selected_model
};
let capability = list_codex_models(config)
.await
.ok()
.and_then(|models| models.into_iter().find(|model| model.id == selected_model))
.and_then(|model| model.effort_capability);
if legacy_minimal_effort(capability.as_ref()) == "low" {
effective.runtime_effort = Some(AiEffortSelection::Enum("low".to_string()));
}
effective
}
pub async fn test_codex_connection(config: &AiConfig) -> Result<AiTestConnectionResult, String> {
let start = Instant::now();
validate_codex_program(config)?;
let codex_command = resolve_codex_command(config).await;
let mut command = cli_command(&codex_command.program);
command.args(codex_command.args.iter().map(String::as_str));
command.args(["login", "status"]);
command.envs(codex_process_env(config, &codex_command)?.iter().map(|(key, value)| (key.as_str(), value.as_str())));
let output = command.output().await.map_err(|e| classify_codex_spawn_error(&e.to_string()))?;
if output.status.success() {
Ok(AiTestConnectionResult {
success: true,
message: format!("OK - {}ms", start.elapsed().as_millis()),
latency_ms: Some(start.elapsed().as_millis() as u64),
model_used: config.model.trim().to_string(),
error_category: None,
})
} else {
let stderr = String::from_utf8_lossy(&output.stderr);
Err(classify_codex_run_error(&stderr))
}
}
fn classify_codex_spawn_error(message: &str) -> String {
if message.contains("No such file") || message.contains("not found") {
"[codexNotInstalled] Codex CLI was not found. Install Codex CLI or set the Codex CLI path in DBX AI settings."
.to_string()
} else if is_command_line_too_long_error(message) {
"[codexCommandLineTooLong] Codex CLI command line is too long. Update DBX so Codex prompts are sent through stdin instead of process arguments."
.to_string()
} else {
format!("[codexRunFailed] Failed to start Codex CLI: {message}")
}
}
fn is_command_line_too_long_error(message: &str) -> bool {
let lower = message.to_ascii_lowercase();
message.contains("os error 206")
|| message.contains("文件名或扩展名太长")
|| lower.contains("filename or extension is too long")
|| lower.contains("the filename or extension is too long")
}
fn classify_codex_run_error(stderr: &str) -> String {
let lower = stderr.to_ascii_lowercase();
if lower.contains("not authenticated") || lower.contains("login") || lower.contains("auth") {
format!("[codexNotAuthenticated] Codex CLI is not authenticated. Run `codex login` and try again. {stderr}")
} else if lower.contains("dbx-mcp-server") || lower.contains("enoent") {
format!("[dbxMcpMissing] DBX MCP server was not found. Install @dbx-app/mcp-server and try again. {stderr}")
} else if lower.contains("mcp") && (lower.contains("dbx") || lower.contains("server")) {
format!("[codexMcpStartupFailed] Codex could not start the DBX MCP server. {stderr}")
} else {
format!("[codexRunFailed] Codex CLI failed. {stderr}")
}
}
pub fn parse_codex_jsonl_event(line: &str) -> Option<Vec<AgentEvent>> {
parse_cli_jsonl_event(line, CliAgentJsonlDialect::CodexExec)
}
pub async fn run_codex_agent(
config: &AiConfig,
prompt: &str,
images: &[crate::ai::AiInlineImage],
options: CodexRunOptions,
cancelled: &Notify,
on_event: impl Fn(AgentEvent) + Send + Sync + 'static,
) -> Result<String, String> {
validate_codex_program(config)?;
let (_image_directory, image_paths) = materialize_codex_images(images)?;
let effective_config = capability_aware_codex_config(config).await;
let mut command = build_codex_exec_command(&effective_config, prompt, &options);
let resolved_command = resolve_codex_command(config).await;
command.program = resolved_command.program;
command.args.splice(0..0, resolved_command.args);
attach_codex_images(&mut command, &image_paths);
let env = codex_process_env(config, &command)?;
run_cli_jsonl_agent(
CliAgentProcessSpec {
command,
env,
env_remove: Vec::new(),
current_dir: None,
stdin: Some(prompt.to_string()),
dialect: CliAgentJsonlDialect::CodexExec,
classify_spawn_error: classify_codex_spawn_error,
classify_run_error: classify_codex_run_error,
},
cancelled,
on_event,
)
.await
}
#[cfg(test)]
mod tests {
use super::codex_process_env_with_system_proxy;
#[cfg(not(windows))]
use super::shell_quote;
use super::{
attach_codex_images, build_codex_exec_command, classify_codex_spawn_error, codex_cli_env, codex_enabled_tools,
codex_model_cache_key, is_path_like_program, legacy_minimal_effort, list_codex_models_cached,
materialize_codex_images, parse_codex_app_server_models, parse_codex_jsonl_event, parse_codex_models,
validate_codex_program, with_codex_model_discovery_timeout, CachedCodexModels, CodexModelCacheClass,
CodexModelDiscovery, CodexRunOptions, CODEX_MODEL_COMPATIBILITY_CACHE_TTL, CODEX_MODEL_COMPATIBILITY_TIMEOUT,
CODEX_MODEL_DISCOVERY_TIMEOUT, CODEX_MODEL_NEGATIVE_CACHE_TTL, CODEX_MODEL_SUCCESS_CACHE_TTL,
DEFAULT_CODEX_MODELS,
};
#[cfg(not(windows))]
use super::{codex_process_env, common_executable_dirs, merged_path_with_dir};
#[cfg(windows)]
use super::{
direct_program_path, first_windows_program_path, program_path_candidates, resolve_codex_command,
windows_npm_codex_shim_command,
};
use crate::agent_events::AgentEvent;
use crate::ai::{
AiApiStyle, AiAuthMethod, AiCapabilitySource, AiConfig, AiEffortCapability, AiEffortSelection, AiInlineImage,
AiProvider, AiReasoningLevel,
};
use crate::ai_cli_agent::{model_infos, CliAgentCommandSpec};
use serde_json::json;
use std::sync::atomic::{AtomicUsize, Ordering};
use std::sync::Arc;
use std::time::{Duration, Instant};
use tokio::sync::{Barrier, Mutex, Notify};
fn codex_config(model: &str) -> AiConfig {
AiConfig {
provider: AiProvider::CodexCli,
api_key: String::new(),
auth_method: AiAuthMethod::Bearer,
endpoint: String::new(),
model: model.to_string(),
models: Vec::new(),
api_style: AiApiStyle::Completions,
proxy_enabled: false,
proxy_url: String::new(),
enable_thinking: true,
reasoning_level: AiReasoningLevel::Default,
runtime_effort: None,
context_window: None,
max_retries: None,
codex_cli_path: None,
codex_cli_env: Default::default(),
claude_code_cli_path: None,
claude_code_cli_env: Default::default(),
pi_agent_cli_path: None,
pi_agent_cli_env: Default::default(),
opencode_cli_path: None,
opencode_cli_env: Default::default(),
cursor_cli_path: None,
cursor_cli_env: Default::default(),
grok_cli_path: None,
grok_cli_env: Default::default(),
codebuddy_cli_path: None,
codebuddy_cli_env: Default::default(),
qoder_cli_path: None,
qoder_cli_env: Default::default(),
}
}
fn run_options() -> CodexRunOptions {
CodexRunOptions {
connection_id: "conn-1".to_string(),
connection_name: "local".to_string(),
database: "demo".to_string(),
schema: None,
agent_mode: true,
allow_writes: false,
allow_dangerous: false,
confirmed_write_sql: None,
mcp_server_command: None,
}
}
fn model_discovery(class: CodexModelCacheClass, ids: &[&str]) -> CodexModelDiscovery {
CodexModelDiscovery { class, models: model_infos(ids) }
}
#[test]
fn builds_codex_command_with_scoped_mcp_and_omits_default_model() {
let spec = build_codex_exec_command(&codex_config("default"), "hello", &run_options());
assert_eq!(spec.program, "codex");
assert!(spec.args.contains(&"--json".to_string()));
assert_eq!(spec.args.last().map(String::as_str), Some("-"));
assert!(!spec.args.contains(&"hello".to_string()));
assert!(!spec.args.contains(&"--model".to_string()));
assert!(!spec.args.contains(&"--ask-for-approval".to_string()));
assert!(spec.args.contains(&"mcp_servers.dbx.command=\"dbx-mcp-server\"".to_string()));
assert!(spec.args.contains(&"mcp_servers.dbx.default_tools_approval_mode=\"approve\"".to_string()));
assert!(spec.args.contains(&"mcp_servers.dbx.env.DBX_MCP_ALLOW_WRITES=\"0\"".to_string()));
assert!(spec.args.contains(&"mcp_servers.dbx.env.DBX_MCP_ALLOW_DANGEROUS_SQL=\"0\"".to_string()));
assert!(spec.args.contains(&"mcp_servers.dbx.env.DBX_MCP_SCOPE_CONNECTION_ID=\"conn-1\"".to_string()));
assert!(spec.args.iter().any(|arg| arg.contains("dbx_execute_query")));
}
#[test]
fn codex_image_attachment_uses_image_argument_and_clean_prompt() {
let prompt = "inspect this";
let images = vec![AiInlineImage { media_type: "image/png".to_string(), data: "aGVsbG8=".to_string() }];
let (directory, paths) = materialize_codex_images(&images).unwrap();
let mut command = build_codex_exec_command(&codex_config("default"), prompt, &run_options());
attach_codex_images(&mut command, &paths);
assert_eq!(prompt, "inspect this");
assert!(directory.is_some());
assert_eq!(std::fs::read(&paths[0]).unwrap(), b"hello");
let image_arg = command.args.iter().position(|arg| arg == "--image").unwrap();
let prompt_arg = command.args.iter().position(|arg| arg == "-").unwrap();
assert_eq!(command.args[image_arg + 1], paths[0].to_string_lossy());
assert!(image_arg < prompt_arg);
}
#[test]
fn builds_codex_command_with_non_default_model_and_ask_tools() {
let mut options = run_options();
options.agent_mode = false;
let spec = build_codex_exec_command(&codex_config("gpt-5.5"), "hello", &options);
let model_pos = spec.args.iter().position(|arg| arg == "--model").unwrap();
assert_eq!(spec.args[model_pos + 1], "gpt-5.5");
assert!(!codex_enabled_tools(false).contains(&"dbx_execute_query"));
assert!(spec.args.iter().any(|arg| arg.contains("dbx_get_schema_context")));
assert!(!spec.args.iter().any(|arg| arg.contains("dbx_execute_query")));
}
#[test]
fn builds_codex_command_with_resolved_mcp_server_path() {
let mut options = run_options();
options.mcp_server_command = Some(CliAgentCommandSpec {
program: "/opt/dbx/bin/dbx-mcp-server".to_string(),
args: vec!["--stdio".to_string()],
});
let spec = build_codex_exec_command(&codex_config("default"), "hello", &options);
assert!(spec.args.contains(&"mcp_servers.dbx.command=\"/opt/dbx/bin/dbx-mcp-server\"".to_string()));
assert!(spec.args.contains(&"mcp_servers.dbx.args=[\"--stdio\"]".to_string()));
}
#[test]
fn builds_codex_command_with_reasoning_effort_override() {
let mut config = codex_config("default");
config.reasoning_level = AiReasoningLevel::High;
let spec = build_codex_exec_command(&config, "hello", &run_options());
assert!(!spec.args.contains(&"--reasoning-effort".to_string()));
assert!(spec.args.contains(&"model_reasoning_effort=\"high\"".to_string()));
}
#[test]
fn keeps_minimal_reasoning_literal_without_capability_fallback() {
let mut config = codex_config("default");
config.reasoning_level = AiReasoningLevel::Minimal;
let spec = build_codex_exec_command(&config, "hello", &run_options());
assert!(spec.args.contains(&"model_reasoning_effort=\"minimal\"".to_string()));
assert!(!spec.args.contains(&"model_reasoning_effort=\"low\"".to_string()));
}
#[test]
fn runtime_effort_takes_priority_over_legacy_reasoning_level() {
let mut config = codex_config("default");
config.reasoning_level = AiReasoningLevel::High;
config.runtime_effort = Some(AiEffortSelection::ProviderDefault);
let spec = build_codex_exec_command(&config, "hello", &run_options());
assert!(!spec.args.iter().any(|arg| arg.starts_with("model_reasoning_effort=")));
config.runtime_effort = Some(AiEffortSelection::Enum("xhigh".to_string()));
let spec = build_codex_exec_command(&config, "hello", &run_options());
assert!(spec.args.contains(&"model_reasoning_effort=\"xhigh\"".to_string()));
}
#[test]
fn path_like_codex_programs_are_detected() {
assert!(is_path_like_program("/opt/homebrew/bin/codex"));
assert!(is_path_like_program("~/bin/codex"));
assert!(is_path_like_program(r"C:\Tools\codex.exe"));
assert!(!is_path_like_program("codex"));
}
#[test]
#[cfg(windows)]
fn windows_codex_lookup_prefers_cmd_over_extensionless_shim() {
let candidates = program_path_candidates(std::path::Path::new(r"C:\nvm4w\nodejs"), "codex");
assert_eq!(candidates[0], std::path::Path::new(r"C:\nvm4w\nodejs\codex.cmd"));
assert!(candidates.iter().position(|path| path == std::path::Path::new(r"C:\nvm4w\nodejs\codex")).unwrap() > 0);
}
#[test]
#[cfg(windows)]
fn windows_shell_lookup_prefers_launchable_command() {
let dir = std::env::temp_dir().join(format!("dbx-codex-test-{}", std::process::id()));
std::fs::create_dir_all(&dir).unwrap();
let extensionless = dir.join("codex");
let cmd = dir.join("codex.cmd");
std::fs::write(&extensionless, "#!/bin/sh\n").unwrap();
std::fs::write(&cmd, "@echo off\n").unwrap();
let output = format!("{}\n{}\n", extensionless.display(), cmd.display());
let resolved = first_windows_program_path(&output).unwrap();
assert_eq!(resolved, cmd.to_string_lossy());
let _ = std::fs::remove_file(extensionless);
let _ = std::fs::remove_file(cmd);
let _ = std::fs::remove_dir(dir);
}
#[test]
#[cfg(windows)]
fn windows_direct_extensionless_path_uses_cmd_sibling() {
let dir = std::env::temp_dir().join(format!("dbx-codex-direct-test-{}", std::process::id()));
std::fs::create_dir_all(&dir).unwrap();
let extensionless = dir.join("codex");
let cmd = dir.join("codex.cmd");
std::fs::write(&extensionless, "#!/bin/sh\n").unwrap();
std::fs::write(&cmd, "@echo off\n").unwrap();
let resolved = direct_program_path(extensionless.to_string_lossy().as_ref()).unwrap();
assert_eq!(resolved, cmd.to_string_lossy().as_ref());
let _ = std::fs::remove_file(extensionless);
let _ = std::fs::remove_file(cmd);
let _ = std::fs::remove_dir(dir);
}
#[test]
#[cfg(windows)]
fn windows_direct_extensionless_path_is_not_launchable_without_sibling() {
let dir = std::env::temp_dir().join(format!("dbx-codex-direct-missing-test-{}", std::process::id()));
std::fs::create_dir_all(&dir).unwrap();
let extensionless = dir.join("codex");
std::fs::write(&extensionless, "#!/bin/sh\n").unwrap();
let resolved = direct_program_path(extensionless.to_string_lossy().as_ref());
assert!(resolved.is_none());
let _ = std::fs::remove_file(extensionless);
let _ = std::fs::remove_dir(dir);
}
#[test]
#[cfg(windows)]
fn windows_direct_directory_path_uses_codex_cmd_inside() {
let dir = std::env::temp_dir().join(format!("dbx-codex-direct-dir-test-{}", std::process::id()));
std::fs::create_dir_all(&dir).unwrap();
let extensionless = dir.join("codex");
let cmd = dir.join("codex.cmd");
std::fs::write(&extensionless, "#!/bin/sh\n").unwrap();
std::fs::write(&cmd, "@echo off\n").unwrap();
let resolved = direct_program_path(dir.to_string_lossy().as_ref()).unwrap();
assert_eq!(resolved, cmd.to_string_lossy().as_ref());
let _ = std::fs::remove_file(extensionless);
let _ = std::fs::remove_file(cmd);
let _ = std::fs::remove_dir(dir);
}
#[tokio::test]
#[cfg(windows)]
async fn windows_configured_nvm_directory_resolves_codex_cmd_shim() {
let dir = std::env::temp_dir().join(format!("dbx-codex-nvm-dir-test-{}", std::process::id()));
let bin_dir = dir.join("node_modules").join("@openai").join("codex").join("bin");
std::fs::create_dir_all(&bin_dir).unwrap();
let cmd = dir.join("codex.cmd");
let node = dir.join("node.exe");
let codex_js = bin_dir.join("codex.js");
std::fs::write(&cmd, "@echo off\nnode codex.js %*\n").unwrap();
std::fs::write(&node, "").unwrap();
std::fs::write(&codex_js, "#!/usr/bin/env node\n").unwrap();
let mut config = codex_config("default");
config.codex_cli_path = Some(dir.to_string_lossy().to_string());
let command = resolve_codex_command(&config).await;
assert_eq!(command.program, node.to_string_lossy().as_ref());
assert_eq!(command.args, vec![codex_js.to_string_lossy().to_string()]);
let _ = std::fs::remove_file(cmd);
let _ = std::fs::remove_file(node);
let _ = std::fs::remove_file(codex_js);
let _ = std::fs::remove_dir_all(dir);
}
#[test]
#[cfg(windows)]
fn windows_npm_codex_cmd_shim_uses_node_directly() {
let dir = std::env::temp_dir().join(format!("dbx-codex-npm-shim-test-{}", std::process::id()));
let bin_dir = dir.join("node_modules").join("@openai").join("codex").join("bin");
std::fs::create_dir_all(&bin_dir).unwrap();
let cmd = dir.join("codex.cmd");
let node = dir.join("node.exe");
let codex_js = bin_dir.join("codex.js");
std::fs::write(&cmd, "@echo off\nnode codex.js %*\n").unwrap();
std::fs::write(&node, "").unwrap();
std::fs::write(&codex_js, "#!/usr/bin/env node\n").unwrap();
let command = windows_npm_codex_shim_command(cmd.to_string_lossy().as_ref()).unwrap();
assert_eq!(command.program, node.to_string_lossy().as_ref());
assert_eq!(command.args, vec![codex_js.to_string_lossy().to_string()]);
let _ = std::fs::remove_file(cmd);
let _ = std::fs::remove_file(node);
let _ = std::fs::remove_file(codex_js);
let _ = std::fs::remove_dir_all(dir);
}
#[test]
#[cfg(not(windows))]
fn common_codex_lookup_dirs_include_homebrew_and_system_paths() {
let dirs = common_executable_dirs();
assert!(dirs.iter().any(|dir| dir == std::path::Path::new("/opt/homebrew/bin")));
assert!(dirs.iter().any(|dir| dir == std::path::Path::new("/usr/local/bin")));
assert!(dirs.iter().any(|dir| dir == std::path::Path::new("/usr/bin")));
}
#[test]
#[cfg(not(windows))]
fn codex_command_env_prepends_resolved_program_dir_and_keeps_node_dirs() {
let config = codex_config("default");
let command = CliAgentCommandSpec { program: "/opt/homebrew/bin/codex".to_string(), args: Vec::new() };
let env = codex_process_env(&config, &command).unwrap();
let path = env.iter().find(|(key, _)| key == "PATH").map(|(_, value)| value).unwrap();
let dirs = std::env::split_paths(path).collect::<Vec<_>>();
assert_eq!(dirs.first().unwrap(), std::path::Path::new("/opt/homebrew/bin"));
assert!(dirs.iter().any(|dir| dir == std::path::Path::new("/usr/bin")));
}
#[test]
#[cfg(not(windows))]
fn merged_path_deduplicates_codex_dir() {
let path = merged_path_with_dir("/opt/homebrew/bin", None);
let dirs = std::env::split_paths(&path).collect::<Vec<_>>();
let count = dirs.iter().filter(|dir| *dir == std::path::Path::new("/opt/homebrew/bin")).count();
assert_eq!(count, 1);
}
#[test]
#[cfg(not(windows))]
fn codex_process_env_keeps_resolved_program_dir_before_user_path() {
let mut config = codex_config("default");
config.codex_cli_env.insert("PATH".to_string(), "/custom/bin:/usr/bin".to_string());
let command = CliAgentCommandSpec { program: "/opt/homebrew/bin/codex".to_string(), args: Vec::new() };
let env = codex_process_env(&config, &command).unwrap();
let path = env.iter().find(|(key, _)| key == "PATH").map(|(_, value)| value).unwrap();
let dirs = std::env::split_paths(path).collect::<Vec<_>>();
assert_eq!(dirs.first().unwrap(), std::path::Path::new("/opt/homebrew/bin"));
assert!(dirs.iter().any(|dir| dir == std::path::Path::new("/custom/bin")));
}
#[test]
fn codex_process_env_uses_system_proxy_when_not_configured() {
let config = codex_config("default");
let command = CliAgentCommandSpec { program: "/opt/homebrew/bin/codex".to_string(), args: Vec::new() };
let env = codex_process_env_with_system_proxy(&config, &command, Some("http://127.0.0.1:7897"), &[]).unwrap();
assert!(env.contains(&("HTTP_PROXY".to_string(), "http://127.0.0.1:7897".to_string())));
assert!(env.contains(&("HTTPS_PROXY".to_string(), "http://127.0.0.1:7897".to_string())));
}
#[test]
fn explicit_codex_proxy_env_overrides_system_proxy() {
let mut config = codex_config("default");
config.codex_cli_env.insert("http_proxy".to_string(), "http://manual-http:9800".to_string());
config.codex_cli_env.insert("HTTPS_PROXY".to_string(), "http://manual-https:9801".to_string());
let command = CliAgentCommandSpec { program: "/opt/homebrew/bin/codex".to_string(), args: Vec::new() };
let env = codex_process_env_with_system_proxy(&config, &command, Some("http://127.0.0.1:7897"), &[]).unwrap();
assert!(env.contains(&("http_proxy".to_string(), "http://manual-http:9800".to_string())));
assert!(env.contains(&("HTTPS_PROXY".to_string(), "http://manual-https:9801".to_string())));
assert!(!env.iter().any(|(_, value)| value == "http://127.0.0.1:7897"));
}
#[test]
fn inherited_proxy_env_overrides_system_proxy() {
let config = codex_config("default");
let command = CliAgentCommandSpec { program: "/opt/homebrew/bin/codex".to_string(), args: Vec::new() };
let inherited_env_keys = vec!["https_proxy".to_string()];
let env =
codex_process_env_with_system_proxy(&config, &command, Some("http://127.0.0.1:7897"), &inherited_env_keys)
.unwrap();
assert!(env.contains(&("HTTP_PROXY".to_string(), "http://127.0.0.1:7897".to_string())));
assert!(!env.iter().any(|(key, _)| key.eq_ignore_ascii_case("HTTPS_PROXY")));
}
#[test]
#[cfg(not(windows))]
fn shell_quote_handles_codex_program_names() {
assert_eq!(shell_quote("codex"), "'codex'");
assert_eq!(shell_quote("can't"), "'can'\"'\"'t'");
}
#[test]
fn default_model_list_matches_plan() {
assert_eq!(model_infos(DEFAULT_CODEX_MODELS), model_infos(&["default", "gpt-5.5", "gpt-5.4-mini"]));
}
#[test]
fn normalizes_codex_cli_env() {
let mut config = codex_config("default");
config.codex_cli_env.insert(" HTTPS_PROXY ".to_string(), "http://proxy:9800".to_string());
config.codex_cli_env.insert("NO_PROXY".to_string(), "localhost,127.0.0.1".to_string());
config.codex_cli_env.insert("".to_string(), "ignored".to_string());
let env = codex_cli_env(&config).unwrap();
assert_eq!(
env,
vec![
("HTTPS_PROXY".to_string(), "http://proxy:9800".to_string()),
("NO_PROXY".to_string(), "localhost,127.0.0.1".to_string())
]
);
}
#[test]
fn rejects_invalid_codex_cli_env_name() {
let mut config = codex_config("default");
config.codex_cli_env.insert("BAD-NAME".to_string(), "value".to_string());
let err = codex_cli_env(&config).unwrap_err();
assert!(err.contains("[codexEnvInvalid]"));
}
#[test]
fn rejects_reserved_dbx_mcp_env_name() {
let mut config = codex_config("default");
config.codex_cli_env.insert("DBX_MCP_ALLOW_DANGEROUS_SQL".to_string(), "1".to_string());
let err = codex_cli_env(&config).unwrap_err();
assert!(err.contains("[codexEnvReserved]"));
}
#[test]
fn rejects_shell_style_env_prefix_in_codex_cli_path() {
let mut config = codex_config("default");
config.codex_cli_path = Some("HTTPS_PROXY=http://proxy:9800 /opt/homebrew/bin/codex".to_string());
let err = validate_codex_program(&config).unwrap_err();
assert!(err.contains("[codexCliPathInvalid]"));
assert!(err.contains("environment variables section"));
}
#[test]
fn rejects_directory_without_codex_in_codex_cli_path() {
let dir = std::env::temp_dir().join(format!("dbx-codex-empty-dir-test-{}", std::process::id()));
std::fs::create_dir_all(&dir).unwrap();
let mut config = codex_config("default");
config.codex_cli_path = Some(dir.to_string_lossy().to_string());
let err = validate_codex_program(&config).unwrap_err();
assert!(err.contains("[codexCliPathInvalid]"));
let _ = std::fs::remove_dir(dir);
}
#[test]
fn parses_codex_model_catalog_without_service_tiers() {
let models = parse_codex_models(
r#"{"models":[{"slug":"gpt-5.5","display_name":"GPT-5.5","service_tiers":[{"id":"priority","name":"Priority"}]},{"slug":"gpt-5.4-mini","display_name":"GPT-5.4 mini"}]}"#,
)
.unwrap();
assert_eq!(
models.iter().map(|model| model.id.as_str()).collect::<Vec<_>>(),
vec!["default", "gpt-5.5", "gpt-5.4-mini"]
);
assert_eq!(models[1].display_name.as_deref(), Some("GPT-5.5"));
assert!(!models.iter().any(|model| model.id == "priority" || model.id == "Priority"));
}
#[test]
fn app_server_default_inherits_selected_model_effort_capability() {
let models = parse_codex_app_server_models(&json!({
"id": 2,
"result": {
"data": [
{
"id": "gpt-low-only",
"displayName": "GPT low only",
"isDefault": true,
"supportedReasoningEfforts": [
{ "reasoningEffort": "low" },
{ "reasoningEffort": "medium" },
{ "reasoningEffort": "high" }
]
},
{
"id": "gpt-minimal",
"displayName": "GPT minimal",
"isDefault": false,
"supportedReasoningEfforts": [
{ "reasoningEffort": "minimal" },
{ "reasoningEffort": "low" }
]
}
],
"nextCursor": null
}
}))
.unwrap();
assert_eq!(
models.iter().map(|model| model.id.as_str()).collect::<Vec<_>>(),
["default", "gpt-low-only", "gpt-minimal"]
);
assert_eq!(legacy_minimal_effort(models[0].effort_capability.as_ref()), "low");
assert_eq!(legacy_minimal_effort(models[1].effort_capability.as_ref()), "low");
assert_eq!(legacy_minimal_effort(models[2].effort_capability.as_ref()), "minimal");
}
#[test]
fn legacy_minimal_preserves_unknown_or_non_enum_capabilities() {
assert_eq!(legacy_minimal_effort(None), "minimal");
assert_eq!(legacy_minimal_effort(Some(&AiEffortCapability::Unsupported)), "minimal");
assert_eq!(
legacy_minimal_effort(Some(&AiEffortCapability::FreeText {
placeholder: None,
source: AiCapabilitySource::LocalCli,
})),
"minimal"
);
}
#[test]
fn model_cache_uses_bounded_success_fallback_and_negative_ttls() {
assert_eq!(CODEX_MODEL_DISCOVERY_TIMEOUT, Duration::from_secs(15));
assert_eq!(CODEX_MODEL_COMPATIBILITY_TIMEOUT, Duration::from_secs(10));
assert_eq!(CODEX_MODEL_SUCCESS_CACHE_TTL, Duration::from_secs(5 * 60));
assert_eq!(CODEX_MODEL_COMPATIBILITY_CACHE_TTL, Duration::from_secs(30));
assert_eq!(CODEX_MODEL_NEGATIVE_CACHE_TTL, Duration::from_secs(10));
let loaded_at = Instant::now();
for class in [
CodexModelCacheClass::Capability,
CodexModelCacheClass::CompatibilityFallback,
CodexModelCacheClass::StaticFallback,
] {
let entry = CachedCodexModels { key: 7, loaded_at, class, models: Vec::new() };
assert!(entry.is_fresh(7, loaded_at + class.ttl() - Duration::from_millis(1)));
assert!(!entry.is_fresh(7, loaded_at + class.ttl()));
assert!(!entry.is_fresh(8, loaded_at));
}
}
#[test]
fn model_cache_key_tracks_resolved_command_and_process_env() {
let command =
CliAgentCommandSpec { program: "/opt/codex/bin/codex".to_string(), args: vec!["shim.js".to_string()] };
let process_env = vec![("CODEX_HOME".to_string(), "/tmp/codex-a".to_string())];
let key = codex_model_cache_key(&command, &process_env);
assert_eq!(key, codex_model_cache_key(&command, &process_env));
assert_ne!(
key,
codex_model_cache_key(
&CliAgentCommandSpec { program: "/usr/local/bin/codex".to_string(), args: command.args.clone() },
&process_env,
)
);
assert_ne!(key, codex_model_cache_key(&command, &[("CODEX_HOME".to_string(), "/tmp/codex-b".to_string())],));
}
#[tokio::test]
async fn concurrent_cache_misses_do_not_hold_the_mutex_during_discovery() {
let cache = Arc::new(Mutex::new(None));
let barrier = Arc::new(Barrier::new(2));
let probes = Arc::new(AtomicUsize::new(0));
let mut tasks = Vec::new();
for _ in 0..2 {
let cache = cache.clone();
let barrier = barrier.clone();
let probes = probes.clone();
tasks.push(tokio::spawn(async move {
list_codex_models_cached(cache.as_ref(), 7, || async move {
probes.fetch_add(1, Ordering::SeqCst);
barrier.wait().await;
model_discovery(CodexModelCacheClass::Capability, &["default", "gpt-minimal"])
})
.await
}));
}
let (first, second) = tokio::time::timeout(Duration::from_millis(500), async {
tokio::try_join!(tasks.remove(0), tasks.remove(0))
})
.await
.expect("concurrent discovery should not serialize behind the cache mutex")
.unwrap();
assert_eq!(probes.load(Ordering::SeqCst), 2);
assert_eq!(first, model_infos(&["default", "gpt-minimal"]));
assert_eq!(second, first);
}
#[tokio::test]
async fn slower_fallback_does_not_replace_a_fresh_capability_result() {
let cache = Arc::new(Mutex::new(None));
let fallback_started = Arc::new(Notify::new());
let release_fallback = Arc::new(Notify::new());
let fallback_task = {
let cache = cache.clone();
let fallback_started = fallback_started.clone();
let release_fallback = release_fallback.clone();
tokio::spawn(async move {
list_codex_models_cached(cache.as_ref(), 9, || async move {
fallback_started.notify_one();
release_fallback.notified().await;
model_discovery(CodexModelCacheClass::StaticFallback, &["default", "fallback"])
})
.await
})
};
fallback_started.notified().await;
let capability = list_codex_models_cached(cache.as_ref(), 9, || async {
model_discovery(CodexModelCacheClass::Capability, &["default", "gpt-minimal"])
})
.await;
release_fallback.notify_one();
let fallback_result = tokio::time::timeout(Duration::from_millis(500), fallback_task)
.await
.expect("fallback discovery should finish after release")
.unwrap();
assert_eq!(capability, model_infos(&["default", "gpt-minimal"]));
assert_eq!(fallback_result, capability);
assert_eq!(cache.lock().await.as_ref().unwrap().class, CodexModelCacheClass::Capability);
}
#[tokio::test]
async fn compatibility_and_static_fallbacks_are_cached_briefly() {
for (key, class) in
[(11, CodexModelCacheClass::CompatibilityFallback), (12, CodexModelCacheClass::StaticFallback)]
{
let cache = Mutex::new(None);
let probes = Arc::new(AtomicUsize::new(0));
let first_probes = probes.clone();
let first = list_codex_models_cached(&cache, key, || async move {
first_probes.fetch_add(1, Ordering::SeqCst);
model_discovery(class, &["default", "fallback"])
})
.await;
let second_probes = probes.clone();
let second = list_codex_models_cached(&cache, key, || async move {
second_probes.fetch_add(1, Ordering::SeqCst);
model_discovery(CodexModelCacheClass::Capability, &["default", "unexpected"])
})
.await;
assert_eq!(probes.load(Ordering::SeqCst), 1);
assert_eq!(first, model_infos(&["default", "fallback"]));
assert_eq!(second, first);
}
}
#[tokio::test]
async fn discovery_timeout_can_be_tested_without_a_real_slow_process() {
let result = with_codex_model_discovery_timeout(
Duration::from_millis(5),
std::future::pending::<Result<Vec<crate::ai::AiModelInfo>, String>>(),
)
.await;
assert_eq!(result.unwrap_err(), "Codex model discovery timed out");
}
#[test]
fn classifies_windows_command_line_too_long_spawn_error() {
let err = classify_codex_spawn_error("文件名或扩展名太长。 (os error 206)");
assert!(err.contains("[codexCommandLineTooLong]"));
}
#[test]
fn parses_codex_jsonl_events() {
assert!(parse_codex_jsonl_event(r#"{"type":"thread.started","thread_id":"t"}"#).is_none());
let started = parse_codex_jsonl_event(
r#"{"type":"item.started","item":{"id":"tool-1","type":"mcp_tool_call","tool_name":"dbx_list_tables","arguments":{"schema":"public"}}}"#,
)
.unwrap();
assert!(matches!(&started[0], AgentEvent::ToolCallStart { tool_name, .. } if tool_name == "dbx_list_tables"));
let completed = parse_codex_jsonl_event(
r#"{"type":"item.completed","item":{"id":"msg-1","type":"agent_message","text":"Done"}}"#,
)
.unwrap();
assert!(matches!(&completed[0], AgentEvent::TextDelta { delta } if delta == "Done"));
let tool_done = parse_codex_jsonl_event(
r#"{"type":"item.completed","item":{"id":"tool-1","type":"mcp_tool_call","tool_name":"dbx_list_tables","result":{"content":"users"}}}"#,
)
.unwrap();
assert!(
matches!(&tool_done[0], AgentEvent::ToolCallEnd { tool_name, is_error, .. } if tool_name == "dbx_list_tables" && !is_error)
);
let current_started = parse_codex_jsonl_event(
r#"{"type":"item.started","item":{"id":"item_0","type":"mcp_tool_call","server":"dbx","tool":"dbx_execute_query","arguments":{"sql":"SELECT 1"},"result":null,"error":null,"status":"in_progress"}}"#,
)
.unwrap();
assert!(
matches!(&current_started[0], AgentEvent::ToolCallStart { tool_name, args, .. } if tool_name == "dbx_execute_query" && args["sql"] == "SELECT 1")
);
let current_tool_done = parse_codex_jsonl_event(
r#"{"type":"item.completed","item":{"id":"item_0","type":"mcp_tool_call","server":"dbx","tool":"dbx_execute_query","arguments":{"sql":"SELECT 1"},"result":{"content":[{"type":"text","text":"ok"}],"structured_content":null},"error":null,"status":"completed"}}"#,
)
.unwrap();
assert!(
matches!(&current_tool_done[0], AgentEvent::ToolCallEnd { tool_name, result, is_error, .. } if tool_name == "dbx_execute_query" && result["content"][0]["text"] == "ok" && !is_error)
);
let current_tool_error = parse_codex_jsonl_event(
r#"{"type":"item.completed","item":{"id":"item_0","type":"mcp_tool_call","server":"dbx","tool":"dbx_execute_query","arguments":{"sql":"SELECT 1"},"result":null,"error":{"message":"user cancelled MCP tool call"},"status":"failed"}}"#,
)
.unwrap();
assert!(
matches!(&current_tool_error[0], AgentEvent::ToolCallEnd { tool_name, result, is_error, .. } if tool_name == "dbx_execute_query" && result["message"] == "user cancelled MCP tool call" && *is_error)
);
let turn_done =
parse_codex_jsonl_event(r#"{"type":"turn.completed","usage":{"input_tokens":12,"output_tokens":3}}"#)
.unwrap();
assert!(matches!(&turn_done[0], AgentEvent::AgentEnd { input_tokens: Some(12), output_tokens: Some(3) }));
let failed = parse_codex_jsonl_event(r#"{"type":"turn.failed","message":"boom"}"#).unwrap();
assert!(matches!(&failed[0], AgentEvent::Error { message } if message == "boom"));
}
}