1use crate::{
2 copy_recursive, ignore::IgnoreStack, DiagnosticSummary, ProjectEntryId, RemoveOptions,
3};
4use ::ignore::gitignore::{Gitignore, GitignoreBuilder};
5use anyhow::{anyhow, Context, Result};
6use client::{proto, Client};
7use clock::ReplicaId;
8use collections::{HashMap, VecDeque};
9use fs::{
10 repository::{GitFileStatus, GitRepository, RepoPath, RepoPathDescendants},
11 Fs, LineEnding,
12};
13use futures::{
14 channel::{
15 mpsc::{self, UnboundedSender},
16 oneshot,
17 },
18 select_biased,
19 task::Poll,
20 Stream, StreamExt,
21};
22use fuzzy::CharBag;
23use git::{DOT_GIT, GITIGNORE};
24use gpui::{executor, AppContext, AsyncAppContext, Entity, ModelContext, ModelHandle, Task};
25use language::{
26 proto::{
27 deserialize_fingerprint, deserialize_version, serialize_fingerprint, serialize_line_ending,
28 serialize_version,
29 },
30 Buffer, DiagnosticEntry, File as _, PointUtf16, Rope, RopeFingerprint, Unclipped,
31};
32use lsp::LanguageServerId;
33use parking_lot::Mutex;
34use postage::{
35 barrier,
36 prelude::{Sink as _, Stream as _},
37 watch,
38};
39use smol::channel::{self, Sender};
40use std::{
41 any::Any,
42 cmp::{self, Ordering},
43 convert::TryFrom,
44 ffi::OsStr,
45 fmt,
46 future::Future,
47 mem,
48 ops::{Deref, DerefMut},
49 path::{Path, PathBuf},
50 pin::Pin,
51 sync::{
52 atomic::{AtomicUsize, Ordering::SeqCst},
53 Arc,
54 },
55 time::{Duration, SystemTime},
56};
57use sum_tree::{Bias, Edit, SeekTarget, SumTree, TreeMap, TreeSet};
58use util::{paths::HOME, ResultExt, TryFutureExt, TakeUntilExt};
59
60#[derive(Copy, Clone, PartialEq, Eq, Debug, Hash, PartialOrd, Ord)]
61pub struct WorktreeId(usize);
62
63pub enum Worktree {
64 Local(LocalWorktree),
65 Remote(RemoteWorktree),
66}
67
68pub struct LocalWorktree {
69 snapshot: LocalSnapshot,
70 path_changes_tx: channel::Sender<(Vec<PathBuf>, barrier::Sender)>,
71 is_scanning: (watch::Sender<bool>, watch::Receiver<bool>),
72 _background_scanner_task: Task<()>,
73 share: Option<ShareState>,
74 diagnostics: HashMap<
75 Arc<Path>,
76 Vec<(
77 LanguageServerId,
78 Vec<DiagnosticEntry<Unclipped<PointUtf16>>>,
79 )>,
80 >,
81 diagnostic_summaries: HashMap<Arc<Path>, HashMap<LanguageServerId, DiagnosticSummary>>,
82 client: Arc<Client>,
83 fs: Arc<dyn Fs>,
84 visible: bool,
85}
86
87pub struct RemoteWorktree {
88 snapshot: Snapshot,
89 background_snapshot: Arc<Mutex<Snapshot>>,
90 project_id: u64,
91 client: Arc<Client>,
92 updates_tx: Option<UnboundedSender<proto::UpdateWorktree>>,
93 snapshot_subscriptions: VecDeque<(usize, oneshot::Sender<()>)>,
94 replica_id: ReplicaId,
95 diagnostic_summaries: HashMap<Arc<Path>, HashMap<LanguageServerId, DiagnosticSummary>>,
96 visible: bool,
97 disconnected: bool,
98}
99
100#[derive(Clone)]
101pub struct Snapshot {
102 id: WorktreeId,
103 abs_path: Arc<Path>,
104 root_name: String,
105 root_char_bag: CharBag,
106 entries_by_path: SumTree<Entry>,
107 entries_by_id: SumTree<PathEntry>,
108 repository_entries: TreeMap<RepositoryWorkDirectory, RepositoryEntry>,
109
110 /// A number that increases every time the worktree begins scanning
111 /// a set of paths from the filesystem. This scanning could be caused
112 /// by some operation performed on the worktree, such as reading or
113 /// writing a file, or by an event reported by the filesystem.
114 scan_id: usize,
115
116 /// The latest scan id that has completed, and whose preceding scans
117 /// have all completed. The current `scan_id` could be more than one
118 /// greater than the `completed_scan_id` if operations are performed
119 /// on the worktree while it is processing a file-system event.
120 completed_scan_id: usize,
121}
122
123impl Snapshot {
124 pub fn repo_for(&self, path: &Path) -> Option<RepositoryEntry> {
125 let mut max_len = 0;
126 let mut current_candidate = None;
127 for (work_directory, repo) in (&self.repository_entries).iter() {
128 if repo.contains(self, path) {
129 if work_directory.0.as_os_str().len() >= max_len {
130 current_candidate = Some(repo);
131 max_len = work_directory.0.as_os_str().len();
132 } else {
133 break;
134 }
135 }
136 }
137
138 current_candidate.map(|entry| entry.to_owned())
139 }
140}
141
142#[derive(Clone, Debug, PartialEq, Eq)]
143pub struct RepositoryEntry {
144 pub(crate) work_directory: WorkDirectoryEntry,
145 pub(crate) branch: Option<Arc<str>>,
146 pub(crate) statuses: TreeMap<RepoPath, GitFileStatus>,
147}
148
149fn read_git_status(git_status: i32) -> Option<GitFileStatus> {
150 proto::GitStatus::from_i32(git_status).map(|status| match status {
151 proto::GitStatus::Added => GitFileStatus::Added,
152 proto::GitStatus::Modified => GitFileStatus::Modified,
153 proto::GitStatus::Conflict => GitFileStatus::Conflict,
154 })
155}
156
157impl RepositoryEntry {
158 pub fn branch(&self) -> Option<Arc<str>> {
159 self.branch.clone()
160 }
161
162 pub fn work_directory_id(&self) -> ProjectEntryId {
163 *self.work_directory
164 }
165
166 pub fn work_directory(&self, snapshot: &Snapshot) -> Option<RepositoryWorkDirectory> {
167 snapshot
168 .entry_for_id(self.work_directory_id())
169 .map(|entry| RepositoryWorkDirectory(entry.path.clone()))
170 }
171
172 pub(crate) fn contains(&self, snapshot: &Snapshot, path: &Path) -> bool {
173 self.work_directory.contains(snapshot, path)
174 }
175
176 pub fn status_for_file(&self, snapshot: &Snapshot, path: &Path) -> Option<GitFileStatus> {
177 self.work_directory
178 .relativize(snapshot, path)
179 .and_then(|repo_path| self.statuses.get(&repo_path))
180 .cloned()
181 }
182
183 pub fn status_for_path(&self, snapshot: &Snapshot, path: &Path) -> Option<GitFileStatus> {
184 self.work_directory
185 .relativize(snapshot, path)
186 .and_then(|repo_path| {
187 self.statuses
188 .iter_from(&repo_path)
189 .take_while(|(key, _)| key.starts_with(&repo_path))
190 // Short circut once we've found the highest level
191 .take_until(|(_, status)| status == &&GitFileStatus::Conflict)
192 .map(|(_, status)| status)
193 .reduce(
194 |status_first, status_second| match (status_first, status_second) {
195 (GitFileStatus::Conflict, _) | (_, GitFileStatus::Conflict) => {
196 &GitFileStatus::Conflict
197 }
198 (GitFileStatus::Modified, _) | (_, GitFileStatus::Modified) => {
199 &GitFileStatus::Modified
200 }
201 _ => &GitFileStatus::Added,
202 },
203 )
204 .copied()
205 })
206 }
207
208 pub fn build_update(&self, other: &Self) -> proto::RepositoryEntry {
209 let mut updated_statuses: Vec<proto::StatusEntry> = Vec::new();
210 let mut removed_statuses: Vec<String> = Vec::new();
211
212 let mut self_statuses = self.statuses.iter().peekable();
213 let mut other_statuses = other.statuses.iter().peekable();
214 loop {
215 match (self_statuses.peek(), other_statuses.peek()) {
216 (Some((self_repo_path, self_status)), Some((other_repo_path, other_status))) => {
217 match Ord::cmp(self_repo_path, other_repo_path) {
218 Ordering::Less => {
219 updated_statuses.push(make_status_entry(self_repo_path, self_status));
220 self_statuses.next();
221 }
222 Ordering::Equal => {
223 if self_status != other_status {
224 updated_statuses
225 .push(make_status_entry(self_repo_path, self_status));
226 }
227
228 self_statuses.next();
229 other_statuses.next();
230 }
231 Ordering::Greater => {
232 removed_statuses.push(make_repo_path(other_repo_path));
233 other_statuses.next();
234 }
235 }
236 }
237 (Some((self_repo_path, self_status)), None) => {
238 updated_statuses.push(make_status_entry(self_repo_path, self_status));
239 self_statuses.next();
240 }
241 (None, Some((other_repo_path, _))) => {
242 removed_statuses.push(make_repo_path(other_repo_path));
243 other_statuses.next();
244 }
245 (None, None) => break,
246 }
247 }
248
249 proto::RepositoryEntry {
250 work_directory_id: self.work_directory_id().to_proto(),
251 branch: self.branch.as_ref().map(|str| str.to_string()),
252 removed_repo_paths: removed_statuses,
253 updated_statuses: updated_statuses,
254 }
255 }
256}
257
258fn make_repo_path(path: &RepoPath) -> String {
259 path.as_os_str().to_string_lossy().to_string()
260}
261
262fn make_status_entry(path: &RepoPath, status: &GitFileStatus) -> proto::StatusEntry {
263 proto::StatusEntry {
264 repo_path: make_repo_path(path),
265 status: match status {
266 GitFileStatus::Added => proto::GitStatus::Added.into(),
267 GitFileStatus::Modified => proto::GitStatus::Modified.into(),
268 GitFileStatus::Conflict => proto::GitStatus::Conflict.into(),
269 },
270 }
271}
272
273impl From<&RepositoryEntry> for proto::RepositoryEntry {
274 fn from(value: &RepositoryEntry) -> Self {
275 proto::RepositoryEntry {
276 work_directory_id: value.work_directory.to_proto(),
277 branch: value.branch.as_ref().map(|str| str.to_string()),
278 updated_statuses: value
279 .statuses
280 .iter()
281 .map(|(repo_path, status)| make_status_entry(repo_path, status))
282 .collect(),
283 removed_repo_paths: Default::default(),
284 }
285 }
286}
287
288/// This path corresponds to the 'content path' (the folder that contains the .git)
289#[derive(Clone, Debug, Ord, PartialOrd, Eq, PartialEq)]
290pub struct RepositoryWorkDirectory(Arc<Path>);
291
292impl Default for RepositoryWorkDirectory {
293 fn default() -> Self {
294 RepositoryWorkDirectory(Arc::from(Path::new("")))
295 }
296}
297
298impl AsRef<Path> for RepositoryWorkDirectory {
299 fn as_ref(&self) -> &Path {
300 self.0.as_ref()
301 }
302}
303
304#[derive(Clone, Debug, Ord, PartialOrd, Eq, PartialEq)]
305pub struct WorkDirectoryEntry(ProjectEntryId);
306
307impl WorkDirectoryEntry {
308 // Note that these paths should be relative to the worktree root.
309 pub(crate) fn contains(&self, snapshot: &Snapshot, path: &Path) -> bool {
310 snapshot
311 .entry_for_id(self.0)
312 .map(|entry| path.starts_with(&entry.path))
313 .unwrap_or(false)
314 }
315
316 pub(crate) fn relativize(&self, worktree: &Snapshot, path: &Path) -> Option<RepoPath> {
317 worktree.entry_for_id(self.0).and_then(|entry| {
318 path.strip_prefix(&entry.path)
319 .ok()
320 .map(move |path| path.into())
321 })
322 }
323}
324
325impl Deref for WorkDirectoryEntry {
326 type Target = ProjectEntryId;
327
328 fn deref(&self) -> &Self::Target {
329 &self.0
330 }
331}
332
333impl<'a> From<ProjectEntryId> for WorkDirectoryEntry {
334 fn from(value: ProjectEntryId) -> Self {
335 WorkDirectoryEntry(value)
336 }
337}
338
339#[derive(Debug, Clone)]
340pub struct LocalSnapshot {
341 ignores_by_parent_abs_path: HashMap<Arc<Path>, (Arc<Gitignore>, usize)>,
342 // The ProjectEntryId corresponds to the entry for the .git dir
343 // work_directory_id
344 git_repositories: TreeMap<ProjectEntryId, LocalRepositoryEntry>,
345 removed_entry_ids: HashMap<u64, ProjectEntryId>,
346 next_entry_id: Arc<AtomicUsize>,
347 snapshot: Snapshot,
348}
349
350#[derive(Debug, Clone)]
351pub struct LocalRepositoryEntry {
352 pub(crate) scan_id: usize,
353 pub(crate) full_scan_id: usize,
354 pub(crate) repo_ptr: Arc<Mutex<dyn GitRepository>>,
355 /// Path to the actual .git folder.
356 /// Note: if .git is a file, this points to the folder indicated by the .git file
357 pub(crate) git_dir_path: Arc<Path>,
358}
359
360impl LocalRepositoryEntry {
361 // Note that this path should be relative to the worktree root.
362 pub(crate) fn in_dot_git(&self, path: &Path) -> bool {
363 path.starts_with(self.git_dir_path.as_ref())
364 }
365}
366
367impl Deref for LocalSnapshot {
368 type Target = Snapshot;
369
370 fn deref(&self) -> &Self::Target {
371 &self.snapshot
372 }
373}
374
375impl DerefMut for LocalSnapshot {
376 fn deref_mut(&mut self) -> &mut Self::Target {
377 &mut self.snapshot
378 }
379}
380
381enum ScanState {
382 Started,
383 Updated {
384 snapshot: LocalSnapshot,
385 changes: HashMap<(Arc<Path>, ProjectEntryId), PathChange>,
386 barrier: Option<barrier::Sender>,
387 scanning: bool,
388 },
389}
390
391struct ShareState {
392 project_id: u64,
393 snapshots_tx: watch::Sender<LocalSnapshot>,
394 resume_updates: watch::Sender<()>,
395 _maintain_remote_snapshot: Task<Option<()>>,
396}
397
398pub enum Event {
399 UpdatedEntries(HashMap<(Arc<Path>, ProjectEntryId), PathChange>),
400 UpdatedGitRepositories(HashMap<Arc<Path>, LocalRepositoryEntry>),
401}
402
403impl Entity for Worktree {
404 type Event = Event;
405}
406
407impl Worktree {
408 pub async fn local(
409 client: Arc<Client>,
410 path: impl Into<Arc<Path>>,
411 visible: bool,
412 fs: Arc<dyn Fs>,
413 next_entry_id: Arc<AtomicUsize>,
414 cx: &mut AsyncAppContext,
415 ) -> Result<ModelHandle<Self>> {
416 // After determining whether the root entry is a file or a directory, populate the
417 // snapshot's "root name", which will be used for the purpose of fuzzy matching.
418 let abs_path = path.into();
419 let metadata = fs
420 .metadata(&abs_path)
421 .await
422 .context("failed to stat worktree path")?;
423
424 Ok(cx.add_model(move |cx: &mut ModelContext<Worktree>| {
425 let root_name = abs_path
426 .file_name()
427 .map_or(String::new(), |f| f.to_string_lossy().to_string());
428
429 let mut snapshot = LocalSnapshot {
430 ignores_by_parent_abs_path: Default::default(),
431 removed_entry_ids: Default::default(),
432 git_repositories: Default::default(),
433 next_entry_id,
434 snapshot: Snapshot {
435 id: WorktreeId::from_usize(cx.model_id()),
436 abs_path: abs_path.clone(),
437 root_name: root_name.clone(),
438 root_char_bag: root_name.chars().map(|c| c.to_ascii_lowercase()).collect(),
439 entries_by_path: Default::default(),
440 entries_by_id: Default::default(),
441 repository_entries: Default::default(),
442 scan_id: 1,
443 completed_scan_id: 0,
444 },
445 };
446
447 if let Some(metadata) = metadata {
448 snapshot.insert_entry(
449 Entry::new(
450 Arc::from(Path::new("")),
451 &metadata,
452 &snapshot.next_entry_id,
453 snapshot.root_char_bag,
454 ),
455 fs.as_ref(),
456 );
457 }
458
459 let (path_changes_tx, path_changes_rx) = channel::unbounded();
460 let (scan_states_tx, mut scan_states_rx) = mpsc::unbounded();
461
462 cx.spawn_weak(|this, mut cx| async move {
463 while let Some((state, this)) = scan_states_rx.next().await.zip(this.upgrade(&cx)) {
464 this.update(&mut cx, |this, cx| {
465 let this = this.as_local_mut().unwrap();
466 match state {
467 ScanState::Started => {
468 *this.is_scanning.0.borrow_mut() = true;
469 }
470 ScanState::Updated {
471 snapshot,
472 changes,
473 barrier,
474 scanning,
475 } => {
476 *this.is_scanning.0.borrow_mut() = scanning;
477 this.set_snapshot(snapshot, cx);
478 cx.emit(Event::UpdatedEntries(changes));
479 drop(barrier);
480 }
481 }
482 cx.notify();
483 });
484 }
485 })
486 .detach();
487
488 let background_scanner_task = cx.background().spawn({
489 let fs = fs.clone();
490 let snapshot = snapshot.clone();
491 let background = cx.background().clone();
492 async move {
493 let events = fs.watch(&abs_path, Duration::from_millis(100)).await;
494 BackgroundScanner::new(
495 snapshot,
496 fs,
497 scan_states_tx,
498 background,
499 path_changes_rx,
500 )
501 .run(events)
502 .await;
503 }
504 });
505
506 Worktree::Local(LocalWorktree {
507 snapshot,
508 is_scanning: watch::channel_with(true),
509 share: None,
510 path_changes_tx,
511 _background_scanner_task: background_scanner_task,
512 diagnostics: Default::default(),
513 diagnostic_summaries: Default::default(),
514 client,
515 fs,
516 visible,
517 })
518 }))
519 }
520
521 pub fn remote(
522 project_remote_id: u64,
523 replica_id: ReplicaId,
524 worktree: proto::WorktreeMetadata,
525 client: Arc<Client>,
526 cx: &mut AppContext,
527 ) -> ModelHandle<Self> {
528 cx.add_model(|cx: &mut ModelContext<Self>| {
529 let snapshot = Snapshot {
530 id: WorktreeId(worktree.id as usize),
531 abs_path: Arc::from(PathBuf::from(worktree.abs_path)),
532 root_name: worktree.root_name.clone(),
533 root_char_bag: worktree
534 .root_name
535 .chars()
536 .map(|c| c.to_ascii_lowercase())
537 .collect(),
538 entries_by_path: Default::default(),
539 entries_by_id: Default::default(),
540 repository_entries: Default::default(),
541 scan_id: 1,
542 completed_scan_id: 0,
543 };
544
545 let (updates_tx, mut updates_rx) = mpsc::unbounded();
546 let background_snapshot = Arc::new(Mutex::new(snapshot.clone()));
547 let (mut snapshot_updated_tx, mut snapshot_updated_rx) = watch::channel();
548
549 cx.background()
550 .spawn({
551 let background_snapshot = background_snapshot.clone();
552 async move {
553 while let Some(update) = updates_rx.next().await {
554 if let Err(error) =
555 background_snapshot.lock().apply_remote_update(update)
556 {
557 log::error!("error applying worktree update: {}", error);
558 }
559 snapshot_updated_tx.send(()).await.ok();
560 }
561 }
562 })
563 .detach();
564
565 cx.spawn_weak(|this, mut cx| async move {
566 while (snapshot_updated_rx.recv().await).is_some() {
567 if let Some(this) = this.upgrade(&cx) {
568 this.update(&mut cx, |this, cx| {
569 let this = this.as_remote_mut().unwrap();
570 this.snapshot = this.background_snapshot.lock().clone();
571 cx.emit(Event::UpdatedEntries(Default::default()));
572 cx.notify();
573 while let Some((scan_id, _)) = this.snapshot_subscriptions.front() {
574 if this.observed_snapshot(*scan_id) {
575 let (_, tx) = this.snapshot_subscriptions.pop_front().unwrap();
576 let _ = tx.send(());
577 } else {
578 break;
579 }
580 }
581 });
582 } else {
583 break;
584 }
585 }
586 })
587 .detach();
588
589 Worktree::Remote(RemoteWorktree {
590 project_id: project_remote_id,
591 replica_id,
592 snapshot: snapshot.clone(),
593 background_snapshot,
594 updates_tx: Some(updates_tx),
595 snapshot_subscriptions: Default::default(),
596 client: client.clone(),
597 diagnostic_summaries: Default::default(),
598 visible: worktree.visible,
599 disconnected: false,
600 })
601 })
602 }
603
604 pub fn as_local(&self) -> Option<&LocalWorktree> {
605 if let Worktree::Local(worktree) = self {
606 Some(worktree)
607 } else {
608 None
609 }
610 }
611
612 pub fn as_remote(&self) -> Option<&RemoteWorktree> {
613 if let Worktree::Remote(worktree) = self {
614 Some(worktree)
615 } else {
616 None
617 }
618 }
619
620 pub fn as_local_mut(&mut self) -> Option<&mut LocalWorktree> {
621 if let Worktree::Local(worktree) = self {
622 Some(worktree)
623 } else {
624 None
625 }
626 }
627
628 pub fn as_remote_mut(&mut self) -> Option<&mut RemoteWorktree> {
629 if let Worktree::Remote(worktree) = self {
630 Some(worktree)
631 } else {
632 None
633 }
634 }
635
636 pub fn is_local(&self) -> bool {
637 matches!(self, Worktree::Local(_))
638 }
639
640 pub fn is_remote(&self) -> bool {
641 !self.is_local()
642 }
643
644 pub fn snapshot(&self) -> Snapshot {
645 match self {
646 Worktree::Local(worktree) => worktree.snapshot().snapshot,
647 Worktree::Remote(worktree) => worktree.snapshot(),
648 }
649 }
650
651 pub fn scan_id(&self) -> usize {
652 match self {
653 Worktree::Local(worktree) => worktree.snapshot.scan_id,
654 Worktree::Remote(worktree) => worktree.snapshot.scan_id,
655 }
656 }
657
658 pub fn completed_scan_id(&self) -> usize {
659 match self {
660 Worktree::Local(worktree) => worktree.snapshot.completed_scan_id,
661 Worktree::Remote(worktree) => worktree.snapshot.completed_scan_id,
662 }
663 }
664
665 pub fn is_visible(&self) -> bool {
666 match self {
667 Worktree::Local(worktree) => worktree.visible,
668 Worktree::Remote(worktree) => worktree.visible,
669 }
670 }
671
672 pub fn replica_id(&self) -> ReplicaId {
673 match self {
674 Worktree::Local(_) => 0,
675 Worktree::Remote(worktree) => worktree.replica_id,
676 }
677 }
678
679 pub fn diagnostic_summaries(
680 &self,
681 ) -> impl Iterator<Item = (Arc<Path>, LanguageServerId, DiagnosticSummary)> + '_ {
682 match self {
683 Worktree::Local(worktree) => &worktree.diagnostic_summaries,
684 Worktree::Remote(worktree) => &worktree.diagnostic_summaries,
685 }
686 .iter()
687 .flat_map(|(path, summaries)| {
688 summaries
689 .iter()
690 .map(move |(&server_id, &summary)| (path.clone(), server_id, summary))
691 })
692 }
693
694 pub fn abs_path(&self) -> Arc<Path> {
695 match self {
696 Worktree::Local(worktree) => worktree.abs_path.clone(),
697 Worktree::Remote(worktree) => worktree.abs_path.clone(),
698 }
699 }
700}
701
702impl LocalWorktree {
703 pub fn contains_abs_path(&self, path: &Path) -> bool {
704 path.starts_with(&self.abs_path)
705 }
706
707 fn absolutize(&self, path: &Path) -> PathBuf {
708 if path.file_name().is_some() {
709 self.abs_path.join(path)
710 } else {
711 self.abs_path.to_path_buf()
712 }
713 }
714
715 pub(crate) fn load_buffer(
716 &mut self,
717 id: u64,
718 path: &Path,
719 cx: &mut ModelContext<Worktree>,
720 ) -> Task<Result<ModelHandle<Buffer>>> {
721 let path = Arc::from(path);
722 cx.spawn(move |this, mut cx| async move {
723 let (file, contents, diff_base) = this
724 .update(&mut cx, |t, cx| t.as_local().unwrap().load(&path, cx))
725 .await?;
726 let text_buffer = cx
727 .background()
728 .spawn(async move { text::Buffer::new(0, id, contents) })
729 .await;
730 Ok(cx.add_model(|cx| {
731 let mut buffer = Buffer::build(text_buffer, diff_base, Some(Arc::new(file)));
732 buffer.git_diff_recalc(cx);
733 buffer
734 }))
735 })
736 }
737
738 pub fn diagnostics_for_path(
739 &self,
740 path: &Path,
741 ) -> Vec<(
742 LanguageServerId,
743 Vec<DiagnosticEntry<Unclipped<PointUtf16>>>,
744 )> {
745 self.diagnostics.get(path).cloned().unwrap_or_default()
746 }
747
748 pub fn update_diagnostics(
749 &mut self,
750 server_id: LanguageServerId,
751 worktree_path: Arc<Path>,
752 diagnostics: Vec<DiagnosticEntry<Unclipped<PointUtf16>>>,
753 _: &mut ModelContext<Worktree>,
754 ) -> Result<bool> {
755 let summaries_by_server_id = self
756 .diagnostic_summaries
757 .entry(worktree_path.clone())
758 .or_default();
759
760 let old_summary = summaries_by_server_id
761 .remove(&server_id)
762 .unwrap_or_default();
763
764 let new_summary = DiagnosticSummary::new(&diagnostics);
765 if new_summary.is_empty() {
766 if let Some(diagnostics_by_server_id) = self.diagnostics.get_mut(&worktree_path) {
767 if let Ok(ix) = diagnostics_by_server_id.binary_search_by_key(&server_id, |e| e.0) {
768 diagnostics_by_server_id.remove(ix);
769 }
770 if diagnostics_by_server_id.is_empty() {
771 self.diagnostics.remove(&worktree_path);
772 }
773 }
774 } else {
775 summaries_by_server_id.insert(server_id, new_summary);
776 let diagnostics_by_server_id =
777 self.diagnostics.entry(worktree_path.clone()).or_default();
778 match diagnostics_by_server_id.binary_search_by_key(&server_id, |e| e.0) {
779 Ok(ix) => {
780 diagnostics_by_server_id[ix] = (server_id, diagnostics);
781 }
782 Err(ix) => {
783 diagnostics_by_server_id.insert(ix, (server_id, diagnostics));
784 }
785 }
786 }
787
788 if !old_summary.is_empty() || !new_summary.is_empty() {
789 if let Some(share) = self.share.as_ref() {
790 self.client
791 .send(proto::UpdateDiagnosticSummary {
792 project_id: share.project_id,
793 worktree_id: self.id().to_proto(),
794 summary: Some(proto::DiagnosticSummary {
795 path: worktree_path.to_string_lossy().to_string(),
796 language_server_id: server_id.0 as u64,
797 error_count: new_summary.error_count as u32,
798 warning_count: new_summary.warning_count as u32,
799 }),
800 })
801 .log_err();
802 }
803 }
804
805 Ok(!old_summary.is_empty() || !new_summary.is_empty())
806 }
807
808 fn set_snapshot(&mut self, new_snapshot: LocalSnapshot, cx: &mut ModelContext<Worktree>) {
809 let updated_repos =
810 self.changed_repos(&self.git_repositories, &new_snapshot.git_repositories);
811 self.snapshot = new_snapshot;
812
813 if let Some(share) = self.share.as_mut() {
814 *share.snapshots_tx.borrow_mut() = self.snapshot.clone();
815 }
816
817 if !updated_repos.is_empty() {
818 cx.emit(Event::UpdatedGitRepositories(updated_repos));
819 }
820 }
821
822 fn changed_repos(
823 &self,
824 old_repos: &TreeMap<ProjectEntryId, LocalRepositoryEntry>,
825 new_repos: &TreeMap<ProjectEntryId, LocalRepositoryEntry>,
826 ) -> HashMap<Arc<Path>, LocalRepositoryEntry> {
827 let mut diff = HashMap::default();
828 let mut old_repos = old_repos.iter().peekable();
829 let mut new_repos = new_repos.iter().peekable();
830 loop {
831 match (old_repos.peek(), new_repos.peek()) {
832 (Some((old_entry_id, old_repo)), Some((new_entry_id, new_repo))) => {
833 match Ord::cmp(old_entry_id, new_entry_id) {
834 Ordering::Less => {
835 if let Some(entry) = self.entry_for_id(**old_entry_id) {
836 diff.insert(entry.path.clone(), (*old_repo).clone());
837 }
838 old_repos.next();
839 }
840 Ordering::Equal => {
841 if old_repo.scan_id != new_repo.scan_id {
842 if let Some(entry) = self.entry_for_id(**new_entry_id) {
843 diff.insert(entry.path.clone(), (*new_repo).clone());
844 }
845 }
846
847 old_repos.next();
848 new_repos.next();
849 }
850 Ordering::Greater => {
851 if let Some(entry) = self.entry_for_id(**new_entry_id) {
852 diff.insert(entry.path.clone(), (*new_repo).clone());
853 }
854 new_repos.next();
855 }
856 }
857 }
858 (Some((old_entry_id, old_repo)), None) => {
859 if let Some(entry) = self.entry_for_id(**old_entry_id) {
860 diff.insert(entry.path.clone(), (*old_repo).clone());
861 }
862 old_repos.next();
863 }
864 (None, Some((new_entry_id, new_repo))) => {
865 if let Some(entry) = self.entry_for_id(**new_entry_id) {
866 diff.insert(entry.path.clone(), (*new_repo).clone());
867 }
868 new_repos.next();
869 }
870 (None, None) => break,
871 }
872 }
873 diff
874 }
875
876 pub fn scan_complete(&self) -> impl Future<Output = ()> {
877 let mut is_scanning_rx = self.is_scanning.1.clone();
878 async move {
879 let mut is_scanning = is_scanning_rx.borrow().clone();
880 while is_scanning {
881 if let Some(value) = is_scanning_rx.recv().await {
882 is_scanning = value;
883 } else {
884 break;
885 }
886 }
887 }
888 }
889
890 pub fn snapshot(&self) -> LocalSnapshot {
891 self.snapshot.clone()
892 }
893
894 pub fn metadata_proto(&self) -> proto::WorktreeMetadata {
895 proto::WorktreeMetadata {
896 id: self.id().to_proto(),
897 root_name: self.root_name().to_string(),
898 visible: self.visible,
899 abs_path: self.abs_path().as_os_str().to_string_lossy().into(),
900 }
901 }
902
903 fn load(
904 &self,
905 path: &Path,
906 cx: &mut ModelContext<Worktree>,
907 ) -> Task<Result<(File, String, Option<String>)>> {
908 let handle = cx.handle();
909 let path = Arc::from(path);
910 let abs_path = self.absolutize(&path);
911 let fs = self.fs.clone();
912 let snapshot = self.snapshot();
913
914 let mut index_task = None;
915
916 if let Some(repo) = snapshot.repo_for(&path) {
917 let repo_path = repo.work_directory.relativize(self, &path).unwrap();
918 if let Some(repo) = self.git_repositories.get(&*repo.work_directory) {
919 let repo = repo.repo_ptr.to_owned();
920 index_task = Some(
921 cx.background()
922 .spawn(async move { repo.lock().load_index_text(&repo_path) }),
923 );
924 }
925 }
926
927 cx.spawn(|this, mut cx| async move {
928 let text = fs.load(&abs_path).await?;
929
930 let diff_base = if let Some(index_task) = index_task {
931 index_task.await
932 } else {
933 None
934 };
935
936 // Eagerly populate the snapshot with an updated entry for the loaded file
937 let entry = this
938 .update(&mut cx, |this, cx| {
939 this.as_local().unwrap().refresh_entry(path, None, cx)
940 })
941 .await?;
942
943 Ok((
944 File {
945 entry_id: entry.id,
946 worktree: handle,
947 path: entry.path,
948 mtime: entry.mtime,
949 is_local: true,
950 is_deleted: false,
951 },
952 text,
953 diff_base,
954 ))
955 })
956 }
957
958 pub fn save_buffer(
959 &self,
960 buffer_handle: ModelHandle<Buffer>,
961 path: Arc<Path>,
962 has_changed_file: bool,
963 cx: &mut ModelContext<Worktree>,
964 ) -> Task<Result<(clock::Global, RopeFingerprint, SystemTime)>> {
965 let handle = cx.handle();
966 let buffer = buffer_handle.read(cx);
967
968 let rpc = self.client.clone();
969 let buffer_id = buffer.remote_id();
970 let project_id = self.share.as_ref().map(|share| share.project_id);
971
972 let text = buffer.as_rope().clone();
973 let fingerprint = text.fingerprint();
974 let version = buffer.version();
975 let save = self.write_file(path, text, buffer.line_ending(), cx);
976
977 cx.as_mut().spawn(|mut cx| async move {
978 let entry = save.await?;
979
980 if has_changed_file {
981 let new_file = Arc::new(File {
982 entry_id: entry.id,
983 worktree: handle,
984 path: entry.path,
985 mtime: entry.mtime,
986 is_local: true,
987 is_deleted: false,
988 });
989
990 if let Some(project_id) = project_id {
991 rpc.send(proto::UpdateBufferFile {
992 project_id,
993 buffer_id,
994 file: Some(new_file.to_proto()),
995 })
996 .log_err();
997 }
998
999 buffer_handle.update(&mut cx, |buffer, cx| {
1000 if has_changed_file {
1001 buffer.file_updated(new_file, cx).detach();
1002 }
1003 });
1004 }
1005
1006 if let Some(project_id) = project_id {
1007 rpc.send(proto::BufferSaved {
1008 project_id,
1009 buffer_id,
1010 version: serialize_version(&version),
1011 mtime: Some(entry.mtime.into()),
1012 fingerprint: serialize_fingerprint(fingerprint),
1013 })?;
1014 }
1015
1016 buffer_handle.update(&mut cx, |buffer, cx| {
1017 buffer.did_save(version.clone(), fingerprint, entry.mtime, cx);
1018 });
1019
1020 Ok((version, fingerprint, entry.mtime))
1021 })
1022 }
1023
1024 pub fn create_entry(
1025 &self,
1026 path: impl Into<Arc<Path>>,
1027 is_dir: bool,
1028 cx: &mut ModelContext<Worktree>,
1029 ) -> Task<Result<Entry>> {
1030 let path = path.into();
1031 let abs_path = self.absolutize(&path);
1032 let fs = self.fs.clone();
1033 let write = cx.background().spawn(async move {
1034 if is_dir {
1035 fs.create_dir(&abs_path).await
1036 } else {
1037 fs.save(&abs_path, &Default::default(), Default::default())
1038 .await
1039 }
1040 });
1041
1042 cx.spawn(|this, mut cx| async move {
1043 write.await?;
1044 this.update(&mut cx, |this, cx| {
1045 this.as_local_mut().unwrap().refresh_entry(path, None, cx)
1046 })
1047 .await
1048 })
1049 }
1050
1051 pub fn write_file(
1052 &self,
1053 path: impl Into<Arc<Path>>,
1054 text: Rope,
1055 line_ending: LineEnding,
1056 cx: &mut ModelContext<Worktree>,
1057 ) -> Task<Result<Entry>> {
1058 let path = path.into();
1059 let abs_path = self.absolutize(&path);
1060 let fs = self.fs.clone();
1061 let write = cx
1062 .background()
1063 .spawn(async move { fs.save(&abs_path, &text, line_ending).await });
1064
1065 cx.spawn(|this, mut cx| async move {
1066 write.await?;
1067 this.update(&mut cx, |this, cx| {
1068 this.as_local_mut().unwrap().refresh_entry(path, None, cx)
1069 })
1070 .await
1071 })
1072 }
1073
1074 pub fn delete_entry(
1075 &self,
1076 entry_id: ProjectEntryId,
1077 cx: &mut ModelContext<Worktree>,
1078 ) -> Option<Task<Result<()>>> {
1079 let entry = self.entry_for_id(entry_id)?.clone();
1080 let abs_path = self.abs_path.clone();
1081 let fs = self.fs.clone();
1082
1083 let delete = cx.background().spawn(async move {
1084 let mut abs_path = fs.canonicalize(&abs_path).await?;
1085 if entry.path.file_name().is_some() {
1086 abs_path = abs_path.join(&entry.path);
1087 }
1088 if entry.is_file() {
1089 fs.remove_file(&abs_path, Default::default()).await?;
1090 } else {
1091 fs.remove_dir(
1092 &abs_path,
1093 RemoveOptions {
1094 recursive: true,
1095 ignore_if_not_exists: false,
1096 },
1097 )
1098 .await?;
1099 }
1100 anyhow::Ok(abs_path)
1101 });
1102
1103 Some(cx.spawn(|this, mut cx| async move {
1104 let abs_path = delete.await?;
1105 let (tx, mut rx) = barrier::channel();
1106 this.update(&mut cx, |this, _| {
1107 this.as_local_mut()
1108 .unwrap()
1109 .path_changes_tx
1110 .try_send((vec![abs_path], tx))
1111 })?;
1112 rx.recv().await;
1113 Ok(())
1114 }))
1115 }
1116
1117 pub fn rename_entry(
1118 &self,
1119 entry_id: ProjectEntryId,
1120 new_path: impl Into<Arc<Path>>,
1121 cx: &mut ModelContext<Worktree>,
1122 ) -> Option<Task<Result<Entry>>> {
1123 let old_path = self.entry_for_id(entry_id)?.path.clone();
1124 let new_path = new_path.into();
1125 let abs_old_path = self.absolutize(&old_path);
1126 let abs_new_path = self.absolutize(&new_path);
1127 let fs = self.fs.clone();
1128 let rename = cx.background().spawn(async move {
1129 fs.rename(&abs_old_path, &abs_new_path, Default::default())
1130 .await
1131 });
1132
1133 Some(cx.spawn(|this, mut cx| async move {
1134 rename.await?;
1135 this.update(&mut cx, |this, cx| {
1136 this.as_local_mut()
1137 .unwrap()
1138 .refresh_entry(new_path.clone(), Some(old_path), cx)
1139 })
1140 .await
1141 }))
1142 }
1143
1144 pub fn copy_entry(
1145 &self,
1146 entry_id: ProjectEntryId,
1147 new_path: impl Into<Arc<Path>>,
1148 cx: &mut ModelContext<Worktree>,
1149 ) -> Option<Task<Result<Entry>>> {
1150 let old_path = self.entry_for_id(entry_id)?.path.clone();
1151 let new_path = new_path.into();
1152 let abs_old_path = self.absolutize(&old_path);
1153 let abs_new_path = self.absolutize(&new_path);
1154 let fs = self.fs.clone();
1155 let copy = cx.background().spawn(async move {
1156 copy_recursive(
1157 fs.as_ref(),
1158 &abs_old_path,
1159 &abs_new_path,
1160 Default::default(),
1161 )
1162 .await
1163 });
1164
1165 Some(cx.spawn(|this, mut cx| async move {
1166 copy.await?;
1167 this.update(&mut cx, |this, cx| {
1168 this.as_local_mut()
1169 .unwrap()
1170 .refresh_entry(new_path.clone(), None, cx)
1171 })
1172 .await
1173 }))
1174 }
1175
1176 fn refresh_entry(
1177 &self,
1178 path: Arc<Path>,
1179 old_path: Option<Arc<Path>>,
1180 cx: &mut ModelContext<Worktree>,
1181 ) -> Task<Result<Entry>> {
1182 let fs = self.fs.clone();
1183 let abs_root_path = self.abs_path.clone();
1184 let path_changes_tx = self.path_changes_tx.clone();
1185 cx.spawn_weak(move |this, mut cx| async move {
1186 let abs_path = fs.canonicalize(&abs_root_path).await?;
1187 let mut paths = Vec::with_capacity(2);
1188 paths.push(if path.file_name().is_some() {
1189 abs_path.join(&path)
1190 } else {
1191 abs_path.clone()
1192 });
1193 if let Some(old_path) = old_path {
1194 paths.push(if old_path.file_name().is_some() {
1195 abs_path.join(&old_path)
1196 } else {
1197 abs_path.clone()
1198 });
1199 }
1200
1201 let (tx, mut rx) = barrier::channel();
1202 path_changes_tx.try_send((paths, tx))?;
1203 rx.recv().await;
1204 this.upgrade(&cx)
1205 .ok_or_else(|| anyhow!("worktree was dropped"))?
1206 .update(&mut cx, |this, _| {
1207 this.entry_for_path(path)
1208 .cloned()
1209 .ok_or_else(|| anyhow!("failed to read path after update"))
1210 })
1211 })
1212 }
1213
1214 pub fn share(&mut self, project_id: u64, cx: &mut ModelContext<Worktree>) -> Task<Result<()>> {
1215 let (share_tx, share_rx) = oneshot::channel();
1216
1217 if let Some(share) = self.share.as_mut() {
1218 let _ = share_tx.send(());
1219 *share.resume_updates.borrow_mut() = ();
1220 } else {
1221 let (snapshots_tx, mut snapshots_rx) = watch::channel_with(self.snapshot());
1222 let (resume_updates_tx, mut resume_updates_rx) = watch::channel();
1223 let worktree_id = cx.model_id() as u64;
1224
1225 for (path, summaries) in &self.diagnostic_summaries {
1226 for (&server_id, summary) in summaries {
1227 if let Err(e) = self.client.send(proto::UpdateDiagnosticSummary {
1228 project_id,
1229 worktree_id,
1230 summary: Some(summary.to_proto(server_id, &path)),
1231 }) {
1232 return Task::ready(Err(e));
1233 }
1234 }
1235 }
1236
1237 let _maintain_remote_snapshot = cx.background().spawn({
1238 let client = self.client.clone();
1239 async move {
1240 let mut share_tx = Some(share_tx);
1241 let mut prev_snapshot = LocalSnapshot {
1242 ignores_by_parent_abs_path: Default::default(),
1243 removed_entry_ids: Default::default(),
1244 next_entry_id: Default::default(),
1245 git_repositories: Default::default(),
1246 snapshot: Snapshot {
1247 id: WorktreeId(worktree_id as usize),
1248 abs_path: Path::new("").into(),
1249 root_name: Default::default(),
1250 root_char_bag: Default::default(),
1251 entries_by_path: Default::default(),
1252 entries_by_id: Default::default(),
1253 repository_entries: Default::default(),
1254 scan_id: 0,
1255 completed_scan_id: 0,
1256 },
1257 };
1258 while let Some(snapshot) = snapshots_rx.recv().await {
1259 #[cfg(any(test, feature = "test-support"))]
1260 const MAX_CHUNK_SIZE: usize = 2;
1261 #[cfg(not(any(test, feature = "test-support")))]
1262 const MAX_CHUNK_SIZE: usize = 256;
1263
1264 let update =
1265 snapshot.build_update(&prev_snapshot, project_id, worktree_id, true);
1266 for update in proto::split_worktree_update(update, MAX_CHUNK_SIZE) {
1267 let _ = resume_updates_rx.try_recv();
1268 while let Err(error) = client.request(update.clone()).await {
1269 log::error!("failed to send worktree update: {}", error);
1270 log::info!("waiting to resume updates");
1271 if resume_updates_rx.next().await.is_none() {
1272 return Ok(());
1273 }
1274 }
1275 }
1276
1277 if let Some(share_tx) = share_tx.take() {
1278 let _ = share_tx.send(());
1279 }
1280
1281 prev_snapshot = snapshot;
1282 }
1283
1284 Ok::<_, anyhow::Error>(())
1285 }
1286 .log_err()
1287 });
1288
1289 self.share = Some(ShareState {
1290 project_id,
1291 snapshots_tx,
1292 resume_updates: resume_updates_tx,
1293 _maintain_remote_snapshot,
1294 });
1295 }
1296
1297 cx.foreground()
1298 .spawn(async move { share_rx.await.map_err(|_| anyhow!("share ended")) })
1299 }
1300
1301 pub fn unshare(&mut self) {
1302 self.share.take();
1303 }
1304
1305 pub fn is_shared(&self) -> bool {
1306 self.share.is_some()
1307 }
1308}
1309
1310impl RemoteWorktree {
1311 fn snapshot(&self) -> Snapshot {
1312 self.snapshot.clone()
1313 }
1314
1315 pub fn disconnected_from_host(&mut self) {
1316 self.updates_tx.take();
1317 self.snapshot_subscriptions.clear();
1318 self.disconnected = true;
1319 }
1320
1321 pub fn save_buffer(
1322 &self,
1323 buffer_handle: ModelHandle<Buffer>,
1324 cx: &mut ModelContext<Worktree>,
1325 ) -> Task<Result<(clock::Global, RopeFingerprint, SystemTime)>> {
1326 let buffer = buffer_handle.read(cx);
1327 let buffer_id = buffer.remote_id();
1328 let version = buffer.version();
1329 let rpc = self.client.clone();
1330 let project_id = self.project_id;
1331 cx.as_mut().spawn(|mut cx| async move {
1332 let response = rpc
1333 .request(proto::SaveBuffer {
1334 project_id,
1335 buffer_id,
1336 version: serialize_version(&version),
1337 })
1338 .await?;
1339 let version = deserialize_version(&response.version);
1340 let fingerprint = deserialize_fingerprint(&response.fingerprint)?;
1341 let mtime = response
1342 .mtime
1343 .ok_or_else(|| anyhow!("missing mtime"))?
1344 .into();
1345
1346 buffer_handle.update(&mut cx, |buffer, cx| {
1347 buffer.did_save(version.clone(), fingerprint, mtime, cx);
1348 });
1349
1350 Ok((version, fingerprint, mtime))
1351 })
1352 }
1353
1354 pub fn update_from_remote(&mut self, update: proto::UpdateWorktree) {
1355 if let Some(updates_tx) = &self.updates_tx {
1356 updates_tx
1357 .unbounded_send(update)
1358 .expect("consumer runs to completion");
1359 }
1360 }
1361
1362 fn observed_snapshot(&self, scan_id: usize) -> bool {
1363 self.completed_scan_id >= scan_id
1364 }
1365
1366 fn wait_for_snapshot(&mut self, scan_id: usize) -> impl Future<Output = Result<()>> {
1367 let (tx, rx) = oneshot::channel();
1368 if self.observed_snapshot(scan_id) {
1369 let _ = tx.send(());
1370 } else if self.disconnected {
1371 drop(tx);
1372 } else {
1373 match self
1374 .snapshot_subscriptions
1375 .binary_search_by_key(&scan_id, |probe| probe.0)
1376 {
1377 Ok(ix) | Err(ix) => self.snapshot_subscriptions.insert(ix, (scan_id, tx)),
1378 }
1379 }
1380
1381 async move {
1382 rx.await?;
1383 Ok(())
1384 }
1385 }
1386
1387 pub fn update_diagnostic_summary(
1388 &mut self,
1389 path: Arc<Path>,
1390 summary: &proto::DiagnosticSummary,
1391 ) {
1392 let server_id = LanguageServerId(summary.language_server_id as usize);
1393 let summary = DiagnosticSummary {
1394 error_count: summary.error_count as usize,
1395 warning_count: summary.warning_count as usize,
1396 };
1397
1398 if summary.is_empty() {
1399 if let Some(summaries) = self.diagnostic_summaries.get_mut(&path) {
1400 summaries.remove(&server_id);
1401 if summaries.is_empty() {
1402 self.diagnostic_summaries.remove(&path);
1403 }
1404 }
1405 } else {
1406 self.diagnostic_summaries
1407 .entry(path)
1408 .or_default()
1409 .insert(server_id, summary);
1410 }
1411 }
1412
1413 pub fn insert_entry(
1414 &mut self,
1415 entry: proto::Entry,
1416 scan_id: usize,
1417 cx: &mut ModelContext<Worktree>,
1418 ) -> Task<Result<Entry>> {
1419 let wait_for_snapshot = self.wait_for_snapshot(scan_id);
1420 cx.spawn(|this, mut cx| async move {
1421 wait_for_snapshot.await?;
1422 this.update(&mut cx, |worktree, _| {
1423 let worktree = worktree.as_remote_mut().unwrap();
1424 let mut snapshot = worktree.background_snapshot.lock();
1425 let entry = snapshot.insert_entry(entry);
1426 worktree.snapshot = snapshot.clone();
1427 entry
1428 })
1429 })
1430 }
1431
1432 pub(crate) fn delete_entry(
1433 &mut self,
1434 id: ProjectEntryId,
1435 scan_id: usize,
1436 cx: &mut ModelContext<Worktree>,
1437 ) -> Task<Result<()>> {
1438 let wait_for_snapshot = self.wait_for_snapshot(scan_id);
1439 cx.spawn(|this, mut cx| async move {
1440 wait_for_snapshot.await?;
1441 this.update(&mut cx, |worktree, _| {
1442 let worktree = worktree.as_remote_mut().unwrap();
1443 let mut snapshot = worktree.background_snapshot.lock();
1444 snapshot.delete_entry(id);
1445 worktree.snapshot = snapshot.clone();
1446 });
1447 Ok(())
1448 })
1449 }
1450}
1451
1452impl Snapshot {
1453 pub fn id(&self) -> WorktreeId {
1454 self.id
1455 }
1456
1457 pub fn abs_path(&self) -> &Arc<Path> {
1458 &self.abs_path
1459 }
1460
1461 pub fn contains_entry(&self, entry_id: ProjectEntryId) -> bool {
1462 self.entries_by_id.get(&entry_id, &()).is_some()
1463 }
1464
1465 pub(crate) fn insert_entry(&mut self, entry: proto::Entry) -> Result<Entry> {
1466 let entry = Entry::try_from((&self.root_char_bag, entry))?;
1467 let old_entry = self.entries_by_id.insert_or_replace(
1468 PathEntry {
1469 id: entry.id,
1470 path: entry.path.clone(),
1471 is_ignored: entry.is_ignored,
1472 scan_id: 0,
1473 },
1474 &(),
1475 );
1476 if let Some(old_entry) = old_entry {
1477 self.entries_by_path.remove(&PathKey(old_entry.path), &());
1478 }
1479 self.entries_by_path.insert_or_replace(entry.clone(), &());
1480 Ok(entry)
1481 }
1482
1483 fn delete_entry(&mut self, entry_id: ProjectEntryId) -> Option<Arc<Path>> {
1484 let removed_entry = self.entries_by_id.remove(&entry_id, &())?;
1485 self.entries_by_path = {
1486 let mut cursor = self.entries_by_path.cursor();
1487 let mut new_entries_by_path =
1488 cursor.slice(&TraversalTarget::Path(&removed_entry.path), Bias::Left, &());
1489 while let Some(entry) = cursor.item() {
1490 if entry.path.starts_with(&removed_entry.path) {
1491 self.entries_by_id.remove(&entry.id, &());
1492 cursor.next(&());
1493 } else {
1494 break;
1495 }
1496 }
1497 new_entries_by_path.push_tree(cursor.suffix(&()), &());
1498 new_entries_by_path
1499 };
1500
1501 Some(removed_entry.path)
1502 }
1503
1504 pub(crate) fn apply_remote_update(&mut self, mut update: proto::UpdateWorktree) -> Result<()> {
1505 let mut entries_by_path_edits = Vec::new();
1506 let mut entries_by_id_edits = Vec::new();
1507 for entry_id in update.removed_entries {
1508 if let Some(entry) = self.entry_for_id(ProjectEntryId::from_proto(entry_id)) {
1509 entries_by_path_edits.push(Edit::Remove(PathKey(entry.path.clone())));
1510 entries_by_id_edits.push(Edit::Remove(entry.id));
1511 }
1512 }
1513
1514 for entry in update.updated_entries {
1515 let entry = Entry::try_from((&self.root_char_bag, entry))?;
1516 if let Some(PathEntry { path, .. }) = self.entries_by_id.get(&entry.id, &()) {
1517 entries_by_path_edits.push(Edit::Remove(PathKey(path.clone())));
1518 }
1519 entries_by_id_edits.push(Edit::Insert(PathEntry {
1520 id: entry.id,
1521 path: entry.path.clone(),
1522 is_ignored: entry.is_ignored,
1523 scan_id: 0,
1524 }));
1525 entries_by_path_edits.push(Edit::Insert(entry));
1526 }
1527
1528 self.entries_by_path.edit(entries_by_path_edits, &());
1529 self.entries_by_id.edit(entries_by_id_edits, &());
1530
1531 update.removed_repositories.sort_unstable();
1532 self.repository_entries.retain(|_, entry| {
1533 if let Ok(_) = update
1534 .removed_repositories
1535 .binary_search(&entry.work_directory.to_proto())
1536 {
1537 false
1538 } else {
1539 true
1540 }
1541 });
1542
1543 for repository in update.updated_repositories {
1544 let work_directory_entry: WorkDirectoryEntry =
1545 ProjectEntryId::from_proto(repository.work_directory_id).into();
1546
1547 if let Some(entry) = self.entry_for_id(*work_directory_entry) {
1548 let mut statuses = TreeMap::default();
1549 for status_entry in repository.updated_statuses {
1550 let Some(git_file_status) = read_git_status(status_entry.status) else {
1551 continue;
1552 };
1553
1554 let repo_path = RepoPath::new(status_entry.repo_path.into());
1555 statuses.insert(repo_path, git_file_status);
1556 }
1557
1558 let work_directory = RepositoryWorkDirectory(entry.path.clone());
1559 if self.repository_entries.get(&work_directory).is_some() {
1560 self.repository_entries.update(&work_directory, |repo| {
1561 repo.branch = repository.branch.map(Into::into);
1562 repo.statuses.insert_tree(statuses);
1563
1564 for repo_path in repository.removed_repo_paths {
1565 let repo_path = RepoPath::new(repo_path.into());
1566 repo.statuses.remove(&repo_path);
1567 }
1568 });
1569 } else {
1570 self.repository_entries.insert(
1571 work_directory,
1572 RepositoryEntry {
1573 work_directory: work_directory_entry,
1574 branch: repository.branch.map(Into::into),
1575 statuses,
1576 },
1577 )
1578 }
1579 } else {
1580 log::error!("no work directory entry for repository {:?}", repository)
1581 }
1582 }
1583
1584 self.scan_id = update.scan_id as usize;
1585 if update.is_last_update {
1586 self.completed_scan_id = update.scan_id as usize;
1587 }
1588
1589 Ok(())
1590 }
1591
1592 pub fn file_count(&self) -> usize {
1593 self.entries_by_path.summary().file_count
1594 }
1595
1596 pub fn visible_file_count(&self) -> usize {
1597 self.entries_by_path.summary().visible_file_count
1598 }
1599
1600 fn traverse_from_offset(
1601 &self,
1602 include_dirs: bool,
1603 include_ignored: bool,
1604 start_offset: usize,
1605 ) -> Traversal {
1606 let mut cursor = self.entries_by_path.cursor();
1607 cursor.seek(
1608 &TraversalTarget::Count {
1609 count: start_offset,
1610 include_dirs,
1611 include_ignored,
1612 },
1613 Bias::Right,
1614 &(),
1615 );
1616 Traversal {
1617 cursor,
1618 include_dirs,
1619 include_ignored,
1620 }
1621 }
1622
1623 fn traverse_from_path(
1624 &self,
1625 include_dirs: bool,
1626 include_ignored: bool,
1627 path: &Path,
1628 ) -> Traversal {
1629 let mut cursor = self.entries_by_path.cursor();
1630 cursor.seek(&TraversalTarget::Path(path), Bias::Left, &());
1631 Traversal {
1632 cursor,
1633 include_dirs,
1634 include_ignored,
1635 }
1636 }
1637
1638 pub fn files(&self, include_ignored: bool, start: usize) -> Traversal {
1639 self.traverse_from_offset(false, include_ignored, start)
1640 }
1641
1642 pub fn entries(&self, include_ignored: bool) -> Traversal {
1643 self.traverse_from_offset(true, include_ignored, 0)
1644 }
1645
1646 pub fn repositories(&self) -> impl Iterator<Item = &RepositoryEntry> {
1647 self.repository_entries.values()
1648 }
1649
1650 pub fn paths(&self) -> impl Iterator<Item = &Arc<Path>> {
1651 let empty_path = Path::new("");
1652 self.entries_by_path
1653 .cursor::<()>()
1654 .filter(move |entry| entry.path.as_ref() != empty_path)
1655 .map(|entry| &entry.path)
1656 }
1657
1658 fn child_entries<'a>(&'a self, parent_path: &'a Path) -> ChildEntriesIter<'a> {
1659 let mut cursor = self.entries_by_path.cursor();
1660 cursor.seek(&TraversalTarget::Path(parent_path), Bias::Right, &());
1661 let traversal = Traversal {
1662 cursor,
1663 include_dirs: true,
1664 include_ignored: true,
1665 };
1666 ChildEntriesIter {
1667 traversal,
1668 parent_path,
1669 }
1670 }
1671
1672 fn descendent_entries<'a>(
1673 &'a self,
1674 include_dirs: bool,
1675 include_ignored: bool,
1676 parent_path: &'a Path,
1677 ) -> DescendentEntriesIter<'a> {
1678 let mut cursor = self.entries_by_path.cursor();
1679 cursor.seek(&TraversalTarget::Path(parent_path), Bias::Left, &());
1680 let mut traversal = Traversal {
1681 cursor,
1682 include_dirs,
1683 include_ignored,
1684 };
1685
1686 if traversal.end_offset() == traversal.start_offset() {
1687 traversal.advance();
1688 }
1689
1690 DescendentEntriesIter {
1691 traversal,
1692 parent_path,
1693 }
1694 }
1695
1696 pub fn root_entry(&self) -> Option<&Entry> {
1697 self.entry_for_path("")
1698 }
1699
1700 pub fn root_name(&self) -> &str {
1701 &self.root_name
1702 }
1703
1704 pub fn root_git_entry(&self) -> Option<RepositoryEntry> {
1705 self.repository_entries
1706 .get(&RepositoryWorkDirectory(Path::new("").into()))
1707 .map(|entry| entry.to_owned())
1708 }
1709
1710 pub fn git_entries(&self) -> impl Iterator<Item = &RepositoryEntry> {
1711 self.repository_entries.values()
1712 }
1713
1714 pub fn scan_id(&self) -> usize {
1715 self.scan_id
1716 }
1717
1718 pub fn entry_for_path(&self, path: impl AsRef<Path>) -> Option<&Entry> {
1719 let path = path.as_ref();
1720 self.traverse_from_path(true, true, path)
1721 .entry()
1722 .and_then(|entry| {
1723 if entry.path.as_ref() == path {
1724 Some(entry)
1725 } else {
1726 None
1727 }
1728 })
1729 }
1730
1731 pub fn entry_for_id(&self, id: ProjectEntryId) -> Option<&Entry> {
1732 let entry = self.entries_by_id.get(&id, &())?;
1733 self.entry_for_path(&entry.path)
1734 }
1735
1736 pub fn inode_for_path(&self, path: impl AsRef<Path>) -> Option<u64> {
1737 self.entry_for_path(path.as_ref()).map(|e| e.inode)
1738 }
1739}
1740
1741impl LocalSnapshot {
1742 pub(crate) fn get_local_repo(&self, repo: &RepositoryEntry) -> Option<&LocalRepositoryEntry> {
1743 self.git_repositories.get(&repo.work_directory.0)
1744 }
1745
1746 pub(crate) fn repo_for_metadata(
1747 &self,
1748 path: &Path,
1749 ) -> Option<(&ProjectEntryId, &LocalRepositoryEntry)> {
1750 self.git_repositories
1751 .iter()
1752 .find(|(_, repo)| repo.in_dot_git(path))
1753 }
1754
1755 #[cfg(test)]
1756 pub(crate) fn build_initial_update(&self, project_id: u64) -> proto::UpdateWorktree {
1757 let root_name = self.root_name.clone();
1758 proto::UpdateWorktree {
1759 project_id,
1760 worktree_id: self.id().to_proto(),
1761 abs_path: self.abs_path().to_string_lossy().into(),
1762 root_name,
1763 updated_entries: self.entries_by_path.iter().map(Into::into).collect(),
1764 removed_entries: Default::default(),
1765 scan_id: self.scan_id as u64,
1766 is_last_update: true,
1767 updated_repositories: self.repository_entries.values().map(Into::into).collect(),
1768 removed_repositories: Default::default(),
1769 }
1770 }
1771
1772 pub(crate) fn build_update(
1773 &self,
1774 other: &Self,
1775 project_id: u64,
1776 worktree_id: u64,
1777 include_ignored: bool,
1778 ) -> proto::UpdateWorktree {
1779 let mut updated_entries = Vec::new();
1780 let mut removed_entries = Vec::new();
1781 let mut self_entries = self
1782 .entries_by_id
1783 .cursor::<()>()
1784 .filter(|e| include_ignored || !e.is_ignored)
1785 .peekable();
1786 let mut other_entries = other
1787 .entries_by_id
1788 .cursor::<()>()
1789 .filter(|e| include_ignored || !e.is_ignored)
1790 .peekable();
1791 loop {
1792 match (self_entries.peek(), other_entries.peek()) {
1793 (Some(self_entry), Some(other_entry)) => {
1794 match Ord::cmp(&self_entry.id, &other_entry.id) {
1795 Ordering::Less => {
1796 let entry = self.entry_for_id(self_entry.id).unwrap().into();
1797 updated_entries.push(entry);
1798 self_entries.next();
1799 }
1800 Ordering::Equal => {
1801 if self_entry.scan_id != other_entry.scan_id {
1802 let entry = self.entry_for_id(self_entry.id).unwrap().into();
1803 updated_entries.push(entry);
1804 }
1805
1806 self_entries.next();
1807 other_entries.next();
1808 }
1809 Ordering::Greater => {
1810 removed_entries.push(other_entry.id.to_proto());
1811 other_entries.next();
1812 }
1813 }
1814 }
1815 (Some(self_entry), None) => {
1816 let entry = self.entry_for_id(self_entry.id).unwrap().into();
1817 updated_entries.push(entry);
1818 self_entries.next();
1819 }
1820 (None, Some(other_entry)) => {
1821 removed_entries.push(other_entry.id.to_proto());
1822 other_entries.next();
1823 }
1824 (None, None) => break,
1825 }
1826 }
1827
1828 let mut updated_repositories: Vec<proto::RepositoryEntry> = Vec::new();
1829 let mut removed_repositories = Vec::new();
1830 let mut self_repos = self.snapshot.repository_entries.iter().peekable();
1831 let mut other_repos = other.snapshot.repository_entries.iter().peekable();
1832 loop {
1833 match (self_repos.peek(), other_repos.peek()) {
1834 (Some((self_work_dir, self_repo)), Some((other_work_dir, other_repo))) => {
1835 match Ord::cmp(self_work_dir, other_work_dir) {
1836 Ordering::Less => {
1837 updated_repositories.push((*self_repo).into());
1838 self_repos.next();
1839 }
1840 Ordering::Equal => {
1841 if self_repo != other_repo {
1842 updated_repositories.push(self_repo.build_update(other_repo));
1843 }
1844
1845 self_repos.next();
1846 other_repos.next();
1847 }
1848 Ordering::Greater => {
1849 removed_repositories.push(other_repo.work_directory.to_proto());
1850 other_repos.next();
1851 }
1852 }
1853 }
1854 (Some((_, self_repo)), None) => {
1855 updated_repositories.push((*self_repo).into());
1856 self_repos.next();
1857 }
1858 (None, Some((_, other_repo))) => {
1859 removed_repositories.push(other_repo.work_directory.to_proto());
1860 other_repos.next();
1861 }
1862 (None, None) => break,
1863 }
1864 }
1865
1866 proto::UpdateWorktree {
1867 project_id,
1868 worktree_id,
1869 abs_path: self.abs_path().to_string_lossy().into(),
1870 root_name: self.root_name().to_string(),
1871 updated_entries,
1872 removed_entries,
1873 scan_id: self.scan_id as u64,
1874 is_last_update: self.completed_scan_id == self.scan_id,
1875 updated_repositories,
1876 removed_repositories,
1877 }
1878 }
1879
1880 fn insert_entry(&mut self, mut entry: Entry, fs: &dyn Fs) -> Entry {
1881 if entry.is_file() && entry.path.file_name() == Some(&GITIGNORE) {
1882 let abs_path = self.abs_path.join(&entry.path);
1883 match smol::block_on(build_gitignore(&abs_path, fs)) {
1884 Ok(ignore) => {
1885 self.ignores_by_parent_abs_path.insert(
1886 abs_path.parent().unwrap().into(),
1887 (Arc::new(ignore), self.scan_id),
1888 );
1889 }
1890 Err(error) => {
1891 log::error!(
1892 "error loading .gitignore file {:?} - {:?}",
1893 &entry.path,
1894 error
1895 );
1896 }
1897 }
1898 }
1899
1900 self.reuse_entry_id(&mut entry);
1901
1902 if entry.kind == EntryKind::PendingDir {
1903 if let Some(existing_entry) =
1904 self.entries_by_path.get(&PathKey(entry.path.clone()), &())
1905 {
1906 entry.kind = existing_entry.kind;
1907 }
1908 }
1909
1910 let scan_id = self.scan_id;
1911 let removed = self.entries_by_path.insert_or_replace(entry.clone(), &());
1912 if let Some(removed) = removed {
1913 if removed.id != entry.id {
1914 self.entries_by_id.remove(&removed.id, &());
1915 }
1916 }
1917 self.entries_by_id.insert_or_replace(
1918 PathEntry {
1919 id: entry.id,
1920 path: entry.path.clone(),
1921 is_ignored: entry.is_ignored,
1922 scan_id,
1923 },
1924 &(),
1925 );
1926
1927 entry
1928 }
1929
1930 fn populate_dir(
1931 &mut self,
1932 parent_path: Arc<Path>,
1933 entries: impl IntoIterator<Item = Entry>,
1934 ignore: Option<Arc<Gitignore>>,
1935 fs: &dyn Fs,
1936 ) {
1937 let mut parent_entry = if let Some(parent_entry) =
1938 self.entries_by_path.get(&PathKey(parent_path.clone()), &())
1939 {
1940 parent_entry.clone()
1941 } else {
1942 log::warn!(
1943 "populating a directory {:?} that has been removed",
1944 parent_path
1945 );
1946 return;
1947 };
1948
1949 match parent_entry.kind {
1950 EntryKind::PendingDir => {
1951 parent_entry.kind = EntryKind::Dir;
1952 }
1953 EntryKind::Dir => {}
1954 _ => return,
1955 }
1956
1957 if let Some(ignore) = ignore {
1958 self.ignores_by_parent_abs_path.insert(
1959 self.abs_path.join(&parent_path).into(),
1960 (ignore, self.scan_id),
1961 );
1962 }
1963
1964 if parent_path.file_name() == Some(&DOT_GIT) {
1965 self.build_repo(parent_path, fs);
1966 }
1967
1968 let mut entries_by_path_edits = vec![Edit::Insert(parent_entry)];
1969 let mut entries_by_id_edits = Vec::new();
1970
1971 for mut entry in entries {
1972 self.reuse_entry_id(&mut entry);
1973 entries_by_id_edits.push(Edit::Insert(PathEntry {
1974 id: entry.id,
1975 path: entry.path.clone(),
1976 is_ignored: entry.is_ignored,
1977 scan_id: self.scan_id,
1978 }));
1979 entries_by_path_edits.push(Edit::Insert(entry));
1980 }
1981
1982 self.entries_by_path.edit(entries_by_path_edits, &());
1983 self.entries_by_id.edit(entries_by_id_edits, &());
1984 }
1985
1986 fn build_repo(&mut self, parent_path: Arc<Path>, fs: &dyn Fs) -> Option<()> {
1987 let abs_path = self.abs_path.join(&parent_path);
1988 let work_dir: Arc<Path> = parent_path.parent().unwrap().into();
1989
1990 // Guard against repositories inside the repository metadata
1991 if work_dir
1992 .components()
1993 .find(|component| component.as_os_str() == *DOT_GIT)
1994 .is_some()
1995 {
1996 return None;
1997 };
1998
1999 let work_dir_id = self
2000 .entry_for_path(work_dir.clone())
2001 .map(|entry| entry.id)?;
2002
2003 if self.git_repositories.get(&work_dir_id).is_none() {
2004 let repo = fs.open_repo(abs_path.as_path())?;
2005 let work_directory = RepositoryWorkDirectory(work_dir.clone());
2006 let scan_id = self.scan_id;
2007
2008 let repo_lock = repo.lock();
2009
2010 self.repository_entries.insert(
2011 work_directory,
2012 RepositoryEntry {
2013 work_directory: work_dir_id.into(),
2014 branch: repo_lock.branch_name().map(Into::into),
2015 statuses: repo_lock.statuses().unwrap_or_default(),
2016 },
2017 );
2018 drop(repo_lock);
2019
2020 self.git_repositories.insert(
2021 work_dir_id,
2022 LocalRepositoryEntry {
2023 scan_id,
2024 full_scan_id: scan_id,
2025 repo_ptr: repo,
2026 git_dir_path: parent_path.clone(),
2027 },
2028 )
2029 }
2030
2031 Some(())
2032 }
2033 fn reuse_entry_id(&mut self, entry: &mut Entry) {
2034 if let Some(removed_entry_id) = self.removed_entry_ids.remove(&entry.inode) {
2035 entry.id = removed_entry_id;
2036 } else if let Some(existing_entry) = self.entry_for_path(&entry.path) {
2037 entry.id = existing_entry.id;
2038 }
2039 }
2040
2041 fn remove_path(&mut self, path: &Path) {
2042 let mut new_entries;
2043 let removed_entries;
2044 {
2045 let mut cursor = self.entries_by_path.cursor::<TraversalProgress>();
2046 new_entries = cursor.slice(&TraversalTarget::Path(path), Bias::Left, &());
2047 removed_entries = cursor.slice(&TraversalTarget::PathSuccessor(path), Bias::Left, &());
2048 new_entries.push_tree(cursor.suffix(&()), &());
2049 }
2050 self.entries_by_path = new_entries;
2051
2052 let mut entries_by_id_edits = Vec::new();
2053 for entry in removed_entries.cursor::<()>() {
2054 let removed_entry_id = self
2055 .removed_entry_ids
2056 .entry(entry.inode)
2057 .or_insert(entry.id);
2058 *removed_entry_id = cmp::max(*removed_entry_id, entry.id);
2059 entries_by_id_edits.push(Edit::Remove(entry.id));
2060 }
2061 self.entries_by_id.edit(entries_by_id_edits, &());
2062
2063 if path.file_name() == Some(&GITIGNORE) {
2064 let abs_parent_path = self.abs_path.join(path.parent().unwrap());
2065 if let Some((_, scan_id)) = self
2066 .ignores_by_parent_abs_path
2067 .get_mut(abs_parent_path.as_path())
2068 {
2069 *scan_id = self.snapshot.scan_id;
2070 }
2071 }
2072 }
2073
2074 fn ancestor_inodes_for_path(&self, path: &Path) -> TreeSet<u64> {
2075 let mut inodes = TreeSet::default();
2076 for ancestor in path.ancestors().skip(1) {
2077 if let Some(entry) = self.entry_for_path(ancestor) {
2078 inodes.insert(entry.inode);
2079 }
2080 }
2081 inodes
2082 }
2083
2084 fn ignore_stack_for_abs_path(&self, abs_path: &Path, is_dir: bool) -> Arc<IgnoreStack> {
2085 let mut new_ignores = Vec::new();
2086 for ancestor in abs_path.ancestors().skip(1) {
2087 if let Some((ignore, _)) = self.ignores_by_parent_abs_path.get(ancestor) {
2088 new_ignores.push((ancestor, Some(ignore.clone())));
2089 } else {
2090 new_ignores.push((ancestor, None));
2091 }
2092 }
2093
2094 let mut ignore_stack = IgnoreStack::none();
2095 for (parent_abs_path, ignore) in new_ignores.into_iter().rev() {
2096 if ignore_stack.is_abs_path_ignored(parent_abs_path, true) {
2097 ignore_stack = IgnoreStack::all();
2098 break;
2099 } else if let Some(ignore) = ignore {
2100 ignore_stack = ignore_stack.append(parent_abs_path.into(), ignore);
2101 }
2102 }
2103
2104 if ignore_stack.is_abs_path_ignored(abs_path, is_dir) {
2105 ignore_stack = IgnoreStack::all();
2106 }
2107
2108 ignore_stack
2109 }
2110}
2111
2112async fn build_gitignore(abs_path: &Path, fs: &dyn Fs) -> Result<Gitignore> {
2113 let contents = fs.load(abs_path).await?;
2114 let parent = abs_path.parent().unwrap_or_else(|| Path::new("/"));
2115 let mut builder = GitignoreBuilder::new(parent);
2116 for line in contents.lines() {
2117 builder.add_line(Some(abs_path.into()), line)?;
2118 }
2119 Ok(builder.build()?)
2120}
2121
2122impl WorktreeId {
2123 pub fn from_usize(handle_id: usize) -> Self {
2124 Self(handle_id)
2125 }
2126
2127 pub(crate) fn from_proto(id: u64) -> Self {
2128 Self(id as usize)
2129 }
2130
2131 pub fn to_proto(&self) -> u64 {
2132 self.0 as u64
2133 }
2134
2135 pub fn to_usize(&self) -> usize {
2136 self.0
2137 }
2138}
2139
2140impl fmt::Display for WorktreeId {
2141 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2142 self.0.fmt(f)
2143 }
2144}
2145
2146impl Deref for Worktree {
2147 type Target = Snapshot;
2148
2149 fn deref(&self) -> &Self::Target {
2150 match self {
2151 Worktree::Local(worktree) => &worktree.snapshot,
2152 Worktree::Remote(worktree) => &worktree.snapshot,
2153 }
2154 }
2155}
2156
2157impl Deref for LocalWorktree {
2158 type Target = LocalSnapshot;
2159
2160 fn deref(&self) -> &Self::Target {
2161 &self.snapshot
2162 }
2163}
2164
2165impl Deref for RemoteWorktree {
2166 type Target = Snapshot;
2167
2168 fn deref(&self) -> &Self::Target {
2169 &self.snapshot
2170 }
2171}
2172
2173impl fmt::Debug for LocalWorktree {
2174 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2175 self.snapshot.fmt(f)
2176 }
2177}
2178
2179impl fmt::Debug for Snapshot {
2180 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2181 struct EntriesById<'a>(&'a SumTree<PathEntry>);
2182 struct EntriesByPath<'a>(&'a SumTree<Entry>);
2183
2184 impl<'a> fmt::Debug for EntriesByPath<'a> {
2185 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2186 f.debug_map()
2187 .entries(self.0.iter().map(|entry| (&entry.path, entry.id)))
2188 .finish()
2189 }
2190 }
2191
2192 impl<'a> fmt::Debug for EntriesById<'a> {
2193 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2194 f.debug_list().entries(self.0.iter()).finish()
2195 }
2196 }
2197
2198 f.debug_struct("Snapshot")
2199 .field("id", &self.id)
2200 .field("root_name", &self.root_name)
2201 .field("entries_by_path", &EntriesByPath(&self.entries_by_path))
2202 .field("entries_by_id", &EntriesById(&self.entries_by_id))
2203 .finish()
2204 }
2205}
2206
2207#[derive(Clone, PartialEq)]
2208pub struct File {
2209 pub worktree: ModelHandle<Worktree>,
2210 pub path: Arc<Path>,
2211 pub mtime: SystemTime,
2212 pub(crate) entry_id: ProjectEntryId,
2213 pub(crate) is_local: bool,
2214 pub(crate) is_deleted: bool,
2215}
2216
2217impl language::File for File {
2218 fn as_local(&self) -> Option<&dyn language::LocalFile> {
2219 if self.is_local {
2220 Some(self)
2221 } else {
2222 None
2223 }
2224 }
2225
2226 fn mtime(&self) -> SystemTime {
2227 self.mtime
2228 }
2229
2230 fn path(&self) -> &Arc<Path> {
2231 &self.path
2232 }
2233
2234 fn full_path(&self, cx: &AppContext) -> PathBuf {
2235 let mut full_path = PathBuf::new();
2236 let worktree = self.worktree.read(cx);
2237
2238 if worktree.is_visible() {
2239 full_path.push(worktree.root_name());
2240 } else {
2241 let path = worktree.abs_path();
2242
2243 if worktree.is_local() && path.starts_with(HOME.as_path()) {
2244 full_path.push("~");
2245 full_path.push(path.strip_prefix(HOME.as_path()).unwrap());
2246 } else {
2247 full_path.push(path)
2248 }
2249 }
2250
2251 if self.path.components().next().is_some() {
2252 full_path.push(&self.path);
2253 }
2254
2255 full_path
2256 }
2257
2258 /// Returns the last component of this handle's absolute path. If this handle refers to the root
2259 /// of its worktree, then this method will return the name of the worktree itself.
2260 fn file_name<'a>(&'a self, cx: &'a AppContext) -> &'a OsStr {
2261 self.path
2262 .file_name()
2263 .unwrap_or_else(|| OsStr::new(&self.worktree.read(cx).root_name))
2264 }
2265
2266 fn is_deleted(&self) -> bool {
2267 self.is_deleted
2268 }
2269
2270 fn as_any(&self) -> &dyn Any {
2271 self
2272 }
2273
2274 fn to_proto(&self) -> rpc::proto::File {
2275 rpc::proto::File {
2276 worktree_id: self.worktree.id() as u64,
2277 entry_id: self.entry_id.to_proto(),
2278 path: self.path.to_string_lossy().into(),
2279 mtime: Some(self.mtime.into()),
2280 is_deleted: self.is_deleted,
2281 }
2282 }
2283}
2284
2285impl language::LocalFile for File {
2286 fn abs_path(&self, cx: &AppContext) -> PathBuf {
2287 self.worktree
2288 .read(cx)
2289 .as_local()
2290 .unwrap()
2291 .abs_path
2292 .join(&self.path)
2293 }
2294
2295 fn load(&self, cx: &AppContext) -> Task<Result<String>> {
2296 let worktree = self.worktree.read(cx).as_local().unwrap();
2297 let abs_path = worktree.absolutize(&self.path);
2298 let fs = worktree.fs.clone();
2299 cx.background()
2300 .spawn(async move { fs.load(&abs_path).await })
2301 }
2302
2303 fn buffer_reloaded(
2304 &self,
2305 buffer_id: u64,
2306 version: &clock::Global,
2307 fingerprint: RopeFingerprint,
2308 line_ending: LineEnding,
2309 mtime: SystemTime,
2310 cx: &mut AppContext,
2311 ) {
2312 let worktree = self.worktree.read(cx).as_local().unwrap();
2313 if let Some(project_id) = worktree.share.as_ref().map(|share| share.project_id) {
2314 worktree
2315 .client
2316 .send(proto::BufferReloaded {
2317 project_id,
2318 buffer_id,
2319 version: serialize_version(version),
2320 mtime: Some(mtime.into()),
2321 fingerprint: serialize_fingerprint(fingerprint),
2322 line_ending: serialize_line_ending(line_ending) as i32,
2323 })
2324 .log_err();
2325 }
2326 }
2327}
2328
2329impl File {
2330 pub fn from_proto(
2331 proto: rpc::proto::File,
2332 worktree: ModelHandle<Worktree>,
2333 cx: &AppContext,
2334 ) -> Result<Self> {
2335 let worktree_id = worktree
2336 .read(cx)
2337 .as_remote()
2338 .ok_or_else(|| anyhow!("not remote"))?
2339 .id();
2340
2341 if worktree_id.to_proto() != proto.worktree_id {
2342 return Err(anyhow!("worktree id does not match file"));
2343 }
2344
2345 Ok(Self {
2346 worktree,
2347 path: Path::new(&proto.path).into(),
2348 mtime: proto.mtime.ok_or_else(|| anyhow!("no timestamp"))?.into(),
2349 entry_id: ProjectEntryId::from_proto(proto.entry_id),
2350 is_local: false,
2351 is_deleted: proto.is_deleted,
2352 })
2353 }
2354
2355 pub fn from_dyn(file: Option<&Arc<dyn language::File>>) -> Option<&Self> {
2356 file.and_then(|f| f.as_any().downcast_ref())
2357 }
2358
2359 pub fn worktree_id(&self, cx: &AppContext) -> WorktreeId {
2360 self.worktree.read(cx).id()
2361 }
2362
2363 pub fn project_entry_id(&self, _: &AppContext) -> Option<ProjectEntryId> {
2364 if self.is_deleted {
2365 None
2366 } else {
2367 Some(self.entry_id)
2368 }
2369 }
2370}
2371
2372#[derive(Clone, Debug, PartialEq, Eq)]
2373pub struct Entry {
2374 pub id: ProjectEntryId,
2375 pub kind: EntryKind,
2376 pub path: Arc<Path>,
2377 pub inode: u64,
2378 pub mtime: SystemTime,
2379 pub is_symlink: bool,
2380 pub is_ignored: bool,
2381}
2382
2383#[derive(Clone, Copy, Debug, PartialEq, Eq)]
2384pub enum EntryKind {
2385 PendingDir,
2386 Dir,
2387 File(CharBag),
2388}
2389
2390#[derive(Clone, Copy, Debug)]
2391pub enum PathChange {
2392 Added,
2393 Removed,
2394 Updated,
2395 AddedOrUpdated,
2396}
2397
2398impl Entry {
2399 fn new(
2400 path: Arc<Path>,
2401 metadata: &fs::Metadata,
2402 next_entry_id: &AtomicUsize,
2403 root_char_bag: CharBag,
2404 ) -> Self {
2405 Self {
2406 id: ProjectEntryId::new(next_entry_id),
2407 kind: if metadata.is_dir {
2408 EntryKind::PendingDir
2409 } else {
2410 EntryKind::File(char_bag_for_path(root_char_bag, &path))
2411 },
2412 path,
2413 inode: metadata.inode,
2414 mtime: metadata.mtime,
2415 is_symlink: metadata.is_symlink,
2416 is_ignored: false,
2417 }
2418 }
2419
2420 pub fn is_dir(&self) -> bool {
2421 matches!(self.kind, EntryKind::Dir | EntryKind::PendingDir)
2422 }
2423
2424 pub fn is_file(&self) -> bool {
2425 matches!(self.kind, EntryKind::File(_))
2426 }
2427}
2428
2429impl sum_tree::Item for Entry {
2430 type Summary = EntrySummary;
2431
2432 fn summary(&self) -> Self::Summary {
2433 let visible_count = if self.is_ignored { 0 } else { 1 };
2434 let file_count;
2435 let visible_file_count;
2436 if self.is_file() {
2437 file_count = 1;
2438 visible_file_count = visible_count;
2439 } else {
2440 file_count = 0;
2441 visible_file_count = 0;
2442 }
2443
2444 EntrySummary {
2445 max_path: self.path.clone(),
2446 count: 1,
2447 visible_count,
2448 file_count,
2449 visible_file_count,
2450 }
2451 }
2452}
2453
2454impl sum_tree::KeyedItem for Entry {
2455 type Key = PathKey;
2456
2457 fn key(&self) -> Self::Key {
2458 PathKey(self.path.clone())
2459 }
2460}
2461
2462#[derive(Clone, Debug)]
2463pub struct EntrySummary {
2464 max_path: Arc<Path>,
2465 count: usize,
2466 visible_count: usize,
2467 file_count: usize,
2468 visible_file_count: usize,
2469}
2470
2471impl Default for EntrySummary {
2472 fn default() -> Self {
2473 Self {
2474 max_path: Arc::from(Path::new("")),
2475 count: 0,
2476 visible_count: 0,
2477 file_count: 0,
2478 visible_file_count: 0,
2479 }
2480 }
2481}
2482
2483impl sum_tree::Summary for EntrySummary {
2484 type Context = ();
2485
2486 fn add_summary(&mut self, rhs: &Self, _: &()) {
2487 self.max_path = rhs.max_path.clone();
2488 self.count += rhs.count;
2489 self.visible_count += rhs.visible_count;
2490 self.file_count += rhs.file_count;
2491 self.visible_file_count += rhs.visible_file_count;
2492 }
2493}
2494
2495#[derive(Clone, Debug)]
2496struct PathEntry {
2497 id: ProjectEntryId,
2498 path: Arc<Path>,
2499 is_ignored: bool,
2500 scan_id: usize,
2501}
2502
2503impl sum_tree::Item for PathEntry {
2504 type Summary = PathEntrySummary;
2505
2506 fn summary(&self) -> Self::Summary {
2507 PathEntrySummary { max_id: self.id }
2508 }
2509}
2510
2511impl sum_tree::KeyedItem for PathEntry {
2512 type Key = ProjectEntryId;
2513
2514 fn key(&self) -> Self::Key {
2515 self.id
2516 }
2517}
2518
2519#[derive(Clone, Debug, Default)]
2520struct PathEntrySummary {
2521 max_id: ProjectEntryId,
2522}
2523
2524impl sum_tree::Summary for PathEntrySummary {
2525 type Context = ();
2526
2527 fn add_summary(&mut self, summary: &Self, _: &Self::Context) {
2528 self.max_id = summary.max_id;
2529 }
2530}
2531
2532impl<'a> sum_tree::Dimension<'a, PathEntrySummary> for ProjectEntryId {
2533 fn add_summary(&mut self, summary: &'a PathEntrySummary, _: &()) {
2534 *self = summary.max_id;
2535 }
2536}
2537
2538#[derive(Clone, Debug, Eq, PartialEq, Ord, PartialOrd)]
2539pub struct PathKey(Arc<Path>);
2540
2541impl Default for PathKey {
2542 fn default() -> Self {
2543 Self(Path::new("").into())
2544 }
2545}
2546
2547impl<'a> sum_tree::Dimension<'a, EntrySummary> for PathKey {
2548 fn add_summary(&mut self, summary: &'a EntrySummary, _: &()) {
2549 self.0 = summary.max_path.clone();
2550 }
2551}
2552
2553struct BackgroundScanner {
2554 snapshot: Mutex<LocalSnapshot>,
2555 fs: Arc<dyn Fs>,
2556 status_updates_tx: UnboundedSender<ScanState>,
2557 executor: Arc<executor::Background>,
2558 refresh_requests_rx: channel::Receiver<(Vec<PathBuf>, barrier::Sender)>,
2559 prev_state: Mutex<BackgroundScannerState>,
2560 finished_initial_scan: bool,
2561}
2562
2563struct BackgroundScannerState {
2564 snapshot: Snapshot,
2565 event_paths: Vec<Arc<Path>>,
2566}
2567
2568impl BackgroundScanner {
2569 fn new(
2570 snapshot: LocalSnapshot,
2571 fs: Arc<dyn Fs>,
2572 status_updates_tx: UnboundedSender<ScanState>,
2573 executor: Arc<executor::Background>,
2574 refresh_requests_rx: channel::Receiver<(Vec<PathBuf>, barrier::Sender)>,
2575 ) -> Self {
2576 Self {
2577 fs,
2578 status_updates_tx,
2579 executor,
2580 refresh_requests_rx,
2581 prev_state: Mutex::new(BackgroundScannerState {
2582 snapshot: snapshot.snapshot.clone(),
2583 event_paths: Default::default(),
2584 }),
2585 snapshot: Mutex::new(snapshot),
2586 finished_initial_scan: false,
2587 }
2588 }
2589
2590 async fn run(
2591 &mut self,
2592 mut events_rx: Pin<Box<dyn Send + Stream<Item = Vec<fsevent::Event>>>>,
2593 ) {
2594 use futures::FutureExt as _;
2595
2596 let (root_abs_path, root_inode) = {
2597 let snapshot = self.snapshot.lock();
2598 (
2599 snapshot.abs_path.clone(),
2600 snapshot.root_entry().map(|e| e.inode),
2601 )
2602 };
2603
2604 // Populate ignores above the root.
2605 let ignore_stack;
2606 for ancestor in root_abs_path.ancestors().skip(1) {
2607 if let Ok(ignore) = build_gitignore(&ancestor.join(&*GITIGNORE), self.fs.as_ref()).await
2608 {
2609 self.snapshot
2610 .lock()
2611 .ignores_by_parent_abs_path
2612 .insert(ancestor.into(), (ignore.into(), 0));
2613 }
2614 }
2615 {
2616 let mut snapshot = self.snapshot.lock();
2617 snapshot.scan_id += 1;
2618 ignore_stack = snapshot.ignore_stack_for_abs_path(&root_abs_path, true);
2619 if ignore_stack.is_all() {
2620 if let Some(mut root_entry) = snapshot.root_entry().cloned() {
2621 root_entry.is_ignored = true;
2622 snapshot.insert_entry(root_entry, self.fs.as_ref());
2623 }
2624 }
2625 };
2626
2627 // Perform an initial scan of the directory.
2628 let (scan_job_tx, scan_job_rx) = channel::unbounded();
2629 smol::block_on(scan_job_tx.send(ScanJob {
2630 abs_path: root_abs_path,
2631 path: Arc::from(Path::new("")),
2632 ignore_stack,
2633 ancestor_inodes: TreeSet::from_ordered_entries(root_inode),
2634 scan_queue: scan_job_tx.clone(),
2635 }))
2636 .unwrap();
2637 drop(scan_job_tx);
2638 self.scan_dirs(true, scan_job_rx).await;
2639 {
2640 let mut snapshot = self.snapshot.lock();
2641 snapshot.completed_scan_id = snapshot.scan_id;
2642 }
2643 self.send_status_update(false, None);
2644
2645 // Process any any FS events that occurred while performing the initial scan.
2646 // For these events, update events cannot be as precise, because we didn't
2647 // have the previous state loaded yet.
2648 if let Poll::Ready(Some(events)) = futures::poll!(events_rx.next()) {
2649 let mut paths = events.into_iter().map(|e| e.path).collect::<Vec<_>>();
2650 while let Poll::Ready(Some(more_events)) = futures::poll!(events_rx.next()) {
2651 paths.extend(more_events.into_iter().map(|e| e.path));
2652 }
2653 self.process_events(paths).await;
2654 }
2655
2656 self.finished_initial_scan = true;
2657
2658 // Continue processing events until the worktree is dropped.
2659 loop {
2660 select_biased! {
2661 // Process any path refresh requests from the worktree. Prioritize
2662 // these before handling changes reported by the filesystem.
2663 request = self.refresh_requests_rx.recv().fuse() => {
2664 let Ok((paths, barrier)) = request else { break };
2665 if !self.process_refresh_request(paths, barrier).await {
2666 return;
2667 }
2668 }
2669
2670 events = events_rx.next().fuse() => {
2671 let Some(events) = events else { break };
2672 let mut paths = events.into_iter().map(|e| e.path).collect::<Vec<_>>();
2673 while let Poll::Ready(Some(more_events)) = futures::poll!(events_rx.next()) {
2674 paths.extend(more_events.into_iter().map(|e| e.path));
2675 }
2676 self.process_events(paths).await;
2677 }
2678 }
2679 }
2680 }
2681
2682 async fn process_refresh_request(&self, paths: Vec<PathBuf>, barrier: barrier::Sender) -> bool {
2683 if let Some(mut paths) = self.reload_entries_for_paths(paths, None).await {
2684 paths.sort_unstable();
2685 util::extend_sorted(
2686 &mut self.prev_state.lock().event_paths,
2687 paths,
2688 usize::MAX,
2689 Ord::cmp,
2690 );
2691 }
2692 self.send_status_update(false, Some(barrier))
2693 }
2694
2695 async fn process_events(&mut self, paths: Vec<PathBuf>) {
2696 let (scan_job_tx, scan_job_rx) = channel::unbounded();
2697 let paths = self
2698 .reload_entries_for_paths(paths, Some(scan_job_tx.clone()))
2699 .await;
2700 if let Some(paths) = &paths {
2701 util::extend_sorted(
2702 &mut self.prev_state.lock().event_paths,
2703 paths.iter().cloned(),
2704 usize::MAX,
2705 Ord::cmp,
2706 );
2707 }
2708 drop(scan_job_tx);
2709 self.scan_dirs(false, scan_job_rx).await;
2710
2711 self.update_ignore_statuses().await;
2712
2713 let mut snapshot = self.snapshot.lock();
2714
2715 if let Some(paths) = paths {
2716 for path in paths {
2717 self.reload_repo_for_file_path(&path, &mut *snapshot, self.fs.as_ref());
2718 }
2719 }
2720
2721 let mut git_repositories = mem::take(&mut snapshot.git_repositories);
2722 git_repositories.retain(|work_directory_id, _| {
2723 snapshot
2724 .entry_for_id(*work_directory_id)
2725 .map_or(false, |entry| {
2726 snapshot.entry_for_path(entry.path.join(*DOT_GIT)).is_some()
2727 })
2728 });
2729 snapshot.git_repositories = git_repositories;
2730
2731 let mut git_repository_entries = mem::take(&mut snapshot.snapshot.repository_entries);
2732 git_repository_entries.retain(|_, entry| {
2733 snapshot
2734 .git_repositories
2735 .get(&entry.work_directory.0)
2736 .is_some()
2737 });
2738 snapshot.snapshot.repository_entries = git_repository_entries;
2739
2740 snapshot.removed_entry_ids.clear();
2741 snapshot.completed_scan_id = snapshot.scan_id;
2742
2743 drop(snapshot);
2744
2745 self.send_status_update(false, None);
2746 self.prev_state.lock().event_paths.clear();
2747 }
2748
2749 async fn scan_dirs(
2750 &self,
2751 enable_progress_updates: bool,
2752 scan_jobs_rx: channel::Receiver<ScanJob>,
2753 ) {
2754 use futures::FutureExt as _;
2755
2756 if self
2757 .status_updates_tx
2758 .unbounded_send(ScanState::Started)
2759 .is_err()
2760 {
2761 return;
2762 }
2763
2764 let progress_update_count = AtomicUsize::new(0);
2765 self.executor
2766 .scoped(|scope| {
2767 for _ in 0..self.executor.num_cpus() {
2768 scope.spawn(async {
2769 let mut last_progress_update_count = 0;
2770 let progress_update_timer = self.progress_timer(enable_progress_updates).fuse();
2771 futures::pin_mut!(progress_update_timer);
2772
2773 loop {
2774 select_biased! {
2775 // Process any path refresh requests before moving on to process
2776 // the scan queue, so that user operations are prioritized.
2777 request = self.refresh_requests_rx.recv().fuse() => {
2778 let Ok((paths, barrier)) = request else { break };
2779 if !self.process_refresh_request(paths, barrier).await {
2780 return;
2781 }
2782 }
2783
2784 // Send periodic progress updates to the worktree. Use an atomic counter
2785 // to ensure that only one of the workers sends a progress update after
2786 // the update interval elapses.
2787 _ = progress_update_timer => {
2788 match progress_update_count.compare_exchange(
2789 last_progress_update_count,
2790 last_progress_update_count + 1,
2791 SeqCst,
2792 SeqCst
2793 ) {
2794 Ok(_) => {
2795 last_progress_update_count += 1;
2796 self.send_status_update(true, None);
2797 }
2798 Err(count) => {
2799 last_progress_update_count = count;
2800 }
2801 }
2802 progress_update_timer.set(self.progress_timer(enable_progress_updates).fuse());
2803 }
2804
2805 // Recursively load directories from the file system.
2806 job = scan_jobs_rx.recv().fuse() => {
2807 let Ok(job) = job else { break };
2808 if let Err(err) = self.scan_dir(&job).await {
2809 if job.path.as_ref() != Path::new("") {
2810 log::error!("error scanning directory {:?}: {}", job.abs_path, err);
2811 }
2812 }
2813 }
2814 }
2815 }
2816 })
2817 }
2818 })
2819 .await;
2820 }
2821
2822 fn send_status_update(&self, scanning: bool, barrier: Option<barrier::Sender>) -> bool {
2823 let mut prev_state = self.prev_state.lock();
2824 let new_snapshot = self.snapshot.lock().clone();
2825 let old_snapshot = mem::replace(&mut prev_state.snapshot, new_snapshot.snapshot.clone());
2826
2827 let changes = self.build_change_set(
2828 &old_snapshot,
2829 &new_snapshot.snapshot,
2830 &prev_state.event_paths,
2831 );
2832
2833 self.status_updates_tx
2834 .unbounded_send(ScanState::Updated {
2835 snapshot: new_snapshot,
2836 changes,
2837 scanning,
2838 barrier,
2839 })
2840 .is_ok()
2841 }
2842
2843 async fn scan_dir(&self, job: &ScanJob) -> Result<()> {
2844 let mut new_entries: Vec<Entry> = Vec::new();
2845 let mut new_jobs: Vec<Option<ScanJob>> = Vec::new();
2846 let mut ignore_stack = job.ignore_stack.clone();
2847 let mut new_ignore = None;
2848 let (root_abs_path, root_char_bag, next_entry_id) = {
2849 let snapshot = self.snapshot.lock();
2850 (
2851 snapshot.abs_path().clone(),
2852 snapshot.root_char_bag,
2853 snapshot.next_entry_id.clone(),
2854 )
2855 };
2856 let mut child_paths = self.fs.read_dir(&job.abs_path).await?;
2857 while let Some(child_abs_path) = child_paths.next().await {
2858 let child_abs_path: Arc<Path> = match child_abs_path {
2859 Ok(child_abs_path) => child_abs_path.into(),
2860 Err(error) => {
2861 log::error!("error processing entry {:?}", error);
2862 continue;
2863 }
2864 };
2865
2866 let child_name = child_abs_path.file_name().unwrap();
2867 let child_path: Arc<Path> = job.path.join(child_name).into();
2868 let child_metadata = match self.fs.metadata(&child_abs_path).await {
2869 Ok(Some(metadata)) => metadata,
2870 Ok(None) => continue,
2871 Err(err) => {
2872 log::error!("error processing {:?}: {:?}", child_abs_path, err);
2873 continue;
2874 }
2875 };
2876
2877 // If we find a .gitignore, add it to the stack of ignores used to determine which paths are ignored
2878 if child_name == *GITIGNORE {
2879 match build_gitignore(&child_abs_path, self.fs.as_ref()).await {
2880 Ok(ignore) => {
2881 let ignore = Arc::new(ignore);
2882 ignore_stack = ignore_stack.append(job.abs_path.clone(), ignore.clone());
2883 new_ignore = Some(ignore);
2884 }
2885 Err(error) => {
2886 log::error!(
2887 "error loading .gitignore file {:?} - {:?}",
2888 child_name,
2889 error
2890 );
2891 }
2892 }
2893
2894 // Update ignore status of any child entries we've already processed to reflect the
2895 // ignore file in the current directory. Because `.gitignore` starts with a `.`,
2896 // there should rarely be too numerous. Update the ignore stack associated with any
2897 // new jobs as well.
2898 let mut new_jobs = new_jobs.iter_mut();
2899 for entry in &mut new_entries {
2900 let entry_abs_path = root_abs_path.join(&entry.path);
2901 entry.is_ignored =
2902 ignore_stack.is_abs_path_ignored(&entry_abs_path, entry.is_dir());
2903
2904 if entry.is_dir() {
2905 if let Some(job) = new_jobs.next().expect("Missing scan job for entry") {
2906 job.ignore_stack = if entry.is_ignored {
2907 IgnoreStack::all()
2908 } else {
2909 ignore_stack.clone()
2910 };
2911 }
2912 }
2913 }
2914 }
2915
2916 let mut child_entry = Entry::new(
2917 child_path.clone(),
2918 &child_metadata,
2919 &next_entry_id,
2920 root_char_bag,
2921 );
2922
2923 if child_entry.is_dir() {
2924 let is_ignored = ignore_stack.is_abs_path_ignored(&child_abs_path, true);
2925 child_entry.is_ignored = is_ignored;
2926
2927 // Avoid recursing until crash in the case of a recursive symlink
2928 if !job.ancestor_inodes.contains(&child_entry.inode) {
2929 let mut ancestor_inodes = job.ancestor_inodes.clone();
2930 ancestor_inodes.insert(child_entry.inode);
2931
2932 new_jobs.push(Some(ScanJob {
2933 abs_path: child_abs_path,
2934 path: child_path,
2935 ignore_stack: if is_ignored {
2936 IgnoreStack::all()
2937 } else {
2938 ignore_stack.clone()
2939 },
2940 ancestor_inodes,
2941 scan_queue: job.scan_queue.clone(),
2942 }));
2943 } else {
2944 new_jobs.push(None);
2945 }
2946 } else {
2947 child_entry.is_ignored = ignore_stack.is_abs_path_ignored(&child_abs_path, false);
2948 }
2949
2950 new_entries.push(child_entry);
2951 }
2952
2953 self.snapshot.lock().populate_dir(
2954 job.path.clone(),
2955 new_entries,
2956 new_ignore,
2957 self.fs.as_ref(),
2958 );
2959
2960 for new_job in new_jobs {
2961 if let Some(new_job) = new_job {
2962 job.scan_queue.send(new_job).await.unwrap();
2963 }
2964 }
2965
2966 Ok(())
2967 }
2968
2969 async fn reload_entries_for_paths(
2970 &self,
2971 mut abs_paths: Vec<PathBuf>,
2972 scan_queue_tx: Option<Sender<ScanJob>>,
2973 ) -> Option<Vec<Arc<Path>>> {
2974 let doing_recursive_update = scan_queue_tx.is_some();
2975
2976 abs_paths.sort_unstable();
2977 abs_paths.dedup_by(|a, b| a.starts_with(&b));
2978
2979 let root_abs_path = self.snapshot.lock().abs_path.clone();
2980 let root_canonical_path = self.fs.canonicalize(&root_abs_path).await.log_err()?;
2981 let metadata = futures::future::join_all(
2982 abs_paths
2983 .iter()
2984 .map(|abs_path| self.fs.metadata(&abs_path))
2985 .collect::<Vec<_>>(),
2986 )
2987 .await;
2988
2989 let mut snapshot = self.snapshot.lock();
2990 let is_idle = snapshot.completed_scan_id == snapshot.scan_id;
2991 snapshot.scan_id += 1;
2992 if is_idle && !doing_recursive_update {
2993 snapshot.completed_scan_id = snapshot.scan_id;
2994 }
2995
2996 // Remove any entries for paths that no longer exist or are being recursively
2997 // refreshed. Do this before adding any new entries, so that renames can be
2998 // detected regardless of the order of the paths.
2999 let mut event_paths = Vec::<Arc<Path>>::with_capacity(abs_paths.len());
3000 for (abs_path, metadata) in abs_paths.iter().zip(metadata.iter()) {
3001 if let Ok(path) = abs_path.strip_prefix(&root_canonical_path) {
3002 if matches!(metadata, Ok(None)) || doing_recursive_update {
3003 snapshot.remove_path(path);
3004 }
3005 event_paths.push(path.into());
3006 } else {
3007 log::error!(
3008 "unexpected event {:?} for root path {:?}",
3009 abs_path,
3010 root_canonical_path
3011 );
3012 }
3013 }
3014
3015 for (path, metadata) in event_paths.iter().cloned().zip(metadata.into_iter()) {
3016 let abs_path: Arc<Path> = root_abs_path.join(&path).into();
3017
3018 match metadata {
3019 Ok(Some(metadata)) => {
3020 let ignore_stack =
3021 snapshot.ignore_stack_for_abs_path(&abs_path, metadata.is_dir);
3022 let mut fs_entry = Entry::new(
3023 path.clone(),
3024 &metadata,
3025 snapshot.next_entry_id.as_ref(),
3026 snapshot.root_char_bag,
3027 );
3028 fs_entry.is_ignored = ignore_stack.is_all();
3029 snapshot.insert_entry(fs_entry, self.fs.as_ref());
3030
3031 if let Some(scan_queue_tx) = &scan_queue_tx {
3032 let mut ancestor_inodes = snapshot.ancestor_inodes_for_path(&path);
3033 if metadata.is_dir && !ancestor_inodes.contains(&metadata.inode) {
3034 ancestor_inodes.insert(metadata.inode);
3035 smol::block_on(scan_queue_tx.send(ScanJob {
3036 abs_path,
3037 path,
3038 ignore_stack,
3039 ancestor_inodes,
3040 scan_queue: scan_queue_tx.clone(),
3041 }))
3042 .unwrap();
3043 }
3044 }
3045 }
3046 Ok(None) => {
3047 self.remove_repo_path(&path, &mut snapshot);
3048 }
3049 Err(err) => {
3050 // TODO - create a special 'error' entry in the entries tree to mark this
3051 log::error!("error reading file on event {:?}", err);
3052 }
3053 }
3054 }
3055
3056 Some(event_paths)
3057 }
3058
3059 fn remove_repo_path(&self, path: &Path, snapshot: &mut LocalSnapshot) -> Option<()> {
3060 if !path
3061 .components()
3062 .any(|component| component.as_os_str() == *DOT_GIT)
3063 {
3064 let scan_id = snapshot.scan_id;
3065 let repo = snapshot.repo_for(&path)?;
3066
3067 let repo_path = repo.work_directory.relativize(&snapshot, &path)?;
3068
3069 let work_dir = repo.work_directory(snapshot)?;
3070 let work_dir_id = repo.work_directory;
3071
3072 snapshot
3073 .git_repositories
3074 .update(&work_dir_id, |entry| entry.scan_id = scan_id);
3075
3076 snapshot.repository_entries.update(&work_dir, |entry| {
3077 entry
3078 .statuses
3079 .remove_range(&repo_path, &RepoPathDescendants(&repo_path))
3080 });
3081 }
3082
3083 Some(())
3084 }
3085
3086 fn reload_repo_for_file_path(
3087 &self,
3088 path: &Path,
3089 snapshot: &mut LocalSnapshot,
3090 fs: &dyn Fs,
3091 ) -> Option<()> {
3092 let scan_id = snapshot.scan_id;
3093
3094 if path
3095 .components()
3096 .any(|component| component.as_os_str() == *DOT_GIT)
3097 {
3098 let (entry_id, repo_ptr) = {
3099 let Some((entry_id, repo)) = snapshot.repo_for_metadata(&path) else {
3100 let dot_git_dir = path.ancestors()
3101 .skip_while(|ancestor| ancestor.file_name() != Some(&*DOT_GIT))
3102 .next()?;
3103
3104 snapshot.build_repo(dot_git_dir.into(), fs);
3105 return None;
3106 };
3107 if repo.full_scan_id == scan_id {
3108 return None;
3109 }
3110 (*entry_id, repo.repo_ptr.to_owned())
3111 };
3112
3113 let work_dir = snapshot
3114 .entry_for_id(entry_id)
3115 .map(|entry| RepositoryWorkDirectory(entry.path.clone()))?;
3116
3117 let repo = repo_ptr.lock();
3118 repo.reload_index();
3119 let branch = repo.branch_name();
3120 let statuses = repo.statuses().unwrap_or_default();
3121
3122 snapshot.git_repositories.update(&entry_id, |entry| {
3123 entry.scan_id = scan_id;
3124 entry.full_scan_id = scan_id;
3125 });
3126
3127 snapshot.repository_entries.update(&work_dir, |entry| {
3128 entry.branch = branch.map(Into::into);
3129 entry.statuses = statuses;
3130 });
3131 } else {
3132 if snapshot
3133 .entry_for_path(&path)
3134 .map(|entry| entry.is_ignored)
3135 .unwrap_or(false)
3136 {
3137 self.remove_repo_path(&path, snapshot);
3138 return None;
3139 }
3140
3141 let repo = snapshot.repo_for(&path)?;
3142
3143 let work_dir = repo.work_directory(snapshot)?;
3144 let work_dir_id = repo.work_directory.clone();
3145
3146 snapshot
3147 .git_repositories
3148 .update(&work_dir_id, |entry| entry.scan_id = scan_id);
3149
3150 let local_repo = snapshot.get_local_repo(&repo)?.to_owned();
3151
3152 // Short circuit if we've already scanned everything
3153 if local_repo.full_scan_id == scan_id {
3154 return None;
3155 }
3156
3157 let mut repository = snapshot.repository_entries.remove(&work_dir)?;
3158
3159 for entry in snapshot.descendent_entries(false, false, path) {
3160 let Some(repo_path) = repo.work_directory.relativize(snapshot, &entry.path) else {
3161 continue;
3162 };
3163
3164 let status = local_repo.repo_ptr.lock().status(&repo_path);
3165 if let Some(status) = status {
3166 repository.statuses.insert(repo_path.clone(), status);
3167 } else {
3168 repository.statuses.remove(&repo_path);
3169 }
3170 }
3171
3172 snapshot.repository_entries.insert(work_dir, repository)
3173 }
3174
3175 Some(())
3176 }
3177
3178 async fn update_ignore_statuses(&self) {
3179 use futures::FutureExt as _;
3180
3181 let mut snapshot = self.snapshot.lock().clone();
3182 let mut ignores_to_update = Vec::new();
3183 let mut ignores_to_delete = Vec::new();
3184 for (parent_abs_path, (_, scan_id)) in &snapshot.ignores_by_parent_abs_path {
3185 if let Ok(parent_path) = parent_abs_path.strip_prefix(&snapshot.abs_path) {
3186 if *scan_id > snapshot.completed_scan_id
3187 && snapshot.entry_for_path(parent_path).is_some()
3188 {
3189 ignores_to_update.push(parent_abs_path.clone());
3190 }
3191
3192 let ignore_path = parent_path.join(&*GITIGNORE);
3193 if snapshot.entry_for_path(ignore_path).is_none() {
3194 ignores_to_delete.push(parent_abs_path.clone());
3195 }
3196 }
3197 }
3198
3199 for parent_abs_path in ignores_to_delete {
3200 snapshot.ignores_by_parent_abs_path.remove(&parent_abs_path);
3201 self.snapshot
3202 .lock()
3203 .ignores_by_parent_abs_path
3204 .remove(&parent_abs_path);
3205 }
3206
3207 let (ignore_queue_tx, ignore_queue_rx) = channel::unbounded();
3208 ignores_to_update.sort_unstable();
3209 let mut ignores_to_update = ignores_to_update.into_iter().peekable();
3210 while let Some(parent_abs_path) = ignores_to_update.next() {
3211 while ignores_to_update
3212 .peek()
3213 .map_or(false, |p| p.starts_with(&parent_abs_path))
3214 {
3215 ignores_to_update.next().unwrap();
3216 }
3217
3218 let ignore_stack = snapshot.ignore_stack_for_abs_path(&parent_abs_path, true);
3219 smol::block_on(ignore_queue_tx.send(UpdateIgnoreStatusJob {
3220 abs_path: parent_abs_path,
3221 ignore_stack,
3222 ignore_queue: ignore_queue_tx.clone(),
3223 }))
3224 .unwrap();
3225 }
3226 drop(ignore_queue_tx);
3227
3228 self.executor
3229 .scoped(|scope| {
3230 for _ in 0..self.executor.num_cpus() {
3231 scope.spawn(async {
3232 loop {
3233 select_biased! {
3234 // Process any path refresh requests before moving on to process
3235 // the queue of ignore statuses.
3236 request = self.refresh_requests_rx.recv().fuse() => {
3237 let Ok((paths, barrier)) = request else { break };
3238 if !self.process_refresh_request(paths, barrier).await {
3239 return;
3240 }
3241 }
3242
3243 // Recursively process directories whose ignores have changed.
3244 job = ignore_queue_rx.recv().fuse() => {
3245 let Ok(job) = job else { break };
3246 self.update_ignore_status(job, &snapshot).await;
3247 }
3248 }
3249 }
3250 });
3251 }
3252 })
3253 .await;
3254 }
3255
3256 async fn update_ignore_status(&self, job: UpdateIgnoreStatusJob, snapshot: &LocalSnapshot) {
3257 let mut ignore_stack = job.ignore_stack;
3258 if let Some((ignore, _)) = snapshot.ignores_by_parent_abs_path.get(&job.abs_path) {
3259 ignore_stack = ignore_stack.append(job.abs_path.clone(), ignore.clone());
3260 }
3261
3262 let mut entries_by_id_edits = Vec::new();
3263 let mut entries_by_path_edits = Vec::new();
3264 let path = job.abs_path.strip_prefix(&snapshot.abs_path).unwrap();
3265 for mut entry in snapshot.child_entries(path).cloned() {
3266 let was_ignored = entry.is_ignored;
3267 let abs_path = snapshot.abs_path().join(&entry.path);
3268 entry.is_ignored = ignore_stack.is_abs_path_ignored(&abs_path, entry.is_dir());
3269 if entry.is_dir() {
3270 let child_ignore_stack = if entry.is_ignored {
3271 IgnoreStack::all()
3272 } else {
3273 ignore_stack.clone()
3274 };
3275 job.ignore_queue
3276 .send(UpdateIgnoreStatusJob {
3277 abs_path: abs_path.into(),
3278 ignore_stack: child_ignore_stack,
3279 ignore_queue: job.ignore_queue.clone(),
3280 })
3281 .await
3282 .unwrap();
3283 }
3284
3285 if entry.is_ignored != was_ignored {
3286 let mut path_entry = snapshot.entries_by_id.get(&entry.id, &()).unwrap().clone();
3287 path_entry.scan_id = snapshot.scan_id;
3288 path_entry.is_ignored = entry.is_ignored;
3289 entries_by_id_edits.push(Edit::Insert(path_entry));
3290 entries_by_path_edits.push(Edit::Insert(entry));
3291 }
3292 }
3293
3294 let mut snapshot = self.snapshot.lock();
3295 snapshot.entries_by_path.edit(entries_by_path_edits, &());
3296 snapshot.entries_by_id.edit(entries_by_id_edits, &());
3297 }
3298
3299 fn build_change_set(
3300 &self,
3301 old_snapshot: &Snapshot,
3302 new_snapshot: &Snapshot,
3303 event_paths: &[Arc<Path>],
3304 ) -> HashMap<(Arc<Path>, ProjectEntryId), PathChange> {
3305 use PathChange::{Added, AddedOrUpdated, Removed, Updated};
3306
3307 let mut changes = HashMap::default();
3308 let mut old_paths = old_snapshot.entries_by_path.cursor::<PathKey>();
3309 let mut new_paths = new_snapshot.entries_by_path.cursor::<PathKey>();
3310 let received_before_initialized = !self.finished_initial_scan;
3311
3312 for path in event_paths {
3313 let path = PathKey(path.clone());
3314 old_paths.seek(&path, Bias::Left, &());
3315 new_paths.seek(&path, Bias::Left, &());
3316
3317 loop {
3318 match (old_paths.item(), new_paths.item()) {
3319 (Some(old_entry), Some(new_entry)) => {
3320 if old_entry.path > path.0
3321 && new_entry.path > path.0
3322 && !old_entry.path.starts_with(&path.0)
3323 && !new_entry.path.starts_with(&path.0)
3324 {
3325 break;
3326 }
3327
3328 match Ord::cmp(&old_entry.path, &new_entry.path) {
3329 Ordering::Less => {
3330 changes.insert((old_entry.path.clone(), old_entry.id), Removed);
3331 old_paths.next(&());
3332 }
3333 Ordering::Equal => {
3334 if received_before_initialized {
3335 // If the worktree was not fully initialized when this event was generated,
3336 // we can't know whether this entry was added during the scan or whether
3337 // it was merely updated.
3338 changes.insert(
3339 (new_entry.path.clone(), new_entry.id),
3340 AddedOrUpdated,
3341 );
3342 } else if old_entry.mtime != new_entry.mtime {
3343 changes.insert((new_entry.path.clone(), new_entry.id), Updated);
3344 }
3345 old_paths.next(&());
3346 new_paths.next(&());
3347 }
3348 Ordering::Greater => {
3349 changes.insert((new_entry.path.clone(), new_entry.id), Added);
3350 new_paths.next(&());
3351 }
3352 }
3353 }
3354 (Some(old_entry), None) => {
3355 changes.insert((old_entry.path.clone(), old_entry.id), Removed);
3356 old_paths.next(&());
3357 }
3358 (None, Some(new_entry)) => {
3359 changes.insert((new_entry.path.clone(), new_entry.id), Added);
3360 new_paths.next(&());
3361 }
3362 (None, None) => break,
3363 }
3364 }
3365 }
3366
3367 changes
3368 }
3369
3370 async fn progress_timer(&self, running: bool) {
3371 if !running {
3372 return futures::future::pending().await;
3373 }
3374
3375 #[cfg(any(test, feature = "test-support"))]
3376 if self.fs.is_fake() {
3377 return self.executor.simulate_random_delay().await;
3378 }
3379
3380 smol::Timer::after(Duration::from_millis(100)).await;
3381 }
3382}
3383
3384fn char_bag_for_path(root_char_bag: CharBag, path: &Path) -> CharBag {
3385 let mut result = root_char_bag;
3386 result.extend(
3387 path.to_string_lossy()
3388 .chars()
3389 .map(|c| c.to_ascii_lowercase()),
3390 );
3391 result
3392}
3393
3394struct ScanJob {
3395 abs_path: Arc<Path>,
3396 path: Arc<Path>,
3397 ignore_stack: Arc<IgnoreStack>,
3398 scan_queue: Sender<ScanJob>,
3399 ancestor_inodes: TreeSet<u64>,
3400}
3401
3402struct UpdateIgnoreStatusJob {
3403 abs_path: Arc<Path>,
3404 ignore_stack: Arc<IgnoreStack>,
3405 ignore_queue: Sender<UpdateIgnoreStatusJob>,
3406}
3407
3408pub trait WorktreeHandle {
3409 #[cfg(any(test, feature = "test-support"))]
3410 fn flush_fs_events<'a>(
3411 &self,
3412 cx: &'a gpui::TestAppContext,
3413 ) -> futures::future::LocalBoxFuture<'a, ()>;
3414}
3415
3416impl WorktreeHandle for ModelHandle<Worktree> {
3417 // When the worktree's FS event stream sometimes delivers "redundant" events for FS changes that
3418 // occurred before the worktree was constructed. These events can cause the worktree to perfrom
3419 // extra directory scans, and emit extra scan-state notifications.
3420 //
3421 // This function mutates the worktree's directory and waits for those mutations to be picked up,
3422 // to ensure that all redundant FS events have already been processed.
3423 #[cfg(any(test, feature = "test-support"))]
3424 fn flush_fs_events<'a>(
3425 &self,
3426 cx: &'a gpui::TestAppContext,
3427 ) -> futures::future::LocalBoxFuture<'a, ()> {
3428 use smol::future::FutureExt;
3429
3430 let filename = "fs-event-sentinel";
3431 let tree = self.clone();
3432 let (fs, root_path) = self.read_with(cx, |tree, _| {
3433 let tree = tree.as_local().unwrap();
3434 (tree.fs.clone(), tree.abs_path().clone())
3435 });
3436
3437 async move {
3438 fs.create_file(&root_path.join(filename), Default::default())
3439 .await
3440 .unwrap();
3441 tree.condition(cx, |tree, _| tree.entry_for_path(filename).is_some())
3442 .await;
3443
3444 fs.remove_file(&root_path.join(filename), Default::default())
3445 .await
3446 .unwrap();
3447 tree.condition(cx, |tree, _| tree.entry_for_path(filename).is_none())
3448 .await;
3449
3450 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
3451 .await;
3452 }
3453 .boxed_local()
3454 }
3455}
3456
3457#[derive(Clone, Debug)]
3458struct TraversalProgress<'a> {
3459 max_path: &'a Path,
3460 count: usize,
3461 visible_count: usize,
3462 file_count: usize,
3463 visible_file_count: usize,
3464}
3465
3466impl<'a> TraversalProgress<'a> {
3467 fn count(&self, include_dirs: bool, include_ignored: bool) -> usize {
3468 match (include_ignored, include_dirs) {
3469 (true, true) => self.count,
3470 (true, false) => self.file_count,
3471 (false, true) => self.visible_count,
3472 (false, false) => self.visible_file_count,
3473 }
3474 }
3475}
3476
3477impl<'a> sum_tree::Dimension<'a, EntrySummary> for TraversalProgress<'a> {
3478 fn add_summary(&mut self, summary: &'a EntrySummary, _: &()) {
3479 self.max_path = summary.max_path.as_ref();
3480 self.count += summary.count;
3481 self.visible_count += summary.visible_count;
3482 self.file_count += summary.file_count;
3483 self.visible_file_count += summary.visible_file_count;
3484 }
3485}
3486
3487impl<'a> Default for TraversalProgress<'a> {
3488 fn default() -> Self {
3489 Self {
3490 max_path: Path::new(""),
3491 count: 0,
3492 visible_count: 0,
3493 file_count: 0,
3494 visible_file_count: 0,
3495 }
3496 }
3497}
3498
3499pub struct Traversal<'a> {
3500 cursor: sum_tree::Cursor<'a, Entry, TraversalProgress<'a>>,
3501 include_ignored: bool,
3502 include_dirs: bool,
3503}
3504
3505impl<'a> Traversal<'a> {
3506 pub fn advance(&mut self) -> bool {
3507 self.cursor.seek_forward(
3508 &TraversalTarget::Count {
3509 count: self.end_offset() + 1,
3510 include_dirs: self.include_dirs,
3511 include_ignored: self.include_ignored,
3512 },
3513 Bias::Left,
3514 &(),
3515 )
3516 }
3517
3518 pub fn advance_to_sibling(&mut self) -> bool {
3519 while let Some(entry) = self.cursor.item() {
3520 self.cursor.seek_forward(
3521 &TraversalTarget::PathSuccessor(&entry.path),
3522 Bias::Left,
3523 &(),
3524 );
3525 if let Some(entry) = self.cursor.item() {
3526 if (self.include_dirs || !entry.is_dir())
3527 && (self.include_ignored || !entry.is_ignored)
3528 {
3529 return true;
3530 }
3531 }
3532 }
3533 false
3534 }
3535
3536 pub fn entry(&self) -> Option<&'a Entry> {
3537 self.cursor.item()
3538 }
3539
3540 pub fn start_offset(&self) -> usize {
3541 self.cursor
3542 .start()
3543 .count(self.include_dirs, self.include_ignored)
3544 }
3545
3546 pub fn end_offset(&self) -> usize {
3547 self.cursor
3548 .end(&())
3549 .count(self.include_dirs, self.include_ignored)
3550 }
3551}
3552
3553impl<'a> Iterator for Traversal<'a> {
3554 type Item = &'a Entry;
3555
3556 fn next(&mut self) -> Option<Self::Item> {
3557 if let Some(item) = self.entry() {
3558 self.advance();
3559 Some(item)
3560 } else {
3561 None
3562 }
3563 }
3564}
3565
3566#[derive(Debug)]
3567enum TraversalTarget<'a> {
3568 Path(&'a Path),
3569 PathSuccessor(&'a Path),
3570 Count {
3571 count: usize,
3572 include_ignored: bool,
3573 include_dirs: bool,
3574 },
3575}
3576
3577impl<'a, 'b> SeekTarget<'a, EntrySummary, TraversalProgress<'a>> for TraversalTarget<'b> {
3578 fn cmp(&self, cursor_location: &TraversalProgress<'a>, _: &()) -> Ordering {
3579 match self {
3580 TraversalTarget::Path(path) => path.cmp(&cursor_location.max_path),
3581 TraversalTarget::PathSuccessor(path) => {
3582 if !cursor_location.max_path.starts_with(path) {
3583 Ordering::Equal
3584 } else {
3585 Ordering::Greater
3586 }
3587 }
3588 TraversalTarget::Count {
3589 count,
3590 include_dirs,
3591 include_ignored,
3592 } => Ord::cmp(
3593 count,
3594 &cursor_location.count(*include_dirs, *include_ignored),
3595 ),
3596 }
3597 }
3598}
3599
3600struct ChildEntriesIter<'a> {
3601 parent_path: &'a Path,
3602 traversal: Traversal<'a>,
3603}
3604
3605impl<'a> Iterator for ChildEntriesIter<'a> {
3606 type Item = &'a Entry;
3607
3608 fn next(&mut self) -> Option<Self::Item> {
3609 if let Some(item) = self.traversal.entry() {
3610 if item.path.starts_with(&self.parent_path) {
3611 self.traversal.advance_to_sibling();
3612 return Some(item);
3613 }
3614 }
3615 None
3616 }
3617}
3618
3619struct DescendentEntriesIter<'a> {
3620 parent_path: &'a Path,
3621 traversal: Traversal<'a>,
3622}
3623
3624impl<'a> Iterator for DescendentEntriesIter<'a> {
3625 type Item = &'a Entry;
3626
3627 fn next(&mut self) -> Option<Self::Item> {
3628 if let Some(item) = self.traversal.entry() {
3629 if item.path.starts_with(&self.parent_path) {
3630 self.traversal.advance();
3631 return Some(item);
3632 }
3633 }
3634 None
3635 }
3636}
3637
3638impl<'a> From<&'a Entry> for proto::Entry {
3639 fn from(entry: &'a Entry) -> Self {
3640 Self {
3641 id: entry.id.to_proto(),
3642 is_dir: entry.is_dir(),
3643 path: entry.path.to_string_lossy().into(),
3644 inode: entry.inode,
3645 mtime: Some(entry.mtime.into()),
3646 is_symlink: entry.is_symlink,
3647 is_ignored: entry.is_ignored,
3648 }
3649 }
3650}
3651
3652impl<'a> TryFrom<(&'a CharBag, proto::Entry)> for Entry {
3653 type Error = anyhow::Error;
3654
3655 fn try_from((root_char_bag, entry): (&'a CharBag, proto::Entry)) -> Result<Self> {
3656 if let Some(mtime) = entry.mtime {
3657 let kind = if entry.is_dir {
3658 EntryKind::Dir
3659 } else {
3660 let mut char_bag = *root_char_bag;
3661 char_bag.extend(entry.path.chars().map(|c| c.to_ascii_lowercase()));
3662 EntryKind::File(char_bag)
3663 };
3664 let path: Arc<Path> = PathBuf::from(entry.path).into();
3665 Ok(Entry {
3666 id: ProjectEntryId::from_proto(entry.id),
3667 kind,
3668 path,
3669 inode: entry.inode,
3670 mtime: mtime.into(),
3671 is_symlink: entry.is_symlink,
3672 is_ignored: entry.is_ignored,
3673 })
3674 } else {
3675 Err(anyhow!(
3676 "missing mtime in remote worktree entry {:?}",
3677 entry.path
3678 ))
3679 }
3680 }
3681}
3682
3683#[cfg(test)]
3684mod tests {
3685 use super::*;
3686 use fs::{FakeFs, RealFs};
3687 use gpui::{executor::Deterministic, TestAppContext};
3688 use pretty_assertions::assert_eq;
3689 use rand::prelude::*;
3690 use serde_json::json;
3691 use std::{env, fmt::Write};
3692 use util::{http::FakeHttpClient, test::temp_tree};
3693
3694 #[gpui::test]
3695 async fn test_traversal(cx: &mut TestAppContext) {
3696 let fs = FakeFs::new(cx.background());
3697 fs.insert_tree(
3698 "/root",
3699 json!({
3700 ".gitignore": "a/b\n",
3701 "a": {
3702 "b": "",
3703 "c": "",
3704 }
3705 }),
3706 )
3707 .await;
3708
3709 let http_client = FakeHttpClient::with_404_response();
3710 let client = cx.read(|cx| Client::new(http_client, cx));
3711
3712 let tree = Worktree::local(
3713 client,
3714 Path::new("/root"),
3715 true,
3716 fs,
3717 Default::default(),
3718 &mut cx.to_async(),
3719 )
3720 .await
3721 .unwrap();
3722 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
3723 .await;
3724
3725 tree.read_with(cx, |tree, _| {
3726 assert_eq!(
3727 tree.entries(false)
3728 .map(|entry| entry.path.as_ref())
3729 .collect::<Vec<_>>(),
3730 vec![
3731 Path::new(""),
3732 Path::new(".gitignore"),
3733 Path::new("a"),
3734 Path::new("a/c"),
3735 ]
3736 );
3737 assert_eq!(
3738 tree.entries(true)
3739 .map(|entry| entry.path.as_ref())
3740 .collect::<Vec<_>>(),
3741 vec![
3742 Path::new(""),
3743 Path::new(".gitignore"),
3744 Path::new("a"),
3745 Path::new("a/b"),
3746 Path::new("a/c"),
3747 ]
3748 );
3749 })
3750 }
3751
3752 #[gpui::test]
3753 async fn test_descendent_entries(cx: &mut TestAppContext) {
3754 let fs = FakeFs::new(cx.background());
3755 fs.insert_tree(
3756 "/root",
3757 json!({
3758 "a": "",
3759 "b": {
3760 "c": {
3761 "d": ""
3762 },
3763 "e": {}
3764 },
3765 "f": "",
3766 "g": {
3767 "h": {}
3768 },
3769 "i": {
3770 "j": {
3771 "k": ""
3772 },
3773 "l": {
3774
3775 }
3776 },
3777 ".gitignore": "i/j\n",
3778 }),
3779 )
3780 .await;
3781
3782 let http_client = FakeHttpClient::with_404_response();
3783 let client = cx.read(|cx| Client::new(http_client, cx));
3784
3785 let tree = Worktree::local(
3786 client,
3787 Path::new("/root"),
3788 true,
3789 fs,
3790 Default::default(),
3791 &mut cx.to_async(),
3792 )
3793 .await
3794 .unwrap();
3795 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
3796 .await;
3797
3798 tree.read_with(cx, |tree, _| {
3799 assert_eq!(
3800 tree.descendent_entries(false, false, Path::new("b"))
3801 .map(|entry| entry.path.as_ref())
3802 .collect::<Vec<_>>(),
3803 vec![Path::new("b/c/d"),]
3804 );
3805 assert_eq!(
3806 tree.descendent_entries(true, false, Path::new("b"))
3807 .map(|entry| entry.path.as_ref())
3808 .collect::<Vec<_>>(),
3809 vec![
3810 Path::new("b"),
3811 Path::new("b/c"),
3812 Path::new("b/c/d"),
3813 Path::new("b/e"),
3814 ]
3815 );
3816
3817 assert_eq!(
3818 tree.descendent_entries(false, false, Path::new("g"))
3819 .map(|entry| entry.path.as_ref())
3820 .collect::<Vec<_>>(),
3821 Vec::<PathBuf>::new()
3822 );
3823 assert_eq!(
3824 tree.descendent_entries(true, false, Path::new("g"))
3825 .map(|entry| entry.path.as_ref())
3826 .collect::<Vec<_>>(),
3827 vec![Path::new("g"), Path::new("g/h"),]
3828 );
3829
3830 assert_eq!(
3831 tree.descendent_entries(false, false, Path::new("i"))
3832 .map(|entry| entry.path.as_ref())
3833 .collect::<Vec<_>>(),
3834 Vec::<PathBuf>::new()
3835 );
3836 assert_eq!(
3837 tree.descendent_entries(false, true, Path::new("i"))
3838 .map(|entry| entry.path.as_ref())
3839 .collect::<Vec<_>>(),
3840 vec![Path::new("i/j/k")]
3841 );
3842 assert_eq!(
3843 tree.descendent_entries(true, false, Path::new("i"))
3844 .map(|entry| entry.path.as_ref())
3845 .collect::<Vec<_>>(),
3846 vec![Path::new("i"), Path::new("i/l"),]
3847 );
3848 })
3849 }
3850
3851 #[gpui::test(iterations = 10)]
3852 async fn test_circular_symlinks(executor: Arc<Deterministic>, cx: &mut TestAppContext) {
3853 let fs = FakeFs::new(cx.background());
3854 fs.insert_tree(
3855 "/root",
3856 json!({
3857 "lib": {
3858 "a": {
3859 "a.txt": ""
3860 },
3861 "b": {
3862 "b.txt": ""
3863 }
3864 }
3865 }),
3866 )
3867 .await;
3868 fs.insert_symlink("/root/lib/a/lib", "..".into()).await;
3869 fs.insert_symlink("/root/lib/b/lib", "..".into()).await;
3870
3871 let client = cx.read(|cx| Client::new(FakeHttpClient::with_404_response(), cx));
3872 let tree = Worktree::local(
3873 client,
3874 Path::new("/root"),
3875 true,
3876 fs.clone(),
3877 Default::default(),
3878 &mut cx.to_async(),
3879 )
3880 .await
3881 .unwrap();
3882
3883 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
3884 .await;
3885
3886 tree.read_with(cx, |tree, _| {
3887 assert_eq!(
3888 tree.entries(false)
3889 .map(|entry| entry.path.as_ref())
3890 .collect::<Vec<_>>(),
3891 vec![
3892 Path::new(""),
3893 Path::new("lib"),
3894 Path::new("lib/a"),
3895 Path::new("lib/a/a.txt"),
3896 Path::new("lib/a/lib"),
3897 Path::new("lib/b"),
3898 Path::new("lib/b/b.txt"),
3899 Path::new("lib/b/lib"),
3900 ]
3901 );
3902 });
3903
3904 fs.rename(
3905 Path::new("/root/lib/a/lib"),
3906 Path::new("/root/lib/a/lib-2"),
3907 Default::default(),
3908 )
3909 .await
3910 .unwrap();
3911 executor.run_until_parked();
3912 tree.read_with(cx, |tree, _| {
3913 assert_eq!(
3914 tree.entries(false)
3915 .map(|entry| entry.path.as_ref())
3916 .collect::<Vec<_>>(),
3917 vec![
3918 Path::new(""),
3919 Path::new("lib"),
3920 Path::new("lib/a"),
3921 Path::new("lib/a/a.txt"),
3922 Path::new("lib/a/lib-2"),
3923 Path::new("lib/b"),
3924 Path::new("lib/b/b.txt"),
3925 Path::new("lib/b/lib"),
3926 ]
3927 );
3928 });
3929 }
3930
3931 #[gpui::test]
3932 async fn test_rescan_with_gitignore(cx: &mut TestAppContext) {
3933 let parent_dir = temp_tree(json!({
3934 ".gitignore": "ancestor-ignored-file1\nancestor-ignored-file2\n",
3935 "tree": {
3936 ".git": {},
3937 ".gitignore": "ignored-dir\n",
3938 "tracked-dir": {
3939 "tracked-file1": "",
3940 "ancestor-ignored-file1": "",
3941 },
3942 "ignored-dir": {
3943 "ignored-file1": ""
3944 }
3945 }
3946 }));
3947 let dir = parent_dir.path().join("tree");
3948
3949 let client = cx.read(|cx| Client::new(FakeHttpClient::with_404_response(), cx));
3950
3951 let tree = Worktree::local(
3952 client,
3953 dir.as_path(),
3954 true,
3955 Arc::new(RealFs),
3956 Default::default(),
3957 &mut cx.to_async(),
3958 )
3959 .await
3960 .unwrap();
3961 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
3962 .await;
3963 tree.flush_fs_events(cx).await;
3964 cx.read(|cx| {
3965 let tree = tree.read(cx);
3966 assert!(
3967 !tree
3968 .entry_for_path("tracked-dir/tracked-file1")
3969 .unwrap()
3970 .is_ignored
3971 );
3972 assert!(
3973 tree.entry_for_path("tracked-dir/ancestor-ignored-file1")
3974 .unwrap()
3975 .is_ignored
3976 );
3977 assert!(
3978 tree.entry_for_path("ignored-dir/ignored-file1")
3979 .unwrap()
3980 .is_ignored
3981 );
3982 });
3983
3984 std::fs::write(dir.join("tracked-dir/tracked-file2"), "").unwrap();
3985 std::fs::write(dir.join("tracked-dir/ancestor-ignored-file2"), "").unwrap();
3986 std::fs::write(dir.join("ignored-dir/ignored-file2"), "").unwrap();
3987 tree.flush_fs_events(cx).await;
3988 cx.read(|cx| {
3989 let tree = tree.read(cx);
3990 assert!(
3991 !tree
3992 .entry_for_path("tracked-dir/tracked-file2")
3993 .unwrap()
3994 .is_ignored
3995 );
3996 assert!(
3997 tree.entry_for_path("tracked-dir/ancestor-ignored-file2")
3998 .unwrap()
3999 .is_ignored
4000 );
4001 assert!(
4002 tree.entry_for_path("ignored-dir/ignored-file2")
4003 .unwrap()
4004 .is_ignored
4005 );
4006 assert!(tree.entry_for_path(".git").unwrap().is_ignored);
4007 });
4008 }
4009
4010 #[gpui::test]
4011 async fn test_git_repository_for_path(cx: &mut TestAppContext) {
4012 let root = temp_tree(json!({
4013 "dir1": {
4014 ".git": {},
4015 "deps": {
4016 "dep1": {
4017 ".git": {},
4018 "src": {
4019 "a.txt": ""
4020 }
4021 }
4022 },
4023 "src": {
4024 "b.txt": ""
4025 }
4026 },
4027 "c.txt": "",
4028 }));
4029
4030 let http_client = FakeHttpClient::with_404_response();
4031 let client = cx.read(|cx| Client::new(http_client, cx));
4032 let tree = Worktree::local(
4033 client,
4034 root.path(),
4035 true,
4036 Arc::new(RealFs),
4037 Default::default(),
4038 &mut cx.to_async(),
4039 )
4040 .await
4041 .unwrap();
4042
4043 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
4044 .await;
4045 tree.flush_fs_events(cx).await;
4046
4047 tree.read_with(cx, |tree, _cx| {
4048 let tree = tree.as_local().unwrap();
4049
4050 assert!(tree.repo_for("c.txt".as_ref()).is_none());
4051
4052 let entry = tree.repo_for("dir1/src/b.txt".as_ref()).unwrap();
4053 assert_eq!(
4054 entry
4055 .work_directory(tree)
4056 .map(|directory| directory.as_ref().to_owned()),
4057 Some(Path::new("dir1").to_owned())
4058 );
4059
4060 let entry = tree.repo_for("dir1/deps/dep1/src/a.txt".as_ref()).unwrap();
4061 assert_eq!(
4062 entry
4063 .work_directory(tree)
4064 .map(|directory| directory.as_ref().to_owned()),
4065 Some(Path::new("dir1/deps/dep1").to_owned())
4066 );
4067 });
4068
4069 let repo_update_events = Arc::new(Mutex::new(vec![]));
4070 tree.update(cx, |_, cx| {
4071 let repo_update_events = repo_update_events.clone();
4072 cx.subscribe(&tree, move |_, _, event, _| {
4073 if let Event::UpdatedGitRepositories(update) = event {
4074 repo_update_events.lock().push(update.clone());
4075 }
4076 })
4077 .detach();
4078 });
4079
4080 std::fs::write(root.path().join("dir1/.git/random_new_file"), "hello").unwrap();
4081 tree.flush_fs_events(cx).await;
4082
4083 assert_eq!(
4084 repo_update_events.lock()[0]
4085 .keys()
4086 .cloned()
4087 .collect::<Vec<Arc<Path>>>(),
4088 vec![Path::new("dir1").into()]
4089 );
4090
4091 std::fs::remove_dir_all(root.path().join("dir1/.git")).unwrap();
4092 tree.flush_fs_events(cx).await;
4093
4094 tree.read_with(cx, |tree, _cx| {
4095 let tree = tree.as_local().unwrap();
4096
4097 assert!(tree.repo_for("dir1/src/b.txt".as_ref()).is_none());
4098 });
4099 }
4100
4101 #[gpui::test]
4102 async fn test_git_status(cx: &mut TestAppContext) {
4103 #[track_caller]
4104 fn git_init(path: &Path) -> git2::Repository {
4105 git2::Repository::init(path).expect("Failed to initialize git repository")
4106 }
4107
4108 #[track_caller]
4109 fn git_add(path: &Path, repo: &git2::Repository) {
4110 let mut index = repo.index().expect("Failed to get index");
4111 index.add_path(path).expect("Failed to add a.txt");
4112 index.write().expect("Failed to write index");
4113 }
4114
4115 #[track_caller]
4116 fn git_remove_index(path: &Path, repo: &git2::Repository) {
4117 let mut index = repo.index().expect("Failed to get index");
4118 index.remove_path(path).expect("Failed to add a.txt");
4119 index.write().expect("Failed to write index");
4120 }
4121
4122 #[track_caller]
4123 fn git_commit(msg: &'static str, repo: &git2::Repository) {
4124 use git2::Signature;
4125
4126 let signature = Signature::now("test", "test@zed.dev").unwrap();
4127 let oid = repo.index().unwrap().write_tree().unwrap();
4128 let tree = repo.find_tree(oid).unwrap();
4129 if let Some(head) = repo.head().ok() {
4130 let parent_obj = head.peel(git2::ObjectType::Commit).unwrap();
4131
4132 let parent_commit = parent_obj.as_commit().unwrap();
4133
4134 repo.commit(
4135 Some("HEAD"),
4136 &signature,
4137 &signature,
4138 msg,
4139 &tree,
4140 &[parent_commit],
4141 )
4142 .expect("Failed to commit with parent");
4143 } else {
4144 repo.commit(Some("HEAD"), &signature, &signature, msg, &tree, &[])
4145 .expect("Failed to commit");
4146 }
4147 }
4148
4149 #[track_caller]
4150 fn git_stash(repo: &mut git2::Repository) {
4151 use git2::Signature;
4152
4153 let signature = Signature::now("test", "test@zed.dev").unwrap();
4154 repo.stash_save(&signature, "N/A", None)
4155 .expect("Failed to stash");
4156 }
4157
4158 #[track_caller]
4159 fn git_reset(offset: usize, repo: &git2::Repository) {
4160 let head = repo.head().expect("Couldn't get repo head");
4161 let object = head.peel(git2::ObjectType::Commit).unwrap();
4162 let commit = object.as_commit().unwrap();
4163 let new_head = commit
4164 .parents()
4165 .inspect(|parnet| {
4166 parnet.message();
4167 })
4168 .skip(offset)
4169 .next()
4170 .expect("Not enough history");
4171 repo.reset(&new_head.as_object(), git2::ResetType::Soft, None)
4172 .expect("Could not reset");
4173 }
4174
4175 #[allow(dead_code)]
4176 #[track_caller]
4177 fn git_status(repo: &git2::Repository) -> HashMap<String, git2::Status> {
4178 repo.statuses(None)
4179 .unwrap()
4180 .iter()
4181 .map(|status| (status.path().unwrap().to_string(), status.status()))
4182 .collect()
4183 }
4184
4185 const IGNORE_RULE: &'static str = "**/target";
4186
4187 let root = temp_tree(json!({
4188 "project": {
4189 "a.txt": "a",
4190 "b.txt": "bb",
4191 "c": {
4192 "d": {
4193 "e.txt": "eee"
4194 }
4195 },
4196 "f.txt": "ffff",
4197 "target": {
4198 "build_file": "???"
4199 },
4200 ".gitignore": IGNORE_RULE
4201 },
4202
4203 }));
4204
4205 let http_client = FakeHttpClient::with_404_response();
4206 let client = cx.read(|cx| Client::new(http_client, cx));
4207 let tree = Worktree::local(
4208 client,
4209 root.path(),
4210 true,
4211 Arc::new(RealFs),
4212 Default::default(),
4213 &mut cx.to_async(),
4214 )
4215 .await
4216 .unwrap();
4217
4218 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
4219 .await;
4220
4221 const A_TXT: &'static str = "a.txt";
4222 const B_TXT: &'static str = "b.txt";
4223 const E_TXT: &'static str = "c/d/e.txt";
4224 const F_TXT: &'static str = "f.txt";
4225 const DOTGITIGNORE: &'static str = ".gitignore";
4226 const BUILD_FILE: &'static str = "target/build_file";
4227
4228 let work_dir = root.path().join("project");
4229 let mut repo = git_init(work_dir.as_path());
4230 repo.add_ignore_rule(IGNORE_RULE).unwrap();
4231 git_add(Path::new(A_TXT), &repo);
4232 git_add(Path::new(E_TXT), &repo);
4233 git_add(Path::new(DOTGITIGNORE), &repo);
4234 git_commit("Initial commit", &repo);
4235
4236 std::fs::write(work_dir.join(A_TXT), "aa").unwrap();
4237
4238 tree.flush_fs_events(cx).await;
4239
4240 // Check that the right git state is observed on startup
4241 tree.read_with(cx, |tree, _cx| {
4242 let snapshot = tree.snapshot();
4243 assert_eq!(snapshot.repository_entries.iter().count(), 1);
4244 let (dir, repo) = snapshot.repository_entries.iter().next().unwrap();
4245 assert_eq!(dir.0.as_ref(), Path::new("project"));
4246
4247 assert_eq!(repo.statuses.iter().count(), 3);
4248 assert_eq!(
4249 repo.statuses.get(&Path::new(A_TXT).into()),
4250 Some(&GitFileStatus::Modified)
4251 );
4252 assert_eq!(
4253 repo.statuses.get(&Path::new(B_TXT).into()),
4254 Some(&GitFileStatus::Added)
4255 );
4256 assert_eq!(
4257 repo.statuses.get(&Path::new(F_TXT).into()),
4258 Some(&GitFileStatus::Added)
4259 );
4260 });
4261
4262 git_add(Path::new(A_TXT), &repo);
4263 git_add(Path::new(B_TXT), &repo);
4264 git_commit("Committing modified and added", &repo);
4265 tree.flush_fs_events(cx).await;
4266
4267 // Check that repo only changes are tracked
4268 tree.read_with(cx, |tree, _cx| {
4269 let snapshot = tree.snapshot();
4270 let (_, repo) = snapshot.repository_entries.iter().next().unwrap();
4271
4272 assert_eq!(repo.statuses.iter().count(), 1);
4273 assert_eq!(
4274 repo.statuses.get(&Path::new(F_TXT).into()),
4275 Some(&GitFileStatus::Added)
4276 );
4277 });
4278
4279 git_reset(0, &repo);
4280 git_remove_index(Path::new(B_TXT), &repo);
4281 git_stash(&mut repo);
4282 std::fs::write(work_dir.join(E_TXT), "eeee").unwrap();
4283 std::fs::write(work_dir.join(BUILD_FILE), "this should be ignored").unwrap();
4284 tree.flush_fs_events(cx).await;
4285
4286 // Check that more complex repo changes are tracked
4287 tree.read_with(cx, |tree, _cx| {
4288 let snapshot = tree.snapshot();
4289 let (_, repo) = snapshot.repository_entries.iter().next().unwrap();
4290
4291 assert_eq!(repo.statuses.iter().count(), 3);
4292 assert_eq!(repo.statuses.get(&Path::new(A_TXT).into()), None);
4293 assert_eq!(
4294 repo.statuses.get(&Path::new(B_TXT).into()),
4295 Some(&GitFileStatus::Added)
4296 );
4297 assert_eq!(
4298 repo.statuses.get(&Path::new(E_TXT).into()),
4299 Some(&GitFileStatus::Modified)
4300 );
4301 assert_eq!(
4302 repo.statuses.get(&Path::new(F_TXT).into()),
4303 Some(&GitFileStatus::Added)
4304 );
4305 });
4306
4307 std::fs::remove_file(work_dir.join(B_TXT)).unwrap();
4308 std::fs::remove_dir_all(work_dir.join("c")).unwrap();
4309 std::fs::write(
4310 work_dir.join(DOTGITIGNORE),
4311 [IGNORE_RULE, "f.txt"].join("\n"),
4312 )
4313 .unwrap();
4314
4315 git_add(Path::new(DOTGITIGNORE), &repo);
4316 git_commit("Committing modified git ignore", &repo);
4317
4318 tree.flush_fs_events(cx).await;
4319
4320 // Check that non-repo behavior is tracked
4321 tree.read_with(cx, |tree, _cx| {
4322 let snapshot = tree.snapshot();
4323 let (_, repo) = snapshot.repository_entries.iter().next().unwrap();
4324
4325 assert_eq!(repo.statuses.iter().count(), 0);
4326 });
4327
4328 let mut renamed_dir_name = "first_directory/second_directory";
4329 const RENAMED_FILE: &'static str = "rf.txt";
4330
4331 std::fs::create_dir_all(work_dir.join(renamed_dir_name)).unwrap();
4332 std::fs::write(
4333 work_dir.join(renamed_dir_name).join(RENAMED_FILE),
4334 "new-contents",
4335 )
4336 .unwrap();
4337
4338 tree.flush_fs_events(cx).await;
4339
4340 tree.read_with(cx, |tree, _cx| {
4341 let snapshot = tree.snapshot();
4342 let (_, repo) = snapshot.repository_entries.iter().next().unwrap();
4343
4344 assert_eq!(repo.statuses.iter().count(), 1);
4345 assert_eq!(
4346 repo.statuses
4347 .get(&Path::new(renamed_dir_name).join(RENAMED_FILE).into()),
4348 Some(&GitFileStatus::Added)
4349 );
4350 });
4351
4352 renamed_dir_name = "new_first_directory/second_directory";
4353
4354 std::fs::rename(
4355 work_dir.join("first_directory"),
4356 work_dir.join("new_first_directory"),
4357 )
4358 .unwrap();
4359
4360 tree.flush_fs_events(cx).await;
4361
4362 tree.read_with(cx, |tree, _cx| {
4363 let snapshot = tree.snapshot();
4364 let (_, repo) = snapshot.repository_entries.iter().next().unwrap();
4365
4366 assert_eq!(repo.statuses.iter().count(), 1);
4367 assert_eq!(
4368 repo.statuses
4369 .get(&Path::new(renamed_dir_name).join(RENAMED_FILE).into()),
4370 Some(&GitFileStatus::Added)
4371 );
4372 });
4373 }
4374
4375 #[gpui::test]
4376 async fn test_write_file(cx: &mut TestAppContext) {
4377 let dir = temp_tree(json!({
4378 ".git": {},
4379 ".gitignore": "ignored-dir\n",
4380 "tracked-dir": {},
4381 "ignored-dir": {}
4382 }));
4383
4384 let client = cx.read(|cx| Client::new(FakeHttpClient::with_404_response(), cx));
4385
4386 let tree = Worktree::local(
4387 client,
4388 dir.path(),
4389 true,
4390 Arc::new(RealFs),
4391 Default::default(),
4392 &mut cx.to_async(),
4393 )
4394 .await
4395 .unwrap();
4396 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
4397 .await;
4398 tree.flush_fs_events(cx).await;
4399
4400 tree.update(cx, |tree, cx| {
4401 tree.as_local().unwrap().write_file(
4402 Path::new("tracked-dir/file.txt"),
4403 "hello".into(),
4404 Default::default(),
4405 cx,
4406 )
4407 })
4408 .await
4409 .unwrap();
4410 tree.update(cx, |tree, cx| {
4411 tree.as_local().unwrap().write_file(
4412 Path::new("ignored-dir/file.txt"),
4413 "world".into(),
4414 Default::default(),
4415 cx,
4416 )
4417 })
4418 .await
4419 .unwrap();
4420
4421 tree.read_with(cx, |tree, _| {
4422 let tracked = tree.entry_for_path("tracked-dir/file.txt").unwrap();
4423 let ignored = tree.entry_for_path("ignored-dir/file.txt").unwrap();
4424 assert!(!tracked.is_ignored);
4425 assert!(ignored.is_ignored);
4426 });
4427 }
4428
4429 #[gpui::test(iterations = 30)]
4430 async fn test_create_directory_during_initial_scan(cx: &mut TestAppContext) {
4431 let client = cx.read(|cx| Client::new(FakeHttpClient::with_404_response(), cx));
4432
4433 let fs = FakeFs::new(cx.background());
4434 fs.insert_tree(
4435 "/root",
4436 json!({
4437 "b": {},
4438 "c": {},
4439 "d": {},
4440 }),
4441 )
4442 .await;
4443
4444 let tree = Worktree::local(
4445 client,
4446 "/root".as_ref(),
4447 true,
4448 fs,
4449 Default::default(),
4450 &mut cx.to_async(),
4451 )
4452 .await
4453 .unwrap();
4454
4455 let mut snapshot1 = tree.update(cx, |tree, _| tree.as_local().unwrap().snapshot());
4456
4457 let entry = tree
4458 .update(cx, |tree, cx| {
4459 tree.as_local_mut()
4460 .unwrap()
4461 .create_entry("a/e".as_ref(), true, cx)
4462 })
4463 .await
4464 .unwrap();
4465 assert!(entry.is_dir());
4466
4467 cx.foreground().run_until_parked();
4468 tree.read_with(cx, |tree, _| {
4469 assert_eq!(tree.entry_for_path("a/e").unwrap().kind, EntryKind::Dir);
4470 });
4471
4472 let snapshot2 = tree.update(cx, |tree, _| tree.as_local().unwrap().snapshot());
4473 let update = snapshot2.build_update(&snapshot1, 0, 0, true);
4474 snapshot1.apply_remote_update(update).unwrap();
4475 assert_eq!(snapshot1.to_vec(true), snapshot2.to_vec(true),);
4476 }
4477
4478 #[gpui::test(iterations = 100)]
4479 async fn test_random_worktree_operations_during_initial_scan(
4480 cx: &mut TestAppContext,
4481 mut rng: StdRng,
4482 ) {
4483 let operations = env::var("OPERATIONS")
4484 .map(|o| o.parse().unwrap())
4485 .unwrap_or(5);
4486 let initial_entries = env::var("INITIAL_ENTRIES")
4487 .map(|o| o.parse().unwrap())
4488 .unwrap_or(20);
4489
4490 let root_dir = Path::new("/test");
4491 let fs = FakeFs::new(cx.background()) as Arc<dyn Fs>;
4492 fs.as_fake().insert_tree(root_dir, json!({})).await;
4493 for _ in 0..initial_entries {
4494 randomly_mutate_fs(&fs, root_dir, 1.0, &mut rng).await;
4495 }
4496 log::info!("generated initial tree");
4497
4498 let client = cx.read(|cx| Client::new(FakeHttpClient::with_404_response(), cx));
4499 let worktree = Worktree::local(
4500 client.clone(),
4501 root_dir,
4502 true,
4503 fs.clone(),
4504 Default::default(),
4505 &mut cx.to_async(),
4506 )
4507 .await
4508 .unwrap();
4509
4510 let mut snapshot = worktree.update(cx, |tree, _| tree.as_local().unwrap().snapshot());
4511
4512 for _ in 0..operations {
4513 worktree
4514 .update(cx, |worktree, cx| {
4515 randomly_mutate_worktree(worktree, &mut rng, cx)
4516 })
4517 .await
4518 .log_err();
4519 worktree.read_with(cx, |tree, _| {
4520 tree.as_local().unwrap().snapshot.check_invariants()
4521 });
4522
4523 if rng.gen_bool(0.6) {
4524 let new_snapshot =
4525 worktree.read_with(cx, |tree, _| tree.as_local().unwrap().snapshot());
4526 let update = new_snapshot.build_update(&snapshot, 0, 0, true);
4527 snapshot.apply_remote_update(update.clone()).unwrap();
4528 assert_eq!(
4529 snapshot.to_vec(true),
4530 new_snapshot.to_vec(true),
4531 "incorrect snapshot after update {:?}",
4532 update
4533 );
4534 }
4535 }
4536
4537 worktree
4538 .update(cx, |tree, _| tree.as_local_mut().unwrap().scan_complete())
4539 .await;
4540 worktree.read_with(cx, |tree, _| {
4541 tree.as_local().unwrap().snapshot.check_invariants()
4542 });
4543
4544 let new_snapshot = worktree.read_with(cx, |tree, _| tree.as_local().unwrap().snapshot());
4545 let update = new_snapshot.build_update(&snapshot, 0, 0, true);
4546 snapshot.apply_remote_update(update.clone()).unwrap();
4547 assert_eq!(
4548 snapshot.to_vec(true),
4549 new_snapshot.to_vec(true),
4550 "incorrect snapshot after update {:?}",
4551 update
4552 );
4553 }
4554
4555 #[gpui::test(iterations = 100)]
4556 async fn test_random_worktree_changes(cx: &mut TestAppContext, mut rng: StdRng) {
4557 let operations = env::var("OPERATIONS")
4558 .map(|o| o.parse().unwrap())
4559 .unwrap_or(40);
4560 let initial_entries = env::var("INITIAL_ENTRIES")
4561 .map(|o| o.parse().unwrap())
4562 .unwrap_or(20);
4563
4564 let root_dir = Path::new("/test");
4565 let fs = FakeFs::new(cx.background()) as Arc<dyn Fs>;
4566 fs.as_fake().insert_tree(root_dir, json!({})).await;
4567 for _ in 0..initial_entries {
4568 randomly_mutate_fs(&fs, root_dir, 1.0, &mut rng).await;
4569 }
4570 log::info!("generated initial tree");
4571
4572 let client = cx.read(|cx| Client::new(FakeHttpClient::with_404_response(), cx));
4573 let worktree = Worktree::local(
4574 client.clone(),
4575 root_dir,
4576 true,
4577 fs.clone(),
4578 Default::default(),
4579 &mut cx.to_async(),
4580 )
4581 .await
4582 .unwrap();
4583
4584 worktree
4585 .update(cx, |tree, _| tree.as_local_mut().unwrap().scan_complete())
4586 .await;
4587
4588 // After the initial scan is complete, the `UpdatedEntries` event can
4589 // be used to follow along with all changes to the worktree's snapshot.
4590 worktree.update(cx, |tree, cx| {
4591 let mut paths = tree
4592 .as_local()
4593 .unwrap()
4594 .paths()
4595 .cloned()
4596 .collect::<Vec<_>>();
4597
4598 cx.subscribe(&worktree, move |tree, _, event, _| {
4599 if let Event::UpdatedEntries(changes) = event {
4600 for ((path, _), change_type) in changes.iter() {
4601 let path = path.clone();
4602 let ix = match paths.binary_search(&path) {
4603 Ok(ix) | Err(ix) => ix,
4604 };
4605 match change_type {
4606 PathChange::Added => {
4607 assert_ne!(paths.get(ix), Some(&path));
4608 paths.insert(ix, path);
4609 }
4610
4611 PathChange::Removed => {
4612 assert_eq!(paths.get(ix), Some(&path));
4613 paths.remove(ix);
4614 }
4615
4616 PathChange::Updated => {
4617 assert_eq!(paths.get(ix), Some(&path));
4618 }
4619
4620 PathChange::AddedOrUpdated => {
4621 if paths[ix] != path {
4622 paths.insert(ix, path);
4623 }
4624 }
4625 }
4626 }
4627
4628 let new_paths = tree.paths().cloned().collect::<Vec<_>>();
4629 assert_eq!(paths, new_paths, "incorrect changes: {:?}", changes);
4630 }
4631 })
4632 .detach();
4633 });
4634
4635 let mut snapshots = Vec::new();
4636 let mut mutations_len = operations;
4637 while mutations_len > 1 {
4638 if rng.gen_bool(0.2) {
4639 worktree
4640 .update(cx, |worktree, cx| {
4641 randomly_mutate_worktree(worktree, &mut rng, cx)
4642 })
4643 .await
4644 .unwrap();
4645 } else {
4646 randomly_mutate_fs(&fs, root_dir, 1.0, &mut rng).await;
4647 }
4648
4649 let buffered_event_count = fs.as_fake().buffered_event_count().await;
4650 if buffered_event_count > 0 && rng.gen_bool(0.3) {
4651 let len = rng.gen_range(0..=buffered_event_count);
4652 log::info!("flushing {} events", len);
4653 fs.as_fake().flush_events(len).await;
4654 } else {
4655 randomly_mutate_fs(&fs, root_dir, 0.6, &mut rng).await;
4656 mutations_len -= 1;
4657 }
4658
4659 cx.foreground().run_until_parked();
4660 if rng.gen_bool(0.2) {
4661 log::info!("storing snapshot {}", snapshots.len());
4662 let snapshot =
4663 worktree.read_with(cx, |tree, _| tree.as_local().unwrap().snapshot());
4664 snapshots.push(snapshot);
4665 }
4666 }
4667
4668 log::info!("quiescing");
4669 fs.as_fake().flush_events(usize::MAX).await;
4670 cx.foreground().run_until_parked();
4671 let snapshot = worktree.read_with(cx, |tree, _| tree.as_local().unwrap().snapshot());
4672 snapshot.check_invariants();
4673
4674 {
4675 let new_worktree = Worktree::local(
4676 client.clone(),
4677 root_dir,
4678 true,
4679 fs.clone(),
4680 Default::default(),
4681 &mut cx.to_async(),
4682 )
4683 .await
4684 .unwrap();
4685 new_worktree
4686 .update(cx, |tree, _| tree.as_local_mut().unwrap().scan_complete())
4687 .await;
4688 let new_snapshot =
4689 new_worktree.read_with(cx, |tree, _| tree.as_local().unwrap().snapshot());
4690 assert_eq!(snapshot.to_vec(true), new_snapshot.to_vec(true));
4691 }
4692
4693 for (i, mut prev_snapshot) in snapshots.into_iter().enumerate() {
4694 let include_ignored = rng.gen::<bool>();
4695 if !include_ignored {
4696 let mut entries_by_path_edits = Vec::new();
4697 let mut entries_by_id_edits = Vec::new();
4698 for entry in prev_snapshot
4699 .entries_by_id
4700 .cursor::<()>()
4701 .filter(|e| e.is_ignored)
4702 {
4703 entries_by_path_edits.push(Edit::Remove(PathKey(entry.path.clone())));
4704 entries_by_id_edits.push(Edit::Remove(entry.id));
4705 }
4706
4707 prev_snapshot
4708 .entries_by_path
4709 .edit(entries_by_path_edits, &());
4710 prev_snapshot.entries_by_id.edit(entries_by_id_edits, &());
4711 }
4712
4713 let update = snapshot.build_update(&prev_snapshot, 0, 0, include_ignored);
4714 prev_snapshot.apply_remote_update(update.clone()).unwrap();
4715 assert_eq!(
4716 prev_snapshot.to_vec(include_ignored),
4717 snapshot.to_vec(include_ignored),
4718 "wrong update for snapshot {i}. update: {:?}",
4719 update
4720 );
4721 }
4722 }
4723
4724 fn randomly_mutate_worktree(
4725 worktree: &mut Worktree,
4726 rng: &mut impl Rng,
4727 cx: &mut ModelContext<Worktree>,
4728 ) -> Task<Result<()>> {
4729 let worktree = worktree.as_local_mut().unwrap();
4730 let snapshot = worktree.snapshot();
4731 let entry = snapshot.entries(false).choose(rng).unwrap();
4732
4733 match rng.gen_range(0_u32..100) {
4734 0..=33 if entry.path.as_ref() != Path::new("") => {
4735 log::info!("deleting entry {:?} ({})", entry.path, entry.id.0);
4736 worktree.delete_entry(entry.id, cx).unwrap()
4737 }
4738 ..=66 if entry.path.as_ref() != Path::new("") => {
4739 let other_entry = snapshot.entries(false).choose(rng).unwrap();
4740 let new_parent_path = if other_entry.is_dir() {
4741 other_entry.path.clone()
4742 } else {
4743 other_entry.path.parent().unwrap().into()
4744 };
4745 let mut new_path = new_parent_path.join(gen_name(rng));
4746 if new_path.starts_with(&entry.path) {
4747 new_path = gen_name(rng).into();
4748 }
4749
4750 log::info!(
4751 "renaming entry {:?} ({}) to {:?}",
4752 entry.path,
4753 entry.id.0,
4754 new_path
4755 );
4756 let task = worktree.rename_entry(entry.id, new_path, cx).unwrap();
4757 cx.foreground().spawn(async move {
4758 task.await?;
4759 Ok(())
4760 })
4761 }
4762 _ => {
4763 let task = if entry.is_dir() {
4764 let child_path = entry.path.join(gen_name(rng));
4765 let is_dir = rng.gen_bool(0.3);
4766 log::info!(
4767 "creating {} at {:?}",
4768 if is_dir { "dir" } else { "file" },
4769 child_path,
4770 );
4771 worktree.create_entry(child_path, is_dir, cx)
4772 } else {
4773 log::info!("overwriting file {:?} ({})", entry.path, entry.id.0);
4774 worktree.write_file(entry.path.clone(), "".into(), Default::default(), cx)
4775 };
4776 cx.foreground().spawn(async move {
4777 task.await?;
4778 Ok(())
4779 })
4780 }
4781 }
4782 }
4783
4784 async fn randomly_mutate_fs(
4785 fs: &Arc<dyn Fs>,
4786 root_path: &Path,
4787 insertion_probability: f64,
4788 rng: &mut impl Rng,
4789 ) {
4790 let mut files = Vec::new();
4791 let mut dirs = Vec::new();
4792 for path in fs.as_fake().paths() {
4793 if path.starts_with(root_path) {
4794 if fs.is_file(&path).await {
4795 files.push(path);
4796 } else {
4797 dirs.push(path);
4798 }
4799 }
4800 }
4801
4802 if (files.is_empty() && dirs.len() == 1) || rng.gen_bool(insertion_probability) {
4803 let path = dirs.choose(rng).unwrap();
4804 let new_path = path.join(gen_name(rng));
4805
4806 if rng.gen() {
4807 log::info!(
4808 "creating dir {:?}",
4809 new_path.strip_prefix(root_path).unwrap()
4810 );
4811 fs.create_dir(&new_path).await.unwrap();
4812 } else {
4813 log::info!(
4814 "creating file {:?}",
4815 new_path.strip_prefix(root_path).unwrap()
4816 );
4817 fs.create_file(&new_path, Default::default()).await.unwrap();
4818 }
4819 } else if rng.gen_bool(0.05) {
4820 let ignore_dir_path = dirs.choose(rng).unwrap();
4821 let ignore_path = ignore_dir_path.join(&*GITIGNORE);
4822
4823 let subdirs = dirs
4824 .iter()
4825 .filter(|d| d.starts_with(&ignore_dir_path))
4826 .cloned()
4827 .collect::<Vec<_>>();
4828 let subfiles = files
4829 .iter()
4830 .filter(|d| d.starts_with(&ignore_dir_path))
4831 .cloned()
4832 .collect::<Vec<_>>();
4833 let files_to_ignore = {
4834 let len = rng.gen_range(0..=subfiles.len());
4835 subfiles.choose_multiple(rng, len)
4836 };
4837 let dirs_to_ignore = {
4838 let len = rng.gen_range(0..subdirs.len());
4839 subdirs.choose_multiple(rng, len)
4840 };
4841
4842 let mut ignore_contents = String::new();
4843 for path_to_ignore in files_to_ignore.chain(dirs_to_ignore) {
4844 writeln!(
4845 ignore_contents,
4846 "{}",
4847 path_to_ignore
4848 .strip_prefix(&ignore_dir_path)
4849 .unwrap()
4850 .to_str()
4851 .unwrap()
4852 )
4853 .unwrap();
4854 }
4855 log::info!(
4856 "creating gitignore {:?} with contents:\n{}",
4857 ignore_path.strip_prefix(&root_path).unwrap(),
4858 ignore_contents
4859 );
4860 fs.save(
4861 &ignore_path,
4862 &ignore_contents.as_str().into(),
4863 Default::default(),
4864 )
4865 .await
4866 .unwrap();
4867 } else {
4868 let old_path = {
4869 let file_path = files.choose(rng);
4870 let dir_path = dirs[1..].choose(rng);
4871 file_path.into_iter().chain(dir_path).choose(rng).unwrap()
4872 };
4873
4874 let is_rename = rng.gen();
4875 if is_rename {
4876 let new_path_parent = dirs
4877 .iter()
4878 .filter(|d| !d.starts_with(old_path))
4879 .choose(rng)
4880 .unwrap();
4881
4882 let overwrite_existing_dir =
4883 !old_path.starts_with(&new_path_parent) && rng.gen_bool(0.3);
4884 let new_path = if overwrite_existing_dir {
4885 fs.remove_dir(
4886 &new_path_parent,
4887 RemoveOptions {
4888 recursive: true,
4889 ignore_if_not_exists: true,
4890 },
4891 )
4892 .await
4893 .unwrap();
4894 new_path_parent.to_path_buf()
4895 } else {
4896 new_path_parent.join(gen_name(rng))
4897 };
4898
4899 log::info!(
4900 "renaming {:?} to {}{:?}",
4901 old_path.strip_prefix(&root_path).unwrap(),
4902 if overwrite_existing_dir {
4903 "overwrite "
4904 } else {
4905 ""
4906 },
4907 new_path.strip_prefix(&root_path).unwrap()
4908 );
4909 fs.rename(
4910 &old_path,
4911 &new_path,
4912 fs::RenameOptions {
4913 overwrite: true,
4914 ignore_if_exists: true,
4915 },
4916 )
4917 .await
4918 .unwrap();
4919 } else if fs.is_file(&old_path).await {
4920 log::info!(
4921 "deleting file {:?}",
4922 old_path.strip_prefix(&root_path).unwrap()
4923 );
4924 fs.remove_file(old_path, Default::default()).await.unwrap();
4925 } else {
4926 log::info!(
4927 "deleting dir {:?}",
4928 old_path.strip_prefix(&root_path).unwrap()
4929 );
4930 fs.remove_dir(
4931 &old_path,
4932 RemoveOptions {
4933 recursive: true,
4934 ignore_if_not_exists: true,
4935 },
4936 )
4937 .await
4938 .unwrap();
4939 }
4940 }
4941 }
4942
4943 fn gen_name(rng: &mut impl Rng) -> String {
4944 (0..6)
4945 .map(|_| rng.sample(rand::distributions::Alphanumeric))
4946 .map(char::from)
4947 .collect()
4948 }
4949
4950 impl LocalSnapshot {
4951 fn check_invariants(&self) {
4952 assert_eq!(
4953 self.entries_by_path
4954 .cursor::<()>()
4955 .map(|e| (&e.path, e.id))
4956 .collect::<Vec<_>>(),
4957 self.entries_by_id
4958 .cursor::<()>()
4959 .map(|e| (&e.path, e.id))
4960 .collect::<collections::BTreeSet<_>>()
4961 .into_iter()
4962 .collect::<Vec<_>>(),
4963 "entries_by_path and entries_by_id are inconsistent"
4964 );
4965
4966 let mut files = self.files(true, 0);
4967 let mut visible_files = self.files(false, 0);
4968 for entry in self.entries_by_path.cursor::<()>() {
4969 if entry.is_file() {
4970 assert_eq!(files.next().unwrap().inode, entry.inode);
4971 if !entry.is_ignored {
4972 assert_eq!(visible_files.next().unwrap().inode, entry.inode);
4973 }
4974 }
4975 }
4976
4977 assert!(files.next().is_none());
4978 assert!(visible_files.next().is_none());
4979
4980 let mut bfs_paths = Vec::new();
4981 let mut stack = vec![Path::new("")];
4982 while let Some(path) = stack.pop() {
4983 bfs_paths.push(path);
4984 let ix = stack.len();
4985 for child_entry in self.child_entries(path) {
4986 stack.insert(ix, &child_entry.path);
4987 }
4988 }
4989
4990 let dfs_paths_via_iter = self
4991 .entries_by_path
4992 .cursor::<()>()
4993 .map(|e| e.path.as_ref())
4994 .collect::<Vec<_>>();
4995 assert_eq!(bfs_paths, dfs_paths_via_iter);
4996
4997 let dfs_paths_via_traversal = self
4998 .entries(true)
4999 .map(|e| e.path.as_ref())
5000 .collect::<Vec<_>>();
5001 assert_eq!(dfs_paths_via_traversal, dfs_paths_via_iter);
5002
5003 for ignore_parent_abs_path in self.ignores_by_parent_abs_path.keys() {
5004 let ignore_parent_path =
5005 ignore_parent_abs_path.strip_prefix(&self.abs_path).unwrap();
5006 assert!(self.entry_for_path(&ignore_parent_path).is_some());
5007 assert!(self
5008 .entry_for_path(ignore_parent_path.join(&*GITIGNORE))
5009 .is_some());
5010 }
5011 }
5012
5013 fn to_vec(&self, include_ignored: bool) -> Vec<(&Path, u64, bool)> {
5014 let mut paths = Vec::new();
5015 for entry in self.entries_by_path.cursor::<()>() {
5016 if include_ignored || !entry.is_ignored {
5017 paths.push((entry.path.as_ref(), entry.inode, entry.is_ignored));
5018 }
5019 }
5020 paths.sort_by(|a, b| a.0.cmp(b.0));
5021 paths
5022 }
5023 }
5024}