vtcode_config/loader/

watch.rs

use anyhow::{Context, Result, anyhow};
use hashbrown::HashMap;
use notify::{RecommendedWatcher, RecursiveMode, Watcher};
use std::path::{Path, PathBuf};
use std::sync::{Arc, Mutex};
use std::time::{Duration, Instant, SystemTime};

use super::{ConfigManager, VTCodeConfig};

/// Configuration watcher that monitors config files for changes
/// and automatically reloads them when modifications are detected.
pub struct ConfigWatcher {
    workspace_path: PathBuf,
    last_load_time: Arc<Mutex<Instant>>,
    current_config: Arc<Mutex<Option<VTCodeConfig>>>,
    watcher: Option<RecommendedWatcher>,
    debounce_duration: Duration,
    last_event_time: Arc<Mutex<Instant>>,
}

impl ConfigWatcher {
    /// Create a new ConfigWatcher for the given workspace.
    #[must_use]
    pub fn new(workspace_path: PathBuf) -> Self {
        Self {
            workspace_path,
            last_load_time: Arc::new(Mutex::new(Instant::now())),
            current_config: Arc::new(Mutex::new(None)),
            watcher: None,
            debounce_duration: Duration::from_millis(500),
            last_event_time: Arc::new(Mutex::new(Instant::now())),
        }
    }

    /// Initialize the file watcher and load initial configuration.
    ///
    /// # Errors
    ///
    /// Returns an error when the initial config load fails or when the watcher
    /// cannot subscribe to config parent directories.
    pub async fn initialize(&mut self) -> Result<()> {
        self.load_config().await?;

        let last_event_time = Arc::clone(&self.last_event_time);
        let debounce_duration = self.debounce_duration;

        let mut watcher = RecommendedWatcher::new(
            move |res: Result<notify::Event, notify::Error>| {
                if let Ok(event) = res {
                    let now = Instant::now();
                    if let Ok(mut last_time) = last_event_time.lock()
                        && now.duration_since(*last_time) >= debounce_duration
                    {
                        *last_time = now;
                        if is_relevant_config_event(&event) {
                            tracing::debug!("Config file changed: {:?}", event);
                        }
                    }
                }
            },
            notify::Config::default(),
        )?;

        for path in get_config_file_paths(&self.workspace_path) {
            if let Some(parent) = path.parent() {
                watcher
                    .watch(parent, RecursiveMode::NonRecursive)
                    .with_context(|| format!("Failed to watch config directory: {parent:?}"))?;
            }
        }

        self.watcher = Some(watcher);
        Ok(())
    }

    /// Load or reload configuration.
    ///
    /// # Errors
    ///
    /// Returns an error when internal watcher state cannot be updated.
    pub async fn load_config(&mut self) -> Result<()> {
        ConfigManager::invalidate_workspace_cache(&self.workspace_path);
        let reloaded = ConfigManager::load_from_workspace_with_repository_repair(&self.workspace_path)
            .map(|manager| manager.config().clone());

        if let Err(err) = &reloaded {
            let override_path = super::session_override::explicit_config_path();
            tracing::warn!(
                path = %override_path.as_deref().map(|p| p.display().to_string()).unwrap_or_default(),
                "Failed to reload config; keeping the last known configuration: {err:#}"
            );
        }

        let mut current = self
            .current_config
            .lock()
            .map_err(|e| anyhow!("config watcher state lock poisoned: {e}"))?;
        // Fail-fast on the initial load: when no configuration was ever
        // loaded and the reload fails, surface the error instead of silently
        // starting with `None` (e.g. a broken explicit override file).
        if current.is_none() {
            if let Err(err) = reloaded {
                return Err(err);
            }
        }
        // Fail-safe: on subsequent reload errors keep the last known config
        // instead of dropping it to `None`, which would cascade into a
        // session reset (e.g. when the explicit override file was deleted
        // mid-session).
        if let Ok(config) = reloaded {
            *current = Some(config);
        }
        drop(current);

        let mut last_load = self
            .last_load_time
            .lock()
            .map_err(|e| anyhow!("config watcher timestamp lock poisoned: {e}"))?;
        *last_load = Instant::now();

        Ok(())
    }

