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