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