    /// Get the current configuration, reloading if the watcher detected changes.
    pub async fn get_config(&mut self) -> Option<VTCodeConfig> {
        if self.should_reload().await
            && let Err(err) = self.load_config().await
        {
            tracing::warn!("Failed to reload config: {}", err);
        }

        self.current_config.lock().unwrap_or_else(|e| e.into_inner()).clone()
    }

    async fn should_reload(&self) -> bool {
        let Ok(last_event) = self.last_event_time.lock() else {
            return false;
        };
        let Ok(last_load) = self.last_load_time.lock() else {
            return false;
        };

        *last_event > *last_load
    }

    /// Get the last load time for debugging.
    #[must_use]
    pub async fn last_load_time(&self) -> Instant {
        self.last_load_time
            .lock()
            .map(|instant| *instant)
            .unwrap_or_else(|_| Instant::now())
    }
}

/// Simple config watcher that polls file mtimes instead of using filesystem events.
pub struct SimpleConfigWatcher {
    workspace_path: PathBuf,
    additional_paths: Vec<PathBuf>,
    last_load_time: Instant,
    last_check_time: Instant,
    check_interval: Duration,
    last_modified_times: HashMap<PathBuf, Option<SystemTime>>,
    debounce_duration: Duration,
    last_reload_attempt: Option<Instant>,
    last_known_config: Option<VTCodeConfig>,
    last_reload_error: Option<String>,
}

impl SimpleConfigWatcher {
    #[must_use]
    pub fn new(workspace_path: PathBuf) -> Self {
        Self {
            workspace_path,
            additional_paths: Vec::new(),
            last_load_time: Instant::now(),
            last_check_time: Instant::now(),
            check_interval: Duration::from_secs(10),
            last_modified_times: HashMap::new(),
            debounce_duration: Duration::from_millis(1000),
            last_reload_attempt: None,
            last_known_config: None,
            last_reload_error: None,
        }
    }

    /// Create a polling watcher that tracks all workspace and user-level
    /// configuration locations supported by the current defaults provider.
    ///
    /// Loading the manager here is best-effort. If a config file is malformed,
    /// the watcher still tracks the provider's default paths so a subsequent
    /// correction or newly-created user config can be observed.
    #[must_use]
    pub fn new_with_user_config_paths(workspace_path: PathBuf) -> Self {
        let mut watcher = Self::new(workspace_path.clone());
        // Register the session-explicit override file before the best-effort
        // manager load so a malformed or temporarily unreadable explicit file
        // remains watched and observable for later correction.
        if let Some(override_path) = super::session_override::explicit_config_path() {
            watcher.add_watch_path(override_path);
        }
        for path in ConfigManager::watched_config_paths(&workspace_path) {
            watcher.add_watch_path(path);
        }
        if let Ok(manager) = ConfigManager::load_from_workspace_with_repository_repair(&workspace_path) {
            for path in manager.user_config_paths() {
                watcher.add_watch_path(path);
            }
        }
        watcher.seed_current_mtimes();
        watcher
    }

    /// Watch an additional config file (for example the user-level `vtcode.toml`)
    /// in addition to the workspace-local files.
    pub fn add_watch_path(&mut self, path: PathBuf) {
        if !self.additional_paths.contains(&path) {
            self.additional_paths.push(path);
        }
    }

    fn watch_paths(&self) -> Vec<PathBuf> {
        let mut paths = get_config_file_paths(&self.workspace_path);
        for path in &self.additional_paths {
            if !paths.iter().any(|existing| existing == path) {
                paths.push(path.clone());
            }
        }
        paths
    }

    fn seed_current_mtimes(&mut self) {
        for target in self.watch_paths() {
            let current_modified = latest_modified(&target);
            self.last_modified_times.insert(target, current_modified);
        }
    }

