dgf1988/codewhale
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

fix(settings): tighten legacy path migration coverage

Browse Source
This commit is contained in:
xyuai
2026-06-04 07:58:01 +08:00
committed by Hunter B
parent f7a602cd20
commit 9e15805f64
1 changed files with 133 additions and 74 deletions
Download Patch File Download Diff File Expand all files Collapse all files
crates/tui/src/settings.rs
+133 -74
View File
@@ -5,7 +5,7 @@
//! TUI-specific preferences (theme, keybinds, font_size) that survive project
//! switches are stored separately in tui.toml. See [`TuiPrefs`].
use std::path::PathBuf;
use std::path::{Path, PathBuf};
use anyhow::{Context, Result};
use serde::{Deserialize, Serialize};
@@ -364,43 +364,40 @@ impl Default for Settings {
}
impl Settings {
/// Get the settings file path
/// Get the canonical settings file path.
///
/// New writes should target `~/.codewhale/settings.toml`. Legacy
/// DeepSeek-branded paths remain readable as fallbacks during load, but we
/// no longer surface them as the primary path in `/config`.
pub fn path() -> Result<PathBuf> {
// Allow tests to override the settings directory via the same env var
// used for config (DEEPSEEK_CONFIG_PATH points at config.toml; the
// settings file lives as a sibling in the same directory).
if let Ok(config_path) = std::env::var("DEEPSEEK_CONFIG_PATH") {
let config_path = config_path.trim();
if !config_path.is_empty() {
let p = expand_path(config_path);
if let Some(parent) = p.parent() {
return Ok(parent.join(SETTINGS_FILE_NAME));
}
}
}
let primary = codewhale_config::codewhale_home()
.ok()
.map(|home| home.join(SETTINGS_FILE_NAME));
let legacy_home = codewhale_config::legacy_deepseek_home()
.ok()
.map(|home| home.join(SETTINGS_FILE_NAME));
let legacy_config_dir =
dirs::config_dir().map(|dir| dir.join("deepseek").join(SETTINGS_FILE_NAME));
resolve_settings_path_from_candidates(primary, legacy_home, legacy_config_dir)
let (primary, _legacy_home, legacy_config_dir) = settings_path_candidates();
primary.or(legacy_config_dir).ok_or_else(|| {
anyhow::anyhow!("Failed to resolve settings path: no config directory found.")
})
}
/// Load settings from disk, or return defaults if not found
pub fn load() -> Result<Self> {
let path = Self::path()?;
let mut settings = if !path.exists() {
let (primary, legacy_home, legacy_config_dir) = settings_path_candidates();
let write_path = primary
.as_ref()
.cloned()
.or_else(|| legacy_config_dir.clone())
.ok_or_else(|| {
anyhow::anyhow!("Failed to resolve settings path: no config directory found.")
})?;
let read_path =
resolve_settings_path_from_candidates(primary, legacy_home, legacy_config_dir)
.unwrap_or_else(|_| write_path.clone());
let mut settings = if !read_path.exists() {
Self::default()
} else {
let content = std::fs::read_to_string(&path)
.with_context(|| format!("Failed to read settings from {}", path.display()))?;
let mut s: Settings = toml::from_str(&content)
.with_context(|| format!("Failed to parse settings from {}", path.display()))?;
let content = std::fs::read_to_string(&read_path)
.with_context(|| format!("Failed to read settings from {}", read_path.display()))?;
let mut s: Settings = toml::from_str(&content).with_context(|| {
format!("Failed to parse settings from {}", read_path.display())
})?;
s.default_mode = normalize_mode(&s.default_mode).to_string();
s.composer_density = normalize_composer_density(&s.composer_density).to_string();
s.transcript_spacing = normalize_transcript_spacing(&s.transcript_spacing).to_string();
@@ -420,6 +417,7 @@ impl Settings {
.and_then(|value| normalize_reasoning_effort_setting(value).ok().flatten());
s
};
migrate_settings_file_to_primary_if_needed(&write_path, &read_path);
settings.apply_env_overrides();
Ok(settings)
}
@@ -427,7 +425,10 @@ impl Settings {
/// Whether the user explicitly persisted an `auto_compact` preference.
/// When absent, callers may choose a model-aware default.
pub fn auto_compact_explicitly_configured() -> bool {
let Ok(path) = Self::path() else {
let (primary, legacy_home, legacy_config_dir) = settings_path_candidates();
let Ok(path) =
resolve_settings_path_from_candidates(primary, legacy_home, legacy_config_dir)
else {
return false;
};
let Ok(content) = std::fs::read_to_string(path) else {
@@ -1014,6 +1015,58 @@ fn resolve_settings_path_from_candidates(
})
}
fn settings_path_candidates() -> (Option<PathBuf>, Option<PathBuf>, Option<PathBuf>) {
// Allow tests to override the settings directory via the same env var
// used for config (DEEPSEEK_CONFIG_PATH points at config.toml; the
// settings file lives as a sibling in the same directory).
if let Ok(config_path) = std::env::var("DEEPSEEK_CONFIG_PATH") {
let config_path = config_path.trim();
if !config_path.is_empty() {
let p = expand_path(config_path);
if let Some(parent) = p.parent() {
return (Some(parent.join(SETTINGS_FILE_NAME)), None, None);
}
}
}
let primary = codewhale_config::codewhale_home()
.ok()
.map(|home| home.join(SETTINGS_FILE_NAME));
let legacy_home = codewhale_config::legacy_deepseek_home()
.ok()
.map(|home| home.join(SETTINGS_FILE_NAME));
let legacy_config_dir =
dirs::config_dir().map(|dir| dir.join("deepseek").join(SETTINGS_FILE_NAME));
(primary, legacy_home, legacy_config_dir)
}
fn migrate_settings_file_to_primary_if_needed(primary: &Path, active_read_path: &Path) {
if primary == active_read_path || primary.exists() || !active_read_path.exists() {
return;
}
let Some(parent) = primary.parent() else {
return;
};
if let Err(err) = std::fs::create_dir_all(parent) {
tracing::warn!(
"failed to create settings migration directory {}: {err}",
parent.display()
);
return;
}
if let Err(err) = std::fs::copy(active_read_path, primary) {
tracing::warn!(
"failed to migrate settings from {} to {}: {err}",
active_read_path.display(),
primary.display()
);
}
}
fn normalize_default_model(value: &str) -> Option<String> {
let trimmed = value.trim();
if trimmed.eq_ignore_ascii_case("auto") {
@@ -2329,69 +2382,75 @@ mod tests {
}
#[test]
fn settings_path_reads_legacy_deepseek_home_when_present() {
fn settings_path_prefers_codewhale_home_even_when_legacy_exists() {
let _g = config_path_test_guard();
let tmp = tempfile::tempdir().expect("tempdir");
let legacy_dir = tmp.path().join(".deepseek");
std::fs::create_dir_all(&legacy_dir).expect("legacy dir");
std::fs::write(legacy_dir.join("settings.toml"), "low_motion = true\n")
.expect("legacy settings");
let _config_override = EnvVarRestore::remove("DEEPSEEK_CONFIG_PATH");
let _codewhale_home = EnvVarRestore::set("CODEWHALE_HOME", tmp.path().join(".codewhale"));
let _home = EnvVarRestore::set("HOME", tmp.path());
let got = Settings::path().expect("settings path");
assert_eq!(got, tmp.path().join(".codewhale").join("settings.toml"));
}
#[test]
fn settings_load_migrates_legacy_deepseek_home_into_codewhale_home() {
let _g = config_path_test_guard();
let tmp = tempfile::tempdir().expect("tempdir");
let primary = tmp.path().join(".codewhale").join("settings.toml");
let legacy_dir = tmp.path().join(".deepseek");
std::fs::create_dir_all(&legacy_dir).expect("legacy dir");
let legacy_home = legacy_dir.join("settings.toml");
std::fs::create_dir_all(&legacy_dir).expect("legacy dir");
std::fs::write(&legacy_home, "low_motion = true\n").expect("legacy settings");
let legacy_config_dir = tmp
.path()
.join("platform-config")
.join("deepseek")
.join("settings.toml");
std::fs::create_dir_all(legacy_config_dir.parent().expect("parent"))
.expect("legacy config dir");
std::fs::write(&legacy_config_dir, "low_motion = false\n")
.expect("platform legacy settings");
let _config_override = EnvVarRestore::remove("DEEPSEEK_CONFIG_PATH");
let _codewhale_home = EnvVarRestore::set("CODEWHALE_HOME", tmp.path().join(".codewhale"));
let _home = EnvVarRestore::set("HOME", tmp.path());
let got = resolve_settings_path_from_candidates(
Some(primary),
Some(legacy_home.clone()),
Some(legacy_config_dir),
)
.expect("settings path");
let loaded = Settings::load().expect("load settings");
assert_eq!(got, legacy_home);
assert!(loaded.low_motion, "legacy settings should still be read");
assert!(
primary.exists(),
"settings load should migrate to primary path"
);
let display = loaded.display(crate::localization::Locale::En);
assert!(
display.contains(&format!("Config file: {}", primary.display())),
"settings display should surface the canonical codewhale path:\n{display}"
);
}
#[test]
fn settings_path_keeps_platform_config_dir_as_last_legacy_fallback() {
fn settings_load_migrates_platform_legacy_fallback_into_codewhale_home() {
let _g = config_path_test_guard();
let tmp = tempfile::tempdir().expect("tempdir");
let primary = tmp.path().join(".codewhale").join("settings.toml");
let legacy_home = tmp.path().join(".deepseek").join("settings.toml");
let legacy_config_dir = tmp
.path()
.join("platform-config")
let _config_override = EnvVarRestore::remove("DEEPSEEK_CONFIG_PATH");
let _codewhale_home = EnvVarRestore::set("CODEWHALE_HOME", tmp.path().join(".codewhale"));
let _home = EnvVarRestore::set("HOME", tmp.path());
let _xdg = EnvVarRestore::set("XDG_CONFIG_HOME", tmp.path().join("platform-config"));
#[cfg(windows)]
let _appdata = EnvVarRestore::set("APPDATA", tmp.path().join("platform-config"));
let legacy_config_dir = dirs::config_dir()
.expect("config dir")
.join("deepseek")
.join("settings.toml");
std::fs::create_dir_all(legacy_config_dir.parent().expect("parent"))
.expect("legacy config dir");
std::fs::write(&legacy_config_dir, "low_motion = true\n").expect("legacy settings");
let got = resolve_settings_path_from_candidates(
Some(primary),
Some(legacy_home),
Some(legacy_config_dir.clone()),
)
.expect("settings path");
let loaded = Settings::load().expect("load settings");
assert_eq!(got, legacy_config_dir);
}
#[test]
fn settings_path_uses_primary_when_platform_config_dir_is_unavailable() {
let _g = config_path_test_guard();
let tmp = tempfile::tempdir().expect("tempdir");
let primary = tmp.path().join(".codewhale").join("settings.toml");
let got = resolve_settings_path_from_candidates(Some(primary.clone()), None, None)
.expect("settings path");
assert_eq!(got, primary);
assert!(loaded.low_motion, "legacy settings should still be read");
assert!(
primary.exists(),
"legacy fallback should be copied into primary"
);
}
#[test]