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 /// Find the lowest path in the worktree's datastructures that is an ancestor
985 fn lowest_ancestor(&self, path: &Path) -> PathBuf {
986 let mut lowest_ancestor = None;
987 for path in path.ancestors() {
988 if self.entry_for_path(path).is_some() {
989 lowest_ancestor = Some(path.to_path_buf());
990 break;
991 }
992 }
993
994 lowest_ancestor.unwrap_or_else(|| PathBuf::from(""))
995 }
996
997 pub fn create_entry(
998 &self,
999 path: impl Into<Arc<Path>>,
1000 is_dir: bool,
1001 cx: &mut ModelContext<Worktree>,
1002 ) -> Task<Result<Entry>> {
1003 let path = path.into();
1004 let lowest_ancestor = self.lowest_ancestor(&path);
1005 let abs_path = self.absolutize(&path);
1006 let fs = self.fs.clone();
1007 let write = cx.background().spawn(async move {
1008 if is_dir {
1009 fs.create_dir(&abs_path).await
1010 } else {
1011 fs.save(&abs_path, &Default::default(), Default::default())
1012 .await
1013 }
1014 });
1015
1016 cx.spawn(|this, mut cx| async move {
1017 write.await?;
1018 let (result, refreshes) = this.update(&mut cx, |this, cx| {
1019 let mut refreshes = Vec::<Task<anyhow::Result<Entry>>>::new();
1020 let refresh_paths = path.strip_prefix(&lowest_ancestor).unwrap();
1021 for refresh_path in refresh_paths.ancestors() {
1022 if refresh_path == Path::new("") {
1023 continue;
1024 }
1025 let refresh_full_path = lowest_ancestor.join(refresh_path);
1026
1027 refreshes.push(this.as_local_mut().unwrap().refresh_entry(
1028 refresh_full_path.into(),
1029 None,
1030 cx,
1031 ));
1032 }
1033 (
1034 this.as_local_mut().unwrap().refresh_entry(path, None, cx),
1035 refreshes,
1036 )
1037 });
1038 for refresh in refreshes {
1039 refresh.await.log_err();
1040 }
1041
1042 result.await
1043 })
1044 }
1045
1046 pub fn write_file(
1047 &self,
1048 path: impl Into<Arc<Path>>,
1049 text: Rope,
1050 line_ending: LineEnding,
1051 cx: &mut ModelContext<Worktree>,
1052 ) -> Task<Result<Entry>> {
1053 let path = path.into();
1054 let abs_path = self.absolutize(&path);
1055 let fs = self.fs.clone();
1056 let write = cx
1057 .background()
1058 .spawn(async move { fs.save(&abs_path, &text, line_ending).await });
1059
1060 cx.spawn(|this, mut cx| async move {
1061 write.await?;
1062 this.update(&mut cx, |this, cx| {
1063 this.as_local_mut().unwrap().refresh_entry(path, None, cx)
1064 })
1065 .await
1066 })
1067 }
1068
1069 pub fn delete_entry(
1070 &self,
1071 entry_id: ProjectEntryId,
1072 cx: &mut ModelContext<Worktree>,
1073 ) -> Option<Task<Result<()>>> {
1074 let entry = self.entry_for_id(entry_id)?.clone();
1075 let abs_path = self.absolutize(&entry.path);
1076 let fs = self.fs.clone();
1077
1078 let delete = cx.background().spawn(async move {
1079 if entry.is_file() {
1080 fs.remove_file(&abs_path, Default::default()).await?;
1081 } else {
1082 fs.remove_dir(
1083 &abs_path,
1084 RemoveOptions {
1085 recursive: true,
1086 ignore_if_not_exists: false,
1087 },
1088 )
1089 .await?;
1090 }
1091 anyhow::Ok(entry.path)
1092 });
1093
1094 Some(cx.spawn(|this, mut cx| async move {
1095 let path = delete.await?;
1096 this.update(&mut cx, |this, _| {
1097 this.as_local_mut()
1098 .unwrap()
1099 .refresh_entries_for_paths(vec![path])
1100 })
1101 .recv()
1102 .await;
1103 Ok(())
1104 }))
1105 }
1106
1107 pub fn rename_entry(
1108 &self,
1109 entry_id: ProjectEntryId,
1110 new_path: impl Into<Arc<Path>>,
1111 cx: &mut ModelContext<Worktree>,
1112 ) -> Option<Task<Result<Entry>>> {
1113 let old_path = self.entry_for_id(entry_id)?.path.clone();
1114 let new_path = new_path.into();
1115 let abs_old_path = self.absolutize(&old_path);
1116 let abs_new_path = self.absolutize(&new_path);
1117 let fs = self.fs.clone();
1118 let rename = cx.background().spawn(async move {
1119 fs.rename(&abs_old_path, &abs_new_path, Default::default())
1120 .await
1121 });
1122
1123 Some(cx.spawn(|this, mut cx| async move {
1124 rename.await?;
1125 this.update(&mut cx, |this, cx| {
1126 this.as_local_mut()
1127 .unwrap()
1128 .refresh_entry(new_path.clone(), Some(old_path), cx)
1129 })
1130 .await
1131 }))
1132 }
1133
1134 pub fn copy_entry(
1135 &self,
1136 entry_id: ProjectEntryId,
1137 new_path: impl Into<Arc<Path>>,
1138 cx: &mut ModelContext<Worktree>,
1139 ) -> Option<Task<Result<Entry>>> {
1140 let old_path = self.entry_for_id(entry_id)?.path.clone();
1141 let new_path = new_path.into();
1142 let abs_old_path = self.absolutize(&old_path);
1143 let abs_new_path = self.absolutize(&new_path);
1144 let fs = self.fs.clone();
1145 let copy = cx.background().spawn(async move {
1146 copy_recursive(
1147 fs.as_ref(),
1148 &abs_old_path,
1149 &abs_new_path,
1150 Default::default(),
1151 )
1152 .await
1153 });
1154
1155 Some(cx.spawn(|this, mut cx| async move {
1156 copy.await?;
1157 this.update(&mut cx, |this, cx| {
1158 this.as_local_mut()
1159 .unwrap()
1160 .refresh_entry(new_path.clone(), None, cx)
1161 })
1162 .await
1163 }))
1164 }
1165
1166 pub fn expand_entry(
1167 &mut self,
1168 entry_id: ProjectEntryId,
1169 cx: &mut ModelContext<Worktree>,
1170 ) -> Option<Task<Result<()>>> {
1171 let path = self.entry_for_id(entry_id)?.path.clone();
1172 let mut refresh = self.refresh_entries_for_paths(vec![path]);
1173 Some(cx.background().spawn(async move {
1174 refresh.next().await;
1175 Ok(())
1176 }))
1177 }
1178
1179 pub fn refresh_entries_for_paths(&self, paths: Vec<Arc<Path>>) -> barrier::Receiver {
1180 let (tx, rx) = barrier::channel();
1181 self.scan_requests_tx
1182 .try_send(ScanRequest {
1183 relative_paths: paths,
1184 done: tx,
1185 })
1186 .ok();
1187 rx
1188 }
1189
1190 pub fn add_path_prefix_to_scan(&self, path_prefix: Arc<Path>) {
1191 self.path_prefixes_to_scan_tx.try_send(path_prefix).ok();
1192 }
1193
1194 fn refresh_entry(
1195 &self,
1196 path: Arc<Path>,
1197 old_path: Option<Arc<Path>>,
1198 cx: &mut ModelContext<Worktree>,
1199 ) -> Task<Result<Entry>> {
1200 let paths = if let Some(old_path) = old_path.as_ref() {
1201 vec![old_path.clone(), path.clone()]
1202 } else {
1203 vec![path.clone()]
1204 };
1205 let mut refresh = self.refresh_entries_for_paths(paths);
1206 cx.spawn_weak(move |this, mut cx| async move {
1207 refresh.recv().await;
1208 this.upgrade(&cx)
1209 .ok_or_else(|| anyhow!("worktree was dropped"))?
1210 .update(&mut cx, |this, _| {
1211 this.entry_for_path(path)
1212 .cloned()
1213 .ok_or_else(|| anyhow!("failed to read path after update"))
1214 })
1215 })
1216 }
1217
1218 pub fn observe_updates<F, Fut>(
1219 &mut self,
1220 project_id: u64,
1221 cx: &mut ModelContext<Worktree>,
1222 callback: F,
1223 ) -> oneshot::Receiver<()>
1224 where
1225 F: 'static + Send + Fn(proto::UpdateWorktree) -> Fut,
1226 Fut: Send + Future<Output = bool>,
1227 {
1228 #[cfg(any(test, feature = "test-support"))]
1229 const MAX_CHUNK_SIZE: usize = 2;
1230 #[cfg(not(any(test, feature = "test-support")))]
1231 const MAX_CHUNK_SIZE: usize = 256;
1232
1233 let (share_tx, share_rx) = oneshot::channel();
1234
1235 if let Some(share) = self.share.as_mut() {
1236 share_tx.send(()).ok();
1237 *share.resume_updates.borrow_mut() = ();
1238 return share_rx;
1239 }
1240
1241 let (resume_updates_tx, mut resume_updates_rx) = watch::channel::<()>();
1242 let (snapshots_tx, mut snapshots_rx) =
1243 mpsc::unbounded::<(LocalSnapshot, UpdatedEntriesSet, UpdatedGitRepositoriesSet)>();
1244 snapshots_tx
1245 .unbounded_send((self.snapshot(), Arc::from([]), Arc::from([])))
1246 .ok();
1247
1248 let worktree_id = cx.model_id() as u64;
1249 let _maintain_remote_snapshot = cx.background().spawn(async move {
1250 let mut is_first = true;
1251 while let Some((snapshot, entry_changes, repo_changes)) = snapshots_rx.next().await {
1252 let update;
1253 if is_first {
1254 update = snapshot.build_initial_update(project_id, worktree_id);
1255 is_first = false;
1256 } else {
1257 update =
1258 snapshot.build_update(project_id, worktree_id, entry_changes, repo_changes);
1259 }
1260
1261 for update in proto::split_worktree_update(update, MAX_CHUNK_SIZE) {
1262 let _ = resume_updates_rx.try_recv();
1263 loop {
1264 let result = callback(update.clone());
1265 if result.await {
1266 break;
1267 } else {
1268 log::info!("waiting to resume updates");
1269 if resume_updates_rx.next().await.is_none() {
1270 return Some(());
1271 }
1272 }
1273 }
1274 }
1275 }
1276 share_tx.send(()).ok();
1277 Some(())
1278 });
1279
1280 self.share = Some(ShareState {
1281 project_id,
1282 snapshots_tx,
1283 resume_updates: resume_updates_tx,
1284 _maintain_remote_snapshot,
1285 });
1286 share_rx
1287 }
1288
1289 pub fn share(&mut self, project_id: u64, cx: &mut ModelContext<Worktree>) -> Task<Result<()>> {
1290 let client = self.client.clone();
1291
1292 for (path, summaries) in &self.diagnostic_summaries {
1293 for (&server_id, summary) in summaries {
1294 if let Err(e) = self.client.send(proto::UpdateDiagnosticSummary {
1295 project_id,
1296 worktree_id: cx.model_id() as u64,
1297 summary: Some(summary.to_proto(server_id, &path)),
1298 }) {
1299 return Task::ready(Err(e));
1300 }
1301 }
1302 }
1303
1304 let rx = self.observe_updates(project_id, cx, move |update| {
1305 client.request(update).map(|result| result.is_ok())
1306 });
1307 cx.foreground()
1308 .spawn(async move { rx.await.map_err(|_| anyhow!("share ended")) })
1309 }
1310
1311 pub fn unshare(&mut self) {
1312 self.share.take();
1313 }
1314
1315 pub fn is_shared(&self) -> bool {
1316 self.share.is_some()
1317 }
1318}
1319
1320impl RemoteWorktree {
1321 fn snapshot(&self) -> Snapshot {
1322 self.snapshot.clone()
1323 }
1324
1325 pub fn disconnected_from_host(&mut self) {
1326 self.updates_tx.take();
1327 self.snapshot_subscriptions.clear();
1328 self.disconnected = true;
1329 }
1330
1331 pub fn save_buffer(
1332 &self,
1333 buffer_handle: ModelHandle<Buffer>,
1334 cx: &mut ModelContext<Worktree>,
1335 ) -> Task<Result<()>> {
1336 let buffer = buffer_handle.read(cx);
1337 let buffer_id = buffer.remote_id();
1338 let version = buffer.version();
1339 let rpc = self.client.clone();
1340 let project_id = self.project_id;
1341 cx.as_mut().spawn(|mut cx| async move {
1342 let response = rpc
1343 .request(proto::SaveBuffer {
1344 project_id,
1345 buffer_id,
1346 version: serialize_version(&version),
1347 })
1348 .await?;
1349 let version = deserialize_version(&response.version);
1350 let fingerprint = deserialize_fingerprint(&response.fingerprint)?;
1351 let mtime = response
1352 .mtime
1353 .ok_or_else(|| anyhow!("missing mtime"))?
1354 .into();
1355
1356 buffer_handle.update(&mut cx, |buffer, cx| {
1357 buffer.did_save(version.clone(), fingerprint, mtime, cx);
1358 });
1359
1360 Ok(())
1361 })
1362 }
1363
1364 pub fn update_from_remote(&mut self, update: proto::UpdateWorktree) {
1365 if let Some(updates_tx) = &self.updates_tx {
1366 updates_tx
1367 .unbounded_send(update)
1368 .expect("consumer runs to completion");
1369 }
1370 }
1371
1372 fn observed_snapshot(&self, scan_id: usize) -> bool {
1373 self.completed_scan_id >= scan_id
1374 }
1375
1376 pub(crate) fn wait_for_snapshot(&mut self, scan_id: usize) -> impl Future<Output = Result<()>> {
1377 let (tx, rx) = oneshot::channel();
1378 if self.observed_snapshot(scan_id) {
1379 let _ = tx.send(());
1380 } else if self.disconnected {
1381 drop(tx);
1382 } else {
1383 match self
1384 .snapshot_subscriptions
1385 .binary_search_by_key(&scan_id, |probe| probe.0)
1386 {
1387 Ok(ix) | Err(ix) => self.snapshot_subscriptions.insert(ix, (scan_id, tx)),
1388 }
1389 }
1390
1391 async move {
1392 rx.await?;
1393 Ok(())
1394 }
1395 }
1396
1397 pub fn update_diagnostic_summary(
1398 &mut self,
1399 path: Arc<Path>,
1400 summary: &proto::DiagnosticSummary,
1401 ) {
1402 let server_id = LanguageServerId(summary.language_server_id as usize);
1403 let summary = DiagnosticSummary {
1404 error_count: summary.error_count as usize,
1405 warning_count: summary.warning_count as usize,
1406 };
1407
1408 if summary.is_empty() {
1409 if let Some(summaries) = self.diagnostic_summaries.get_mut(&path) {
1410 summaries.remove(&server_id);
1411 if summaries.is_empty() {
1412 self.diagnostic_summaries.remove(&path);
1413 }
1414 }
1415 } else {
1416 self.diagnostic_summaries
1417 .entry(path)
1418 .or_default()
1419 .insert(server_id, summary);
1420 }
1421 }
1422
1423 pub fn insert_entry(
1424 &mut self,
1425 entry: proto::Entry,
1426 scan_id: usize,
1427 cx: &mut ModelContext<Worktree>,
1428 ) -> Task<Result<Entry>> {
1429 let wait_for_snapshot = self.wait_for_snapshot(scan_id);
1430 cx.spawn(|this, mut cx| async move {
1431 wait_for_snapshot.await?;
1432 this.update(&mut cx, |worktree, _| {
1433 let worktree = worktree.as_remote_mut().unwrap();
1434 let mut snapshot = worktree.background_snapshot.lock();
1435 let entry = snapshot.insert_entry(entry);
1436 worktree.snapshot = snapshot.clone();
1437 entry
1438 })
1439 })
1440 }
1441
1442 pub(crate) fn delete_entry(
1443 &mut self,
1444 id: ProjectEntryId,
1445 scan_id: usize,
1446 cx: &mut ModelContext<Worktree>,
1447 ) -> Task<Result<()>> {
1448 let wait_for_snapshot = self.wait_for_snapshot(scan_id);
1449 cx.spawn(|this, mut cx| async move {
1450 wait_for_snapshot.await?;
1451 this.update(&mut cx, |worktree, _| {
1452 let worktree = worktree.as_remote_mut().unwrap();
1453 let mut snapshot = worktree.background_snapshot.lock();
1454 snapshot.delete_entry(id);
1455 worktree.snapshot = snapshot.clone();
1456 });
1457 Ok(())
1458 })
1459 }
1460}
1461
1462impl Snapshot {
1463 pub fn id(&self) -> WorktreeId {
1464 self.id
1465 }
1466
1467 pub fn abs_path(&self) -> &Arc<Path> {
1468 &self.abs_path
1469 }
1470
1471 pub fn absolutize(&self, path: &Path) -> PathBuf {
1472 if path.file_name().is_some() {
1473 self.abs_path.join(path)
1474 } else {
1475 self.abs_path.to_path_buf()
1476 }
1477 }
1478
1479 pub fn contains_entry(&self, entry_id: ProjectEntryId) -> bool {
1480 self.entries_by_id.get(&entry_id, &()).is_some()
1481 }
1482
1483 pub(crate) fn insert_entry(&mut self, entry: proto::Entry) -> Result<Entry> {
1484 let entry = Entry::try_from((&self.root_char_bag, entry))?;
1485 let old_entry = self.entries_by_id.insert_or_replace(
1486 PathEntry {
1487 id: entry.id,
1488 path: entry.path.clone(),
1489 is_ignored: entry.is_ignored,
1490 scan_id: 0,
1491 },
1492 &(),
1493 );
1494 if let Some(old_entry) = old_entry {
1495 self.entries_by_path.remove(&PathKey(old_entry.path), &());
1496 }
1497 self.entries_by_path.insert_or_replace(entry.clone(), &());
1498 Ok(entry)
1499 }
1500
1501 fn delete_entry(&mut self, entry_id: ProjectEntryId) -> Option<Arc<Path>> {
1502 let removed_entry = self.entries_by_id.remove(&entry_id, &())?;
1503 self.entries_by_path = {
1504 let mut cursor = self.entries_by_path.cursor::<TraversalProgress>();
1505 let mut new_entries_by_path =
1506 cursor.slice(&TraversalTarget::Path(&removed_entry.path), Bias::Left, &());
1507 while let Some(entry) = cursor.item() {
1508 if entry.path.starts_with(&removed_entry.path) {
1509 self.entries_by_id.remove(&entry.id, &());
1510 cursor.next(&());
1511 } else {
1512 break;
1513 }
1514 }
1515 new_entries_by_path.append(cursor.suffix(&()), &());
1516 new_entries_by_path
1517 };
1518
1519 Some(removed_entry.path)
1520 }
1521
1522 #[cfg(any(test, feature = "test-support"))]
1523 pub fn status_for_file(&self, path: impl Into<PathBuf>) -> Option<GitFileStatus> {
1524 let path = path.into();
1525 self.entries_by_path
1526 .get(&PathKey(Arc::from(path)), &())
1527 .and_then(|entry| entry.git_status)
1528 }
1529
1530 pub(crate) fn apply_remote_update(&mut self, mut update: proto::UpdateWorktree) -> Result<()> {
1531 let mut entries_by_path_edits = Vec::new();
1532 let mut entries_by_id_edits = Vec::new();
1533
1534 for entry_id in update.removed_entries {
1535 let entry_id = ProjectEntryId::from_proto(entry_id);
1536 entries_by_id_edits.push(Edit::Remove(entry_id));
1537 if let Some(entry) = self.entry_for_id(entry_id) {
1538 entries_by_path_edits.push(Edit::Remove(PathKey(entry.path.clone())));
1539 }
1540 }
1541
1542 for entry in update.updated_entries {
1543 let entry = Entry::try_from((&self.root_char_bag, entry))?;
1544 if let Some(PathEntry { path, .. }) = self.entries_by_id.get(&entry.id, &()) {
1545 entries_by_path_edits.push(Edit::Remove(PathKey(path.clone())));
1546 }
1547 if let Some(old_entry) = self.entries_by_path.get(&PathKey(entry.path.clone()), &()) {
1548 if old_entry.id != entry.id {
1549 entries_by_id_edits.push(Edit::Remove(old_entry.id));
1550 }
1551 }
1552 entries_by_id_edits.push(Edit::Insert(PathEntry {
1553 id: entry.id,
1554 path: entry.path.clone(),
1555 is_ignored: entry.is_ignored,
1556 scan_id: 0,
1557 }));
1558 entries_by_path_edits.push(Edit::Insert(entry));
1559 }
1560
1561 self.entries_by_path.edit(entries_by_path_edits, &());
1562 self.entries_by_id.edit(entries_by_id_edits, &());
1563
1564 update.removed_repositories.sort_unstable();
1565 self.repository_entries.retain(|_, entry| {
1566 if let Ok(_) = update
1567 .removed_repositories
1568 .binary_search(&entry.work_directory.to_proto())
1569 {
1570 false
1571 } else {
1572 true
1573 }
1574 });
1575
1576 for repository in update.updated_repositories {
1577 let work_directory_entry: WorkDirectoryEntry =
1578 ProjectEntryId::from_proto(repository.work_directory_id).into();
1579
1580 if let Some(entry) = self.entry_for_id(*work_directory_entry) {
1581 let work_directory = RepositoryWorkDirectory(entry.path.clone());
1582 if self.repository_entries.get(&work_directory).is_some() {
1583 self.repository_entries.update(&work_directory, |repo| {
1584 repo.branch = repository.branch.map(Into::into);
1585 });
1586 } else {
1587 self.repository_entries.insert(
1588 work_directory,
1589 RepositoryEntry {
1590 work_directory: work_directory_entry,
1591 branch: repository.branch.map(Into::into),
1592 },
1593 )
1594 }
1595 } else {
1596 log::error!("no work directory entry for repository {:?}", repository)
1597 }
1598 }
1599
1600 self.scan_id = update.scan_id as usize;
1601 if update.is_last_update {
1602 self.completed_scan_id = update.scan_id as usize;
1603 }
1604
1605 Ok(())
1606 }
1607
1608 pub fn file_count(&self) -> usize {
1609 self.entries_by_path.summary().file_count
1610 }
1611
1612 pub fn visible_file_count(&self) -> usize {
1613 self.entries_by_path.summary().non_ignored_file_count
1614 }
1615
1616 fn traverse_from_offset(
1617 &self,
1618 include_dirs: bool,
1619 include_ignored: bool,
1620 start_offset: usize,
1621 ) -> Traversal {
1622 let mut cursor = self.entries_by_path.cursor();
1623 cursor.seek(
1624 &TraversalTarget::Count {
1625 count: start_offset,
1626 include_dirs,
1627 include_ignored,
1628 },
1629 Bias::Right,
1630 &(),
1631 );
1632 Traversal {
1633 cursor,
1634 include_dirs,
1635 include_ignored,
1636 }
1637 }
1638
1639 fn traverse_from_path(
1640 &self,
1641 include_dirs: bool,
1642 include_ignored: bool,
1643 path: &Path,
1644 ) -> Traversal {
1645 let mut cursor = self.entries_by_path.cursor();
1646 cursor.seek(&TraversalTarget::Path(path), Bias::Left, &());
1647 Traversal {
1648 cursor,
1649 include_dirs,
1650 include_ignored,
1651 }
1652 }
1653
1654 pub fn files(&self, include_ignored: bool, start: usize) -> Traversal {
1655 self.traverse_from_offset(false, include_ignored, start)
1656 }
1657
1658 pub fn entries(&self, include_ignored: bool) -> Traversal {
1659 self.traverse_from_offset(true, include_ignored, 0)
1660 }
1661
1662 pub fn repositories(&self) -> impl Iterator<Item = (&Arc<Path>, &RepositoryEntry)> {
1663 self.repository_entries
1664 .iter()
1665 .map(|(path, entry)| (&path.0, entry))
1666 }
1667
1668 /// Get the repository whose work directory contains the given path.
1669 pub fn repository_for_work_directory(&self, path: &Path) -> Option<RepositoryEntry> {
1670 self.repository_entries
1671 .get(&RepositoryWorkDirectory(path.into()))
1672 .cloned()
1673 }
1674
1675 /// Get the repository whose work directory contains the given path.
1676 pub fn repository_for_path(&self, path: &Path) -> Option<RepositoryEntry> {
1677 self.repository_and_work_directory_for_path(path)
1678 .map(|e| e.1)
1679 }
1680
1681 pub fn repository_and_work_directory_for_path(
1682 &self,
1683 path: &Path,
1684 ) -> Option<(RepositoryWorkDirectory, RepositoryEntry)> {
1685 self.repository_entries
1686 .iter()
1687 .filter(|(workdir_path, _)| path.starts_with(workdir_path))
1688 .last()
1689 .map(|(path, repo)| (path.clone(), repo.clone()))
1690 }
1691
1692 /// Given an ordered iterator of entries, returns an iterator of those entries,
1693 /// along with their containing git repository.
1694 pub fn entries_with_repositories<'a>(
1695 &'a self,
1696 entries: impl 'a + Iterator<Item = &'a Entry>,
1697 ) -> impl 'a + Iterator<Item = (&'a Entry, Option<&'a RepositoryEntry>)> {
1698 let mut containing_repos = Vec::<(&Arc<Path>, &RepositoryEntry)>::new();
1699 let mut repositories = self.repositories().peekable();
1700 entries.map(move |entry| {
1701 while let Some((repo_path, _)) = containing_repos.last() {
1702 if !entry.path.starts_with(repo_path) {
1703 containing_repos.pop();
1704 } else {
1705 break;
1706 }
1707 }
1708 while let Some((repo_path, _)) = repositories.peek() {
1709 if entry.path.starts_with(repo_path) {
1710 containing_repos.push(repositories.next().unwrap());
1711 } else {
1712 break;
1713 }
1714 }
1715 let repo = containing_repos.last().map(|(_, repo)| *repo);
1716 (entry, repo)
1717 })
1718 }
1719
1720 /// Update the `git_status` of the given entries such that files'
1721 /// statuses bubble up to their ancestor directories.
1722 pub fn propagate_git_statuses(&self, result: &mut [Entry]) {
1723 let mut cursor = self
1724 .entries_by_path
1725 .cursor::<(TraversalProgress, GitStatuses)>();
1726 let mut entry_stack = Vec::<(usize, GitStatuses)>::new();
1727
1728 let mut result_ix = 0;
1729 loop {
1730 let next_entry = result.get(result_ix);
1731 let containing_entry = entry_stack.last().map(|(ix, _)| &result[*ix]);
1732
1733 let entry_to_finish = match (containing_entry, next_entry) {
1734 (Some(_), None) => entry_stack.pop(),
1735 (Some(containing_entry), Some(next_path)) => {
1736 if !next_path.path.starts_with(&containing_entry.path) {
1737 entry_stack.pop()
1738 } else {
1739 None
1740 }
1741 }
1742 (None, Some(_)) => None,
1743 (None, None) => break,
1744 };
1745
1746 if let Some((entry_ix, prev_statuses)) = entry_to_finish {
1747 cursor.seek_forward(
1748 &TraversalTarget::PathSuccessor(&result[entry_ix].path),
1749 Bias::Left,
1750 &(),
1751 );
1752
1753 let statuses = cursor.start().1 - prev_statuses;
1754
1755 result[entry_ix].git_status = if statuses.conflict > 0 {
1756 Some(GitFileStatus::Conflict)
1757 } else if statuses.modified > 0 {
1758 Some(GitFileStatus::Modified)
1759 } else if statuses.added > 0 {
1760 Some(GitFileStatus::Added)
1761 } else {
1762 None
1763 };
1764 } else {
1765 if result[result_ix].is_dir() {
1766 cursor.seek_forward(
1767 &TraversalTarget::Path(&result[result_ix].path),
1768 Bias::Left,
1769 &(),
1770 );
1771 entry_stack.push((result_ix, cursor.start().1));
1772 }
1773 result_ix += 1;
1774 }
1775 }
1776 }
1777
1778 pub fn paths(&self) -> impl Iterator<Item = &Arc<Path>> {
1779 let empty_path = Path::new("");
1780 self.entries_by_path
1781 .cursor::<()>()
1782 .filter(move |entry| entry.path.as_ref() != empty_path)
1783 .map(|entry| &entry.path)
1784 }
1785
1786 fn child_entries<'a>(&'a self, parent_path: &'a Path) -> ChildEntriesIter<'a> {
1787 let mut cursor = self.entries_by_path.cursor();
1788 cursor.seek(&TraversalTarget::Path(parent_path), Bias::Right, &());
1789 let traversal = Traversal {
1790 cursor,
1791 include_dirs: true,
1792 include_ignored: true,
1793 };
1794 ChildEntriesIter {
1795 traversal,
1796 parent_path,
1797 }
1798 }
1799
1800 pub fn descendent_entries<'a>(
1801 &'a self,
1802 include_dirs: bool,
1803 include_ignored: bool,
1804 parent_path: &'a Path,
1805 ) -> DescendentEntriesIter<'a> {
1806 let mut cursor = self.entries_by_path.cursor();
1807 cursor.seek(&TraversalTarget::Path(parent_path), Bias::Left, &());
1808 let mut traversal = Traversal {
1809 cursor,
1810 include_dirs,
1811 include_ignored,
1812 };
1813
1814 if traversal.end_offset() == traversal.start_offset() {
1815 traversal.advance();
1816 }
1817
1818 DescendentEntriesIter {
1819 traversal,
1820 parent_path,
1821 }
1822 }
1823
1824 pub fn root_entry(&self) -> Option<&Entry> {
1825 self.entry_for_path("")
1826 }
1827
1828 pub fn root_name(&self) -> &str {
1829 &self.root_name
1830 }
1831
1832 pub fn root_git_entry(&self) -> Option<RepositoryEntry> {
1833 self.repository_entries
1834 .get(&RepositoryWorkDirectory(Path::new("").into()))
1835 .map(|entry| entry.to_owned())
1836 }
1837
1838 pub fn git_entries(&self) -> impl Iterator<Item = &RepositoryEntry> {
1839 self.repository_entries.values()
1840 }
1841
1842 pub fn scan_id(&self) -> usize {
1843 self.scan_id
1844 }
1845
1846 pub fn entry_for_path(&self, path: impl AsRef<Path>) -> Option<&Entry> {
1847 let path = path.as_ref();
1848 self.traverse_from_path(true, true, path)
1849 .entry()
1850 .and_then(|entry| {
1851 if entry.path.as_ref() == path {
1852 Some(entry)
1853 } else {
1854 None
1855 }
1856 })
1857 }
1858
1859 pub fn entry_for_id(&self, id: ProjectEntryId) -> Option<&Entry> {
1860 let entry = self.entries_by_id.get(&id, &())?;
1861 self.entry_for_path(&entry.path)
1862 }
1863
1864 pub fn inode_for_path(&self, path: impl AsRef<Path>) -> Option<u64> {
1865 self.entry_for_path(path.as_ref()).map(|e| e.inode)
1866 }
1867}
1868
1869impl LocalSnapshot {
1870 pub(crate) fn get_local_repo(&self, repo: &RepositoryEntry) -> Option<&LocalRepositoryEntry> {
1871 self.git_repositories.get(&repo.work_directory.0)
1872 }
1873
1874 pub(crate) fn local_repo_for_path(
1875 &self,
1876 path: &Path,
1877 ) -> Option<(RepositoryWorkDirectory, &LocalRepositoryEntry)> {
1878 let (path, repo) = self.repository_and_work_directory_for_path(path)?;
1879 Some((path, self.git_repositories.get(&repo.work_directory_id())?))
1880 }
1881
1882 fn build_update(
1883 &self,
1884 project_id: u64,
1885 worktree_id: u64,
1886 entry_changes: UpdatedEntriesSet,
1887 repo_changes: UpdatedGitRepositoriesSet,
1888 ) -> proto::UpdateWorktree {
1889 let mut updated_entries = Vec::new();
1890 let mut removed_entries = Vec::new();
1891 let mut updated_repositories = Vec::new();
1892 let mut removed_repositories = Vec::new();
1893
1894 for (_, entry_id, path_change) in entry_changes.iter() {
1895 if let PathChange::Removed = path_change {
1896 removed_entries.push(entry_id.0 as u64);
1897 } else if let Some(entry) = self.entry_for_id(*entry_id) {
1898 updated_entries.push(proto::Entry::from(entry));
1899 }
1900 }
1901
1902 for (work_dir_path, change) in repo_changes.iter() {
1903 let new_repo = self
1904 .repository_entries
1905 .get(&RepositoryWorkDirectory(work_dir_path.clone()));
1906 match (&change.old_repository, new_repo) {
1907 (Some(old_repo), Some(new_repo)) => {
1908 updated_repositories.push(new_repo.build_update(old_repo));
1909 }
1910 (None, Some(new_repo)) => {
1911 updated_repositories.push(proto::RepositoryEntry::from(new_repo));
1912 }
1913 (Some(old_repo), None) => {
1914 removed_repositories.push(old_repo.work_directory.0.to_proto());
1915 }
1916 _ => {}
1917 }
1918 }
1919
1920 removed_entries.sort_unstable();
1921 updated_entries.sort_unstable_by_key(|e| e.id);
1922 removed_repositories.sort_unstable();
1923 updated_repositories.sort_unstable_by_key(|e| e.work_directory_id);
1924
1925 // TODO - optimize, knowing that removed_entries are sorted.
1926 removed_entries.retain(|id| updated_entries.binary_search_by_key(id, |e| e.id).is_err());
1927
1928 proto::UpdateWorktree {
1929 project_id,
1930 worktree_id,
1931 abs_path: self.abs_path().to_string_lossy().into(),
1932 root_name: self.root_name().to_string(),
1933 updated_entries,
1934 removed_entries,
1935 scan_id: self.scan_id as u64,
1936 is_last_update: self.completed_scan_id == self.scan_id,
1937 updated_repositories,
1938 removed_repositories,
1939 }
1940 }
1941
1942 fn build_initial_update(&self, project_id: u64, worktree_id: u64) -> proto::UpdateWorktree {
1943 let mut updated_entries = self
1944 .entries_by_path
1945 .iter()
1946 .map(proto::Entry::from)
1947 .collect::<Vec<_>>();
1948 updated_entries.sort_unstable_by_key(|e| e.id);
1949
1950 let mut updated_repositories = self
1951 .repository_entries
1952 .values()
1953 .map(proto::RepositoryEntry::from)
1954 .collect::<Vec<_>>();
1955 updated_repositories.sort_unstable_by_key(|e| e.work_directory_id);
1956
1957 proto::UpdateWorktree {
1958 project_id,
1959 worktree_id,
1960 abs_path: self.abs_path().to_string_lossy().into(),
1961 root_name: self.root_name().to_string(),
1962 updated_entries,
1963 removed_entries: Vec::new(),
1964 scan_id: self.scan_id as u64,
1965 is_last_update: self.completed_scan_id == self.scan_id,
1966 updated_repositories,
1967 removed_repositories: Vec::new(),
1968 }
1969 }
1970
1971 fn insert_entry(&mut self, mut entry: Entry, fs: &dyn Fs) -> Entry {
1972 if entry.is_file() && entry.path.file_name() == Some(&GITIGNORE) {
1973 let abs_path = self.abs_path.join(&entry.path);
1974 match smol::block_on(build_gitignore(&abs_path, fs)) {
1975 Ok(ignore) => {
1976 self.ignores_by_parent_abs_path
1977 .insert(abs_path.parent().unwrap().into(), (Arc::new(ignore), true));
1978 }
1979 Err(error) => {
1980 log::error!(
1981 "error loading .gitignore file {:?} - {:?}",
1982 &entry.path,
1983 error
1984 );
1985 }
1986 }
1987 }
1988
1989 if entry.kind == EntryKind::PendingDir {
1990 if let Some(existing_entry) =
1991 self.entries_by_path.get(&PathKey(entry.path.clone()), &())
1992 {
1993 entry.kind = existing_entry.kind;
1994 }
1995 }
1996
1997 let scan_id = self.scan_id;
1998 let removed = self.entries_by_path.insert_or_replace(entry.clone(), &());
1999 if let Some(removed) = removed {
2000 if removed.id != entry.id {
2001 self.entries_by_id.remove(&removed.id, &());
2002 }
2003 }
2004 self.entries_by_id.insert_or_replace(
2005 PathEntry {
2006 id: entry.id,
2007 path: entry.path.clone(),
2008 is_ignored: entry.is_ignored,
2009 scan_id,
2010 },
2011 &(),
2012 );
2013
2014 entry
2015 }
2016
2017 #[must_use = "Changed paths must be used for diffing later"]
2018 fn scan_statuses(
2019 &mut self,
2020 repo_ptr: &dyn GitRepository,
2021 work_directory: &RepositoryWorkDirectory,
2022 ) -> Vec<Arc<Path>> {
2023 let mut changes = vec![];
2024 let mut edits = vec![];
2025 for mut entry in self
2026 .descendent_entries(false, false, &work_directory.0)
2027 .cloned()
2028 {
2029 let Ok(repo_path) = entry.path.strip_prefix(&work_directory.0) else {
2030 continue;
2031 };
2032 let git_file_status = repo_ptr
2033 .status(&RepoPath(repo_path.into()))
2034 .log_err()
2035 .flatten();
2036 if entry.git_status != git_file_status {
2037 entry.git_status = git_file_status;
2038 changes.push(entry.path.clone());
2039 edits.push(Edit::Insert(entry));
2040 }
2041 }
2042
2043 self.entries_by_path.edit(edits, &());
2044 changes
2045 }
2046
2047 fn ancestor_inodes_for_path(&self, path: &Path) -> TreeSet<u64> {
2048 let mut inodes = TreeSet::default();
2049 for ancestor in path.ancestors().skip(1) {
2050 if let Some(entry) = self.entry_for_path(ancestor) {
2051 inodes.insert(entry.inode);
2052 }
2053 }
2054 inodes
2055 }
2056
2057 fn ignore_stack_for_abs_path(&self, abs_path: &Path, is_dir: bool) -> Arc<IgnoreStack> {
2058 let mut new_ignores = Vec::new();
2059 for ancestor in abs_path.ancestors().skip(1) {
2060 if let Some((ignore, _)) = self.ignores_by_parent_abs_path.get(ancestor) {
2061 new_ignores.push((ancestor, Some(ignore.clone())));
2062 } else {
2063 new_ignores.push((ancestor, None));
2064 }
2065 }
2066
2067 let mut ignore_stack = IgnoreStack::none();
2068 for (parent_abs_path, ignore) in new_ignores.into_iter().rev() {
2069 if ignore_stack.is_abs_path_ignored(parent_abs_path, true) {
2070 ignore_stack = IgnoreStack::all();
2071 break;
2072 } else if let Some(ignore) = ignore {
2073 ignore_stack = ignore_stack.append(parent_abs_path.into(), ignore);
2074 }
2075 }
2076
2077 if ignore_stack.is_abs_path_ignored(abs_path, is_dir) {
2078 ignore_stack = IgnoreStack::all();
2079 }
2080
2081 ignore_stack
2082 }
2083
2084 #[cfg(test)]
2085 pub(crate) fn expanded_entries(&self) -> impl Iterator<Item = &Entry> {
2086 self.entries_by_path
2087 .cursor::<()>()
2088 .filter(|entry| entry.kind == EntryKind::Dir && (entry.is_external || entry.is_ignored))
2089 }
2090
2091 #[cfg(test)]
2092 pub fn check_invariants(&self, git_state: bool) {
2093 use pretty_assertions::assert_eq;
2094
2095 assert_eq!(
2096 self.entries_by_path
2097 .cursor::<()>()
2098 .map(|e| (&e.path, e.id))
2099 .collect::<Vec<_>>(),
2100 self.entries_by_id
2101 .cursor::<()>()
2102 .map(|e| (&e.path, e.id))
2103 .collect::<collections::BTreeSet<_>>()
2104 .into_iter()
2105 .collect::<Vec<_>>(),
2106 "entries_by_path and entries_by_id are inconsistent"
2107 );
2108
2109 let mut files = self.files(true, 0);
2110 let mut visible_files = self.files(false, 0);
2111 for entry in self.entries_by_path.cursor::<()>() {
2112 if entry.is_file() {
2113 assert_eq!(files.next().unwrap().inode, entry.inode);
2114 if !entry.is_ignored && !entry.is_external {
2115 assert_eq!(visible_files.next().unwrap().inode, entry.inode);
2116 }
2117 }
2118 }
2119
2120 assert!(files.next().is_none());
2121 assert!(visible_files.next().is_none());
2122
2123 let mut bfs_paths = Vec::new();
2124 let mut stack = self
2125 .root_entry()
2126 .map(|e| e.path.as_ref())
2127 .into_iter()
2128 .collect::<Vec<_>>();
2129 while let Some(path) = stack.pop() {
2130 bfs_paths.push(path);
2131 let ix = stack.len();
2132 for child_entry in self.child_entries(path) {
2133 stack.insert(ix, &child_entry.path);
2134 }
2135 }
2136
2137 let dfs_paths_via_iter = self
2138 .entries_by_path
2139 .cursor::<()>()
2140 .map(|e| e.path.as_ref())
2141 .collect::<Vec<_>>();
2142 assert_eq!(bfs_paths, dfs_paths_via_iter);
2143
2144 let dfs_paths_via_traversal = self
2145 .entries(true)
2146 .map(|e| e.path.as_ref())
2147 .collect::<Vec<_>>();
2148 assert_eq!(dfs_paths_via_traversal, dfs_paths_via_iter);
2149
2150 if git_state {
2151 for ignore_parent_abs_path in self.ignores_by_parent_abs_path.keys() {
2152 let ignore_parent_path =
2153 ignore_parent_abs_path.strip_prefix(&self.abs_path).unwrap();
2154 assert!(self.entry_for_path(&ignore_parent_path).is_some());
2155 assert!(self
2156 .entry_for_path(ignore_parent_path.join(&*GITIGNORE))
2157 .is_some());
2158 }
2159 }
2160 }
2161
2162 #[cfg(test)]
2163 pub fn entries_without_ids(&self, include_ignored: bool) -> Vec<(&Path, u64, bool)> {
2164 let mut paths = Vec::new();
2165 for entry in self.entries_by_path.cursor::<()>() {
2166 if include_ignored || !entry.is_ignored {
2167 paths.push((entry.path.as_ref(), entry.inode, entry.is_ignored));
2168 }
2169 }
2170 paths.sort_by(|a, b| a.0.cmp(b.0));
2171 paths
2172 }
2173}
2174
2175impl BackgroundScannerState {
2176 fn should_scan_directory(&self, entry: &Entry) -> bool {
2177 (!entry.is_external && !entry.is_ignored)
2178 || entry.path.file_name() == Some(&*DOT_GIT)
2179 || self.scanned_dirs.contains(&entry.id) // If we've ever scanned it, keep scanning
2180 || self
2181 .paths_to_scan
2182 .iter()
2183 .any(|p| p.starts_with(&entry.path))
2184 || self
2185 .path_prefixes_to_scan
2186 .iter()
2187 .any(|p| entry.path.starts_with(p))
2188 }
2189
2190 fn reuse_entry_id(&mut self, entry: &mut Entry) {
2191 if let Some(removed_entry_id) = self.removed_entry_ids.remove(&entry.inode) {
2192 entry.id = removed_entry_id;
2193 } else if let Some(existing_entry) = self.snapshot.entry_for_path(&entry.path) {
2194 entry.id = existing_entry.id;
2195 }
2196 }
2197
2198 fn insert_entry(&mut self, mut entry: Entry, fs: &dyn Fs) -> Entry {
2199 self.reuse_entry_id(&mut entry);
2200 let entry = self.snapshot.insert_entry(entry, fs);
2201 if entry.path.file_name() == Some(&DOT_GIT) {
2202 self.build_repository(entry.path.clone(), fs);
2203 }
2204
2205 #[cfg(test)]
2206 self.snapshot.check_invariants(false);
2207
2208 entry
2209 }
2210
2211 fn populate_dir(
2212 &mut self,
2213 parent_path: &Arc<Path>,
2214 entries: impl IntoIterator<Item = Entry>,
2215 ignore: Option<Arc<Gitignore>>,
2216 fs: &dyn Fs,
2217 ) {
2218 let mut parent_entry = if let Some(parent_entry) = self
2219 .snapshot
2220 .entries_by_path
2221 .get(&PathKey(parent_path.clone()), &())
2222 {
2223 parent_entry.clone()
2224 } else {
2225 log::warn!(
2226 "populating a directory {:?} that has been removed",
2227 parent_path
2228 );
2229 return;
2230 };
2231
2232 match parent_entry.kind {
2233 EntryKind::PendingDir | EntryKind::UnloadedDir => parent_entry.kind = EntryKind::Dir,
2234 EntryKind::Dir => {}
2235 _ => return,
2236 }
2237
2238 if let Some(ignore) = ignore {
2239 let abs_parent_path = self.snapshot.abs_path.join(&parent_path).into();
2240 self.snapshot
2241 .ignores_by_parent_abs_path
2242 .insert(abs_parent_path, (ignore, false));
2243 }
2244
2245 self.scanned_dirs.insert(parent_entry.id);
2246 let mut entries_by_path_edits = vec![Edit::Insert(parent_entry)];
2247 let mut entries_by_id_edits = Vec::new();
2248 let mut dotgit_path = None;
2249
2250 for entry in entries {
2251 if entry.path.file_name() == Some(&DOT_GIT) {
2252 dotgit_path = Some(entry.path.clone());
2253 }
2254
2255 entries_by_id_edits.push(Edit::Insert(PathEntry {
2256 id: entry.id,
2257 path: entry.path.clone(),
2258 is_ignored: entry.is_ignored,
2259 scan_id: self.snapshot.scan_id,
2260 }));
2261 entries_by_path_edits.push(Edit::Insert(entry));
2262 }
2263
2264 self.snapshot
2265 .entries_by_path
2266 .edit(entries_by_path_edits, &());
2267 self.snapshot.entries_by_id.edit(entries_by_id_edits, &());
2268
2269 if let Some(dotgit_path) = dotgit_path {
2270 self.build_repository(dotgit_path, fs);
2271 }
2272 if let Err(ix) = self.changed_paths.binary_search(parent_path) {
2273 self.changed_paths.insert(ix, parent_path.clone());
2274 }
2275
2276 #[cfg(test)]
2277 self.snapshot.check_invariants(false);
2278 }
2279
2280 fn remove_path(&mut self, path: &Path) {
2281 let mut new_entries;
2282 let removed_entries;
2283 {
2284 let mut cursor = self.snapshot.entries_by_path.cursor::<TraversalProgress>();
2285 new_entries = cursor.slice(&TraversalTarget::Path(path), Bias::Left, &());
2286 removed_entries = cursor.slice(&TraversalTarget::PathSuccessor(path), Bias::Left, &());
2287 new_entries.append(cursor.suffix(&()), &());
2288 }
2289 self.snapshot.entries_by_path = new_entries;
2290
2291 let mut entries_by_id_edits = Vec::new();
2292 for entry in removed_entries.cursor::<()>() {
2293 let removed_entry_id = self
2294 .removed_entry_ids
2295 .entry(entry.inode)
2296 .or_insert(entry.id);
2297 *removed_entry_id = cmp::max(*removed_entry_id, entry.id);
2298 entries_by_id_edits.push(Edit::Remove(entry.id));
2299 }
2300 self.snapshot.entries_by_id.edit(entries_by_id_edits, &());
2301
2302 if path.file_name() == Some(&GITIGNORE) {
2303 let abs_parent_path = self.snapshot.abs_path.join(path.parent().unwrap());
2304 if let Some((_, needs_update)) = self
2305 .snapshot
2306 .ignores_by_parent_abs_path
2307 .get_mut(abs_parent_path.as_path())
2308 {
2309 *needs_update = true;
2310 }
2311 }
2312
2313 #[cfg(test)]
2314 self.snapshot.check_invariants(false);
2315 }
2316
2317 fn reload_repositories(&mut self, changed_paths: &[Arc<Path>], fs: &dyn Fs) {
2318 let scan_id = self.snapshot.scan_id;
2319
2320 // Find each of the .git directories that contain any of the given paths.
2321 let mut prev_dot_git_dir = None;
2322 for changed_path in changed_paths {
2323 let Some(dot_git_dir) = changed_path
2324 .ancestors()
2325 .find(|ancestor| ancestor.file_name() == Some(&*DOT_GIT)) else {
2326 continue;
2327 };
2328
2329 // Avoid processing the same repository multiple times, if multiple paths
2330 // within it have changed.
2331 if prev_dot_git_dir == Some(dot_git_dir) {
2332 continue;
2333 }
2334 prev_dot_git_dir = Some(dot_git_dir);
2335
2336 // If there is already a repository for this .git directory, reload
2337 // the status for all of its files.
2338 let repository = self
2339 .snapshot
2340 .git_repositories
2341 .iter()
2342 .find_map(|(entry_id, repo)| {
2343 (repo.git_dir_path.as_ref() == dot_git_dir).then(|| (*entry_id, repo.clone()))
2344 });
2345 match repository {
2346 None => {
2347 self.build_repository(dot_git_dir.into(), fs);
2348 }
2349 Some((entry_id, repository)) => {
2350 if repository.git_dir_scan_id == scan_id {
2351 continue;
2352 }
2353 let Some(work_dir) = self
2354 .snapshot
2355 .entry_for_id(entry_id)
2356 .map(|entry| RepositoryWorkDirectory(entry.path.clone())) else { continue };
2357
2358 log::info!("reload git repository {:?}", dot_git_dir);
2359 let repository = repository.repo_ptr.lock();
2360 let branch = repository.branch_name();
2361 repository.reload_index();
2362
2363 self.snapshot
2364 .git_repositories
2365 .update(&entry_id, |entry| entry.git_dir_scan_id = scan_id);
2366 self.snapshot
2367 .snapshot
2368 .repository_entries
2369 .update(&work_dir, |entry| entry.branch = branch.map(Into::into));
2370
2371 let changed_paths = self.snapshot.scan_statuses(&*repository, &work_dir);
2372 util::extend_sorted(
2373 &mut self.changed_paths,
2374 changed_paths,
2375 usize::MAX,
2376 Ord::cmp,
2377 )
2378 }
2379 }
2380 }
2381
2382 // Remove any git repositories whose .git entry no longer exists.
2383 let mut snapshot = &mut self.snapshot;
2384 let mut repositories = mem::take(&mut snapshot.git_repositories);
2385 let mut repository_entries = mem::take(&mut snapshot.repository_entries);
2386 repositories.retain(|work_directory_id, _| {
2387 snapshot
2388 .entry_for_id(*work_directory_id)
2389 .map_or(false, |entry| {
2390 snapshot.entry_for_path(entry.path.join(*DOT_GIT)).is_some()
2391 })
2392 });
2393 repository_entries.retain(|_, entry| repositories.get(&entry.work_directory.0).is_some());
2394 snapshot.git_repositories = repositories;
2395 snapshot.repository_entries = repository_entries;
2396 }
2397
2398 fn build_repository(&mut self, dot_git_path: Arc<Path>, fs: &dyn Fs) -> Option<()> {
2399 log::info!("build git repository {:?}", dot_git_path);
2400
2401 let work_dir_path: Arc<Path> = dot_git_path.parent().unwrap().into();
2402
2403 // Guard against repositories inside the repository metadata
2404 if work_dir_path.iter().any(|component| component == *DOT_GIT) {
2405 return None;
2406 };
2407
2408 let work_dir_id = self
2409 .snapshot
2410 .entry_for_path(work_dir_path.clone())
2411 .map(|entry| entry.id)?;
2412
2413 if self.snapshot.git_repositories.get(&work_dir_id).is_some() {
2414 return None;
2415 }
2416
2417 let abs_path = self.snapshot.abs_path.join(&dot_git_path);
2418 let repository = fs.open_repo(abs_path.as_path())?;
2419 let work_directory = RepositoryWorkDirectory(work_dir_path.clone());
2420
2421 let repo_lock = repository.lock();
2422 self.snapshot.repository_entries.insert(
2423 work_directory.clone(),
2424 RepositoryEntry {
2425 work_directory: work_dir_id.into(),
2426 branch: repo_lock.branch_name().map(Into::into),
2427 },
2428 );
2429
2430 let changed_paths = self
2431 .snapshot
2432 .scan_statuses(repo_lock.deref(), &work_directory);
2433 drop(repo_lock);
2434
2435 self.snapshot.git_repositories.insert(
2436 work_dir_id,
2437 LocalRepositoryEntry {
2438 git_dir_scan_id: 0,
2439 repo_ptr: repository,
2440 git_dir_path: dot_git_path.clone(),
2441 },
2442 );
2443
2444 util::extend_sorted(&mut self.changed_paths, changed_paths, usize::MAX, Ord::cmp);
2445 Some(())
2446 }
2447}
2448
2449async fn build_gitignore(abs_path: &Path, fs: &dyn Fs) -> Result<Gitignore> {
2450 let contents = fs.load(abs_path).await?;
2451 let parent = abs_path.parent().unwrap_or_else(|| Path::new("/"));
2452 let mut builder = GitignoreBuilder::new(parent);
2453 for line in contents.lines() {
2454 builder.add_line(Some(abs_path.into()), line)?;
2455 }
2456 Ok(builder.build()?)
2457}
2458
2459impl WorktreeId {
2460 pub fn from_usize(handle_id: usize) -> Self {
2461 Self(handle_id)
2462 }
2463
2464 pub(crate) fn from_proto(id: u64) -> Self {
2465 Self(id as usize)
2466 }
2467
2468 pub fn to_proto(&self) -> u64 {
2469 self.0 as u64
2470 }
2471
2472 pub fn to_usize(&self) -> usize {
2473 self.0
2474 }
2475}
2476
2477impl fmt::Display for WorktreeId {
2478 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2479 self.0.fmt(f)
2480 }
2481}
2482
2483impl Deref for Worktree {
2484 type Target = Snapshot;
2485
2486 fn deref(&self) -> &Self::Target {
2487 match self {
2488 Worktree::Local(worktree) => &worktree.snapshot,
2489 Worktree::Remote(worktree) => &worktree.snapshot,
2490 }
2491 }
2492}
2493
2494impl Deref for LocalWorktree {
2495 type Target = LocalSnapshot;
2496
2497 fn deref(&self) -> &Self::Target {
2498 &self.snapshot
2499 }
2500}
2501
2502impl Deref for RemoteWorktree {
2503 type Target = Snapshot;
2504
2505 fn deref(&self) -> &Self::Target {
2506 &self.snapshot
2507 }
2508}
2509
2510impl fmt::Debug for LocalWorktree {
2511 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2512 self.snapshot.fmt(f)
2513 }
2514}
2515
2516impl fmt::Debug for Snapshot {
2517 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2518 struct EntriesById<'a>(&'a SumTree<PathEntry>);
2519 struct EntriesByPath<'a>(&'a SumTree<Entry>);
2520
2521 impl<'a> fmt::Debug for EntriesByPath<'a> {
2522 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2523 f.debug_map()
2524 .entries(self.0.iter().map(|entry| (&entry.path, entry.id)))
2525 .finish()
2526 }
2527 }
2528
2529 impl<'a> fmt::Debug for EntriesById<'a> {
2530 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2531 f.debug_list().entries(self.0.iter()).finish()
2532 }
2533 }
2534
2535 f.debug_struct("Snapshot")
2536 .field("id", &self.id)
2537 .field("root_name", &self.root_name)
2538 .field("entries_by_path", &EntriesByPath(&self.entries_by_path))
2539 .field("entries_by_id", &EntriesById(&self.entries_by_id))
2540 .finish()
2541 }
2542}
2543
2544#[derive(Clone, PartialEq)]
2545pub struct File {
2546 pub worktree: ModelHandle<Worktree>,
2547 pub path: Arc<Path>,
2548 pub mtime: SystemTime,
2549 pub(crate) entry_id: ProjectEntryId,
2550 pub(crate) is_local: bool,
2551 pub(crate) is_deleted: bool,
2552}
2553
2554impl language::File for File {
2555 fn as_local(&self) -> Option<&dyn language::LocalFile> {
2556 if self.is_local {
2557 Some(self)
2558 } else {
2559 None
2560 }
2561 }
2562
2563 fn mtime(&self) -> SystemTime {
2564 self.mtime
2565 }
2566
2567 fn path(&self) -> &Arc<Path> {
2568 &self.path
2569 }
2570
2571 fn full_path(&self, cx: &AppContext) -> PathBuf {
2572 let mut full_path = PathBuf::new();
2573 let worktree = self.worktree.read(cx);
2574
2575 if worktree.is_visible() {
2576 full_path.push(worktree.root_name());
2577 } else {
2578 let path = worktree.abs_path();
2579
2580 if worktree.is_local() && path.starts_with(HOME.as_path()) {
2581 full_path.push("~");
2582 full_path.push(path.strip_prefix(HOME.as_path()).unwrap());
2583 } else {
2584 full_path.push(path)
2585 }
2586 }
2587
2588 if self.path.components().next().is_some() {
2589 full_path.push(&self.path);
2590 }
2591
2592 full_path
2593 }
2594
2595 /// Returns the last component of this handle's absolute path. If this handle refers to the root
2596 /// of its worktree, then this method will return the name of the worktree itself.
2597 fn file_name<'a>(&'a self, cx: &'a AppContext) -> &'a OsStr {
2598 self.path
2599 .file_name()
2600 .unwrap_or_else(|| OsStr::new(&self.worktree.read(cx).root_name))
2601 }
2602
2603 fn worktree_id(&self) -> usize {
2604 self.worktree.id()
2605 }
2606
2607 fn is_deleted(&self) -> bool {
2608 self.is_deleted
2609 }
2610
2611 fn as_any(&self) -> &dyn Any {
2612 self
2613 }
2614
2615 fn to_proto(&self) -> rpc::proto::File {
2616 rpc::proto::File {
2617 worktree_id: self.worktree.id() as u64,
2618 entry_id: self.entry_id.to_proto(),
2619 path: self.path.to_string_lossy().into(),
2620 mtime: Some(self.mtime.into()),
2621 is_deleted: self.is_deleted,
2622 }
2623 }
2624}
2625
2626impl language::LocalFile for File {
2627 fn abs_path(&self, cx: &AppContext) -> PathBuf {
2628 self.worktree
2629 .read(cx)
2630 .as_local()
2631 .unwrap()
2632 .abs_path
2633 .join(&self.path)
2634 }
2635
2636 fn load(&self, cx: &AppContext) -> Task<Result<String>> {
2637 let worktree = self.worktree.read(cx).as_local().unwrap();
2638 let abs_path = worktree.absolutize(&self.path);
2639 let fs = worktree.fs.clone();
2640 cx.background()
2641 .spawn(async move { fs.load(&abs_path).await })
2642 }
2643
2644 fn buffer_reloaded(
2645 &self,
2646 buffer_id: u64,
2647 version: &clock::Global,
2648 fingerprint: RopeFingerprint,
2649 line_ending: LineEnding,
2650 mtime: SystemTime,
2651 cx: &mut AppContext,
2652 ) {
2653 let worktree = self.worktree.read(cx).as_local().unwrap();
2654 if let Some(project_id) = worktree.share.as_ref().map(|share| share.project_id) {
2655 worktree
2656 .client
2657 .send(proto::BufferReloaded {
2658 project_id,
2659 buffer_id,
2660 version: serialize_version(version),
2661 mtime: Some(mtime.into()),
2662 fingerprint: serialize_fingerprint(fingerprint),
2663 line_ending: serialize_line_ending(line_ending) as i32,
2664 })
2665 .log_err();
2666 }
2667 }
2668}
2669
2670impl File {
2671 pub fn for_entry(entry: Entry, worktree: ModelHandle<Worktree>) -> Arc<Self> {
2672 Arc::new(Self {
2673 worktree,
2674 path: entry.path.clone(),
2675 mtime: entry.mtime,
2676 entry_id: entry.id,
2677 is_local: true,
2678 is_deleted: false,
2679 })
2680 }
2681
2682 pub fn from_proto(
2683 proto: rpc::proto::File,
2684 worktree: ModelHandle<Worktree>,
2685 cx: &AppContext,
2686 ) -> Result<Self> {
2687 let worktree_id = worktree
2688 .read(cx)
2689 .as_remote()
2690 .ok_or_else(|| anyhow!("not remote"))?
2691 .id();
2692
2693 if worktree_id.to_proto() != proto.worktree_id {
2694 return Err(anyhow!("worktree id does not match file"));
2695 }
2696
2697 Ok(Self {
2698 worktree,
2699 path: Path::new(&proto.path).into(),
2700 mtime: proto.mtime.ok_or_else(|| anyhow!("no timestamp"))?.into(),
2701 entry_id: ProjectEntryId::from_proto(proto.entry_id),
2702 is_local: false,
2703 is_deleted: proto.is_deleted,
2704 })
2705 }
2706
2707 pub fn from_dyn(file: Option<&Arc<dyn language::File>>) -> Option<&Self> {
2708 file.and_then(|f| f.as_any().downcast_ref())
2709 }
2710
2711 pub fn worktree_id(&self, cx: &AppContext) -> WorktreeId {
2712 self.worktree.read(cx).id()
2713 }
2714
2715 pub fn project_entry_id(&self, _: &AppContext) -> Option<ProjectEntryId> {
2716 if self.is_deleted {
2717 None
2718 } else {
2719 Some(self.entry_id)
2720 }
2721 }
2722}
2723
2724#[derive(Clone, Debug, PartialEq, Eq)]
2725pub struct Entry {
2726 pub id: ProjectEntryId,
2727 pub kind: EntryKind,
2728 pub path: Arc<Path>,
2729 pub inode: u64,
2730 pub mtime: SystemTime,
2731 pub is_symlink: bool,
2732
2733 /// Whether this entry is ignored by Git.
2734 ///
2735 /// We only scan ignored entries once the directory is expanded and
2736 /// exclude them from searches.
2737 pub is_ignored: bool,
2738
2739 /// Whether this entry's canonical path is outside of the worktree.
2740 /// This means the entry is only accessible from the worktree root via a
2741 /// symlink.
2742 ///
2743 /// We only scan entries outside of the worktree once the symlinked
2744 /// directory is expanded. External entries are treated like gitignored
2745 /// entries in that they are not included in searches.
2746 pub is_external: bool,
2747 pub git_status: Option<GitFileStatus>,
2748}
2749
2750#[derive(Clone, Copy, Debug, PartialEq, Eq)]
2751pub enum EntryKind {
2752 UnloadedDir,
2753 PendingDir,
2754 Dir,
2755 File(CharBag),
2756}
2757
2758#[derive(Clone, Copy, Debug, PartialEq)]
2759pub enum PathChange {
2760 /// A filesystem entry was was created.
2761 Added,
2762 /// A filesystem entry was removed.
2763 Removed,
2764 /// A filesystem entry was updated.
2765 Updated,
2766 /// A filesystem entry was either updated or added. We don't know
2767 /// whether or not it already existed, because the path had not
2768 /// been loaded before the event.
2769 AddedOrUpdated,
2770 /// A filesystem entry was found during the initial scan of the worktree.
2771 Loaded,
2772}
2773
2774pub struct GitRepositoryChange {
2775 /// The previous state of the repository, if it already existed.
2776 pub old_repository: Option<RepositoryEntry>,
2777}
2778
2779pub type UpdatedEntriesSet = Arc<[(Arc<Path>, ProjectEntryId, PathChange)]>;
2780pub type UpdatedGitRepositoriesSet = Arc<[(Arc<Path>, GitRepositoryChange)]>;
2781
2782impl Entry {
2783 fn new(
2784 path: Arc<Path>,
2785 metadata: &fs::Metadata,
2786 next_entry_id: &AtomicUsize,
2787 root_char_bag: CharBag,
2788 ) -> Self {
2789 Self {
2790 id: ProjectEntryId::new(next_entry_id),
2791 kind: if metadata.is_dir {
2792 EntryKind::PendingDir
2793 } else {
2794 EntryKind::File(char_bag_for_path(root_char_bag, &path))
2795 },
2796 path,
2797 inode: metadata.inode,
2798 mtime: metadata.mtime,
2799 is_symlink: metadata.is_symlink,
2800 is_ignored: false,
2801 is_external: false,
2802 git_status: None,
2803 }
2804 }
2805
2806 pub fn is_dir(&self) -> bool {
2807 self.kind.is_dir()
2808 }
2809
2810 pub fn is_file(&self) -> bool {
2811 self.kind.is_file()
2812 }
2813
2814 pub fn git_status(&self) -> Option<GitFileStatus> {
2815 self.git_status
2816 }
2817}
2818
2819impl EntryKind {
2820 pub fn is_dir(&self) -> bool {
2821 matches!(
2822 self,
2823 EntryKind::Dir | EntryKind::PendingDir | EntryKind::UnloadedDir
2824 )
2825 }
2826
2827 pub fn is_unloaded(&self) -> bool {
2828 matches!(self, EntryKind::UnloadedDir)
2829 }
2830
2831 pub fn is_file(&self) -> bool {
2832 matches!(self, EntryKind::File(_))
2833 }
2834}
2835
2836impl sum_tree::Item for Entry {
2837 type Summary = EntrySummary;
2838
2839 fn summary(&self) -> Self::Summary {
2840 let non_ignored_count = if self.is_ignored || self.is_external {
2841 0
2842 } else {
2843 1
2844 };
2845 let file_count;
2846 let non_ignored_file_count;
2847 if self.is_file() {
2848 file_count = 1;
2849 non_ignored_file_count = non_ignored_count;
2850 } else {
2851 file_count = 0;
2852 non_ignored_file_count = 0;
2853 }
2854
2855 let mut statuses = GitStatuses::default();
2856 match self.git_status {
2857 Some(status) => match status {
2858 GitFileStatus::Added => statuses.added = 1,
2859 GitFileStatus::Modified => statuses.modified = 1,
2860 GitFileStatus::Conflict => statuses.conflict = 1,
2861 },
2862 None => {}
2863 }
2864
2865 EntrySummary {
2866 max_path: self.path.clone(),
2867 count: 1,
2868 non_ignored_count,
2869 file_count,
2870 non_ignored_file_count,
2871 statuses,
2872 }
2873 }
2874}
2875
2876impl sum_tree::KeyedItem for Entry {
2877 type Key = PathKey;
2878
2879 fn key(&self) -> Self::Key {
2880 PathKey(self.path.clone())
2881 }
2882}
2883
2884#[derive(Clone, Debug)]
2885pub struct EntrySummary {
2886 max_path: Arc<Path>,
2887 count: usize,
2888 non_ignored_count: usize,
2889 file_count: usize,
2890 non_ignored_file_count: usize,
2891 statuses: GitStatuses,
2892}
2893
2894impl Default for EntrySummary {
2895 fn default() -> Self {
2896 Self {
2897 max_path: Arc::from(Path::new("")),
2898 count: 0,
2899 non_ignored_count: 0,
2900 file_count: 0,
2901 non_ignored_file_count: 0,
2902 statuses: Default::default(),
2903 }
2904 }
2905}
2906
2907impl sum_tree::Summary for EntrySummary {
2908 type Context = ();
2909
2910 fn add_summary(&mut self, rhs: &Self, _: &()) {
2911 self.max_path = rhs.max_path.clone();
2912 self.count += rhs.count;
2913 self.non_ignored_count += rhs.non_ignored_count;
2914 self.file_count += rhs.file_count;
2915 self.non_ignored_file_count += rhs.non_ignored_file_count;
2916 self.statuses += rhs.statuses;
2917 }
2918}
2919
2920#[derive(Clone, Debug)]
2921struct PathEntry {
2922 id: ProjectEntryId,
2923 path: Arc<Path>,
2924 is_ignored: bool,
2925 scan_id: usize,
2926}
2927
2928impl sum_tree::Item for PathEntry {
2929 type Summary = PathEntrySummary;
2930
2931 fn summary(&self) -> Self::Summary {
2932 PathEntrySummary { max_id: self.id }
2933 }
2934}
2935
2936impl sum_tree::KeyedItem for PathEntry {
2937 type Key = ProjectEntryId;
2938
2939 fn key(&self) -> Self::Key {
2940 self.id
2941 }
2942}
2943
2944#[derive(Clone, Debug, Default)]
2945struct PathEntrySummary {
2946 max_id: ProjectEntryId,
2947}
2948
2949impl sum_tree::Summary for PathEntrySummary {
2950 type Context = ();
2951
2952 fn add_summary(&mut self, summary: &Self, _: &Self::Context) {
2953 self.max_id = summary.max_id;
2954 }
2955}
2956
2957impl<'a> sum_tree::Dimension<'a, PathEntrySummary> for ProjectEntryId {
2958 fn add_summary(&mut self, summary: &'a PathEntrySummary, _: &()) {
2959 *self = summary.max_id;
2960 }
2961}
2962
2963#[derive(Clone, Debug, Eq, PartialEq, Ord, PartialOrd)]
2964pub struct PathKey(Arc<Path>);
2965
2966impl Default for PathKey {
2967 fn default() -> Self {
2968 Self(Path::new("").into())
2969 }
2970}
2971
2972impl<'a> sum_tree::Dimension<'a, EntrySummary> for PathKey {
2973 fn add_summary(&mut self, summary: &'a EntrySummary, _: &()) {
2974 self.0 = summary.max_path.clone();
2975 }
2976}
2977
2978struct BackgroundScanner {
2979 state: Mutex<BackgroundScannerState>,
2980 fs: Arc<dyn Fs>,
2981 status_updates_tx: UnboundedSender<ScanState>,
2982 executor: Arc<executor::Background>,
2983 scan_requests_rx: channel::Receiver<ScanRequest>,
2984 path_prefixes_to_scan_rx: channel::Receiver<Arc<Path>>,
2985 next_entry_id: Arc<AtomicUsize>,
2986 phase: BackgroundScannerPhase,
2987}
2988
2989#[derive(PartialEq)]
2990enum BackgroundScannerPhase {
2991 InitialScan,
2992 EventsReceivedDuringInitialScan,
2993 Events,
2994}
2995
2996impl BackgroundScanner {
2997 fn new(
2998 snapshot: LocalSnapshot,
2999 next_entry_id: Arc<AtomicUsize>,
3000 fs: Arc<dyn Fs>,
3001 status_updates_tx: UnboundedSender<ScanState>,
3002 executor: Arc<executor::Background>,
3003 scan_requests_rx: channel::Receiver<ScanRequest>,
3004 path_prefixes_to_scan_rx: channel::Receiver<Arc<Path>>,
3005 ) -> Self {
3006 Self {
3007 fs,
3008 status_updates_tx,
3009 executor,
3010 scan_requests_rx,
3011 path_prefixes_to_scan_rx,
3012 next_entry_id,
3013 state: Mutex::new(BackgroundScannerState {
3014 prev_snapshot: snapshot.snapshot.clone(),
3015 snapshot,
3016 scanned_dirs: Default::default(),
3017 path_prefixes_to_scan: Default::default(),
3018 paths_to_scan: Default::default(),
3019 removed_entry_ids: Default::default(),
3020 changed_paths: Default::default(),
3021 }),
3022 phase: BackgroundScannerPhase::InitialScan,
3023 }
3024 }
3025
3026 async fn run(
3027 &mut self,
3028 mut fs_events_rx: Pin<Box<dyn Send + Stream<Item = Vec<fsevent::Event>>>>,
3029 ) {
3030 use futures::FutureExt as _;
3031
3032 let (root_abs_path, root_inode) = {
3033 let snapshot = &self.state.lock().snapshot;
3034 (
3035 snapshot.abs_path.clone(),
3036 snapshot.root_entry().map(|e| e.inode),
3037 )
3038 };
3039
3040 // Populate ignores above the root.
3041 let ignore_stack;
3042 for ancestor in root_abs_path.ancestors().skip(1) {
3043 if let Ok(ignore) = build_gitignore(&ancestor.join(&*GITIGNORE), self.fs.as_ref()).await
3044 {
3045 self.state
3046 .lock()
3047 .snapshot
3048 .ignores_by_parent_abs_path
3049 .insert(ancestor.into(), (ignore.into(), false));
3050 }
3051 }
3052 {
3053 let mut state = self.state.lock();
3054 state.snapshot.scan_id += 1;
3055 ignore_stack = state
3056 .snapshot
3057 .ignore_stack_for_abs_path(&root_abs_path, true);
3058 if ignore_stack.is_all() {
3059 if let Some(mut root_entry) = state.snapshot.root_entry().cloned() {
3060 root_entry.is_ignored = true;
3061 state.insert_entry(root_entry, self.fs.as_ref());
3062 }
3063 }
3064 };
3065
3066 // Perform an initial scan of the directory.
3067 let (scan_job_tx, scan_job_rx) = channel::unbounded();
3068 smol::block_on(scan_job_tx.send(ScanJob {
3069 abs_path: root_abs_path,
3070 path: Arc::from(Path::new("")),
3071 ignore_stack,
3072 ancestor_inodes: TreeSet::from_ordered_entries(root_inode),
3073 is_external: false,
3074 scan_queue: scan_job_tx.clone(),
3075 }))
3076 .unwrap();
3077 drop(scan_job_tx);
3078 self.scan_dirs(true, scan_job_rx).await;
3079 {
3080 let mut state = self.state.lock();
3081 state.snapshot.completed_scan_id = state.snapshot.scan_id;
3082 }
3083
3084 self.send_status_update(false, None);
3085
3086 // Process any any FS events that occurred while performing the initial scan.
3087 // For these events, update events cannot be as precise, because we didn't
3088 // have the previous state loaded yet.
3089 self.phase = BackgroundScannerPhase::EventsReceivedDuringInitialScan;
3090 if let Poll::Ready(Some(events)) = futures::poll!(fs_events_rx.next()) {
3091 let mut paths = events.into_iter().map(|e| e.path).collect::<Vec<_>>();
3092 while let Poll::Ready(Some(more_events)) = futures::poll!(fs_events_rx.next()) {
3093 paths.extend(more_events.into_iter().map(|e| e.path));
3094 }
3095 self.process_events(paths).await;
3096 }
3097
3098 // Continue processing events until the worktree is dropped.
3099 self.phase = BackgroundScannerPhase::Events;
3100 loop {
3101 select_biased! {
3102 // Process any path refresh requests from the worktree. Prioritize
3103 // these before handling changes reported by the filesystem.
3104 request = self.scan_requests_rx.recv().fuse() => {
3105 let Ok(request) = request else { break };
3106 if !self.process_scan_request(request, false).await {
3107 return;
3108 }
3109 }
3110
3111 path_prefix = self.path_prefixes_to_scan_rx.recv().fuse() => {
3112 let Ok(path_prefix) = path_prefix else { break };
3113 log::trace!("adding path prefix {:?}", path_prefix);
3114
3115 let did_scan = self.forcibly_load_paths(&[path_prefix.clone()]).await;
3116 if did_scan {
3117 let abs_path =
3118 {
3119 let mut state = self.state.lock();
3120 state.path_prefixes_to_scan.insert(path_prefix.clone());
3121 state.snapshot.abs_path.join(&path_prefix)
3122 };
3123
3124 if let Some(abs_path) = self.fs.canonicalize(&abs_path).await.log_err() {
3125 self.process_events(vec![abs_path]).await;
3126 }
3127 }
3128 }
3129
3130 events = fs_events_rx.next().fuse() => {
3131 let Some(events) = events else { break };
3132 let mut paths = events.into_iter().map(|e| e.path).collect::<Vec<_>>();
3133 while let Poll::Ready(Some(more_events)) = futures::poll!(fs_events_rx.next()) {
3134 paths.extend(more_events.into_iter().map(|e| e.path));
3135 }
3136 self.process_events(paths.clone()).await;
3137 }
3138 }
3139 }
3140 }
3141
3142 async fn process_scan_request(&self, mut request: ScanRequest, scanning: bool) -> bool {
3143 log::debug!("rescanning paths {:?}", request.relative_paths);
3144
3145 request.relative_paths.sort_unstable();
3146 self.forcibly_load_paths(&request.relative_paths).await;
3147
3148 let root_path = self.state.lock().snapshot.abs_path.clone();
3149 let root_canonical_path = match self.fs.canonicalize(&root_path).await {
3150 Ok(path) => path,
3151 Err(err) => {
3152 log::error!("failed to canonicalize root path: {}", err);
3153 return false;
3154 }
3155 };
3156 let abs_paths = request
3157 .relative_paths
3158 .iter()
3159 .map(|path| {
3160 if path.file_name().is_some() {
3161 root_canonical_path.join(path)
3162 } else {
3163 root_canonical_path.clone()
3164 }
3165 })
3166 .collect::<Vec<_>>();
3167
3168 self.reload_entries_for_paths(
3169 root_path,
3170 root_canonical_path,
3171 &request.relative_paths,
3172 abs_paths,
3173 None,
3174 )
3175 .await;
3176 self.send_status_update(scanning, Some(request.done))
3177 }
3178
3179 async fn process_events(&mut self, mut abs_paths: Vec<PathBuf>) {
3180 let root_path = self.state.lock().snapshot.abs_path.clone();
3181 let root_canonical_path = match self.fs.canonicalize(&root_path).await {
3182 Ok(path) => path,
3183 Err(err) => {
3184 log::error!("failed to canonicalize root path: {}", err);
3185 return;
3186 }
3187 };
3188
3189 let mut relative_paths = Vec::with_capacity(abs_paths.len());
3190 abs_paths.sort_unstable();
3191 abs_paths.dedup_by(|a, b| a.starts_with(&b));
3192 abs_paths.retain(|abs_path| {
3193 let snapshot = &self.state.lock().snapshot;
3194 {
3195 let relative_path: Arc<Path> =
3196 if let Ok(path) = abs_path.strip_prefix(&root_canonical_path) {
3197 path.into()
3198 } else {
3199 log::error!(
3200 "ignoring event {abs_path:?} outside of root path {root_canonical_path:?}",
3201 );
3202 return false;
3203 };
3204
3205 let parent_dir_is_loaded = relative_path.parent().map_or(true, |parent| {
3206 snapshot
3207 .entry_for_path(parent)
3208 .map_or(false, |entry| entry.kind == EntryKind::Dir)
3209 });
3210 if !parent_dir_is_loaded {
3211 log::debug!("ignoring event {relative_path:?} within unloaded directory");
3212 return false;
3213 }
3214
3215 relative_paths.push(relative_path);
3216 true
3217 }
3218 });
3219
3220 if relative_paths.is_empty() {
3221 return;
3222 }
3223
3224 log::debug!("received fs events {:?}", relative_paths);
3225
3226 let (scan_job_tx, scan_job_rx) = channel::unbounded();
3227 self.reload_entries_for_paths(
3228 root_path,
3229 root_canonical_path,
3230 &relative_paths,
3231 abs_paths,
3232 Some(scan_job_tx.clone()),
3233 )
3234 .await;
3235 drop(scan_job_tx);
3236 self.scan_dirs(false, scan_job_rx).await;
3237
3238 let (scan_job_tx, scan_job_rx) = channel::unbounded();
3239 self.update_ignore_statuses(scan_job_tx).await;
3240 self.scan_dirs(false, scan_job_rx).await;
3241
3242 {
3243 let mut state = self.state.lock();
3244 state.reload_repositories(&relative_paths, self.fs.as_ref());
3245 state.snapshot.completed_scan_id = state.snapshot.scan_id;
3246 for (_, entry_id) in mem::take(&mut state.removed_entry_ids) {
3247 state.scanned_dirs.remove(&entry_id);
3248 }
3249 }
3250
3251 self.send_status_update(false, None);
3252 }
3253
3254 async fn forcibly_load_paths(&self, paths: &[Arc<Path>]) -> bool {
3255 let (scan_job_tx, mut scan_job_rx) = channel::unbounded();
3256 {
3257 let mut state = self.state.lock();
3258 let root_path = state.snapshot.abs_path.clone();
3259 for path in paths {
3260 for ancestor in path.ancestors() {
3261 if let Some(entry) = state.snapshot.entry_for_path(ancestor) {
3262 if entry.kind == EntryKind::UnloadedDir {
3263 let abs_path = root_path.join(ancestor);
3264 let ignore_stack =
3265 state.snapshot.ignore_stack_for_abs_path(&abs_path, true);
3266 let ancestor_inodes =
3267 state.snapshot.ancestor_inodes_for_path(&ancestor);
3268 scan_job_tx
3269 .try_send(ScanJob {
3270 abs_path: abs_path.into(),
3271 path: ancestor.into(),
3272 ignore_stack,
3273 scan_queue: scan_job_tx.clone(),
3274 ancestor_inodes,
3275 is_external: entry.is_external,
3276 })
3277 .unwrap();
3278 state.paths_to_scan.insert(path.clone());
3279 break;
3280 }
3281 }
3282 }
3283 }
3284 drop(scan_job_tx);
3285 }
3286 while let Some(job) = scan_job_rx.next().await {
3287 self.scan_dir(&job).await.log_err();
3288 }
3289
3290 mem::take(&mut self.state.lock().paths_to_scan).len() > 0
3291 }
3292
3293 async fn scan_dirs(
3294 &self,
3295 enable_progress_updates: bool,
3296 scan_jobs_rx: channel::Receiver<ScanJob>,
3297 ) {
3298 use futures::FutureExt as _;
3299
3300 if self
3301 .status_updates_tx
3302 .unbounded_send(ScanState::Started)
3303 .is_err()
3304 {
3305 return;
3306 }
3307
3308 let progress_update_count = AtomicUsize::new(0);
3309 self.executor
3310 .scoped(|scope| {
3311 for _ in 0..self.executor.num_cpus() {
3312 scope.spawn(async {
3313 let mut last_progress_update_count = 0;
3314 let progress_update_timer = self.progress_timer(enable_progress_updates).fuse();
3315 futures::pin_mut!(progress_update_timer);
3316
3317 loop {
3318 select_biased! {
3319 // Process any path refresh requests before moving on to process
3320 // the scan queue, so that user operations are prioritized.
3321 request = self.scan_requests_rx.recv().fuse() => {
3322 let Ok(request) = request else { break };
3323 if !self.process_scan_request(request, true).await {
3324 return;
3325 }
3326 }
3327
3328 // Send periodic progress updates to the worktree. Use an atomic counter
3329 // to ensure that only one of the workers sends a progress update after
3330 // the update interval elapses.
3331 _ = progress_update_timer => {
3332 match progress_update_count.compare_exchange(
3333 last_progress_update_count,
3334 last_progress_update_count + 1,
3335 SeqCst,
3336 SeqCst
3337 ) {
3338 Ok(_) => {
3339 last_progress_update_count += 1;
3340 self.send_status_update(true, None);
3341 }
3342 Err(count) => {
3343 last_progress_update_count = count;
3344 }
3345 }
3346 progress_update_timer.set(self.progress_timer(enable_progress_updates).fuse());
3347 }
3348
3349 // Recursively load directories from the file system.
3350 job = scan_jobs_rx.recv().fuse() => {
3351 let Ok(job) = job else { break };
3352 if let Err(err) = self.scan_dir(&job).await {
3353 if job.path.as_ref() != Path::new("") {
3354 log::error!("error scanning directory {:?}: {}", job.abs_path, err);
3355 }
3356 }
3357 }
3358 }
3359 }
3360 })
3361 }
3362 })
3363 .await;
3364 }
3365
3366 fn send_status_update(&self, scanning: bool, barrier: Option<barrier::Sender>) -> bool {
3367 let mut state = self.state.lock();
3368 if state.changed_paths.is_empty() && scanning {
3369 return true;
3370 }
3371
3372 let new_snapshot = state.snapshot.clone();
3373 let old_snapshot = mem::replace(&mut state.prev_snapshot, new_snapshot.snapshot.clone());
3374 let changes = self.build_change_set(&old_snapshot, &new_snapshot, &state.changed_paths);
3375 state.changed_paths.clear();
3376
3377 self.status_updates_tx
3378 .unbounded_send(ScanState::Updated {
3379 snapshot: new_snapshot,
3380 changes,
3381 scanning,
3382 barrier,
3383 })
3384 .is_ok()
3385 }
3386
3387 async fn scan_dir(&self, job: &ScanJob) -> Result<()> {
3388 log::debug!("scan directory {:?}", job.path);
3389
3390 let mut ignore_stack = job.ignore_stack.clone();
3391 let mut new_ignore = None;
3392 let (root_abs_path, root_char_bag, next_entry_id, repository) = {
3393 let snapshot = &self.state.lock().snapshot;
3394 (
3395 snapshot.abs_path().clone(),
3396 snapshot.root_char_bag,
3397 self.next_entry_id.clone(),
3398 snapshot
3399 .local_repo_for_path(&job.path)
3400 .map(|(work_dir, repo)| (work_dir, repo.clone())),
3401 )
3402 };
3403
3404 let mut root_canonical_path = None;
3405 let mut new_entries: Vec<Entry> = Vec::new();
3406 let mut new_jobs: Vec<Option<ScanJob>> = Vec::new();
3407 let mut child_paths = self.fs.read_dir(&job.abs_path).await?;
3408 while let Some(child_abs_path) = child_paths.next().await {
3409 let child_abs_path: Arc<Path> = match child_abs_path {
3410 Ok(child_abs_path) => child_abs_path.into(),
3411 Err(error) => {
3412 log::error!("error processing entry {:?}", error);
3413 continue;
3414 }
3415 };
3416
3417 let child_name = child_abs_path.file_name().unwrap();
3418 let child_path: Arc<Path> = job.path.join(child_name).into();
3419 let child_metadata = match self.fs.metadata(&child_abs_path).await {
3420 Ok(Some(metadata)) => metadata,
3421 Ok(None) => continue,
3422 Err(err) => {
3423 log::error!("error processing {:?}: {:?}", child_abs_path, err);
3424 continue;
3425 }
3426 };
3427
3428 // If we find a .gitignore, add it to the stack of ignores used to determine which paths are ignored
3429 if child_name == *GITIGNORE {
3430 match build_gitignore(&child_abs_path, self.fs.as_ref()).await {
3431 Ok(ignore) => {
3432 let ignore = Arc::new(ignore);
3433 ignore_stack = ignore_stack.append(job.abs_path.clone(), ignore.clone());
3434 new_ignore = Some(ignore);
3435 }
3436 Err(error) => {
3437 log::error!(
3438 "error loading .gitignore file {:?} - {:?}",
3439 child_name,
3440 error
3441 );
3442 }
3443 }
3444
3445 // Update ignore status of any child entries we've already processed to reflect the
3446 // ignore file in the current directory. Because `.gitignore` starts with a `.`,
3447 // there should rarely be too numerous. Update the ignore stack associated with any
3448 // new jobs as well.
3449 let mut new_jobs = new_jobs.iter_mut();
3450 for entry in &mut new_entries {
3451 let entry_abs_path = root_abs_path.join(&entry.path);
3452 entry.is_ignored =
3453 ignore_stack.is_abs_path_ignored(&entry_abs_path, entry.is_dir());
3454
3455 if entry.is_dir() {
3456 if let Some(job) = new_jobs.next().expect("missing scan job for entry") {
3457 job.ignore_stack = if entry.is_ignored {
3458 IgnoreStack::all()
3459 } else {
3460 ignore_stack.clone()
3461 };
3462 }
3463 }
3464 }
3465 }
3466
3467 let mut child_entry = Entry::new(
3468 child_path.clone(),
3469 &child_metadata,
3470 &next_entry_id,
3471 root_char_bag,
3472 );
3473
3474 if job.is_external {
3475 child_entry.is_external = true;
3476 } else if child_metadata.is_symlink {
3477 let canonical_path = match self.fs.canonicalize(&child_abs_path).await {
3478 Ok(path) => path,
3479 Err(err) => {
3480 log::error!(
3481 "error reading target of symlink {:?}: {:?}",
3482 child_abs_path,
3483 err
3484 );
3485 continue;
3486 }
3487 };
3488
3489 // lazily canonicalize the root path in order to determine if
3490 // symlinks point outside of the worktree.
3491 let root_canonical_path = match &root_canonical_path {
3492 Some(path) => path,
3493 None => match self.fs.canonicalize(&root_abs_path).await {
3494 Ok(path) => root_canonical_path.insert(path),
3495 Err(err) => {
3496 log::error!("error canonicalizing root {:?}: {:?}", root_abs_path, err);
3497 continue;
3498 }
3499 },
3500 };
3501
3502 if !canonical_path.starts_with(root_canonical_path) {
3503 child_entry.is_external = true;
3504 }
3505 }
3506
3507 if child_entry.is_dir() {
3508 child_entry.is_ignored = ignore_stack.is_abs_path_ignored(&child_abs_path, true);
3509
3510 // Avoid recursing until crash in the case of a recursive symlink
3511 if !job.ancestor_inodes.contains(&child_entry.inode) {
3512 let mut ancestor_inodes = job.ancestor_inodes.clone();
3513 ancestor_inodes.insert(child_entry.inode);
3514
3515 new_jobs.push(Some(ScanJob {
3516 abs_path: child_abs_path,
3517 path: child_path,
3518 is_external: child_entry.is_external,
3519 ignore_stack: if child_entry.is_ignored {
3520 IgnoreStack::all()
3521 } else {
3522 ignore_stack.clone()
3523 },
3524 ancestor_inodes,
3525 scan_queue: job.scan_queue.clone(),
3526 }));
3527 } else {
3528 new_jobs.push(None);
3529 }
3530 } else {
3531 child_entry.is_ignored = ignore_stack.is_abs_path_ignored(&child_abs_path, false);
3532 if !child_entry.is_ignored {
3533 if let Some((repo_path, repo)) = &repository {
3534 if let Ok(path) = child_path.strip_prefix(&repo_path.0) {
3535 child_entry.git_status = repo
3536 .repo_ptr
3537 .lock()
3538 .status(&RepoPath(path.into()))
3539 .log_err()
3540 .flatten();
3541 }
3542 }
3543 }
3544 }
3545
3546 new_entries.push(child_entry);
3547 }
3548
3549 let mut state = self.state.lock();
3550 let mut new_jobs = new_jobs.into_iter();
3551 for entry in &mut new_entries {
3552 state.reuse_entry_id(entry);
3553
3554 if entry.is_dir() {
3555 let new_job = new_jobs.next().expect("missing scan job for entry");
3556 if state.should_scan_directory(&entry) {
3557 if let Some(new_job) = new_job {
3558 job.scan_queue
3559 .try_send(new_job)
3560 .expect("channel is unbounded");
3561 }
3562 } else {
3563 log::debug!("defer scanning directory {:?}", entry.path);
3564 entry.kind = EntryKind::UnloadedDir;
3565 }
3566 }
3567 }
3568 assert!(new_jobs.next().is_none());
3569
3570 state.populate_dir(&job.path, new_entries, new_ignore, self.fs.as_ref());
3571 Ok(())
3572 }
3573
3574 async fn reload_entries_for_paths(
3575 &self,
3576 root_abs_path: Arc<Path>,
3577 root_canonical_path: PathBuf,
3578 relative_paths: &[Arc<Path>],
3579 abs_paths: Vec<PathBuf>,
3580 scan_queue_tx: Option<Sender<ScanJob>>,
3581 ) {
3582 let metadata = futures::future::join_all(
3583 abs_paths
3584 .iter()
3585 .map(|abs_path| async move {
3586 let metadata = self.fs.metadata(&abs_path).await?;
3587 if let Some(metadata) = metadata {
3588 let canonical_path = self.fs.canonicalize(&abs_path).await?;
3589 anyhow::Ok(Some((metadata, canonical_path)))
3590 } else {
3591 Ok(None)
3592 }
3593 })
3594 .collect::<Vec<_>>(),
3595 )
3596 .await;
3597
3598 let mut state = self.state.lock();
3599 let snapshot = &mut state.snapshot;
3600 let is_idle = snapshot.completed_scan_id == snapshot.scan_id;
3601 let doing_recursive_update = scan_queue_tx.is_some();
3602 snapshot.scan_id += 1;
3603 if is_idle && !doing_recursive_update {
3604 snapshot.completed_scan_id = snapshot.scan_id;
3605 }
3606
3607 // Remove any entries for paths that no longer exist or are being recursively
3608 // refreshed. Do this before adding any new entries, so that renames can be
3609 // detected regardless of the order of the paths.
3610 for (path, metadata) in relative_paths.iter().zip(metadata.iter()) {
3611 if matches!(metadata, Ok(None)) || doing_recursive_update {
3612 log::trace!("remove path {:?}", path);
3613 state.remove_path(path);
3614 }
3615 }
3616
3617 for (path, metadata) in relative_paths.iter().zip(metadata.iter()) {
3618 let abs_path: Arc<Path> = root_abs_path.join(&path).into();
3619 match metadata {
3620 Ok(Some((metadata, canonical_path))) => {
3621 let ignore_stack = state
3622 .snapshot
3623 .ignore_stack_for_abs_path(&abs_path, metadata.is_dir);
3624
3625 let mut fs_entry = Entry::new(
3626 path.clone(),
3627 metadata,
3628 self.next_entry_id.as_ref(),
3629 state.snapshot.root_char_bag,
3630 );
3631 fs_entry.is_ignored = ignore_stack.is_all();
3632 fs_entry.is_external = !canonical_path.starts_with(&root_canonical_path);
3633
3634 if !fs_entry.is_ignored {
3635 if !fs_entry.is_dir() {
3636 if let Some((work_dir, repo)) =
3637 state.snapshot.local_repo_for_path(&path)
3638 {
3639 if let Ok(path) = path.strip_prefix(work_dir.0) {
3640 fs_entry.git_status = repo
3641 .repo_ptr
3642 .lock()
3643 .status(&RepoPath(path.into()))
3644 .log_err()
3645 .flatten()
3646 }
3647 }
3648 }
3649 }
3650
3651 if let (Some(scan_queue_tx), true) = (&scan_queue_tx, fs_entry.is_dir()) {
3652 if state.should_scan_directory(&fs_entry) {
3653 let mut ancestor_inodes =
3654 state.snapshot.ancestor_inodes_for_path(&path);
3655 if !ancestor_inodes.contains(&metadata.inode) {
3656 ancestor_inodes.insert(metadata.inode);
3657 smol::block_on(scan_queue_tx.send(ScanJob {
3658 abs_path,
3659 path: path.clone(),
3660 ignore_stack,
3661 ancestor_inodes,
3662 is_external: fs_entry.is_external,
3663 scan_queue: scan_queue_tx.clone(),
3664 }))
3665 .unwrap();
3666 }
3667 } else {
3668 fs_entry.kind = EntryKind::UnloadedDir;
3669 }
3670 }
3671
3672 state.insert_entry(fs_entry, self.fs.as_ref());
3673 }
3674 Ok(None) => {
3675 self.remove_repo_path(&path, &mut state.snapshot);
3676 }
3677 Err(err) => {
3678 // TODO - create a special 'error' entry in the entries tree to mark this
3679 log::error!("error reading file on event {:?}", err);
3680 }
3681 }
3682 }
3683
3684 util::extend_sorted(
3685 &mut state.changed_paths,
3686 relative_paths.iter().cloned(),
3687 usize::MAX,
3688 Ord::cmp,
3689 );
3690 }
3691
3692 fn remove_repo_path(&self, path: &Path, snapshot: &mut LocalSnapshot) -> Option<()> {
3693 if !path
3694 .components()
3695 .any(|component| component.as_os_str() == *DOT_GIT)
3696 {
3697 if let Some(repository) = snapshot.repository_for_work_directory(path) {
3698 let entry = repository.work_directory.0;
3699 snapshot.git_repositories.remove(&entry);
3700 snapshot
3701 .snapshot
3702 .repository_entries
3703 .remove(&RepositoryWorkDirectory(path.into()));
3704 return Some(());
3705 }
3706 }
3707
3708 // TODO statuses
3709 // Track when a .git is removed and iterate over the file system there
3710
3711 Some(())
3712 }
3713
3714 async fn update_ignore_statuses(&self, scan_job_tx: Sender<ScanJob>) {
3715 use futures::FutureExt as _;
3716
3717 let mut snapshot = self.state.lock().snapshot.clone();
3718 let mut ignores_to_update = Vec::new();
3719 let mut ignores_to_delete = Vec::new();
3720 let abs_path = snapshot.abs_path.clone();
3721 for (parent_abs_path, (_, needs_update)) in &mut snapshot.ignores_by_parent_abs_path {
3722 if let Ok(parent_path) = parent_abs_path.strip_prefix(&abs_path) {
3723 if *needs_update {
3724 *needs_update = false;
3725 if snapshot.snapshot.entry_for_path(parent_path).is_some() {
3726 ignores_to_update.push(parent_abs_path.clone());
3727 }
3728 }
3729
3730 let ignore_path = parent_path.join(&*GITIGNORE);
3731 if snapshot.snapshot.entry_for_path(ignore_path).is_none() {
3732 ignores_to_delete.push(parent_abs_path.clone());
3733 }
3734 }
3735 }
3736
3737 for parent_abs_path in ignores_to_delete {
3738 snapshot.ignores_by_parent_abs_path.remove(&parent_abs_path);
3739 self.state
3740 .lock()
3741 .snapshot
3742 .ignores_by_parent_abs_path
3743 .remove(&parent_abs_path);
3744 }
3745
3746 let (ignore_queue_tx, ignore_queue_rx) = channel::unbounded();
3747 ignores_to_update.sort_unstable();
3748 let mut ignores_to_update = ignores_to_update.into_iter().peekable();
3749 while let Some(parent_abs_path) = ignores_to_update.next() {
3750 while ignores_to_update
3751 .peek()
3752 .map_or(false, |p| p.starts_with(&parent_abs_path))
3753 {
3754 ignores_to_update.next().unwrap();
3755 }
3756
3757 let ignore_stack = snapshot.ignore_stack_for_abs_path(&parent_abs_path, true);
3758 smol::block_on(ignore_queue_tx.send(UpdateIgnoreStatusJob {
3759 abs_path: parent_abs_path,
3760 ignore_stack,
3761 ignore_queue: ignore_queue_tx.clone(),
3762 scan_queue: scan_job_tx.clone(),
3763 }))
3764 .unwrap();
3765 }
3766 drop(ignore_queue_tx);
3767
3768 self.executor
3769 .scoped(|scope| {
3770 for _ in 0..self.executor.num_cpus() {
3771 scope.spawn(async {
3772 loop {
3773 select_biased! {
3774 // Process any path refresh requests before moving on to process
3775 // the queue of ignore statuses.
3776 request = self.scan_requests_rx.recv().fuse() => {
3777 let Ok(request) = request else { break };
3778 if !self.process_scan_request(request, true).await {
3779 return;
3780 }
3781 }
3782
3783 // Recursively process directories whose ignores have changed.
3784 job = ignore_queue_rx.recv().fuse() => {
3785 let Ok(job) = job else { break };
3786 self.update_ignore_status(job, &snapshot).await;
3787 }
3788 }
3789 }
3790 });
3791 }
3792 })
3793 .await;
3794 }
3795
3796 async fn update_ignore_status(&self, job: UpdateIgnoreStatusJob, snapshot: &LocalSnapshot) {
3797 log::trace!("update ignore status {:?}", job.abs_path);
3798
3799 let mut ignore_stack = job.ignore_stack;
3800 if let Some((ignore, _)) = snapshot.ignores_by_parent_abs_path.get(&job.abs_path) {
3801 ignore_stack = ignore_stack.append(job.abs_path.clone(), ignore.clone());
3802 }
3803
3804 let mut entries_by_id_edits = Vec::new();
3805 let mut entries_by_path_edits = Vec::new();
3806 let path = job.abs_path.strip_prefix(&snapshot.abs_path).unwrap();
3807 for mut entry in snapshot.child_entries(path).cloned() {
3808 let was_ignored = entry.is_ignored;
3809 let abs_path: Arc<Path> = snapshot.abs_path().join(&entry.path).into();
3810 entry.is_ignored = ignore_stack.is_abs_path_ignored(&abs_path, entry.is_dir());
3811 if entry.is_dir() {
3812 let child_ignore_stack = if entry.is_ignored {
3813 IgnoreStack::all()
3814 } else {
3815 ignore_stack.clone()
3816 };
3817
3818 // Scan any directories that were previously ignored and weren't
3819 // previously scanned.
3820 if was_ignored && !entry.is_ignored && entry.kind.is_unloaded() {
3821 let state = self.state.lock();
3822 if state.should_scan_directory(&entry) {
3823 job.scan_queue
3824 .try_send(ScanJob {
3825 abs_path: abs_path.clone(),
3826 path: entry.path.clone(),
3827 ignore_stack: child_ignore_stack.clone(),
3828 scan_queue: job.scan_queue.clone(),
3829 ancestor_inodes: state
3830 .snapshot
3831 .ancestor_inodes_for_path(&entry.path),
3832 is_external: false,
3833 })
3834 .unwrap();
3835 }
3836 }
3837
3838 job.ignore_queue
3839 .send(UpdateIgnoreStatusJob {
3840 abs_path: abs_path.clone(),
3841 ignore_stack: child_ignore_stack,
3842 ignore_queue: job.ignore_queue.clone(),
3843 scan_queue: job.scan_queue.clone(),
3844 })
3845 .await
3846 .unwrap();
3847 }
3848
3849 if entry.is_ignored != was_ignored {
3850 let mut path_entry = snapshot.entries_by_id.get(&entry.id, &()).unwrap().clone();
3851 path_entry.scan_id = snapshot.scan_id;
3852 path_entry.is_ignored = entry.is_ignored;
3853 entries_by_id_edits.push(Edit::Insert(path_entry));
3854 entries_by_path_edits.push(Edit::Insert(entry));
3855 }
3856 }
3857
3858 let state = &mut self.state.lock();
3859 for edit in &entries_by_path_edits {
3860 if let Edit::Insert(entry) = edit {
3861 if let Err(ix) = state.changed_paths.binary_search(&entry.path) {
3862 state.changed_paths.insert(ix, entry.path.clone());
3863 }
3864 }
3865 }
3866
3867 state
3868 .snapshot
3869 .entries_by_path
3870 .edit(entries_by_path_edits, &());
3871 state.snapshot.entries_by_id.edit(entries_by_id_edits, &());
3872 }
3873
3874 fn build_change_set(
3875 &self,
3876 old_snapshot: &Snapshot,
3877 new_snapshot: &Snapshot,
3878 event_paths: &[Arc<Path>],
3879 ) -> UpdatedEntriesSet {
3880 use BackgroundScannerPhase::*;
3881 use PathChange::{Added, AddedOrUpdated, Loaded, Removed, Updated};
3882
3883 // Identify which paths have changed. Use the known set of changed
3884 // parent paths to optimize the search.
3885 let mut changes = Vec::new();
3886 let mut old_paths = old_snapshot.entries_by_path.cursor::<PathKey>();
3887 let mut new_paths = new_snapshot.entries_by_path.cursor::<PathKey>();
3888 let mut last_newly_loaded_dir_path = None;
3889 old_paths.next(&());
3890 new_paths.next(&());
3891 for path in event_paths {
3892 let path = PathKey(path.clone());
3893 if old_paths.item().map_or(false, |e| e.path < path.0) {
3894 old_paths.seek_forward(&path, Bias::Left, &());
3895 }
3896 if new_paths.item().map_or(false, |e| e.path < path.0) {
3897 new_paths.seek_forward(&path, Bias::Left, &());
3898 }
3899 loop {
3900 match (old_paths.item(), new_paths.item()) {
3901 (Some(old_entry), Some(new_entry)) => {
3902 if old_entry.path > path.0
3903 && new_entry.path > path.0
3904 && !old_entry.path.starts_with(&path.0)
3905 && !new_entry.path.starts_with(&path.0)
3906 {
3907 break;
3908 }
3909
3910 match Ord::cmp(&old_entry.path, &new_entry.path) {
3911 Ordering::Less => {
3912 changes.push((old_entry.path.clone(), old_entry.id, Removed));
3913 old_paths.next(&());
3914 }
3915 Ordering::Equal => {
3916 if self.phase == EventsReceivedDuringInitialScan {
3917 if old_entry.id != new_entry.id {
3918 changes.push((
3919 old_entry.path.clone(),
3920 old_entry.id,
3921 Removed,
3922 ));
3923 }
3924 // If the worktree was not fully initialized when this event was generated,
3925 // we can't know whether this entry was added during the scan or whether
3926 // it was merely updated.
3927 changes.push((
3928 new_entry.path.clone(),
3929 new_entry.id,
3930 AddedOrUpdated,
3931 ));
3932 } else if old_entry.id != new_entry.id {
3933 changes.push((old_entry.path.clone(), old_entry.id, Removed));
3934 changes.push((new_entry.path.clone(), new_entry.id, Added));
3935 } else if old_entry != new_entry {
3936 if old_entry.kind.is_unloaded() {
3937 last_newly_loaded_dir_path = Some(&new_entry.path);
3938 changes.push((
3939 new_entry.path.clone(),
3940 new_entry.id,
3941 Loaded,
3942 ));
3943 } else {
3944 changes.push((
3945 new_entry.path.clone(),
3946 new_entry.id,
3947 Updated,
3948 ));
3949 }
3950 }
3951 old_paths.next(&());
3952 new_paths.next(&());
3953 }
3954 Ordering::Greater => {
3955 let is_newly_loaded = self.phase == InitialScan
3956 || last_newly_loaded_dir_path
3957 .as_ref()
3958 .map_or(false, |dir| new_entry.path.starts_with(&dir));
3959 changes.push((
3960 new_entry.path.clone(),
3961 new_entry.id,
3962 if is_newly_loaded { Loaded } else { Added },
3963 ));
3964 new_paths.next(&());
3965 }
3966 }
3967 }
3968 (Some(old_entry), None) => {
3969 changes.push((old_entry.path.clone(), old_entry.id, Removed));
3970 old_paths.next(&());
3971 }
3972 (None, Some(new_entry)) => {
3973 let is_newly_loaded = self.phase == InitialScan
3974 || last_newly_loaded_dir_path
3975 .as_ref()
3976 .map_or(false, |dir| new_entry.path.starts_with(&dir));
3977 changes.push((
3978 new_entry.path.clone(),
3979 new_entry.id,
3980 if is_newly_loaded { Loaded } else { Added },
3981 ));
3982 new_paths.next(&());
3983 }
3984 (None, None) => break,
3985 }
3986 }
3987 }
3988
3989 changes.into()
3990 }
3991
3992 async fn progress_timer(&self, running: bool) {
3993 if !running {
3994 return futures::future::pending().await;
3995 }
3996
3997 #[cfg(any(test, feature = "test-support"))]
3998 if self.fs.is_fake() {
3999 return self.executor.simulate_random_delay().await;
4000 }
4001
4002 smol::Timer::after(Duration::from_millis(100)).await;
4003 }
4004}
4005
4006fn char_bag_for_path(root_char_bag: CharBag, path: &Path) -> CharBag {
4007 let mut result = root_char_bag;
4008 result.extend(
4009 path.to_string_lossy()
4010 .chars()
4011 .map(|c| c.to_ascii_lowercase()),
4012 );
4013 result
4014}
4015
4016struct ScanJob {
4017 abs_path: Arc<Path>,
4018 path: Arc<Path>,
4019 ignore_stack: Arc<IgnoreStack>,
4020 scan_queue: Sender<ScanJob>,
4021 ancestor_inodes: TreeSet<u64>,
4022 is_external: bool,
4023}
4024
4025struct UpdateIgnoreStatusJob {
4026 abs_path: Arc<Path>,
4027 ignore_stack: Arc<IgnoreStack>,
4028 ignore_queue: Sender<UpdateIgnoreStatusJob>,
4029 scan_queue: Sender<ScanJob>,
4030}
4031
4032pub trait WorktreeHandle {
4033 #[cfg(any(test, feature = "test-support"))]
4034 fn flush_fs_events<'a>(
4035 &self,
4036 cx: &'a gpui::TestAppContext,
4037 ) -> futures::future::LocalBoxFuture<'a, ()>;
4038}
4039
4040impl WorktreeHandle for ModelHandle<Worktree> {
4041 // When the worktree's FS event stream sometimes delivers "redundant" events for FS changes that
4042 // occurred before the worktree was constructed. These events can cause the worktree to perform
4043 // extra directory scans, and emit extra scan-state notifications.
4044 //
4045 // This function mutates the worktree's directory and waits for those mutations to be picked up,
4046 // to ensure that all redundant FS events have already been processed.
4047 #[cfg(any(test, feature = "test-support"))]
4048 fn flush_fs_events<'a>(
4049 &self,
4050 cx: &'a gpui::TestAppContext,
4051 ) -> futures::future::LocalBoxFuture<'a, ()> {
4052 let filename = "fs-event-sentinel";
4053 let tree = self.clone();
4054 let (fs, root_path) = self.read_with(cx, |tree, _| {
4055 let tree = tree.as_local().unwrap();
4056 (tree.fs.clone(), tree.abs_path().clone())
4057 });
4058
4059 async move {
4060 fs.create_file(&root_path.join(filename), Default::default())
4061 .await
4062 .unwrap();
4063 tree.condition(cx, |tree, _| tree.entry_for_path(filename).is_some())
4064 .await;
4065
4066 fs.remove_file(&root_path.join(filename), Default::default())
4067 .await
4068 .unwrap();
4069 tree.condition(cx, |tree, _| tree.entry_for_path(filename).is_none())
4070 .await;
4071
4072 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
4073 .await;
4074 }
4075 .boxed_local()
4076 }
4077}
4078
4079#[derive(Clone, Debug)]
4080struct TraversalProgress<'a> {
4081 max_path: &'a Path,
4082 count: usize,
4083 non_ignored_count: usize,
4084 file_count: usize,
4085 non_ignored_file_count: usize,
4086}
4087
4088impl<'a> TraversalProgress<'a> {
4089 fn count(&self, include_dirs: bool, include_ignored: bool) -> usize {
4090 match (include_ignored, include_dirs) {
4091 (true, true) => self.count,
4092 (true, false) => self.file_count,
4093 (false, true) => self.non_ignored_count,
4094 (false, false) => self.non_ignored_file_count,
4095 }
4096 }
4097}
4098
4099impl<'a> sum_tree::Dimension<'a, EntrySummary> for TraversalProgress<'a> {
4100 fn add_summary(&mut self, summary: &'a EntrySummary, _: &()) {
4101 self.max_path = summary.max_path.as_ref();
4102 self.count += summary.count;
4103 self.non_ignored_count += summary.non_ignored_count;
4104 self.file_count += summary.file_count;
4105 self.non_ignored_file_count += summary.non_ignored_file_count;
4106 }
4107}
4108
4109impl<'a> Default for TraversalProgress<'a> {
4110 fn default() -> Self {
4111 Self {
4112 max_path: Path::new(""),
4113 count: 0,
4114 non_ignored_count: 0,
4115 file_count: 0,
4116 non_ignored_file_count: 0,
4117 }
4118 }
4119}
4120
4121#[derive(Clone, Debug, Default, Copy)]
4122struct GitStatuses {
4123 added: usize,
4124 modified: usize,
4125 conflict: usize,
4126}
4127
4128impl AddAssign for GitStatuses {
4129 fn add_assign(&mut self, rhs: Self) {
4130 self.added += rhs.added;
4131 self.modified += rhs.modified;
4132 self.conflict += rhs.conflict;
4133 }
4134}
4135
4136impl Sub for GitStatuses {
4137 type Output = GitStatuses;
4138
4139 fn sub(self, rhs: Self) -> Self::Output {
4140 GitStatuses {
4141 added: self.added - rhs.added,
4142 modified: self.modified - rhs.modified,
4143 conflict: self.conflict - rhs.conflict,
4144 }
4145 }
4146}
4147
4148impl<'a> sum_tree::Dimension<'a, EntrySummary> for GitStatuses {
4149 fn add_summary(&mut self, summary: &'a EntrySummary, _: &()) {
4150 *self += summary.statuses
4151 }
4152}
4153
4154pub struct Traversal<'a> {
4155 cursor: sum_tree::Cursor<'a, Entry, TraversalProgress<'a>>,
4156 include_ignored: bool,
4157 include_dirs: bool,
4158}
4159
4160impl<'a> Traversal<'a> {
4161 pub fn advance(&mut self) -> bool {
4162 self.cursor.seek_forward(
4163 &TraversalTarget::Count {
4164 count: self.end_offset() + 1,
4165 include_dirs: self.include_dirs,
4166 include_ignored: self.include_ignored,
4167 },
4168 Bias::Left,
4169 &(),
4170 )
4171 }
4172
4173 pub fn advance_to_sibling(&mut self) -> bool {
4174 while let Some(entry) = self.cursor.item() {
4175 self.cursor.seek_forward(
4176 &TraversalTarget::PathSuccessor(&entry.path),
4177 Bias::Left,
4178 &(),
4179 );
4180 if let Some(entry) = self.cursor.item() {
4181 if (self.include_dirs || !entry.is_dir())
4182 && (self.include_ignored || !entry.is_ignored)
4183 {
4184 return true;
4185 }
4186 }
4187 }
4188 false
4189 }
4190
4191 pub fn entry(&self) -> Option<&'a Entry> {
4192 self.cursor.item()
4193 }
4194
4195 pub fn start_offset(&self) -> usize {
4196 self.cursor
4197 .start()
4198 .count(self.include_dirs, self.include_ignored)
4199 }
4200
4201 pub fn end_offset(&self) -> usize {
4202 self.cursor
4203 .end(&())
4204 .count(self.include_dirs, self.include_ignored)
4205 }
4206}
4207
4208impl<'a> Iterator for Traversal<'a> {
4209 type Item = &'a Entry;
4210
4211 fn next(&mut self) -> Option<Self::Item> {
4212 if let Some(item) = self.entry() {
4213 self.advance();
4214 Some(item)
4215 } else {
4216 None
4217 }
4218 }
4219}
4220
4221#[derive(Debug)]
4222enum TraversalTarget<'a> {
4223 Path(&'a Path),
4224 PathSuccessor(&'a Path),
4225 Count {
4226 count: usize,
4227 include_ignored: bool,
4228 include_dirs: bool,
4229 },
4230}
4231
4232impl<'a, 'b> SeekTarget<'a, EntrySummary, TraversalProgress<'a>> for TraversalTarget<'b> {
4233 fn cmp(&self, cursor_location: &TraversalProgress<'a>, _: &()) -> Ordering {
4234 match self {
4235 TraversalTarget::Path(path) => path.cmp(&cursor_location.max_path),
4236 TraversalTarget::PathSuccessor(path) => {
4237 if !cursor_location.max_path.starts_with(path) {
4238 Ordering::Equal
4239 } else {
4240 Ordering::Greater
4241 }
4242 }
4243 TraversalTarget::Count {
4244 count,
4245 include_dirs,
4246 include_ignored,
4247 } => Ord::cmp(
4248 count,
4249 &cursor_location.count(*include_dirs, *include_ignored),
4250 ),
4251 }
4252 }
4253}
4254
4255impl<'a, 'b> SeekTarget<'a, EntrySummary, (TraversalProgress<'a>, GitStatuses)>
4256 for TraversalTarget<'b>
4257{
4258 fn cmp(&self, cursor_location: &(TraversalProgress<'a>, GitStatuses), _: &()) -> Ordering {
4259 self.cmp(&cursor_location.0, &())
4260 }
4261}
4262
4263struct ChildEntriesIter<'a> {
4264 parent_path: &'a Path,
4265 traversal: Traversal<'a>,
4266}
4267
4268impl<'a> Iterator for ChildEntriesIter<'a> {
4269 type Item = &'a Entry;
4270
4271 fn next(&mut self) -> Option<Self::Item> {
4272 if let Some(item) = self.traversal.entry() {
4273 if item.path.starts_with(&self.parent_path) {
4274 self.traversal.advance_to_sibling();
4275 return Some(item);
4276 }
4277 }
4278 None
4279 }
4280}
4281
4282pub struct DescendentEntriesIter<'a> {
4283 parent_path: &'a Path,
4284 traversal: Traversal<'a>,
4285}
4286
4287impl<'a> Iterator for DescendentEntriesIter<'a> {
4288 type Item = &'a Entry;
4289
4290 fn next(&mut self) -> Option<Self::Item> {
4291 if let Some(item) = self.traversal.entry() {
4292 if item.path.starts_with(&self.parent_path) {
4293 self.traversal.advance();
4294 return Some(item);
4295 }
4296 }
4297 None
4298 }
4299}
4300
4301impl<'a> From<&'a Entry> for proto::Entry {
4302 fn from(entry: &'a Entry) -> Self {
4303 Self {
4304 id: entry.id.to_proto(),
4305 is_dir: entry.is_dir(),
4306 path: entry.path.to_string_lossy().into(),
4307 inode: entry.inode,
4308 mtime: Some(entry.mtime.into()),
4309 is_symlink: entry.is_symlink,
4310 is_ignored: entry.is_ignored,
4311 is_external: entry.is_external,
4312 git_status: entry.git_status.map(|status| status.to_proto()),
4313 }
4314 }
4315}
4316
4317impl<'a> TryFrom<(&'a CharBag, proto::Entry)> for Entry {
4318 type Error = anyhow::Error;
4319
4320 fn try_from((root_char_bag, entry): (&'a CharBag, proto::Entry)) -> Result<Self> {
4321 if let Some(mtime) = entry.mtime {
4322 let kind = if entry.is_dir {
4323 EntryKind::Dir
4324 } else {
4325 let mut char_bag = *root_char_bag;
4326 char_bag.extend(entry.path.chars().map(|c| c.to_ascii_lowercase()));
4327 EntryKind::File(char_bag)
4328 };
4329 let path: Arc<Path> = PathBuf::from(entry.path).into();
4330 Ok(Entry {
4331 id: ProjectEntryId::from_proto(entry.id),
4332 kind,
4333 path,
4334 inode: entry.inode,
4335 mtime: mtime.into(),
4336 is_symlink: entry.is_symlink,
4337 is_ignored: entry.is_ignored,
4338 is_external: entry.is_external,
4339 git_status: GitFileStatus::from_proto(entry.git_status),
4340 })
4341 } else {
4342 Err(anyhow!(
4343 "missing mtime in remote worktree entry {:?}",
4344 entry.path
4345 ))
4346 }
4347 }
4348}