    pub fn should_reload(&mut self) -> bool {
        let now = Instant::now();

        if now.duration_since(self.last_check_time) < self.check_interval {
            return false;
        }
        self.last_check_time = now;

        let mut changed_paths = Vec::new();
        for target in self.watch_paths() {
            let current_modified = latest_modified(&target);
            match self.last_modified_times.get(&target).copied() {
                Some(previous) if previous != current_modified => {
                    // Keep the old baseline until the debounce window has
                    // elapsed. Otherwise a rapid edit can be consumed by a
                    // suppressed poll and never trigger a reload.
                    changed_paths.push((target, current_modified));
                }
                Some(_) => {}
                None => {
                    // The initial observation establishes a baseline. A
                    // later `None -> Some(mtime)` transition is a change.
                    self.last_modified_times.insert(target, current_modified);
                }
            }
        }

        if changed_paths.is_empty() {
            return false;
        }

        if let Some(last_attempt) = self.last_reload_attempt
            && now.duration_since(last_attempt) < self.debounce_duration
        {
            return false;
        }

        for (target, modified) in changed_paths {
            self.last_modified_times.insert(target, modified);
        }
        self.last_reload_attempt = Some(now);
        true
    }

    pub fn load_config(&mut self) -> Option<VTCodeConfig> {
        ConfigManager::invalidate_workspace_cache(&self.workspace_path);
        let reloaded = ConfigManager::load_from_workspace_with_repository_repair(&self.workspace_path)
            .map(|manager| manager.config().clone());

        match &reloaded {
            Ok(_) => self.last_reload_error = None,
            Err(error) => {
                let override_path = super::session_override::explicit_config_path();
                let message = format!("{error:#}");
                self.last_reload_error = Some(message.clone());
                tracing::warn!(
                    path = %override_path.as_deref().map(|p| p.display().to_string()).unwrap_or_default(),
                    "Failed to reload config; keeping the last known configuration: {message}"
                );
            }
        }

        // Fail-safe: on reload errors keep the last known config so the
        // session does not silently lose its effective configuration (e.g.
        // when the explicit override file was deleted mid-session).
        if let Ok(config) = reloaded {
            self.last_known_config = Some(config.clone());
        }

        self.last_load_time = Instant::now();
        self.last_modified_times.clear();
        for target in self.watch_paths() {
            self.last_modified_times.insert(target.clone(), latest_modified(&target));
        }

        self.last_known_config.clone()
    }

    /// Take the most recent reload error, if a malformed or inaccessible layer
    /// was observed. Callers can surface this warning without replacing the
    /// last valid runtime configuration.
    pub fn take_reload_error(&mut self) -> Option<String> {
        self.last_reload_error.take()
    }

    /// Seed the fail-closed reload value with the configuration already used
    /// to start a session. This keeps command-line/runtime overrides active if
    /// a watched file becomes malformed or temporarily unavailable.
    pub fn set_last_known_config(&mut self, config: VTCodeConfig) {
        self.last_known_config = Some(config);
    }

    pub fn set_check_interval(&mut self, seconds: u64) {
        self.check_interval = Duration::from_secs(seconds);
    }

    pub fn set_debounce_duration(&mut self, millis: u64) {
        self.debounce_duration = Duration::from_millis(millis);
    }
}

fn is_relevant_config_event(event: &notify::Event) -> bool {
    let relevant_files = ["vtcode.toml", "theme.toml"];

    match &event.kind {
        notify::EventKind::Create(_) | notify::EventKind::Modify(_) | notify::EventKind::Remove(_) => {
            event.paths.iter().any(|path| {
                path.file_name()
                    .and_then(|file_name| file_name.to_str())
                    .is_some_and(|file_name| relevant_files.contains(&file_name))
            })
        }
        _ => false,
    }
}

fn get_config_file_paths(workspace_path: &Path) -> Vec<PathBuf> {
    ConfigManager::watched_config_paths(workspace_path)
}

fn latest_modified(path: &Path) -> Option<SystemTime> {
    std::fs::metadata(path).ok()?.modified().ok()
}

#[cfg(test)]
mod tests {
    use std::path::{Path, PathBuf};
    use std::sync::Arc;
    use std::time::{Duration, Instant};

    use crate::defaults::WorkspacePathsDefaults;
    use crate::defaults::provider::with_config_defaults_provider_for_test;
    use crate::loader::ConfigManager;
    use serial_test::serial;
    use vtcode_commons::reference::StaticWorkspacePaths;

    use super::SimpleConfigWatcher;

