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