mirror of
https://github.com/openai/codex.git
synced 2026-05-05 05:42:33 +03:00
c3e60849e5
# Why Requirements support host-specific `remote_sandbox_config.hostname_patterns`, but config loading previously resolved and passed the system hostname through every config-loading path even when no requirements layer used `remote_sandbox_config`. On machines where hostname lookup is slow, startup and app-server config reads paid for a feature that was not active. We only need the hostname when a requirements layer actually declares `remote_sandbox_config`, so this moves hostname resolution to the single requirements merge point and keeps all other config callers unaware of hostname matching. # What - Removed the eager `host_name` plumbing from `load_config_layers_state`, `load_requirements_toml`, `ConfigBuilder`, app-server `ConfigManager`, network proxy loading, and related call sites. - Resolve the hostname inside `merge_requirements_with_remote_sandbox_config` only when the incoming requirements contain `remote_sandbox_config`.
79 lines
2.9 KiB
Markdown
79 lines
2.9 KiB
Markdown
# `codex-config` loader
|
||
|
||
This module is the canonical place to **load and describe Codex configuration layers** (user config, CLI/session overrides, managed config, and MDM-managed preferences) and to produce:
|
||
|
||
- An **effective merged** TOML config.
|
||
- **Per-key origins** metadata (which layer “wins” for a given key).
|
||
- **Per-layer versions** (stable fingerprints) used for optimistic concurrency / conflict detection.
|
||
|
||
## Public surface
|
||
|
||
Exported from `codex_config::loader`:
|
||
|
||
- `load_config_layers_state(fs, codex_home, cwd_opt, cli_overrides, overrides, cloud_requirements, thread_config_loader) -> ConfigLayerStack`
|
||
- `ConfigLayerStack`
|
||
- `effective_config() -> toml::Value`
|
||
- `origins() -> HashMap<String, ConfigLayerMetadata>`
|
||
- `layers_high_to_low() -> Vec<ConfigLayer>`
|
||
- `with_user_config(user_config) -> ConfigLayerStack`
|
||
- `ConfigLayerEntry` (one layer’s `{name, config, version, disabled_reason}`; `name` carries source metadata)
|
||
- `LoaderOverrides` (test/override hooks for managed config sources)
|
||
- `merge_toml_values(base, overlay)` (public helper used elsewhere)
|
||
|
||
## Layering model
|
||
|
||
Precedence is **top overrides bottom**:
|
||
|
||
1. **MDM** managed preferences (macOS only)
|
||
2. **System** managed config (e.g. `managed_config.toml`)
|
||
3. **Session flags** (CLI overrides, applied as dotted-path TOML writes)
|
||
4. **User** config (`config.toml`)
|
||
|
||
Thread config entries supplied by `thread_config_loader` are inserted according
|
||
to their translated `ConfigLayerSource` precedence.
|
||
|
||
Layers with a `disabled_reason` are still surfaced for UI, but are ignored when
|
||
computing the effective config and origins metadata. This is what
|
||
`ConfigLayerStack::effective_config()` implements.
|
||
|
||
## Typical usage
|
||
|
||
Most callers want the effective config plus metadata:
|
||
|
||
```rust
|
||
use codex_config::NoopThreadConfigLoader;
|
||
use codex_config::CloudRequirementsLoader;
|
||
use codex_config::LoaderOverrides;
|
||
use codex_config::loader::load_config_layers_state;
|
||
use codex_exec_server::LOCAL_FS;
|
||
use codex_utils_absolute_path::AbsolutePathBuf;
|
||
use toml::Value as TomlValue;
|
||
|
||
let cli_overrides: Vec<(String, TomlValue)> = Vec::new();
|
||
let cwd = AbsolutePathBuf::current_dir()?;
|
||
let layers = load_config_layers_state(
|
||
LOCAL_FS.as_ref(),
|
||
&codex_home,
|
||
Some(cwd),
|
||
&cli_overrides,
|
||
LoaderOverrides::default(),
|
||
CloudRequirementsLoader::default(),
|
||
&NoopThreadConfigLoader,
|
||
).await?;
|
||
|
||
let effective = layers.effective_config();
|
||
let origins = layers.origins();
|
||
let layers_for_ui = layers.layers_high_to_low();
|
||
```
|
||
|
||
## Internal layout
|
||
|
||
Implementation is split by concern:
|
||
|
||
- `state.rs`: public types (`ConfigLayerEntry`, `ConfigLayerStack`) + merge/origins convenience methods.
|
||
- `layer_io.rs`: reading `config.toml`, managed config, and managed preferences inputs.
|
||
- `overrides.rs`: CLI dotted-path overrides → TOML “session flags” layer.
|
||
- `merge.rs`: recursive TOML merge.
|
||
- `fingerprint.rs`: stable per-layer hashing and per-key origins traversal.
|
||
- `macos.rs`: managed preferences integration (macOS only).
|