mirror of
https://github.com/openai/codex.git
synced 2026-11-20 23:08:21 +00:00
Add a loader for executor-local config layers (#37406)
## What changed - Add `load_local_config_layers` to return raw configuration and requirements layers with their sources, base directories, precedence order, and cloud insertion positions. - Support projecting layer stacks to selected TOML paths while preserving non-table override blockers and adjusting cloud insertion positions when empty layers are removed. - Reuse project discovery and trust handling for local reads, including linked-worktree hooks, without resolving relative paths or including profiles, session flags, thread layers, or cloud-provided values. ## Testing - Cover layer ordering, raw relative paths, legacy requirements, trust filtering, projection semantics, and untrusted linked-worktree hook handling. GitOrigin-RevId: a1098af5650ac44e5a230ba9a5fe918927986d05
This commit is contained in:
1 parent
c87a218bd3
commit
957f8eedee
5 files changed
+831
-90
No files matched your search
@@ -1,4 +1,5 @@
|
||||
mod layer_io;
|
||||
mod local;
|
||||
#[cfg(target_os = "macos")]
|
||||
mod macos;
|
||||
#[cfg(test)]
|
||||
@@ -51,6 +52,11 @@ use std::path::Path;
|
||||
use std::path::PathBuf;
|
||||
use toml::Value as TomlValue;
|
||||
|
||||
pub use local::LocalConfigLayers;
|
||||
pub use local::LocalTomlLayer;
|
||||
pub use local::LocalTomlLayerStack;
|
||||
pub use local::load_local_config_layers;
|
||||
|
||||
#[cfg(unix)]
|
||||
const SYSTEM_CONFIG_TOML_FILE_UNIX: &str = "/etc/codex/config.toml";
|
||||
|
||||
@@ -188,6 +194,7 @@ pub async fn load_config_layers_state(
|
||||
// requirements layers for backwards compatibility.
|
||||
requirements_layers.extend(requirements_layers_from_legacy_scheme(
|
||||
loaded_config_layers.clone(),
|
||||
codex_home,
|
||||
)?);
|
||||
requirements_layers.extend(managed_preferences_requirements_layer);
|
||||
}
|
||||
@@ -499,18 +506,36 @@ async fn load_config_toml_for_required_layer(
|
||||
strict_config: bool,
|
||||
create_entry: impl FnOnce(TomlValue) -> ConfigLayerEntry,
|
||||
) -> io::Result<ConfigLayerEntry> {
|
||||
let loaded = load_config_toml_for_required_layer_raw(fs, toml_file, strict_config).await?;
|
||||
let toml_value = resolve_relative_paths_in_config_toml(loaded.toml, loaded.base_dir.as_path())?;
|
||||
|
||||
Ok(create_entry(toml_value))
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone)]
|
||||
struct LoadedTomlFile {
|
||||
toml: TomlValue,
|
||||
base_dir: AbsolutePathBuf,
|
||||
}
|
||||
|
||||
async fn load_config_toml_for_required_layer_raw(
|
||||
fs: &dyn ExecutorFileSystem,
|
||||
toml_file: &AbsolutePathBuf,
|
||||
strict_config: bool,
|
||||
) -> io::Result<LoadedTomlFile> {
|
||||
let config_parent = toml_file.as_path().parent().ok_or_else(|| {
|
||||
io::Error::new(
|
||||
io::ErrorKind::InvalidData,
|
||||
format!(
|
||||
"Config file {} has no parent directory",
|
||||
toml_file.as_path().display()
|
||||
),
|
||||
)
|
||||
})?;
|
||||
let base_dir = AbsolutePathBuf::from_absolute_path(config_parent)?;
|
||||
let toml_file_uri = PathUri::from_abs_path(toml_file);
|
||||
let toml_value = match fs.read_file_text(&toml_file_uri, /*sandbox*/ None).await {
|
||||
Ok(contents) => {
|
||||
let config_parent = toml_file.as_path().parent().ok_or_else(|| {
|
||||
io::Error::new(
|
||||
io::ErrorKind::InvalidData,
|
||||
format!(
|
||||
"Config file {} has no parent directory",
|
||||
toml_file.as_path().display()
|
||||
),
|
||||
)
|
||||
})?;
|
||||
let config: TomlValue = toml::from_str(&contents).map_err(|err| {
|
||||
let config_error =
|
||||
config_error_from_toml(toml_file.as_path(), &contents, err.clone());
|
||||
@@ -524,7 +549,7 @@ async fn load_config_toml_for_required_layer(
|
||||
config_parent,
|
||||
)?;
|
||||
}
|
||||
resolve_relative_paths_in_config_toml(config, config_parent)
|
||||
Ok(config)
|
||||
}
|
||||
Err(e) => {
|
||||
if e.kind() == io::ErrorKind::NotFound {
|
||||
@@ -541,7 +566,10 @@ async fn load_config_toml_for_required_layer(
|
||||
}
|
||||
}?;
|
||||
|
||||
Ok(create_entry(toml_value))
|
||||
Ok(LoadedTomlFile {
|
||||
toml: toml_value,
|
||||
base_dir,
|
||||
})
|
||||
}
|
||||
|
||||
fn validate_config_toml_strictly(
|
||||
@@ -750,6 +778,7 @@ fn windows_program_data_dir_from_known_folder() -> io::Result<PathBuf> {
|
||||
|
||||
fn requirements_layers_from_legacy_scheme(
|
||||
loaded_config_layers: LoadedConfigLayers,
|
||||
codex_home: &Path,
|
||||
) -> io::Result<Vec<RequirementsLayerEntry>> {
|
||||
// List the file-backed legacy layer first because requirements layers are
|
||||
// composed lowest-precedence to highest-precedence, and MDM has higher
|
||||
@@ -762,18 +791,31 @@ fn requirements_layers_from_legacy_scheme(
|
||||
let layer_count =
|
||||
usize::from(managed_config.is_some()) + usize::from(managed_config_from_mdm.is_some());
|
||||
let mut layers = Vec::with_capacity(layer_count);
|
||||
for (source, config) in managed_config
|
||||
let codex_home = AbsolutePathBuf::from_absolute_path(codex_home)?;
|
||||
for (source, config, base_dir) in managed_config
|
||||
.map(|c| {
|
||||
(
|
||||
let base_dir = c.file.parent().ok_or_else(|| {
|
||||
io::Error::new(
|
||||
io::ErrorKind::InvalidData,
|
||||
format!(
|
||||
"Managed config file {} has no parent directory",
|
||||
c.file.as_path().display()
|
||||
),
|
||||
)
|
||||
})?;
|
||||
Ok::<_, io::Error>((
|
||||
RequirementSource::LegacyManagedConfigTomlFromFile { file: c.file },
|
||||
c.managed_config,
|
||||
)
|
||||
base_dir,
|
||||
))
|
||||
})
|
||||
.transpose()?
|
||||
.into_iter()
|
||||
.chain(managed_config_from_mdm.map(|config| {
|
||||
(
|
||||
RequirementSource::LegacyManagedConfigTomlFromMdm,
|
||||
config.managed_config,
|
||||
codex_home.clone(),
|
||||
)
|
||||
}))
|
||||
{
|
||||
@@ -785,10 +827,13 @@ fn requirements_layers_from_legacy_scheme(
|
||||
)
|
||||
})?;
|
||||
|
||||
layers.push(RequirementsLayerEntry::from_toml_value(
|
||||
source,
|
||||
legacy_requirements_to_toml_value(legacy_config)?,
|
||||
));
|
||||
layers.push(
|
||||
RequirementsLayerEntry::from_toml_value(
|
||||
source,
|
||||
legacy_requirements_to_toml_value(legacy_config)?,
|
||||
)
|
||||
.with_base_dir(base_dir),
|
||||
);
|
||||
}
|
||||
|
||||
Ok(layers)
|
||||
@@ -1212,6 +1257,20 @@ struct LoadedProjectLayers {
|
||||
startup_warnings: Vec<String>,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone)]
|
||||
struct DiscoveredProjectLayer {
|
||||
dot_codex_folder: AbsolutePathBuf,
|
||||
config: TomlValue,
|
||||
disabled_reason: Option<String>,
|
||||
hooks_config_folder_override: Option<AbsolutePathBuf>,
|
||||
load_root_checkout_hooks: bool,
|
||||
}
|
||||
|
||||
struct DiscoveredProjectLayers {
|
||||
layers: Vec<DiscoveredProjectLayer>,
|
||||
startup_warnings: Vec<String>,
|
||||
}
|
||||
|
||||
/// Return the appropriate list of layers (each with
|
||||
/// [ConfigLayerSource::Project] as the source) between `cwd` and
|
||||
/// `project_root`, inclusive. The list is ordered in _increasing_ precdence,
|
||||
@@ -1226,6 +1285,52 @@ async fn load_project_layers(
|
||||
codex_home: &Path,
|
||||
strict_config: bool,
|
||||
) -> io::Result<LoadedProjectLayers> {
|
||||
let discovered = discover_project_layers(
|
||||
fs,
|
||||
cwd,
|
||||
project_root,
|
||||
trust_context,
|
||||
codex_home,
|
||||
strict_config,
|
||||
)
|
||||
.await?;
|
||||
let mut layers = Vec::with_capacity(discovered.layers.len());
|
||||
for layer in discovered.layers {
|
||||
let config =
|
||||
resolve_relative_paths_in_config_toml(layer.config, layer.dot_codex_folder.as_path())?;
|
||||
let config = if layer.load_root_checkout_hooks {
|
||||
merge_root_checkout_project_hooks(
|
||||
fs,
|
||||
config,
|
||||
layer.hooks_config_folder_override.as_ref(),
|
||||
layer.disabled_reason.is_none(),
|
||||
)
|
||||
.await?
|
||||
} else {
|
||||
config
|
||||
};
|
||||
layers.push(project_layer_entry(
|
||||
&layer.dot_codex_folder,
|
||||
config,
|
||||
layer.disabled_reason,
|
||||
layer.hooks_config_folder_override,
|
||||
));
|
||||
}
|
||||
|
||||
Ok(LoadedProjectLayers {
|
||||
layers,
|
||||
startup_warnings: discovered.startup_warnings,
|
||||
})
|
||||
}
|
||||
|
||||
async fn discover_project_layers(
|
||||
fs: &dyn ExecutorFileSystem,
|
||||
cwd: &AbsolutePathBuf,
|
||||
project_root: &AbsolutePathBuf,
|
||||
trust_context: &ProjectTrustContext,
|
||||
codex_home: &Path,
|
||||
strict_config: bool,
|
||||
) -> io::Result<DiscoveredProjectLayers> {
|
||||
let codex_home_abs = AbsolutePathBuf::from_absolute_path(codex_home)?;
|
||||
let codex_home_normalized =
|
||||
normalize_path(codex_home_abs.as_path()).unwrap_or_else(|_| codex_home_abs.to_path_buf());
|
||||
@@ -1282,12 +1387,13 @@ async fn load_project_layers(
|
||||
),
|
||||
));
|
||||
}
|
||||
layers.push(project_layer_entry(
|
||||
&dot_codex_abs,
|
||||
TomlValue::Table(toml::map::Map::new()),
|
||||
disabled_reason.clone(),
|
||||
hooks_config_folder_override.clone(),
|
||||
));
|
||||
layers.push(DiscoveredProjectLayer {
|
||||
dot_codex_folder: dot_codex_abs,
|
||||
config: TomlValue::Table(toml::map::Map::new()),
|
||||
disabled_reason,
|
||||
hooks_config_folder_override,
|
||||
load_root_checkout_hooks: false,
|
||||
});
|
||||
continue;
|
||||
}
|
||||
};
|
||||
@@ -1301,47 +1407,32 @@ async fn load_project_layers(
|
||||
)?;
|
||||
}
|
||||
let ignored_project_config_keys = sanitize_project_config(&mut config);
|
||||
let config =
|
||||
resolve_relative_paths_in_config_toml(config, dot_codex_abs.as_path())?;
|
||||
let config = merge_root_checkout_project_hooks(
|
||||
fs,
|
||||
config,
|
||||
hooks_config_folder_override.as_ref(),
|
||||
decision.is_trusted(),
|
||||
)
|
||||
.await?;
|
||||
if disabled_reason.is_none() && !ignored_project_config_keys.is_empty() {
|
||||
startup_warnings.push(project_ignored_config_keys_warning(
|
||||
&dot_codex_abs,
|
||||
&ignored_project_config_keys,
|
||||
));
|
||||
}
|
||||
let entry = project_layer_entry(
|
||||
&dot_codex_abs,
|
||||
layers.push(DiscoveredProjectLayer {
|
||||
dot_codex_folder: dot_codex_abs,
|
||||
config,
|
||||
disabled_reason.clone(),
|
||||
hooks_config_folder_override.clone(),
|
||||
);
|
||||
layers.push(entry);
|
||||
disabled_reason,
|
||||
hooks_config_folder_override,
|
||||
load_root_checkout_hooks: true,
|
||||
});
|
||||
}
|
||||
Err(err) => {
|
||||
if err.kind() == io::ErrorKind::NotFound {
|
||||
// If there is no config.toml file, record an empty entry
|
||||
// for this project layer, as this may still have subfolders
|
||||
// that are significant in the overall ConfigLayerStack.
|
||||
let config = merge_root_checkout_project_hooks(
|
||||
fs,
|
||||
TomlValue::Table(toml::map::Map::new()),
|
||||
hooks_config_folder_override.as_ref(),
|
||||
decision.is_trusted(),
|
||||
)
|
||||
.await?;
|
||||
layers.push(project_layer_entry(
|
||||
&dot_codex_abs,
|
||||
config,
|
||||
layers.push(DiscoveredProjectLayer {
|
||||
dot_codex_folder: dot_codex_abs,
|
||||
config: TomlValue::Table(toml::map::Map::new()),
|
||||
disabled_reason,
|
||||
hooks_config_folder_override,
|
||||
));
|
||||
load_root_checkout_hooks: true,
|
||||
});
|
||||
} else {
|
||||
let config_file_display = config_file.as_path().display();
|
||||
return Err(io::Error::new(
|
||||
@@ -1353,7 +1444,7 @@ async fn load_project_layers(
|
||||
}
|
||||
}
|
||||
|
||||
Ok(LoadedProjectLayers {
|
||||
Ok(DiscoveredProjectLayers {
|
||||
layers,
|
||||
startup_warnings,
|
||||
})
|
||||
@@ -1370,43 +1461,10 @@ async fn merge_root_checkout_project_hooks(
|
||||
let Some(hooks_config_folder) = hooks_config_folder_override else {
|
||||
return Ok(config);
|
||||
};
|
||||
let hooks_config_file = hooks_config_folder.join(CONFIG_TOML_FILE);
|
||||
let hooks_config_file_uri = PathUri::from_abs_path(&hooks_config_file);
|
||||
let root_config = match fs
|
||||
.read_file_text(&hooks_config_file_uri, /*sandbox*/ None)
|
||||
.await
|
||||
{
|
||||
Ok(contents) => {
|
||||
let parsed: TomlValue = match toml::from_str(&contents) {
|
||||
Ok(parsed) => parsed,
|
||||
Err(err) => {
|
||||
if is_trusted {
|
||||
return Err(io::Error::new(
|
||||
io::ErrorKind::InvalidData,
|
||||
format!(
|
||||
"Error parsing project hooks config file {}: {err}",
|
||||
hooks_config_file.as_path().display()
|
||||
),
|
||||
));
|
||||
}
|
||||
TomlValue::Table(toml::map::Map::new())
|
||||
}
|
||||
};
|
||||
resolve_relative_paths_in_config_toml(parsed, hooks_config_folder.as_path())?
|
||||
}
|
||||
Err(err) if err.kind() == io::ErrorKind::NotFound => {
|
||||
TomlValue::Table(toml::map::Map::new())
|
||||
}
|
||||
Err(err) => {
|
||||
return Err(io::Error::new(
|
||||
err.kind(),
|
||||
format!(
|
||||
"Failed to read project hooks config file {}: {err}",
|
||||
hooks_config_file.as_path().display()
|
||||
),
|
||||
));
|
||||
}
|
||||
};
|
||||
let root_config =
|
||||
load_root_checkout_project_config(fs, hooks_config_folder, is_trusted).await?;
|
||||
let root_config =
|
||||
resolve_relative_paths_in_config_toml(root_config, hooks_config_folder.as_path())?;
|
||||
|
||||
let Some(config_table) = config.as_table_mut() else {
|
||||
return Ok(config);
|
||||
@@ -1417,6 +1475,52 @@ async fn merge_root_checkout_project_hooks(
|
||||
}
|
||||
Ok(config)
|
||||
}
|
||||
|
||||
async fn load_root_checkout_project_config(
|
||||
fs: &dyn ExecutorFileSystem,
|
||||
hooks_config_folder: &AbsolutePathBuf,
|
||||
is_trusted: bool,
|
||||
) -> io::Result<TomlValue> {
|
||||
let hooks_config_file = hooks_config_folder.join(CONFIG_TOML_FILE);
|
||||
let hooks_config_file_uri = PathUri::from_abs_path(&hooks_config_file);
|
||||
Ok(
|
||||
match fs
|
||||
.read_file_text(&hooks_config_file_uri, /*sandbox*/ None)
|
||||
.await
|
||||
{
|
||||
Ok(contents) => {
|
||||
let parsed: TomlValue = match toml::from_str(&contents) {
|
||||
Ok(parsed) => parsed,
|
||||
Err(err) => {
|
||||
if is_trusted {
|
||||
return Err(io::Error::new(
|
||||
io::ErrorKind::InvalidData,
|
||||
format!(
|
||||
"Error parsing project hooks config file {}: {err}",
|
||||
hooks_config_file.as_path().display()
|
||||
),
|
||||
));
|
||||
}
|
||||
TomlValue::Table(toml::map::Map::new())
|
||||
}
|
||||
};
|
||||
parsed
|
||||
}
|
||||
Err(err) if err.kind() == io::ErrorKind::NotFound => {
|
||||
TomlValue::Table(toml::map::Map::new())
|
||||
}
|
||||
Err(err) => {
|
||||
return Err(io::Error::new(
|
||||
err.kind(),
|
||||
format!(
|
||||
"Failed to read project hooks config file {}: {err}",
|
||||
hooks_config_file.as_path().display()
|
||||
),
|
||||
));
|
||||
}
|
||||
},
|
||||
)
|
||||
}
|
||||
/// The legacy mechanism for specifying admin-enforced configuration is to read
|
||||
/// from a file like `/etc/codex/managed_config.toml` that has the same
|
||||
/// structure as `config.toml` where fields like `approval_policy` can specify
|
||||
|
||||
Reference in new issue
Block a user