Skip to content

armgit / zed

Public Imported from GitHub
0

Code at the speed of thought – Zed is a high-performance, multiplayer code editor from the creators of Atom and Tree-sitter.

file_finder: Debounce file finder refreshes on worktree updates (#60451)

Bing Wang2fd6e237787f
diff --git a/crates/file_finder/src/file_finder.rs b/crates/file_finder/src/file_finder.rs
index a9bdd7288d1..d37a419b127 100644
--- a/crates/file_finder/src/file_finder.rs
+++ b/crates/file_finder/src/file_finder.rs
@@ -31,7 +31,7 @@ use project_panel::project_panel_settings::ProjectPanelSettings;
use settings::Settings;
use std::{
borrow::Cow,
- cmp,
+ cmp, mem,
ops::{Range, RangeInclusive},
path::{Component, Path, PathBuf},
sync::{
@@ -387,6 +387,7 @@ pub struct FileFinderDelegate {
focus_handle: FocusHandle,
include_ignored: Option<bool>,
include_ignored_refresh: Task<()>,
+ debounce_next_refresh: bool,
}
/// Use a custom ordering for file finder: the regular one
@@ -845,6 +846,7 @@ impl FoundPath {
const MAX_RECENT_SELECTIONS: usize = 20;
const SEARCH_DEBOUNCE: Duration = Duration::from_millis(100);
+const WORKTREE_UPDATE_REFRESH_DEBOUNCE: Duration = Duration::from_millis(200);
pub enum Event {
Selected(ProjectPath),
@@ -994,6 +996,7 @@ impl FileFinderDelegate {
focus_handle: cx.focus_handle(),
include_ignored: include_ignored.or(FileFinderSettings::get_global(cx).include_ignored),
include_ignored_refresh: Task::ready(()),
+ debounce_next_refresh: false,
}
}
@@ -1004,11 +1007,17 @@ impl FileFinderDelegate {
) {
cx.subscribe_in(project, window, |file_finder, _, event, window, cx| {
match event {
- project::Event::WorktreeUpdatedEntries(_, _)
- | project::Event::WorktreeAdded(_)
- | project::Event::WorktreeRemoved(_) => file_finder
- .picker
- .update(cx, |picker, cx| picker.refresh(window, cx)),
+ project::Event::WorktreeUpdatedEntries(_, _) => {
+ file_finder.picker.update(cx, |picker, cx| {
+ picker.delegate.debounce_next_refresh = true;
+ picker.refresh(window, cx);
+ })
+ }
+ project::Event::WorktreeAdded(_) | project::Event::WorktreeRemoved(_) => {
+ file_finder
+ .picker
+ .update(cx, |picker, cx| picker.refresh(window, cx))
+ }
_ => {}
};
})
@@ -1842,6 +1851,7 @@ impl PickerDelegate for FileFinderDelegate {
window: &mut Window,
cx: &mut Context<Picker<Self>>,
) -> Task<()> {
+ let debounce_refresh = mem::take(&mut self.debounce_next_refresh);
let raw_query = raw_query.trim();
let raw_query = match &raw_query.get(0..2) {
@@ -1915,7 +1925,11 @@ impl PickerDelegate for FileFinderDelegate {
let was_in_flight = search_in_flight.swap(true, atomic::Ordering::Relaxed);
cx.spawn_in(window, async move |this, cx| {
- if was_in_flight {
+ if debounce_refresh {
+ cx.background_executor()
+ .timer(WORKTREE_UPDATE_REFRESH_DEBOUNCE)
+ .await;
+ } else if was_in_flight {
cx.background_executor().timer(SEARCH_DEBOUNCE).await;
}
let _ = maybe!(async move {
diff --git a/crates/file_finder/src/file_finder_tests.rs b/crates/file_finder/src/file_finder_tests.rs
index ec49c8a373e..2c6df4b1e5b 100644
--- a/crates/file_finder/src/file_finder_tests.rs
+++ b/crates/file_finder/src/file_finder_tests.rs
@@ -3347,7 +3347,7 @@ async fn test_selected_history_item_stays_selected_on_worktree_updated(cx: &mut
.expect("unable to create file");
}
- cx.executor().advance_clock(FS_WATCH_LATENCY);
+ advance_worktree_update_refresh(cx);
picker.update(cx, |finder, _| {
assert_eq!(finder.delegate.matches.len(), 3);
@@ -3516,7 +3516,7 @@ async fn test_search_results_refreshed_on_worktree_updates(cx: &mut gpui::TestAp
.remove_file("/src/main.rs".as_ref(), Default::default())
.await
.expect("unable to remove file");
- cx.executor().advance_clock(FS_WATCH_LATENCY);
+ advance_worktree_update_refresh(cx);
// main.rs is in not among search results anymore
picker.update(cx, |finder, _| {
@@ -3531,7 +3531,7 @@ async fn test_search_results_refreshed_on_worktree_updates(cx: &mut gpui::TestAp
.create_file("/src/util.rs".as_ref(), Default::default())
.await
.expect("unable to create file");
- cx.executor().advance_clock(FS_WATCH_LATENCY);
+ advance_worktree_update_refresh(cx);
// util.rs is among search results
picker.update(cx, |finder, _| {
@@ -3542,6 +3542,51 @@ async fn test_search_results_refreshed_on_worktree_updates(cx: &mut gpui::TestAp
});
}
+#[gpui::test]
+async fn test_worktree_entry_updates_are_coalesced(cx: &mut gpui::TestAppContext) {
+ let app_state = init_test(cx);
+
+ app_state
+ .fs
+ .as_fake()
+ .insert_tree(
+ "/src",
+ json!({
+ "lib.rs": "// Lib file",
+ }),
+ )
+ .await;
+
+ let project = Project::test(app_state.fs.clone(), ["/src".as_ref()], cx).await;
+ let (picker, _, cx) = build_find_picker(project, cx);
+
+ simulate_input(cx, "rs");
+ let initial_search_count = picker.read_with(cx, |picker, _| picker.delegate.search_count);
+
+ for filename in ["one.rs", "two.rs", "three.rs"] {
+ app_state
+ .fs
+ .create_file(Path::new(&format!("/src/{filename}")), Default::default())
+ .await
+ .expect("unable to create file");
+ cx.executor().advance_clock(FS_WATCH_LATENCY);
+ cx.run_until_parked();
+ }
+
+ cx.executor()
+ .advance_clock(WORKTREE_UPDATE_REFRESH_DEBOUNCE);
+ cx.run_until_parked();
+
+ picker.update(cx, |picker, _| {
+ assert_eq!(
+ picker.delegate.search_count,
+ initial_search_count + 1,
+ "bursty worktree entry updates should be coalesced into one search refresh"
+ );
+ assert_eq!(picker.delegate.matches.len(), 5);
+ });
+}
+
#[gpui::test]
async fn test_search_results_refreshed_on_standalone_file_creation(cx: &mut gpui::TestAppContext) {
let app_state = init_test(cx);
@@ -3688,7 +3733,7 @@ async fn test_search_results_refreshed_on_adding_and_removing_worktrees(
})
.await
.expect("unable to create workdir");
- cx.executor().advance_clock(FS_WATCH_LATENCY);
+ advance_worktree_update_refresh(cx);
// main.rs is among search results
picker.update(cx, |finder, _| {
@@ -3918,11 +3963,15 @@ async fn test_selected_match_stays_selected_after_matches_refreshed(cx: &mut gpu
.create_file(Path::new(&filename), Default::default())
.await
.expect("unable to create file");
- // Wait for each file system event to be fully processed before adding the next
+ // Wait for each file system event to be observed before adding the next.
cx.executor().advance_clock(FS_WATCH_LATENCY);
cx.run_until_parked();
}
+ cx.executor()
+ .advance_clock(WORKTREE_UPDATE_REFRESH_DEBOUNCE);
+ cx.run_until_parked();
+
// file_13.txt is still selected
picker.update(cx, |finder, _| {
let expected_selected_index = selected_index + files_to_add;
@@ -3966,7 +4015,7 @@ async fn test_first_match_selected_if_previous_one_is_not_in_the_match_list(
.remove_file("/src/file_2.txt".as_ref(), Default::default())
.await
.expect("unable to remove file");
- cx.executor().advance_clock(FS_WATCH_LATENCY);
+ advance_worktree_update_refresh(cx);
// file_1.txt is now selected
picker.update(cx, |finder, _| {
@@ -4571,6 +4620,12 @@ fn simulate_input(cx: &mut VisualTestContext, input: &str) {
cx.run_until_parked();
}
+fn advance_worktree_update_refresh(cx: &mut VisualTestContext) {
+ cx.executor()
+ .advance_clock(FS_WATCH_LATENCY + WORKTREE_UPDATE_REFRESH_DEBOUNCE);
+ cx.run_until_parked();
+}
+
#[track_caller]
pub(crate) fn active_file_picker(
workspace: &Entity<Workspace>,