1mod ignore;
2mod worktree_settings;
3#[cfg(test)]
4mod worktree_tests;
5
6use ::ignore::gitignore::{Gitignore, GitignoreBuilder};
7use anyhow::{Context as _, Result, anyhow};
8use clock::ReplicaId;
9use collections::{HashMap, HashSet, VecDeque};
10use fs::{Fs, MTime, PathEvent, RemoveOptions, Watcher, copy_recursive, read_dir_items};
11use futures::{
12 FutureExt as _, Stream, StreamExt,
13 channel::{
14 mpsc::{self, UnboundedSender},
15 oneshot,
16 },
17 select_biased,
18 task::Poll,
19};
20use fuzzy::CharBag;
21use git::{
22 COMMIT_MESSAGE, DOT_GIT, FSMONITOR_DAEMON, GITIGNORE, INDEX_LOCK, LFS_DIR, status::GitSummary,
23};
24use gpui::{
25 App, AppContext as _, AsyncApp, BackgroundExecutor, Context, Entity, EventEmitter, Task,
26};
27use ignore::IgnoreStack;
28use language::DiskState;
29
30use parking_lot::Mutex;
31use paths::{local_settings_folder_name, local_vscode_folder_name};
32use postage::{
33 barrier,
34 prelude::{Sink as _, Stream as _},
35 watch,
36};
37use rpc::{
38 AnyProtoClient,
39 proto::{self, split_worktree_update},
40};
41pub use settings::WorktreeId;
42use settings::{Settings, SettingsLocation, SettingsStore};
43use smallvec::{SmallVec, smallvec};
44use smol::channel::{self, Sender};
45use std::{
46 any::Any,
47 borrow::Borrow as _,
48 cmp::Ordering,
49 collections::hash_map,
50 convert::TryFrom,
51 ffi::OsStr,
52 fmt,
53 future::Future,
54 mem::{self},
55 ops::{Deref, DerefMut},
56 path::{Path, PathBuf},
57 pin::Pin,
58 sync::{
59 Arc,
60 atomic::{AtomicUsize, Ordering::SeqCst},
61 },
62 time::{Duration, Instant},
63};
64use sum_tree::{Bias, Dimensions, Edit, KeyedItem, SeekTarget, SumTree, Summary, TreeMap, TreeSet};
65use text::{LineEnding, Rope};
66use util::{
67 ResultExt, debug_panic, maybe,
68 paths::{PathMatcher, PathStyle, SanitizedPath, home_dir},
69 rel_path::RelPath,
70};
71pub use worktree_settings::WorktreeSettings;
72
73pub const FS_WATCH_LATENCY: Duration = Duration::from_millis(100);
74
75/// A set of local or remote files that are being opened as part of a project.
76/// Responsible for tracking related FS (for local)/collab (for remote) events and corresponding updates.
77/// Stores git repositories data and the diagnostics for the file(s).
78///
79/// Has an absolute path, and may be set to be visible in Zed UI or not.
80/// May correspond to a directory or a single file.
81/// Possible examples:
82/// * a drag and dropped file — may be added as an invisible, "ephemeral" entry to the current worktree
83/// * a directory opened in Zed — may be added as a visible entry to the current worktree
84///
85/// Uses [`Entry`] to track the state of each file/directory, can look up absolute paths for entries.
86pub enum Worktree {
87 Local(LocalWorktree),
88 Remote(RemoteWorktree),
89}
90
91/// An entry, created in the worktree.
92#[derive(Debug)]
93pub enum CreatedEntry {
94 /// Got created and indexed by the worktree, receiving a corresponding entry.
95 Included(Entry),
96 /// Got created, but not indexed due to falling under exclusion filters.
97 Excluded { abs_path: PathBuf },
98}
99
100pub struct LoadedFile {
101 pub file: Arc<File>,
102 pub text: String,
103}
104
105pub struct LoadedBinaryFile {
106 pub file: Arc<File>,
107 pub content: Vec<u8>,
108}
109
110impl fmt::Debug for LoadedBinaryFile {
111 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
112 f.debug_struct("LoadedBinaryFile")
113 .field("file", &self.file)
114 .field("content_bytes", &self.content.len())
115 .finish()
116 }
117}
118
119pub struct LocalWorktree {
120 snapshot: LocalSnapshot,
121 scan_requests_tx: channel::Sender<ScanRequest>,
122 path_prefixes_to_scan_tx: channel::Sender<PathPrefixScanRequest>,
123 is_scanning: (watch::Sender<bool>, watch::Receiver<bool>),
124 _background_scanner_tasks: Vec<Task<()>>,
125 update_observer: Option<UpdateObservationState>,
126 fs: Arc<dyn Fs>,
127 fs_case_sensitive: bool,
128 visible: bool,
129 next_entry_id: Arc<AtomicUsize>,
130 settings: WorktreeSettings,
131 share_private_files: bool,
132}
133
134pub struct PathPrefixScanRequest {
135 path: Arc<RelPath>,
136 done: SmallVec<[barrier::Sender; 1]>,
137}
138
139struct ScanRequest {
140 relative_paths: Vec<Arc<RelPath>>,
141 done: SmallVec<[barrier::Sender; 1]>,
142}
143
144pub struct RemoteWorktree {
145 snapshot: Snapshot,
146 background_snapshot: Arc<Mutex<(Snapshot, Vec<proto::UpdateWorktree>)>>,
147 project_id: u64,
148 client: AnyProtoClient,
149 file_scan_inclusions: PathMatcher,
150 updates_tx: Option<UnboundedSender<proto::UpdateWorktree>>,
151 update_observer: Option<mpsc::UnboundedSender<proto::UpdateWorktree>>,
152 snapshot_subscriptions: VecDeque<(usize, oneshot::Sender<()>)>,
153 replica_id: ReplicaId,
154 visible: bool,
155 disconnected: bool,
156}
157
158#[derive(Clone)]
159pub struct Snapshot {
160 id: WorktreeId,
161 /// The absolute path of the worktree root.
162 abs_path: Arc<SanitizedPath>,
163 path_style: PathStyle,
164 root_name: Arc<RelPath>,
165 root_char_bag: CharBag,
166 entries_by_path: SumTree<Entry>,
167 entries_by_id: SumTree<PathEntry>,
168 always_included_entries: Vec<Arc<RelPath>>,
169
170 /// A number that increases every time the worktree begins scanning
171 /// a set of paths from the filesystem. This scanning could be caused
172 /// by some operation performed on the worktree, such as reading or
173 /// writing a file, or by an event reported by the filesystem.
174 scan_id: usize,
175
176 /// The latest scan id that has completed, and whose preceding scans
177 /// have all completed. The current `scan_id` could be more than one
178 /// greater than the `completed_scan_id` if operations are performed
179 /// on the worktree while it is processing a file-system event.
180 completed_scan_id: usize,
181}
182
183/// This path corresponds to the 'content path' of a repository in relation
184/// to Zed's project root.
185/// In the majority of the cases, this is the folder that contains the .git folder.
186/// But if a sub-folder of a git repository is opened, this corresponds to the
187/// project root and the .git folder is located in a parent directory.
188#[derive(Clone, Debug, Ord, PartialOrd, Eq, PartialEq, Hash)]
189pub enum WorkDirectory {
190 InProject {
191 relative_path: Arc<RelPath>,
192 },
193 AboveProject {
194 absolute_path: Arc<Path>,
195 location_in_repo: Arc<Path>,
196 },
197}
198
199impl WorkDirectory {
200 fn path_key(&self) -> PathKey {
201 match self {
202 WorkDirectory::InProject { relative_path } => PathKey(relative_path.clone()),
203 WorkDirectory::AboveProject { .. } => PathKey(RelPath::empty().into()),
204 }
205 }
206
207 /// Returns true if the given path is a child of the work directory.
208 ///
209 /// Note that the path may not be a member of this repository, if there
210 /// is a repository in a directory between these two paths
211 /// external .git folder in a parent folder of the project root.
212 #[track_caller]
213 pub fn directory_contains(&self, path: &RelPath) -> bool {
214 match self {
215 WorkDirectory::InProject { relative_path } => path.starts_with(relative_path),
216 WorkDirectory::AboveProject { .. } => true,
217 }
218 }
219}
220
221impl Default for WorkDirectory {
222 fn default() -> Self {
223 Self::InProject {
224 relative_path: Arc::from(RelPath::empty()),
225 }
226 }
227}
228
229#[derive(Clone)]
230pub struct LocalSnapshot {
231 snapshot: Snapshot,
232 global_gitignore: Option<Arc<Gitignore>>,
233 /// All of the gitignore files in the worktree, indexed by their absolute path.
234 /// The boolean indicates whether the gitignore needs to be updated.
235 ignores_by_parent_abs_path: HashMap<Arc<Path>, (Arc<Gitignore>, bool)>,
236 /// All of the git repositories in the worktree, indexed by the project entry
237 /// id of their parent directory.
238 git_repositories: TreeMap<ProjectEntryId, LocalRepositoryEntry>,
239 /// The file handle of the worktree root
240 /// (so we can find it after it's been moved)
241 root_file_handle: Option<Arc<dyn fs::FileHandle>>,
242 executor: BackgroundExecutor,
243}
244
245struct BackgroundScannerState {
246 snapshot: LocalSnapshot,
247 scanned_dirs: HashSet<ProjectEntryId>,
248 path_prefixes_to_scan: HashSet<Arc<RelPath>>,
249 paths_to_scan: HashSet<Arc<RelPath>>,
250 /// The ids of all of the entries that were removed from the snapshot
251 /// as part of the current update. These entry ids may be re-used
252 /// if the same inode is discovered at a new path, or if the given
253 /// path is re-created after being deleted.
254 removed_entries: HashMap<u64, Entry>,
255 changed_paths: Vec<Arc<RelPath>>,
256 prev_snapshot: Snapshot,
257}
258
259#[derive(Debug, Clone)]
260struct LocalRepositoryEntry {
261 work_directory_id: ProjectEntryId,
262 work_directory: WorkDirectory,
263 work_directory_abs_path: Arc<Path>,
264 git_dir_scan_id: usize,
265 /// Absolute path to the original .git entry that caused us to create this repository.
266 ///
267 /// This is normally a directory, but may be a "gitfile" that points to a directory elsewhere
268 /// (whose path we then store in `repository_dir_abs_path`).
269 dot_git_abs_path: Arc<Path>,
270 /// Absolute path to the "commondir" for this repository.
271 ///
272 /// This is always a directory. For a normal repository, this is the same as dot_git_abs_path,
273 /// but in the case of a submodule or a worktree it is the path to the "parent" .git directory
274 /// from which the submodule/worktree was derived.
275 common_dir_abs_path: Arc<Path>,
276 /// Absolute path to the directory holding the repository's state.
277 ///
278 /// For a normal repository, this is a directory and coincides with `dot_git_abs_path` and
279 /// `common_dir_abs_path`. For a submodule or worktree, this is some subdirectory of the
280 /// commondir like `/project/.git/modules/foo`.
281 repository_dir_abs_path: Arc<Path>,
282}
283
284impl sum_tree::Item for LocalRepositoryEntry {
285 type Summary = PathSummary<sum_tree::NoSummary>;
286
287 fn summary(&self, _: <Self::Summary as Summary>::Context<'_>) -> Self::Summary {
288 PathSummary {
289 max_path: self.work_directory.path_key().0,
290 item_summary: sum_tree::NoSummary,
291 }
292 }
293}
294
295impl KeyedItem for LocalRepositoryEntry {
296 type Key = PathKey;
297
298 fn key(&self) -> Self::Key {
299 self.work_directory.path_key()
300 }
301}
302
303impl Deref for LocalRepositoryEntry {
304 type Target = WorkDirectory;
305
306 fn deref(&self) -> &Self::Target {
307 &self.work_directory
308 }
309}
310
311impl Deref for LocalSnapshot {
312 type Target = Snapshot;
313
314 fn deref(&self) -> &Self::Target {
315 &self.snapshot
316 }
317}
318
319impl DerefMut for LocalSnapshot {
320 fn deref_mut(&mut self) -> &mut Self::Target {
321 &mut self.snapshot
322 }
323}
324
325enum ScanState {
326 Started,
327 Updated {
328 snapshot: LocalSnapshot,
329 changes: UpdatedEntriesSet,
330 barrier: SmallVec<[barrier::Sender; 1]>,
331 scanning: bool,
332 },
333 RootUpdated {
334 new_path: Arc<SanitizedPath>,
335 },
336}
337
338struct UpdateObservationState {
339 snapshots_tx: mpsc::UnboundedSender<(LocalSnapshot, UpdatedEntriesSet)>,
340 resume_updates: watch::Sender<()>,
341 _maintain_remote_snapshot: Task<Option<()>>,
342}
343
344#[derive(Clone)]
345pub enum Event {
346 UpdatedEntries(UpdatedEntriesSet),
347 UpdatedGitRepositories(UpdatedGitRepositoriesSet),
348 DeletedEntry(ProjectEntryId),
349}
350
351impl EventEmitter<Event> for Worktree {}
352
353impl Worktree {
354 pub async fn local(
355 path: impl Into<Arc<Path>>,
356 visible: bool,
357 fs: Arc<dyn Fs>,
358 next_entry_id: Arc<AtomicUsize>,
359 cx: &mut AsyncApp,
360 ) -> Result<Entity<Self>> {
361 let abs_path = path.into();
362 let metadata = fs
363 .metadata(&abs_path)
364 .await
365 .context("failed to stat worktree path")?;
366
367 let fs_case_sensitive = fs.is_case_sensitive().await.unwrap_or_else(|e| {
368 log::error!(
369 "Failed to determine whether filesystem is case sensitive (falling back to true) due to error: {e:#}"
370 );
371 true
372 });
373
374 let root_file_handle = if metadata.as_ref().is_some() {
375 fs.open_handle(&abs_path)
376 .await
377 .with_context(|| {
378 format!(
379 "failed to open local worktree root at {}",
380 abs_path.display()
381 )
382 })
383 .log_err()
384 } else {
385 None
386 };
387
388 cx.new(move |cx: &mut Context<Worktree>| {
389 let mut snapshot = LocalSnapshot {
390 ignores_by_parent_abs_path: Default::default(),
391 global_gitignore: Default::default(),
392 git_repositories: Default::default(),
393 snapshot: Snapshot::new(
394 cx.entity_id().as_u64(),
395 abs_path
396 .file_name()
397 .and_then(|f| f.to_str())
398 .map_or(RelPath::empty().into(), |f| {
399 RelPath::unix(f).unwrap().into()
400 }),
401 abs_path.clone(),
402 PathStyle::local(),
403 ),
404 root_file_handle,
405 executor: cx.background_executor().clone(),
406 };
407
408 let worktree_id = snapshot.id();
409 let settings_location = Some(SettingsLocation {
410 worktree_id,
411 path: RelPath::empty(),
412 });
413
414 let settings = WorktreeSettings::get(settings_location, cx).clone();
415 cx.observe_global::<SettingsStore>(move |this, cx| {
416 if let Self::Local(this) = this {
417 let settings = WorktreeSettings::get(settings_location, cx).clone();
418 if this.settings != settings {
419 this.settings = settings;
420 this.restart_background_scanners(cx);
421 }
422 }
423 })
424 .detach();
425
426 let share_private_files = false;
427 if let Some(metadata) = metadata {
428 let mut entry = Entry::new(
429 RelPath::empty().into(),
430 &metadata,
431 &next_entry_id,
432 snapshot.root_char_bag,
433 None,
434 );
435 if !metadata.is_dir {
436 if let Some(file_name) = abs_path.file_name()
437 && let Some(file_name) = file_name.to_str()
438 && let Ok(path) = RelPath::unix(file_name)
439 {
440 entry.is_private = !share_private_files && settings.is_path_private(path);
441 entry.is_hidden = settings.is_path_hidden(path);
442 }
443 }
444 snapshot.insert_entry(entry, fs.as_ref());
445 }
446
447 let (scan_requests_tx, scan_requests_rx) = channel::unbounded();
448 let (path_prefixes_to_scan_tx, path_prefixes_to_scan_rx) = channel::unbounded();
449 let mut worktree = LocalWorktree {
450 share_private_files,
451 next_entry_id,
452 snapshot,
453 is_scanning: watch::channel_with(true),
454 update_observer: None,
455 scan_requests_tx,
456 path_prefixes_to_scan_tx,
457 _background_scanner_tasks: Vec::new(),
458 fs,
459 fs_case_sensitive,
460 visible,
461 settings,
462 };
463 worktree.start_background_scanner(scan_requests_rx, path_prefixes_to_scan_rx, cx);
464 Worktree::Local(worktree)
465 })
466 }
467
468 pub fn remote(
469 project_id: u64,
470 replica_id: ReplicaId,
471 worktree: proto::WorktreeMetadata,
472 client: AnyProtoClient,
473 path_style: PathStyle,
474 cx: &mut App,
475 ) -> Entity<Self> {
476 cx.new(|cx: &mut Context<Self>| {
477 let snapshot = Snapshot::new(
478 worktree.id,
479 RelPath::from_proto(&worktree.root_name)
480 .unwrap_or_else(|_| RelPath::empty().into()),
481 Path::new(&worktree.abs_path).into(),
482 path_style,
483 );
484
485 let background_snapshot = Arc::new(Mutex::new((
486 snapshot.clone(),
487 Vec::<proto::UpdateWorktree>::new(),
488 )));
489 let (background_updates_tx, mut background_updates_rx) =
490 mpsc::unbounded::<proto::UpdateWorktree>();
491 let (mut snapshot_updated_tx, mut snapshot_updated_rx) = watch::channel();
492
493 let worktree_id = snapshot.id();
494 let settings_location = Some(SettingsLocation {
495 worktree_id,
496 path: RelPath::empty(),
497 });
498
499 let settings = WorktreeSettings::get(settings_location, cx).clone();
500 let worktree = RemoteWorktree {
501 client,
502 project_id,
503 replica_id,
504 snapshot,
505 file_scan_inclusions: settings.parent_dir_scan_inclusions.clone(),
506 background_snapshot: background_snapshot.clone(),
507 updates_tx: Some(background_updates_tx),
508 update_observer: None,
509 snapshot_subscriptions: Default::default(),
510 visible: worktree.visible,
511 disconnected: false,
512 };
513
514 // Apply updates to a separate snapshot in a background task, then
515 // send them to a foreground task which updates the model.
516 cx.background_spawn(async move {
517 while let Some(update) = background_updates_rx.next().await {
518 {
519 let mut lock = background_snapshot.lock();
520 lock.0.apply_remote_update(
521 update.clone(),
522 &settings.parent_dir_scan_inclusions,
523 );
524 lock.1.push(update);
525 }
526 snapshot_updated_tx.send(()).await.ok();
527 }
528 })
529 .detach();
530
531 // On the foreground task, update to the latest snapshot and notify
532 // any update observer of all updates that led to that snapshot.
533 cx.spawn(async move |this, cx| {
534 while (snapshot_updated_rx.recv().await).is_some() {
535 this.update(cx, |this, cx| {
536 let mut entries_changed = false;
537 let this = this.as_remote_mut().unwrap();
538 {
539 let mut lock = this.background_snapshot.lock();
540 this.snapshot = lock.0.clone();
541 for update in lock.1.drain(..) {
542 entries_changed |= !update.updated_entries.is_empty()
543 || !update.removed_entries.is_empty();
544 if let Some(tx) = &this.update_observer {
545 tx.unbounded_send(update).ok();
546 }
547 }
548 };
549
550 if entries_changed {
551 cx.emit(Event::UpdatedEntries(Arc::default()));
552 }
553 cx.notify();
554 while let Some((scan_id, _)) = this.snapshot_subscriptions.front() {
555 if this.observed_snapshot(*scan_id) {
556 let (_, tx) = this.snapshot_subscriptions.pop_front().unwrap();
557 let _ = tx.send(());
558 } else {
559 break;
560 }
561 }
562 })?;
563 }
564 anyhow::Ok(())
565 })
566 .detach();
567
568 Worktree::Remote(worktree)
569 })
570 }
571
572 pub fn as_local(&self) -> Option<&LocalWorktree> {
573 if let Worktree::Local(worktree) = self {
574 Some(worktree)
575 } else {
576 None
577 }
578 }
579
580 pub fn as_remote(&self) -> Option<&RemoteWorktree> {
581 if let Worktree::Remote(worktree) = self {
582 Some(worktree)
583 } else {
584 None
585 }
586 }
587
588 pub fn as_local_mut(&mut self) -> Option<&mut LocalWorktree> {
589 if let Worktree::Local(worktree) = self {
590 Some(worktree)
591 } else {
592 None
593 }
594 }
595
596 pub fn as_remote_mut(&mut self) -> Option<&mut RemoteWorktree> {
597 if let Worktree::Remote(worktree) = self {
598 Some(worktree)
599 } else {
600 None
601 }
602 }
603
604 pub fn is_local(&self) -> bool {
605 matches!(self, Worktree::Local(_))
606 }
607
608 pub fn is_remote(&self) -> bool {
609 !self.is_local()
610 }
611
612 pub fn settings_location(&self, _: &Context<Self>) -> SettingsLocation<'static> {
613 SettingsLocation {
614 worktree_id: self.id(),
615 path: RelPath::empty(),
616 }
617 }
618
619 pub fn snapshot(&self) -> Snapshot {
620 match self {
621 Worktree::Local(worktree) => worktree.snapshot.snapshot.clone(),
622 Worktree::Remote(worktree) => worktree.snapshot.clone(),
623 }
624 }
625
626 pub fn scan_id(&self) -> usize {
627 match self {
628 Worktree::Local(worktree) => worktree.snapshot.scan_id,
629 Worktree::Remote(worktree) => worktree.snapshot.scan_id,
630 }
631 }
632
633 pub fn metadata_proto(&self) -> proto::WorktreeMetadata {
634 proto::WorktreeMetadata {
635 id: self.id().to_proto(),
636 root_name: self.root_name().to_proto(),
637 visible: self.is_visible(),
638 abs_path: self.abs_path().to_string_lossy().into_owned(),
639 }
640 }
641
642 pub fn completed_scan_id(&self) -> usize {
643 match self {
644 Worktree::Local(worktree) => worktree.snapshot.completed_scan_id,
645 Worktree::Remote(worktree) => worktree.snapshot.completed_scan_id,
646 }
647 }
648
649 pub fn is_visible(&self) -> bool {
650 match self {
651 Worktree::Local(worktree) => worktree.visible,
652 Worktree::Remote(worktree) => worktree.visible,
653 }
654 }
655
656 pub fn replica_id(&self) -> ReplicaId {
657 match self {
658 Worktree::Local(_) => ReplicaId::LOCAL,
659 Worktree::Remote(worktree) => worktree.replica_id,
660 }
661 }
662
663 pub fn abs_path(&self) -> Arc<Path> {
664 match self {
665 Worktree::Local(worktree) => SanitizedPath::cast_arc(worktree.abs_path.clone()),
666 Worktree::Remote(worktree) => SanitizedPath::cast_arc(worktree.abs_path.clone()),
667 }
668 }
669
670 pub fn root_file(&self, cx: &Context<Self>) -> Option<Arc<File>> {
671 let entry = self.root_entry()?;
672 Some(File::for_entry(entry.clone(), cx.entity()))
673 }
674
675 pub fn observe_updates<F, Fut>(&mut self, project_id: u64, cx: &Context<Worktree>, callback: F)
676 where
677 F: 'static + Send + Fn(proto::UpdateWorktree) -> Fut,
678 Fut: 'static + Send + Future<Output = bool>,
679 {
680 match self {
681 Worktree::Local(this) => this.observe_updates(project_id, cx, callback),
682 Worktree::Remote(this) => this.observe_updates(project_id, cx, callback),
683 }
684 }
685
686 pub fn stop_observing_updates(&mut self) {
687 match self {
688 Worktree::Local(this) => {
689 this.update_observer.take();
690 }
691 Worktree::Remote(this) => {
692 this.update_observer.take();
693 }
694 }
695 }
696
697 #[cfg(any(test, feature = "test-support"))]
698 pub fn has_update_observer(&self) -> bool {
699 match self {
700 Worktree::Local(this) => this.update_observer.is_some(),
701 Worktree::Remote(this) => this.update_observer.is_some(),
702 }
703 }
704
705 pub fn load_file(&self, path: &RelPath, cx: &Context<Worktree>) -> Task<Result<LoadedFile>> {
706 match self {
707 Worktree::Local(this) => this.load_file(path, cx),
708 Worktree::Remote(_) => {
709 Task::ready(Err(anyhow!("remote worktrees can't yet load files")))
710 }
711 }
712 }
713
714 pub fn load_binary_file(
715 &self,
716 path: &RelPath,
717 cx: &Context<Worktree>,
718 ) -> Task<Result<LoadedBinaryFile>> {
719 match self {
720 Worktree::Local(this) => this.load_binary_file(path, cx),
721 Worktree::Remote(_) => {
722 Task::ready(Err(anyhow!("remote worktrees can't yet load binary files")))
723 }
724 }
725 }
726
727 pub fn write_file(
728 &self,
729 path: Arc<RelPath>,
730 text: Rope,
731 line_ending: LineEnding,
732 cx: &Context<Worktree>,
733 ) -> Task<Result<Arc<File>>> {
734 match self {
735 Worktree::Local(this) => this.write_file(path, text, line_ending, cx),
736 Worktree::Remote(_) => {
737 Task::ready(Err(anyhow!("remote worktree can't yet write files")))
738 }
739 }
740 }
741
742 pub fn create_entry(
743 &mut self,
744 path: Arc<RelPath>,
745 is_directory: bool,
746 content: Option<Vec<u8>>,
747 cx: &Context<Worktree>,
748 ) -> Task<Result<CreatedEntry>> {
749 let worktree_id = self.id();
750 match self {
751 Worktree::Local(this) => this.create_entry(path, is_directory, content, cx),
752 Worktree::Remote(this) => {
753 let project_id = this.project_id;
754 let request = this.client.request(proto::CreateProjectEntry {
755 worktree_id: worktree_id.to_proto(),
756 project_id,
757 path: path.as_ref().to_proto(),
758 content,
759 is_directory,
760 });
761 cx.spawn(async move |this, cx| {
762 let response = request.await?;
763 match response.entry {
764 Some(entry) => this
765 .update(cx, |worktree, cx| {
766 worktree.as_remote_mut().unwrap().insert_entry(
767 entry,
768 response.worktree_scan_id as usize,
769 cx,
770 )
771 })?
772 .await
773 .map(CreatedEntry::Included),
774 None => {
775 let abs_path =
776 this.read_with(cx, |worktree, _| worktree.absolutize(&path))?;
777 Ok(CreatedEntry::Excluded { abs_path })
778 }
779 }
780 })
781 }
782 }
783 }
784
785 pub fn delete_entry(
786 &mut self,
787 entry_id: ProjectEntryId,
788 trash: bool,
789 cx: &mut Context<Worktree>,
790 ) -> Option<Task<Result<()>>> {
791 let task = match self {
792 Worktree::Local(this) => this.delete_entry(entry_id, trash, cx),
793 Worktree::Remote(this) => this.delete_entry(entry_id, trash, cx),
794 }?;
795
796 let entry = match &*self {
797 Worktree::Local(this) => this.entry_for_id(entry_id),
798 Worktree::Remote(this) => this.entry_for_id(entry_id),
799 }?;
800
801 let mut ids = vec![entry_id];
802 let path = &*entry.path;
803
804 self.get_children_ids_recursive(path, &mut ids);
805
806 for id in ids {
807 cx.emit(Event::DeletedEntry(id));
808 }
809 Some(task)
810 }
811
812 fn get_children_ids_recursive(&self, path: &RelPath, ids: &mut Vec<ProjectEntryId>) {
813 let children_iter = self.child_entries(path);
814 for child in children_iter {
815 ids.push(child.id);
816 self.get_children_ids_recursive(&child.path, ids);
817 }
818 }
819
820 // pub fn rename_entry(
821 // &mut self,
822 // entry_id: ProjectEntryId,
823 // new_path: Arc<RelPath>,
824 // cx: &Context<Self>,
825 // ) -> Task<Result<CreatedEntry>> {
826 // match self {
827 // Worktree::Local(this) => this.rename_entry(entry_id, new_path, cx),
828 // Worktree::Remote(this) => this.rename_entry(entry_id, new_path, cx),
829 // }
830 // }
831
832 pub fn copy_external_entries(
833 &mut self,
834 target_directory: Arc<RelPath>,
835 paths: Vec<Arc<Path>>,
836 fs: Arc<dyn Fs>,
837 cx: &Context<Worktree>,
838 ) -> Task<Result<Vec<ProjectEntryId>>> {
839 match self {
840 Worktree::Local(this) => this.copy_external_entries(target_directory, paths, cx),
841 Worktree::Remote(this) => this.copy_external_entries(target_directory, paths, fs, cx),
842 }
843 }
844
845 pub fn expand_entry(
846 &mut self,
847 entry_id: ProjectEntryId,
848 cx: &Context<Worktree>,
849 ) -> Option<Task<Result<()>>> {
850 match self {
851 Worktree::Local(this) => this.expand_entry(entry_id, cx),
852 Worktree::Remote(this) => {
853 let response = this.client.request(proto::ExpandProjectEntry {
854 project_id: this.project_id,
855 entry_id: entry_id.to_proto(),
856 });
857 Some(cx.spawn(async move |this, cx| {
858 let response = response.await?;
859 this.update(cx, |this, _| {
860 this.as_remote_mut()
861 .unwrap()
862 .wait_for_snapshot(response.worktree_scan_id as usize)
863 })?
864 .await?;
865 Ok(())
866 }))
867 }
868 }
869 }
870
871 pub fn expand_all_for_entry(
872 &mut self,
873 entry_id: ProjectEntryId,
874 cx: &Context<Worktree>,
875 ) -> Option<Task<Result<()>>> {
876 match self {
877 Worktree::Local(this) => this.expand_all_for_entry(entry_id, cx),
878 Worktree::Remote(this) => {
879 let response = this.client.request(proto::ExpandAllForProjectEntry {
880 project_id: this.project_id,
881 entry_id: entry_id.to_proto(),
882 });
883 Some(cx.spawn(async move |this, cx| {
884 let response = response.await?;
885 this.update(cx, |this, _| {
886 this.as_remote_mut()
887 .unwrap()
888 .wait_for_snapshot(response.worktree_scan_id as usize)
889 })?
890 .await?;
891 Ok(())
892 }))
893 }
894 }
895 }
896
897 pub async fn handle_create_entry(
898 this: Entity<Self>,
899 request: proto::CreateProjectEntry,
900 mut cx: AsyncApp,
901 ) -> Result<proto::ProjectEntryResponse> {
902 let (scan_id, entry) = this.update(&mut cx, |this, cx| {
903 anyhow::Ok((
904 this.scan_id(),
905 this.create_entry(
906 RelPath::from_proto(&request.path).with_context(|| {
907 format!("received invalid relative path {:?}", request.path)
908 })?,
909 request.is_directory,
910 request.content,
911 cx,
912 ),
913 ))
914 })??;
915 Ok(proto::ProjectEntryResponse {
916 entry: match &entry.await? {
917 CreatedEntry::Included(entry) => Some(entry.into()),
918 CreatedEntry::Excluded { .. } => None,
919 },
920 worktree_scan_id: scan_id as u64,
921 })
922 }
923
924 pub async fn handle_delete_entry(
925 this: Entity<Self>,
926 request: proto::DeleteProjectEntry,
927 mut cx: AsyncApp,
928 ) -> Result<proto::ProjectEntryResponse> {
929 let (scan_id, task) = this.update(&mut cx, |this, cx| {
930 (
931 this.scan_id(),
932 this.delete_entry(
933 ProjectEntryId::from_proto(request.entry_id),
934 request.use_trash,
935 cx,
936 ),
937 )
938 })?;
939 task.context("invalid entry")?.await?;
940 Ok(proto::ProjectEntryResponse {
941 entry: None,
942 worktree_scan_id: scan_id as u64,
943 })
944 }
945
946 pub async fn handle_expand_entry(
947 this: Entity<Self>,
948 request: proto::ExpandProjectEntry,
949 mut cx: AsyncApp,
950 ) -> Result<proto::ExpandProjectEntryResponse> {
951 let task = this.update(&mut cx, |this, cx| {
952 this.expand_entry(ProjectEntryId::from_proto(request.entry_id), cx)
953 })?;
954 task.context("no such entry")?.await?;
955 let scan_id = this.read_with(&cx, |this, _| this.scan_id())?;
956 Ok(proto::ExpandProjectEntryResponse {
957 worktree_scan_id: scan_id as u64,
958 })
959 }
960
961 pub async fn handle_expand_all_for_entry(
962 this: Entity<Self>,
963 request: proto::ExpandAllForProjectEntry,
964 mut cx: AsyncApp,
965 ) -> Result<proto::ExpandAllForProjectEntryResponse> {
966 let task = this.update(&mut cx, |this, cx| {
967 this.expand_all_for_entry(ProjectEntryId::from_proto(request.entry_id), cx)
968 })?;
969 task.context("no such entry")?.await?;
970 let scan_id = this.read_with(&cx, |this, _| this.scan_id())?;
971 Ok(proto::ExpandAllForProjectEntryResponse {
972 worktree_scan_id: scan_id as u64,
973 })
974 }
975
976 pub fn is_single_file(&self) -> bool {
977 self.root_dir().is_none()
978 }
979
980 /// For visible worktrees, returns the path with the worktree name as the first component.
981 /// Otherwise, returns an absolute path.
982 pub fn full_path(&self, worktree_relative_path: &RelPath) -> PathBuf {
983 if self.is_visible() {
984 self.root_name()
985 .join(worktree_relative_path)
986 .display(self.path_style)
987 .to_string()
988 .into()
989 } else {
990 let full_path = self.abs_path();
991 let mut full_path_string = if self.is_local()
992 && let Ok(stripped) = full_path.strip_prefix(home_dir())
993 {
994 self.path_style
995 .join("~", &*stripped.to_string_lossy())
996 .unwrap()
997 } else {
998 full_path.to_string_lossy().into_owned()
999 };
1000
1001 if worktree_relative_path.components().next().is_some() {
1002 full_path_string.push_str(self.path_style.separator());
1003 full_path_string.push_str(&worktree_relative_path.display(self.path_style));
1004 }
1005
1006 full_path_string.into()
1007 }
1008 }
1009}
1010
1011impl LocalWorktree {
1012 pub fn fs(&self) -> &Arc<dyn Fs> {
1013 &self.fs
1014 }
1015
1016 pub fn is_path_private(&self, path: &RelPath) -> bool {
1017 !self.share_private_files && self.settings.is_path_private(path)
1018 }
1019
1020 pub fn fs_is_case_sensitive(&self) -> bool {
1021 self.fs_case_sensitive
1022 }
1023
1024 fn restart_background_scanners(&mut self, cx: &Context<Worktree>) {
1025 let (scan_requests_tx, scan_requests_rx) = channel::unbounded();
1026 let (path_prefixes_to_scan_tx, path_prefixes_to_scan_rx) = channel::unbounded();
1027 self.scan_requests_tx = scan_requests_tx;
1028 self.path_prefixes_to_scan_tx = path_prefixes_to_scan_tx;
1029
1030 self.start_background_scanner(scan_requests_rx, path_prefixes_to_scan_rx, cx);
1031 let always_included_entries = mem::take(&mut self.snapshot.always_included_entries);
1032 log::debug!(
1033 "refreshing entries for the following always included paths: {:?}",
1034 always_included_entries
1035 );
1036
1037 // Cleans up old always included entries to ensure they get updated properly. Otherwise,
1038 // nested always included entries may not get updated and will result in out-of-date info.
1039 self.refresh_entries_for_paths(always_included_entries);
1040 }
1041
1042 fn start_background_scanner(
1043 &mut self,
1044 scan_requests_rx: channel::Receiver<ScanRequest>,
1045 path_prefixes_to_scan_rx: channel::Receiver<PathPrefixScanRequest>,
1046 cx: &Context<Worktree>,
1047 ) {
1048 let snapshot = self.snapshot();
1049 let share_private_files = self.share_private_files;
1050 let next_entry_id = self.next_entry_id.clone();
1051 let fs = self.fs.clone();
1052 let settings = self.settings.clone();
1053 let (scan_states_tx, mut scan_states_rx) = mpsc::unbounded();
1054 let background_scanner = cx.background_spawn({
1055 let abs_path = snapshot.abs_path.as_path().to_path_buf();
1056 let background = cx.background_executor().clone();
1057 async move {
1058 let (events, watcher) = fs.watch(&abs_path, FS_WATCH_LATENCY).await;
1059 let fs_case_sensitive = fs.is_case_sensitive().await.unwrap_or_else(|e| {
1060 log::error!("Failed to determine whether filesystem is case sensitive: {e:#}");
1061 true
1062 });
1063
1064 let mut scanner = BackgroundScanner {
1065 fs,
1066 fs_case_sensitive,
1067 status_updates_tx: scan_states_tx,
1068 executor: background,
1069 scan_requests_rx,
1070 path_prefixes_to_scan_rx,
1071 next_entry_id,
1072 state: async_lock::Mutex::new(BackgroundScannerState {
1073 prev_snapshot: snapshot.snapshot.clone(),
1074 snapshot,
1075 scanned_dirs: Default::default(),
1076 path_prefixes_to_scan: Default::default(),
1077 paths_to_scan: Default::default(),
1078 removed_entries: Default::default(),
1079 changed_paths: Default::default(),
1080 }),
1081 phase: BackgroundScannerPhase::InitialScan,
1082 share_private_files,
1083 settings,
1084 watcher,
1085 };
1086
1087 scanner
1088 .run(Box::pin(events.map(|events| events.into_iter().collect())))
1089 .await;
1090 }
1091 });
1092 let scan_state_updater = cx.spawn(async move |this, cx| {
1093 while let Some((state, this)) = scan_states_rx.next().await.zip(this.upgrade()) {
1094 this.update(cx, |this, cx| {
1095 let this = this.as_local_mut().unwrap();
1096 match state {
1097 ScanState::Started => {
1098 *this.is_scanning.0.borrow_mut() = true;
1099 }
1100 ScanState::Updated {
1101 snapshot,
1102 changes,
1103 barrier,
1104 scanning,
1105 } => {
1106 *this.is_scanning.0.borrow_mut() = scanning;
1107 this.set_snapshot(snapshot, changes, cx);
1108 drop(barrier);
1109 }
1110 ScanState::RootUpdated { new_path } => {
1111 this.update_abs_path_and_refresh(new_path, cx);
1112 }
1113 }
1114 })
1115 .ok();
1116 }
1117 });
1118 self._background_scanner_tasks = vec![background_scanner, scan_state_updater];
1119 *self.is_scanning.0.borrow_mut() = true;
1120 }
1121
1122 fn set_snapshot(
1123 &mut self,
1124 mut new_snapshot: LocalSnapshot,
1125 entry_changes: UpdatedEntriesSet,
1126 cx: &mut Context<Worktree>,
1127 ) {
1128 let repo_changes = self.changed_repos(&self.snapshot, &mut new_snapshot);
1129 self.snapshot = new_snapshot;
1130
1131 if let Some(share) = self.update_observer.as_mut() {
1132 share
1133 .snapshots_tx
1134 .unbounded_send((self.snapshot.clone(), entry_changes.clone()))
1135 .ok();
1136 }
1137
1138 if !entry_changes.is_empty() {
1139 cx.emit(Event::UpdatedEntries(entry_changes));
1140 }
1141 if !repo_changes.is_empty() {
1142 cx.emit(Event::UpdatedGitRepositories(repo_changes));
1143 }
1144 }
1145
1146 fn changed_repos(
1147 &self,
1148 old_snapshot: &LocalSnapshot,
1149 new_snapshot: &mut LocalSnapshot,
1150 ) -> UpdatedGitRepositoriesSet {
1151 let mut changes = Vec::new();
1152 let mut old_repos = old_snapshot.git_repositories.iter().peekable();
1153 let new_repos = new_snapshot.git_repositories.clone();
1154 let mut new_repos = new_repos.iter().peekable();
1155
1156 loop {
1157 match (new_repos.peek().map(clone), old_repos.peek().map(clone)) {
1158 (Some((new_entry_id, new_repo)), Some((old_entry_id, old_repo))) => {
1159 match Ord::cmp(&new_entry_id, &old_entry_id) {
1160 Ordering::Less => {
1161 changes.push(UpdatedGitRepository {
1162 work_directory_id: new_entry_id,
1163 old_work_directory_abs_path: None,
1164 new_work_directory_abs_path: Some(
1165 new_repo.work_directory_abs_path.clone(),
1166 ),
1167 dot_git_abs_path: Some(new_repo.dot_git_abs_path.clone()),
1168 repository_dir_abs_path: Some(
1169 new_repo.repository_dir_abs_path.clone(),
1170 ),
1171 common_dir_abs_path: Some(new_repo.common_dir_abs_path.clone()),
1172 });
1173 new_repos.next();
1174 }
1175 Ordering::Equal => {
1176 if new_repo.git_dir_scan_id != old_repo.git_dir_scan_id
1177 || new_repo.work_directory_abs_path
1178 != old_repo.work_directory_abs_path
1179 {
1180 changes.push(UpdatedGitRepository {
1181 work_directory_id: new_entry_id,
1182 old_work_directory_abs_path: Some(
1183 old_repo.work_directory_abs_path.clone(),
1184 ),
1185 new_work_directory_abs_path: Some(
1186 new_repo.work_directory_abs_path.clone(),
1187 ),
1188 dot_git_abs_path: Some(new_repo.dot_git_abs_path.clone()),
1189 repository_dir_abs_path: Some(
1190 new_repo.repository_dir_abs_path.clone(),
1191 ),
1192 common_dir_abs_path: Some(new_repo.common_dir_abs_path.clone()),
1193 });
1194 }
1195 new_repos.next();
1196 old_repos.next();
1197 }
1198 Ordering::Greater => {
1199 changes.push(UpdatedGitRepository {
1200 work_directory_id: old_entry_id,
1201 old_work_directory_abs_path: Some(
1202 old_repo.work_directory_abs_path.clone(),
1203 ),
1204 new_work_directory_abs_path: None,
1205 dot_git_abs_path: None,
1206 repository_dir_abs_path: None,
1207 common_dir_abs_path: None,
1208 });
1209 old_repos.next();
1210 }
1211 }
1212 }
1213 (Some((entry_id, repo)), None) => {
1214 changes.push(UpdatedGitRepository {
1215 work_directory_id: entry_id,
1216 old_work_directory_abs_path: None,
1217 new_work_directory_abs_path: Some(repo.work_directory_abs_path.clone()),
1218 dot_git_abs_path: Some(repo.dot_git_abs_path.clone()),
1219 repository_dir_abs_path: Some(repo.repository_dir_abs_path.clone()),
1220 common_dir_abs_path: Some(repo.common_dir_abs_path.clone()),
1221 });
1222 new_repos.next();
1223 }
1224 (None, Some((entry_id, repo))) => {
1225 changes.push(UpdatedGitRepository {
1226 work_directory_id: entry_id,
1227 old_work_directory_abs_path: Some(repo.work_directory_abs_path.clone()),
1228 new_work_directory_abs_path: None,
1229 dot_git_abs_path: Some(repo.dot_git_abs_path.clone()),
1230 repository_dir_abs_path: Some(repo.repository_dir_abs_path.clone()),
1231 common_dir_abs_path: Some(repo.common_dir_abs_path.clone()),
1232 });
1233 old_repos.next();
1234 }
1235 (None, None) => break,
1236 }
1237 }
1238
1239 fn clone<T: Clone, U: Clone>(value: &(&T, &U)) -> (T, U) {
1240 (value.0.clone(), value.1.clone())
1241 }
1242
1243 changes.into()
1244 }
1245
1246 pub fn scan_complete(&self) -> impl Future<Output = ()> + use<> {
1247 let mut is_scanning_rx = self.is_scanning.1.clone();
1248 async move {
1249 let mut is_scanning = *is_scanning_rx.borrow();
1250 while is_scanning {
1251 if let Some(value) = is_scanning_rx.recv().await {
1252 is_scanning = value;
1253 } else {
1254 break;
1255 }
1256 }
1257 }
1258 }
1259
1260 pub fn snapshot(&self) -> LocalSnapshot {
1261 self.snapshot.clone()
1262 }
1263
1264 pub fn settings(&self) -> WorktreeSettings {
1265 self.settings.clone()
1266 }
1267
1268 fn load_binary_file(
1269 &self,
1270 path: &RelPath,
1271 cx: &Context<Worktree>,
1272 ) -> Task<Result<LoadedBinaryFile>> {
1273 let path = Arc::from(path);
1274 let abs_path = self.absolutize(&path);
1275 let fs = self.fs.clone();
1276 let entry = self.refresh_entry(path.clone(), None, cx);
1277 let is_private = self.is_path_private(&path);
1278
1279 let worktree = cx.weak_entity();
1280 cx.background_spawn(async move {
1281 let content = fs.load_bytes(&abs_path).await?;
1282
1283 let worktree = worktree.upgrade().context("worktree was dropped")?;
1284 let file = match entry.await? {
1285 Some(entry) => File::for_entry(entry, worktree),
1286 None => {
1287 let metadata = fs
1288 .metadata(&abs_path)
1289 .await
1290 .with_context(|| {
1291 format!("Loading metadata for excluded file {abs_path:?}")
1292 })?
1293 .with_context(|| {
1294 format!("Excluded file {abs_path:?} got removed during loading")
1295 })?;
1296 Arc::new(File {
1297 entry_id: None,
1298 worktree,
1299 path,
1300 disk_state: DiskState::Present {
1301 mtime: metadata.mtime,
1302 },
1303 is_local: true,
1304 is_private,
1305 })
1306 }
1307 };
1308
1309 Ok(LoadedBinaryFile { file, content })
1310 })
1311 }
1312
1313 fn load_file(&self, path: &RelPath, cx: &Context<Worktree>) -> Task<Result<LoadedFile>> {
1314 let path = Arc::from(path);
1315 let abs_path = self.absolutize(&path);
1316 let fs = self.fs.clone();
1317 let entry = self.refresh_entry(path.clone(), None, cx);
1318 let is_private = self.is_path_private(path.as_ref());
1319
1320 let this = cx.weak_entity();
1321 cx.background_spawn(async move {
1322 // WARN: Temporary workaround for #27283.
1323 // We are not efficient with our memory usage per file, and use in excess of 64GB for a 10GB file
1324 // Therefore, as a temporary workaround to prevent system freezes, we just bail before opening a file
1325 // if it is too large
1326 // 5GB seems to be more reasonable, peaking at ~16GB, while 6GB jumps up to >24GB which seems like a
1327 // reasonable limit
1328 {
1329 const FILE_SIZE_MAX: u64 = 6 * 1024 * 1024 * 1024; // 6GB
1330 if let Ok(Some(metadata)) = fs.metadata(&abs_path).await
1331 && metadata.len >= FILE_SIZE_MAX
1332 {
1333 anyhow::bail!("File is too large to load");
1334 }
1335 }
1336 let text = fs.load(&abs_path).await?;
1337
1338 let worktree = this.upgrade().context("worktree was dropped")?;
1339 let file = match entry.await? {
1340 Some(entry) => File::for_entry(entry, worktree),
1341 None => {
1342 let metadata = fs
1343 .metadata(&abs_path)
1344 .await
1345 .with_context(|| {
1346 format!("Loading metadata for excluded file {abs_path:?}")
1347 })?
1348 .with_context(|| {
1349 format!("Excluded file {abs_path:?} got removed during loading")
1350 })?;
1351 Arc::new(File {
1352 entry_id: None,
1353 worktree,
1354 path,
1355 disk_state: DiskState::Present {
1356 mtime: metadata.mtime,
1357 },
1358 is_local: true,
1359 is_private,
1360 })
1361 }
1362 };
1363
1364 Ok(LoadedFile { file, text })
1365 })
1366 }
1367
1368 /// Find the lowest path in the worktree's datastructures that is an ancestor
1369 fn lowest_ancestor(&self, path: &RelPath) -> Arc<RelPath> {
1370 let mut lowest_ancestor = None;
1371 for path in path.ancestors() {
1372 if self.entry_for_path(path).is_some() {
1373 lowest_ancestor = Some(path.into());
1374 break;
1375 }
1376 }
1377
1378 lowest_ancestor.unwrap_or_else(|| RelPath::empty().into())
1379 }
1380
1381 fn create_entry(
1382 &self,
1383 path: Arc<RelPath>,
1384 is_dir: bool,
1385 content: Option<Vec<u8>>,
1386 cx: &Context<Worktree>,
1387 ) -> Task<Result<CreatedEntry>> {
1388 let abs_path = self.absolutize(&path);
1389 let path_excluded = self.settings.is_path_excluded(&path);
1390 let fs = self.fs.clone();
1391 let task_abs_path = abs_path.clone();
1392 let write = cx.background_spawn(async move {
1393 if is_dir {
1394 fs.create_dir(&task_abs_path)
1395 .await
1396 .with_context(|| format!("creating directory {task_abs_path:?}"))
1397 } else {
1398 fs.write(&task_abs_path, content.as_deref().unwrap_or(&[]))
1399 .await
1400 .with_context(|| format!("creating file {task_abs_path:?}"))
1401 }
1402 });
1403
1404 let lowest_ancestor = self.lowest_ancestor(&path);
1405 cx.spawn(async move |this, cx| {
1406 write.await?;
1407 if path_excluded {
1408 return Ok(CreatedEntry::Excluded { abs_path });
1409 }
1410
1411 let (result, refreshes) = this.update(cx, |this, cx| {
1412 let mut refreshes = Vec::new();
1413 let refresh_paths = path.strip_prefix(&lowest_ancestor).unwrap();
1414 for refresh_path in refresh_paths.ancestors() {
1415 if refresh_path == RelPath::empty() {
1416 continue;
1417 }
1418 let refresh_full_path = lowest_ancestor.join(refresh_path);
1419
1420 refreshes.push(this.as_local_mut().unwrap().refresh_entry(
1421 refresh_full_path,
1422 None,
1423 cx,
1424 ));
1425 }
1426 (
1427 this.as_local_mut().unwrap().refresh_entry(path, None, cx),
1428 refreshes,
1429 )
1430 })?;
1431 for refresh in refreshes {
1432 refresh.await.log_err();
1433 }
1434
1435 Ok(result
1436 .await?
1437 .map(CreatedEntry::Included)
1438 .unwrap_or_else(|| CreatedEntry::Excluded { abs_path }))
1439 })
1440 }
1441
1442 fn write_file(
1443 &self,
1444 path: Arc<RelPath>,
1445 text: Rope,
1446 line_ending: LineEnding,
1447 cx: &Context<Worktree>,
1448 ) -> Task<Result<Arc<File>>> {
1449 let fs = self.fs.clone();
1450 let is_private = self.is_path_private(&path);
1451 let abs_path = self.absolutize(&path);
1452
1453 let write = cx.background_spawn({
1454 let fs = fs.clone();
1455 let abs_path = abs_path.clone();
1456 async move { fs.save(&abs_path, &text, line_ending).await }
1457 });
1458
1459 cx.spawn(async move |this, cx| {
1460 write.await?;
1461 let entry = this
1462 .update(cx, |this, cx| {
1463 this.as_local_mut()
1464 .unwrap()
1465 .refresh_entry(path.clone(), None, cx)
1466 })?
1467 .await?;
1468 let worktree = this.upgrade().context("worktree dropped")?;
1469 if let Some(entry) = entry {
1470 Ok(File::for_entry(entry, worktree))
1471 } else {
1472 let metadata = fs
1473 .metadata(&abs_path)
1474 .await
1475 .with_context(|| {
1476 format!("Fetching metadata after saving the excluded buffer {abs_path:?}")
1477 })?
1478 .with_context(|| {
1479 format!("Excluded buffer {path:?} got removed during saving")
1480 })?;
1481 Ok(Arc::new(File {
1482 worktree,
1483 path,
1484 disk_state: DiskState::Present {
1485 mtime: metadata.mtime,
1486 },
1487 entry_id: None,
1488 is_local: true,
1489 is_private,
1490 }))
1491 }
1492 })
1493 }
1494
1495 fn delete_entry(
1496 &self,
1497 entry_id: ProjectEntryId,
1498 trash: bool,
1499 cx: &Context<Worktree>,
1500 ) -> Option<Task<Result<()>>> {
1501 let entry = self.entry_for_id(entry_id)?.clone();
1502 let abs_path = self.absolutize(&entry.path);
1503 let fs = self.fs.clone();
1504
1505 let delete = cx.background_spawn(async move {
1506 if entry.is_file() {
1507 if trash {
1508 fs.trash_file(&abs_path, Default::default()).await?;
1509 } else {
1510 fs.remove_file(&abs_path, Default::default()).await?;
1511 }
1512 } else if trash {
1513 fs.trash_dir(
1514 &abs_path,
1515 RemoveOptions {
1516 recursive: true,
1517 ignore_if_not_exists: false,
1518 },
1519 )
1520 .await?;
1521 } else {
1522 fs.remove_dir(
1523 &abs_path,
1524 RemoveOptions {
1525 recursive: true,
1526 ignore_if_not_exists: false,
1527 },
1528 )
1529 .await?;
1530 }
1531 anyhow::Ok(entry.path)
1532 });
1533
1534 Some(cx.spawn(async move |this, cx| {
1535 let path = delete.await?;
1536 this.update(cx, |this, _| {
1537 this.as_local_mut()
1538 .unwrap()
1539 .refresh_entries_for_paths(vec![path])
1540 })?
1541 .recv()
1542 .await;
1543 Ok(())
1544 }))
1545 }
1546
1547 pub fn copy_external_entries(
1548 &self,
1549 target_directory: Arc<RelPath>,
1550 paths: Vec<Arc<Path>>,
1551 cx: &Context<Worktree>,
1552 ) -> Task<Result<Vec<ProjectEntryId>>> {
1553 let target_directory = self.absolutize(&target_directory);
1554 let worktree_path = self.abs_path().clone();
1555 let fs = self.fs.clone();
1556 let paths = paths
1557 .into_iter()
1558 .filter_map(|source| {
1559 let file_name = source.file_name()?;
1560 let mut target = target_directory.clone();
1561 target.push(file_name);
1562
1563 // Do not allow copying the same file to itself.
1564 if source.as_ref() != target.as_path() {
1565 Some((source, target))
1566 } else {
1567 None
1568 }
1569 })
1570 .collect::<Vec<_>>();
1571
1572 let paths_to_refresh = paths
1573 .iter()
1574 .filter_map(|(_, target)| {
1575 RelPath::new(
1576 target.strip_prefix(&worktree_path).ok()?,
1577 PathStyle::local(),
1578 )
1579 .ok()
1580 .map(|path| path.into_arc())
1581 })
1582 .collect::<Vec<_>>();
1583
1584 cx.spawn(async move |this, cx| {
1585 cx.background_spawn(async move {
1586 for (source, target) in paths {
1587 copy_recursive(
1588 fs.as_ref(),
1589 &source,
1590 &target,
1591 fs::CopyOptions {
1592 overwrite: true,
1593 ..Default::default()
1594 },
1595 )
1596 .await
1597 .with_context(|| {
1598 format!("Failed to copy file from {source:?} to {target:?}")
1599 })?;
1600 }
1601 anyhow::Ok(())
1602 })
1603 .await
1604 .log_err();
1605 let mut refresh = cx.read_entity(
1606 &this.upgrade().with_context(|| "Dropped worktree")?,
1607 |this, _| {
1608 anyhow::Ok::<postage::barrier::Receiver>(
1609 this.as_local()
1610 .with_context(|| "Worktree is not local")?
1611 .refresh_entries_for_paths(paths_to_refresh.clone()),
1612 )
1613 },
1614 )??;
1615
1616 cx.background_spawn(async move {
1617 refresh.next().await;
1618 anyhow::Ok(())
1619 })
1620 .await
1621 .log_err();
1622
1623 let this = this.upgrade().with_context(|| "Dropped worktree")?;
1624 cx.read_entity(&this, |this, _| {
1625 paths_to_refresh
1626 .iter()
1627 .filter_map(|path| Some(this.entry_for_path(path)?.id))
1628 .collect()
1629 })
1630 })
1631 }
1632
1633 fn expand_entry(
1634 &self,
1635 entry_id: ProjectEntryId,
1636 cx: &Context<Worktree>,
1637 ) -> Option<Task<Result<()>>> {
1638 let path = self.entry_for_id(entry_id)?.path.clone();
1639 let mut refresh = self.refresh_entries_for_paths(vec![path]);
1640 Some(cx.background_spawn(async move {
1641 refresh.next().await;
1642 Ok(())
1643 }))
1644 }
1645
1646 fn expand_all_for_entry(
1647 &self,
1648 entry_id: ProjectEntryId,
1649 cx: &Context<Worktree>,
1650 ) -> Option<Task<Result<()>>> {
1651 let path = self.entry_for_id(entry_id).unwrap().path.clone();
1652 let mut rx = self.add_path_prefix_to_scan(path);
1653 Some(cx.background_spawn(async move {
1654 rx.next().await;
1655 Ok(())
1656 }))
1657 }
1658
1659 pub fn refresh_entries_for_paths(&self, paths: Vec<Arc<RelPath>>) -> barrier::Receiver {
1660 let (tx, rx) = barrier::channel();
1661 self.scan_requests_tx
1662 .try_send(ScanRequest {
1663 relative_paths: paths,
1664 done: smallvec![tx],
1665 })
1666 .ok();
1667 rx
1668 }
1669
1670 #[cfg(feature = "test-support")]
1671 pub fn manually_refresh_entries_for_paths(
1672 &self,
1673 paths: Vec<Arc<RelPath>>,
1674 ) -> barrier::Receiver {
1675 self.refresh_entries_for_paths(paths)
1676 }
1677
1678 pub fn add_path_prefix_to_scan(&self, path_prefix: Arc<RelPath>) -> barrier::Receiver {
1679 let (tx, rx) = barrier::channel();
1680 self.path_prefixes_to_scan_tx
1681 .try_send(PathPrefixScanRequest {
1682 path: path_prefix,
1683 done: smallvec![tx],
1684 })
1685 .ok();
1686 rx
1687 }
1688
1689 pub fn refresh_entry(
1690 &self,
1691 path: Arc<RelPath>,
1692 old_path: Option<Arc<RelPath>>,
1693 cx: &Context<Worktree>,
1694 ) -> Task<Result<Option<Entry>>> {
1695 if self.settings.is_path_excluded(&path) {
1696 return Task::ready(Ok(None));
1697 }
1698 let paths = if let Some(old_path) = old_path.as_ref() {
1699 vec![old_path.clone(), path.clone()]
1700 } else {
1701 vec![path.clone()]
1702 };
1703 let t0 = Instant::now();
1704 let mut refresh = self.refresh_entries_for_paths(paths);
1705 // todo(lw): Hot foreground spawn
1706 cx.spawn(async move |this, cx| {
1707 refresh.recv().await;
1708 log::trace!("refreshed entry {path:?} in {:?}", t0.elapsed());
1709 let new_entry = this.read_with(cx, |this, _| {
1710 this.entry_for_path(&path).cloned().with_context(|| {
1711 format!("Could not find entry in worktree for {path:?} after refresh")
1712 })
1713 })??;
1714 Ok(Some(new_entry))
1715 })
1716 }
1717
1718 fn observe_updates<F, Fut>(&mut self, project_id: u64, cx: &Context<Worktree>, callback: F)
1719 where
1720 F: 'static + Send + Fn(proto::UpdateWorktree) -> Fut,
1721 Fut: 'static + Send + Future<Output = bool>,
1722 {
1723 if let Some(observer) = self.update_observer.as_mut() {
1724 *observer.resume_updates.borrow_mut() = ();
1725 return;
1726 }
1727
1728 let (resume_updates_tx, mut resume_updates_rx) = watch::channel::<()>();
1729 let (snapshots_tx, mut snapshots_rx) =
1730 mpsc::unbounded::<(LocalSnapshot, UpdatedEntriesSet)>();
1731 snapshots_tx
1732 .unbounded_send((self.snapshot(), Arc::default()))
1733 .ok();
1734
1735 let worktree_id = cx.entity_id().as_u64();
1736 let _maintain_remote_snapshot = cx.background_spawn(async move {
1737 let mut is_first = true;
1738 while let Some((snapshot, entry_changes)) = snapshots_rx.next().await {
1739 let update = if is_first {
1740 is_first = false;
1741 snapshot.build_initial_update(project_id, worktree_id)
1742 } else {
1743 snapshot.build_update(project_id, worktree_id, entry_changes)
1744 };
1745
1746 for update in proto::split_worktree_update(update) {
1747 let _ = resume_updates_rx.try_recv();
1748 loop {
1749 let result = callback(update.clone());
1750 if result.await {
1751 break;
1752 } else {
1753 log::info!("waiting to resume updates");
1754 if resume_updates_rx.next().await.is_none() {
1755 return Some(());
1756 }
1757 }
1758 }
1759 }
1760 }
1761 Some(())
1762 });
1763
1764 self.update_observer = Some(UpdateObservationState {
1765 snapshots_tx,
1766 resume_updates: resume_updates_tx,
1767 _maintain_remote_snapshot,
1768 });
1769 }
1770
1771 pub fn share_private_files(&mut self, cx: &Context<Worktree>) {
1772 self.share_private_files = true;
1773 self.restart_background_scanners(cx);
1774 }
1775
1776 pub fn update_abs_path_and_refresh(
1777 &mut self,
1778 new_path: Arc<SanitizedPath>,
1779 cx: &Context<Worktree>,
1780 ) {
1781 self.snapshot.git_repositories = Default::default();
1782 self.snapshot.ignores_by_parent_abs_path = Default::default();
1783 let root_name = new_path
1784 .as_path()
1785 .file_name()
1786 .and_then(|f| f.to_str())
1787 .map_or(RelPath::empty().into(), |f| {
1788 RelPath::unix(f).unwrap().into()
1789 });
1790 self.snapshot.update_abs_path(new_path, root_name);
1791 self.restart_background_scanners(cx);
1792 }
1793}
1794
1795impl RemoteWorktree {
1796 pub fn project_id(&self) -> u64 {
1797 self.project_id
1798 }
1799
1800 pub fn client(&self) -> AnyProtoClient {
1801 self.client.clone()
1802 }
1803
1804 pub fn disconnected_from_host(&mut self) {
1805 self.updates_tx.take();
1806 self.snapshot_subscriptions.clear();
1807 self.disconnected = true;
1808 }
1809
1810 pub fn update_from_remote(&self, update: proto::UpdateWorktree) {
1811 if let Some(updates_tx) = &self.updates_tx {
1812 updates_tx
1813 .unbounded_send(update)
1814 .expect("consumer runs to completion");
1815 }
1816 }
1817
1818 fn observe_updates<F, Fut>(&mut self, project_id: u64, cx: &Context<Worktree>, callback: F)
1819 where
1820 F: 'static + Send + Fn(proto::UpdateWorktree) -> Fut,
1821 Fut: 'static + Send + Future<Output = bool>,
1822 {
1823 let (tx, mut rx) = mpsc::unbounded();
1824 let initial_update = self
1825 .snapshot
1826 .build_initial_update(project_id, self.id().to_proto());
1827 self.update_observer = Some(tx);
1828 cx.spawn(async move |this, cx| {
1829 let mut update = initial_update;
1830 'outer: loop {
1831 // SSH projects use a special project ID of 0, and we need to
1832 // remap it to the correct one here.
1833 update.project_id = project_id;
1834
1835 for chunk in split_worktree_update(update) {
1836 if !callback(chunk).await {
1837 break 'outer;
1838 }
1839 }
1840
1841 if let Some(next_update) = rx.next().await {
1842 update = next_update;
1843 } else {
1844 break;
1845 }
1846 }
1847 this.update(cx, |this, _| {
1848 let this = this.as_remote_mut().unwrap();
1849 this.update_observer.take();
1850 })
1851 })
1852 .detach();
1853 }
1854
1855 fn observed_snapshot(&self, scan_id: usize) -> bool {
1856 self.completed_scan_id >= scan_id
1857 }
1858
1859 pub fn wait_for_snapshot(
1860 &mut self,
1861 scan_id: usize,
1862 ) -> impl Future<Output = Result<()>> + use<> {
1863 let (tx, rx) = oneshot::channel();
1864 if self.observed_snapshot(scan_id) {
1865 let _ = tx.send(());
1866 } else if self.disconnected {
1867 drop(tx);
1868 } else {
1869 match self
1870 .snapshot_subscriptions
1871 .binary_search_by_key(&scan_id, |probe| probe.0)
1872 {
1873 Ok(ix) | Err(ix) => self.snapshot_subscriptions.insert(ix, (scan_id, tx)),
1874 }
1875 }
1876
1877 async move {
1878 rx.await?;
1879 Ok(())
1880 }
1881 }
1882
1883 pub fn insert_entry(
1884 &mut self,
1885 entry: proto::Entry,
1886 scan_id: usize,
1887 cx: &Context<Worktree>,
1888 ) -> Task<Result<Entry>> {
1889 let wait_for_snapshot = self.wait_for_snapshot(scan_id);
1890 cx.spawn(async move |this, cx| {
1891 wait_for_snapshot.await?;
1892 this.update(cx, |worktree, _| {
1893 let worktree = worktree.as_remote_mut().unwrap();
1894 let snapshot = &mut worktree.background_snapshot.lock().0;
1895 let entry = snapshot.insert_entry(entry, &worktree.file_scan_inclusions);
1896 worktree.snapshot = snapshot.clone();
1897 entry
1898 })?
1899 })
1900 }
1901
1902 fn delete_entry(
1903 &self,
1904 entry_id: ProjectEntryId,
1905 trash: bool,
1906 cx: &Context<Worktree>,
1907 ) -> Option<Task<Result<()>>> {
1908 let response = self.client.request(proto::DeleteProjectEntry {
1909 project_id: self.project_id,
1910 entry_id: entry_id.to_proto(),
1911 use_trash: trash,
1912 });
1913 Some(cx.spawn(async move |this, cx| {
1914 let response = response.await?;
1915 let scan_id = response.worktree_scan_id as usize;
1916
1917 this.update(cx, move |this, _| {
1918 this.as_remote_mut().unwrap().wait_for_snapshot(scan_id)
1919 })?
1920 .await?;
1921
1922 this.update(cx, |this, _| {
1923 let this = this.as_remote_mut().unwrap();
1924 let snapshot = &mut this.background_snapshot.lock().0;
1925 snapshot.delete_entry(entry_id);
1926 this.snapshot = snapshot.clone();
1927 })
1928 }))
1929 }
1930
1931 // fn rename_entry(
1932 // &self,
1933 // entry_id: ProjectEntryId,
1934 // new_path: impl Into<Arc<RelPath>>,
1935 // cx: &Context<Worktree>,
1936 // ) -> Task<Result<CreatedEntry>> {
1937 // let new_path: Arc<RelPath> = new_path.into();
1938 // let response = self.client.request(proto::RenameProjectEntry {
1939 // project_id: self.project_id,
1940 // entry_id: entry_id.to_proto(),
1941 // new_worktree_id: new_path.worktree_id,
1942 // new_path: new_path.as_ref().to_proto(),
1943 // });
1944 // cx.spawn(async move |this, cx| {
1945 // let response = response.await?;
1946 // match response.entry {
1947 // Some(entry) => this
1948 // .update(cx, |this, cx| {
1949 // this.as_remote_mut().unwrap().insert_entry(
1950 // entry,
1951 // response.worktree_scan_id as usize,
1952 // cx,
1953 // )
1954 // })?
1955 // .await
1956 // .map(CreatedEntry::Included),
1957 // None => {
1958 // let abs_path =
1959 // this.read_with(cx, |worktree, _| worktree.absolutize(&new_path))?;
1960 // Ok(CreatedEntry::Excluded { abs_path })
1961 // }
1962 // }
1963 // })
1964 // }
1965
1966 fn copy_external_entries(
1967 &self,
1968 target_directory: Arc<RelPath>,
1969 paths_to_copy: Vec<Arc<Path>>,
1970 local_fs: Arc<dyn Fs>,
1971 cx: &Context<Worktree>,
1972 ) -> Task<anyhow::Result<Vec<ProjectEntryId>>> {
1973 let client = self.client.clone();
1974 let worktree_id = self.id().to_proto();
1975 let project_id = self.project_id;
1976
1977 cx.background_spawn(async move {
1978 let mut requests = Vec::new();
1979 for root_path_to_copy in paths_to_copy {
1980 let Some(filename) = root_path_to_copy
1981 .file_name()
1982 .and_then(|name| name.to_str())
1983 .and_then(|filename| RelPath::unix(filename).ok())
1984 else {
1985 continue;
1986 };
1987 for (abs_path, is_directory) in
1988 read_dir_items(local_fs.as_ref(), &root_path_to_copy).await?
1989 {
1990 let Some(relative_path) = abs_path
1991 .strip_prefix(&root_path_to_copy)
1992 .map_err(|e| anyhow::Error::from(e))
1993 .and_then(|relative_path| RelPath::new(relative_path, PathStyle::local()))
1994 .log_err()
1995 else {
1996 continue;
1997 };
1998 let content = if is_directory {
1999 None
2000 } else {
2001 Some(local_fs.load_bytes(&abs_path).await?)
2002 };
2003
2004 let mut target_path = target_directory.join(filename);
2005 if relative_path.file_name().is_some() {
2006 target_path = target_path.join(&relative_path);
2007 }
2008
2009 requests.push(proto::CreateProjectEntry {
2010 project_id,
2011 worktree_id,
2012 path: target_path.to_proto(),
2013 is_directory,
2014 content,
2015 });
2016 }
2017 }
2018 requests.sort_unstable_by(|a, b| a.path.cmp(&b.path));
2019 requests.dedup();
2020
2021 let mut copied_entry_ids = Vec::new();
2022 for request in requests {
2023 let response = client.request(request).await?;
2024 copied_entry_ids.extend(response.entry.map(|e| ProjectEntryId::from_proto(e.id)));
2025 }
2026
2027 Ok(copied_entry_ids)
2028 })
2029 }
2030}
2031
2032impl Snapshot {
2033 pub fn new(
2034 id: u64,
2035 root_name: Arc<RelPath>,
2036 abs_path: Arc<Path>,
2037 path_style: PathStyle,
2038 ) -> Self {
2039 Snapshot {
2040 id: WorktreeId::from_usize(id as usize),
2041 abs_path: SanitizedPath::from_arc(abs_path),
2042 path_style,
2043 root_char_bag: root_name
2044 .as_unix_str()
2045 .chars()
2046 .map(|c| c.to_ascii_lowercase())
2047 .collect(),
2048 root_name,
2049 always_included_entries: Default::default(),
2050 entries_by_path: Default::default(),
2051 entries_by_id: Default::default(),
2052 scan_id: 1,
2053 completed_scan_id: 0,
2054 }
2055 }
2056
2057 pub fn id(&self) -> WorktreeId {
2058 self.id
2059 }
2060
2061 // TODO:
2062 // Consider the following:
2063 //
2064 // ```rust
2065 // let abs_path: Arc<Path> = snapshot.abs_path(); // e.g. "C:\Users\user\Desktop\project"
2066 // let some_non_trimmed_path = Path::new("\\\\?\\C:\\Users\\user\\Desktop\\project\\main.rs");
2067 // // The caller perform some actions here:
2068 // some_non_trimmed_path.strip_prefix(abs_path); // This fails
2069 // some_non_trimmed_path.starts_with(abs_path); // This fails too
2070 // ```
2071 //
2072 // This is definitely a bug, but it's not clear if we should handle it here or not.
2073 pub fn abs_path(&self) -> &Arc<Path> {
2074 SanitizedPath::cast_arc_ref(&self.abs_path)
2075 }
2076
2077 fn build_initial_update(&self, project_id: u64, worktree_id: u64) -> proto::UpdateWorktree {
2078 let mut updated_entries = self
2079 .entries_by_path
2080 .iter()
2081 .map(proto::Entry::from)
2082 .collect::<Vec<_>>();
2083 updated_entries.sort_unstable_by_key(|e| e.id);
2084
2085 proto::UpdateWorktree {
2086 project_id,
2087 worktree_id,
2088 abs_path: self.abs_path().to_string_lossy().into_owned(),
2089 root_name: self.root_name().to_proto(),
2090 updated_entries,
2091 removed_entries: Vec::new(),
2092 scan_id: self.scan_id as u64,
2093 is_last_update: self.completed_scan_id == self.scan_id,
2094 // Sent in separate messages.
2095 updated_repositories: Vec::new(),
2096 removed_repositories: Vec::new(),
2097 }
2098 }
2099
2100 pub fn work_directory_abs_path(&self, work_directory: &WorkDirectory) -> PathBuf {
2101 match work_directory {
2102 WorkDirectory::InProject { relative_path } => self.absolutize(relative_path),
2103 WorkDirectory::AboveProject { absolute_path, .. } => absolute_path.as_ref().to_owned(),
2104 }
2105 }
2106
2107 pub fn absolutize(&self, path: &RelPath) -> PathBuf {
2108 if path.file_name().is_some() {
2109 let mut abs_path = self.abs_path.to_string();
2110 for component in path.components() {
2111 if !abs_path.ends_with(self.path_style.separator()) {
2112 abs_path.push_str(self.path_style.separator());
2113 }
2114 abs_path.push_str(component);
2115 }
2116 PathBuf::from(abs_path)
2117 } else {
2118 self.abs_path.as_path().to_path_buf()
2119 }
2120 }
2121
2122 pub fn contains_entry(&self, entry_id: ProjectEntryId) -> bool {
2123 self.entries_by_id.get(&entry_id, ()).is_some()
2124 }
2125
2126 fn insert_entry(
2127 &mut self,
2128 entry: proto::Entry,
2129 always_included_paths: &PathMatcher,
2130 ) -> Result<Entry> {
2131 let entry = Entry::try_from((&self.root_char_bag, always_included_paths, entry))?;
2132 let old_entry = self.entries_by_id.insert_or_replace(
2133 PathEntry {
2134 id: entry.id,
2135 path: entry.path.clone(),
2136 is_ignored: entry.is_ignored,
2137 scan_id: 0,
2138 },
2139 (),
2140 );
2141 if let Some(old_entry) = old_entry {
2142 self.entries_by_path.remove(&PathKey(old_entry.path), ());
2143 }
2144 self.entries_by_path.insert_or_replace(entry.clone(), ());
2145 Ok(entry)
2146 }
2147
2148 fn delete_entry(&mut self, entry_id: ProjectEntryId) -> Option<Arc<RelPath>> {
2149 let removed_entry = self.entries_by_id.remove(&entry_id, ())?;
2150 self.entries_by_path = {
2151 let mut cursor = self.entries_by_path.cursor::<TraversalProgress>(());
2152 let mut new_entries_by_path =
2153 cursor.slice(&TraversalTarget::path(&removed_entry.path), Bias::Left);
2154 while let Some(entry) = cursor.item() {
2155 if entry.path.starts_with(&removed_entry.path) {
2156 self.entries_by_id.remove(&entry.id, ());
2157 cursor.next();
2158 } else {
2159 break;
2160 }
2161 }
2162 new_entries_by_path.append(cursor.suffix(), ());
2163 new_entries_by_path
2164 };
2165
2166 Some(removed_entry.path)
2167 }
2168
2169 fn update_abs_path(&mut self, abs_path: Arc<SanitizedPath>, root_name: Arc<RelPath>) {
2170 self.abs_path = abs_path;
2171 if root_name != self.root_name {
2172 self.root_char_bag = root_name
2173 .as_unix_str()
2174 .chars()
2175 .map(|c| c.to_ascii_lowercase())
2176 .collect();
2177 self.root_name = root_name;
2178 }
2179 }
2180
2181 fn apply_remote_update(
2182 &mut self,
2183 update: proto::UpdateWorktree,
2184 always_included_paths: &PathMatcher,
2185 ) {
2186 log::debug!(
2187 "applying remote worktree update. {} entries updated, {} removed",
2188 update.updated_entries.len(),
2189 update.removed_entries.len()
2190 );
2191 if let Some(root_name) = RelPath::from_proto(&update.root_name).log_err() {
2192 self.update_abs_path(
2193 SanitizedPath::new_arc(&Path::new(&update.abs_path)),
2194 root_name,
2195 );
2196 }
2197
2198 let mut entries_by_path_edits = Vec::new();
2199 let mut entries_by_id_edits = Vec::new();
2200
2201 for entry_id in update.removed_entries {
2202 let entry_id = ProjectEntryId::from_proto(entry_id);
2203 entries_by_id_edits.push(Edit::Remove(entry_id));
2204 if let Some(entry) = self.entry_for_id(entry_id) {
2205 entries_by_path_edits.push(Edit::Remove(PathKey(entry.path.clone())));
2206 }
2207 }
2208
2209 for entry in update.updated_entries {
2210 let Some(entry) =
2211 Entry::try_from((&self.root_char_bag, always_included_paths, entry)).log_err()
2212 else {
2213 continue;
2214 };
2215 if let Some(PathEntry { path, .. }) = self.entries_by_id.get(&entry.id, ()) {
2216 entries_by_path_edits.push(Edit::Remove(PathKey(path.clone())));
2217 }
2218 if let Some(old_entry) = self.entries_by_path.get(&PathKey(entry.path.clone()), ())
2219 && old_entry.id != entry.id
2220 {
2221 entries_by_id_edits.push(Edit::Remove(old_entry.id));
2222 }
2223 entries_by_id_edits.push(Edit::Insert(PathEntry {
2224 id: entry.id,
2225 path: entry.path.clone(),
2226 is_ignored: entry.is_ignored,
2227 scan_id: 0,
2228 }));
2229 entries_by_path_edits.push(Edit::Insert(entry));
2230 }
2231
2232 self.entries_by_path.edit(entries_by_path_edits, ());
2233 self.entries_by_id.edit(entries_by_id_edits, ());
2234
2235 self.scan_id = update.scan_id as usize;
2236 if update.is_last_update {
2237 self.completed_scan_id = update.scan_id as usize;
2238 }
2239 }
2240
2241 pub fn entry_count(&self) -> usize {
2242 self.entries_by_path.summary().count
2243 }
2244
2245 pub fn visible_entry_count(&self) -> usize {
2246 self.entries_by_path.summary().non_ignored_count
2247 }
2248
2249 pub fn dir_count(&self) -> usize {
2250 let summary = self.entries_by_path.summary();
2251 summary.count - summary.file_count
2252 }
2253
2254 pub fn visible_dir_count(&self) -> usize {
2255 let summary = self.entries_by_path.summary();
2256 summary.non_ignored_count - summary.non_ignored_file_count
2257 }
2258
2259 pub fn file_count(&self) -> usize {
2260 self.entries_by_path.summary().file_count
2261 }
2262
2263 pub fn visible_file_count(&self) -> usize {
2264 self.entries_by_path.summary().non_ignored_file_count
2265 }
2266
2267 fn traverse_from_offset(
2268 &self,
2269 include_files: bool,
2270 include_dirs: bool,
2271 include_ignored: bool,
2272 start_offset: usize,
2273 ) -> Traversal<'_> {
2274 let mut cursor = self.entries_by_path.cursor(());
2275 cursor.seek(
2276 &TraversalTarget::Count {
2277 count: start_offset,
2278 include_files,
2279 include_dirs,
2280 include_ignored,
2281 },
2282 Bias::Right,
2283 );
2284 Traversal {
2285 snapshot: self,
2286 cursor,
2287 include_files,
2288 include_dirs,
2289 include_ignored,
2290 }
2291 }
2292
2293 pub fn traverse_from_path(
2294 &self,
2295 include_files: bool,
2296 include_dirs: bool,
2297 include_ignored: bool,
2298 path: &RelPath,
2299 ) -> Traversal<'_> {
2300 Traversal::new(self, include_files, include_dirs, include_ignored, path)
2301 }
2302
2303 pub fn files(&self, include_ignored: bool, start: usize) -> Traversal<'_> {
2304 self.traverse_from_offset(true, false, include_ignored, start)
2305 }
2306
2307 pub fn directories(&self, include_ignored: bool, start: usize) -> Traversal<'_> {
2308 self.traverse_from_offset(false, true, include_ignored, start)
2309 }
2310
2311 pub fn entries(&self, include_ignored: bool, start: usize) -> Traversal<'_> {
2312 self.traverse_from_offset(true, true, include_ignored, start)
2313 }
2314
2315 pub fn paths(&self) -> impl Iterator<Item = &RelPath> {
2316 self.entries_by_path
2317 .cursor::<()>(())
2318 .filter(move |entry| !entry.path.is_empty())
2319 .map(|entry| entry.path.as_ref())
2320 }
2321
2322 pub fn child_entries<'a>(&'a self, parent_path: &'a RelPath) -> ChildEntriesIter<'a> {
2323 let options = ChildEntriesOptions {
2324 include_files: true,
2325 include_dirs: true,
2326 include_ignored: true,
2327 };
2328 self.child_entries_with_options(parent_path, options)
2329 }
2330
2331 pub fn child_entries_with_options<'a>(
2332 &'a self,
2333 parent_path: &'a RelPath,
2334 options: ChildEntriesOptions,
2335 ) -> ChildEntriesIter<'a> {
2336 let mut cursor = self.entries_by_path.cursor(());
2337 cursor.seek(&TraversalTarget::path(parent_path), Bias::Right);
2338 let traversal = Traversal {
2339 snapshot: self,
2340 cursor,
2341 include_files: options.include_files,
2342 include_dirs: options.include_dirs,
2343 include_ignored: options.include_ignored,
2344 };
2345 ChildEntriesIter {
2346 traversal,
2347 parent_path,
2348 }
2349 }
2350
2351 pub fn root_entry(&self) -> Option<&Entry> {
2352 self.entries_by_path.first()
2353 }
2354
2355 /// Returns `None` for a single file worktree, or `Some(self.abs_path())` if
2356 /// it is a directory.
2357 pub fn root_dir(&self) -> Option<Arc<Path>> {
2358 self.root_entry()
2359 .filter(|entry| entry.is_dir())
2360 .map(|_| self.abs_path().clone())
2361 }
2362
2363 pub fn root_name(&self) -> &RelPath {
2364 &self.root_name
2365 }
2366
2367 pub fn root_name_str(&self) -> &str {
2368 self.root_name.as_unix_str()
2369 }
2370
2371 pub fn scan_id(&self) -> usize {
2372 self.scan_id
2373 }
2374
2375 pub fn entry_for_path(&self, path: &RelPath) -> Option<&Entry> {
2376 self.traverse_from_path(true, true, true, path)
2377 .entry()
2378 .and_then(|entry| {
2379 if entry.path.as_ref() == path {
2380 Some(entry)
2381 } else {
2382 None
2383 }
2384 })
2385 }
2386
2387 /// Resolves a path to an executable using the following heuristics:
2388 ///
2389 /// 1. If the path is relative and contains more than one component,
2390 /// it is joined to the worktree root path.
2391 /// 2. If the path is relative and exists in the worktree
2392 /// (even if falls under an exclusion filter),
2393 /// it is joined to the worktree root path.
2394 /// 3. Otherwise the path is returned unmodified.
2395 ///
2396 /// Relative paths that do not exist in the worktree may
2397 /// still be found using the `PATH` environment variable.
2398 pub fn resolve_executable_path(&self, path: PathBuf) -> PathBuf {
2399 if let Ok(rel_path) = RelPath::new(&path, self.path_style)
2400 && (path.components().count() > 1 || self.entry_for_path(&rel_path).is_some())
2401 {
2402 self.abs_path().join(path)
2403 } else {
2404 path
2405 }
2406 }
2407
2408 pub fn entry_for_id(&self, id: ProjectEntryId) -> Option<&Entry> {
2409 let entry = self.entries_by_id.get(&id, ())?;
2410 self.entry_for_path(&entry.path)
2411 }
2412
2413 pub fn path_style(&self) -> PathStyle {
2414 self.path_style
2415 }
2416}
2417
2418impl LocalSnapshot {
2419 fn local_repo_for_work_directory_path(&self, path: &RelPath) -> Option<&LocalRepositoryEntry> {
2420 self.git_repositories
2421 .iter()
2422 .map(|(_, entry)| entry)
2423 .find(|entry| entry.work_directory.path_key() == PathKey(path.into()))
2424 }
2425
2426 fn build_update(
2427 &self,
2428 project_id: u64,
2429 worktree_id: u64,
2430 entry_changes: UpdatedEntriesSet,
2431 ) -> proto::UpdateWorktree {
2432 let mut updated_entries = Vec::new();
2433 let mut removed_entries = Vec::new();
2434
2435 for (_, entry_id, path_change) in entry_changes.iter() {
2436 if let PathChange::Removed = path_change {
2437 removed_entries.push(entry_id.0 as u64);
2438 } else if let Some(entry) = self.entry_for_id(*entry_id) {
2439 updated_entries.push(proto::Entry::from(entry));
2440 }
2441 }
2442
2443 removed_entries.sort_unstable();
2444 updated_entries.sort_unstable_by_key(|e| e.id);
2445
2446 // TODO - optimize, knowing that removed_entries are sorted.
2447 removed_entries.retain(|id| updated_entries.binary_search_by_key(id, |e| e.id).is_err());
2448
2449 proto::UpdateWorktree {
2450 project_id,
2451 worktree_id,
2452 abs_path: self.abs_path().to_string_lossy().into_owned(),
2453 root_name: self.root_name().to_proto(),
2454 updated_entries,
2455 removed_entries,
2456 scan_id: self.scan_id as u64,
2457 is_last_update: self.completed_scan_id == self.scan_id,
2458 // Sent in separate messages.
2459 updated_repositories: Vec::new(),
2460 removed_repositories: Vec::new(),
2461 }
2462 }
2463
2464 fn insert_entry(&mut self, mut entry: Entry, fs: &dyn Fs) -> Entry {
2465 log::trace!("insert entry {:?}", entry.path);
2466 if entry.is_file() && entry.path.file_name() == Some(&GITIGNORE) {
2467 let abs_path = self.absolutize(&entry.path);
2468 match self.executor.block(build_gitignore(&abs_path, fs)) {
2469 Ok(ignore) => {
2470 self.ignores_by_parent_abs_path
2471 .insert(abs_path.parent().unwrap().into(), (Arc::new(ignore), true));
2472 }
2473 Err(error) => {
2474 log::error!(
2475 "error loading .gitignore file {:?} - {:?}",
2476 &entry.path,
2477 error
2478 );
2479 }
2480 }
2481 }
2482
2483 if entry.kind == EntryKind::PendingDir
2484 && let Some(existing_entry) = self.entries_by_path.get(&PathKey(entry.path.clone()), ())
2485 {
2486 entry.kind = existing_entry.kind;
2487 }
2488
2489 let scan_id = self.scan_id;
2490 let removed = self.entries_by_path.insert_or_replace(entry.clone(), ());
2491 if let Some(removed) = removed
2492 && removed.id != entry.id
2493 {
2494 self.entries_by_id.remove(&removed.id, ());
2495 }
2496 self.entries_by_id.insert_or_replace(
2497 PathEntry {
2498 id: entry.id,
2499 path: entry.path.clone(),
2500 is_ignored: entry.is_ignored,
2501 scan_id,
2502 },
2503 (),
2504 );
2505
2506 entry
2507 }
2508
2509 fn ancestor_inodes_for_path(&self, path: &RelPath) -> TreeSet<u64> {
2510 let mut inodes = TreeSet::default();
2511 for ancestor in path.ancestors().skip(1) {
2512 if let Some(entry) = self.entry_for_path(ancestor) {
2513 inodes.insert(entry.inode);
2514 }
2515 }
2516 inodes
2517 }
2518
2519 async fn ignore_stack_for_abs_path(
2520 &self,
2521 abs_path: &Path,
2522 is_dir: bool,
2523 fs: &dyn Fs,
2524 ) -> IgnoreStack {
2525 let mut new_ignores = Vec::new();
2526 let mut repo_root = None;
2527 for (index, ancestor) in abs_path.ancestors().enumerate() {
2528 if index > 0 {
2529 if let Some((ignore, _)) = self.ignores_by_parent_abs_path.get(ancestor) {
2530 new_ignores.push((ancestor, Some(ignore.clone())));
2531 } else {
2532 new_ignores.push((ancestor, None));
2533 }
2534 }
2535
2536 let metadata = fs.metadata(&ancestor.join(DOT_GIT)).await.ok().flatten();
2537 if metadata.is_some() {
2538 repo_root = Some(Arc::from(ancestor));
2539 break;
2540 }
2541 }
2542
2543 let mut ignore_stack = if let Some(global_gitignore) = self.global_gitignore.clone() {
2544 IgnoreStack::global(global_gitignore)
2545 } else {
2546 IgnoreStack::none()
2547 };
2548 ignore_stack.repo_root = repo_root;
2549 for (parent_abs_path, ignore) in new_ignores.into_iter().rev() {
2550 if ignore_stack.is_abs_path_ignored(parent_abs_path, true) {
2551 ignore_stack = IgnoreStack::all();
2552 break;
2553 } else if let Some(ignore) = ignore {
2554 ignore_stack = ignore_stack.append(parent_abs_path.into(), ignore);
2555 }
2556 }
2557
2558 if ignore_stack.is_abs_path_ignored(abs_path, is_dir) {
2559 ignore_stack = IgnoreStack::all();
2560 }
2561
2562 ignore_stack
2563 }
2564
2565 #[cfg(test)]
2566 fn expanded_entries(&self) -> impl Iterator<Item = &Entry> {
2567 self.entries_by_path
2568 .cursor::<()>(())
2569 .filter(|entry| entry.kind == EntryKind::Dir && (entry.is_external || entry.is_ignored))
2570 }
2571
2572 #[cfg(test)]
2573 pub fn check_invariants(&self, git_state: bool) {
2574 use pretty_assertions::assert_eq;
2575
2576 assert_eq!(
2577 self.entries_by_path
2578 .cursor::<()>(())
2579 .map(|e| (&e.path, e.id))
2580 .collect::<Vec<_>>(),
2581 self.entries_by_id
2582 .cursor::<()>(())
2583 .map(|e| (&e.path, e.id))
2584 .collect::<collections::BTreeSet<_>>()
2585 .into_iter()
2586 .collect::<Vec<_>>(),
2587 "entries_by_path and entries_by_id are inconsistent"
2588 );
2589
2590 let mut files = self.files(true, 0);
2591 let mut visible_files = self.files(false, 0);
2592 for entry in self.entries_by_path.cursor::<()>(()) {
2593 if entry.is_file() {
2594 assert_eq!(files.next().unwrap().inode, entry.inode);
2595 if (!entry.is_ignored && !entry.is_external) || entry.is_always_included {
2596 assert_eq!(visible_files.next().unwrap().inode, entry.inode);
2597 }
2598 }
2599 }
2600
2601 assert!(files.next().is_none());
2602 assert!(visible_files.next().is_none());
2603
2604 let mut bfs_paths = Vec::new();
2605 let mut stack = self
2606 .root_entry()
2607 .map(|e| e.path.as_ref())
2608 .into_iter()
2609 .collect::<Vec<_>>();
2610 while let Some(path) = stack.pop() {
2611 bfs_paths.push(path);
2612 let ix = stack.len();
2613 for child_entry in self.child_entries(path) {
2614 stack.insert(ix, &child_entry.path);
2615 }
2616 }
2617
2618 let dfs_paths_via_iter = self
2619 .entries_by_path
2620 .cursor::<()>(())
2621 .map(|e| e.path.as_ref())
2622 .collect::<Vec<_>>();
2623 assert_eq!(bfs_paths, dfs_paths_via_iter);
2624
2625 let dfs_paths_via_traversal = self
2626 .entries(true, 0)
2627 .map(|e| e.path.as_ref())
2628 .collect::<Vec<_>>();
2629
2630 assert_eq!(dfs_paths_via_traversal, dfs_paths_via_iter);
2631
2632 if git_state {
2633 for ignore_parent_abs_path in self.ignores_by_parent_abs_path.keys() {
2634 let ignore_parent_path = &RelPath::new(
2635 ignore_parent_abs_path
2636 .strip_prefix(self.abs_path.as_path())
2637 .unwrap(),
2638 PathStyle::local(),
2639 )
2640 .unwrap();
2641 assert!(self.entry_for_path(ignore_parent_path).is_some());
2642 assert!(
2643 self.entry_for_path(
2644 &ignore_parent_path.join(RelPath::unix(GITIGNORE).unwrap())
2645 )
2646 .is_some()
2647 );
2648 }
2649 }
2650 }
2651
2652 #[cfg(test)]
2653 pub fn entries_without_ids(&self, include_ignored: bool) -> Vec<(&RelPath, u64, bool)> {
2654 let mut paths = Vec::new();
2655 for entry in self.entries_by_path.cursor::<()>(()) {
2656 if include_ignored || !entry.is_ignored {
2657 paths.push((entry.path.as_ref(), entry.inode, entry.is_ignored));
2658 }
2659 }
2660 paths.sort_by(|a, b| a.0.cmp(b.0));
2661 paths
2662 }
2663}
2664
2665impl BackgroundScannerState {
2666 fn should_scan_directory(&self, entry: &Entry) -> bool {
2667 (!entry.is_external && (!entry.is_ignored || entry.is_always_included))
2668 || entry.path.file_name() == Some(DOT_GIT)
2669 || entry.path.file_name() == Some(local_settings_folder_name())
2670 || entry.path.file_name() == Some(local_vscode_folder_name())
2671 || self.scanned_dirs.contains(&entry.id) // If we've ever scanned it, keep scanning
2672 || self
2673 .paths_to_scan
2674 .iter()
2675 .any(|p| p.starts_with(&entry.path))
2676 || self
2677 .path_prefixes_to_scan
2678 .iter()
2679 .any(|p| entry.path.starts_with(p))
2680 }
2681
2682 async fn enqueue_scan_dir(
2683 &self,
2684 abs_path: Arc<Path>,
2685 entry: &Entry,
2686 scan_job_tx: &Sender<ScanJob>,
2687 fs: &dyn Fs,
2688 ) {
2689 let path = entry.path.clone();
2690 let ignore_stack = self
2691 .snapshot
2692 .ignore_stack_for_abs_path(&abs_path, true, fs)
2693 .await;
2694 let mut ancestor_inodes = self.snapshot.ancestor_inodes_for_path(&path);
2695
2696 if !ancestor_inodes.contains(&entry.inode) {
2697 ancestor_inodes.insert(entry.inode);
2698 scan_job_tx
2699 .try_send(ScanJob {
2700 abs_path,
2701 path,
2702 ignore_stack,
2703 scan_queue: scan_job_tx.clone(),
2704 ancestor_inodes,
2705 is_external: entry.is_external,
2706 })
2707 .unwrap();
2708 }
2709 }
2710
2711 fn reuse_entry_id(&mut self, entry: &mut Entry) {
2712 if let Some(mtime) = entry.mtime {
2713 // If an entry with the same inode was removed from the worktree during this scan,
2714 // then it *might* represent the same file or directory. But the OS might also have
2715 // re-used the inode for a completely different file or directory.
2716 //
2717 // Conditionally reuse the old entry's id:
2718 // * if the mtime is the same, the file was probably been renamed.
2719 // * if the path is the same, the file may just have been updated
2720 if let Some(removed_entry) = self.removed_entries.remove(&entry.inode) {
2721 if removed_entry.mtime == Some(mtime) || removed_entry.path == entry.path {
2722 entry.id = removed_entry.id;
2723 }
2724 } else if let Some(existing_entry) = self.snapshot.entry_for_path(&entry.path) {
2725 entry.id = existing_entry.id;
2726 }
2727 }
2728 }
2729
2730 async fn insert_entry(
2731 &mut self,
2732 mut entry: Entry,
2733 fs: &dyn Fs,
2734 watcher: &dyn Watcher,
2735 ) -> Entry {
2736 self.reuse_entry_id(&mut entry);
2737 let entry = self.snapshot.insert_entry(entry, fs);
2738 if entry.path.file_name() == Some(&DOT_GIT) {
2739 self.insert_git_repository(entry.path.clone(), fs, watcher)
2740 .await;
2741 }
2742
2743 #[cfg(test)]
2744 self.snapshot.check_invariants(false);
2745
2746 entry
2747 }
2748
2749 fn populate_dir(
2750 &mut self,
2751 parent_path: Arc<RelPath>,
2752 entries: impl IntoIterator<Item = Entry>,
2753 ignore: Option<Arc<Gitignore>>,
2754 ) {
2755 let mut parent_entry = if let Some(parent_entry) = self
2756 .snapshot
2757 .entries_by_path
2758 .get(&PathKey(parent_path.clone()), ())
2759 {
2760 parent_entry.clone()
2761 } else {
2762 log::warn!(
2763 "populating a directory {:?} that has been removed",
2764 parent_path
2765 );
2766 return;
2767 };
2768
2769 match parent_entry.kind {
2770 EntryKind::PendingDir | EntryKind::UnloadedDir => parent_entry.kind = EntryKind::Dir,
2771 EntryKind::Dir => {}
2772 _ => return,
2773 }
2774
2775 if let Some(ignore) = ignore {
2776 let abs_parent_path = self
2777 .snapshot
2778 .abs_path
2779 .as_path()
2780 .join(parent_path.as_std_path())
2781 .into();
2782 self.snapshot
2783 .ignores_by_parent_abs_path
2784 .insert(abs_parent_path, (ignore, false));
2785 }
2786
2787 let parent_entry_id = parent_entry.id;
2788 self.scanned_dirs.insert(parent_entry_id);
2789 let mut entries_by_path_edits = vec![Edit::Insert(parent_entry)];
2790 let mut entries_by_id_edits = Vec::new();
2791
2792 for entry in entries {
2793 entries_by_id_edits.push(Edit::Insert(PathEntry {
2794 id: entry.id,
2795 path: entry.path.clone(),
2796 is_ignored: entry.is_ignored,
2797 scan_id: self.snapshot.scan_id,
2798 }));
2799 entries_by_path_edits.push(Edit::Insert(entry));
2800 }
2801
2802 self.snapshot
2803 .entries_by_path
2804 .edit(entries_by_path_edits, ());
2805 self.snapshot.entries_by_id.edit(entries_by_id_edits, ());
2806
2807 if let Err(ix) = self.changed_paths.binary_search(&parent_path) {
2808 self.changed_paths.insert(ix, parent_path.clone());
2809 }
2810
2811 #[cfg(test)]
2812 self.snapshot.check_invariants(false);
2813 }
2814
2815 fn remove_path(&mut self, path: &RelPath) {
2816 log::trace!("background scanner removing path {path:?}");
2817 let mut new_entries;
2818 let removed_entries;
2819 {
2820 let mut cursor = self
2821 .snapshot
2822 .entries_by_path
2823 .cursor::<TraversalProgress>(());
2824 new_entries = cursor.slice(&TraversalTarget::path(path), Bias::Left);
2825 removed_entries = cursor.slice(&TraversalTarget::successor(path), Bias::Left);
2826 new_entries.append(cursor.suffix(), ());
2827 }
2828 self.snapshot.entries_by_path = new_entries;
2829
2830 let mut removed_ids = Vec::with_capacity(removed_entries.summary().count);
2831 for entry in removed_entries.cursor::<()>(()) {
2832 match self.removed_entries.entry(entry.inode) {
2833 hash_map::Entry::Occupied(mut e) => {
2834 let prev_removed_entry = e.get_mut();
2835 if entry.id > prev_removed_entry.id {
2836 *prev_removed_entry = entry.clone();
2837 }
2838 }
2839 hash_map::Entry::Vacant(e) => {
2840 e.insert(entry.clone());
2841 }
2842 }
2843
2844 if entry.path.file_name() == Some(GITIGNORE) {
2845 let abs_parent_path = self.snapshot.absolutize(&entry.path.parent().unwrap());
2846 if let Some((_, needs_update)) = self
2847 .snapshot
2848 .ignores_by_parent_abs_path
2849 .get_mut(abs_parent_path.as_path())
2850 {
2851 *needs_update = true;
2852 }
2853 }
2854
2855 if let Err(ix) = removed_ids.binary_search(&entry.id) {
2856 removed_ids.insert(ix, entry.id);
2857 }
2858 }
2859
2860 self.snapshot
2861 .entries_by_id
2862 .edit(removed_ids.iter().map(|&id| Edit::Remove(id)).collect(), ());
2863 self.snapshot
2864 .git_repositories
2865 .retain(|id, _| removed_ids.binary_search(id).is_err());
2866
2867 #[cfg(test)]
2868 self.snapshot.check_invariants(false);
2869 }
2870
2871 async fn insert_git_repository(
2872 &mut self,
2873 dot_git_path: Arc<RelPath>,
2874 fs: &dyn Fs,
2875 watcher: &dyn Watcher,
2876 ) {
2877 let work_dir_path: Arc<RelPath> = match dot_git_path.parent() {
2878 Some(parent_dir) => {
2879 // Guard against repositories inside the repository metadata
2880 if parent_dir
2881 .components()
2882 .any(|component| component == DOT_GIT)
2883 {
2884 log::debug!(
2885 "not building git repository for nested `.git` directory, `.git` path in the worktree: {dot_git_path:?}"
2886 );
2887 return;
2888 };
2889
2890 parent_dir.into()
2891 }
2892 None => {
2893 // `dot_git_path.parent().is_none()` means `.git` directory is the opened worktree itself,
2894 // no files inside that directory are tracked by git, so no need to build the repo around it
2895 log::debug!(
2896 "not building git repository for the worktree itself, `.git` path in the worktree: {dot_git_path:?}"
2897 );
2898 return;
2899 }
2900 };
2901
2902 let dot_git_abs_path = Arc::from(self.snapshot.absolutize(&dot_git_path).as_ref());
2903
2904 self.insert_git_repository_for_path(
2905 WorkDirectory::InProject {
2906 relative_path: work_dir_path,
2907 },
2908 dot_git_abs_path,
2909 fs,
2910 watcher,
2911 )
2912 .await
2913 .log_err();
2914 }
2915
2916 async fn insert_git_repository_for_path(
2917 &mut self,
2918 work_directory: WorkDirectory,
2919 dot_git_abs_path: Arc<Path>,
2920 fs: &dyn Fs,
2921 watcher: &dyn Watcher,
2922 ) -> Result<LocalRepositoryEntry> {
2923 let work_dir_entry = self
2924 .snapshot
2925 .entry_for_path(&work_directory.path_key().0)
2926 .with_context(|| {
2927 format!(
2928 "working directory `{}` not indexed",
2929 work_directory
2930 .path_key()
2931 .0
2932 .display(self.snapshot.path_style)
2933 )
2934 })?;
2935 let work_directory_abs_path = self.snapshot.work_directory_abs_path(&work_directory);
2936
2937 let (repository_dir_abs_path, common_dir_abs_path) =
2938 discover_git_paths(&dot_git_abs_path, fs).await;
2939 watcher
2940 .add(&common_dir_abs_path)
2941 .context("failed to add common directory to watcher")
2942 .log_err();
2943 if !repository_dir_abs_path.starts_with(&common_dir_abs_path) {
2944 watcher
2945 .add(&repository_dir_abs_path)
2946 .context("failed to add repository directory to watcher")
2947 .log_err();
2948 }
2949
2950 let work_directory_id = work_dir_entry.id;
2951
2952 let local_repository = LocalRepositoryEntry {
2953 work_directory_id,
2954 work_directory,
2955 work_directory_abs_path: work_directory_abs_path.as_path().into(),
2956 git_dir_scan_id: 0,
2957 dot_git_abs_path,
2958 common_dir_abs_path,
2959 repository_dir_abs_path,
2960 };
2961
2962 self.snapshot
2963 .git_repositories
2964 .insert(work_directory_id, local_repository.clone());
2965
2966 log::trace!("inserting new local git repository");
2967 Ok(local_repository)
2968 }
2969}
2970
2971async fn is_git_dir(path: &Path, fs: &dyn Fs) -> bool {
2972 if let Some(file_name) = path.file_name()
2973 && file_name == DOT_GIT
2974 {
2975 return true;
2976 }
2977
2978 // If we're in a bare repository, we are not inside a `.git` folder. In a
2979 // bare repository, the root folder contains what would normally be in the
2980 // `.git` folder.
2981 let head_metadata = fs.metadata(&path.join("HEAD")).await;
2982 if !matches!(head_metadata, Ok(Some(_))) {
2983 return false;
2984 }
2985 let config_metadata = fs.metadata(&path.join("config")).await;
2986 matches!(config_metadata, Ok(Some(_)))
2987}
2988
2989async fn build_gitignore(abs_path: &Path, fs: &dyn Fs) -> Result<Gitignore> {
2990 let contents = fs
2991 .load(abs_path)
2992 .await
2993 .with_context(|| format!("failed to load gitignore file at {}", abs_path.display()))?;
2994 let parent = abs_path.parent().unwrap_or_else(|| Path::new("/"));
2995 let mut builder = GitignoreBuilder::new(parent);
2996 for line in contents.lines() {
2997 builder.add_line(Some(abs_path.into()), line)?;
2998 }
2999 Ok(builder.build()?)
3000}
3001
3002impl Deref for Worktree {
3003 type Target = Snapshot;
3004
3005 fn deref(&self) -> &Self::Target {
3006 match self {
3007 Worktree::Local(worktree) => &worktree.snapshot,
3008 Worktree::Remote(worktree) => &worktree.snapshot,
3009 }
3010 }
3011}
3012
3013impl Deref for LocalWorktree {
3014 type Target = LocalSnapshot;
3015
3016 fn deref(&self) -> &Self::Target {
3017 &self.snapshot
3018 }
3019}
3020
3021impl Deref for RemoteWorktree {
3022 type Target = Snapshot;
3023
3024 fn deref(&self) -> &Self::Target {
3025 &self.snapshot
3026 }
3027}
3028
3029impl fmt::Debug for LocalWorktree {
3030 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
3031 self.snapshot.fmt(f)
3032 }
3033}
3034
3035impl fmt::Debug for Snapshot {
3036 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
3037 struct EntriesById<'a>(&'a SumTree<PathEntry>);
3038 struct EntriesByPath<'a>(&'a SumTree<Entry>);
3039
3040 impl fmt::Debug for EntriesByPath<'_> {
3041 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
3042 f.debug_map()
3043 .entries(self.0.iter().map(|entry| (&entry.path, entry.id)))
3044 .finish()
3045 }
3046 }
3047
3048 impl fmt::Debug for EntriesById<'_> {
3049 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
3050 f.debug_list().entries(self.0.iter()).finish()
3051 }
3052 }
3053
3054 f.debug_struct("Snapshot")
3055 .field("id", &self.id)
3056 .field("root_name", &self.root_name)
3057 .field("entries_by_path", &EntriesByPath(&self.entries_by_path))
3058 .field("entries_by_id", &EntriesById(&self.entries_by_id))
3059 .finish()
3060 }
3061}
3062
3063#[derive(Debug, Clone, PartialEq)]
3064pub struct File {
3065 pub worktree: Entity<Worktree>,
3066 pub path: Arc<RelPath>,
3067 pub disk_state: DiskState,
3068 pub entry_id: Option<ProjectEntryId>,
3069 pub is_local: bool,
3070 pub is_private: bool,
3071}
3072
3073impl language::File for File {
3074 fn as_local(&self) -> Option<&dyn language::LocalFile> {
3075 if self.is_local { Some(self) } else { None }
3076 }
3077
3078 fn disk_state(&self) -> DiskState {
3079 self.disk_state
3080 }
3081
3082 fn path(&self) -> &Arc<RelPath> {
3083 &self.path
3084 }
3085
3086 fn full_path(&self, cx: &App) -> PathBuf {
3087 self.worktree.read(cx).full_path(&self.path)
3088 }
3089
3090 /// Returns the last component of this handle's absolute path. If this handle refers to the root
3091 /// of its worktree, then this method will return the name of the worktree itself.
3092 fn file_name<'a>(&'a self, cx: &'a App) -> &'a str {
3093 self.path
3094 .file_name()
3095 .unwrap_or_else(|| self.worktree.read(cx).root_name_str())
3096 }
3097
3098 fn worktree_id(&self, cx: &App) -> WorktreeId {
3099 self.worktree.read(cx).id()
3100 }
3101
3102 fn to_proto(&self, cx: &App) -> rpc::proto::File {
3103 rpc::proto::File {
3104 worktree_id: self.worktree.read(cx).id().to_proto(),
3105 entry_id: self.entry_id.map(|id| id.to_proto()),
3106 path: self.path.as_ref().to_proto(),
3107 mtime: self.disk_state.mtime().map(|time| time.into()),
3108 is_deleted: self.disk_state == DiskState::Deleted,
3109 }
3110 }
3111
3112 fn is_private(&self) -> bool {
3113 self.is_private
3114 }
3115
3116 fn path_style(&self, cx: &App) -> PathStyle {
3117 self.worktree.read(cx).path_style()
3118 }
3119}
3120
3121impl language::LocalFile for File {
3122 fn abs_path(&self, cx: &App) -> PathBuf {
3123 self.worktree.read(cx).absolutize(&self.path)
3124 }
3125
3126 fn load(&self, cx: &App) -> Task<Result<String>> {
3127 let worktree = self.worktree.read(cx).as_local().unwrap();
3128 let abs_path = worktree.absolutize(&self.path);
3129 let fs = worktree.fs.clone();
3130 cx.background_spawn(async move { fs.load(&abs_path).await })
3131 }
3132
3133 fn load_bytes(&self, cx: &App) -> Task<Result<Vec<u8>>> {
3134 let worktree = self.worktree.read(cx).as_local().unwrap();
3135 let abs_path = worktree.absolutize(&self.path);
3136 let fs = worktree.fs.clone();
3137 cx.background_spawn(async move { fs.load_bytes(&abs_path).await })
3138 }
3139}
3140
3141impl File {
3142 pub fn for_entry(entry: Entry, worktree: Entity<Worktree>) -> Arc<Self> {
3143 Arc::new(Self {
3144 worktree,
3145 path: entry.path.clone(),
3146 disk_state: if let Some(mtime) = entry.mtime {
3147 DiskState::Present { mtime }
3148 } else {
3149 DiskState::New
3150 },
3151 entry_id: Some(entry.id),
3152 is_local: true,
3153 is_private: entry.is_private,
3154 })
3155 }
3156
3157 pub fn from_proto(
3158 proto: rpc::proto::File,
3159 worktree: Entity<Worktree>,
3160 cx: &App,
3161 ) -> Result<Self> {
3162 let worktree_id = worktree.read(cx).as_remote().context("not remote")?.id();
3163
3164 anyhow::ensure!(
3165 worktree_id.to_proto() == proto.worktree_id,
3166 "worktree id does not match file"
3167 );
3168
3169 let disk_state = if proto.is_deleted {
3170 DiskState::Deleted
3171 } else if let Some(mtime) = proto.mtime.map(&Into::into) {
3172 DiskState::Present { mtime }
3173 } else {
3174 DiskState::New
3175 };
3176
3177 Ok(Self {
3178 worktree,
3179 path: RelPath::from_proto(&proto.path).context("invalid path in file protobuf")?,
3180 disk_state,
3181 entry_id: proto.entry_id.map(ProjectEntryId::from_proto),
3182 is_local: false,
3183 is_private: false,
3184 })
3185 }
3186
3187 pub fn from_dyn(file: Option<&Arc<dyn language::File>>) -> Option<&Self> {
3188 file.and_then(|f| {
3189 let f: &dyn language::File = f.borrow();
3190 let f: &dyn Any = f;
3191 f.downcast_ref()
3192 })
3193 }
3194
3195 pub fn worktree_id(&self, cx: &App) -> WorktreeId {
3196 self.worktree.read(cx).id()
3197 }
3198
3199 pub fn project_entry_id(&self) -> Option<ProjectEntryId> {
3200 match self.disk_state {
3201 DiskState::Deleted => None,
3202 _ => self.entry_id,
3203 }
3204 }
3205}
3206
3207#[derive(Clone, Debug, PartialEq, Eq)]
3208pub struct Entry {
3209 pub id: ProjectEntryId,
3210 pub kind: EntryKind,
3211 pub path: Arc<RelPath>,
3212 pub inode: u64,
3213 pub mtime: Option<MTime>,
3214
3215 pub canonical_path: Option<Arc<Path>>,
3216 /// Whether this entry is ignored by Git.
3217 ///
3218 /// We only scan ignored entries once the directory is expanded and
3219 /// exclude them from searches.
3220 pub is_ignored: bool,
3221
3222 /// Whether this entry is hidden or inside hidden directory.
3223 ///
3224 /// We only scan hidden entries once the directory is expanded.
3225 pub is_hidden: bool,
3226
3227 /// Whether this entry is always included in searches.
3228 ///
3229 /// This is used for entries that are always included in searches, even
3230 /// if they are ignored by git. Overridden by file_scan_exclusions.
3231 pub is_always_included: bool,
3232
3233 /// Whether this entry's canonical path is outside of the worktree.
3234 /// This means the entry is only accessible from the worktree root via a
3235 /// symlink.
3236 ///
3237 /// We only scan entries outside of the worktree once the symlinked
3238 /// directory is expanded. External entries are treated like gitignored
3239 /// entries in that they are not included in searches.
3240 pub is_external: bool,
3241
3242 /// Whether this entry is considered to be a `.env` file.
3243 pub is_private: bool,
3244 /// The entry's size on disk, in bytes.
3245 pub size: u64,
3246 pub char_bag: CharBag,
3247 pub is_fifo: bool,
3248}
3249
3250#[derive(Clone, Copy, Debug, PartialEq, Eq)]
3251pub enum EntryKind {
3252 UnloadedDir,
3253 PendingDir,
3254 Dir,
3255 File,
3256}
3257
3258#[derive(Clone, Copy, Debug, PartialEq)]
3259pub enum PathChange {
3260 /// A filesystem entry was was created.
3261 Added,
3262 /// A filesystem entry was removed.
3263 Removed,
3264 /// A filesystem entry was updated.
3265 Updated,
3266 /// A filesystem entry was either updated or added. We don't know
3267 /// whether or not it already existed, because the path had not
3268 /// been loaded before the event.
3269 AddedOrUpdated,
3270 /// A filesystem entry was found during the initial scan of the worktree.
3271 Loaded,
3272}
3273
3274#[derive(Clone, Debug, PartialEq, Eq)]
3275pub struct UpdatedGitRepository {
3276 /// ID of the repository's working directory.
3277 ///
3278 /// For a repo that's above the worktree root, this is the ID of the worktree root, and hence not unique.
3279 /// It's included here to aid the GitStore in detecting when a repository's working directory is renamed.
3280 pub work_directory_id: ProjectEntryId,
3281 pub old_work_directory_abs_path: Option<Arc<Path>>,
3282 pub new_work_directory_abs_path: Option<Arc<Path>>,
3283 /// For a normal git repository checkout, the absolute path to the .git directory.
3284 /// For a worktree, the absolute path to the worktree's subdirectory inside the .git directory.
3285 pub dot_git_abs_path: Option<Arc<Path>>,
3286 pub repository_dir_abs_path: Option<Arc<Path>>,
3287 pub common_dir_abs_path: Option<Arc<Path>>,
3288}
3289
3290pub type UpdatedEntriesSet = Arc<[(Arc<RelPath>, ProjectEntryId, PathChange)]>;
3291pub type UpdatedGitRepositoriesSet = Arc<[UpdatedGitRepository]>;
3292
3293#[derive(Clone, Debug)]
3294pub struct PathProgress<'a> {
3295 pub max_path: &'a RelPath,
3296}
3297
3298#[derive(Clone, Debug)]
3299pub struct PathSummary<S> {
3300 pub max_path: Arc<RelPath>,
3301 pub item_summary: S,
3302}
3303
3304impl<S: Summary> Summary for PathSummary<S> {
3305 type Context<'a> = S::Context<'a>;
3306
3307 fn zero(cx: Self::Context<'_>) -> Self {
3308 Self {
3309 max_path: RelPath::empty().into(),
3310 item_summary: S::zero(cx),
3311 }
3312 }
3313
3314 fn add_summary(&mut self, rhs: &Self, cx: Self::Context<'_>) {
3315 self.max_path = rhs.max_path.clone();
3316 self.item_summary.add_summary(&rhs.item_summary, cx);
3317 }
3318}
3319
3320impl<'a, S: Summary> sum_tree::Dimension<'a, PathSummary<S>> for PathProgress<'a> {
3321 fn zero(_: <PathSummary<S> as Summary>::Context<'_>) -> Self {
3322 Self {
3323 max_path: RelPath::empty(),
3324 }
3325 }
3326
3327 fn add_summary(
3328 &mut self,
3329 summary: &'a PathSummary<S>,
3330 _: <PathSummary<S> as Summary>::Context<'_>,
3331 ) {
3332 self.max_path = summary.max_path.as_ref()
3333 }
3334}
3335
3336impl<'a> sum_tree::Dimension<'a, PathSummary<GitSummary>> for GitSummary {
3337 fn zero(_cx: ()) -> Self {
3338 Default::default()
3339 }
3340
3341 fn add_summary(&mut self, summary: &'a PathSummary<GitSummary>, _: ()) {
3342 *self += summary.item_summary
3343 }
3344}
3345
3346impl<'a>
3347 sum_tree::SeekTarget<'a, PathSummary<GitSummary>, Dimensions<TraversalProgress<'a>, GitSummary>>
3348 for PathTarget<'_>
3349{
3350 fn cmp(
3351 &self,
3352 cursor_location: &Dimensions<TraversalProgress<'a>, GitSummary>,
3353 _: (),
3354 ) -> Ordering {
3355 self.cmp_path(cursor_location.0.max_path)
3356 }
3357}
3358
3359impl<'a, S: Summary> sum_tree::Dimension<'a, PathSummary<S>> for PathKey {
3360 fn zero(_: S::Context<'_>) -> Self {
3361 Default::default()
3362 }
3363
3364 fn add_summary(&mut self, summary: &'a PathSummary<S>, _: S::Context<'_>) {
3365 self.0 = summary.max_path.clone();
3366 }
3367}
3368
3369impl<'a, S: Summary> sum_tree::Dimension<'a, PathSummary<S>> for TraversalProgress<'a> {
3370 fn zero(_cx: S::Context<'_>) -> Self {
3371 Default::default()
3372 }
3373
3374 fn add_summary(&mut self, summary: &'a PathSummary<S>, _: S::Context<'_>) {
3375 self.max_path = summary.max_path.as_ref();
3376 }
3377}
3378
3379impl Entry {
3380 fn new(
3381 path: Arc<RelPath>,
3382 metadata: &fs::Metadata,
3383 next_entry_id: &AtomicUsize,
3384 root_char_bag: CharBag,
3385 canonical_path: Option<Arc<Path>>,
3386 ) -> Self {
3387 let char_bag = char_bag_for_path(root_char_bag, &path);
3388 Self {
3389 id: ProjectEntryId::new(next_entry_id),
3390 kind: if metadata.is_dir {
3391 EntryKind::PendingDir
3392 } else {
3393 EntryKind::File
3394 },
3395 path,
3396 inode: metadata.inode,
3397 mtime: Some(metadata.mtime),
3398 size: metadata.len,
3399 canonical_path,
3400 is_ignored: false,
3401 is_hidden: false,
3402 is_always_included: false,
3403 is_external: false,
3404 is_private: false,
3405 char_bag,
3406 is_fifo: metadata.is_fifo,
3407 }
3408 }
3409
3410 pub fn is_created(&self) -> bool {
3411 self.mtime.is_some()
3412 }
3413
3414 pub fn is_dir(&self) -> bool {
3415 self.kind.is_dir()
3416 }
3417
3418 pub fn is_file(&self) -> bool {
3419 self.kind.is_file()
3420 }
3421}
3422
3423impl EntryKind {
3424 pub fn is_dir(&self) -> bool {
3425 matches!(
3426 self,
3427 EntryKind::Dir | EntryKind::PendingDir | EntryKind::UnloadedDir
3428 )
3429 }
3430
3431 pub fn is_unloaded(&self) -> bool {
3432 matches!(self, EntryKind::UnloadedDir)
3433 }
3434
3435 pub fn is_file(&self) -> bool {
3436 matches!(self, EntryKind::File)
3437 }
3438}
3439
3440impl sum_tree::Item for Entry {
3441 type Summary = EntrySummary;
3442
3443 fn summary(&self, _cx: ()) -> Self::Summary {
3444 let non_ignored_count = if (self.is_ignored || self.is_external) && !self.is_always_included
3445 {
3446 0
3447 } else {
3448 1
3449 };
3450 let file_count;
3451 let non_ignored_file_count;
3452 if self.is_file() {
3453 file_count = 1;
3454 non_ignored_file_count = non_ignored_count;
3455 } else {
3456 file_count = 0;
3457 non_ignored_file_count = 0;
3458 }
3459
3460 EntrySummary {
3461 max_path: self.path.clone(),
3462 count: 1,
3463 non_ignored_count,
3464 file_count,
3465 non_ignored_file_count,
3466 }
3467 }
3468}
3469
3470impl sum_tree::KeyedItem for Entry {
3471 type Key = PathKey;
3472
3473 fn key(&self) -> Self::Key {
3474 PathKey(self.path.clone())
3475 }
3476}
3477
3478#[derive(Clone, Debug)]
3479pub struct EntrySummary {
3480 max_path: Arc<RelPath>,
3481 count: usize,
3482 non_ignored_count: usize,
3483 file_count: usize,
3484 non_ignored_file_count: usize,
3485}
3486
3487impl Default for EntrySummary {
3488 fn default() -> Self {
3489 Self {
3490 max_path: Arc::from(RelPath::empty()),
3491 count: 0,
3492 non_ignored_count: 0,
3493 file_count: 0,
3494 non_ignored_file_count: 0,
3495 }
3496 }
3497}
3498
3499impl sum_tree::ContextLessSummary for EntrySummary {
3500 fn zero() -> Self {
3501 Default::default()
3502 }
3503
3504 fn add_summary(&mut self, rhs: &Self) {
3505 self.max_path = rhs.max_path.clone();
3506 self.count += rhs.count;
3507 self.non_ignored_count += rhs.non_ignored_count;
3508 self.file_count += rhs.file_count;
3509 self.non_ignored_file_count += rhs.non_ignored_file_count;
3510 }
3511}
3512
3513#[derive(Clone, Debug)]
3514struct PathEntry {
3515 id: ProjectEntryId,
3516 path: Arc<RelPath>,
3517 is_ignored: bool,
3518 scan_id: usize,
3519}
3520
3521impl sum_tree::Item for PathEntry {
3522 type Summary = PathEntrySummary;
3523
3524 fn summary(&self, _cx: ()) -> Self::Summary {
3525 PathEntrySummary { max_id: self.id }
3526 }
3527}
3528
3529impl sum_tree::KeyedItem for PathEntry {
3530 type Key = ProjectEntryId;
3531
3532 fn key(&self) -> Self::Key {
3533 self.id
3534 }
3535}
3536
3537#[derive(Clone, Debug, Default)]
3538struct PathEntrySummary {
3539 max_id: ProjectEntryId,
3540}
3541
3542impl sum_tree::ContextLessSummary for PathEntrySummary {
3543 fn zero() -> Self {
3544 Default::default()
3545 }
3546
3547 fn add_summary(&mut self, summary: &Self) {
3548 self.max_id = summary.max_id;
3549 }
3550}
3551
3552impl<'a> sum_tree::Dimension<'a, PathEntrySummary> for ProjectEntryId {
3553 fn zero(_cx: ()) -> Self {
3554 Default::default()
3555 }
3556
3557 fn add_summary(&mut self, summary: &'a PathEntrySummary, _: ()) {
3558 *self = summary.max_id;
3559 }
3560}
3561
3562#[derive(Clone, Debug, Eq, PartialEq, Ord, PartialOrd, Hash)]
3563pub struct PathKey(pub Arc<RelPath>);
3564
3565impl Default for PathKey {
3566 fn default() -> Self {
3567 Self(RelPath::empty().into())
3568 }
3569}
3570
3571impl<'a> sum_tree::Dimension<'a, EntrySummary> for PathKey {
3572 fn zero(_cx: ()) -> Self {
3573 Default::default()
3574 }
3575
3576 fn add_summary(&mut self, summary: &'a EntrySummary, _: ()) {
3577 self.0 = summary.max_path.clone();
3578 }
3579}
3580
3581struct BackgroundScanner {
3582 state: async_lock::Mutex<BackgroundScannerState>,
3583 fs: Arc<dyn Fs>,
3584 fs_case_sensitive: bool,
3585 status_updates_tx: UnboundedSender<ScanState>,
3586 executor: BackgroundExecutor,
3587 scan_requests_rx: channel::Receiver<ScanRequest>,
3588 path_prefixes_to_scan_rx: channel::Receiver<PathPrefixScanRequest>,
3589 next_entry_id: Arc<AtomicUsize>,
3590 phase: BackgroundScannerPhase,
3591 watcher: Arc<dyn Watcher>,
3592 settings: WorktreeSettings,
3593 share_private_files: bool,
3594}
3595
3596#[derive(Copy, Clone, PartialEq)]
3597enum BackgroundScannerPhase {
3598 InitialScan,
3599 EventsReceivedDuringInitialScan,
3600 Events,
3601}
3602
3603impl BackgroundScanner {
3604 async fn run(&mut self, mut fs_events_rx: Pin<Box<dyn Send + Stream<Item = Vec<PathEvent>>>>) {
3605 // If the worktree root does not contain a git repository, then find
3606 // the git repository in an ancestor directory. Find any gitignore files
3607 // in ancestor directories.
3608 let root_abs_path = self.state.lock().await.snapshot.abs_path.clone();
3609 let (ignores, repo) = discover_ancestor_git_repo(self.fs.clone(), &root_abs_path).await;
3610 self.state
3611 .lock()
3612 .await
3613 .snapshot
3614 .ignores_by_parent_abs_path
3615 .extend(ignores);
3616 let containing_git_repository = if let Some((ancestor_dot_git, work_directory)) = repo {
3617 maybe!(async {
3618 self.state
3619 .lock()
3620 .await
3621 .insert_git_repository_for_path(
3622 work_directory,
3623 ancestor_dot_git.clone().into(),
3624 self.fs.as_ref(),
3625 self.watcher.as_ref(),
3626 )
3627 .await
3628 .log_err()?;
3629 Some(ancestor_dot_git)
3630 })
3631 .await
3632 } else {
3633 None
3634 };
3635
3636 log::trace!("containing git repository: {containing_git_repository:?}");
3637
3638 let mut global_gitignore_events = if let Some(global_gitignore_path) =
3639 &paths::global_gitignore_path()
3640 {
3641 let is_file = self.fs.is_file(&global_gitignore_path).await;
3642 self.state.lock().await.snapshot.global_gitignore = if is_file {
3643 build_gitignore(global_gitignore_path, self.fs.as_ref())
3644 .await
3645 .ok()
3646 .map(Arc::new)
3647 } else {
3648 None
3649 };
3650 if is_file
3651 || matches!(global_gitignore_path.parent(), Some(path) if self.fs.is_dir(path).await)
3652 {
3653 self.fs
3654 .watch(global_gitignore_path, FS_WATCH_LATENCY)
3655 .await
3656 .0
3657 } else {
3658 Box::pin(futures::stream::pending())
3659 }
3660 } else {
3661 self.state.lock().await.snapshot.global_gitignore = None;
3662 Box::pin(futures::stream::pending())
3663 };
3664
3665 let (scan_job_tx, scan_job_rx) = channel::unbounded();
3666 {
3667 let mut state = self.state.lock().await;
3668 state.snapshot.scan_id += 1;
3669 if let Some(mut root_entry) = state.snapshot.root_entry().cloned() {
3670 let ignore_stack = state
3671 .snapshot
3672 .ignore_stack_for_abs_path(root_abs_path.as_path(), true, self.fs.as_ref())
3673 .await;
3674 if ignore_stack.is_abs_path_ignored(root_abs_path.as_path(), true) {
3675 root_entry.is_ignored = true;
3676 state
3677 .insert_entry(root_entry.clone(), self.fs.as_ref(), self.watcher.as_ref())
3678 .await;
3679 }
3680 if root_entry.is_dir() {
3681 state
3682 .enqueue_scan_dir(
3683 root_abs_path.as_path().into(),
3684 &root_entry,
3685 &scan_job_tx,
3686 self.fs.as_ref(),
3687 )
3688 .await;
3689 }
3690 }
3691 };
3692
3693 // Perform an initial scan of the directory.
3694 drop(scan_job_tx);
3695 self.scan_dirs(true, scan_job_rx).await;
3696 {
3697 let mut state = self.state.lock().await;
3698 state.snapshot.completed_scan_id = state.snapshot.scan_id;
3699 }
3700
3701 self.send_status_update(false, SmallVec::new()).await;
3702
3703 // Process any any FS events that occurred while performing the initial scan.
3704 // For these events, update events cannot be as precise, because we didn't
3705 // have the previous state loaded yet.
3706 self.phase = BackgroundScannerPhase::EventsReceivedDuringInitialScan;
3707 if let Poll::Ready(Some(mut paths)) = futures::poll!(fs_events_rx.next()) {
3708 while let Poll::Ready(Some(more_paths)) = futures::poll!(fs_events_rx.next()) {
3709 paths.extend(more_paths);
3710 }
3711 self.process_events(
3712 paths
3713 .into_iter()
3714 .filter(|e| e.kind.is_some())
3715 .map(Into::into)
3716 .collect(),
3717 )
3718 .await;
3719 }
3720 if let Some(abs_path) = containing_git_repository {
3721 self.process_events(vec![abs_path]).await;
3722 }
3723
3724 // Continue processing events until the worktree is dropped.
3725 self.phase = BackgroundScannerPhase::Events;
3726
3727 loop {
3728 select_biased! {
3729 // Process any path refresh requests from the worktree. Prioritize
3730 // these before handling changes reported by the filesystem.
3731 request = self.next_scan_request().fuse() => {
3732 let Ok(request) = request else { break };
3733 if !self.process_scan_request(request, false).await {
3734 return;
3735 }
3736 }
3737
3738 path_prefix_request = self.path_prefixes_to_scan_rx.recv().fuse() => {
3739 let Ok(request) = path_prefix_request else { break };
3740 log::trace!("adding path prefix {:?}", request.path);
3741
3742 let did_scan = self.forcibly_load_paths(std::slice::from_ref(&request.path)).await;
3743 if did_scan {
3744 let abs_path =
3745 {
3746 let mut state = self.state.lock().await;
3747 state.path_prefixes_to_scan.insert(request.path.clone());
3748 state.snapshot.absolutize(&request.path)
3749 };
3750
3751 if let Some(abs_path) = self.fs.canonicalize(&abs_path).await.log_err() {
3752 self.process_events(vec![abs_path]).await;
3753 }
3754 }
3755 self.send_status_update(false, request.done).await;
3756 }
3757
3758 paths = fs_events_rx.next().fuse() => {
3759 let Some(mut paths) = paths else { break };
3760 while let Poll::Ready(Some(more_paths)) = futures::poll!(fs_events_rx.next()) {
3761 paths.extend(more_paths);
3762 }
3763 self.process_events(paths.into_iter().filter(|e| e.kind.is_some()).map(Into::into).collect()).await;
3764 }
3765
3766 paths = global_gitignore_events.next().fuse() => {
3767 match paths.as_deref() {
3768 Some([event, ..]) => {
3769 self.update_global_gitignore(&event.path).await;
3770 }
3771 _ => (),
3772 }
3773 }
3774 }
3775 }
3776 }
3777
3778 async fn process_scan_request(&self, mut request: ScanRequest, scanning: bool) -> bool {
3779 log::debug!("rescanning paths {:?}", request.relative_paths);
3780
3781 request.relative_paths.sort_unstable();
3782 self.forcibly_load_paths(&request.relative_paths).await;
3783
3784 let root_path = self.state.lock().await.snapshot.abs_path.clone();
3785 let root_canonical_path = self.fs.canonicalize(root_path.as_path()).await;
3786 let root_canonical_path = match &root_canonical_path {
3787 Ok(path) => SanitizedPath::new(path),
3788 Err(err) => {
3789 log::error!("failed to canonicalize root path {root_path:?}: {err}");
3790 return true;
3791 }
3792 };
3793 let abs_paths = request
3794 .relative_paths
3795 .iter()
3796 .map(|path| {
3797 if path.file_name().is_some() {
3798 root_canonical_path.as_path().join(path.as_std_path())
3799 } else {
3800 root_canonical_path.as_path().to_path_buf()
3801 }
3802 })
3803 .collect::<Vec<_>>();
3804
3805 {
3806 let mut state = self.state.lock().await;
3807 let is_idle = state.snapshot.completed_scan_id == state.snapshot.scan_id;
3808 state.snapshot.scan_id += 1;
3809 if is_idle {
3810 state.snapshot.completed_scan_id = state.snapshot.scan_id;
3811 }
3812 }
3813
3814 self.reload_entries_for_paths(
3815 &root_path,
3816 &root_canonical_path,
3817 &request.relative_paths,
3818 abs_paths,
3819 None,
3820 )
3821 .await;
3822
3823 self.send_status_update(scanning, request.done).await
3824 }
3825
3826 async fn process_events(&self, mut abs_paths: Vec<PathBuf>) {
3827 log::trace!("process events: {abs_paths:?}");
3828 let root_path = self.state.lock().await.snapshot.abs_path.clone();
3829 let root_canonical_path = self.fs.canonicalize(root_path.as_path()).await;
3830 let root_canonical_path = match &root_canonical_path {
3831 Ok(path) => SanitizedPath::new(path),
3832 Err(err) => {
3833 let new_path = self
3834 .state
3835 .lock()
3836 .await
3837 .snapshot
3838 .root_file_handle
3839 .clone()
3840 .and_then(|handle| handle.current_path(&self.fs).log_err())
3841 .map(|path| SanitizedPath::new_arc(&path))
3842 .filter(|new_path| *new_path != root_path);
3843
3844 if let Some(new_path) = new_path {
3845 log::info!(
3846 "root renamed from {} to {}",
3847 root_path.as_path().display(),
3848 new_path.as_path().display()
3849 );
3850 self.status_updates_tx
3851 .unbounded_send(ScanState::RootUpdated { new_path })
3852 .ok();
3853 } else {
3854 log::warn!("root path could not be canonicalized: {:#}", err);
3855 }
3856 return;
3857 }
3858 };
3859
3860 // Certain directories may have FS changes, but do not lead to git data changes that Zed cares about.
3861 // Ignore these, to avoid Zed unnecessarily rescanning git metadata.
3862 let skipped_files_in_dot_git = [COMMIT_MESSAGE, INDEX_LOCK];
3863 let skipped_dirs_in_dot_git = [FSMONITOR_DAEMON, LFS_DIR];
3864
3865 let mut relative_paths = Vec::with_capacity(abs_paths.len());
3866 let mut dot_git_abs_paths = Vec::new();
3867 abs_paths.sort_unstable();
3868 abs_paths.dedup_by(|a, b| a.starts_with(b));
3869 {
3870 let snapshot = &self.state.lock().await.snapshot;
3871 abs_paths.retain(|abs_path| {
3872 let abs_path = &SanitizedPath::new(abs_path);
3873
3874
3875 {
3876 let mut is_git_related = false;
3877
3878 let dot_git_paths = self.executor.block(maybe!(async {
3879 let mut path = None;
3880 for ancestor in abs_path.as_path().ancestors() {
3881
3882 if is_git_dir(ancestor, self.fs.as_ref()).await {
3883 let path_in_git_dir = abs_path
3884 .as_path()
3885 .strip_prefix(ancestor)
3886 .expect("stripping off the ancestor");
3887 path = Some((ancestor.to_owned(), path_in_git_dir.to_owned()));
3888 break;
3889 }
3890 }
3891 path
3892
3893 }));
3894
3895 if let Some((dot_git_abs_path, path_in_git_dir)) = dot_git_paths {
3896 if skipped_files_in_dot_git
3897 .iter()
3898 .any(|skipped| OsStr::new(skipped) == path_in_git_dir.as_path().as_os_str())
3899 || skipped_dirs_in_dot_git.iter().any(|skipped_git_subdir| {
3900 path_in_git_dir.starts_with(skipped_git_subdir)
3901 })
3902 {
3903 log::debug!("ignoring event {abs_path:?} as it's in the .git directory among skipped files or directories");
3904 return false;
3905 }
3906
3907 is_git_related = true;
3908 if !dot_git_abs_paths.contains(&dot_git_abs_path) {
3909 dot_git_abs_paths.push(dot_git_abs_path);
3910 }
3911 }
3912
3913 let relative_path = if let Ok(path) =
3914 abs_path.strip_prefix(&root_canonical_path)
3915 && let Ok(path) = RelPath::new(path, PathStyle::local())
3916 {
3917 path
3918 } else {
3919 if is_git_related {
3920 log::debug!(
3921 "ignoring event {abs_path:?}, since it's in git dir outside of root path {root_canonical_path:?}",
3922 );
3923 } else {
3924 log::error!(
3925 "ignoring event {abs_path:?} outside of root path {root_canonical_path:?}",
3926 );
3927 }
3928 return false;
3929 };
3930
3931 if abs_path.file_name() == Some(OsStr::new(GITIGNORE)) {
3932 for (_, repo) in snapshot
3933 .git_repositories
3934 .iter()
3935 .filter(|(_, repo)| repo.directory_contains(&relative_path))
3936 {
3937 if !dot_git_abs_paths.iter().any(|dot_git_abs_path| {
3938 dot_git_abs_path == repo.common_dir_abs_path.as_ref()
3939 }) {
3940 dot_git_abs_paths.push(repo.common_dir_abs_path.to_path_buf());
3941 }
3942 }
3943 }
3944
3945 let parent_dir_is_loaded = relative_path.parent().is_none_or(|parent| {
3946 snapshot
3947 .entry_for_path(parent)
3948 .is_some_and(|entry| entry.kind == EntryKind::Dir)
3949 });
3950 if !parent_dir_is_loaded {
3951 log::debug!("ignoring event {relative_path:?} within unloaded directory");
3952 return false;
3953 }
3954
3955 if self.settings.is_path_excluded(&relative_path) {
3956 if !is_git_related {
3957 log::debug!("ignoring FS event for excluded path {relative_path:?}");
3958 }
3959 return false;
3960 }
3961
3962 relative_paths.push(relative_path.into_arc());
3963 true
3964 }
3965 });
3966 }
3967 if relative_paths.is_empty() && dot_git_abs_paths.is_empty() {
3968 return;
3969 }
3970
3971 self.state.lock().await.snapshot.scan_id += 1;
3972
3973 let (scan_job_tx, scan_job_rx) = channel::unbounded();
3974 log::debug!("received fs events {:?}", relative_paths);
3975 self.reload_entries_for_paths(
3976 &root_path,
3977 &root_canonical_path,
3978 &relative_paths,
3979 abs_paths,
3980 Some(scan_job_tx.clone()),
3981 )
3982 .await;
3983
3984 let affected_repo_roots = if !dot_git_abs_paths.is_empty() {
3985 self.update_git_repositories(dot_git_abs_paths).await
3986 } else {
3987 Vec::new()
3988 };
3989
3990 {
3991 let mut ignores_to_update = self.ignores_needing_update().await;
3992 ignores_to_update.extend(affected_repo_roots);
3993 let ignores_to_update = self.order_ignores(ignores_to_update).await;
3994 let snapshot = self.state.lock().await.snapshot.clone();
3995 self.update_ignore_statuses_for_paths(scan_job_tx, snapshot, ignores_to_update)
3996 .await;
3997 self.scan_dirs(false, scan_job_rx).await;
3998 }
3999
4000 {
4001 let mut state = self.state.lock().await;
4002 state.snapshot.completed_scan_id = state.snapshot.scan_id;
4003 for (_, entry) in mem::take(&mut state.removed_entries) {
4004 state.scanned_dirs.remove(&entry.id);
4005 }
4006 }
4007 self.send_status_update(false, SmallVec::new()).await;
4008 }
4009
4010 async fn update_global_gitignore(&self, abs_path: &Path) {
4011 let ignore = build_gitignore(abs_path, self.fs.as_ref())
4012 .await
4013 .log_err()
4014 .map(Arc::new);
4015 let (prev_snapshot, ignore_stack, abs_path) = {
4016 let mut state = self.state.lock().await;
4017 state.snapshot.global_gitignore = ignore;
4018 let abs_path = state.snapshot.abs_path().clone();
4019 let ignore_stack = state
4020 .snapshot
4021 .ignore_stack_for_abs_path(&abs_path, true, self.fs.as_ref())
4022 .await;
4023 (state.snapshot.clone(), ignore_stack, abs_path)
4024 };
4025 let (scan_job_tx, scan_job_rx) = channel::unbounded();
4026 self.update_ignore_statuses_for_paths(
4027 scan_job_tx,
4028 prev_snapshot,
4029 vec![(abs_path, ignore_stack)],
4030 )
4031 .await;
4032 self.scan_dirs(false, scan_job_rx).await;
4033 self.send_status_update(false, SmallVec::new()).await;
4034 }
4035
4036 async fn forcibly_load_paths(&self, paths: &[Arc<RelPath>]) -> bool {
4037 let (scan_job_tx, scan_job_rx) = channel::unbounded();
4038 {
4039 let mut state = self.state.lock().await;
4040 let root_path = state.snapshot.abs_path.clone();
4041 for path in paths {
4042 for ancestor in path.ancestors() {
4043 if let Some(entry) = state.snapshot.entry_for_path(ancestor)
4044 && entry.kind == EntryKind::UnloadedDir
4045 {
4046 let abs_path = root_path.join(ancestor.as_std_path());
4047 state
4048 .enqueue_scan_dir(
4049 abs_path.into(),
4050 entry,
4051 &scan_job_tx,
4052 self.fs.as_ref(),
4053 )
4054 .await;
4055 state.paths_to_scan.insert(path.clone());
4056 break;
4057 }
4058 }
4059 }
4060 drop(scan_job_tx);
4061 }
4062 while let Ok(job) = scan_job_rx.recv().await {
4063 self.scan_dir(&job).await.log_err();
4064 }
4065
4066 !mem::take(&mut self.state.lock().await.paths_to_scan).is_empty()
4067 }
4068
4069 async fn scan_dirs(
4070 &self,
4071 enable_progress_updates: bool,
4072 scan_jobs_rx: channel::Receiver<ScanJob>,
4073 ) {
4074 if self
4075 .status_updates_tx
4076 .unbounded_send(ScanState::Started)
4077 .is_err()
4078 {
4079 return;
4080 }
4081
4082 let progress_update_count = AtomicUsize::new(0);
4083 self.executor
4084 .scoped(|scope| {
4085 for _ in 0..self.executor.num_cpus() {
4086 scope.spawn(async {
4087 let mut last_progress_update_count = 0;
4088 let progress_update_timer = self.progress_timer(enable_progress_updates).fuse();
4089 futures::pin_mut!(progress_update_timer);
4090
4091 loop {
4092 select_biased! {
4093 // Process any path refresh requests before moving on to process
4094 // the scan queue, so that user operations are prioritized.
4095 request = self.next_scan_request().fuse() => {
4096 let Ok(request) = request else { break };
4097 if !self.process_scan_request(request, true).await {
4098 return;
4099 }
4100 }
4101
4102 // Send periodic progress updates to the worktree. Use an atomic counter
4103 // to ensure that only one of the workers sends a progress update after
4104 // the update interval elapses.
4105 _ = progress_update_timer => {
4106 match progress_update_count.compare_exchange(
4107 last_progress_update_count,
4108 last_progress_update_count + 1,
4109 SeqCst,
4110 SeqCst
4111 ) {
4112 Ok(_) => {
4113 last_progress_update_count += 1;
4114 self.send_status_update(true, SmallVec::new()).await;
4115 }
4116 Err(count) => {
4117 last_progress_update_count = count;
4118 }
4119 }
4120 progress_update_timer.set(self.progress_timer(enable_progress_updates).fuse());
4121 }
4122
4123 // Recursively load directories from the file system.
4124 job = scan_jobs_rx.recv().fuse() => {
4125 let Ok(job) = job else { break };
4126 if let Err(err) = self.scan_dir(&job).await
4127 && job.path.is_empty() {
4128 log::error!("error scanning directory {:?}: {}", job.abs_path, err);
4129 }
4130 }
4131 }
4132 }
4133 });
4134 }
4135 })
4136 .await;
4137 }
4138
4139 async fn send_status_update(
4140 &self,
4141 scanning: bool,
4142 barrier: SmallVec<[barrier::Sender; 1]>,
4143 ) -> bool {
4144 let mut state = self.state.lock().await;
4145 if state.changed_paths.is_empty() && scanning {
4146 return true;
4147 }
4148
4149 let new_snapshot = state.snapshot.clone();
4150 let old_snapshot = mem::replace(&mut state.prev_snapshot, new_snapshot.snapshot.clone());
4151 let changes = build_diff(
4152 self.phase,
4153 &old_snapshot,
4154 &new_snapshot,
4155 &state.changed_paths,
4156 );
4157 state.changed_paths.clear();
4158
4159 self.status_updates_tx
4160 .unbounded_send(ScanState::Updated {
4161 snapshot: new_snapshot,
4162 changes,
4163 scanning,
4164 barrier,
4165 })
4166 .is_ok()
4167 }
4168
4169 async fn scan_dir(&self, job: &ScanJob) -> Result<()> {
4170 let root_abs_path;
4171 let root_char_bag;
4172 {
4173 let snapshot = &self.state.lock().await.snapshot;
4174 if self.settings.is_path_excluded(&job.path) {
4175 log::error!("skipping excluded directory {:?}", job.path);
4176 return Ok(());
4177 }
4178 log::trace!("scanning directory {:?}", job.path);
4179 root_abs_path = snapshot.abs_path().clone();
4180 root_char_bag = snapshot.root_char_bag;
4181 }
4182
4183 let next_entry_id = self.next_entry_id.clone();
4184 let mut ignore_stack = job.ignore_stack.clone();
4185 let mut new_ignore = None;
4186 let mut root_canonical_path = None;
4187 let mut new_entries: Vec<Entry> = Vec::new();
4188 let mut new_jobs: Vec<Option<ScanJob>> = Vec::new();
4189 let mut child_paths = self
4190 .fs
4191 .read_dir(&job.abs_path)
4192 .await?
4193 .filter_map(|entry| async {
4194 match entry {
4195 Ok(entry) => Some(entry),
4196 Err(error) => {
4197 log::error!("error processing entry {:?}", error);
4198 None
4199 }
4200 }
4201 })
4202 .collect::<Vec<_>>()
4203 .await;
4204
4205 // Ensure that .git and .gitignore are processed first.
4206 swap_to_front(&mut child_paths, GITIGNORE);
4207 swap_to_front(&mut child_paths, DOT_GIT);
4208
4209 if let Some(path) = child_paths.first()
4210 && path.ends_with(DOT_GIT)
4211 {
4212 ignore_stack.repo_root = Some(job.abs_path.clone());
4213 }
4214
4215 for child_abs_path in child_paths {
4216 let child_abs_path: Arc<Path> = child_abs_path.into();
4217 let child_name = child_abs_path.file_name().unwrap();
4218 let Some(child_path) = child_name
4219 .to_str()
4220 .and_then(|name| Some(job.path.join(RelPath::unix(name).ok()?)))
4221 else {
4222 continue;
4223 };
4224
4225 if child_name == DOT_GIT {
4226 let mut state = self.state.lock().await;
4227 state
4228 .insert_git_repository(
4229 child_path.clone(),
4230 self.fs.as_ref(),
4231 self.watcher.as_ref(),
4232 )
4233 .await;
4234 } else if child_name == GITIGNORE {
4235 match build_gitignore(&child_abs_path, self.fs.as_ref()).await {
4236 Ok(ignore) => {
4237 let ignore = Arc::new(ignore);
4238 ignore_stack = ignore_stack.append(job.abs_path.clone(), ignore.clone());
4239 new_ignore = Some(ignore);
4240 }
4241 Err(error) => {
4242 log::error!(
4243 "error loading .gitignore file {:?} - {:?}",
4244 child_name,
4245 error
4246 );
4247 }
4248 }
4249 }
4250
4251 if self.settings.is_path_excluded(&child_path) {
4252 log::debug!("skipping excluded child entry {child_path:?}");
4253 self.state.lock().await.remove_path(&child_path);
4254 continue;
4255 }
4256
4257 let child_metadata = match self.fs.metadata(&child_abs_path).await {
4258 Ok(Some(metadata)) => metadata,
4259 Ok(None) => continue,
4260 Err(err) => {
4261 log::error!("error processing {child_abs_path:?}: {err:?}");
4262 continue;
4263 }
4264 };
4265
4266 let mut child_entry = Entry::new(
4267 child_path.clone(),
4268 &child_metadata,
4269 &next_entry_id,
4270 root_char_bag,
4271 None,
4272 );
4273
4274 if job.is_external {
4275 child_entry.is_external = true;
4276 } else if child_metadata.is_symlink {
4277 let canonical_path = match self.fs.canonicalize(&child_abs_path).await {
4278 Ok(path) => path,
4279 Err(err) => {
4280 log::error!("error reading target of symlink {child_abs_path:?}: {err:#}",);
4281 continue;
4282 }
4283 };
4284
4285 // lazily canonicalize the root path in order to determine if
4286 // symlinks point outside of the worktree.
4287 let root_canonical_path = match &root_canonical_path {
4288 Some(path) => path,
4289 None => match self.fs.canonicalize(&root_abs_path).await {
4290 Ok(path) => root_canonical_path.insert(path),
4291 Err(err) => {
4292 log::error!("error canonicalizing root {:?}: {:?}", root_abs_path, err);
4293 continue;
4294 }
4295 },
4296 };
4297
4298 if !canonical_path.starts_with(root_canonical_path) {
4299 child_entry.is_external = true;
4300 }
4301
4302 child_entry.canonical_path = Some(canonical_path.into());
4303 }
4304
4305 if child_entry.is_dir() {
4306 child_entry.is_ignored = ignore_stack.is_abs_path_ignored(&child_abs_path, true);
4307 child_entry.is_always_included =
4308 self.settings.is_path_always_included(&child_path, true);
4309
4310 // Avoid recursing until crash in the case of a recursive symlink
4311 if job.ancestor_inodes.contains(&child_entry.inode) {
4312 new_jobs.push(None);
4313 } else {
4314 let mut ancestor_inodes = job.ancestor_inodes.clone();
4315 ancestor_inodes.insert(child_entry.inode);
4316
4317 new_jobs.push(Some(ScanJob {
4318 abs_path: child_abs_path.clone(),
4319 path: child_path,
4320 is_external: child_entry.is_external,
4321 ignore_stack: if child_entry.is_ignored {
4322 IgnoreStack::all()
4323 } else {
4324 ignore_stack.clone()
4325 },
4326 ancestor_inodes,
4327 scan_queue: job.scan_queue.clone(),
4328 }));
4329 }
4330 } else {
4331 child_entry.is_ignored = ignore_stack.is_abs_path_ignored(&child_abs_path, false);
4332 child_entry.is_always_included =
4333 self.settings.is_path_always_included(&child_path, false);
4334 }
4335
4336 {
4337 let relative_path = job
4338 .path
4339 .join(RelPath::unix(child_name.to_str().unwrap()).unwrap());
4340 if self.is_path_private(&relative_path) {
4341 log::debug!("detected private file: {relative_path:?}");
4342 child_entry.is_private = true;
4343 }
4344 if self.settings.is_path_hidden(&relative_path) {
4345 log::debug!("detected hidden file: {relative_path:?}");
4346 child_entry.is_hidden = true;
4347 }
4348 }
4349
4350 new_entries.push(child_entry);
4351 }
4352
4353 let mut state = self.state.lock().await;
4354
4355 // Identify any subdirectories that should not be scanned.
4356 let mut job_ix = 0;
4357 for entry in &mut new_entries {
4358 state.reuse_entry_id(entry);
4359 if entry.is_dir() {
4360 if state.should_scan_directory(entry) {
4361 job_ix += 1;
4362 } else {
4363 log::debug!("defer scanning directory {:?}", entry.path);
4364 entry.kind = EntryKind::UnloadedDir;
4365 new_jobs.remove(job_ix);
4366 }
4367 }
4368 if entry.is_always_included {
4369 state
4370 .snapshot
4371 .always_included_entries
4372 .push(entry.path.clone());
4373 }
4374 }
4375
4376 state.populate_dir(job.path.clone(), new_entries, new_ignore);
4377 self.watcher.add(job.abs_path.as_ref()).log_err();
4378
4379 for new_job in new_jobs.into_iter().flatten() {
4380 job.scan_queue
4381 .try_send(new_job)
4382 .expect("channel is unbounded");
4383 }
4384
4385 Ok(())
4386 }
4387
4388 /// All list arguments should be sorted before calling this function
4389 async fn reload_entries_for_paths(
4390 &self,
4391 root_abs_path: &SanitizedPath,
4392 root_canonical_path: &SanitizedPath,
4393 relative_paths: &[Arc<RelPath>],
4394 abs_paths: Vec<PathBuf>,
4395 scan_queue_tx: Option<Sender<ScanJob>>,
4396 ) {
4397 // grab metadata for all requested paths
4398 let metadata = futures::future::join_all(
4399 abs_paths
4400 .iter()
4401 .map(|abs_path| async move {
4402 let metadata = self.fs.metadata(abs_path).await?;
4403 if let Some(metadata) = metadata {
4404 let canonical_path = self.fs.canonicalize(abs_path).await?;
4405
4406 // If we're on a case-insensitive filesystem (default on macOS), we want
4407 // to only ignore metadata for non-symlink files if their absolute-path matches
4408 // the canonical-path.
4409 // Because if not, this might be a case-only-renaming (`mv test.txt TEST.TXT`)
4410 // and we want to ignore the metadata for the old path (`test.txt`) so it's
4411 // treated as removed.
4412 if !self.fs_case_sensitive && !metadata.is_symlink {
4413 let canonical_file_name = canonical_path.file_name();
4414 let file_name = abs_path.file_name();
4415 if canonical_file_name != file_name {
4416 return Ok(None);
4417 }
4418 }
4419
4420 anyhow::Ok(Some((metadata, SanitizedPath::new_arc(&canonical_path))))
4421 } else {
4422 Ok(None)
4423 }
4424 })
4425 .collect::<Vec<_>>(),
4426 )
4427 .await;
4428
4429 let mut new_ancestor_repo = if relative_paths.iter().any(|path| path.is_empty()) {
4430 Some(discover_ancestor_git_repo(self.fs.clone(), &root_abs_path).await)
4431 } else {
4432 None
4433 };
4434
4435 let mut state = self.state.lock().await;
4436 let doing_recursive_update = scan_queue_tx.is_some();
4437
4438 // Remove any entries for paths that no longer exist or are being recursively
4439 // refreshed. Do this before adding any new entries, so that renames can be
4440 // detected regardless of the order of the paths.
4441 for (path, metadata) in relative_paths.iter().zip(metadata.iter()) {
4442 if matches!(metadata, Ok(None)) || doing_recursive_update {
4443 state.remove_path(path);
4444 }
4445 }
4446
4447 for (path, metadata) in relative_paths.iter().zip(metadata.into_iter()) {
4448 let abs_path: Arc<Path> = root_abs_path.join(path.as_std_path()).into();
4449 match metadata {
4450 Ok(Some((metadata, canonical_path))) => {
4451 let ignore_stack = state
4452 .snapshot
4453 .ignore_stack_for_abs_path(&abs_path, metadata.is_dir, self.fs.as_ref())
4454 .await;
4455 let is_external = !canonical_path.starts_with(&root_canonical_path);
4456 let mut fs_entry = Entry::new(
4457 path.clone(),
4458 &metadata,
4459 self.next_entry_id.as_ref(),
4460 state.snapshot.root_char_bag,
4461 if metadata.is_symlink {
4462 Some(canonical_path.as_path().to_path_buf().into())
4463 } else {
4464 None
4465 },
4466 );
4467
4468 let is_dir = fs_entry.is_dir();
4469 fs_entry.is_ignored = ignore_stack.is_abs_path_ignored(&abs_path, is_dir);
4470 fs_entry.is_external = is_external;
4471 fs_entry.is_private = self.is_path_private(path);
4472 fs_entry.is_always_included =
4473 self.settings.is_path_always_included(path, is_dir);
4474 fs_entry.is_hidden = self.settings.is_path_hidden(path);
4475
4476 if let (Some(scan_queue_tx), true) = (&scan_queue_tx, is_dir) {
4477 if state.should_scan_directory(&fs_entry)
4478 || (fs_entry.path.is_empty()
4479 && abs_path.file_name() == Some(OsStr::new(DOT_GIT)))
4480 {
4481 state
4482 .enqueue_scan_dir(
4483 abs_path,
4484 &fs_entry,
4485 scan_queue_tx,
4486 self.fs.as_ref(),
4487 )
4488 .await;
4489 } else {
4490 fs_entry.kind = EntryKind::UnloadedDir;
4491 }
4492 }
4493
4494 state
4495 .insert_entry(fs_entry.clone(), self.fs.as_ref(), self.watcher.as_ref())
4496 .await;
4497
4498 if path.is_empty()
4499 && let Some((ignores, repo)) = new_ancestor_repo.take()
4500 {
4501 log::trace!("updating ancestor git repository");
4502 state.snapshot.ignores_by_parent_abs_path.extend(ignores);
4503 if let Some((ancestor_dot_git, work_directory)) = repo {
4504 state
4505 .insert_git_repository_for_path(
4506 work_directory,
4507 ancestor_dot_git.into(),
4508 self.fs.as_ref(),
4509 self.watcher.as_ref(),
4510 )
4511 .await
4512 .log_err();
4513 }
4514 }
4515 }
4516 Ok(None) => {
4517 self.remove_repo_path(path.clone(), &mut state.snapshot);
4518 }
4519 Err(err) => {
4520 log::error!("error reading file {abs_path:?} on event: {err:#}");
4521 }
4522 }
4523 }
4524
4525 util::extend_sorted(
4526 &mut state.changed_paths,
4527 relative_paths.iter().cloned(),
4528 usize::MAX,
4529 Ord::cmp,
4530 );
4531 }
4532
4533 fn remove_repo_path(&self, path: Arc<RelPath>, snapshot: &mut LocalSnapshot) -> Option<()> {
4534 if !path.components().any(|component| component == DOT_GIT)
4535 && let Some(local_repo) = snapshot.local_repo_for_work_directory_path(&path)
4536 {
4537 let id = local_repo.work_directory_id;
4538 log::debug!("remove repo path: {:?}", path);
4539 snapshot.git_repositories.remove(&id);
4540 return Some(());
4541 }
4542
4543 Some(())
4544 }
4545
4546 async fn update_ignore_statuses_for_paths(
4547 &self,
4548 scan_job_tx: Sender<ScanJob>,
4549 prev_snapshot: LocalSnapshot,
4550 ignores_to_update: Vec<(Arc<Path>, IgnoreStack)>,
4551 ) {
4552 let (ignore_queue_tx, ignore_queue_rx) = channel::unbounded();
4553 {
4554 for (parent_abs_path, ignore_stack) in ignores_to_update {
4555 ignore_queue_tx
4556 .send_blocking(UpdateIgnoreStatusJob {
4557 abs_path: parent_abs_path,
4558 ignore_stack,
4559 ignore_queue: ignore_queue_tx.clone(),
4560 scan_queue: scan_job_tx.clone(),
4561 })
4562 .unwrap();
4563 }
4564 }
4565 drop(ignore_queue_tx);
4566
4567 self.executor
4568 .scoped(|scope| {
4569 for _ in 0..self.executor.num_cpus() {
4570 scope.spawn(async {
4571 loop {
4572 select_biased! {
4573 // Process any path refresh requests before moving on to process
4574 // the queue of ignore statuses.
4575 request = self.next_scan_request().fuse() => {
4576 let Ok(request) = request else { break };
4577 if !self.process_scan_request(request, true).await {
4578 return;
4579 }
4580 }
4581
4582 // Recursively process directories whose ignores have changed.
4583 job = ignore_queue_rx.recv().fuse() => {
4584 let Ok(job) = job else { break };
4585 self.update_ignore_status(job, &prev_snapshot).await;
4586 }
4587 }
4588 }
4589 });
4590 }
4591 })
4592 .await;
4593 }
4594
4595 async fn ignores_needing_update(&self) -> Vec<Arc<Path>> {
4596 let mut ignores_to_update = Vec::new();
4597
4598 {
4599 let snapshot = &mut self.state.lock().await.snapshot;
4600 let abs_path = snapshot.abs_path.clone();
4601 snapshot
4602 .ignores_by_parent_abs_path
4603 .retain(|parent_abs_path, (_, needs_update)| {
4604 if let Ok(parent_path) = parent_abs_path.strip_prefix(abs_path.as_path())
4605 && let Some(parent_path) =
4606 RelPath::new(&parent_path, PathStyle::local()).log_err()
4607 {
4608 if *needs_update {
4609 *needs_update = false;
4610 if snapshot.snapshot.entry_for_path(&parent_path).is_some() {
4611 ignores_to_update.push(parent_abs_path.clone());
4612 }
4613 }
4614
4615 let ignore_path = parent_path.join(RelPath::unix(GITIGNORE).unwrap());
4616 if snapshot.snapshot.entry_for_path(&ignore_path).is_none() {
4617 return false;
4618 }
4619 }
4620 true
4621 });
4622 }
4623
4624 ignores_to_update
4625 }
4626
4627 async fn order_ignores(&self, mut ignores: Vec<Arc<Path>>) -> Vec<(Arc<Path>, IgnoreStack)> {
4628 let fs = self.fs.clone();
4629 let snapshot = self.state.lock().await.snapshot.clone();
4630 ignores.sort_unstable();
4631 let mut ignores_to_update = ignores.into_iter().peekable();
4632
4633 let mut result = vec![];
4634 while let Some(parent_abs_path) = ignores_to_update.next() {
4635 while ignores_to_update
4636 .peek()
4637 .map_or(false, |p| p.starts_with(&parent_abs_path))
4638 {
4639 ignores_to_update.next().unwrap();
4640 }
4641 let ignore_stack = snapshot
4642 .ignore_stack_for_abs_path(&parent_abs_path, true, fs.as_ref())
4643 .await;
4644 result.push((parent_abs_path, ignore_stack));
4645 }
4646
4647 result
4648 }
4649
4650 async fn update_ignore_status(&self, job: UpdateIgnoreStatusJob, snapshot: &LocalSnapshot) {
4651 log::trace!("update ignore status {:?}", job.abs_path);
4652
4653 let mut ignore_stack = job.ignore_stack;
4654 if let Some((ignore, _)) = snapshot.ignores_by_parent_abs_path.get(&job.abs_path) {
4655 ignore_stack = ignore_stack.append(job.abs_path.clone(), ignore.clone());
4656 }
4657
4658 let mut entries_by_id_edits = Vec::new();
4659 let mut entries_by_path_edits = Vec::new();
4660 let Some(path) = job
4661 .abs_path
4662 .strip_prefix(snapshot.abs_path.as_path())
4663 .map_err(|_| {
4664 anyhow::anyhow!(
4665 "Failed to strip prefix '{}' from path '{}'",
4666 snapshot.abs_path.as_path().display(),
4667 job.abs_path.display()
4668 )
4669 })
4670 .log_err()
4671 else {
4672 return;
4673 };
4674
4675 let Some(path) = RelPath::new(&path, PathStyle::local()).log_err() else {
4676 return;
4677 };
4678
4679 if let Ok(Some(metadata)) = self.fs.metadata(&job.abs_path.join(DOT_GIT)).await
4680 && metadata.is_dir
4681 {
4682 ignore_stack.repo_root = Some(job.abs_path.clone());
4683 }
4684
4685 for mut entry in snapshot.child_entries(&path).cloned() {
4686 let was_ignored = entry.is_ignored;
4687 let abs_path: Arc<Path> = snapshot.absolutize(&entry.path).into();
4688 entry.is_ignored = ignore_stack.is_abs_path_ignored(&abs_path, entry.is_dir());
4689
4690 if entry.is_dir() {
4691 let child_ignore_stack = if entry.is_ignored {
4692 IgnoreStack::all()
4693 } else {
4694 ignore_stack.clone()
4695 };
4696
4697 // Scan any directories that were previously ignored and weren't previously scanned.
4698 if was_ignored && !entry.is_ignored && entry.kind.is_unloaded() {
4699 let state = self.state.lock().await;
4700 if state.should_scan_directory(&entry) {
4701 state
4702 .enqueue_scan_dir(
4703 abs_path.clone(),
4704 &entry,
4705 &job.scan_queue,
4706 self.fs.as_ref(),
4707 )
4708 .await;
4709 }
4710 }
4711
4712 job.ignore_queue
4713 .send(UpdateIgnoreStatusJob {
4714 abs_path: abs_path.clone(),
4715 ignore_stack: child_ignore_stack,
4716 ignore_queue: job.ignore_queue.clone(),
4717 scan_queue: job.scan_queue.clone(),
4718 })
4719 .await
4720 .unwrap();
4721 }
4722
4723 if entry.is_ignored != was_ignored {
4724 let mut path_entry = snapshot.entries_by_id.get(&entry.id, ()).unwrap().clone();
4725 path_entry.scan_id = snapshot.scan_id;
4726 path_entry.is_ignored = entry.is_ignored;
4727 entries_by_id_edits.push(Edit::Insert(path_entry));
4728 entries_by_path_edits.push(Edit::Insert(entry));
4729 }
4730 }
4731
4732 let state = &mut self.state.lock().await;
4733 for edit in &entries_by_path_edits {
4734 if let Edit::Insert(entry) = edit
4735 && let Err(ix) = state.changed_paths.binary_search(&entry.path)
4736 {
4737 state.changed_paths.insert(ix, entry.path.clone());
4738 }
4739 }
4740
4741 state
4742 .snapshot
4743 .entries_by_path
4744 .edit(entries_by_path_edits, ());
4745 state.snapshot.entries_by_id.edit(entries_by_id_edits, ());
4746 }
4747
4748 async fn update_git_repositories(&self, dot_git_paths: Vec<PathBuf>) -> Vec<Arc<Path>> {
4749 log::trace!("reloading repositories: {dot_git_paths:?}");
4750 let mut state = self.state.lock().await;
4751 let scan_id = state.snapshot.scan_id;
4752 let mut affected_repo_roots = Vec::new();
4753 for dot_git_dir in dot_git_paths {
4754 let existing_repository_entry =
4755 state
4756 .snapshot
4757 .git_repositories
4758 .iter()
4759 .find_map(|(_, repo)| {
4760 let dot_git_dir = SanitizedPath::new(&dot_git_dir);
4761 if SanitizedPath::new(repo.common_dir_abs_path.as_ref()) == dot_git_dir
4762 || SanitizedPath::new(repo.repository_dir_abs_path.as_ref())
4763 == dot_git_dir
4764 {
4765 Some(repo.clone())
4766 } else {
4767 None
4768 }
4769 });
4770
4771 match existing_repository_entry {
4772 None => {
4773 let Ok(relative) = dot_git_dir.strip_prefix(state.snapshot.abs_path()) else {
4774 debug_panic!(
4775 "update_git_repositories called with .git directory outside the worktree root"
4776 );
4777 return Vec::new();
4778 };
4779 affected_repo_roots.push(dot_git_dir.parent().unwrap().into());
4780 state
4781 .insert_git_repository(
4782 RelPath::new(relative, PathStyle::local())
4783 .unwrap()
4784 .into_arc(),
4785 self.fs.as_ref(),
4786 self.watcher.as_ref(),
4787 )
4788 .await;
4789 }
4790 Some(local_repository) => {
4791 state.snapshot.git_repositories.update(
4792 &local_repository.work_directory_id,
4793 |entry| {
4794 entry.git_dir_scan_id = scan_id;
4795 },
4796 );
4797 }
4798 };
4799 }
4800
4801 // Remove any git repositories whose .git entry no longer exists.
4802 let snapshot = &mut state.snapshot;
4803 let mut ids_to_preserve = HashSet::default();
4804 for (&work_directory_id, entry) in snapshot.git_repositories.iter() {
4805 let exists_in_snapshot =
4806 snapshot
4807 .entry_for_id(work_directory_id)
4808 .is_some_and(|entry| {
4809 snapshot
4810 .entry_for_path(&entry.path.join(RelPath::unix(DOT_GIT).unwrap()))
4811 .is_some()
4812 });
4813
4814 if exists_in_snapshot
4815 || matches!(
4816 self.fs.metadata(&entry.common_dir_abs_path).await,
4817 Ok(Some(_))
4818 )
4819 {
4820 ids_to_preserve.insert(work_directory_id);
4821 }
4822 }
4823
4824 snapshot
4825 .git_repositories
4826 .retain(|work_directory_id, entry| {
4827 let preserve = ids_to_preserve.contains(work_directory_id);
4828 if !preserve {
4829 affected_repo_roots.push(entry.dot_git_abs_path.parent().unwrap().into());
4830 }
4831 preserve
4832 });
4833
4834 affected_repo_roots
4835 }
4836
4837 async fn progress_timer(&self, running: bool) {
4838 if !running {
4839 return futures::future::pending().await;
4840 }
4841
4842 #[cfg(any(test, feature = "test-support"))]
4843 if self.fs.is_fake() {
4844 return self.executor.simulate_random_delay().await;
4845 }
4846
4847 smol::Timer::after(FS_WATCH_LATENCY).await;
4848 }
4849
4850 fn is_path_private(&self, path: &RelPath) -> bool {
4851 !self.share_private_files && self.settings.is_path_private(path)
4852 }
4853
4854 async fn next_scan_request(&self) -> Result<ScanRequest> {
4855 let mut request = self.scan_requests_rx.recv().await?;
4856 while let Ok(next_request) = self.scan_requests_rx.try_recv() {
4857 request.relative_paths.extend(next_request.relative_paths);
4858 request.done.extend(next_request.done);
4859 }
4860 Ok(request)
4861 }
4862}
4863
4864async fn discover_ancestor_git_repo(
4865 fs: Arc<dyn Fs>,
4866 root_abs_path: &SanitizedPath,
4867) -> (
4868 HashMap<Arc<Path>, (Arc<Gitignore>, bool)>,
4869 Option<(PathBuf, WorkDirectory)>,
4870) {
4871 let mut ignores = HashMap::default();
4872 for (index, ancestor) in root_abs_path.as_path().ancestors().enumerate() {
4873 if index != 0 {
4874 if ancestor == paths::home_dir() {
4875 // Unless $HOME is itself the worktree root, don't consider it as a
4876 // containing git repository---expensive and likely unwanted.
4877 break;
4878 } else if let Ok(ignore) = build_gitignore(&ancestor.join(GITIGNORE), fs.as_ref()).await
4879 {
4880 ignores.insert(ancestor.into(), (ignore.into(), false));
4881 }
4882 }
4883
4884 let ancestor_dot_git = ancestor.join(DOT_GIT);
4885 log::trace!("considering ancestor: {ancestor_dot_git:?}");
4886 // Check whether the directory or file called `.git` exists (in the
4887 // case of worktrees it's a file.)
4888 if fs
4889 .metadata(&ancestor_dot_git)
4890 .await
4891 .is_ok_and(|metadata| metadata.is_some())
4892 {
4893 if index != 0 {
4894 // We canonicalize, since the FS events use the canonicalized path.
4895 if let Some(ancestor_dot_git) = fs.canonicalize(&ancestor_dot_git).await.log_err() {
4896 let location_in_repo = root_abs_path
4897 .as_path()
4898 .strip_prefix(ancestor)
4899 .unwrap()
4900 .into();
4901 log::info!("inserting parent git repo for this worktree: {location_in_repo:?}");
4902 // We associate the external git repo with our root folder and
4903 // also mark where in the git repo the root folder is located.
4904 return (
4905 ignores,
4906 Some((
4907 ancestor_dot_git,
4908 WorkDirectory::AboveProject {
4909 absolute_path: ancestor.into(),
4910 location_in_repo,
4911 },
4912 )),
4913 );
4914 };
4915 }
4916
4917 // Reached root of git repository.
4918 break;
4919 }
4920 }
4921
4922 (ignores, None)
4923}
4924
4925fn build_diff(
4926 phase: BackgroundScannerPhase,
4927 old_snapshot: &Snapshot,
4928 new_snapshot: &Snapshot,
4929 event_paths: &[Arc<RelPath>],
4930) -> UpdatedEntriesSet {
4931 use BackgroundScannerPhase::*;
4932 use PathChange::{Added, AddedOrUpdated, Loaded, Removed, Updated};
4933
4934 // Identify which paths have changed. Use the known set of changed
4935 // parent paths to optimize the search.
4936 let mut changes = Vec::new();
4937 let mut old_paths = old_snapshot.entries_by_path.cursor::<PathKey>(());
4938 let mut new_paths = new_snapshot.entries_by_path.cursor::<PathKey>(());
4939 let mut last_newly_loaded_dir_path = None;
4940 old_paths.next();
4941 new_paths.next();
4942 for path in event_paths {
4943 let path = PathKey(path.clone());
4944 if old_paths.item().is_some_and(|e| e.path < path.0) {
4945 old_paths.seek_forward(&path, Bias::Left);
4946 }
4947 if new_paths.item().is_some_and(|e| e.path < path.0) {
4948 new_paths.seek_forward(&path, Bias::Left);
4949 }
4950 loop {
4951 match (old_paths.item(), new_paths.item()) {
4952 (Some(old_entry), Some(new_entry)) => {
4953 if old_entry.path > path.0
4954 && new_entry.path > path.0
4955 && !old_entry.path.starts_with(&path.0)
4956 && !new_entry.path.starts_with(&path.0)
4957 {
4958 break;
4959 }
4960
4961 match Ord::cmp(&old_entry.path, &new_entry.path) {
4962 Ordering::Less => {
4963 changes.push((old_entry.path.clone(), old_entry.id, Removed));
4964 old_paths.next();
4965 }
4966 Ordering::Equal => {
4967 if phase == EventsReceivedDuringInitialScan {
4968 if old_entry.id != new_entry.id {
4969 changes.push((old_entry.path.clone(), old_entry.id, Removed));
4970 }
4971 // If the worktree was not fully initialized when this event was generated,
4972 // we can't know whether this entry was added during the scan or whether
4973 // it was merely updated.
4974 changes.push((
4975 new_entry.path.clone(),
4976 new_entry.id,
4977 AddedOrUpdated,
4978 ));
4979 } else if old_entry.id != new_entry.id {
4980 changes.push((old_entry.path.clone(), old_entry.id, Removed));
4981 changes.push((new_entry.path.clone(), new_entry.id, Added));
4982 } else if old_entry != new_entry {
4983 if old_entry.kind.is_unloaded() {
4984 last_newly_loaded_dir_path = Some(&new_entry.path);
4985 changes.push((new_entry.path.clone(), new_entry.id, Loaded));
4986 } else {
4987 changes.push((new_entry.path.clone(), new_entry.id, Updated));
4988 }
4989 }
4990 old_paths.next();
4991 new_paths.next();
4992 }
4993 Ordering::Greater => {
4994 let is_newly_loaded = phase == InitialScan
4995 || last_newly_loaded_dir_path
4996 .as_ref()
4997 .is_some_and(|dir| new_entry.path.starts_with(dir));
4998 changes.push((
4999 new_entry.path.clone(),
5000 new_entry.id,
5001 if is_newly_loaded { Loaded } else { Added },
5002 ));
5003 new_paths.next();
5004 }
5005 }
5006 }
5007 (Some(old_entry), None) => {
5008 changes.push((old_entry.path.clone(), old_entry.id, Removed));
5009 old_paths.next();
5010 }
5011 (None, Some(new_entry)) => {
5012 let is_newly_loaded = phase == InitialScan
5013 || last_newly_loaded_dir_path
5014 .as_ref()
5015 .is_some_and(|dir| new_entry.path.starts_with(dir));
5016 changes.push((
5017 new_entry.path.clone(),
5018 new_entry.id,
5019 if is_newly_loaded { Loaded } else { Added },
5020 ));
5021 new_paths.next();
5022 }
5023 (None, None) => break,
5024 }
5025 }
5026 }
5027
5028 changes.into()
5029}
5030
5031fn swap_to_front(child_paths: &mut Vec<PathBuf>, file: &str) {
5032 let position = child_paths
5033 .iter()
5034 .position(|path| path.file_name().unwrap() == file);
5035 if let Some(position) = position {
5036 let temp = child_paths.remove(position);
5037 child_paths.insert(0, temp);
5038 }
5039}
5040
5041fn char_bag_for_path(root_char_bag: CharBag, path: &RelPath) -> CharBag {
5042 let mut result = root_char_bag;
5043 result.extend(path.as_unix_str().chars().map(|c| c.to_ascii_lowercase()));
5044 result
5045}
5046
5047#[derive(Debug)]
5048struct ScanJob {
5049 abs_path: Arc<Path>,
5050 path: Arc<RelPath>,
5051 ignore_stack: IgnoreStack,
5052 scan_queue: Sender<ScanJob>,
5053 ancestor_inodes: TreeSet<u64>,
5054 is_external: bool,
5055}
5056
5057struct UpdateIgnoreStatusJob {
5058 abs_path: Arc<Path>,
5059 ignore_stack: IgnoreStack,
5060 ignore_queue: Sender<UpdateIgnoreStatusJob>,
5061 scan_queue: Sender<ScanJob>,
5062}
5063
5064pub trait WorktreeModelHandle {
5065 #[cfg(any(test, feature = "test-support"))]
5066 fn flush_fs_events<'a>(
5067 &self,
5068 cx: &'a mut gpui::TestAppContext,
5069 ) -> futures::future::LocalBoxFuture<'a, ()>;
5070
5071 #[cfg(any(test, feature = "test-support"))]
5072 fn flush_fs_events_in_root_git_repository<'a>(
5073 &self,
5074 cx: &'a mut gpui::TestAppContext,
5075 ) -> futures::future::LocalBoxFuture<'a, ()>;
5076}
5077
5078impl WorktreeModelHandle for Entity<Worktree> {
5079 // When the worktree's FS event stream sometimes delivers "redundant" events for FS changes that
5080 // occurred before the worktree was constructed. These events can cause the worktree to perform
5081 // extra directory scans, and emit extra scan-state notifications.
5082 //
5083 // This function mutates the worktree's directory and waits for those mutations to be picked up,
5084 // to ensure that all redundant FS events have already been processed.
5085 #[cfg(any(test, feature = "test-support"))]
5086 fn flush_fs_events<'a>(
5087 &self,
5088 cx: &'a mut gpui::TestAppContext,
5089 ) -> futures::future::LocalBoxFuture<'a, ()> {
5090 let file_name = "fs-event-sentinel";
5091
5092 let tree = self.clone();
5093 let (fs, root_path) = self.read_with(cx, |tree, _| {
5094 let tree = tree.as_local().unwrap();
5095 (tree.fs.clone(), tree.abs_path.clone())
5096 });
5097
5098 async move {
5099 fs.create_file(&root_path.join(file_name), Default::default())
5100 .await
5101 .unwrap();
5102
5103 let mut events = cx.events(&tree);
5104 while events.next().await.is_some() {
5105 if tree.read_with(cx, |tree, _| {
5106 tree.entry_for_path(RelPath::unix(file_name).unwrap())
5107 .is_some()
5108 }) {
5109 break;
5110 }
5111 }
5112
5113 fs.remove_file(&root_path.join(file_name), Default::default())
5114 .await
5115 .unwrap();
5116 while events.next().await.is_some() {
5117 if tree.read_with(cx, |tree, _| {
5118 tree.entry_for_path(RelPath::unix(file_name).unwrap())
5119 .is_none()
5120 }) {
5121 break;
5122 }
5123 }
5124
5125 cx.update(|cx| tree.read(cx).as_local().unwrap().scan_complete())
5126 .await;
5127 }
5128 .boxed_local()
5129 }
5130
5131 // This function is similar to flush_fs_events, except that it waits for events to be flushed in
5132 // the .git folder of the root repository.
5133 // The reason for its existence is that a repository's .git folder might live *outside* of the
5134 // worktree and thus its FS events might go through a different path.
5135 // In order to flush those, we need to create artificial events in the .git folder and wait
5136 // for the repository to be reloaded.
5137 #[cfg(any(test, feature = "test-support"))]
5138 fn flush_fs_events_in_root_git_repository<'a>(
5139 &self,
5140 cx: &'a mut gpui::TestAppContext,
5141 ) -> futures::future::LocalBoxFuture<'a, ()> {
5142 let file_name = "fs-event-sentinel";
5143
5144 let tree = self.clone();
5145 let (fs, root_path, mut git_dir_scan_id) = self.read_with(cx, |tree, _| {
5146 let tree = tree.as_local().unwrap();
5147 let local_repo_entry = tree
5148 .git_repositories
5149 .values()
5150 .min_by_key(|local_repo_entry| local_repo_entry.work_directory.clone())
5151 .unwrap();
5152 (
5153 tree.fs.clone(),
5154 local_repo_entry.common_dir_abs_path.clone(),
5155 local_repo_entry.git_dir_scan_id,
5156 )
5157 });
5158
5159 let scan_id_increased = |tree: &mut Worktree, git_dir_scan_id: &mut usize| {
5160 let tree = tree.as_local().unwrap();
5161 // let repository = tree.repositories.first().unwrap();
5162 let local_repo_entry = tree
5163 .git_repositories
5164 .values()
5165 .min_by_key(|local_repo_entry| local_repo_entry.work_directory.clone())
5166 .unwrap();
5167
5168 if local_repo_entry.git_dir_scan_id > *git_dir_scan_id {
5169 *git_dir_scan_id = local_repo_entry.git_dir_scan_id;
5170 true
5171 } else {
5172 false
5173 }
5174 };
5175
5176 async move {
5177 fs.create_file(&root_path.join(file_name), Default::default())
5178 .await
5179 .unwrap();
5180
5181 let mut events = cx.events(&tree);
5182 while events.next().await.is_some() {
5183 if tree.update(cx, |tree, _| scan_id_increased(tree, &mut git_dir_scan_id)) {
5184 break;
5185 }
5186 }
5187
5188 fs.remove_file(&root_path.join(file_name), Default::default())
5189 .await
5190 .unwrap();
5191
5192 while events.next().await.is_some() {
5193 if tree.update(cx, |tree, _| scan_id_increased(tree, &mut git_dir_scan_id)) {
5194 break;
5195 }
5196 }
5197
5198 cx.update(|cx| tree.read(cx).as_local().unwrap().scan_complete())
5199 .await;
5200 }
5201 .boxed_local()
5202 }
5203}
5204
5205#[derive(Clone, Debug)]
5206struct TraversalProgress<'a> {
5207 max_path: &'a RelPath,
5208 count: usize,
5209 non_ignored_count: usize,
5210 file_count: usize,
5211 non_ignored_file_count: usize,
5212}
5213
5214impl TraversalProgress<'_> {
5215 fn count(&self, include_files: bool, include_dirs: bool, include_ignored: bool) -> usize {
5216 match (include_files, include_dirs, include_ignored) {
5217 (true, true, true) => self.count,
5218 (true, true, false) => self.non_ignored_count,
5219 (true, false, true) => self.file_count,
5220 (true, false, false) => self.non_ignored_file_count,
5221 (false, true, true) => self.count - self.file_count,
5222 (false, true, false) => self.non_ignored_count - self.non_ignored_file_count,
5223 (false, false, _) => 0,
5224 }
5225 }
5226}
5227
5228impl<'a> sum_tree::Dimension<'a, EntrySummary> for TraversalProgress<'a> {
5229 fn zero(_cx: ()) -> Self {
5230 Default::default()
5231 }
5232
5233 fn add_summary(&mut self, summary: &'a EntrySummary, _: ()) {
5234 self.max_path = summary.max_path.as_ref();
5235 self.count += summary.count;
5236 self.non_ignored_count += summary.non_ignored_count;
5237 self.file_count += summary.file_count;
5238 self.non_ignored_file_count += summary.non_ignored_file_count;
5239 }
5240}
5241
5242impl Default for TraversalProgress<'_> {
5243 fn default() -> Self {
5244 Self {
5245 max_path: RelPath::empty(),
5246 count: 0,
5247 non_ignored_count: 0,
5248 file_count: 0,
5249 non_ignored_file_count: 0,
5250 }
5251 }
5252}
5253
5254#[derive(Debug)]
5255pub struct Traversal<'a> {
5256 snapshot: &'a Snapshot,
5257 cursor: sum_tree::Cursor<'a, 'static, Entry, TraversalProgress<'a>>,
5258 include_ignored: bool,
5259 include_files: bool,
5260 include_dirs: bool,
5261}
5262
5263impl<'a> Traversal<'a> {
5264 fn new(
5265 snapshot: &'a Snapshot,
5266 include_files: bool,
5267 include_dirs: bool,
5268 include_ignored: bool,
5269 start_path: &RelPath,
5270 ) -> Self {
5271 let mut cursor = snapshot.entries_by_path.cursor(());
5272 cursor.seek(&TraversalTarget::path(start_path), Bias::Left);
5273 let mut traversal = Self {
5274 snapshot,
5275 cursor,
5276 include_files,
5277 include_dirs,
5278 include_ignored,
5279 };
5280 if traversal.end_offset() == traversal.start_offset() {
5281 traversal.next();
5282 }
5283 traversal
5284 }
5285
5286 pub fn advance(&mut self) -> bool {
5287 self.advance_by(1)
5288 }
5289
5290 pub fn advance_by(&mut self, count: usize) -> bool {
5291 self.cursor.seek_forward(
5292 &TraversalTarget::Count {
5293 count: self.end_offset() + count,
5294 include_dirs: self.include_dirs,
5295 include_files: self.include_files,
5296 include_ignored: self.include_ignored,
5297 },
5298 Bias::Left,
5299 )
5300 }
5301
5302 pub fn advance_to_sibling(&mut self) -> bool {
5303 while let Some(entry) = self.cursor.item() {
5304 self.cursor
5305 .seek_forward(&TraversalTarget::successor(&entry.path), Bias::Left);
5306 if let Some(entry) = self.cursor.item()
5307 && (self.include_files || !entry.is_file())
5308 && (self.include_dirs || !entry.is_dir())
5309 && (self.include_ignored || !entry.is_ignored || entry.is_always_included)
5310 {
5311 return true;
5312 }
5313 }
5314 false
5315 }
5316
5317 pub fn back_to_parent(&mut self) -> bool {
5318 let Some(parent_path) = self.cursor.item().and_then(|entry| entry.path.parent()) else {
5319 return false;
5320 };
5321 self.cursor
5322 .seek(&TraversalTarget::path(parent_path), Bias::Left)
5323 }
5324
5325 pub fn entry(&self) -> Option<&'a Entry> {
5326 self.cursor.item()
5327 }
5328
5329 pub fn snapshot(&self) -> &'a Snapshot {
5330 self.snapshot
5331 }
5332
5333 pub fn start_offset(&self) -> usize {
5334 self.cursor
5335 .start()
5336 .count(self.include_files, self.include_dirs, self.include_ignored)
5337 }
5338
5339 pub fn end_offset(&self) -> usize {
5340 self.cursor
5341 .end()
5342 .count(self.include_files, self.include_dirs, self.include_ignored)
5343 }
5344}
5345
5346impl<'a> Iterator for Traversal<'a> {
5347 type Item = &'a Entry;
5348
5349 fn next(&mut self) -> Option<Self::Item> {
5350 if let Some(item) = self.entry() {
5351 self.advance();
5352 Some(item)
5353 } else {
5354 None
5355 }
5356 }
5357}
5358
5359#[derive(Debug, Clone, Copy)]
5360pub enum PathTarget<'a> {
5361 Path(&'a RelPath),
5362 Successor(&'a RelPath),
5363}
5364
5365impl PathTarget<'_> {
5366 fn cmp_path(&self, other: &RelPath) -> Ordering {
5367 match self {
5368 PathTarget::Path(path) => path.cmp(&other),
5369 PathTarget::Successor(path) => {
5370 if other.starts_with(path) {
5371 Ordering::Greater
5372 } else {
5373 Ordering::Equal
5374 }
5375 }
5376 }
5377 }
5378}
5379
5380impl<'a, S: Summary> SeekTarget<'a, PathSummary<S>, PathProgress<'a>> for PathTarget<'_> {
5381 fn cmp(&self, cursor_location: &PathProgress<'a>, _: S::Context<'_>) -> Ordering {
5382 self.cmp_path(cursor_location.max_path)
5383 }
5384}
5385
5386impl<'a, S: Summary> SeekTarget<'a, PathSummary<S>, TraversalProgress<'a>> for PathTarget<'_> {
5387 fn cmp(&self, cursor_location: &TraversalProgress<'a>, _: S::Context<'_>) -> Ordering {
5388 self.cmp_path(cursor_location.max_path)
5389 }
5390}
5391
5392#[derive(Debug)]
5393enum TraversalTarget<'a> {
5394 Path(PathTarget<'a>),
5395 Count {
5396 count: usize,
5397 include_files: bool,
5398 include_ignored: bool,
5399 include_dirs: bool,
5400 },
5401}
5402
5403impl<'a> TraversalTarget<'a> {
5404 fn path(path: &'a RelPath) -> Self {
5405 Self::Path(PathTarget::Path(path))
5406 }
5407
5408 fn successor(path: &'a RelPath) -> Self {
5409 Self::Path(PathTarget::Successor(path))
5410 }
5411
5412 fn cmp_progress(&self, progress: &TraversalProgress) -> Ordering {
5413 match self {
5414 TraversalTarget::Path(path) => path.cmp_path(progress.max_path),
5415 TraversalTarget::Count {
5416 count,
5417 include_files,
5418 include_dirs,
5419 include_ignored,
5420 } => Ord::cmp(
5421 count,
5422 &progress.count(*include_files, *include_dirs, *include_ignored),
5423 ),
5424 }
5425 }
5426}
5427
5428impl<'a> SeekTarget<'a, EntrySummary, TraversalProgress<'a>> for TraversalTarget<'_> {
5429 fn cmp(&self, cursor_location: &TraversalProgress<'a>, _: ()) -> Ordering {
5430 self.cmp_progress(cursor_location)
5431 }
5432}
5433
5434impl<'a> SeekTarget<'a, PathSummary<sum_tree::NoSummary>, TraversalProgress<'a>>
5435 for TraversalTarget<'_>
5436{
5437 fn cmp(&self, cursor_location: &TraversalProgress<'a>, _: ()) -> Ordering {
5438 self.cmp_progress(cursor_location)
5439 }
5440}
5441
5442pub struct ChildEntriesOptions {
5443 pub include_files: bool,
5444 pub include_dirs: bool,
5445 pub include_ignored: bool,
5446}
5447
5448pub struct ChildEntriesIter<'a> {
5449 parent_path: &'a RelPath,
5450 traversal: Traversal<'a>,
5451}
5452
5453impl<'a> Iterator for ChildEntriesIter<'a> {
5454 type Item = &'a Entry;
5455
5456 fn next(&mut self) -> Option<Self::Item> {
5457 if let Some(item) = self.traversal.entry()
5458 && item.path.starts_with(self.parent_path)
5459 {
5460 self.traversal.advance_to_sibling();
5461 return Some(item);
5462 }
5463 None
5464 }
5465}
5466
5467impl<'a> From<&'a Entry> for proto::Entry {
5468 fn from(entry: &'a Entry) -> Self {
5469 Self {
5470 id: entry.id.to_proto(),
5471 is_dir: entry.is_dir(),
5472 path: entry.path.as_ref().to_proto(),
5473 inode: entry.inode,
5474 mtime: entry.mtime.map(|time| time.into()),
5475 is_ignored: entry.is_ignored,
5476 is_hidden: entry.is_hidden,
5477 is_external: entry.is_external,
5478 is_fifo: entry.is_fifo,
5479 size: Some(entry.size),
5480 canonical_path: entry
5481 .canonical_path
5482 .as_ref()
5483 .map(|path| path.to_string_lossy().into_owned()),
5484 }
5485 }
5486}
5487
5488impl TryFrom<(&CharBag, &PathMatcher, proto::Entry)> for Entry {
5489 type Error = anyhow::Error;
5490
5491 fn try_from(
5492 (root_char_bag, always_included, entry): (&CharBag, &PathMatcher, proto::Entry),
5493 ) -> Result<Self> {
5494 let kind = if entry.is_dir {
5495 EntryKind::Dir
5496 } else {
5497 EntryKind::File
5498 };
5499
5500 let path =
5501 RelPath::from_proto(&entry.path).context("invalid relative path in proto message")?;
5502 let char_bag = char_bag_for_path(*root_char_bag, &path);
5503 let is_always_included = always_included.is_match(path.as_std_path());
5504 Ok(Entry {
5505 id: ProjectEntryId::from_proto(entry.id),
5506 kind,
5507 path,
5508 inode: entry.inode,
5509 mtime: entry.mtime.map(|time| time.into()),
5510 size: entry.size.unwrap_or(0),
5511 canonical_path: entry
5512 .canonical_path
5513 .map(|path_string| Arc::from(PathBuf::from(path_string))),
5514 is_ignored: entry.is_ignored,
5515 is_hidden: entry.is_hidden,
5516 is_always_included,
5517 is_external: entry.is_external,
5518 is_private: false,
5519 char_bag,
5520 is_fifo: entry.is_fifo,
5521 })
5522 }
5523}
5524
5525#[derive(Clone, Copy, Debug, Default, Hash, PartialEq, Eq, PartialOrd, Ord)]
5526pub struct ProjectEntryId(usize);
5527
5528impl ProjectEntryId {
5529 pub const MAX: Self = Self(usize::MAX);
5530 pub const MIN: Self = Self(usize::MIN);
5531
5532 pub fn new(counter: &AtomicUsize) -> Self {
5533 Self(counter.fetch_add(1, SeqCst))
5534 }
5535
5536 pub fn from_proto(id: u64) -> Self {
5537 Self(id as usize)
5538 }
5539
5540 pub fn to_proto(self) -> u64 {
5541 self.0 as u64
5542 }
5543
5544 pub fn from_usize(id: usize) -> Self {
5545 ProjectEntryId(id)
5546 }
5547
5548 pub fn to_usize(self) -> usize {
5549 self.0
5550 }
5551}
5552
5553#[cfg(any(test, feature = "test-support"))]
5554impl CreatedEntry {
5555 pub fn into_included(self) -> Option<Entry> {
5556 match self {
5557 CreatedEntry::Included(entry) => Some(entry),
5558 CreatedEntry::Excluded { .. } => None,
5559 }
5560 }
5561}
5562
5563fn parse_gitfile(content: &str) -> anyhow::Result<&Path> {
5564 let path = content
5565 .strip_prefix("gitdir:")
5566 .with_context(|| format!("parsing gitfile content {content:?}"))?;
5567 Ok(Path::new(path.trim()))
5568}
5569
5570async fn discover_git_paths(dot_git_abs_path: &Arc<Path>, fs: &dyn Fs) -> (Arc<Path>, Arc<Path>) {
5571 let mut repository_dir_abs_path = dot_git_abs_path.clone();
5572 let mut common_dir_abs_path = dot_git_abs_path.clone();
5573
5574 if let Some(path) = fs
5575 .load(dot_git_abs_path)
5576 .await
5577 .ok()
5578 .as_ref()
5579 .and_then(|contents| parse_gitfile(contents).log_err())
5580 {
5581 let path = dot_git_abs_path
5582 .parent()
5583 .unwrap_or(Path::new(""))
5584 .join(path);
5585 if let Some(path) = fs.canonicalize(&path).await.log_err() {
5586 repository_dir_abs_path = Path::new(&path).into();
5587 common_dir_abs_path = repository_dir_abs_path.clone();
5588
5589 if let Some(commondir_contents) = fs.load(&path.join("commondir")).await.ok()
5590 && let Some(commondir_path) = fs
5591 .canonicalize(&path.join(commondir_contents.trim()))
5592 .await
5593 .log_err()
5594 {
5595 common_dir_abs_path = commondir_path.as_path().into();
5596 }
5597 }
5598 };
5599 (repository_dir_abs_path, common_dir_abs_path)
5600}