mirror of
https://github.com/openai/codex.git
synced 2026-11-20 22:40:37 +00:00
## Why Shell snapshots are currently session-scoped even though shell and cwd are properties of a selected turn environment. That makes snapshot refresh depend on separate session-cwd plumbing, prevents retained environments from retaining their snapshot work, and can make snapshot construction use a different shell than command execution. This follows #27955 by making the retained thread-environment service own environment snapshot lifecycles. Session configuration remains the requested selection state, while `ThreadEnvironments` remains the source of successfully resolved environments. ## What changed - Configure the shell-snapshot builder before initial environment resolution. - Start each local environment snapshot task when its `TurnEnvironment` is built and retain that shared task while environment ID and cwd still match. - Inherit retained environment snapshots into spawned child threads. - Carry the selected `TurnEnvironment` through shell runtimes so snapshot construction and command execution use the same environment-specific shell and cwd. - Load project instructions and warm plugins/skills after initial environment resolution. - Continue decoding invalid UTF-8 instruction files lossily without emitting a startup warning. - Keep requested selections in `SessionConfiguration`; failed or duplicate resolutions only affect the resolved environment snapshot. ## Validation - `cargo check -p codex-core --tests` - `just test -p codex-home instructions` (6 passed) - Focused environment, instruction, shell-snapshot, and user-shell tests (84 passed) - Focused shell-snapshot, user-shell, and unified-exec tests (126 passed; two event-timing tests passed on retry)
148 lines
4.5 KiB
Rust
148 lines
4.5 KiB
Rust
use std::fs;
|
|
use std::path::Path;
|
|
|
|
use codex_extension_api::LoadedUserInstructions;
|
|
use codex_extension_api::UserInstructions;
|
|
use codex_extension_api::UserInstructionsProvider;
|
|
use codex_utils_absolute_path::AbsolutePathBuf;
|
|
use pretty_assertions::assert_eq;
|
|
use tempfile::TempDir;
|
|
|
|
use super::CodexHomeUserInstructionsProvider;
|
|
use super::DEFAULT_AGENTS_MD_FILENAME;
|
|
use super::LOCAL_AGENTS_MD_FILENAME;
|
|
|
|
fn provider(home: &TempDir) -> CodexHomeUserInstructionsProvider {
|
|
CodexHomeUserInstructionsProvider::new(
|
|
AbsolutePathBuf::try_from(home.path().to_path_buf()).expect("absolute temp dir"),
|
|
)
|
|
}
|
|
|
|
fn expected(
|
|
home: &TempDir,
|
|
filename: &str,
|
|
text: &str,
|
|
warnings: Vec<String>,
|
|
) -> LoadedUserInstructions {
|
|
LoadedUserInstructions {
|
|
instructions: Some(UserInstructions {
|
|
text: text.to_string(),
|
|
source: AbsolutePathBuf::try_from(home.path().join(filename))
|
|
.expect("absolute source path"),
|
|
}),
|
|
warnings,
|
|
}
|
|
}
|
|
|
|
#[cfg(unix)]
|
|
fn create_symlink_loop(path: &Path) {
|
|
std::os::unix::fs::symlink(
|
|
path.file_name().expect("override path should have a name"),
|
|
path,
|
|
)
|
|
.expect("create symlink loop");
|
|
}
|
|
|
|
#[cfg(windows)]
|
|
fn create_symlink_loop(path: &Path) {
|
|
std::os::windows::fs::symlink_file(
|
|
path.file_name().expect("override path should have a name"),
|
|
path,
|
|
)
|
|
.expect("create symlink loop");
|
|
}
|
|
|
|
#[tokio::test]
|
|
async fn missing_files_return_no_instructions() {
|
|
let home = TempDir::new().expect("temp dir");
|
|
|
|
assert_eq!(
|
|
provider(&home).load_user_instructions().await,
|
|
LoadedUserInstructions::default()
|
|
);
|
|
}
|
|
|
|
#[tokio::test]
|
|
async fn override_takes_precedence_over_default() {
|
|
let home = TempDir::new().expect("temp dir");
|
|
fs::write(home.path().join(DEFAULT_AGENTS_MD_FILENAME), "default").expect("write default");
|
|
fs::write(home.path().join(LOCAL_AGENTS_MD_FILENAME), "override").expect("write override");
|
|
|
|
assert_eq!(
|
|
provider(&home).load_user_instructions().await,
|
|
expected(&home, LOCAL_AGENTS_MD_FILENAME, "override", Vec::new())
|
|
);
|
|
}
|
|
|
|
#[tokio::test]
|
|
async fn empty_override_falls_back_to_trimmed_default() {
|
|
let home = TempDir::new().expect("temp dir");
|
|
fs::write(home.path().join(LOCAL_AGENTS_MD_FILENAME), " \n\t").expect("write override");
|
|
fs::write(
|
|
home.path().join(DEFAULT_AGENTS_MD_FILENAME),
|
|
"\n default instructions \n",
|
|
)
|
|
.expect("write default");
|
|
|
|
assert_eq!(
|
|
provider(&home).load_user_instructions().await,
|
|
expected(
|
|
&home,
|
|
DEFAULT_AGENTS_MD_FILENAME,
|
|
"default instructions",
|
|
Vec::new()
|
|
)
|
|
);
|
|
}
|
|
|
|
#[tokio::test]
|
|
async fn directory_override_falls_back_to_default() {
|
|
let home = TempDir::new().expect("temp dir");
|
|
fs::create_dir(home.path().join(LOCAL_AGENTS_MD_FILENAME)).expect("create override directory");
|
|
fs::write(home.path().join(DEFAULT_AGENTS_MD_FILENAME), "default").expect("write default");
|
|
|
|
assert_eq!(
|
|
provider(&home).load_user_instructions().await,
|
|
expected(&home, DEFAULT_AGENTS_MD_FILENAME, "default", Vec::new())
|
|
);
|
|
}
|
|
|
|
#[tokio::test]
|
|
async fn recoverable_override_read_error_warns_and_falls_back_to_default() {
|
|
let home = TempDir::new().expect("temp dir");
|
|
let override_path = home.path().join(LOCAL_AGENTS_MD_FILENAME);
|
|
create_symlink_loop(&override_path);
|
|
fs::write(home.path().join(DEFAULT_AGENTS_MD_FILENAME), "default").expect("write default");
|
|
let read_error = fs::read(&override_path).expect_err("symlink loop should not be readable");
|
|
let warning = format!(
|
|
"Failed to read global AGENTS.md instructions from `{}`: {read_error}",
|
|
override_path.display()
|
|
);
|
|
|
|
assert_eq!(
|
|
provider(&home).load_user_instructions().await,
|
|
expected(&home, DEFAULT_AGENTS_MD_FILENAME, "default", vec![warning])
|
|
);
|
|
}
|
|
|
|
#[tokio::test]
|
|
async fn invalid_utf8_is_lossy() {
|
|
let home = TempDir::new().expect("temp dir");
|
|
let path = home.path().join(DEFAULT_AGENTS_MD_FILENAME);
|
|
let mut invalid_utf8 = b"global".to_vec();
|
|
invalid_utf8.push(0xff);
|
|
invalid_utf8.extend_from_slice(b" doc");
|
|
fs::write(&path, &invalid_utf8).expect("write invalid utf-8");
|
|
|
|
let outcome = provider(&home).load_user_instructions().await;
|
|
assert_eq!(
|
|
outcome,
|
|
expected(
|
|
&home,
|
|
DEFAULT_AGENTS_MD_FILENAME,
|
|
"global\u{fffd} doc",
|
|
Vec::new()
|
|
)
|
|
);
|
|
}
|