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