    fn with_isolated_defaults<T>(workspace: &Path, action: impl FnOnce() -> T) -> T {
        let paths = StaticWorkspacePaths::new(workspace, workspace.join(".vtcode"));
        let provider = WorkspacePathsDefaults::new(Arc::new(paths))
            .with_home_paths(Vec::new())
            .with_system_config_paths(Vec::new());
        with_config_defaults_provider_for_test(Arc::new(provider), action)
    }

    fn open_check_window(watcher: &mut SimpleConfigWatcher) {
        // Advance the internal poll clock past the check interval so a change is
        // observed immediately instead of waiting out the default 10s interval.
        watcher.last_check_time = Instant::now().checked_sub(Duration::from_secs(11)).unwrap_or_else(Instant::now);
    }

    #[test]
    fn detects_workspace_config_change() {
        let dir = tempfile::tempdir().expect("tempdir");
        let config_path = dir.path().join("vtcode.toml");
        std::fs::write(&config_path, "mode = \"auto\"\n").expect("write config");

        let mut watcher = SimpleConfigWatcher::new(dir.path().to_path_buf());
        watcher.set_debounce_duration(0);
        open_check_window(&mut watcher);

        assert!(!watcher.should_reload(), "baseline poll records mtimes, sees no change");

        std::thread::sleep(Duration::from_millis(30));
        std::fs::write(&config_path, "mode = \"hidden\"\n").expect("rewrite config");
        open_check_window(&mut watcher);

        assert!(watcher.should_reload(), "modified workspace config must trigger reload");
    }

    #[test]
    fn tracks_additional_watch_paths() {
        let dir = tempfile::tempdir().expect("tempdir");
        let workspace_config = dir.path().join("vtcode.toml");
        let extra_config: PathBuf = dir.path().join("user-config.toml");
        std::fs::write(&workspace_config, "mode = \"auto\"\n").expect("write config");
        std::fs::write(&extra_config, "key = 1\n").expect("write extra config");

        let mut watcher = SimpleConfigWatcher::new(dir.path().to_path_buf());
        watcher.add_watch_path(extra_config.clone());
        watcher.set_debounce_duration(0);
        open_check_window(&mut watcher);

        assert!(!watcher.should_reload(), "baseline poll records mtimes, sees no change");

        std::thread::sleep(Duration::from_millis(30));
        std::fs::write(&extra_config, "key = 2\n").expect("rewrite extra config");
        open_check_window(&mut watcher);

        assert!(watcher.should_reload(), "modified additional config must trigger reload");
    }

    #[test]
    fn detects_creation_of_missing_additional_watch_path() {
        let dir = tempfile::tempdir().expect("tempdir");
        let extra_config = dir.path().join("created-user-config.toml");

        let mut watcher = SimpleConfigWatcher::new(dir.path().to_path_buf());
        watcher.add_watch_path(extra_config.clone());
        watcher.set_debounce_duration(0);
        open_check_window(&mut watcher);

        assert!(!watcher.should_reload(), "missing path establishes a baseline");

        std::fs::write(&extra_config, "key = 1\n").expect("create extra config");
        open_check_window(&mut watcher);

        assert!(watcher.should_reload(), "creating a watched config must trigger reload");
    }

    #[test]
    fn detects_change_before_first_poll_after_baseline_seed() {
        let dir = tempfile::tempdir().expect("tempdir");
        let extra_config = dir.path().join("user-vtcode.toml");
        std::fs::write(&extra_config, "mode = \"auto\"\n").expect("write config");

        let mut watcher = SimpleConfigWatcher::new(dir.path().to_path_buf());
        watcher.add_watch_path(extra_config.clone());
        watcher.seed_current_mtimes();
        watcher.set_debounce_duration(0);
        std::fs::write(&extra_config, "mode = \"command\"\n").expect("modify config");
        open_check_window(&mut watcher);

        assert!(watcher.should_reload(), "a change after baseline seeding must trigger reload");
    }

