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 || self.scanned_dirs.contains(&entry.id) // If we've ever scanned it, keep scanning
2179 || self
2180 .paths_to_scan
2181 .iter()
2182 .any(|p| p.starts_with(&entry.path))
2183 || self
2184 .path_prefixes_to_scan
2185 .iter()
2186 .any(|p| entry.path.starts_with(p))
2187 }
2188
2189 fn reuse_entry_id(&mut self, entry: &mut Entry) {
2190 if let Some(removed_entry_id) = self.removed_entry_ids.remove(&entry.inode) {
2191 entry.id = removed_entry_id;
2192 } else if let Some(existing_entry) = self.snapshot.entry_for_path(&entry.path) {
2193 entry.id = existing_entry.id;
2194 }
2195 }
2196
2197 fn insert_entry(&mut self, mut entry: Entry, fs: &dyn Fs) -> Entry {
2198 self.reuse_entry_id(&mut entry);
2199 let entry = self.snapshot.insert_entry(entry, fs);
2200 if entry.path.file_name() == Some(&DOT_GIT) {
2201 self.build_repository(entry.path.clone(), fs);
2202 }
2203
2204 #[cfg(test)]
2205 self.snapshot.check_invariants(false);
2206
2207 entry
2208 }
2209
2210 fn populate_dir(
2211 &mut self,
2212 parent_path: &Arc<Path>,
2213 entries: impl IntoIterator<Item = Entry>,
2214 ignore: Option<Arc<Gitignore>>,
2215 fs: &dyn Fs,
2216 ) {
2217 let mut parent_entry = if let Some(parent_entry) = self
2218 .snapshot
2219 .entries_by_path
2220 .get(&PathKey(parent_path.clone()), &())
2221 {
2222 parent_entry.clone()
2223 } else {
2224 log::warn!(
2225 "populating a directory {:?} that has been removed",
2226 parent_path
2227 );
2228 return;
2229 };
2230
2231 match parent_entry.kind {
2232 EntryKind::PendingDir | EntryKind::UnloadedDir => parent_entry.kind = EntryKind::Dir,
2233 EntryKind::Dir => {}
2234 _ => return,
2235 }
2236
2237 if let Some(ignore) = ignore {
2238 let abs_parent_path = self.snapshot.abs_path.join(&parent_path).into();
2239 self.snapshot
2240 .ignores_by_parent_abs_path
2241 .insert(abs_parent_path, (ignore, false));
2242 }
2243
2244 self.scanned_dirs.insert(parent_entry.id);
2245 let mut entries_by_path_edits = vec![Edit::Insert(parent_entry)];
2246 let mut entries_by_id_edits = Vec::new();
2247 let mut dotgit_path = None;
2248
2249 for entry in entries {
2250 if entry.path.file_name() == Some(&DOT_GIT) {
2251 dotgit_path = Some(entry.path.clone());
2252 }
2253
2254 entries_by_id_edits.push(Edit::Insert(PathEntry {
2255 id: entry.id,
2256 path: entry.path.clone(),
2257 is_ignored: entry.is_ignored,
2258 scan_id: self.snapshot.scan_id,
2259 }));
2260 entries_by_path_edits.push(Edit::Insert(entry));
2261 }
2262
2263 self.snapshot
2264 .entries_by_path
2265 .edit(entries_by_path_edits, &());
2266 self.snapshot.entries_by_id.edit(entries_by_id_edits, &());
2267
2268 if let Some(dotgit_path) = dotgit_path {
2269 self.build_repository(dotgit_path, fs);
2270 }
2271 if let Err(ix) = self.changed_paths.binary_search(parent_path) {
2272 self.changed_paths.insert(ix, parent_path.clone());
2273 }
2274
2275 #[cfg(test)]
2276 self.snapshot.check_invariants(false);
2277 }
2278
2279 fn remove_path(&mut self, path: &Path) {
2280 let mut new_entries;
2281 let removed_entries;
2282 {
2283 let mut cursor = self.snapshot.entries_by_path.cursor::<TraversalProgress>();
2284 new_entries = cursor.slice(&TraversalTarget::Path(path), Bias::Left, &());
2285 removed_entries = cursor.slice(&TraversalTarget::PathSuccessor(path), Bias::Left, &());
2286 new_entries.append(cursor.suffix(&()), &());
2287 }
2288 self.snapshot.entries_by_path = new_entries;
2289
2290 let mut entries_by_id_edits = Vec::new();
2291 for entry in removed_entries.cursor::<()>() {
2292 let removed_entry_id = self
2293 .removed_entry_ids
2294 .entry(entry.inode)
2295 .or_insert(entry.id);
2296 *removed_entry_id = cmp::max(*removed_entry_id, entry.id);
2297 entries_by_id_edits.push(Edit::Remove(entry.id));
2298 }
2299 self.snapshot.entries_by_id.edit(entries_by_id_edits, &());
2300
2301 if path.file_name() == Some(&GITIGNORE) {
2302 let abs_parent_path = self.snapshot.abs_path.join(path.parent().unwrap());
2303 if let Some((_, needs_update)) = self
2304 .snapshot
2305 .ignores_by_parent_abs_path
2306 .get_mut(abs_parent_path.as_path())
2307 {
2308 *needs_update = true;
2309 }
2310 }
2311
2312 #[cfg(test)]
2313 self.snapshot.check_invariants(false);
2314 }
2315
2316 fn reload_repositories(&mut self, changed_paths: &[Arc<Path>], fs: &dyn Fs) {
2317 let scan_id = self.snapshot.scan_id;
2318
2319 // Find each of the .git directories that contain any of the given paths.
2320 let mut prev_dot_git_dir = None;
2321 for changed_path in changed_paths {
2322 let Some(dot_git_dir) = changed_path
2323 .ancestors()
2324 .find(|ancestor| ancestor.file_name() == Some(&*DOT_GIT)) else {
2325 continue;
2326 };
2327
2328 // Avoid processing the same repository multiple times, if multiple paths
2329 // within it have changed.
2330 if prev_dot_git_dir == Some(dot_git_dir) {
2331 continue;
2332 }
2333 prev_dot_git_dir = Some(dot_git_dir);
2334
2335 // If there is already a repository for this .git directory, reload
2336 // the status for all of its files.
2337 let repository = self
2338 .snapshot
2339 .git_repositories
2340 .iter()
2341 .find_map(|(entry_id, repo)| {
2342 (repo.git_dir_path.as_ref() == dot_git_dir).then(|| (*entry_id, repo.clone()))
2343 });
2344 match repository {
2345 None => {
2346 self.build_repository(dot_git_dir.into(), fs);
2347 }
2348 Some((entry_id, repository)) => {
2349 if repository.git_dir_scan_id == scan_id {
2350 continue;
2351 }
2352 let Some(work_dir) = self
2353 .snapshot
2354 .entry_for_id(entry_id)
2355 .map(|entry| RepositoryWorkDirectory(entry.path.clone())) else { continue };
2356
2357 let repository = repository.repo_ptr.lock();
2358 let branch = repository.branch_name();
2359 repository.reload_index();
2360
2361 self.snapshot
2362 .git_repositories
2363 .update(&entry_id, |entry| entry.git_dir_scan_id = scan_id);
2364 self.snapshot
2365 .snapshot
2366 .repository_entries
2367 .update(&work_dir, |entry| entry.branch = branch.map(Into::into));
2368
2369 let changed_paths = self.snapshot.scan_statuses(&*repository, &work_dir);
2370 util::extend_sorted(
2371 &mut self.changed_paths,
2372 changed_paths,
2373 usize::MAX,
2374 Ord::cmp,
2375 )
2376 }
2377 }
2378 }
2379
2380 // Remove any git repositories whose .git entry no longer exists.
2381 let mut snapshot = &mut self.snapshot;
2382 let mut repositories = mem::take(&mut snapshot.git_repositories);
2383 let mut repository_entries = mem::take(&mut snapshot.repository_entries);
2384 repositories.retain(|work_directory_id, _| {
2385 snapshot
2386 .entry_for_id(*work_directory_id)
2387 .map_or(false, |entry| {
2388 snapshot.entry_for_path(entry.path.join(*DOT_GIT)).is_some()
2389 })
2390 });
2391 repository_entries.retain(|_, entry| repositories.get(&entry.work_directory.0).is_some());
2392 snapshot.git_repositories = repositories;
2393 snapshot.repository_entries = repository_entries;
2394 }
2395
2396 fn build_repository(&mut self, dot_git_path: Arc<Path>, fs: &dyn Fs) -> Option<()> {
2397 let work_dir_path: Arc<Path> = dot_git_path.parent().unwrap().into();
2398
2399 // Guard against repositories inside the repository metadata
2400 if work_dir_path.iter().any(|component| component == *DOT_GIT) {
2401 return None;
2402 };
2403
2404 let work_dir_id = self
2405 .snapshot
2406 .entry_for_path(work_dir_path.clone())
2407 .map(|entry| entry.id)?;
2408
2409 if self.snapshot.git_repositories.get(&work_dir_id).is_some() {
2410 return None;
2411 }
2412
2413 let abs_path = self.snapshot.abs_path.join(&dot_git_path);
2414 let repository = fs.open_repo(abs_path.as_path())?;
2415 let work_directory = RepositoryWorkDirectory(work_dir_path.clone());
2416
2417 let repo_lock = repository.lock();
2418 self.snapshot.repository_entries.insert(
2419 work_directory.clone(),
2420 RepositoryEntry {
2421 work_directory: work_dir_id.into(),
2422 branch: repo_lock.branch_name().map(Into::into),
2423 },
2424 );
2425
2426 let changed_paths = self
2427 .snapshot
2428 .scan_statuses(repo_lock.deref(), &work_directory);
2429 drop(repo_lock);
2430
2431 self.snapshot.git_repositories.insert(
2432 work_dir_id,
2433 LocalRepositoryEntry {
2434 git_dir_scan_id: 0,
2435 repo_ptr: repository,
2436 git_dir_path: dot_git_path.clone(),
2437 },
2438 );
2439
2440 util::extend_sorted(&mut self.changed_paths, changed_paths, usize::MAX, Ord::cmp);
2441 Some(())
2442 }
2443}
2444
2445async fn build_gitignore(abs_path: &Path, fs: &dyn Fs) -> Result<Gitignore> {
2446 let contents = fs.load(abs_path).await?;
2447 let parent = abs_path.parent().unwrap_or_else(|| Path::new("/"));
2448 let mut builder = GitignoreBuilder::new(parent);
2449 for line in contents.lines() {
2450 builder.add_line(Some(abs_path.into()), line)?;
2451 }
2452 Ok(builder.build()?)
2453}
2454
2455impl WorktreeId {
2456 pub fn from_usize(handle_id: usize) -> Self {
2457 Self(handle_id)
2458 }
2459
2460 pub(crate) fn from_proto(id: u64) -> Self {
2461 Self(id as usize)
2462 }
2463
2464 pub fn to_proto(&self) -> u64 {
2465 self.0 as u64
2466 }
2467
2468 pub fn to_usize(&self) -> usize {
2469 self.0
2470 }
2471}
2472
2473impl fmt::Display for WorktreeId {
2474 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2475 self.0.fmt(f)
2476 }
2477}
2478
2479impl Deref for Worktree {
2480 type Target = Snapshot;
2481
2482 fn deref(&self) -> &Self::Target {
2483 match self {
2484 Worktree::Local(worktree) => &worktree.snapshot,
2485 Worktree::Remote(worktree) => &worktree.snapshot,
2486 }
2487 }
2488}
2489
2490impl Deref for LocalWorktree {
2491 type Target = LocalSnapshot;
2492
2493 fn deref(&self) -> &Self::Target {
2494 &self.snapshot
2495 }
2496}
2497
2498impl Deref for RemoteWorktree {
2499 type Target = Snapshot;
2500
2501 fn deref(&self) -> &Self::Target {
2502 &self.snapshot
2503 }
2504}
2505
2506impl fmt::Debug for LocalWorktree {
2507 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2508 self.snapshot.fmt(f)
2509 }
2510}
2511
2512impl fmt::Debug for Snapshot {
2513 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2514 struct EntriesById<'a>(&'a SumTree<PathEntry>);
2515 struct EntriesByPath<'a>(&'a SumTree<Entry>);
2516
2517 impl<'a> fmt::Debug for EntriesByPath<'a> {
2518 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2519 f.debug_map()
2520 .entries(self.0.iter().map(|entry| (&entry.path, entry.id)))
2521 .finish()
2522 }
2523 }
2524
2525 impl<'a> fmt::Debug for EntriesById<'a> {
2526 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2527 f.debug_list().entries(self.0.iter()).finish()
2528 }
2529 }
2530
2531 f.debug_struct("Snapshot")
2532 .field("id", &self.id)
2533 .field("root_name", &self.root_name)
2534 .field("entries_by_path", &EntriesByPath(&self.entries_by_path))
2535 .field("entries_by_id", &EntriesById(&self.entries_by_id))
2536 .finish()
2537 }
2538}
2539
2540#[derive(Clone, PartialEq)]
2541pub struct File {
2542 pub worktree: ModelHandle<Worktree>,
2543 pub path: Arc<Path>,
2544 pub mtime: SystemTime,
2545 pub(crate) entry_id: ProjectEntryId,
2546 pub(crate) is_local: bool,
2547 pub(crate) is_deleted: bool,
2548}
2549
2550impl language::File for File {
2551 fn as_local(&self) -> Option<&dyn language::LocalFile> {
2552 if self.is_local {
2553 Some(self)
2554 } else {
2555 None
2556 }
2557 }
2558
2559 fn mtime(&self) -> SystemTime {
2560 self.mtime
2561 }
2562
2563 fn path(&self) -> &Arc<Path> {
2564 &self.path
2565 }
2566
2567 fn full_path(&self, cx: &AppContext) -> PathBuf {
2568 let mut full_path = PathBuf::new();
2569 let worktree = self.worktree.read(cx);
2570
2571 if worktree.is_visible() {
2572 full_path.push(worktree.root_name());
2573 } else {
2574 let path = worktree.abs_path();
2575
2576 if worktree.is_local() && path.starts_with(HOME.as_path()) {
2577 full_path.push("~");
2578 full_path.push(path.strip_prefix(HOME.as_path()).unwrap());
2579 } else {
2580 full_path.push(path)
2581 }
2582 }
2583
2584 if self.path.components().next().is_some() {
2585 full_path.push(&self.path);
2586 }
2587
2588 full_path
2589 }
2590
2591 /// Returns the last component of this handle's absolute path. If this handle refers to the root
2592 /// of its worktree, then this method will return the name of the worktree itself.
2593 fn file_name<'a>(&'a self, cx: &'a AppContext) -> &'a OsStr {
2594 self.path
2595 .file_name()
2596 .unwrap_or_else(|| OsStr::new(&self.worktree.read(cx).root_name))
2597 }
2598
2599 fn worktree_id(&self) -> usize {
2600 self.worktree.id()
2601 }
2602
2603 fn is_deleted(&self) -> bool {
2604 self.is_deleted
2605 }
2606
2607 fn as_any(&self) -> &dyn Any {
2608 self
2609 }
2610
2611 fn to_proto(&self) -> rpc::proto::File {
2612 rpc::proto::File {
2613 worktree_id: self.worktree.id() as u64,
2614 entry_id: self.entry_id.to_proto(),
2615 path: self.path.to_string_lossy().into(),
2616 mtime: Some(self.mtime.into()),
2617 is_deleted: self.is_deleted,
2618 }
2619 }
2620}
2621
2622impl language::LocalFile for File {
2623 fn abs_path(&self, cx: &AppContext) -> PathBuf {
2624 self.worktree
2625 .read(cx)
2626 .as_local()
2627 .unwrap()
2628 .abs_path
2629 .join(&self.path)
2630 }
2631
2632 fn load(&self, cx: &AppContext) -> Task<Result<String>> {
2633 let worktree = self.worktree.read(cx).as_local().unwrap();
2634 let abs_path = worktree.absolutize(&self.path);
2635 let fs = worktree.fs.clone();
2636 cx.background()
2637 .spawn(async move { fs.load(&abs_path).await })
2638 }
2639
2640 fn buffer_reloaded(
2641 &self,
2642 buffer_id: u64,
2643 version: &clock::Global,
2644 fingerprint: RopeFingerprint,
2645 line_ending: LineEnding,
2646 mtime: SystemTime,
2647 cx: &mut AppContext,
2648 ) {
2649 let worktree = self.worktree.read(cx).as_local().unwrap();
2650 if let Some(project_id) = worktree.share.as_ref().map(|share| share.project_id) {
2651 worktree
2652 .client
2653 .send(proto::BufferReloaded {
2654 project_id,
2655 buffer_id,
2656 version: serialize_version(version),
2657 mtime: Some(mtime.into()),
2658 fingerprint: serialize_fingerprint(fingerprint),
2659 line_ending: serialize_line_ending(line_ending) as i32,
2660 })
2661 .log_err();
2662 }
2663 }
2664}
2665
2666impl File {
2667 pub fn for_entry(entry: Entry, worktree: ModelHandle<Worktree>) -> Arc<Self> {
2668 Arc::new(Self {
2669 worktree,
2670 path: entry.path.clone(),
2671 mtime: entry.mtime,
2672 entry_id: entry.id,
2673 is_local: true,
2674 is_deleted: false,
2675 })
2676 }
2677
2678 pub fn from_proto(
2679 proto: rpc::proto::File,
2680 worktree: ModelHandle<Worktree>,
2681 cx: &AppContext,
2682 ) -> Result<Self> {
2683 let worktree_id = worktree
2684 .read(cx)
2685 .as_remote()
2686 .ok_or_else(|| anyhow!("not remote"))?
2687 .id();
2688
2689 if worktree_id.to_proto() != proto.worktree_id {
2690 return Err(anyhow!("worktree id does not match file"));
2691 }
2692
2693 Ok(Self {
2694 worktree,
2695 path: Path::new(&proto.path).into(),
2696 mtime: proto.mtime.ok_or_else(|| anyhow!("no timestamp"))?.into(),
2697 entry_id: ProjectEntryId::from_proto(proto.entry_id),
2698 is_local: false,
2699 is_deleted: proto.is_deleted,
2700 })
2701 }
2702
2703 pub fn from_dyn(file: Option<&Arc<dyn language::File>>) -> Option<&Self> {
2704 file.and_then(|f| f.as_any().downcast_ref())
2705 }
2706
2707 pub fn worktree_id(&self, cx: &AppContext) -> WorktreeId {
2708 self.worktree.read(cx).id()
2709 }
2710
2711 pub fn project_entry_id(&self, _: &AppContext) -> Option<ProjectEntryId> {
2712 if self.is_deleted {
2713 None
2714 } else {
2715 Some(self.entry_id)
2716 }
2717 }
2718}
2719
2720#[derive(Clone, Debug, PartialEq, Eq)]
2721pub struct Entry {
2722 pub id: ProjectEntryId,
2723 pub kind: EntryKind,
2724 pub path: Arc<Path>,
2725 pub inode: u64,
2726 pub mtime: SystemTime,
2727 pub is_symlink: bool,
2728
2729 /// Whether this entry is ignored by Git.
2730 ///
2731 /// We only scan ignored entries once the directory is expanded and
2732 /// exclude them from searches.
2733 pub is_ignored: bool,
2734
2735 /// Whether this entry's canonical path is outside of the worktree.
2736 /// This means the entry is only accessible from the worktree root via a
2737 /// symlink.
2738 ///
2739 /// We only scan entries outside of the worktree once the symlinked
2740 /// directory is expanded. External entries are treated like gitignored
2741 /// entries in that they are not included in searches.
2742 pub is_external: bool,
2743 pub git_status: Option<GitFileStatus>,
2744}
2745
2746#[derive(Clone, Copy, Debug, PartialEq, Eq)]
2747pub enum EntryKind {
2748 UnloadedDir,
2749 PendingDir,
2750 Dir,
2751 File(CharBag),
2752}
2753
2754#[derive(Clone, Copy, Debug, PartialEq)]
2755pub enum PathChange {
2756 /// A filesystem entry was was created.
2757 Added,
2758 /// A filesystem entry was removed.
2759 Removed,
2760 /// A filesystem entry was updated.
2761 Updated,
2762 /// A filesystem entry was either updated or added. We don't know
2763 /// whether or not it already existed, because the path had not
2764 /// been loaded before the event.
2765 AddedOrUpdated,
2766 /// A filesystem entry was found during the initial scan of the worktree.
2767 Loaded,
2768}
2769
2770pub struct GitRepositoryChange {
2771 /// The previous state of the repository, if it already existed.
2772 pub old_repository: Option<RepositoryEntry>,
2773}
2774
2775pub type UpdatedEntriesSet = Arc<[(Arc<Path>, ProjectEntryId, PathChange)]>;
2776pub type UpdatedGitRepositoriesSet = Arc<[(Arc<Path>, GitRepositoryChange)]>;
2777
2778impl Entry {
2779 fn new(
2780 path: Arc<Path>,
2781 metadata: &fs::Metadata,
2782 next_entry_id: &AtomicUsize,
2783 root_char_bag: CharBag,
2784 ) -> Self {
2785 Self {
2786 id: ProjectEntryId::new(next_entry_id),
2787 kind: if metadata.is_dir {
2788 EntryKind::PendingDir
2789 } else {
2790 EntryKind::File(char_bag_for_path(root_char_bag, &path))
2791 },
2792 path,
2793 inode: metadata.inode,
2794 mtime: metadata.mtime,
2795 is_symlink: metadata.is_symlink,
2796 is_ignored: false,
2797 is_external: false,
2798 git_status: None,
2799 }
2800 }
2801
2802 pub fn is_dir(&self) -> bool {
2803 self.kind.is_dir()
2804 }
2805
2806 pub fn is_file(&self) -> bool {
2807 self.kind.is_file()
2808 }
2809
2810 pub fn git_status(&self) -> Option<GitFileStatus> {
2811 self.git_status
2812 }
2813}
2814
2815impl EntryKind {
2816 pub fn is_dir(&self) -> bool {
2817 matches!(
2818 self,
2819 EntryKind::Dir | EntryKind::PendingDir | EntryKind::UnloadedDir
2820 )
2821 }
2822
2823 pub fn is_unloaded(&self) -> bool {
2824 matches!(self, EntryKind::UnloadedDir)
2825 }
2826
2827 pub fn is_file(&self) -> bool {
2828 matches!(self, EntryKind::File(_))
2829 }
2830}
2831
2832impl sum_tree::Item for Entry {
2833 type Summary = EntrySummary;
2834
2835 fn summary(&self) -> Self::Summary {
2836 let non_ignored_count = if self.is_ignored || self.is_external {
2837 0
2838 } else {
2839 1
2840 };
2841 let file_count;
2842 let non_ignored_file_count;
2843 if self.is_file() {
2844 file_count = 1;
2845 non_ignored_file_count = non_ignored_count;
2846 } else {
2847 file_count = 0;
2848 non_ignored_file_count = 0;
2849 }
2850
2851 let mut statuses = GitStatuses::default();
2852 match self.git_status {
2853 Some(status) => match status {
2854 GitFileStatus::Added => statuses.added = 1,
2855 GitFileStatus::Modified => statuses.modified = 1,
2856 GitFileStatus::Conflict => statuses.conflict = 1,
2857 },
2858 None => {}
2859 }
2860
2861 EntrySummary {
2862 max_path: self.path.clone(),
2863 count: 1,
2864 non_ignored_count,
2865 file_count,
2866 non_ignored_file_count,
2867 statuses,
2868 }
2869 }
2870}
2871
2872impl sum_tree::KeyedItem for Entry {
2873 type Key = PathKey;
2874
2875 fn key(&self) -> Self::Key {
2876 PathKey(self.path.clone())
2877 }
2878}
2879
2880#[derive(Clone, Debug)]
2881pub struct EntrySummary {
2882 max_path: Arc<Path>,
2883 count: usize,
2884 non_ignored_count: usize,
2885 file_count: usize,
2886 non_ignored_file_count: usize,
2887 statuses: GitStatuses,
2888}
2889
2890impl Default for EntrySummary {
2891 fn default() -> Self {
2892 Self {
2893 max_path: Arc::from(Path::new("")),
2894 count: 0,
2895 non_ignored_count: 0,
2896 file_count: 0,
2897 non_ignored_file_count: 0,
2898 statuses: Default::default(),
2899 }
2900 }
2901}
2902
2903impl sum_tree::Summary for EntrySummary {
2904 type Context = ();
2905
2906 fn add_summary(&mut self, rhs: &Self, _: &()) {
2907 self.max_path = rhs.max_path.clone();
2908 self.count += rhs.count;
2909 self.non_ignored_count += rhs.non_ignored_count;
2910 self.file_count += rhs.file_count;
2911 self.non_ignored_file_count += rhs.non_ignored_file_count;
2912 self.statuses += rhs.statuses;
2913 }
2914}
2915
2916#[derive(Clone, Debug)]
2917struct PathEntry {
2918 id: ProjectEntryId,
2919 path: Arc<Path>,
2920 is_ignored: bool,
2921 scan_id: usize,
2922}
2923
2924impl sum_tree::Item for PathEntry {
2925 type Summary = PathEntrySummary;
2926
2927 fn summary(&self) -> Self::Summary {
2928 PathEntrySummary { max_id: self.id }
2929 }
2930}
2931
2932impl sum_tree::KeyedItem for PathEntry {
2933 type Key = ProjectEntryId;
2934
2935 fn key(&self) -> Self::Key {
2936 self.id
2937 }
2938}
2939
2940#[derive(Clone, Debug, Default)]
2941struct PathEntrySummary {
2942 max_id: ProjectEntryId,
2943}
2944
2945impl sum_tree::Summary for PathEntrySummary {
2946 type Context = ();
2947
2948 fn add_summary(&mut self, summary: &Self, _: &Self::Context) {
2949 self.max_id = summary.max_id;
2950 }
2951}
2952
2953impl<'a> sum_tree::Dimension<'a, PathEntrySummary> for ProjectEntryId {
2954 fn add_summary(&mut self, summary: &'a PathEntrySummary, _: &()) {
2955 *self = summary.max_id;
2956 }
2957}
2958
2959#[derive(Clone, Debug, Eq, PartialEq, Ord, PartialOrd)]
2960pub struct PathKey(Arc<Path>);
2961
2962impl Default for PathKey {
2963 fn default() -> Self {
2964 Self(Path::new("").into())
2965 }
2966}
2967
2968impl<'a> sum_tree::Dimension<'a, EntrySummary> for PathKey {
2969 fn add_summary(&mut self, summary: &'a EntrySummary, _: &()) {
2970 self.0 = summary.max_path.clone();
2971 }
2972}
2973
2974struct BackgroundScanner {
2975 state: Mutex<BackgroundScannerState>,
2976 fs: Arc<dyn Fs>,
2977 status_updates_tx: UnboundedSender<ScanState>,
2978 executor: Arc<executor::Background>,
2979 scan_requests_rx: channel::Receiver<ScanRequest>,
2980 path_prefixes_to_scan_rx: channel::Receiver<Arc<Path>>,
2981 next_entry_id: Arc<AtomicUsize>,
2982 phase: BackgroundScannerPhase,
2983}
2984
2985#[derive(PartialEq)]
2986enum BackgroundScannerPhase {
2987 InitialScan,
2988 EventsReceivedDuringInitialScan,
2989 Events,
2990}
2991
2992impl BackgroundScanner {
2993 fn new(
2994 snapshot: LocalSnapshot,
2995 next_entry_id: Arc<AtomicUsize>,
2996 fs: Arc<dyn Fs>,
2997 status_updates_tx: UnboundedSender<ScanState>,
2998 executor: Arc<executor::Background>,
2999 scan_requests_rx: channel::Receiver<ScanRequest>,
3000 path_prefixes_to_scan_rx: channel::Receiver<Arc<Path>>,
3001 ) -> Self {
3002 Self {
3003 fs,
3004 status_updates_tx,
3005 executor,
3006 scan_requests_rx,
3007 path_prefixes_to_scan_rx,
3008 next_entry_id,
3009 state: Mutex::new(BackgroundScannerState {
3010 prev_snapshot: snapshot.snapshot.clone(),
3011 snapshot,
3012 scanned_dirs: Default::default(),
3013 path_prefixes_to_scan: Default::default(),
3014 paths_to_scan: Default::default(),
3015 removed_entry_ids: Default::default(),
3016 changed_paths: Default::default(),
3017 }),
3018 phase: BackgroundScannerPhase::InitialScan,
3019 }
3020 }
3021
3022 async fn run(
3023 &mut self,
3024 mut fs_events_rx: Pin<Box<dyn Send + Stream<Item = Vec<fsevent::Event>>>>,
3025 ) {
3026 use futures::FutureExt as _;
3027
3028 let (root_abs_path, root_inode) = {
3029 let snapshot = &self.state.lock().snapshot;
3030 (
3031 snapshot.abs_path.clone(),
3032 snapshot.root_entry().map(|e| e.inode),
3033 )
3034 };
3035
3036 // Populate ignores above the root.
3037 let ignore_stack;
3038 for ancestor in root_abs_path.ancestors().skip(1) {
3039 if let Ok(ignore) = build_gitignore(&ancestor.join(&*GITIGNORE), self.fs.as_ref()).await
3040 {
3041 self.state
3042 .lock()
3043 .snapshot
3044 .ignores_by_parent_abs_path
3045 .insert(ancestor.into(), (ignore.into(), false));
3046 }
3047 }
3048 {
3049 let mut state = self.state.lock();
3050 state.snapshot.scan_id += 1;
3051 ignore_stack = state
3052 .snapshot
3053 .ignore_stack_for_abs_path(&root_abs_path, true);
3054 if ignore_stack.is_all() {
3055 if let Some(mut root_entry) = state.snapshot.root_entry().cloned() {
3056 root_entry.is_ignored = true;
3057 state.insert_entry(root_entry, self.fs.as_ref());
3058 }
3059 }
3060 };
3061
3062 // Perform an initial scan of the directory.
3063 let (scan_job_tx, scan_job_rx) = channel::unbounded();
3064 smol::block_on(scan_job_tx.send(ScanJob {
3065 abs_path: root_abs_path,
3066 path: Arc::from(Path::new("")),
3067 ignore_stack,
3068 ancestor_inodes: TreeSet::from_ordered_entries(root_inode),
3069 is_external: false,
3070 scan_queue: scan_job_tx.clone(),
3071 }))
3072 .unwrap();
3073 drop(scan_job_tx);
3074 self.scan_dirs(true, scan_job_rx).await;
3075 {
3076 let mut state = self.state.lock();
3077 state.snapshot.completed_scan_id = state.snapshot.scan_id;
3078 }
3079
3080 self.send_status_update(false, None);
3081
3082 // Process any any FS events that occurred while performing the initial scan.
3083 // For these events, update events cannot be as precise, because we didn't
3084 // have the previous state loaded yet.
3085 self.phase = BackgroundScannerPhase::EventsReceivedDuringInitialScan;
3086 if let Poll::Ready(Some(events)) = futures::poll!(fs_events_rx.next()) {
3087 let mut paths = events.into_iter().map(|e| e.path).collect::<Vec<_>>();
3088 while let Poll::Ready(Some(more_events)) = futures::poll!(fs_events_rx.next()) {
3089 paths.extend(more_events.into_iter().map(|e| e.path));
3090 }
3091 self.process_events(paths).await;
3092 }
3093
3094 // Continue processing events until the worktree is dropped.
3095 self.phase = BackgroundScannerPhase::Events;
3096 loop {
3097 select_biased! {
3098 // Process any path refresh requests from the worktree. Prioritize
3099 // these before handling changes reported by the filesystem.
3100 request = self.scan_requests_rx.recv().fuse() => {
3101 let Ok(request) = request else { break };
3102 if !self.process_scan_request(request, false).await {
3103 return;
3104 }
3105 }
3106
3107 path_prefix = self.path_prefixes_to_scan_rx.recv().fuse() => {
3108 let Ok(path_prefix) = path_prefix else { break };
3109 log::trace!("adding path prefix {:?}", path_prefix);
3110
3111 let did_scan = self.forcibly_load_paths(&[path_prefix.clone()]).await;
3112 if did_scan {
3113 let abs_path =
3114 {
3115 let mut state = self.state.lock();
3116 state.path_prefixes_to_scan.insert(path_prefix.clone());
3117 state.snapshot.abs_path.join(&path_prefix)
3118 };
3119
3120 if let Some(abs_path) = self.fs.canonicalize(&abs_path).await.log_err() {
3121 self.process_events(vec![abs_path]).await;
3122 }
3123 }
3124 }
3125
3126 events = fs_events_rx.next().fuse() => {
3127 let Some(events) = events else { break };
3128 let mut paths = events.into_iter().map(|e| e.path).collect::<Vec<_>>();
3129 while let Poll::Ready(Some(more_events)) = futures::poll!(fs_events_rx.next()) {
3130 paths.extend(more_events.into_iter().map(|e| e.path));
3131 }
3132 self.process_events(paths.clone()).await;
3133 }
3134 }
3135 }
3136 }
3137
3138 async fn process_scan_request(&self, mut request: ScanRequest, scanning: bool) -> bool {
3139 log::debug!("rescanning paths {:?}", request.relative_paths);
3140
3141 request.relative_paths.sort_unstable();
3142 self.forcibly_load_paths(&request.relative_paths).await;
3143
3144 let root_path = self.state.lock().snapshot.abs_path.clone();
3145 let root_canonical_path = match self.fs.canonicalize(&root_path).await {
3146 Ok(path) => path,
3147 Err(err) => {
3148 log::error!("failed to canonicalize root path: {}", err);
3149 return false;
3150 }
3151 };
3152 let abs_paths = request
3153 .relative_paths
3154 .iter()
3155 .map(|path| {
3156 if path.file_name().is_some() {
3157 root_canonical_path.join(path)
3158 } else {
3159 root_canonical_path.clone()
3160 }
3161 })
3162 .collect::<Vec<_>>();
3163
3164 self.reload_entries_for_paths(
3165 root_path,
3166 root_canonical_path,
3167 &request.relative_paths,
3168 abs_paths,
3169 None,
3170 )
3171 .await;
3172 self.send_status_update(scanning, Some(request.done))
3173 }
3174
3175 async fn process_events(&mut self, mut abs_paths: Vec<PathBuf>) {
3176 log::debug!("received fs events {:?}", abs_paths);
3177
3178 let root_path = self.state.lock().snapshot.abs_path.clone();
3179 let root_canonical_path = match self.fs.canonicalize(&root_path).await {
3180 Ok(path) => path,
3181 Err(err) => {
3182 log::error!("failed to canonicalize root path: {}", err);
3183 return;
3184 }
3185 };
3186
3187 let mut relative_paths = Vec::with_capacity(abs_paths.len());
3188 let mut unloaded_relative_paths = Vec::new();
3189 abs_paths.sort_unstable();
3190 abs_paths.dedup_by(|a, b| a.starts_with(&b));
3191 abs_paths.retain(|abs_path| {
3192 let snapshot = &self.state.lock().snapshot;
3193 {
3194 let relative_path: Arc<Path> =
3195 if let Ok(path) = abs_path.strip_prefix(&root_canonical_path) {
3196 path.into()
3197 } else {
3198 log::error!(
3199 "ignoring event {abs_path:?} outside of root path {root_canonical_path:?}",
3200 );
3201 return false;
3202 };
3203
3204 let parent_dir_is_loaded = relative_path.parent().map_or(true, |parent| {
3205 snapshot
3206 .entry_for_path(parent)
3207 .map_or(false, |entry| entry.kind == EntryKind::Dir)
3208 });
3209 if !parent_dir_is_loaded {
3210 log::debug!("ignoring event {relative_path:?} within unloaded directory");
3211 unloaded_relative_paths.push(relative_path);
3212 return false;
3213 }
3214
3215 relative_paths.push(relative_path);
3216 true
3217 }
3218 });
3219
3220 if !relative_paths.is_empty() {
3221 let (scan_job_tx, scan_job_rx) = channel::unbounded();
3222 self.reload_entries_for_paths(
3223 root_path,
3224 root_canonical_path,
3225 &relative_paths,
3226 abs_paths,
3227 Some(scan_job_tx.clone()),
3228 )
3229 .await;
3230 drop(scan_job_tx);
3231 self.scan_dirs(false, scan_job_rx).await;
3232
3233 let (scan_job_tx, scan_job_rx) = channel::unbounded();
3234 self.update_ignore_statuses(scan_job_tx).await;
3235 self.scan_dirs(false, scan_job_rx).await;
3236 }
3237
3238 {
3239 let mut state = self.state.lock();
3240 relative_paths.extend(unloaded_relative_paths);
3241 state.reload_repositories(&relative_paths, self.fs.as_ref());
3242 state.snapshot.completed_scan_id = state.snapshot.scan_id;
3243 for (_, entry_id) in mem::take(&mut state.removed_entry_ids) {
3244 state.scanned_dirs.remove(&entry_id);
3245 }
3246 }
3247
3248 self.send_status_update(false, None);
3249 }
3250
3251 async fn forcibly_load_paths(&self, paths: &[Arc<Path>]) -> bool {
3252 let (scan_job_tx, mut scan_job_rx) = channel::unbounded();
3253 {
3254 let mut state = self.state.lock();
3255 let root_path = state.snapshot.abs_path.clone();
3256 for path in paths {
3257 for ancestor in path.ancestors() {
3258 if let Some(entry) = state.snapshot.entry_for_path(ancestor) {
3259 if entry.kind == EntryKind::UnloadedDir {
3260 let abs_path = root_path.join(ancestor);
3261 let ignore_stack =
3262 state.snapshot.ignore_stack_for_abs_path(&abs_path, true);
3263 let ancestor_inodes =
3264 state.snapshot.ancestor_inodes_for_path(&ancestor);
3265 scan_job_tx
3266 .try_send(ScanJob {
3267 abs_path: abs_path.into(),
3268 path: ancestor.into(),
3269 ignore_stack,
3270 scan_queue: scan_job_tx.clone(),
3271 ancestor_inodes,
3272 is_external: entry.is_external,
3273 })
3274 .unwrap();
3275 state.paths_to_scan.insert(path.clone());
3276 break;
3277 }
3278 }
3279 }
3280 }
3281 drop(scan_job_tx);
3282 }
3283 while let Some(job) = scan_job_rx.next().await {
3284 self.scan_dir(&job).await.log_err();
3285 }
3286
3287 mem::take(&mut self.state.lock().paths_to_scan).len() > 0
3288 }
3289
3290 async fn scan_dirs(
3291 &self,
3292 enable_progress_updates: bool,
3293 scan_jobs_rx: channel::Receiver<ScanJob>,
3294 ) {
3295 use futures::FutureExt as _;
3296
3297 if self
3298 .status_updates_tx
3299 .unbounded_send(ScanState::Started)
3300 .is_err()
3301 {
3302 return;
3303 }
3304
3305 let progress_update_count = AtomicUsize::new(0);
3306 self.executor
3307 .scoped(|scope| {
3308 for _ in 0..self.executor.num_cpus() {
3309 scope.spawn(async {
3310 let mut last_progress_update_count = 0;
3311 let progress_update_timer = self.progress_timer(enable_progress_updates).fuse();
3312 futures::pin_mut!(progress_update_timer);
3313
3314 loop {
3315 select_biased! {
3316 // Process any path refresh requests before moving on to process
3317 // the scan queue, so that user operations are prioritized.
3318 request = self.scan_requests_rx.recv().fuse() => {
3319 let Ok(request) = request else { break };
3320 if !self.process_scan_request(request, true).await {
3321 return;
3322 }
3323 }
3324
3325 // Send periodic progress updates to the worktree. Use an atomic counter
3326 // to ensure that only one of the workers sends a progress update after
3327 // the update interval elapses.
3328 _ = progress_update_timer => {
3329 match progress_update_count.compare_exchange(
3330 last_progress_update_count,
3331 last_progress_update_count + 1,
3332 SeqCst,
3333 SeqCst
3334 ) {
3335 Ok(_) => {
3336 last_progress_update_count += 1;
3337 self.send_status_update(true, None);
3338 }
3339 Err(count) => {
3340 last_progress_update_count = count;
3341 }
3342 }
3343 progress_update_timer.set(self.progress_timer(enable_progress_updates).fuse());
3344 }
3345
3346 // Recursively load directories from the file system.
3347 job = scan_jobs_rx.recv().fuse() => {
3348 let Ok(job) = job else { break };
3349 if let Err(err) = self.scan_dir(&job).await {
3350 if job.path.as_ref() != Path::new("") {
3351 log::error!("error scanning directory {:?}: {}", job.abs_path, err);
3352 }
3353 }
3354 }
3355 }
3356 }
3357 })
3358 }
3359 })
3360 .await;
3361 }
3362
3363 fn send_status_update(&self, scanning: bool, barrier: Option<barrier::Sender>) -> bool {
3364 let mut state = self.state.lock();
3365 if state.changed_paths.is_empty() && scanning {
3366 return true;
3367 }
3368
3369 let new_snapshot = state.snapshot.clone();
3370 let old_snapshot = mem::replace(&mut state.prev_snapshot, new_snapshot.snapshot.clone());
3371 let changes = self.build_change_set(&old_snapshot, &new_snapshot, &state.changed_paths);
3372 state.changed_paths.clear();
3373
3374 self.status_updates_tx
3375 .unbounded_send(ScanState::Updated {
3376 snapshot: new_snapshot,
3377 changes,
3378 scanning,
3379 barrier,
3380 })
3381 .is_ok()
3382 }
3383
3384 async fn scan_dir(&self, job: &ScanJob) -> Result<()> {
3385 log::debug!("scan directory {:?}", job.path);
3386
3387 let mut ignore_stack = job.ignore_stack.clone();
3388 let mut new_ignore = None;
3389 let (root_abs_path, root_char_bag, next_entry_id, repository) = {
3390 let snapshot = &self.state.lock().snapshot;
3391 (
3392 snapshot.abs_path().clone(),
3393 snapshot.root_char_bag,
3394 self.next_entry_id.clone(),
3395 snapshot
3396 .local_repo_for_path(&job.path)
3397 .map(|(work_dir, repo)| (work_dir, repo.clone())),
3398 )
3399 };
3400
3401 let mut root_canonical_path = None;
3402 let mut new_entries: Vec<Entry> = Vec::new();
3403 let mut new_jobs: Vec<Option<ScanJob>> = Vec::new();
3404 let mut child_paths = self.fs.read_dir(&job.abs_path).await?;
3405 while let Some(child_abs_path) = child_paths.next().await {
3406 let child_abs_path: Arc<Path> = match child_abs_path {
3407 Ok(child_abs_path) => child_abs_path.into(),
3408 Err(error) => {
3409 log::error!("error processing entry {:?}", error);
3410 continue;
3411 }
3412 };
3413
3414 let child_name = child_abs_path.file_name().unwrap();
3415 let child_path: Arc<Path> = job.path.join(child_name).into();
3416 let child_metadata = match self.fs.metadata(&child_abs_path).await {
3417 Ok(Some(metadata)) => metadata,
3418 Ok(None) => continue,
3419 Err(err) => {
3420 log::error!("error processing {:?}: {:?}", child_abs_path, err);
3421 continue;
3422 }
3423 };
3424
3425 // If we find a .gitignore, add it to the stack of ignores used to determine which paths are ignored
3426 if child_name == *GITIGNORE {
3427 match build_gitignore(&child_abs_path, self.fs.as_ref()).await {
3428 Ok(ignore) => {
3429 let ignore = Arc::new(ignore);
3430 ignore_stack = ignore_stack.append(job.abs_path.clone(), ignore.clone());
3431 new_ignore = Some(ignore);
3432 }
3433 Err(error) => {
3434 log::error!(
3435 "error loading .gitignore file {:?} - {:?}",
3436 child_name,
3437 error
3438 );
3439 }
3440 }
3441
3442 // Update ignore status of any child entries we've already processed to reflect the
3443 // ignore file in the current directory. Because `.gitignore` starts with a `.`,
3444 // there should rarely be too numerous. Update the ignore stack associated with any
3445 // new jobs as well.
3446 let mut new_jobs = new_jobs.iter_mut();
3447 for entry in &mut new_entries {
3448 let entry_abs_path = root_abs_path.join(&entry.path);
3449 entry.is_ignored =
3450 ignore_stack.is_abs_path_ignored(&entry_abs_path, entry.is_dir());
3451
3452 if entry.is_dir() {
3453 if let Some(job) = new_jobs.next().expect("missing scan job for entry") {
3454 job.ignore_stack = if entry.is_ignored {
3455 IgnoreStack::all()
3456 } else {
3457 ignore_stack.clone()
3458 };
3459 }
3460 }
3461 }
3462 }
3463
3464 let mut child_entry = Entry::new(
3465 child_path.clone(),
3466 &child_metadata,
3467 &next_entry_id,
3468 root_char_bag,
3469 );
3470
3471 if job.is_external {
3472 child_entry.is_external = true;
3473 } else if child_metadata.is_symlink {
3474 let canonical_path = match self.fs.canonicalize(&child_abs_path).await {
3475 Ok(path) => path,
3476 Err(err) => {
3477 log::error!(
3478 "error reading target of symlink {:?}: {:?}",
3479 child_abs_path,
3480 err
3481 );
3482 continue;
3483 }
3484 };
3485
3486 // lazily canonicalize the root path in order to determine if
3487 // symlinks point outside of the worktree.
3488 let root_canonical_path = match &root_canonical_path {
3489 Some(path) => path,
3490 None => match self.fs.canonicalize(&root_abs_path).await {
3491 Ok(path) => root_canonical_path.insert(path),
3492 Err(err) => {
3493 log::error!("error canonicalizing root {:?}: {:?}", root_abs_path, err);
3494 continue;
3495 }
3496 },
3497 };
3498
3499 if !canonical_path.starts_with(root_canonical_path) {
3500 child_entry.is_external = true;
3501 }
3502 }
3503
3504 if child_entry.is_dir() {
3505 child_entry.is_ignored = ignore_stack.is_abs_path_ignored(&child_abs_path, true);
3506
3507 // Avoid recursing until crash in the case of a recursive symlink
3508 if !job.ancestor_inodes.contains(&child_entry.inode) {
3509 let mut ancestor_inodes = job.ancestor_inodes.clone();
3510 ancestor_inodes.insert(child_entry.inode);
3511
3512 new_jobs.push(Some(ScanJob {
3513 abs_path: child_abs_path,
3514 path: child_path,
3515 is_external: child_entry.is_external,
3516 ignore_stack: if child_entry.is_ignored {
3517 IgnoreStack::all()
3518 } else {
3519 ignore_stack.clone()
3520 },
3521 ancestor_inodes,
3522 scan_queue: job.scan_queue.clone(),
3523 }));
3524 } else {
3525 new_jobs.push(None);
3526 }
3527 } else {
3528 child_entry.is_ignored = ignore_stack.is_abs_path_ignored(&child_abs_path, false);
3529 if !child_entry.is_ignored {
3530 if let Some((repo_path, repo)) = &repository {
3531 if let Ok(path) = child_path.strip_prefix(&repo_path.0) {
3532 child_entry.git_status = repo
3533 .repo_ptr
3534 .lock()
3535 .status(&RepoPath(path.into()))
3536 .log_err()
3537 .flatten();
3538 }
3539 }
3540 }
3541 }
3542
3543 new_entries.push(child_entry);
3544 }
3545
3546 let mut state = self.state.lock();
3547 let mut new_jobs = new_jobs.into_iter();
3548 for entry in &mut new_entries {
3549 state.reuse_entry_id(entry);
3550
3551 if entry.is_dir() {
3552 let new_job = new_jobs.next().expect("missing scan job for entry");
3553 if state.should_scan_directory(&entry) {
3554 if let Some(new_job) = new_job {
3555 job.scan_queue
3556 .try_send(new_job)
3557 .expect("channel is unbounded");
3558 }
3559 } else {
3560 log::debug!("defer scanning directory {:?}", entry.path);
3561 entry.kind = EntryKind::UnloadedDir;
3562 }
3563 }
3564 }
3565 assert!(new_jobs.next().is_none());
3566
3567 state.populate_dir(&job.path, new_entries, new_ignore, self.fs.as_ref());
3568 Ok(())
3569 }
3570
3571 async fn reload_entries_for_paths(
3572 &self,
3573 root_abs_path: Arc<Path>,
3574 root_canonical_path: PathBuf,
3575 relative_paths: &[Arc<Path>],
3576 abs_paths: Vec<PathBuf>,
3577 scan_queue_tx: Option<Sender<ScanJob>>,
3578 ) {
3579 let metadata = futures::future::join_all(
3580 abs_paths
3581 .iter()
3582 .map(|abs_path| async move {
3583 let metadata = self.fs.metadata(&abs_path).await?;
3584 if let Some(metadata) = metadata {
3585 let canonical_path = self.fs.canonicalize(&abs_path).await?;
3586 anyhow::Ok(Some((metadata, canonical_path)))
3587 } else {
3588 Ok(None)
3589 }
3590 })
3591 .collect::<Vec<_>>(),
3592 )
3593 .await;
3594
3595 let mut state = self.state.lock();
3596 let snapshot = &mut state.snapshot;
3597 let is_idle = snapshot.completed_scan_id == snapshot.scan_id;
3598 let doing_recursive_update = scan_queue_tx.is_some();
3599 snapshot.scan_id += 1;
3600 if is_idle && !doing_recursive_update {
3601 snapshot.completed_scan_id = snapshot.scan_id;
3602 }
3603
3604 // Remove any entries for paths that no longer exist or are being recursively
3605 // refreshed. Do this before adding any new entries, so that renames can be
3606 // detected regardless of the order of the paths.
3607 for (path, metadata) in relative_paths.iter().zip(metadata.iter()) {
3608 if matches!(metadata, Ok(None)) || doing_recursive_update {
3609 log::trace!("remove path {:?}", path);
3610 state.remove_path(path);
3611 }
3612 }
3613
3614 for (path, metadata) in relative_paths.iter().zip(metadata.iter()) {
3615 let abs_path: Arc<Path> = root_abs_path.join(&path).into();
3616 match metadata {
3617 Ok(Some((metadata, canonical_path))) => {
3618 let ignore_stack = state
3619 .snapshot
3620 .ignore_stack_for_abs_path(&abs_path, metadata.is_dir);
3621
3622 let mut fs_entry = Entry::new(
3623 path.clone(),
3624 metadata,
3625 self.next_entry_id.as_ref(),
3626 state.snapshot.root_char_bag,
3627 );
3628 fs_entry.is_ignored = ignore_stack.is_all();
3629 fs_entry.is_external = !canonical_path.starts_with(&root_canonical_path);
3630
3631 if !fs_entry.is_ignored {
3632 if !fs_entry.is_dir() {
3633 if let Some((work_dir, repo)) =
3634 state.snapshot.local_repo_for_path(&path)
3635 {
3636 if let Ok(path) = path.strip_prefix(work_dir.0) {
3637 fs_entry.git_status = repo
3638 .repo_ptr
3639 .lock()
3640 .status(&RepoPath(path.into()))
3641 .log_err()
3642 .flatten()
3643 }
3644 }
3645 }
3646 }
3647
3648 let fs_entry = state.insert_entry(fs_entry, self.fs.as_ref());
3649
3650 if let Some(scan_queue_tx) = &scan_queue_tx {
3651 let mut ancestor_inodes = state.snapshot.ancestor_inodes_for_path(&path);
3652 if metadata.is_dir && !ancestor_inodes.contains(&metadata.inode) {
3653 ancestor_inodes.insert(metadata.inode);
3654 smol::block_on(scan_queue_tx.send(ScanJob {
3655 abs_path,
3656 path: path.clone(),
3657 ignore_stack,
3658 ancestor_inodes,
3659 is_external: fs_entry.is_external,
3660 scan_queue: scan_queue_tx.clone(),
3661 }))
3662 .unwrap();
3663 }
3664 }
3665 }
3666 Ok(None) => {
3667 self.remove_repo_path(&path, &mut state.snapshot);
3668 }
3669 Err(err) => {
3670 // TODO - create a special 'error' entry in the entries tree to mark this
3671 log::error!("error reading file on event {:?}", err);
3672 }
3673 }
3674 }
3675
3676 util::extend_sorted(
3677 &mut state.changed_paths,
3678 relative_paths.iter().cloned(),
3679 usize::MAX,
3680 Ord::cmp,
3681 );
3682 }
3683
3684 fn remove_repo_path(&self, path: &Path, snapshot: &mut LocalSnapshot) -> Option<()> {
3685 if !path
3686 .components()
3687 .any(|component| component.as_os_str() == *DOT_GIT)
3688 {
3689 if let Some(repository) = snapshot.repository_for_work_directory(path) {
3690 let entry = repository.work_directory.0;
3691 snapshot.git_repositories.remove(&entry);
3692 snapshot
3693 .snapshot
3694 .repository_entries
3695 .remove(&RepositoryWorkDirectory(path.into()));
3696 return Some(());
3697 }
3698 }
3699
3700 // TODO statuses
3701 // Track when a .git is removed and iterate over the file system there
3702
3703 Some(())
3704 }
3705
3706 async fn update_ignore_statuses(&self, scan_job_tx: Sender<ScanJob>) {
3707 use futures::FutureExt as _;
3708
3709 let mut snapshot = self.state.lock().snapshot.clone();
3710 let mut ignores_to_update = Vec::new();
3711 let mut ignores_to_delete = Vec::new();
3712 let abs_path = snapshot.abs_path.clone();
3713 for (parent_abs_path, (_, needs_update)) in &mut snapshot.ignores_by_parent_abs_path {
3714 if let Ok(parent_path) = parent_abs_path.strip_prefix(&abs_path) {
3715 if *needs_update {
3716 *needs_update = false;
3717 if snapshot.snapshot.entry_for_path(parent_path).is_some() {
3718 ignores_to_update.push(parent_abs_path.clone());
3719 }
3720 }
3721
3722 let ignore_path = parent_path.join(&*GITIGNORE);
3723 if snapshot.snapshot.entry_for_path(ignore_path).is_none() {
3724 ignores_to_delete.push(parent_abs_path.clone());
3725 }
3726 }
3727 }
3728
3729 for parent_abs_path in ignores_to_delete {
3730 snapshot.ignores_by_parent_abs_path.remove(&parent_abs_path);
3731 self.state
3732 .lock()
3733 .snapshot
3734 .ignores_by_parent_abs_path
3735 .remove(&parent_abs_path);
3736 }
3737
3738 let (ignore_queue_tx, ignore_queue_rx) = channel::unbounded();
3739 ignores_to_update.sort_unstable();
3740 let mut ignores_to_update = ignores_to_update.into_iter().peekable();
3741 while let Some(parent_abs_path) = ignores_to_update.next() {
3742 while ignores_to_update
3743 .peek()
3744 .map_or(false, |p| p.starts_with(&parent_abs_path))
3745 {
3746 ignores_to_update.next().unwrap();
3747 }
3748
3749 let ignore_stack = snapshot.ignore_stack_for_abs_path(&parent_abs_path, true);
3750 smol::block_on(ignore_queue_tx.send(UpdateIgnoreStatusJob {
3751 abs_path: parent_abs_path,
3752 ignore_stack,
3753 ignore_queue: ignore_queue_tx.clone(),
3754 scan_queue: scan_job_tx.clone(),
3755 }))
3756 .unwrap();
3757 }
3758 drop(ignore_queue_tx);
3759
3760 self.executor
3761 .scoped(|scope| {
3762 for _ in 0..self.executor.num_cpus() {
3763 scope.spawn(async {
3764 loop {
3765 select_biased! {
3766 // Process any path refresh requests before moving on to process
3767 // the queue of ignore statuses.
3768 request = self.scan_requests_rx.recv().fuse() => {
3769 let Ok(request) = request else { break };
3770 if !self.process_scan_request(request, true).await {
3771 return;
3772 }
3773 }
3774
3775 // Recursively process directories whose ignores have changed.
3776 job = ignore_queue_rx.recv().fuse() => {
3777 let Ok(job) = job else { break };
3778 self.update_ignore_status(job, &snapshot).await;
3779 }
3780 }
3781 }
3782 });
3783 }
3784 })
3785 .await;
3786 }
3787
3788 async fn update_ignore_status(&self, job: UpdateIgnoreStatusJob, snapshot: &LocalSnapshot) {
3789 log::trace!("update ignore status {:?}", job.abs_path);
3790
3791 let mut ignore_stack = job.ignore_stack;
3792 if let Some((ignore, _)) = snapshot.ignores_by_parent_abs_path.get(&job.abs_path) {
3793 ignore_stack = ignore_stack.append(job.abs_path.clone(), ignore.clone());
3794 }
3795
3796 let mut entries_by_id_edits = Vec::new();
3797 let mut entries_by_path_edits = Vec::new();
3798 let path = job.abs_path.strip_prefix(&snapshot.abs_path).unwrap();
3799 for mut entry in snapshot.child_entries(path).cloned() {
3800 let was_ignored = entry.is_ignored;
3801 let abs_path: Arc<Path> = snapshot.abs_path().join(&entry.path).into();
3802 entry.is_ignored = ignore_stack.is_abs_path_ignored(&abs_path, entry.is_dir());
3803 if entry.is_dir() {
3804 let child_ignore_stack = if entry.is_ignored {
3805 IgnoreStack::all()
3806 } else {
3807 ignore_stack.clone()
3808 };
3809
3810 // Scan any directories that were previously ignored and weren't
3811 // previously scanned.
3812 if was_ignored && !entry.is_ignored && entry.kind.is_unloaded() {
3813 let state = self.state.lock();
3814 if state.should_scan_directory(&entry) {
3815 job.scan_queue
3816 .try_send(ScanJob {
3817 abs_path: abs_path.clone(),
3818 path: entry.path.clone(),
3819 ignore_stack: child_ignore_stack.clone(),
3820 scan_queue: job.scan_queue.clone(),
3821 ancestor_inodes: state
3822 .snapshot
3823 .ancestor_inodes_for_path(&entry.path),
3824 is_external: false,
3825 })
3826 .unwrap();
3827 }
3828 }
3829
3830 job.ignore_queue
3831 .send(UpdateIgnoreStatusJob {
3832 abs_path: abs_path.clone(),
3833 ignore_stack: child_ignore_stack,
3834 ignore_queue: job.ignore_queue.clone(),
3835 scan_queue: job.scan_queue.clone(),
3836 })
3837 .await
3838 .unwrap();
3839 }
3840
3841 if entry.is_ignored != was_ignored {
3842 let mut path_entry = snapshot.entries_by_id.get(&entry.id, &()).unwrap().clone();
3843 path_entry.scan_id = snapshot.scan_id;
3844 path_entry.is_ignored = entry.is_ignored;
3845 entries_by_id_edits.push(Edit::Insert(path_entry));
3846 entries_by_path_edits.push(Edit::Insert(entry));
3847 }
3848 }
3849
3850 let state = &mut self.state.lock();
3851 for edit in &entries_by_path_edits {
3852 if let Edit::Insert(entry) = edit {
3853 if let Err(ix) = state.changed_paths.binary_search(&entry.path) {
3854 state.changed_paths.insert(ix, entry.path.clone());
3855 }
3856 }
3857 }
3858
3859 state
3860 .snapshot
3861 .entries_by_path
3862 .edit(entries_by_path_edits, &());
3863 state.snapshot.entries_by_id.edit(entries_by_id_edits, &());
3864 }
3865
3866 fn build_change_set(
3867 &self,
3868 old_snapshot: &Snapshot,
3869 new_snapshot: &Snapshot,
3870 event_paths: &[Arc<Path>],
3871 ) -> UpdatedEntriesSet {
3872 use BackgroundScannerPhase::*;
3873 use PathChange::{Added, AddedOrUpdated, Loaded, Removed, Updated};
3874
3875 // Identify which paths have changed. Use the known set of changed
3876 // parent paths to optimize the search.
3877 let mut changes = Vec::new();
3878 let mut old_paths = old_snapshot.entries_by_path.cursor::<PathKey>();
3879 let mut new_paths = new_snapshot.entries_by_path.cursor::<PathKey>();
3880 let mut last_newly_loaded_dir_path = None;
3881 old_paths.next(&());
3882 new_paths.next(&());
3883 for path in event_paths {
3884 let path = PathKey(path.clone());
3885 if old_paths.item().map_or(false, |e| e.path < path.0) {
3886 old_paths.seek_forward(&path, Bias::Left, &());
3887 }
3888 if new_paths.item().map_or(false, |e| e.path < path.0) {
3889 new_paths.seek_forward(&path, Bias::Left, &());
3890 }
3891 loop {
3892 match (old_paths.item(), new_paths.item()) {
3893 (Some(old_entry), Some(new_entry)) => {
3894 if old_entry.path > path.0
3895 && new_entry.path > path.0
3896 && !old_entry.path.starts_with(&path.0)
3897 && !new_entry.path.starts_with(&path.0)
3898 {
3899 break;
3900 }
3901
3902 match Ord::cmp(&old_entry.path, &new_entry.path) {
3903 Ordering::Less => {
3904 changes.push((old_entry.path.clone(), old_entry.id, Removed));
3905 old_paths.next(&());
3906 }
3907 Ordering::Equal => {
3908 if self.phase == EventsReceivedDuringInitialScan {
3909 if old_entry.id != new_entry.id {
3910 changes.push((
3911 old_entry.path.clone(),
3912 old_entry.id,
3913 Removed,
3914 ));
3915 }
3916 // If the worktree was not fully initialized when this event was generated,
3917 // we can't know whether this entry was added during the scan or whether
3918 // it was merely updated.
3919 changes.push((
3920 new_entry.path.clone(),
3921 new_entry.id,
3922 AddedOrUpdated,
3923 ));
3924 } else if old_entry.id != new_entry.id {
3925 changes.push((old_entry.path.clone(), old_entry.id, Removed));
3926 changes.push((new_entry.path.clone(), new_entry.id, Added));
3927 } else if old_entry != new_entry {
3928 if old_entry.kind.is_unloaded() {
3929 last_newly_loaded_dir_path = Some(&new_entry.path);
3930 changes.push((
3931 new_entry.path.clone(),
3932 new_entry.id,
3933 Loaded,
3934 ));
3935 } else {
3936 changes.push((
3937 new_entry.path.clone(),
3938 new_entry.id,
3939 Updated,
3940 ));
3941 }
3942 }
3943 old_paths.next(&());
3944 new_paths.next(&());
3945 }
3946 Ordering::Greater => {
3947 let is_newly_loaded = self.phase == InitialScan
3948 || last_newly_loaded_dir_path
3949 .as_ref()
3950 .map_or(false, |dir| new_entry.path.starts_with(&dir));
3951 changes.push((
3952 new_entry.path.clone(),
3953 new_entry.id,
3954 if is_newly_loaded { Loaded } else { Added },
3955 ));
3956 new_paths.next(&());
3957 }
3958 }
3959 }
3960 (Some(old_entry), None) => {
3961 changes.push((old_entry.path.clone(), old_entry.id, Removed));
3962 old_paths.next(&());
3963 }
3964 (None, Some(new_entry)) => {
3965 let is_newly_loaded = self.phase == InitialScan
3966 || last_newly_loaded_dir_path
3967 .as_ref()
3968 .map_or(false, |dir| new_entry.path.starts_with(&dir));
3969 changes.push((
3970 new_entry.path.clone(),
3971 new_entry.id,
3972 if is_newly_loaded { Loaded } else { Added },
3973 ));
3974 new_paths.next(&());
3975 }
3976 (None, None) => break,
3977 }
3978 }
3979 }
3980
3981 changes.into()
3982 }
3983
3984 async fn progress_timer(&self, running: bool) {
3985 if !running {
3986 return futures::future::pending().await;
3987 }
3988
3989 #[cfg(any(test, feature = "test-support"))]
3990 if self.fs.is_fake() {
3991 return self.executor.simulate_random_delay().await;
3992 }
3993
3994 smol::Timer::after(Duration::from_millis(100)).await;
3995 }
3996}
3997
3998fn char_bag_for_path(root_char_bag: CharBag, path: &Path) -> CharBag {
3999 let mut result = root_char_bag;
4000 result.extend(
4001 path.to_string_lossy()
4002 .chars()
4003 .map(|c| c.to_ascii_lowercase()),
4004 );
4005 result
4006}
4007
4008struct ScanJob {
4009 abs_path: Arc<Path>,
4010 path: Arc<Path>,
4011 ignore_stack: Arc<IgnoreStack>,
4012 scan_queue: Sender<ScanJob>,
4013 ancestor_inodes: TreeSet<u64>,
4014 is_external: bool,
4015}
4016
4017struct UpdateIgnoreStatusJob {
4018 abs_path: Arc<Path>,
4019 ignore_stack: Arc<IgnoreStack>,
4020 ignore_queue: Sender<UpdateIgnoreStatusJob>,
4021 scan_queue: Sender<ScanJob>,
4022}
4023
4024pub trait WorktreeHandle {
4025 #[cfg(any(test, feature = "test-support"))]
4026 fn flush_fs_events<'a>(
4027 &self,
4028 cx: &'a gpui::TestAppContext,
4029 ) -> futures::future::LocalBoxFuture<'a, ()>;
4030}
4031
4032impl WorktreeHandle for ModelHandle<Worktree> {
4033 // When the worktree's FS event stream sometimes delivers "redundant" events for FS changes that
4034 // occurred before the worktree was constructed. These events can cause the worktree to perform
4035 // extra directory scans, and emit extra scan-state notifications.
4036 //
4037 // This function mutates the worktree's directory and waits for those mutations to be picked up,
4038 // to ensure that all redundant FS events have already been processed.
4039 #[cfg(any(test, feature = "test-support"))]
4040 fn flush_fs_events<'a>(
4041 &self,
4042 cx: &'a gpui::TestAppContext,
4043 ) -> futures::future::LocalBoxFuture<'a, ()> {
4044 let filename = "fs-event-sentinel";
4045 let tree = self.clone();
4046 let (fs, root_path) = self.read_with(cx, |tree, _| {
4047 let tree = tree.as_local().unwrap();
4048 (tree.fs.clone(), tree.abs_path().clone())
4049 });
4050
4051 async move {
4052 fs.create_file(&root_path.join(filename), Default::default())
4053 .await
4054 .unwrap();
4055 tree.condition(cx, |tree, _| tree.entry_for_path(filename).is_some())
4056 .await;
4057
4058 fs.remove_file(&root_path.join(filename), Default::default())
4059 .await
4060 .unwrap();
4061 tree.condition(cx, |tree, _| tree.entry_for_path(filename).is_none())
4062 .await;
4063
4064 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
4065 .await;
4066 }
4067 .boxed_local()
4068 }
4069}
4070
4071#[derive(Clone, Debug)]
4072struct TraversalProgress<'a> {
4073 max_path: &'a Path,
4074 count: usize,
4075 non_ignored_count: usize,
4076 file_count: usize,
4077 non_ignored_file_count: usize,
4078}
4079
4080impl<'a> TraversalProgress<'a> {
4081 fn count(&self, include_dirs: bool, include_ignored: bool) -> usize {
4082 match (include_ignored, include_dirs) {
4083 (true, true) => self.count,
4084 (true, false) => self.file_count,
4085 (false, true) => self.non_ignored_count,
4086 (false, false) => self.non_ignored_file_count,
4087 }
4088 }
4089}
4090
4091impl<'a> sum_tree::Dimension<'a, EntrySummary> for TraversalProgress<'a> {
4092 fn add_summary(&mut self, summary: &'a EntrySummary, _: &()) {
4093 self.max_path = summary.max_path.as_ref();
4094 self.count += summary.count;
4095 self.non_ignored_count += summary.non_ignored_count;
4096 self.file_count += summary.file_count;
4097 self.non_ignored_file_count += summary.non_ignored_file_count;
4098 }
4099}
4100
4101impl<'a> Default for TraversalProgress<'a> {
4102 fn default() -> Self {
4103 Self {
4104 max_path: Path::new(""),
4105 count: 0,
4106 non_ignored_count: 0,
4107 file_count: 0,
4108 non_ignored_file_count: 0,
4109 }
4110 }
4111}
4112
4113#[derive(Clone, Debug, Default, Copy)]
4114struct GitStatuses {
4115 added: usize,
4116 modified: usize,
4117 conflict: usize,
4118}
4119
4120impl AddAssign for GitStatuses {
4121 fn add_assign(&mut self, rhs: Self) {
4122 self.added += rhs.added;
4123 self.modified += rhs.modified;
4124 self.conflict += rhs.conflict;
4125 }
4126}
4127
4128impl Sub for GitStatuses {
4129 type Output = GitStatuses;
4130
4131 fn sub(self, rhs: Self) -> Self::Output {
4132 GitStatuses {
4133 added: self.added - rhs.added,
4134 modified: self.modified - rhs.modified,
4135 conflict: self.conflict - rhs.conflict,
4136 }
4137 }
4138}
4139
4140impl<'a> sum_tree::Dimension<'a, EntrySummary> for GitStatuses {
4141 fn add_summary(&mut self, summary: &'a EntrySummary, _: &()) {
4142 *self += summary.statuses
4143 }
4144}
4145
4146pub struct Traversal<'a> {
4147 cursor: sum_tree::Cursor<'a, Entry, TraversalProgress<'a>>,
4148 include_ignored: bool,
4149 include_dirs: bool,
4150}
4151
4152impl<'a> Traversal<'a> {
4153 pub fn advance(&mut self) -> bool {
4154 self.cursor.seek_forward(
4155 &TraversalTarget::Count {
4156 count: self.end_offset() + 1,
4157 include_dirs: self.include_dirs,
4158 include_ignored: self.include_ignored,
4159 },
4160 Bias::Left,
4161 &(),
4162 )
4163 }
4164
4165 pub fn advance_to_sibling(&mut self) -> bool {
4166 while let Some(entry) = self.cursor.item() {
4167 self.cursor.seek_forward(
4168 &TraversalTarget::PathSuccessor(&entry.path),
4169 Bias::Left,
4170 &(),
4171 );
4172 if let Some(entry) = self.cursor.item() {
4173 if (self.include_dirs || !entry.is_dir())
4174 && (self.include_ignored || !entry.is_ignored)
4175 {
4176 return true;
4177 }
4178 }
4179 }
4180 false
4181 }
4182
4183 pub fn entry(&self) -> Option<&'a Entry> {
4184 self.cursor.item()
4185 }
4186
4187 pub fn start_offset(&self) -> usize {
4188 self.cursor
4189 .start()
4190 .count(self.include_dirs, self.include_ignored)
4191 }
4192
4193 pub fn end_offset(&self) -> usize {
4194 self.cursor
4195 .end(&())
4196 .count(self.include_dirs, self.include_ignored)
4197 }
4198}
4199
4200impl<'a> Iterator for Traversal<'a> {
4201 type Item = &'a Entry;
4202
4203 fn next(&mut self) -> Option<Self::Item> {
4204 if let Some(item) = self.entry() {
4205 self.advance();
4206 Some(item)
4207 } else {
4208 None
4209 }
4210 }
4211}
4212
4213#[derive(Debug)]
4214enum TraversalTarget<'a> {
4215 Path(&'a Path),
4216 PathSuccessor(&'a Path),
4217 Count {
4218 count: usize,
4219 include_ignored: bool,
4220 include_dirs: bool,
4221 },
4222}
4223
4224impl<'a, 'b> SeekTarget<'a, EntrySummary, TraversalProgress<'a>> for TraversalTarget<'b> {
4225 fn cmp(&self, cursor_location: &TraversalProgress<'a>, _: &()) -> Ordering {
4226 match self {
4227 TraversalTarget::Path(path) => path.cmp(&cursor_location.max_path),
4228 TraversalTarget::PathSuccessor(path) => {
4229 if !cursor_location.max_path.starts_with(path) {
4230 Ordering::Equal
4231 } else {
4232 Ordering::Greater
4233 }
4234 }
4235 TraversalTarget::Count {
4236 count,
4237 include_dirs,
4238 include_ignored,
4239 } => Ord::cmp(
4240 count,
4241 &cursor_location.count(*include_dirs, *include_ignored),
4242 ),
4243 }
4244 }
4245}
4246
4247impl<'a, 'b> SeekTarget<'a, EntrySummary, (TraversalProgress<'a>, GitStatuses)>
4248 for TraversalTarget<'b>
4249{
4250 fn cmp(&self, cursor_location: &(TraversalProgress<'a>, GitStatuses), _: &()) -> Ordering {
4251 self.cmp(&cursor_location.0, &())
4252 }
4253}
4254
4255struct ChildEntriesIter<'a> {
4256 parent_path: &'a Path,
4257 traversal: Traversal<'a>,
4258}
4259
4260impl<'a> Iterator for ChildEntriesIter<'a> {
4261 type Item = &'a Entry;
4262
4263 fn next(&mut self) -> Option<Self::Item> {
4264 if let Some(item) = self.traversal.entry() {
4265 if item.path.starts_with(&self.parent_path) {
4266 self.traversal.advance_to_sibling();
4267 return Some(item);
4268 }
4269 }
4270 None
4271 }
4272}
4273
4274pub struct DescendentEntriesIter<'a> {
4275 parent_path: &'a Path,
4276 traversal: Traversal<'a>,
4277}
4278
4279impl<'a> Iterator for DescendentEntriesIter<'a> {
4280 type Item = &'a Entry;
4281
4282 fn next(&mut self) -> Option<Self::Item> {
4283 if let Some(item) = self.traversal.entry() {
4284 if item.path.starts_with(&self.parent_path) {
4285 self.traversal.advance();
4286 return Some(item);
4287 }
4288 }
4289 None
4290 }
4291}
4292
4293impl<'a> From<&'a Entry> for proto::Entry {
4294 fn from(entry: &'a Entry) -> Self {
4295 Self {
4296 id: entry.id.to_proto(),
4297 is_dir: entry.is_dir(),
4298 path: entry.path.to_string_lossy().into(),
4299 inode: entry.inode,
4300 mtime: Some(entry.mtime.into()),
4301 is_symlink: entry.is_symlink,
4302 is_ignored: entry.is_ignored,
4303 is_external: entry.is_external,
4304 git_status: entry.git_status.map(|status| status.to_proto()),
4305 }
4306 }
4307}
4308
4309impl<'a> TryFrom<(&'a CharBag, proto::Entry)> for Entry {
4310 type Error = anyhow::Error;
4311
4312 fn try_from((root_char_bag, entry): (&'a CharBag, proto::Entry)) -> Result<Self> {
4313 if let Some(mtime) = entry.mtime {
4314 let kind = if entry.is_dir {
4315 EntryKind::Dir
4316 } else {
4317 let mut char_bag = *root_char_bag;
4318 char_bag.extend(entry.path.chars().map(|c| c.to_ascii_lowercase()));
4319 EntryKind::File(char_bag)
4320 };
4321 let path: Arc<Path> = PathBuf::from(entry.path).into();
4322 Ok(Entry {
4323 id: ProjectEntryId::from_proto(entry.id),
4324 kind,
4325 path,
4326 inode: entry.inode,
4327 mtime: mtime.into(),
4328 is_symlink: entry.is_symlink,
4329 is_ignored: entry.is_ignored,
4330 is_external: entry.is_external,
4331 git_status: GitFileStatus::from_proto(entry.git_status),
4332 })
4333 } else {
4334 Err(anyhow!(
4335 "missing mtime in remote worktree entry {:?}",
4336 entry.path
4337 ))
4338 }
4339 }
4340}