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