Skip to main content

reflex/
watcher.rs

1//! File system watcher for automatic reindexing
2//!
3//! The watcher monitors the workspace for file changes and automatically
4//! triggers incremental reindexing with configurable debouncing.
5
6use anyhow::{Context, Result};
7use notify::{Config, Event, EventKind, RecommendedWatcher, RecursiveMode, Watcher};
8use std::collections::HashSet;
9use std::path::{Path, PathBuf};
10use std::sync::mpsc::{RecvTimeoutError, channel};
11use std::time::{Duration, Instant};
12
13use crate::indexer::Indexer;
14use crate::models::Language;
15use crate::output;
16
17/// Configuration for file watching
18#[derive(Debug, Clone)]
19pub struct WatchConfig {
20    /// Debounce duration in milliseconds
21    /// Waits this long after the last change before triggering reindex
22    pub debounce_ms: u64,
23    /// Suppress output (only log errors)
24    pub quiet: bool,
25}
26
27impl Default for WatchConfig {
28    fn default() -> Self {
29        Self {
30            debounce_ms: 15000, // 15 seconds
31            quiet: false,
32        }
33    }
34}
35
36/// Watch a directory for file changes and auto-reindex
37///
38/// This function blocks until interrupted (Ctrl+C).
39///
40/// # Algorithm
41///
42/// 1. Set up file system watcher using notify crate
43/// 2. Collect file change events into a HashSet (deduplicate)
44/// 3. Wait for debounce period after last change
45/// 4. Trigger incremental reindex (only changed files)
46/// 5. Repeat
47///
48/// # Debouncing
49///
50/// The debounce timer resets on every file change event. This batches
51/// rapid changes (e.g., multi-file refactors, format-on-save) into a
52/// single reindex operation.
53///
54/// Example timeline:
55/// ```text
56/// t=0s:  File A changed  [timer starts]
57/// t=2s:  File B changed  [timer resets]
58/// t=5s:  File C changed  [timer resets]
59/// t=20s: Timer expires    [reindex A, B, C]
60/// ```
61pub fn watch(path: &Path, indexer: Indexer, config: WatchConfig) -> Result<()> {
62    log::info!(
63        "Starting file watcher for {:?} with {}ms debounce",
64        path,
65        config.debounce_ms
66    );
67
68    // Setup channel for receiving file system events
69    let (tx, rx) = channel();
70
71    // Create watcher with default config
72    let mut watcher =
73        RecommendedWatcher::new(tx, Config::default()).context("Failed to create file watcher")?;
74
75    // Start watching the directory recursively
76    watcher
77        .watch(path, RecursiveMode::Recursive)
78        .context("Failed to start watching directory")?;
79
80    if !config.quiet {
81        println!(
82            "Watching for changes (debounce: {}s)...",
83            config.debounce_ms / 1000
84        );
85    }
86
87    // Track pending file changes
88    let mut pending_files: HashSet<PathBuf> = HashSet::new();
89    // Deleted file paths that need to be removed from the index.
90    // Tracked separately because the file no longer exists on disk and
91    // should_watch_file() cannot reliably inspect it.
92    let mut pending_deletions: HashSet<PathBuf> = HashSet::new();
93    let mut last_event_time: Option<Instant> = None;
94    let debounce_duration = Duration::from_millis(config.debounce_ms);
95
96    // Event loop
97    loop {
98        // Try to receive events with 100ms timeout (allows checking debounce timer)
99        match rx.recv_timeout(Duration::from_millis(100)) {
100            Ok(Ok(event)) => {
101                // Process the file system event
102                if let Some((changed_path, is_removal)) = process_event_typed(&event) {
103                    if is_removal {
104                        // File is gone — we can no longer call should_watch_file() on it,
105                        // but we must still reindex so the deleted entry is removed.
106                        // Accept any path whose extension suggests a code file OR has no
107                        // extension at all (e.g. a deleted directory triggers a broad Remove).
108                        let ext = changed_path
109                            .extension()
110                            .and_then(|e| e.to_str())
111                            .unwrap_or("");
112                        let is_code = ext.is_empty()
113                            || crate::models::Language::from_extension(ext).is_supported();
114                        if is_code {
115                            log::debug!("Detected removal: {:?}", changed_path);
116                            pending_deletions.insert(changed_path);
117                            last_event_time = Some(Instant::now());
118                        }
119                    } else if should_watch_file(&changed_path) {
120                        log::debug!("Detected change: {:?}", changed_path);
121                        pending_files.insert(changed_path);
122                        last_event_time = Some(Instant::now());
123                    }
124                }
125            }
126            Ok(Err(e)) => {
127                log::warn!("Watch error: {}", e);
128            }
129            Err(RecvTimeoutError::Timeout) => {
130                // Check if debounce period has elapsed
131                let has_pending = !pending_files.is_empty() || !pending_deletions.is_empty();
132                if let Some(last_time) = last_event_time {
133                    if has_pending && last_time.elapsed() >= debounce_duration {
134                        // Trigger reindex
135                        let total_changes = pending_files.len() + pending_deletions.len();
136                        if !config.quiet {
137                            if pending_deletions.is_empty() {
138                                println!(
139                                    "\nDetected {} changed file(s), reindexing...",
140                                    pending_files.len()
141                                );
142                            } else {
143                                println!(
144                                    "\nDetected {} change(s) ({} deleted), reindexing...",
145                                    total_changes,
146                                    pending_deletions.len()
147                                );
148                            }
149                        }
150
151                        let start = Instant::now();
152                        match indexer.index(path, false) {
153                            Ok(stats) => {
154                                let elapsed = start.elapsed();
155                                if !config.quiet {
156                                    println!(
157                                        "✓ Reindexed {} files in {:.1}ms\n",
158                                        stats.total_files,
159                                        elapsed.as_secs_f64() * 1000.0
160                                    );
161                                }
162                                log::info!(
163                                    "Reindexed {} files in {:?}",
164                                    stats.total_files,
165                                    elapsed
166                                );
167                            }
168                            Err(e) => {
169                                output::error(&format!("✗ Reindex failed: {}", e));
170                                log::error!("Reindex failed: {}", e);
171                            }
172                        }
173
174                        // Clear pending changes
175                        pending_files.clear();
176                        pending_deletions.clear();
177                        last_event_time = None;
178                    }
179                }
180            }
181            Err(RecvTimeoutError::Disconnected) => {
182                log::info!("Watcher channel disconnected, stopping...");
183                break;
184            }
185        }
186    }
187
188    if !config.quiet {
189        println!("Watcher stopped.");
190    }
191
192    Ok(())
193}
194
195/// Process a file system event and extract the changed path together with a
196/// flag indicating whether this is a deletion (Remove) event.
197///
198/// Returns `Some((path, is_removal))`, or `None` for events that should be
199/// ignored (metadata-only changes, etc.).
200fn process_event_typed(event: &Event) -> Option<(PathBuf, bool)> {
201    match event.kind {
202        EventKind::Remove(_) => event.paths.first().cloned().map(|p| (p, true)),
203        EventKind::Create(_) | EventKind::Modify(_) => {
204            event.paths.first().cloned().map(|p| (p, false))
205        }
206        _ => None,
207    }
208}
209
210/// Process a file system event and extract the changed path
211///
212/// Returns None if the event should be ignored (e.g., metadata changes, directory events)
213fn process_event(event: &Event) -> Option<PathBuf> {
214    process_event_typed(event).map(|(p, _)| p)
215}
216
217/// Check if a file should trigger a reindex
218///
219/// Returns true if the file has a supported language extension
220fn should_watch_file(path: &Path) -> bool {
221    // Skip hidden files and directories
222    if let Some(file_name) = path.file_name() {
223        if file_name.to_string_lossy().starts_with('.') {
224            return false;
225        }
226    }
227
228    // Skip directories
229    if path.is_dir() {
230        return false;
231    }
232
233    // Check if file extension is supported
234    if let Some(ext) = path.extension() {
235        let ext_str = ext.to_string_lossy();
236        let lang = Language::from_extension(&ext_str);
237        return lang.is_supported();
238    }
239
240    false
241}
242
243#[cfg(test)]
244mod tests {
245    use super::*;
246    use std::fs;
247    use tempfile::TempDir;
248
249    #[test]
250    fn test_should_watch_rust_file() {
251        let temp = TempDir::new().unwrap();
252        let rust_file = temp.path().join("test.rs");
253        fs::write(&rust_file, "fn main() {}").unwrap();
254
255        assert!(should_watch_file(&rust_file));
256    }
257
258    #[test]
259    fn test_should_not_watch_unsupported_file() {
260        let temp = TempDir::new().unwrap();
261        let txt_file = temp.path().join("test.txt");
262        fs::write(&txt_file, "plain text").unwrap();
263
264        assert!(!should_watch_file(&txt_file));
265    }
266
267    #[test]
268    fn test_should_not_watch_hidden_file() {
269        let temp = TempDir::new().unwrap();
270        let hidden_file = temp.path().join(".hidden.rs");
271        fs::write(&hidden_file, "fn main() {}").unwrap();
272
273        assert!(!should_watch_file(&hidden_file));
274    }
275
276    #[test]
277    fn test_should_not_watch_directory() {
278        let temp = TempDir::new().unwrap();
279        let dir = temp.path().join("src");
280        fs::create_dir(&dir).unwrap();
281
282        assert!(!should_watch_file(&dir));
283    }
284
285    #[test]
286    fn test_watch_config_default() {
287        let config = WatchConfig::default();
288        assert_eq!(config.debounce_ms, 15000);
289        assert!(!config.quiet);
290    }
291
292    #[test]
293    fn test_process_event_create() {
294        let event = Event {
295            kind: EventKind::Create(notify::event::CreateKind::File),
296            paths: vec![PathBuf::from("/test/file.rs")],
297            attrs: Default::default(),
298        };
299
300        let path = process_event(&event);
301        assert!(path.is_some());
302        assert_eq!(path.unwrap(), PathBuf::from("/test/file.rs"));
303    }
304
305    #[test]
306    fn test_process_event_modify() {
307        let event = Event {
308            kind: EventKind::Modify(notify::event::ModifyKind::Data(
309                notify::event::DataChange::Any,
310            )),
311            paths: vec![PathBuf::from("/test/file.rs")],
312            attrs: Default::default(),
313        };
314
315        let path = process_event(&event);
316        assert!(path.is_some());
317        assert_eq!(path.unwrap(), PathBuf::from("/test/file.rs"));
318    }
319
320    #[test]
321    fn test_process_event_access_ignored() {
322        let event = Event {
323            kind: EventKind::Access(notify::event::AccessKind::Read),
324            paths: vec![PathBuf::from("/test/file.rs")],
325            attrs: Default::default(),
326        };
327
328        let path = process_event(&event);
329        assert!(path.is_none());
330    }
331}