File size: 10,288 Bytes
1851bae | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 | use std::path::PathBuf;
use std::sync::LazyLock;
use config::ConfigBuilder;
use config::builder::DefaultState;
use crate::ForgeConfig;
use crate::legacy::LegacyConfig;
/// Loads all `.env` files found while walking up from the current working
/// directory to the root, with priority given to closer (lower) directories.
/// Executed at most once per process.
static LOAD_DOT_ENV: LazyLock<()> = LazyLock::new(|| {
let cwd = std::env::current_dir().unwrap_or_else(|_| PathBuf::from("."));
let mut paths = vec![];
let mut current = PathBuf::new();
for component in cwd.components() {
current.push(component);
paths.push(current.clone());
}
paths.reverse();
for path in paths {
let env_file = path.join(".env");
if env_file.is_file() {
dotenvy::from_path(&env_file).ok();
}
}
});
/// Caches base-path resolution for the process lifetime.
static BASE_PATH: LazyLock<PathBuf> = LazyLock::new(ConfigReader::resolve_base_path);
/// Merges [`ForgeConfig`] from layered sources using a builder pattern.
#[derive(Default)]
pub struct ConfigReader {
builder: ConfigBuilder<DefaultState>,
}
impl ConfigReader {
/// Returns the path to the legacy JSON config file
/// (`~/.forge/.config.json`).
pub fn config_legacy_path() -> PathBuf {
Self::base_path().join(".config.json")
}
/// Returns the path to the primary TOML config file
/// (`~/.forge/.forge.toml`).
pub fn config_path() -> PathBuf {
Self::base_path().join(".forge.toml")
}
/// Returns the base directory for all Forge config files.
///
/// Resolution order:
/// 1. `FORGE_CONFIG` environment variable, if set.
/// 2. `~/forge` (legacy path), if that directory exists, so users who have
/// not yet run `forge config migrate` continue to read from their
/// existing directory without disruption.
/// 3. `~/.forge` as the default path.
pub fn base_path() -> PathBuf {
BASE_PATH.clone()
}
fn resolve_base_path() -> PathBuf {
if let Ok(path) = std::env::var("FORGE_CONFIG") {
return PathBuf::from(path);
}
let base = dirs::home_dir().unwrap_or(PathBuf::from("."));
let path = base.join("forge");
// Prefer ~/forge (legacy) when it exists so existing users are not
// disrupted; fall back to ~/.forge as the default.
if path.exists() {
tracing::info!("Using legacy path");
return path;
}
tracing::info!("Using new path");
base.join(".forge")
}
/// Adds the provided TOML string as a config source without touching the
/// filesystem.
pub fn read_toml(mut self, contents: &str) -> Self {
self.builder = self
.builder
.add_source(config::File::from_str(contents, config::FileFormat::Toml));
self
}
/// Adds the embedded default config (`../.forge.toml`) as a source.
pub fn read_defaults(self) -> Self {
let defaults = include_str!("../.forge.toml");
self.read_toml(defaults)
}
/// Adds `FORGE_`-prefixed environment variables as a config source.
pub fn read_env(mut self) -> Self {
self.builder = self.builder.add_source(
config::Environment::with_prefix("FORGE")
.prefix_separator("_")
.separator("__")
.try_parsing(true)
.list_separator(",")
.with_list_parse_key("retry.status_codes")
.with_list_parse_key("http.root_cert_paths"),
);
self
}
/// Builds and deserializes all accumulated sources into a [`ForgeConfig`].
///
/// Triggers `.env` file loading (at most once per process) by walking up
/// the directory tree from the current working directory, with closer
/// directories taking priority.
///
/// # Errors
///
/// Returns an error if the configuration cannot be built or deserialized.
pub fn build(self) -> crate::Result<ForgeConfig> {
*LOAD_DOT_ENV;
let config = self.builder.build()?;
Ok(config.try_deserialize::<ForgeConfig>()?)
}
/// Adds `~/.forge/.forge.toml` as a config source, silently skipping if
/// absent.
pub fn read_global(mut self) -> Self {
let path = Self::config_path();
self.builder = self
.builder
.add_source(config::File::from(path).required(false));
self
}
/// Reads `~/.forge/.config.json` (legacy format) and adds it as a source,
/// silently skipping errors.
pub fn read_legacy(self) -> Self {
let content = LegacyConfig::read(&Self::config_legacy_path());
if let Ok(content) = content {
self.read_toml(&content)
} else {
self
}
}
}
#[cfg(test)]
mod tests {
use std::sync::{Mutex, MutexGuard};
use pretty_assertions::assert_eq;
use super::*;
use crate::ModelConfig;
/// Serializes tests that mutate environment variables to prevent races.
static ENV_MUTEX: Mutex<()> = Mutex::new(());
/// Holds env vars set for a test's duration and removes them on drop, while
/// holding [`ENV_MUTEX`].
struct EnvGuard {
keys: Vec<&'static str>,
_lock: MutexGuard<'static, ()>,
}
impl EnvGuard {
/// Acquires [`ENV_MUTEX`], sets each `(key, value)` pair in the
/// environment, and removes each key in `remove` if present. All
/// set keys are cleaned up on drop.
#[must_use]
fn set(pairs: &[(&'static str, &str)]) -> Self {
Self::set_and_remove(pairs, &[])
}
/// Like [`set`] but also removes the listed keys before the test runs.
#[must_use]
fn set_and_remove(pairs: &[(&'static str, &str)], remove: &[&'static str]) -> Self {
let lock = ENV_MUTEX.lock().unwrap_or_else(|e| e.into_inner());
let keys = pairs.iter().map(|(k, _)| *k).collect();
for key in remove {
unsafe { std::env::remove_var(key) };
}
for (key, value) in pairs {
unsafe { std::env::set_var(key, value) };
}
Self { keys, _lock: lock }
}
}
impl Drop for EnvGuard {
fn drop(&mut self) {
for key in &self.keys {
unsafe { std::env::remove_var(key) };
}
}
}
#[test]
fn test_base_path_uses_forge_config_env_var() {
let _guard = EnvGuard::set(&[("FORGE_CONFIG", "/custom/forge/dir")]);
let actual = ConfigReader::resolve_base_path();
let expected = PathBuf::from("/custom/forge/dir");
assert_eq!(actual, expected);
}
#[test]
fn test_base_path_falls_back_to_home_dir_when_env_var_absent() {
// Hold the env mutex and ensure FORGE_CONFIG is absent so this test
// cannot race with test_base_path_uses_forge_config_env_var.
let _guard = EnvGuard::set_and_remove(&[], &["FORGE_CONFIG"]);
let actual = ConfigReader::resolve_base_path();
// Without FORGE_CONFIG set the path must be either "forge" (legacy,
// preferred when ~/forge exists) or ".forge" (default new path).
let name = actual.file_name().unwrap();
assert!(
name == "forge" || name == ".forge",
"Expected base_path to end with 'forge' or '.forge', got: {:?}",
name
);
}
#[test]
fn test_read_parses_without_error() {
let actual = ConfigReader::default().read_defaults().build();
assert!(actual.is_ok(), "read() failed: {:?}", actual.err());
}
#[test]
fn test_legacy_layer_does_not_overwrite_defaults() {
// Simulate what `read_legacy` does: serialize a ForgeConfig that only
// carries session/commit/suggest (all other fields are None) and layer
// it on top of the embedded defaults. The default values must survive.
let legacy = ForgeConfig {
session: Some(ModelConfig {
provider_id: "anthropic".to_string(),
model_id: "claude-3".to_string(),
}),
..Default::default()
};
let legacy_toml = toml_edit::ser::to_string_pretty(&legacy).unwrap();
let actual = ConfigReader::default()
// Read legacy first and then defaults
.read_toml(&legacy_toml)
.read_defaults()
.build()
.unwrap();
// Session should come from the legacy layer
assert_eq!(
actual.session,
Some(ModelConfig {
provider_id: "anthropic".to_string(),
model_id: "claude-3".to_string(),
})
);
// Default values from .forge.toml must be retained, not reset to zero
assert_eq!(actual.max_parallel_file_reads, 64);
assert_eq!(actual.max_read_lines, 2000);
assert_eq!(actual.tool_timeout_secs, 300);
assert_eq!(actual.max_search_lines, 1000);
assert_eq!(actual.tool_supported, true);
}
#[test]
fn test_read_session_from_env_vars() {
let _guard = EnvGuard::set(&[
("FORGE_SESSION__PROVIDER_ID", "fake-provider"),
("FORGE_SESSION__MODEL_ID", "fake-model"),
]);
let actual = ConfigReader::default()
.read_defaults()
.read_env()
.build()
.unwrap();
let expected = Some(ModelConfig {
provider_id: "fake-provider".to_string(),
model_id: "fake-model".to_string(),
});
assert_eq!(actual.session, expected);
}
#[test]
fn test_use_forge_committer_defaults_to_true() {
let actual = ConfigReader::default().read_defaults().build().unwrap();
assert_eq!(actual.use_forge_committer, true);
}
#[test]
fn test_use_forge_committer_can_be_disabled() {
let toml = "use_forge_committer = false\n";
let actual = ConfigReader::default()
.read_defaults()
.read_toml(toml)
.build()
.unwrap();
assert_eq!(actual.use_forge_committer, false);
}
}
|