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