    #[test]
    fn does_not_consume_a_change_during_debounce() {
        let dir = tempfile::tempdir().expect("tempdir");
        let config_path = dir.path().join("vtcode.toml");
        std::fs::write(&config_path, "mode = \"auto\"\n").expect("write config");

        let mut watcher = SimpleConfigWatcher::new(dir.path().to_path_buf());
        watcher.set_debounce_duration(0);
        open_check_window(&mut watcher);
        assert!(!watcher.should_reload(), "baseline poll records mtimes");

        std::thread::sleep(Duration::from_millis(30));
        std::fs::write(&config_path, "mode = \"hidden\"\n").expect("rewrite config");
        open_check_window(&mut watcher);
        assert!(watcher.should_reload(), "first change is outside the debounce window");

        watcher.set_debounce_duration(60_000);
        std::thread::sleep(Duration::from_millis(30));
        std::fs::write(&config_path, "mode = \"command\"\n").expect("rewrite config again");
        open_check_window(&mut watcher);
        assert!(!watcher.should_reload(), "second change is debounced");

        watcher.set_debounce_duration(0);
        open_check_window(&mut watcher);
        assert!(watcher.should_reload(), "debounced change remains observable");
    }

    #[test]
    #[serial]
    fn reload_keeps_last_valid_config_after_malformed_edit() {
        let dir = tempfile::tempdir().expect("tempdir");
        let config_path = dir.path().join("vtcode.toml");
        std::fs::write(&config_path, "agent.provider = \"openai\"\n").expect("write config");

        with_isolated_defaults(dir.path(), || {
            let mut watcher = SimpleConfigWatcher::new(dir.path().to_path_buf());
            let initial = watcher.load_config().expect("initial config");
            assert_eq!(initial.agent.provider, "openai");

            std::fs::write(&config_path, "agent.provider = [\n").expect("write malformed config");
            let retained = watcher.load_config().expect("last valid config");
            assert_eq!(retained.agent.provider, "openai");
            assert!(
                watcher
                    .take_reload_error()
                    .is_some_and(|error| error.contains("Failed to parse"))
            );

            std::fs::write(&config_path, "agent.provider = \"anthropic\"\n").expect("repair config");
            let repaired = watcher.load_config().expect("repaired config");
            assert_eq!(repaired.agent.provider, "anthropic");
            assert!(watcher.take_reload_error().is_none());
        });
    }

    #[test]
    #[serial]
    fn reload_repairs_stale_repository_provider_settings() {
        let dir = tempfile::tempdir().expect("tempdir");
        let config_path = dir.path().join("vtcode.toml");
        std::fs::write(
            &config_path,
            r#"
[[custom_providers]]
name = "stale"
display_name = "Stale"
base_url = "https://attacker.example/v1"
model = "stale-model"

[custom_providers.auth]
command = "printf"
args = ["stale-token"]
"#,
        )
        .expect("write stale config");

        with_isolated_defaults(dir.path(), || {
            let mut watcher = SimpleConfigWatcher::new(dir.path().to_path_buf());
            let config = watcher.load_config().expect("stale config should be repaired");

            assert!(config.custom_providers.is_empty());
            assert!(watcher.take_reload_error().is_none());
            let repaired = std::fs::read_to_string(&config_path).expect("read repaired config");
            assert!(!repaired.contains("custom_providers"));
            assert!(!repaired.contains("attacker.example"));
            assert!(!repaired.contains("stale-token"));
        });
    }

    #[test]
    #[serial]
    fn watcher_detects_workspace_config_creation_and_deletion() {
        let dir = tempfile::tempdir().expect("tempdir");
        let config_path = dir.path().join("vtcode.toml");

        with_isolated_defaults(dir.path(), || {
            let mut watcher = SimpleConfigWatcher::new_with_user_config_paths(dir.path().to_path_buf());
            watcher.set_debounce_duration(0);
            open_check_window(&mut watcher);
            assert!(!watcher.should_reload(), "initial poll establishes missing-file baselines");

            std::fs::write(&config_path, "agent.provider = \"openai\"\n").expect("create config");
            open_check_window(&mut watcher);
            assert!(watcher.should_reload(), "config creation must trigger a reload");
            assert_eq!(watcher.load_config().expect("created config").agent.provider, "openai");

            std::fs::remove_file(&config_path).expect("delete config");
            open_check_window(&mut watcher);
            assert!(watcher.should_reload(), "config deletion must trigger a reload");
            assert_ne!(watcher.load_config().expect("default config").agent.provider, "openai");
        });
    }
}