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