Code at the speed of thought – Zed is a high-performance, multiplayer code editor from the creators of Atom and Tree-sitter.
Add some more logging to diagnose lost FS events and stale git state (#57173)
Cole Miller57a64fc824db
diff --git a/crates/fs/src/fs.rs b/crates/fs/src/fs.rsindex 2d716f8e519..eed246b37ae 100644--- a/crates/fs/src/fs.rs+++ b/crates/fs/src/fs.rs@@ -1257,6 +1257,7 @@ impl Fs for RealFs {async move {executor.timer(latency).await;let paths = std::mem::take(&mut *pending_paths.lock());+ log::debug!("pending path events: {:?}", paths);(!paths.is_empty()).then_some(paths)}}diff --git a/crates/fs/src/fs_watcher.rs b/crates/fs/src/fs_watcher.rsindex ef676e9ed02..85d1e164c0b 100644--- a/crates/fs/src/fs_watcher.rs+++ b/crates/fs/src/fs_watcher.rs@@ -164,7 +164,7 @@ fn push_notify_event(kind: Some(PathEventKind::Rescan),});}-+ log::trace!("path_events: {:?}", path_events);enqueue_path_events(tx, pending_path_events, path_events);}diff --git a/crates/project/src/git_store.rs b/crates/project/src/git_store.rsindex 9f97f829b0c..ee6063c0e4e 100644--- a/crates/project/src/git_store.rs+++ b/crates/project/src/git_store.rs@@ -1498,6 +1498,7 @@ impl GitStore {else {return;};+ log::debug!("received worktree update for repositories: {changed_repos:?}");self.update_repositories_from_worktree(*worktree_id,project_environment.clone(),diff --git a/crates/worktree/src/worktree.rs b/crates/worktree/src/worktree.rsindex a21ea8f639e..f1dfaec5c85 100644--- a/crates/worktree/src/worktree.rs+++ b/crates/worktree/src/worktree.rs@@ -8,7 +8,8 @@ use clock::ReplicaId;use collections::{HashMap, HashSet, VecDeque};use encoding_rs::Encoding;use fs::{- Fs, MTime, PathEvent, RemoveOptions, TrashedEntry, Watcher, copy_recursive, read_dir_items,+ Fs, MTime, PathEvent, PathEventKind, RemoveOptions, TrashedEntry, Watcher, copy_recursive,+ read_dir_items,};use futures::{FutureExt as _, Stream, StreamExt,@@ -4374,6 +4375,8 @@ impl BackgroundScanner {events = Self::normalized_events_for_worktree(&state, &root_canonical_path, events);}+ log::debug!("raw events for process_events: {events:?}");+fn skip_ix(ranges: &mut SmallVec<[Range<usize>; 4]>, ix: usize) {if let Some(last_range) = ranges.last_mut()&& last_range.end == ix@@ -4418,20 +4421,29 @@ impl BackgroundScanner {}if let Some((dot_git_abs_path, path_in_git_dir)) = dot_git_paths {- let skip = skipped_files_in_dot_git.iter().any(|skipped| {+ let is_ignored = skipped_files_in_dot_git.iter().any(|skipped| {OsStr::new(skipped) == path_in_git_dir.as_path().as_os_str()}) || skipped_dirs_in_dot_git.iter()- .any(|skipped_git_subdir| path_in_git_dir.starts_with(skipped_git_subdir))- || path_in_git_dir == Path::new("")- && self.fs.is_dir(&dot_git_abs_path).await;- if skip {+ .any(|skipped_git_subdir| path_in_git_dir.starts_with(skipped_git_subdir));+ let is_dot_git = path_in_git_dir == Path::new("")+ && matches!(event.kind, Some(PathEventKind::Changed))+ && self.fs.is_dir(&dot_git_abs_path).await;+ if is_ignored {log::debug!("ignoring event {abs_path:?} as it's in the .git directory among skipped files or directories");skip_ix(&mut ranges_to_drop, ix);continue;}+ if is_dot_git {+ log::debug!(+ "ignoring event {abs_path:?} for .git directory itself (kind: {:?})",+ event.kind+ );+ skip_ix(&mut ranges_to_drop, ix);+ continue;+ }if !dot_git_abs_paths.contains(&dot_git_abs_path) {dot_git_abs_paths.push(dot_git_abs_path);diff --git a/crates/worktree/tests/integration/main.rs b/crates/worktree/tests/integration/main.rsindex ef5180a7083..f8e07ffa0b4 100644--- a/crates/worktree/tests/integration/main.rs+++ b/crates/worktree/tests/integration/main.rs@@ -3584,6 +3584,34 @@ async fn test_dot_git_dir_event_does_not_suppress_children("should emit UpdatedGitRepositories for a .git/index event");}++ {+ let mut events = cx.events(&worktree);+ fs.pause_events();+ fs.emit_fs_event(dot_git, Some(PathEventKind::Rescan));+ fs.unpause_events_and_flush();+ executor.run_until_parked();++ let got_git_update = drain_git_repo_updates(&mut events);+ assert!(+ got_git_update,+ "should emit UpdatedGitRepositories for a .git rescan event"+ );+ }++ {+ let mut events = cx.events(&worktree);+ fs.pause_events();+ fs.emit_fs_event(project_dir, Some(PathEventKind::Rescan));+ fs.unpause_events_and_flush();+ executor.run_until_parked();++ let got_git_update = drain_git_repo_updates(&mut events);+ assert!(+ got_git_update,+ "should emit UpdatedGitRepositories for a .git rescan event"+ );+ }}fn drain_git_repo_updates(events: &mut futures::channel::mpsc::UnboundedReceiver<Event>) -> bool {