mirror of
https://github.com/openai/codex.git
synced 2026-11-09 00:39:32 +00:00
Retry failed shell snapshot captures (#40447)
## Why A failed shell snapshot capture was cached for the lifetime of its cache entry, so later commands continued using the original command even after a transient profile error was fixed. ## What changed - Retry failed captures after a one-second backoff, up to three total attempts. - Share each attempt across concurrent requests and preserve command fallback during failures and backoff. - Keep the final failure cached after the retry budget is exhausted. ## Testing Cover recovery and retry exhaustion for concurrent requests, local and remote execution, pipes and TTYs, and Bash and zsh where available. GitOrigin-RevId: b432ef7c9eb35a3a0a703ac675b4db6954c43a80
This commit is contained in:
1 parent
eb15245d82
commit
0fe877b4de
3 files changed
+205
-21
No files matched your search
@@ -2,9 +2,120 @@ use std::collections::HashMap;
|
||||
|
||||
use codex_protocol::config_types::ShellEnvironmentPolicyInherit;
|
||||
use pretty_assertions::assert_eq;
|
||||
use test_case::test_case;
|
||||
|
||||
use super::MAX_SNAPSHOT_ATTEMPTS;
|
||||
use super::SNAPSHOT_RETRY_BACKOFF;
|
||||
use super::ShellSnapshotCache;
|
||||
use super::parse_snapshot;
|
||||
use crate::process_sandbox::prepare_exec_request;
|
||||
use crate::protocol::ExecEnvPolicy;
|
||||
use crate::protocol::ExecParams;
|
||||
use crate::protocol::ProcessId;
|
||||
use crate::protocol::ShellInfo;
|
||||
use crate::protocol::ShellSnapshotRequest;
|
||||
|
||||
#[test_case(2; "recovers_on_second_attempt")]
|
||||
#[test_case(3; "recovers_on_last_attempt")]
|
||||
#[test_case(4; "stops_after_three_failures")]
|
||||
#[tokio::test]
|
||||
async fn snapshot_failure_retries_are_bounded_and_single_flight(
|
||||
recovery_attempt: usize,
|
||||
) -> anyhow::Result<()> {
|
||||
let home = tempfile::TempDir::new()?;
|
||||
let profile = home.path().join(".bashrc");
|
||||
std::fs::write(&profile, "printf x >> \"$HOME/captures\"\nexit 7\n")?;
|
||||
let params = ExecParams {
|
||||
process_id: ProcessId::from("snapshot-retry"),
|
||||
argv: vec![
|
||||
"/bin/bash".to_string(),
|
||||
"-lc".to_string(),
|
||||
"true".to_string(),
|
||||
],
|
||||
cwd: codex_utils_path_uri::PathUri::from_host_native_path(home.path())?,
|
||||
env: HashMap::from([
|
||||
(
|
||||
"HOME".to_string(),
|
||||
home.path().to_string_lossy().into_owned(),
|
||||
),
|
||||
("PATH".to_string(), "/usr/bin:/bin".to_string()),
|
||||
]),
|
||||
env_policy: None,
|
||||
shell_snapshot: Some(ShellSnapshotRequest {
|
||||
scope_id: "attachment-1".to_string(),
|
||||
shell: ShellInfo {
|
||||
name: "bash".to_string(),
|
||||
path: "/bin/bash".to_string(),
|
||||
},
|
||||
}),
|
||||
tty: false,
|
||||
pipe_stdin: false,
|
||||
arg0: None,
|
||||
sandbox: None,
|
||||
enforce_managed_network: false,
|
||||
managed_network: None,
|
||||
network_proxy: None,
|
||||
};
|
||||
let cache = ShellSnapshotCache::default();
|
||||
|
||||
for attempt in 1..=5 {
|
||||
if attempt == recovery_attempt {
|
||||
std::fs::write(
|
||||
&profile,
|
||||
"printf x >> \"$HOME/captures\"\nprofile_helper() { printf recovered; }\n",
|
||||
)?;
|
||||
}
|
||||
let mut prepared = prepare_exec_request(
|
||||
¶ms,
|
||||
params.env.clone(),
|
||||
/*runtime_paths*/ None,
|
||||
/*network_policy_decider*/ None,
|
||||
/*network_policy_audit_observer*/ None,
|
||||
)
|
||||
.await
|
||||
.expect("prepare capture");
|
||||
let mut concurrent = prepare_exec_request(
|
||||
¶ms,
|
||||
params.env.clone(),
|
||||
/*runtime_paths*/ None,
|
||||
/*network_policy_decider*/ None,
|
||||
/*network_policy_audit_observer*/ None,
|
||||
)
|
||||
.await
|
||||
.expect("prepare concurrent capture");
|
||||
let (first, second) = tokio::join!(
|
||||
cache.prepare(¶ms, &mut prepared),
|
||||
cache.prepare(¶ms, &mut concurrent),
|
||||
);
|
||||
first.expect("capture failure must preserve command fallback");
|
||||
second.expect("concurrent request must share the capture attempt");
|
||||
assert_eq!(
|
||||
(&prepared.command, &prepared.env),
|
||||
(&concurrent.command, &concurrent.env)
|
||||
);
|
||||
|
||||
tokio::time::pause();
|
||||
if attempt < recovery_attempt || recovery_attempt > MAX_SNAPSHOT_ATTEMPTS {
|
||||
cache
|
||||
.prepare(¶ms, &mut prepared)
|
||||
.await
|
||||
.expect("capture must stay cached during backoff");
|
||||
assert_eq!(
|
||||
(&prepared.command, &prepared.env),
|
||||
(¶ms.argv, ¶ms.env)
|
||||
);
|
||||
} else {
|
||||
assert_ne!(prepared.command, params.argv);
|
||||
}
|
||||
assert_eq!(
|
||||
std::fs::read_to_string(home.path().join("captures"))?,
|
||||
"x".repeat(attempt.min(recovery_attempt).min(MAX_SNAPSHOT_ATTEMPTS))
|
||||
);
|
||||
tokio::time::advance(SNAPSHOT_RETRY_BACKOFF).await;
|
||||
tokio::time::resume();
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn snapshot_filters_profile_exports_after_capture() {
|
||||
|
||||
Reference in new issue
Block a user