mirror of
https://github.com/openai/codex.git
synced 2026-05-05 05:42:33 +03:00
## Why Once the repo-local lint exists, `codex-rs` needs to follow the checked-in convention and CI needs to keep it from drifting. This commit applies the fallback `/*param*/` style consistently across existing positional literal call sites without changing those APIs. The longer-term preference is still to avoid APIs that require comments by choosing clearer parameter types and call shapes. This PR is intentionally the mechanical follow-through for the places where the existing signatures stay in place. After rebasing onto newer `main`, the rollout also had to cover newly introduced `tui_app_server` call sites. That made it clear the first cut of the CI job was too expensive for the common path: it was spending almost as much time installing `cargo-dylint` and re-testing the lint crate as a representative test job spends running product tests. The CI update keeps the full workspace enforcement but trims that extra overhead from ordinary `codex-rs` PRs. ## What changed - keep a dedicated `argument_comment_lint` job in `rust-ci` - mechanically annotate remaining opaque positional literals across `codex-rs` with exact `/*param*/` comments, including the rebased `tui_app_server` call sites that now fall under the lint - keep the checked-in style aligned with the lint policy by using `/*param*/` and leaving string and char literals uncommented - cache `cargo-dylint`, `dylint-link`, and the relevant Cargo registry/git metadata in the lint job - split changed-path detection so the lint crate's own `cargo test` step runs only when `tools/argument-comment-lint/*` or `rust-ci.yml` changes - continue to run the repo wrapper over the `codex-rs` workspace, so product-code enforcement is unchanged Most of the code changes in this commit are intentionally mechanical comment rewrites or insertions driven by the lint itself. ## Verification - `./tools/argument-comment-lint/run.sh --workspace` - `cargo test -p codex-tui-app-server -p codex-tui` - parsed `.github/workflows/rust-ci.yml` locally with PyYAML --- * -> #14652 * #14651
178 lines
5.6 KiB
Rust
178 lines
5.6 KiB
Rust
use crate::ArtifactRuntimePlatform;
|
|
use crate::runtime::default_cached_runtime_root;
|
|
use crate::runtime::load_cached_runtime;
|
|
use std::path::Path;
|
|
use std::path::PathBuf;
|
|
use which::which;
|
|
|
|
const CODEX_APP_PRODUCT_NAMES: [&str; 6] = [
|
|
"Codex",
|
|
"Codex (Dev)",
|
|
"Codex (Agent)",
|
|
"Codex (Nightly)",
|
|
"Codex (Alpha)",
|
|
"Codex (Beta)",
|
|
];
|
|
|
|
/// The JavaScript runtime used to execute the artifact tool.
|
|
#[derive(Clone, Debug, PartialEq, Eq)]
|
|
pub enum JsRuntimeKind {
|
|
Node,
|
|
Electron,
|
|
}
|
|
|
|
/// A discovered JavaScript executable and the way it should be invoked.
|
|
#[derive(Clone, Debug, PartialEq, Eq)]
|
|
pub struct JsRuntime {
|
|
executable_path: PathBuf,
|
|
kind: JsRuntimeKind,
|
|
}
|
|
|
|
impl JsRuntime {
|
|
pub(crate) fn node(executable_path: PathBuf) -> Self {
|
|
Self {
|
|
executable_path,
|
|
kind: JsRuntimeKind::Node,
|
|
}
|
|
}
|
|
|
|
pub(crate) fn electron(executable_path: PathBuf) -> Self {
|
|
Self {
|
|
executable_path,
|
|
kind: JsRuntimeKind::Electron,
|
|
}
|
|
}
|
|
|
|
/// Returns the executable to spawn for artifact commands.
|
|
pub fn executable_path(&self) -> &Path {
|
|
&self.executable_path
|
|
}
|
|
|
|
/// Returns whether the command must set `ELECTRON_RUN_AS_NODE=1`.
|
|
pub fn requires_electron_run_as_node(&self) -> bool {
|
|
self.kind == JsRuntimeKind::Electron
|
|
}
|
|
}
|
|
|
|
/// Returns `true` when artifact execution can find both runtime assets and a JS executable.
|
|
pub fn is_js_runtime_available(codex_home: &Path, runtime_version: &str) -> bool {
|
|
load_cached_runtime(&default_cached_runtime_root(codex_home), runtime_version)
|
|
.ok()
|
|
.and_then(|runtime| runtime.resolve_js_runtime().ok())
|
|
.or_else(resolve_machine_js_runtime)
|
|
.is_some()
|
|
}
|
|
|
|
/// Returns `true` when this machine can use the managed artifact runtime flow.
|
|
///
|
|
/// This is a platform capability check, not a cache or binary availability check.
|
|
/// Callers that rely on `ArtifactRuntimeManager::ensure_installed()` should use this
|
|
/// to decide whether the feature can be exposed on the current machine.
|
|
pub fn can_manage_artifact_runtime() -> bool {
|
|
ArtifactRuntimePlatform::detect_current().is_ok()
|
|
}
|
|
|
|
pub(crate) fn resolve_machine_js_runtime() -> Option<JsRuntime> {
|
|
resolve_js_runtime_from_candidates(
|
|
/*preferred_node_path*/ None,
|
|
system_node_runtime(),
|
|
system_electron_runtime(),
|
|
codex_app_runtime_candidates(),
|
|
)
|
|
}
|
|
|
|
pub(crate) fn resolve_js_runtime_from_candidates(
|
|
preferred_node_path: Option<&Path>,
|
|
node_runtime: Option<JsRuntime>,
|
|
electron_runtime: Option<JsRuntime>,
|
|
codex_app_candidates: Vec<PathBuf>,
|
|
) -> Option<JsRuntime> {
|
|
preferred_node_path
|
|
.and_then(node_runtime_from_path)
|
|
.or(node_runtime)
|
|
.or(electron_runtime)
|
|
.or_else(|| {
|
|
codex_app_candidates
|
|
.into_iter()
|
|
.find_map(|candidate| electron_runtime_from_path(&candidate))
|
|
})
|
|
}
|
|
|
|
pub(crate) fn system_node_runtime() -> Option<JsRuntime> {
|
|
which("node")
|
|
.ok()
|
|
.and_then(|path| node_runtime_from_path(&path))
|
|
}
|
|
|
|
pub(crate) fn system_electron_runtime() -> Option<JsRuntime> {
|
|
which("electron")
|
|
.ok()
|
|
.and_then(|path| electron_runtime_from_path(&path))
|
|
}
|
|
|
|
pub(crate) fn node_runtime_from_path(path: &Path) -> Option<JsRuntime> {
|
|
path.is_file().then(|| JsRuntime::node(path.to_path_buf()))
|
|
}
|
|
|
|
pub(crate) fn electron_runtime_from_path(path: &Path) -> Option<JsRuntime> {
|
|
path.is_file()
|
|
.then(|| JsRuntime::electron(path.to_path_buf()))
|
|
}
|
|
|
|
pub(crate) fn codex_app_runtime_candidates() -> Vec<PathBuf> {
|
|
match std::env::consts::OS {
|
|
"macos" => {
|
|
let mut roots = vec![PathBuf::from("/Applications")];
|
|
if let Some(home) = std::env::var_os("HOME") {
|
|
roots.push(PathBuf::from(home).join("Applications"));
|
|
}
|
|
|
|
roots
|
|
.into_iter()
|
|
.flat_map(|root| {
|
|
CODEX_APP_PRODUCT_NAMES
|
|
.into_iter()
|
|
.map(move |product_name| {
|
|
root.join(format!("{product_name}.app"))
|
|
.join("Contents")
|
|
.join("MacOS")
|
|
.join(product_name)
|
|
})
|
|
})
|
|
.collect()
|
|
}
|
|
"windows" => {
|
|
let mut roots = Vec::new();
|
|
if let Some(local_app_data) = std::env::var_os("LOCALAPPDATA") {
|
|
roots.push(PathBuf::from(local_app_data).join("Programs"));
|
|
}
|
|
if let Some(program_files) = std::env::var_os("ProgramFiles") {
|
|
roots.push(PathBuf::from(program_files));
|
|
}
|
|
if let Some(program_files_x86) = std::env::var_os("ProgramFiles(x86)") {
|
|
roots.push(PathBuf::from(program_files_x86));
|
|
}
|
|
|
|
roots
|
|
.into_iter()
|
|
.flat_map(|root| {
|
|
CODEX_APP_PRODUCT_NAMES
|
|
.into_iter()
|
|
.map(move |product_name| {
|
|
root.join(product_name).join(format!("{product_name}.exe"))
|
|
})
|
|
})
|
|
.collect()
|
|
}
|
|
"linux" => [PathBuf::from("/opt"), PathBuf::from("/usr/lib")]
|
|
.into_iter()
|
|
.flat_map(|root| {
|
|
CODEX_APP_PRODUCT_NAMES
|
|
.into_iter()
|
|
.map(move |product_name| root.join(product_name).join(product_name))
|
|
})
|
|
.collect(),
|
|
_ => Vec::new(),
|
|
}
|
|
}
|