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