1use crate::{
2 copy_recursive, ignore::IgnoreStack, DiagnosticSummary, ProjectEntryId, RemoveOptions,
3};
4use ::ignore::gitignore::{Gitignore, GitignoreBuilder};
5use anyhow::{anyhow, Context as _, Result};
6use client2::{proto, Client};
7use clock::ReplicaId;
8use collections::{HashMap, HashSet, VecDeque};
9use fs::{
10 repository::{GitFileStatus, GitRepository, RepoPath},
11 Fs,
12};
13use futures::{
14 channel::{
15 mpsc::{self, UnboundedSender},
16 oneshot,
17 },
18 select_biased,
19 task::Poll,
20 FutureExt, Stream, StreamExt,
21};
22use fuzzy2::CharBag;
23use git::{DOT_GIT, GITIGNORE};
24use gpui2::{
25 AppContext, AsyncAppContext, Context, EventEmitter, Executor, Handle, ModelContext, Task,
26};
27use language2::{
28 proto::{
29 deserialize_fingerprint, deserialize_version, serialize_fingerprint, serialize_line_ending,
30 serialize_version,
31 },
32 Buffer, DiagnosticEntry, File as _, LineEnding, PointUtf16, Rope, RopeFingerprint, Unclipped,
33};
34use lsp2::LanguageServerId;
35use parking_lot::Mutex;
36use postage::{
37 barrier,
38 prelude::{Sink as _, Stream as _},
39 watch,
40};
41use smol::channel::{self, Sender};
42use std::{
43 any::Any,
44 cmp::{self, Ordering},
45 convert::TryFrom,
46 ffi::OsStr,
47 fmt,
48 future::Future,
49 mem,
50 ops::{AddAssign, Deref, DerefMut, Sub},
51 path::{Path, PathBuf},
52 pin::Pin,
53 sync::{
54 atomic::{AtomicUsize, Ordering::SeqCst},
55 Arc,
56 },
57 time::{Duration, SystemTime},
58};
59use sum_tree::{Bias, Edit, SeekTarget, SumTree, TreeMap, TreeSet};
60use util::{paths::HOME, ResultExt};
61
62#[derive(Copy, Clone, PartialEq, Eq, Debug, Hash, PartialOrd, Ord)]
63pub struct WorktreeId(usize);
64
65pub enum Worktree {
66 Local(LocalWorktree),
67 Remote(RemoteWorktree),
68}
69
70pub struct LocalWorktree {
71 snapshot: LocalSnapshot,
72 scan_requests_tx: channel::Sender<ScanRequest>,
73 path_prefixes_to_scan_tx: channel::Sender<Arc<Path>>,
74 is_scanning: (watch::Sender<bool>, watch::Receiver<bool>),
75 _background_scanner_task: Task<()>,
76 share: Option<ShareState>,
77 diagnostics: HashMap<
78 Arc<Path>,
79 Vec<(
80 LanguageServerId,
81 Vec<DiagnosticEntry<Unclipped<PointUtf16>>>,
82 )>,
83 >,
84 diagnostic_summaries: HashMap<Arc<Path>, HashMap<LanguageServerId, DiagnosticSummary>>,
85 client: Arc<Client>,
86 fs: Arc<dyn Fs>,
87 visible: bool,
88}
89
90struct ScanRequest {
91 relative_paths: Vec<Arc<Path>>,
92 done: barrier::Sender,
93}
94
95pub struct RemoteWorktree {
96 snapshot: Snapshot,
97 background_snapshot: Arc<Mutex<Snapshot>>,
98 project_id: u64,
99 client: Arc<Client>,
100 updates_tx: Option<UnboundedSender<proto::UpdateWorktree>>,
101 snapshot_subscriptions: VecDeque<(usize, oneshot::Sender<()>)>,
102 replica_id: ReplicaId,
103 diagnostic_summaries: HashMap<Arc<Path>, HashMap<LanguageServerId, DiagnosticSummary>>,
104 visible: bool,
105 disconnected: bool,
106}
107
108#[derive(Clone)]
109pub struct Snapshot {
110 id: WorktreeId,
111 abs_path: Arc<Path>,
112 root_name: String,
113 root_char_bag: CharBag,
114 entries_by_path: SumTree<Entry>,
115 entries_by_id: SumTree<PathEntry>,
116 repository_entries: TreeMap<RepositoryWorkDirectory, RepositoryEntry>,
117
118 /// A number that increases every time the worktree begins scanning
119 /// a set of paths from the filesystem. This scanning could be caused
120 /// by some operation performed on the worktree, such as reading or
121 /// writing a file, or by an event reported by the filesystem.
122 scan_id: usize,
123
124 /// The latest scan id that has completed, and whose preceding scans
125 /// have all completed. The current `scan_id` could be more than one
126 /// greater than the `completed_scan_id` if operations are performed
127 /// on the worktree while it is processing a file-system event.
128 completed_scan_id: usize,
129}
130
131#[derive(Clone, Debug, PartialEq, Eq)]
132pub struct RepositoryEntry {
133 pub(crate) work_directory: WorkDirectoryEntry,
134 pub(crate) branch: Option<Arc<str>>,
135}
136
137impl RepositoryEntry {
138 pub fn branch(&self) -> Option<Arc<str>> {
139 self.branch.clone()
140 }
141
142 pub fn work_directory_id(&self) -> ProjectEntryId {
143 *self.work_directory
144 }
145
146 pub fn work_directory(&self, snapshot: &Snapshot) -> Option<RepositoryWorkDirectory> {
147 snapshot
148 .entry_for_id(self.work_directory_id())
149 .map(|entry| RepositoryWorkDirectory(entry.path.clone()))
150 }
151
152 pub fn build_update(&self, _: &Self) -> proto::RepositoryEntry {
153 proto::RepositoryEntry {
154 work_directory_id: self.work_directory_id().to_proto(),
155 branch: self.branch.as_ref().map(|str| str.to_string()),
156 }
157 }
158}
159
160impl From<&RepositoryEntry> for proto::RepositoryEntry {
161 fn from(value: &RepositoryEntry) -> Self {
162 proto::RepositoryEntry {
163 work_directory_id: value.work_directory.to_proto(),
164 branch: value.branch.as_ref().map(|str| str.to_string()),
165 }
166 }
167}
168
169/// This path corresponds to the 'content path' (the folder that contains the .git)
170#[derive(Clone, Debug, Ord, PartialOrd, Eq, PartialEq)]
171pub struct RepositoryWorkDirectory(pub(crate) Arc<Path>);
172
173impl Default for RepositoryWorkDirectory {
174 fn default() -> Self {
175 RepositoryWorkDirectory(Arc::from(Path::new("")))
176 }
177}
178
179impl AsRef<Path> for RepositoryWorkDirectory {
180 fn as_ref(&self) -> &Path {
181 self.0.as_ref()
182 }
183}
184
185#[derive(Clone, Debug, Ord, PartialOrd, Eq, PartialEq)]
186pub struct WorkDirectoryEntry(ProjectEntryId);
187
188impl WorkDirectoryEntry {
189 pub(crate) fn relativize(&self, worktree: &Snapshot, path: &Path) -> Option<RepoPath> {
190 worktree.entry_for_id(self.0).and_then(|entry| {
191 path.strip_prefix(&entry.path)
192 .ok()
193 .map(move |path| path.into())
194 })
195 }
196}
197
198impl Deref for WorkDirectoryEntry {
199 type Target = ProjectEntryId;
200
201 fn deref(&self) -> &Self::Target {
202 &self.0
203 }
204}
205
206impl<'a> From<ProjectEntryId> for WorkDirectoryEntry {
207 fn from(value: ProjectEntryId) -> Self {
208 WorkDirectoryEntry(value)
209 }
210}
211
212#[derive(Debug, Clone)]
213pub struct LocalSnapshot {
214 snapshot: Snapshot,
215 /// All of the gitignore files in the worktree, indexed by their relative path.
216 /// The boolean indicates whether the gitignore needs to be updated.
217 ignores_by_parent_abs_path: HashMap<Arc<Path>, (Arc<Gitignore>, bool)>,
218 /// All of the git repositories in the worktree, indexed by the project entry
219 /// id of their parent directory.
220 git_repositories: TreeMap<ProjectEntryId, LocalRepositoryEntry>,
221}
222
223struct BackgroundScannerState {
224 snapshot: LocalSnapshot,
225 scanned_dirs: HashSet<ProjectEntryId>,
226 path_prefixes_to_scan: HashSet<Arc<Path>>,
227 paths_to_scan: HashSet<Arc<Path>>,
228 /// The ids of all of the entries that were removed from the snapshot
229 /// as part of the current update. These entry ids may be re-used
230 /// if the same inode is discovered at a new path, or if the given
231 /// path is re-created after being deleted.
232 removed_entry_ids: HashMap<u64, ProjectEntryId>,
233 changed_paths: Vec<Arc<Path>>,
234 prev_snapshot: Snapshot,
235}
236
237#[derive(Debug, Clone)]
238pub struct LocalRepositoryEntry {
239 pub(crate) git_dir_scan_id: usize,
240 pub(crate) repo_ptr: Arc<Mutex<dyn GitRepository>>,
241 /// Path to the actual .git folder.
242 /// Note: if .git is a file, this points to the folder indicated by the .git file
243 pub(crate) git_dir_path: Arc<Path>,
244}
245
246impl Deref for LocalSnapshot {
247 type Target = Snapshot;
248
249 fn deref(&self) -> &Self::Target {
250 &self.snapshot
251 }
252}
253
254impl DerefMut for LocalSnapshot {
255 fn deref_mut(&mut self) -> &mut Self::Target {
256 &mut self.snapshot
257 }
258}
259
260enum ScanState {
261 Started,
262 Updated {
263 snapshot: LocalSnapshot,
264 changes: UpdatedEntriesSet,
265 barrier: Option<barrier::Sender>,
266 scanning: bool,
267 },
268}
269
270struct ShareState {
271 project_id: u64,
272 snapshots_tx:
273 mpsc::UnboundedSender<(LocalSnapshot, UpdatedEntriesSet, UpdatedGitRepositoriesSet)>,
274 resume_updates: watch::Sender<()>,
275 _maintain_remote_snapshot: Task<Option<()>>,
276}
277
278pub enum Event {
279 UpdatedEntries(UpdatedEntriesSet),
280 UpdatedGitRepositories(UpdatedGitRepositoriesSet),
281}
282
283impl EventEmitter for Worktree {
284 type Event = Event;
285}
286
287impl Worktree {
288 pub async fn local(
289 client: Arc<Client>,
290 path: impl Into<Arc<Path>>,
291 visible: bool,
292 fs: Arc<dyn Fs>,
293 next_entry_id: Arc<AtomicUsize>,
294 cx: &mut AsyncAppContext,
295 ) -> Result<Handle<Self>> {
296 // After determining whether the root entry is a file or a directory, populate the
297 // snapshot's "root name", which will be used for the purpose of fuzzy matching.
298 let abs_path = path.into();
299 let metadata = fs
300 .metadata(&abs_path)
301 .await
302 .context("failed to stat worktree path")?;
303
304 cx.entity(move |cx: &mut ModelContext<Worktree>| {
305 let root_name = abs_path
306 .file_name()
307 .map_or(String::new(), |f| f.to_string_lossy().to_string());
308
309 let mut snapshot = LocalSnapshot {
310 ignores_by_parent_abs_path: Default::default(),
311 git_repositories: Default::default(),
312 snapshot: Snapshot {
313 id: WorktreeId::from_usize(cx.entity_id().as_u64() as usize),
314 abs_path: abs_path.clone(),
315 root_name: root_name.clone(),
316 root_char_bag: root_name.chars().map(|c| c.to_ascii_lowercase()).collect(),
317 entries_by_path: Default::default(),
318 entries_by_id: Default::default(),
319 repository_entries: Default::default(),
320 scan_id: 1,
321 completed_scan_id: 0,
322 },
323 };
324
325 if let Some(metadata) = metadata {
326 snapshot.insert_entry(
327 Entry::new(
328 Arc::from(Path::new("")),
329 &metadata,
330 &next_entry_id,
331 snapshot.root_char_bag,
332 ),
333 fs.as_ref(),
334 );
335 }
336
337 let (scan_requests_tx, scan_requests_rx) = channel::unbounded();
338 let (path_prefixes_to_scan_tx, path_prefixes_to_scan_rx) = channel::unbounded();
339 let (scan_states_tx, mut scan_states_rx) = mpsc::unbounded();
340
341 cx.spawn(|this, mut cx| async move {
342 while let Some((state, this)) = scan_states_rx.next().await.zip(this.upgrade()) {
343 this.update(&mut cx, |this, cx| {
344 let this = this.as_local_mut().unwrap();
345 match state {
346 ScanState::Started => {
347 *this.is_scanning.0.borrow_mut() = true;
348 }
349 ScanState::Updated {
350 snapshot,
351 changes,
352 barrier,
353 scanning,
354 } => {
355 *this.is_scanning.0.borrow_mut() = scanning;
356 this.set_snapshot(snapshot, changes, cx);
357 drop(barrier);
358 }
359 }
360 cx.notify();
361 })
362 .ok();
363 }
364 })
365 .detach();
366
367 let background_scanner_task = cx.executor().spawn({
368 let fs = fs.clone();
369 let snapshot = snapshot.clone();
370 let background = cx.executor().clone();
371 async move {
372 let events = fs.watch(&abs_path, Duration::from_millis(100)).await;
373 BackgroundScanner::new(
374 snapshot,
375 next_entry_id,
376 fs,
377 scan_states_tx,
378 background,
379 scan_requests_rx,
380 path_prefixes_to_scan_rx,
381 )
382 .run(events)
383 .await;
384 }
385 });
386
387 Worktree::Local(LocalWorktree {
388 snapshot,
389 is_scanning: watch::channel_with(true),
390 share: None,
391 scan_requests_tx,
392 path_prefixes_to_scan_tx,
393 _background_scanner_task: background_scanner_task,
394 diagnostics: Default::default(),
395 diagnostic_summaries: Default::default(),
396 client,
397 fs,
398 visible,
399 })
400 })
401 }
402
403 pub fn remote(
404 project_remote_id: u64,
405 replica_id: ReplicaId,
406 worktree: proto::WorktreeMetadata,
407 client: Arc<Client>,
408 cx: &mut AppContext,
409 ) -> Handle<Self> {
410 cx.entity(|cx: &mut ModelContext<Self>| {
411 let snapshot = Snapshot {
412 id: WorktreeId(worktree.id as usize),
413 abs_path: Arc::from(PathBuf::from(worktree.abs_path)),
414 root_name: worktree.root_name.clone(),
415 root_char_bag: worktree
416 .root_name
417 .chars()
418 .map(|c| c.to_ascii_lowercase())
419 .collect(),
420 entries_by_path: Default::default(),
421 entries_by_id: Default::default(),
422 repository_entries: Default::default(),
423 scan_id: 1,
424 completed_scan_id: 0,
425 };
426
427 let (updates_tx, mut updates_rx) = mpsc::unbounded();
428 let background_snapshot = Arc::new(Mutex::new(snapshot.clone()));
429 let (mut snapshot_updated_tx, mut snapshot_updated_rx) = watch::channel();
430
431 cx.executor()
432 .spawn({
433 let background_snapshot = background_snapshot.clone();
434 async move {
435 while let Some(update) = updates_rx.next().await {
436 if let Err(error) =
437 background_snapshot.lock().apply_remote_update(update)
438 {
439 log::error!("error applying worktree update: {}", error);
440 }
441 snapshot_updated_tx.send(()).await.ok();
442 }
443 }
444 })
445 .detach();
446
447 cx.spawn(|this, mut cx| async move {
448 while (snapshot_updated_rx.recv().await).is_some() {
449 this.update(&mut cx, |this, cx| {
450 let this = this.as_remote_mut().unwrap();
451 this.snapshot = this.background_snapshot.lock().clone();
452 cx.emit(Event::UpdatedEntries(Arc::from([])));
453 cx.notify();
454 while let Some((scan_id, _)) = this.snapshot_subscriptions.front() {
455 if this.observed_snapshot(*scan_id) {
456 let (_, tx) = this.snapshot_subscriptions.pop_front().unwrap();
457 let _ = tx.send(());
458 } else {
459 break;
460 }
461 }
462 })?;
463 }
464 anyhow::Ok(())
465 })
466 .detach();
467
468 Worktree::Remote(RemoteWorktree {
469 project_id: project_remote_id,
470 replica_id,
471 snapshot: snapshot.clone(),
472 background_snapshot,
473 updates_tx: Some(updates_tx),
474 snapshot_subscriptions: Default::default(),
475 client: client.clone(),
476 diagnostic_summaries: Default::default(),
477 visible: worktree.visible,
478 disconnected: false,
479 })
480 })
481 }
482
483 pub fn as_local(&self) -> Option<&LocalWorktree> {
484 if let Worktree::Local(worktree) = self {
485 Some(worktree)
486 } else {
487 None
488 }
489 }
490
491 pub fn as_remote(&self) -> Option<&RemoteWorktree> {
492 if let Worktree::Remote(worktree) = self {
493 Some(worktree)
494 } else {
495 None
496 }
497 }
498
499 pub fn as_local_mut(&mut self) -> Option<&mut LocalWorktree> {
500 if let Worktree::Local(worktree) = self {
501 Some(worktree)
502 } else {
503 None
504 }
505 }
506
507 pub fn as_remote_mut(&mut self) -> Option<&mut RemoteWorktree> {
508 if let Worktree::Remote(worktree) = self {
509 Some(worktree)
510 } else {
511 None
512 }
513 }
514
515 pub fn is_local(&self) -> bool {
516 matches!(self, Worktree::Local(_))
517 }
518
519 pub fn is_remote(&self) -> bool {
520 !self.is_local()
521 }
522
523 pub fn snapshot(&self) -> Snapshot {
524 match self {
525 Worktree::Local(worktree) => worktree.snapshot().snapshot,
526 Worktree::Remote(worktree) => worktree.snapshot(),
527 }
528 }
529
530 pub fn scan_id(&self) -> usize {
531 match self {
532 Worktree::Local(worktree) => worktree.snapshot.scan_id,
533 Worktree::Remote(worktree) => worktree.snapshot.scan_id,
534 }
535 }
536
537 pub fn completed_scan_id(&self) -> usize {
538 match self {
539 Worktree::Local(worktree) => worktree.snapshot.completed_scan_id,
540 Worktree::Remote(worktree) => worktree.snapshot.completed_scan_id,
541 }
542 }
543
544 pub fn is_visible(&self) -> bool {
545 match self {
546 Worktree::Local(worktree) => worktree.visible,
547 Worktree::Remote(worktree) => worktree.visible,
548 }
549 }
550
551 pub fn replica_id(&self) -> ReplicaId {
552 match self {
553 Worktree::Local(_) => 0,
554 Worktree::Remote(worktree) => worktree.replica_id,
555 }
556 }
557
558 pub fn diagnostic_summaries(
559 &self,
560 ) -> impl Iterator<Item = (Arc<Path>, LanguageServerId, DiagnosticSummary)> + '_ {
561 match self {
562 Worktree::Local(worktree) => &worktree.diagnostic_summaries,
563 Worktree::Remote(worktree) => &worktree.diagnostic_summaries,
564 }
565 .iter()
566 .flat_map(|(path, summaries)| {
567 summaries
568 .iter()
569 .map(move |(&server_id, &summary)| (path.clone(), server_id, summary))
570 })
571 }
572
573 pub fn abs_path(&self) -> Arc<Path> {
574 match self {
575 Worktree::Local(worktree) => worktree.abs_path.clone(),
576 Worktree::Remote(worktree) => worktree.abs_path.clone(),
577 }
578 }
579
580 pub fn root_file(&self, cx: &mut ModelContext<Self>) -> Option<Arc<File>> {
581 let entry = self.root_entry()?;
582 Some(File::for_entry(entry.clone(), cx.handle()))
583 }
584}
585
586impl LocalWorktree {
587 pub fn contains_abs_path(&self, path: &Path) -> bool {
588 path.starts_with(&self.abs_path)
589 }
590
591 pub(crate) fn load_buffer(
592 &mut self,
593 id: u64,
594 path: &Path,
595 cx: &mut ModelContext<Worktree>,
596 ) -> Task<Result<Handle<Buffer>>> {
597 let path = Arc::from(path);
598 cx.spawn(move |this, mut cx| async move {
599 let (file, contents, diff_base) = this
600 .update(&mut cx, |t, cx| t.as_local().unwrap().load(&path, cx))?
601 .await?;
602 let text_buffer = cx
603 .executor()
604 .spawn(async move { text::Buffer::new(0, id, contents) })
605 .await;
606 cx.entity(|_| Buffer::build(text_buffer, diff_base, Some(Arc::new(file))))
607 })
608 }
609
610 pub fn diagnostics_for_path(
611 &self,
612 path: &Path,
613 ) -> Vec<(
614 LanguageServerId,
615 Vec<DiagnosticEntry<Unclipped<PointUtf16>>>,
616 )> {
617 self.diagnostics.get(path).cloned().unwrap_or_default()
618 }
619
620 pub fn clear_diagnostics_for_language_server(
621 &mut self,
622 server_id: LanguageServerId,
623 _: &mut ModelContext<Worktree>,
624 ) {
625 let worktree_id = self.id().to_proto();
626 self.diagnostic_summaries
627 .retain(|path, summaries_by_server_id| {
628 if summaries_by_server_id.remove(&server_id).is_some() {
629 if let Some(share) = self.share.as_ref() {
630 self.client
631 .send(proto::UpdateDiagnosticSummary {
632 project_id: share.project_id,
633 worktree_id,
634 summary: Some(proto::DiagnosticSummary {
635 path: path.to_string_lossy().to_string(),
636 language_server_id: server_id.0 as u64,
637 error_count: 0,
638 warning_count: 0,
639 }),
640 })
641 .log_err();
642 }
643 !summaries_by_server_id.is_empty()
644 } else {
645 true
646 }
647 });
648
649 self.diagnostics.retain(|_, diagnostics_by_server_id| {
650 if let Ok(ix) = diagnostics_by_server_id.binary_search_by_key(&server_id, |e| e.0) {
651 diagnostics_by_server_id.remove(ix);
652 !diagnostics_by_server_id.is_empty()
653 } else {
654 true
655 }
656 });
657 }
658
659 pub fn update_diagnostics(
660 &mut self,
661 server_id: LanguageServerId,
662 worktree_path: Arc<Path>,
663 diagnostics: Vec<DiagnosticEntry<Unclipped<PointUtf16>>>,
664 _: &mut ModelContext<Worktree>,
665 ) -> Result<bool> {
666 let summaries_by_server_id = self
667 .diagnostic_summaries
668 .entry(worktree_path.clone())
669 .or_default();
670
671 let old_summary = summaries_by_server_id
672 .remove(&server_id)
673 .unwrap_or_default();
674
675 let new_summary = DiagnosticSummary::new(&diagnostics);
676 if new_summary.is_empty() {
677 if let Some(diagnostics_by_server_id) = self.diagnostics.get_mut(&worktree_path) {
678 if let Ok(ix) = diagnostics_by_server_id.binary_search_by_key(&server_id, |e| e.0) {
679 diagnostics_by_server_id.remove(ix);
680 }
681 if diagnostics_by_server_id.is_empty() {
682 self.diagnostics.remove(&worktree_path);
683 }
684 }
685 } else {
686 summaries_by_server_id.insert(server_id, new_summary);
687 let diagnostics_by_server_id =
688 self.diagnostics.entry(worktree_path.clone()).or_default();
689 match diagnostics_by_server_id.binary_search_by_key(&server_id, |e| e.0) {
690 Ok(ix) => {
691 diagnostics_by_server_id[ix] = (server_id, diagnostics);
692 }
693 Err(ix) => {
694 diagnostics_by_server_id.insert(ix, (server_id, diagnostics));
695 }
696 }
697 }
698
699 if !old_summary.is_empty() || !new_summary.is_empty() {
700 if let Some(share) = self.share.as_ref() {
701 self.client
702 .send(proto::UpdateDiagnosticSummary {
703 project_id: share.project_id,
704 worktree_id: self.id().to_proto(),
705 summary: Some(proto::DiagnosticSummary {
706 path: worktree_path.to_string_lossy().to_string(),
707 language_server_id: server_id.0 as u64,
708 error_count: new_summary.error_count as u32,
709 warning_count: new_summary.warning_count as u32,
710 }),
711 })
712 .log_err();
713 }
714 }
715
716 Ok(!old_summary.is_empty() || !new_summary.is_empty())
717 }
718
719 fn set_snapshot(
720 &mut self,
721 new_snapshot: LocalSnapshot,
722 entry_changes: UpdatedEntriesSet,
723 cx: &mut ModelContext<Worktree>,
724 ) {
725 let repo_changes = self.changed_repos(&self.snapshot, &new_snapshot);
726
727 self.snapshot = new_snapshot;
728
729 if let Some(share) = self.share.as_mut() {
730 share
731 .snapshots_tx
732 .unbounded_send((
733 self.snapshot.clone(),
734 entry_changes.clone(),
735 repo_changes.clone(),
736 ))
737 .ok();
738 }
739
740 if !entry_changes.is_empty() {
741 cx.emit(Event::UpdatedEntries(entry_changes));
742 }
743 if !repo_changes.is_empty() {
744 cx.emit(Event::UpdatedGitRepositories(repo_changes));
745 }
746 }
747
748 fn changed_repos(
749 &self,
750 old_snapshot: &LocalSnapshot,
751 new_snapshot: &LocalSnapshot,
752 ) -> UpdatedGitRepositoriesSet {
753 let mut changes = Vec::new();
754 let mut old_repos = old_snapshot.git_repositories.iter().peekable();
755 let mut new_repos = new_snapshot.git_repositories.iter().peekable();
756 loop {
757 match (new_repos.peek().map(clone), old_repos.peek().map(clone)) {
758 (Some((new_entry_id, new_repo)), Some((old_entry_id, old_repo))) => {
759 match Ord::cmp(&new_entry_id, &old_entry_id) {
760 Ordering::Less => {
761 if let Some(entry) = new_snapshot.entry_for_id(new_entry_id) {
762 changes.push((
763 entry.path.clone(),
764 GitRepositoryChange {
765 old_repository: None,
766 },
767 ));
768 }
769 new_repos.next();
770 }
771 Ordering::Equal => {
772 if new_repo.git_dir_scan_id != old_repo.git_dir_scan_id {
773 if let Some(entry) = new_snapshot.entry_for_id(new_entry_id) {
774 let old_repo = old_snapshot
775 .repository_entries
776 .get(&RepositoryWorkDirectory(entry.path.clone()))
777 .cloned();
778 changes.push((
779 entry.path.clone(),
780 GitRepositoryChange {
781 old_repository: old_repo,
782 },
783 ));
784 }
785 }
786 new_repos.next();
787 old_repos.next();
788 }
789 Ordering::Greater => {
790 if let Some(entry) = old_snapshot.entry_for_id(old_entry_id) {
791 let old_repo = old_snapshot
792 .repository_entries
793 .get(&RepositoryWorkDirectory(entry.path.clone()))
794 .cloned();
795 changes.push((
796 entry.path.clone(),
797 GitRepositoryChange {
798 old_repository: old_repo,
799 },
800 ));
801 }
802 old_repos.next();
803 }
804 }
805 }
806 (Some((entry_id, _)), None) => {
807 if let Some(entry) = new_snapshot.entry_for_id(entry_id) {
808 changes.push((
809 entry.path.clone(),
810 GitRepositoryChange {
811 old_repository: None,
812 },
813 ));
814 }
815 new_repos.next();
816 }
817 (None, Some((entry_id, _))) => {
818 if let Some(entry) = old_snapshot.entry_for_id(entry_id) {
819 let old_repo = old_snapshot
820 .repository_entries
821 .get(&RepositoryWorkDirectory(entry.path.clone()))
822 .cloned();
823 changes.push((
824 entry.path.clone(),
825 GitRepositoryChange {
826 old_repository: old_repo,
827 },
828 ));
829 }
830 old_repos.next();
831 }
832 (None, None) => break,
833 }
834 }
835
836 fn clone<T: Clone, U: Clone>(value: &(&T, &U)) -> (T, U) {
837 (value.0.clone(), value.1.clone())
838 }
839
840 changes.into()
841 }
842
843 pub fn scan_complete(&self) -> impl Future<Output = ()> {
844 let mut is_scanning_rx = self.is_scanning.1.clone();
845 async move {
846 let mut is_scanning = is_scanning_rx.borrow().clone();
847 while is_scanning {
848 if let Some(value) = is_scanning_rx.recv().await {
849 is_scanning = value;
850 } else {
851 break;
852 }
853 }
854 }
855 }
856
857 pub fn snapshot(&self) -> LocalSnapshot {
858 self.snapshot.clone()
859 }
860
861 pub fn metadata_proto(&self) -> proto::WorktreeMetadata {
862 proto::WorktreeMetadata {
863 id: self.id().to_proto(),
864 root_name: self.root_name().to_string(),
865 visible: self.visible,
866 abs_path: self.abs_path().as_os_str().to_string_lossy().into(),
867 }
868 }
869
870 fn load(
871 &self,
872 path: &Path,
873 cx: &mut ModelContext<Worktree>,
874 ) -> Task<Result<(File, String, Option<String>)>> {
875 let path = Arc::from(path);
876 let abs_path = self.absolutize(&path);
877 let fs = self.fs.clone();
878 let entry = self.refresh_entry(path.clone(), None, cx);
879
880 cx.spawn(|this, mut cx| async move {
881 let text = fs.load(&abs_path).await?;
882 let entry = entry.await?;
883
884 let mut index_task = None;
885 let snapshot = this.update(&mut cx, |this, _| this.as_local().unwrap().snapshot())?;
886 if let Some(repo) = snapshot.repository_for_path(&path) {
887 let repo_path = repo.work_directory.relativize(&snapshot, &path).unwrap();
888 if let Some(repo) = snapshot.git_repositories.get(&*repo.work_directory) {
889 let repo = repo.repo_ptr.clone();
890 index_task = Some(
891 cx.executor()
892 .spawn(async move { repo.lock().load_index_text(&repo_path) }),
893 );
894 }
895 }
896
897 let diff_base = if let Some(index_task) = index_task {
898 index_task.await
899 } else {
900 None
901 };
902
903 let worktree = this
904 .upgrade()
905 .ok_or_else(|| anyhow!("worktree was dropped"))?;
906 Ok((
907 File {
908 entry_id: entry.id,
909 worktree,
910 path: entry.path,
911 mtime: entry.mtime,
912 is_local: true,
913 is_deleted: false,
914 },
915 text,
916 diff_base,
917 ))
918 })
919 }
920
921 pub fn save_buffer(
922 &self,
923 buffer_handle: Handle<Buffer>,
924 path: Arc<Path>,
925 has_changed_file: bool,
926 cx: &mut ModelContext<Worktree>,
927 ) -> Task<Result<()>> {
928 let buffer = buffer_handle.read(cx);
929
930 let rpc = self.client.clone();
931 let buffer_id = buffer.remote_id();
932 let project_id = self.share.as_ref().map(|share| share.project_id);
933
934 let text = buffer.as_rope().clone();
935 let fingerprint = text.fingerprint();
936 let version = buffer.version();
937 let save = self.write_file(path, text, buffer.line_ending(), cx);
938
939 cx.spawn(move |this, mut cx| async move {
940 let entry = save.await?;
941 let this = this.upgrade().context("worktree dropped")?;
942
943 if has_changed_file {
944 let new_file = Arc::new(File {
945 entry_id: entry.id,
946 worktree: this,
947 path: entry.path,
948 mtime: entry.mtime,
949 is_local: true,
950 is_deleted: false,
951 });
952
953 if let Some(project_id) = project_id {
954 rpc.send(proto::UpdateBufferFile {
955 project_id,
956 buffer_id,
957 file: Some(new_file.to_proto()),
958 })
959 .log_err();
960 }
961
962 buffer_handle.update(&mut cx, |buffer, cx| {
963 if has_changed_file {
964 buffer.file_updated(new_file, cx).detach();
965 }
966 })?;
967 }
968
969 if let Some(project_id) = project_id {
970 rpc.send(proto::BufferSaved {
971 project_id,
972 buffer_id,
973 version: serialize_version(&version),
974 mtime: Some(entry.mtime.into()),
975 fingerprint: serialize_fingerprint(fingerprint),
976 })?;
977 }
978
979 buffer_handle.update(&mut cx, |buffer, cx| {
980 buffer.did_save(version.clone(), fingerprint, entry.mtime, cx);
981 })?;
982
983 Ok(())
984 })
985 }
986
987 /// Find the lowest path in the worktree's datastructures that is an ancestor
988 fn lowest_ancestor(&self, path: &Path) -> PathBuf {
989 let mut lowest_ancestor = None;
990 for path in path.ancestors() {
991 if self.entry_for_path(path).is_some() {
992 lowest_ancestor = Some(path.to_path_buf());
993 break;
994 }
995 }
996
997 lowest_ancestor.unwrap_or_else(|| PathBuf::from(""))
998 }
999
1000 pub fn create_entry(
1001 &self,
1002 path: impl Into<Arc<Path>>,
1003 is_dir: bool,
1004 cx: &mut ModelContext<Worktree>,
1005 ) -> Task<Result<Entry>> {
1006 let path = path.into();
1007 let lowest_ancestor = self.lowest_ancestor(&path);
1008 let abs_path = self.absolutize(&path);
1009 let fs = self.fs.clone();
1010 let write = cx.executor().spawn(async move {
1011 if is_dir {
1012 fs.create_dir(&abs_path).await
1013 } else {
1014 fs.save(&abs_path, &Default::default(), Default::default())
1015 .await
1016 }
1017 });
1018
1019 cx.spawn(|this, mut cx| async move {
1020 write.await?;
1021 let (result, refreshes) = this.update(&mut cx, |this, cx| {
1022 let mut refreshes = Vec::<Task<anyhow::Result<Entry>>>::new();
1023 let refresh_paths = path.strip_prefix(&lowest_ancestor).unwrap();
1024 for refresh_path in refresh_paths.ancestors() {
1025 if refresh_path == Path::new("") {
1026 continue;
1027 }
1028 let refresh_full_path = lowest_ancestor.join(refresh_path);
1029
1030 refreshes.push(this.as_local_mut().unwrap().refresh_entry(
1031 refresh_full_path.into(),
1032 None,
1033 cx,
1034 ));
1035 }
1036 (
1037 this.as_local_mut().unwrap().refresh_entry(path, None, cx),
1038 refreshes,
1039 )
1040 })?;
1041 for refresh in refreshes {
1042 refresh.await.log_err();
1043 }
1044
1045 result.await
1046 })
1047 }
1048
1049 pub fn write_file(
1050 &self,
1051 path: impl Into<Arc<Path>>,
1052 text: Rope,
1053 line_ending: LineEnding,
1054 cx: &mut ModelContext<Worktree>,
1055 ) -> Task<Result<Entry>> {
1056 let path = path.into();
1057 let abs_path = self.absolutize(&path);
1058 let fs = self.fs.clone();
1059 let write = cx
1060 .executor()
1061 .spawn(async move { fs.save(&abs_path, &text, line_ending).await });
1062
1063 cx.spawn(|this, mut cx| async move {
1064 write.await?;
1065 this.update(&mut cx, |this, cx| {
1066 this.as_local_mut().unwrap().refresh_entry(path, None, cx)
1067 })?
1068 .await
1069 })
1070 }
1071
1072 pub fn delete_entry(
1073 &self,
1074 entry_id: ProjectEntryId,
1075 cx: &mut ModelContext<Worktree>,
1076 ) -> Option<Task<Result<()>>> {
1077 let entry = self.entry_for_id(entry_id)?.clone();
1078 let abs_path = self.absolutize(&entry.path);
1079 let fs = self.fs.clone();
1080
1081 let delete = cx.executor().spawn(async move {
1082 if entry.is_file() {
1083 fs.remove_file(&abs_path, Default::default()).await?;
1084 } else {
1085 fs.remove_dir(
1086 &abs_path,
1087 RemoveOptions {
1088 recursive: true,
1089 ignore_if_not_exists: false,
1090 },
1091 )
1092 .await?;
1093 }
1094 anyhow::Ok(entry.path)
1095 });
1096
1097 Some(cx.spawn(|this, mut cx| async move {
1098 let path = delete.await?;
1099 this.update(&mut cx, |this, _| {
1100 this.as_local_mut()
1101 .unwrap()
1102 .refresh_entries_for_paths(vec![path])
1103 })?
1104 .recv()
1105 .await;
1106 Ok(())
1107 }))
1108 }
1109
1110 pub fn rename_entry(
1111 &self,
1112 entry_id: ProjectEntryId,
1113 new_path: impl Into<Arc<Path>>,
1114 cx: &mut ModelContext<Worktree>,
1115 ) -> Option<Task<Result<Entry>>> {
1116 let old_path = self.entry_for_id(entry_id)?.path.clone();
1117 let new_path = new_path.into();
1118 let abs_old_path = self.absolutize(&old_path);
1119 let abs_new_path = self.absolutize(&new_path);
1120 let fs = self.fs.clone();
1121 let rename = cx.executor().spawn(async move {
1122 fs.rename(&abs_old_path, &abs_new_path, Default::default())
1123 .await
1124 });
1125
1126 Some(cx.spawn(|this, mut cx| async move {
1127 rename.await?;
1128 this.update(&mut cx, |this, cx| {
1129 this.as_local_mut()
1130 .unwrap()
1131 .refresh_entry(new_path.clone(), Some(old_path), cx)
1132 })?
1133 .await
1134 }))
1135 }
1136
1137 pub fn copy_entry(
1138 &self,
1139 entry_id: ProjectEntryId,
1140 new_path: impl Into<Arc<Path>>,
1141 cx: &mut ModelContext<Worktree>,
1142 ) -> Option<Task<Result<Entry>>> {
1143 let old_path = self.entry_for_id(entry_id)?.path.clone();
1144 let new_path = new_path.into();
1145 let abs_old_path = self.absolutize(&old_path);
1146 let abs_new_path = self.absolutize(&new_path);
1147 let fs = self.fs.clone();
1148 let copy = cx.executor().spawn(async move {
1149 copy_recursive(
1150 fs.as_ref(),
1151 &abs_old_path,
1152 &abs_new_path,
1153 Default::default(),
1154 )
1155 .await
1156 });
1157
1158 Some(cx.spawn(|this, mut cx| async move {
1159 copy.await?;
1160 this.update(&mut cx, |this, cx| {
1161 this.as_local_mut()
1162 .unwrap()
1163 .refresh_entry(new_path.clone(), None, cx)
1164 })?
1165 .await
1166 }))
1167 }
1168
1169 pub fn expand_entry(
1170 &mut self,
1171 entry_id: ProjectEntryId,
1172 cx: &mut ModelContext<Worktree>,
1173 ) -> Option<Task<Result<()>>> {
1174 let path = self.entry_for_id(entry_id)?.path.clone();
1175 let mut refresh = self.refresh_entries_for_paths(vec![path]);
1176 Some(cx.executor().spawn(async move {
1177 refresh.next().await;
1178 Ok(())
1179 }))
1180 }
1181
1182 pub fn refresh_entries_for_paths(&self, paths: Vec<Arc<Path>>) -> barrier::Receiver {
1183 let (tx, rx) = barrier::channel();
1184 self.scan_requests_tx
1185 .try_send(ScanRequest {
1186 relative_paths: paths,
1187 done: tx,
1188 })
1189 .ok();
1190 rx
1191 }
1192
1193 pub fn add_path_prefix_to_scan(&self, path_prefix: Arc<Path>) {
1194 self.path_prefixes_to_scan_tx.try_send(path_prefix).ok();
1195 }
1196
1197 fn refresh_entry(
1198 &self,
1199 path: Arc<Path>,
1200 old_path: Option<Arc<Path>>,
1201 cx: &mut ModelContext<Worktree>,
1202 ) -> Task<Result<Entry>> {
1203 let paths = if let Some(old_path) = old_path.as_ref() {
1204 vec![old_path.clone(), path.clone()]
1205 } else {
1206 vec![path.clone()]
1207 };
1208 let mut refresh = self.refresh_entries_for_paths(paths);
1209 cx.spawn(move |this, mut cx| async move {
1210 refresh.recv().await;
1211 this.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.entity_id().as_u64();
1250 let _maintain_remote_snapshot = cx.executor().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.entity_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.executor()
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: Handle<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.spawn(move |_, 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(move |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 #[allow(dead_code)] // todo!("remove this when we use it")
2056 #[cfg(test)]
2057 pub(crate) fn expanded_entries(&self) -> impl Iterator<Item = &Entry> {
2058 self.entries_by_path
2059 .cursor::<()>()
2060 .filter(|entry| entry.kind == EntryKind::Dir && (entry.is_external || entry.is_ignored))
2061 }
2062
2063 #[cfg(test)]
2064 pub fn check_invariants(&self, git_state: bool) {
2065 use pretty_assertions::assert_eq;
2066
2067 assert_eq!(
2068 self.entries_by_path
2069 .cursor::<()>()
2070 .map(|e| (&e.path, e.id))
2071 .collect::<Vec<_>>(),
2072 self.entries_by_id
2073 .cursor::<()>()
2074 .map(|e| (&e.path, e.id))
2075 .collect::<collections::BTreeSet<_>>()
2076 .into_iter()
2077 .collect::<Vec<_>>(),
2078 "entries_by_path and entries_by_id are inconsistent"
2079 );
2080
2081 let mut files = self.files(true, 0);
2082 let mut visible_files = self.files(false, 0);
2083 for entry in self.entries_by_path.cursor::<()>() {
2084 if entry.is_file() {
2085 assert_eq!(files.next().unwrap().inode, entry.inode);
2086 if !entry.is_ignored && !entry.is_external {
2087 assert_eq!(visible_files.next().unwrap().inode, entry.inode);
2088 }
2089 }
2090 }
2091
2092 assert!(files.next().is_none());
2093 assert!(visible_files.next().is_none());
2094
2095 let mut bfs_paths = Vec::new();
2096 let mut stack = self
2097 .root_entry()
2098 .map(|e| e.path.as_ref())
2099 .into_iter()
2100 .collect::<Vec<_>>();
2101 while let Some(path) = stack.pop() {
2102 bfs_paths.push(path);
2103 let ix = stack.len();
2104 for child_entry in self.child_entries(path) {
2105 stack.insert(ix, &child_entry.path);
2106 }
2107 }
2108
2109 let dfs_paths_via_iter = self
2110 .entries_by_path
2111 .cursor::<()>()
2112 .map(|e| e.path.as_ref())
2113 .collect::<Vec<_>>();
2114 assert_eq!(bfs_paths, dfs_paths_via_iter);
2115
2116 let dfs_paths_via_traversal = self
2117 .entries(true)
2118 .map(|e| e.path.as_ref())
2119 .collect::<Vec<_>>();
2120 assert_eq!(dfs_paths_via_traversal, dfs_paths_via_iter);
2121
2122 if git_state {
2123 for ignore_parent_abs_path in self.ignores_by_parent_abs_path.keys() {
2124 let ignore_parent_path =
2125 ignore_parent_abs_path.strip_prefix(&self.abs_path).unwrap();
2126 assert!(self.entry_for_path(&ignore_parent_path).is_some());
2127 assert!(self
2128 .entry_for_path(ignore_parent_path.join(&*GITIGNORE))
2129 .is_some());
2130 }
2131 }
2132 }
2133
2134 #[cfg(test)]
2135 pub fn entries_without_ids(&self, include_ignored: bool) -> Vec<(&Path, u64, bool)> {
2136 let mut paths = Vec::new();
2137 for entry in self.entries_by_path.cursor::<()>() {
2138 if include_ignored || !entry.is_ignored {
2139 paths.push((entry.path.as_ref(), entry.inode, entry.is_ignored));
2140 }
2141 }
2142 paths.sort_by(|a, b| a.0.cmp(b.0));
2143 paths
2144 }
2145}
2146
2147impl BackgroundScannerState {
2148 fn should_scan_directory(&self, entry: &Entry) -> bool {
2149 (!entry.is_external && !entry.is_ignored)
2150 || entry.path.file_name() == Some(&*DOT_GIT)
2151 || self.scanned_dirs.contains(&entry.id) // If we've ever scanned it, keep scanning
2152 || self
2153 .paths_to_scan
2154 .iter()
2155 .any(|p| p.starts_with(&entry.path))
2156 || self
2157 .path_prefixes_to_scan
2158 .iter()
2159 .any(|p| entry.path.starts_with(p))
2160 }
2161
2162 fn enqueue_scan_dir(&self, abs_path: Arc<Path>, entry: &Entry, scan_job_tx: &Sender<ScanJob>) {
2163 let path = entry.path.clone();
2164 let ignore_stack = self.snapshot.ignore_stack_for_abs_path(&abs_path, true);
2165 let mut ancestor_inodes = self.snapshot.ancestor_inodes_for_path(&path);
2166 let mut containing_repository = None;
2167 if !ignore_stack.is_all() {
2168 if let Some((workdir_path, repo)) = self.snapshot.local_repo_for_path(&path) {
2169 if let Ok(repo_path) = path.strip_prefix(&workdir_path.0) {
2170 containing_repository = Some((
2171 workdir_path,
2172 repo.repo_ptr.clone(),
2173 repo.repo_ptr.lock().staged_statuses(repo_path),
2174 ));
2175 }
2176 }
2177 }
2178 if !ancestor_inodes.contains(&entry.inode) {
2179 ancestor_inodes.insert(entry.inode);
2180 scan_job_tx
2181 .try_send(ScanJob {
2182 abs_path,
2183 path,
2184 ignore_stack,
2185 scan_queue: scan_job_tx.clone(),
2186 ancestor_inodes,
2187 is_external: entry.is_external,
2188 containing_repository,
2189 })
2190 .unwrap();
2191 }
2192 }
2193
2194 fn reuse_entry_id(&mut self, entry: &mut Entry) {
2195 if let Some(removed_entry_id) = self.removed_entry_ids.remove(&entry.inode) {
2196 entry.id = removed_entry_id;
2197 } else if let Some(existing_entry) = self.snapshot.entry_for_path(&entry.path) {
2198 entry.id = existing_entry.id;
2199 }
2200 }
2201
2202 fn insert_entry(&mut self, mut entry: Entry, fs: &dyn Fs) -> Entry {
2203 self.reuse_entry_id(&mut entry);
2204 let entry = self.snapshot.insert_entry(entry, fs);
2205 if entry.path.file_name() == Some(&DOT_GIT) {
2206 self.build_git_repository(entry.path.clone(), fs);
2207 }
2208
2209 #[cfg(test)]
2210 self.snapshot.check_invariants(false);
2211
2212 entry
2213 }
2214
2215 fn populate_dir(
2216 &mut self,
2217 parent_path: &Arc<Path>,
2218 entries: impl IntoIterator<Item = Entry>,
2219 ignore: Option<Arc<Gitignore>>,
2220 ) {
2221 let mut parent_entry = if let Some(parent_entry) = self
2222 .snapshot
2223 .entries_by_path
2224 .get(&PathKey(parent_path.clone()), &())
2225 {
2226 parent_entry.clone()
2227 } else {
2228 log::warn!(
2229 "populating a directory {:?} that has been removed",
2230 parent_path
2231 );
2232 return;
2233 };
2234
2235 match parent_entry.kind {
2236 EntryKind::PendingDir | EntryKind::UnloadedDir => parent_entry.kind = EntryKind::Dir,
2237 EntryKind::Dir => {}
2238 _ => return,
2239 }
2240
2241 if let Some(ignore) = ignore {
2242 let abs_parent_path = self.snapshot.abs_path.join(&parent_path).into();
2243 self.snapshot
2244 .ignores_by_parent_abs_path
2245 .insert(abs_parent_path, (ignore, false));
2246 }
2247
2248 let parent_entry_id = parent_entry.id;
2249 self.scanned_dirs.insert(parent_entry_id);
2250 let mut entries_by_path_edits = vec![Edit::Insert(parent_entry)];
2251 let mut entries_by_id_edits = Vec::new();
2252
2253 for entry in entries {
2254 entries_by_id_edits.push(Edit::Insert(PathEntry {
2255 id: entry.id,
2256 path: entry.path.clone(),
2257 is_ignored: entry.is_ignored,
2258 scan_id: self.snapshot.scan_id,
2259 }));
2260 entries_by_path_edits.push(Edit::Insert(entry));
2261 }
2262
2263 self.snapshot
2264 .entries_by_path
2265 .edit(entries_by_path_edits, &());
2266 self.snapshot.entries_by_id.edit(entries_by_id_edits, &());
2267
2268 if let Err(ix) = self.changed_paths.binary_search(parent_path) {
2269 self.changed_paths.insert(ix, parent_path.clone());
2270 }
2271
2272 #[cfg(test)]
2273 self.snapshot.check_invariants(false);
2274 }
2275
2276 fn remove_path(&mut self, path: &Path) {
2277 let mut new_entries;
2278 let removed_entries;
2279 {
2280 let mut cursor = self.snapshot.entries_by_path.cursor::<TraversalProgress>();
2281 new_entries = cursor.slice(&TraversalTarget::Path(path), Bias::Left, &());
2282 removed_entries = cursor.slice(&TraversalTarget::PathSuccessor(path), Bias::Left, &());
2283 new_entries.append(cursor.suffix(&()), &());
2284 }
2285 self.snapshot.entries_by_path = new_entries;
2286
2287 let mut entries_by_id_edits = Vec::new();
2288 for entry in removed_entries.cursor::<()>() {
2289 let removed_entry_id = self
2290 .removed_entry_ids
2291 .entry(entry.inode)
2292 .or_insert(entry.id);
2293 *removed_entry_id = cmp::max(*removed_entry_id, entry.id);
2294 entries_by_id_edits.push(Edit::Remove(entry.id));
2295 }
2296 self.snapshot.entries_by_id.edit(entries_by_id_edits, &());
2297
2298 if path.file_name() == Some(&GITIGNORE) {
2299 let abs_parent_path = self.snapshot.abs_path.join(path.parent().unwrap());
2300 if let Some((_, needs_update)) = self
2301 .snapshot
2302 .ignores_by_parent_abs_path
2303 .get_mut(abs_parent_path.as_path())
2304 {
2305 *needs_update = true;
2306 }
2307 }
2308
2309 #[cfg(test)]
2310 self.snapshot.check_invariants(false);
2311 }
2312
2313 fn reload_repositories(&mut self, changed_paths: &[Arc<Path>], fs: &dyn Fs) {
2314 let scan_id = self.snapshot.scan_id;
2315
2316 // Find each of the .git directories that contain any of the given paths.
2317 let mut prev_dot_git_dir = None;
2318 for changed_path in changed_paths {
2319 let Some(dot_git_dir) = changed_path
2320 .ancestors()
2321 .find(|ancestor| ancestor.file_name() == Some(&*DOT_GIT))
2322 else {
2323 continue;
2324 };
2325
2326 // Avoid processing the same repository multiple times, if multiple paths
2327 // within it have changed.
2328 if prev_dot_git_dir == Some(dot_git_dir) {
2329 continue;
2330 }
2331 prev_dot_git_dir = Some(dot_git_dir);
2332
2333 // If there is already a repository for this .git directory, reload
2334 // the status for all of its files.
2335 let repository = self
2336 .snapshot
2337 .git_repositories
2338 .iter()
2339 .find_map(|(entry_id, repo)| {
2340 (repo.git_dir_path.as_ref() == dot_git_dir).then(|| (*entry_id, repo.clone()))
2341 });
2342 match repository {
2343 None => {
2344 self.build_git_repository(dot_git_dir.into(), fs);
2345 }
2346 Some((entry_id, repository)) => {
2347 if repository.git_dir_scan_id == scan_id {
2348 continue;
2349 }
2350 let Some(work_dir) = self
2351 .snapshot
2352 .entry_for_id(entry_id)
2353 .map(|entry| RepositoryWorkDirectory(entry.path.clone()))
2354 else {
2355 continue;
2356 };
2357
2358 log::info!("reload git repository {:?}", dot_git_dir);
2359 let repository = repository.repo_ptr.lock();
2360 let branch = repository.branch_name();
2361 repository.reload_index();
2362
2363 self.snapshot
2364 .git_repositories
2365 .update(&entry_id, |entry| entry.git_dir_scan_id = scan_id);
2366 self.snapshot
2367 .snapshot
2368 .repository_entries
2369 .update(&work_dir, |entry| entry.branch = branch.map(Into::into));
2370
2371 self.update_git_statuses(&work_dir, &*repository);
2372 }
2373 }
2374 }
2375
2376 // Remove any git repositories whose .git entry no longer exists.
2377 let snapshot = &mut self.snapshot;
2378 let mut repositories = mem::take(&mut snapshot.git_repositories);
2379 let mut repository_entries = mem::take(&mut snapshot.repository_entries);
2380 repositories.retain(|work_directory_id, _| {
2381 snapshot
2382 .entry_for_id(*work_directory_id)
2383 .map_or(false, |entry| {
2384 snapshot.entry_for_path(entry.path.join(*DOT_GIT)).is_some()
2385 })
2386 });
2387 repository_entries.retain(|_, entry| repositories.get(&entry.work_directory.0).is_some());
2388 snapshot.git_repositories = repositories;
2389 snapshot.repository_entries = repository_entries;
2390 }
2391
2392 fn build_git_repository(
2393 &mut self,
2394 dot_git_path: Arc<Path>,
2395 fs: &dyn Fs,
2396 ) -> Option<(
2397 RepositoryWorkDirectory,
2398 Arc<Mutex<dyn GitRepository>>,
2399 TreeMap<RepoPath, GitFileStatus>,
2400 )> {
2401 log::info!("build git repository {:?}", dot_git_path);
2402
2403 let work_dir_path: Arc<Path> = dot_git_path.parent().unwrap().into();
2404
2405 // Guard against repositories inside the repository metadata
2406 if work_dir_path.iter().any(|component| component == *DOT_GIT) {
2407 return None;
2408 };
2409
2410 let work_dir_id = self
2411 .snapshot
2412 .entry_for_path(work_dir_path.clone())
2413 .map(|entry| entry.id)?;
2414
2415 if self.snapshot.git_repositories.get(&work_dir_id).is_some() {
2416 return None;
2417 }
2418
2419 let abs_path = self.snapshot.abs_path.join(&dot_git_path);
2420 let repository = fs.open_repo(abs_path.as_path())?;
2421 let work_directory = RepositoryWorkDirectory(work_dir_path.clone());
2422
2423 let repo_lock = repository.lock();
2424 self.snapshot.repository_entries.insert(
2425 work_directory.clone(),
2426 RepositoryEntry {
2427 work_directory: work_dir_id.into(),
2428 branch: repo_lock.branch_name().map(Into::into),
2429 },
2430 );
2431
2432 let staged_statuses = self.update_git_statuses(&work_directory, &*repo_lock);
2433 drop(repo_lock);
2434
2435 self.snapshot.git_repositories.insert(
2436 work_dir_id,
2437 LocalRepositoryEntry {
2438 git_dir_scan_id: 0,
2439 repo_ptr: repository.clone(),
2440 git_dir_path: dot_git_path.clone(),
2441 },
2442 );
2443
2444 Some((work_directory, repository, staged_statuses))
2445 }
2446
2447 fn update_git_statuses(
2448 &mut self,
2449 work_directory: &RepositoryWorkDirectory,
2450 repo: &dyn GitRepository,
2451 ) -> TreeMap<RepoPath, GitFileStatus> {
2452 let staged_statuses = repo.staged_statuses(Path::new(""));
2453
2454 let mut changes = vec![];
2455 let mut edits = vec![];
2456
2457 for mut entry in self
2458 .snapshot
2459 .descendent_entries(false, false, &work_directory.0)
2460 .cloned()
2461 {
2462 let Ok(repo_path) = entry.path.strip_prefix(&work_directory.0) else {
2463 continue;
2464 };
2465 let repo_path = RepoPath(repo_path.to_path_buf());
2466 let git_file_status = combine_git_statuses(
2467 staged_statuses.get(&repo_path).copied(),
2468 repo.unstaged_status(&repo_path, entry.mtime),
2469 );
2470 if entry.git_status != git_file_status {
2471 entry.git_status = git_file_status;
2472 changes.push(entry.path.clone());
2473 edits.push(Edit::Insert(entry));
2474 }
2475 }
2476
2477 self.snapshot.entries_by_path.edit(edits, &());
2478 util::extend_sorted(&mut self.changed_paths, changes, usize::MAX, Ord::cmp);
2479 staged_statuses
2480 }
2481}
2482
2483async fn build_gitignore(abs_path: &Path, fs: &dyn Fs) -> Result<Gitignore> {
2484 let contents = fs.load(abs_path).await?;
2485 let parent = abs_path.parent().unwrap_or_else(|| Path::new("/"));
2486 let mut builder = GitignoreBuilder::new(parent);
2487 for line in contents.lines() {
2488 builder.add_line(Some(abs_path.into()), line)?;
2489 }
2490 Ok(builder.build()?)
2491}
2492
2493impl WorktreeId {
2494 pub fn from_usize(handle_id: usize) -> Self {
2495 Self(handle_id)
2496 }
2497
2498 pub(crate) fn from_proto(id: u64) -> Self {
2499 Self(id as usize)
2500 }
2501
2502 pub fn to_proto(&self) -> u64 {
2503 self.0 as u64
2504 }
2505
2506 pub fn to_usize(&self) -> usize {
2507 self.0
2508 }
2509}
2510
2511impl fmt::Display for WorktreeId {
2512 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2513 self.0.fmt(f)
2514 }
2515}
2516
2517impl Deref for Worktree {
2518 type Target = Snapshot;
2519
2520 fn deref(&self) -> &Self::Target {
2521 match self {
2522 Worktree::Local(worktree) => &worktree.snapshot,
2523 Worktree::Remote(worktree) => &worktree.snapshot,
2524 }
2525 }
2526}
2527
2528impl Deref for LocalWorktree {
2529 type Target = LocalSnapshot;
2530
2531 fn deref(&self) -> &Self::Target {
2532 &self.snapshot
2533 }
2534}
2535
2536impl Deref for RemoteWorktree {
2537 type Target = Snapshot;
2538
2539 fn deref(&self) -> &Self::Target {
2540 &self.snapshot
2541 }
2542}
2543
2544impl fmt::Debug for LocalWorktree {
2545 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2546 self.snapshot.fmt(f)
2547 }
2548}
2549
2550impl fmt::Debug for Snapshot {
2551 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2552 struct EntriesById<'a>(&'a SumTree<PathEntry>);
2553 struct EntriesByPath<'a>(&'a SumTree<Entry>);
2554
2555 impl<'a> fmt::Debug for EntriesByPath<'a> {
2556 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2557 f.debug_map()
2558 .entries(self.0.iter().map(|entry| (&entry.path, entry.id)))
2559 .finish()
2560 }
2561 }
2562
2563 impl<'a> fmt::Debug for EntriesById<'a> {
2564 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2565 f.debug_list().entries(self.0.iter()).finish()
2566 }
2567 }
2568
2569 f.debug_struct("Snapshot")
2570 .field("id", &self.id)
2571 .field("root_name", &self.root_name)
2572 .field("entries_by_path", &EntriesByPath(&self.entries_by_path))
2573 .field("entries_by_id", &EntriesById(&self.entries_by_id))
2574 .finish()
2575 }
2576}
2577
2578#[derive(Clone, PartialEq)]
2579pub struct File {
2580 pub worktree: Handle<Worktree>,
2581 pub path: Arc<Path>,
2582 pub mtime: SystemTime,
2583 pub(crate) entry_id: ProjectEntryId,
2584 pub(crate) is_local: bool,
2585 pub(crate) is_deleted: bool,
2586}
2587
2588impl language2::File for File {
2589 fn as_local(&self) -> Option<&dyn language2::LocalFile> {
2590 if self.is_local {
2591 Some(self)
2592 } else {
2593 None
2594 }
2595 }
2596
2597 fn mtime(&self) -> SystemTime {
2598 self.mtime
2599 }
2600
2601 fn path(&self) -> &Arc<Path> {
2602 &self.path
2603 }
2604
2605 fn full_path(&self, cx: &AppContext) -> PathBuf {
2606 let mut full_path = PathBuf::new();
2607 let worktree = self.worktree.read(cx);
2608
2609 if worktree.is_visible() {
2610 full_path.push(worktree.root_name());
2611 } else {
2612 let path = worktree.abs_path();
2613
2614 if worktree.is_local() && path.starts_with(HOME.as_path()) {
2615 full_path.push("~");
2616 full_path.push(path.strip_prefix(HOME.as_path()).unwrap());
2617 } else {
2618 full_path.push(path)
2619 }
2620 }
2621
2622 if self.path.components().next().is_some() {
2623 full_path.push(&self.path);
2624 }
2625
2626 full_path
2627 }
2628
2629 /// Returns the last component of this handle's absolute path. If this handle refers to the root
2630 /// of its worktree, then this method will return the name of the worktree itself.
2631 fn file_name<'a>(&'a self, cx: &'a AppContext) -> &'a OsStr {
2632 self.path
2633 .file_name()
2634 .unwrap_or_else(|| OsStr::new(&self.worktree.read(cx).root_name))
2635 }
2636
2637 fn worktree_id(&self) -> usize {
2638 self.worktree.entity_id().as_u64() as usize
2639 }
2640
2641 fn is_deleted(&self) -> bool {
2642 self.is_deleted
2643 }
2644
2645 fn as_any(&self) -> &dyn Any {
2646 self
2647 }
2648
2649 fn to_proto(&self) -> rpc2::proto::File {
2650 rpc2::proto::File {
2651 worktree_id: self.worktree.entity_id().as_u64(),
2652 entry_id: self.entry_id.to_proto(),
2653 path: self.path.to_string_lossy().into(),
2654 mtime: Some(self.mtime.into()),
2655 is_deleted: self.is_deleted,
2656 }
2657 }
2658}
2659
2660impl language2::LocalFile for File {
2661 fn abs_path(&self, cx: &AppContext) -> PathBuf {
2662 self.worktree
2663 .read(cx)
2664 .as_local()
2665 .unwrap()
2666 .abs_path
2667 .join(&self.path)
2668 }
2669
2670 fn load(&self, cx: &AppContext) -> Task<Result<String>> {
2671 let worktree = self.worktree.read(cx).as_local().unwrap();
2672 let abs_path = worktree.absolutize(&self.path);
2673 let fs = worktree.fs.clone();
2674 cx.executor().spawn(async move { fs.load(&abs_path).await })
2675 }
2676
2677 fn buffer_reloaded(
2678 &self,
2679 buffer_id: u64,
2680 version: &clock::Global,
2681 fingerprint: RopeFingerprint,
2682 line_ending: LineEnding,
2683 mtime: SystemTime,
2684 cx: &mut AppContext,
2685 ) {
2686 let worktree = self.worktree.read(cx).as_local().unwrap();
2687 if let Some(project_id) = worktree.share.as_ref().map(|share| share.project_id) {
2688 worktree
2689 .client
2690 .send(proto::BufferReloaded {
2691 project_id,
2692 buffer_id,
2693 version: serialize_version(version),
2694 mtime: Some(mtime.into()),
2695 fingerprint: serialize_fingerprint(fingerprint),
2696 line_ending: serialize_line_ending(line_ending) as i32,
2697 })
2698 .log_err();
2699 }
2700 }
2701}
2702
2703impl File {
2704 pub fn for_entry(entry: Entry, worktree: Handle<Worktree>) -> Arc<Self> {
2705 Arc::new(Self {
2706 worktree,
2707 path: entry.path.clone(),
2708 mtime: entry.mtime,
2709 entry_id: entry.id,
2710 is_local: true,
2711 is_deleted: false,
2712 })
2713 }
2714
2715 pub fn from_proto(
2716 proto: rpc2::proto::File,
2717 worktree: Handle<Worktree>,
2718 cx: &AppContext,
2719 ) -> Result<Self> {
2720 let worktree_id = worktree
2721 .read(cx)
2722 .as_remote()
2723 .ok_or_else(|| anyhow!("not remote"))?
2724 .id();
2725
2726 if worktree_id.to_proto() != proto.worktree_id {
2727 return Err(anyhow!("worktree id does not match file"));
2728 }
2729
2730 Ok(Self {
2731 worktree,
2732 path: Path::new(&proto.path).into(),
2733 mtime: proto.mtime.ok_or_else(|| anyhow!("no timestamp"))?.into(),
2734 entry_id: ProjectEntryId::from_proto(proto.entry_id),
2735 is_local: false,
2736 is_deleted: proto.is_deleted,
2737 })
2738 }
2739
2740 pub fn from_dyn(file: Option<&Arc<dyn language2::File>>) -> Option<&Self> {
2741 file.and_then(|f| f.as_any().downcast_ref())
2742 }
2743
2744 pub fn worktree_id(&self, cx: &AppContext) -> WorktreeId {
2745 self.worktree.read(cx).id()
2746 }
2747
2748 pub fn project_entry_id(&self, _: &AppContext) -> Option<ProjectEntryId> {
2749 if self.is_deleted {
2750 None
2751 } else {
2752 Some(self.entry_id)
2753 }
2754 }
2755}
2756
2757#[derive(Clone, Debug, PartialEq, Eq)]
2758pub struct Entry {
2759 pub id: ProjectEntryId,
2760 pub kind: EntryKind,
2761 pub path: Arc<Path>,
2762 pub inode: u64,
2763 pub mtime: SystemTime,
2764 pub is_symlink: bool,
2765
2766 /// Whether this entry is ignored by Git.
2767 ///
2768 /// We only scan ignored entries once the directory is expanded and
2769 /// exclude them from searches.
2770 pub is_ignored: bool,
2771
2772 /// Whether this entry's canonical path is outside of the worktree.
2773 /// This means the entry is only accessible from the worktree root via a
2774 /// symlink.
2775 ///
2776 /// We only scan entries outside of the worktree once the symlinked
2777 /// directory is expanded. External entries are treated like gitignored
2778 /// entries in that they are not included in searches.
2779 pub is_external: bool,
2780 pub git_status: Option<GitFileStatus>,
2781}
2782
2783#[derive(Clone, Copy, Debug, PartialEq, Eq)]
2784pub enum EntryKind {
2785 UnloadedDir,
2786 PendingDir,
2787 Dir,
2788 File(CharBag),
2789}
2790
2791#[derive(Clone, Copy, Debug, PartialEq)]
2792pub enum PathChange {
2793 /// A filesystem entry was was created.
2794 Added,
2795 /// A filesystem entry was removed.
2796 Removed,
2797 /// A filesystem entry was updated.
2798 Updated,
2799 /// A filesystem entry was either updated or added. We don't know
2800 /// whether or not it already existed, because the path had not
2801 /// been loaded before the event.
2802 AddedOrUpdated,
2803 /// A filesystem entry was found during the initial scan of the worktree.
2804 Loaded,
2805}
2806
2807pub struct GitRepositoryChange {
2808 /// The previous state of the repository, if it already existed.
2809 pub old_repository: Option<RepositoryEntry>,
2810}
2811
2812pub type UpdatedEntriesSet = Arc<[(Arc<Path>, ProjectEntryId, PathChange)]>;
2813pub type UpdatedGitRepositoriesSet = Arc<[(Arc<Path>, GitRepositoryChange)]>;
2814
2815impl Entry {
2816 fn new(
2817 path: Arc<Path>,
2818 metadata: &fs::Metadata,
2819 next_entry_id: &AtomicUsize,
2820 root_char_bag: CharBag,
2821 ) -> Self {
2822 Self {
2823 id: ProjectEntryId::new(next_entry_id),
2824 kind: if metadata.is_dir {
2825 EntryKind::PendingDir
2826 } else {
2827 EntryKind::File(char_bag_for_path(root_char_bag, &path))
2828 },
2829 path,
2830 inode: metadata.inode,
2831 mtime: metadata.mtime,
2832 is_symlink: metadata.is_symlink,
2833 is_ignored: false,
2834 is_external: false,
2835 git_status: None,
2836 }
2837 }
2838
2839 pub fn is_dir(&self) -> bool {
2840 self.kind.is_dir()
2841 }
2842
2843 pub fn is_file(&self) -> bool {
2844 self.kind.is_file()
2845 }
2846
2847 pub fn git_status(&self) -> Option<GitFileStatus> {
2848 self.git_status
2849 }
2850}
2851
2852impl EntryKind {
2853 pub fn is_dir(&self) -> bool {
2854 matches!(
2855 self,
2856 EntryKind::Dir | EntryKind::PendingDir | EntryKind::UnloadedDir
2857 )
2858 }
2859
2860 pub fn is_unloaded(&self) -> bool {
2861 matches!(self, EntryKind::UnloadedDir)
2862 }
2863
2864 pub fn is_file(&self) -> bool {
2865 matches!(self, EntryKind::File(_))
2866 }
2867}
2868
2869impl sum_tree::Item for Entry {
2870 type Summary = EntrySummary;
2871
2872 fn summary(&self) -> Self::Summary {
2873 let non_ignored_count = if self.is_ignored || self.is_external {
2874 0
2875 } else {
2876 1
2877 };
2878 let file_count;
2879 let non_ignored_file_count;
2880 if self.is_file() {
2881 file_count = 1;
2882 non_ignored_file_count = non_ignored_count;
2883 } else {
2884 file_count = 0;
2885 non_ignored_file_count = 0;
2886 }
2887
2888 let mut statuses = GitStatuses::default();
2889 match self.git_status {
2890 Some(status) => match status {
2891 GitFileStatus::Added => statuses.added = 1,
2892 GitFileStatus::Modified => statuses.modified = 1,
2893 GitFileStatus::Conflict => statuses.conflict = 1,
2894 },
2895 None => {}
2896 }
2897
2898 EntrySummary {
2899 max_path: self.path.clone(),
2900 count: 1,
2901 non_ignored_count,
2902 file_count,
2903 non_ignored_file_count,
2904 statuses,
2905 }
2906 }
2907}
2908
2909impl sum_tree::KeyedItem for Entry {
2910 type Key = PathKey;
2911
2912 fn key(&self) -> Self::Key {
2913 PathKey(self.path.clone())
2914 }
2915}
2916
2917#[derive(Clone, Debug)]
2918pub struct EntrySummary {
2919 max_path: Arc<Path>,
2920 count: usize,
2921 non_ignored_count: usize,
2922 file_count: usize,
2923 non_ignored_file_count: usize,
2924 statuses: GitStatuses,
2925}
2926
2927impl Default for EntrySummary {
2928 fn default() -> Self {
2929 Self {
2930 max_path: Arc::from(Path::new("")),
2931 count: 0,
2932 non_ignored_count: 0,
2933 file_count: 0,
2934 non_ignored_file_count: 0,
2935 statuses: Default::default(),
2936 }
2937 }
2938}
2939
2940impl sum_tree::Summary for EntrySummary {
2941 type Context = ();
2942
2943 fn add_summary(&mut self, rhs: &Self, _: &()) {
2944 self.max_path = rhs.max_path.clone();
2945 self.count += rhs.count;
2946 self.non_ignored_count += rhs.non_ignored_count;
2947 self.file_count += rhs.file_count;
2948 self.non_ignored_file_count += rhs.non_ignored_file_count;
2949 self.statuses += rhs.statuses;
2950 }
2951}
2952
2953#[derive(Clone, Debug)]
2954struct PathEntry {
2955 id: ProjectEntryId,
2956 path: Arc<Path>,
2957 is_ignored: bool,
2958 scan_id: usize,
2959}
2960
2961impl sum_tree::Item for PathEntry {
2962 type Summary = PathEntrySummary;
2963
2964 fn summary(&self) -> Self::Summary {
2965 PathEntrySummary { max_id: self.id }
2966 }
2967}
2968
2969impl sum_tree::KeyedItem for PathEntry {
2970 type Key = ProjectEntryId;
2971
2972 fn key(&self) -> Self::Key {
2973 self.id
2974 }
2975}
2976
2977#[derive(Clone, Debug, Default)]
2978struct PathEntrySummary {
2979 max_id: ProjectEntryId,
2980}
2981
2982impl sum_tree::Summary for PathEntrySummary {
2983 type Context = ();
2984
2985 fn add_summary(&mut self, summary: &Self, _: &Self::Context) {
2986 self.max_id = summary.max_id;
2987 }
2988}
2989
2990impl<'a> sum_tree::Dimension<'a, PathEntrySummary> for ProjectEntryId {
2991 fn add_summary(&mut self, summary: &'a PathEntrySummary, _: &()) {
2992 *self = summary.max_id;
2993 }
2994}
2995
2996#[derive(Clone, Debug, Eq, PartialEq, Ord, PartialOrd)]
2997pub struct PathKey(Arc<Path>);
2998
2999impl Default for PathKey {
3000 fn default() -> Self {
3001 Self(Path::new("").into())
3002 }
3003}
3004
3005impl<'a> sum_tree::Dimension<'a, EntrySummary> for PathKey {
3006 fn add_summary(&mut self, summary: &'a EntrySummary, _: &()) {
3007 self.0 = summary.max_path.clone();
3008 }
3009}
3010
3011struct BackgroundScanner {
3012 state: Mutex<BackgroundScannerState>,
3013 fs: Arc<dyn Fs>,
3014 status_updates_tx: UnboundedSender<ScanState>,
3015 executor: Executor,
3016 scan_requests_rx: channel::Receiver<ScanRequest>,
3017 path_prefixes_to_scan_rx: channel::Receiver<Arc<Path>>,
3018 next_entry_id: Arc<AtomicUsize>,
3019 phase: BackgroundScannerPhase,
3020}
3021
3022#[derive(PartialEq)]
3023enum BackgroundScannerPhase {
3024 InitialScan,
3025 EventsReceivedDuringInitialScan,
3026 Events,
3027}
3028
3029impl BackgroundScanner {
3030 fn new(
3031 snapshot: LocalSnapshot,
3032 next_entry_id: Arc<AtomicUsize>,
3033 fs: Arc<dyn Fs>,
3034 status_updates_tx: UnboundedSender<ScanState>,
3035 executor: Executor,
3036 scan_requests_rx: channel::Receiver<ScanRequest>,
3037 path_prefixes_to_scan_rx: channel::Receiver<Arc<Path>>,
3038 ) -> Self {
3039 Self {
3040 fs,
3041 status_updates_tx,
3042 executor,
3043 scan_requests_rx,
3044 path_prefixes_to_scan_rx,
3045 next_entry_id,
3046 state: Mutex::new(BackgroundScannerState {
3047 prev_snapshot: snapshot.snapshot.clone(),
3048 snapshot,
3049 scanned_dirs: Default::default(),
3050 path_prefixes_to_scan: Default::default(),
3051 paths_to_scan: Default::default(),
3052 removed_entry_ids: Default::default(),
3053 changed_paths: Default::default(),
3054 }),
3055 phase: BackgroundScannerPhase::InitialScan,
3056 }
3057 }
3058
3059 async fn run(
3060 &mut self,
3061 mut fs_events_rx: Pin<Box<dyn Send + Stream<Item = Vec<fsevent::Event>>>>,
3062 ) {
3063 use futures::FutureExt as _;
3064
3065 // Populate ignores above the root.
3066 let root_abs_path = self.state.lock().snapshot.abs_path.clone();
3067 for ancestor in root_abs_path.ancestors().skip(1) {
3068 if let Ok(ignore) = build_gitignore(&ancestor.join(&*GITIGNORE), self.fs.as_ref()).await
3069 {
3070 self.state
3071 .lock()
3072 .snapshot
3073 .ignores_by_parent_abs_path
3074 .insert(ancestor.into(), (ignore.into(), false));
3075 }
3076 }
3077
3078 let (scan_job_tx, scan_job_rx) = channel::unbounded();
3079 {
3080 let mut state = self.state.lock();
3081 state.snapshot.scan_id += 1;
3082 if let Some(mut root_entry) = state.snapshot.root_entry().cloned() {
3083 let ignore_stack = state
3084 .snapshot
3085 .ignore_stack_for_abs_path(&root_abs_path, true);
3086 if ignore_stack.is_all() {
3087 root_entry.is_ignored = true;
3088 state.insert_entry(root_entry.clone(), self.fs.as_ref());
3089 }
3090 state.enqueue_scan_dir(root_abs_path, &root_entry, &scan_job_tx);
3091 }
3092 };
3093
3094 // Perform an initial scan of the directory.
3095 drop(scan_job_tx);
3096 self.scan_dirs(true, scan_job_rx).await;
3097 {
3098 let mut state = self.state.lock();
3099 state.snapshot.completed_scan_id = state.snapshot.scan_id;
3100 }
3101
3102 self.send_status_update(false, None);
3103
3104 // Process any any FS events that occurred while performing the initial scan.
3105 // For these events, update events cannot be as precise, because we didn't
3106 // have the previous state loaded yet.
3107 self.phase = BackgroundScannerPhase::EventsReceivedDuringInitialScan;
3108 if let Poll::Ready(Some(events)) = futures::poll!(fs_events_rx.next()) {
3109 let mut paths = events.into_iter().map(|e| e.path).collect::<Vec<_>>();
3110 while let Poll::Ready(Some(more_events)) = futures::poll!(fs_events_rx.next()) {
3111 paths.extend(more_events.into_iter().map(|e| e.path));
3112 }
3113 self.process_events(paths).await;
3114 }
3115
3116 // Continue processing events until the worktree is dropped.
3117 self.phase = BackgroundScannerPhase::Events;
3118 loop {
3119 select_biased! {
3120 // Process any path refresh requests from the worktree. Prioritize
3121 // these before handling changes reported by the filesystem.
3122 request = self.scan_requests_rx.recv().fuse() => {
3123 let Ok(request) = request else { break };
3124 if !self.process_scan_request(request, false).await {
3125 return;
3126 }
3127 }
3128
3129 path_prefix = self.path_prefixes_to_scan_rx.recv().fuse() => {
3130 let Ok(path_prefix) = path_prefix else { break };
3131 log::trace!("adding path prefix {:?}", path_prefix);
3132
3133 let did_scan = self.forcibly_load_paths(&[path_prefix.clone()]).await;
3134 if did_scan {
3135 let abs_path =
3136 {
3137 let mut state = self.state.lock();
3138 state.path_prefixes_to_scan.insert(path_prefix.clone());
3139 state.snapshot.abs_path.join(&path_prefix)
3140 };
3141
3142 if let Some(abs_path) = self.fs.canonicalize(&abs_path).await.log_err() {
3143 self.process_events(vec![abs_path]).await;
3144 }
3145 }
3146 }
3147
3148 events = fs_events_rx.next().fuse() => {
3149 let Some(events) = events else { break };
3150 let mut paths = events.into_iter().map(|e| e.path).collect::<Vec<_>>();
3151 while let Poll::Ready(Some(more_events)) = futures::poll!(fs_events_rx.next()) {
3152 paths.extend(more_events.into_iter().map(|e| e.path));
3153 }
3154 self.process_events(paths.clone()).await;
3155 }
3156 }
3157 }
3158 }
3159
3160 async fn process_scan_request(&self, mut request: ScanRequest, scanning: bool) -> bool {
3161 log::debug!("rescanning paths {:?}", request.relative_paths);
3162
3163 request.relative_paths.sort_unstable();
3164 self.forcibly_load_paths(&request.relative_paths).await;
3165
3166 let root_path = self.state.lock().snapshot.abs_path.clone();
3167 let root_canonical_path = match self.fs.canonicalize(&root_path).await {
3168 Ok(path) => path,
3169 Err(err) => {
3170 log::error!("failed to canonicalize root path: {}", err);
3171 return false;
3172 }
3173 };
3174 let abs_paths = request
3175 .relative_paths
3176 .iter()
3177 .map(|path| {
3178 if path.file_name().is_some() {
3179 root_canonical_path.join(path)
3180 } else {
3181 root_canonical_path.clone()
3182 }
3183 })
3184 .collect::<Vec<_>>();
3185
3186 self.reload_entries_for_paths(
3187 root_path,
3188 root_canonical_path,
3189 &request.relative_paths,
3190 abs_paths,
3191 None,
3192 )
3193 .await;
3194 self.send_status_update(scanning, Some(request.done))
3195 }
3196
3197 async fn process_events(&mut self, mut abs_paths: Vec<PathBuf>) {
3198 let root_path = self.state.lock().snapshot.abs_path.clone();
3199 let root_canonical_path = match self.fs.canonicalize(&root_path).await {
3200 Ok(path) => path,
3201 Err(err) => {
3202 log::error!("failed to canonicalize root path: {}", err);
3203 return;
3204 }
3205 };
3206
3207 let mut relative_paths = Vec::with_capacity(abs_paths.len());
3208 abs_paths.sort_unstable();
3209 abs_paths.dedup_by(|a, b| a.starts_with(&b));
3210 abs_paths.retain(|abs_path| {
3211 let snapshot = &self.state.lock().snapshot;
3212 {
3213 let relative_path: Arc<Path> =
3214 if let Ok(path) = abs_path.strip_prefix(&root_canonical_path) {
3215 path.into()
3216 } else {
3217 log::error!(
3218 "ignoring event {abs_path:?} outside of root path {root_canonical_path:?}",
3219 );
3220 return false;
3221 };
3222
3223 let parent_dir_is_loaded = relative_path.parent().map_or(true, |parent| {
3224 snapshot
3225 .entry_for_path(parent)
3226 .map_or(false, |entry| entry.kind == EntryKind::Dir)
3227 });
3228 if !parent_dir_is_loaded {
3229 log::debug!("ignoring event {relative_path:?} within unloaded directory");
3230 return false;
3231 }
3232
3233 relative_paths.push(relative_path);
3234 true
3235 }
3236 });
3237
3238 if relative_paths.is_empty() {
3239 return;
3240 }
3241
3242 log::debug!("received fs events {:?}", relative_paths);
3243
3244 let (scan_job_tx, scan_job_rx) = channel::unbounded();
3245 self.reload_entries_for_paths(
3246 root_path,
3247 root_canonical_path,
3248 &relative_paths,
3249 abs_paths,
3250 Some(scan_job_tx.clone()),
3251 )
3252 .await;
3253 drop(scan_job_tx);
3254 self.scan_dirs(false, scan_job_rx).await;
3255
3256 let (scan_job_tx, scan_job_rx) = channel::unbounded();
3257 self.update_ignore_statuses(scan_job_tx).await;
3258 self.scan_dirs(false, scan_job_rx).await;
3259
3260 {
3261 let mut state = self.state.lock();
3262 state.reload_repositories(&relative_paths, self.fs.as_ref());
3263 state.snapshot.completed_scan_id = state.snapshot.scan_id;
3264 for (_, entry_id) in mem::take(&mut state.removed_entry_ids) {
3265 state.scanned_dirs.remove(&entry_id);
3266 }
3267 }
3268
3269 self.send_status_update(false, None);
3270 }
3271
3272 async fn forcibly_load_paths(&self, paths: &[Arc<Path>]) -> bool {
3273 let (scan_job_tx, mut scan_job_rx) = channel::unbounded();
3274 {
3275 let mut state = self.state.lock();
3276 let root_path = state.snapshot.abs_path.clone();
3277 for path in paths {
3278 for ancestor in path.ancestors() {
3279 if let Some(entry) = state.snapshot.entry_for_path(ancestor) {
3280 if entry.kind == EntryKind::UnloadedDir {
3281 let abs_path = root_path.join(ancestor);
3282 state.enqueue_scan_dir(abs_path.into(), entry, &scan_job_tx);
3283 state.paths_to_scan.insert(path.clone());
3284 break;
3285 }
3286 }
3287 }
3288 }
3289 drop(scan_job_tx);
3290 }
3291 while let Some(job) = scan_job_rx.next().await {
3292 self.scan_dir(&job).await.log_err();
3293 }
3294
3295 mem::take(&mut self.state.lock().paths_to_scan).len() > 0
3296 }
3297
3298 async fn scan_dirs(
3299 &self,
3300 enable_progress_updates: bool,
3301 scan_jobs_rx: channel::Receiver<ScanJob>,
3302 ) {
3303 use futures::FutureExt as _;
3304
3305 if self
3306 .status_updates_tx
3307 .unbounded_send(ScanState::Started)
3308 .is_err()
3309 {
3310 return;
3311 }
3312
3313 let progress_update_count = AtomicUsize::new(0);
3314 self.executor
3315 .scoped(|scope| {
3316 for _ in 0..self.executor.num_cpus() {
3317 scope.spawn(async {
3318 let mut last_progress_update_count = 0;
3319 let progress_update_timer = self.progress_timer(enable_progress_updates).fuse();
3320 futures::pin_mut!(progress_update_timer);
3321
3322 loop {
3323 select_biased! {
3324 // Process any path refresh requests before moving on to process
3325 // the scan queue, so that user operations are prioritized.
3326 request = self.scan_requests_rx.recv().fuse() => {
3327 let Ok(request) = request else { break };
3328 if !self.process_scan_request(request, true).await {
3329 return;
3330 }
3331 }
3332
3333 // Send periodic progress updates to the worktree. Use an atomic counter
3334 // to ensure that only one of the workers sends a progress update after
3335 // the update interval elapses.
3336 _ = progress_update_timer => {
3337 match progress_update_count.compare_exchange(
3338 last_progress_update_count,
3339 last_progress_update_count + 1,
3340 SeqCst,
3341 SeqCst
3342 ) {
3343 Ok(_) => {
3344 last_progress_update_count += 1;
3345 self.send_status_update(true, None);
3346 }
3347 Err(count) => {
3348 last_progress_update_count = count;
3349 }
3350 }
3351 progress_update_timer.set(self.progress_timer(enable_progress_updates).fuse());
3352 }
3353
3354 // Recursively load directories from the file system.
3355 job = scan_jobs_rx.recv().fuse() => {
3356 let Ok(job) = job else { break };
3357 if let Err(err) = self.scan_dir(&job).await {
3358 if job.path.as_ref() != Path::new("") {
3359 log::error!("error scanning directory {:?}: {}", job.abs_path, err);
3360 }
3361 }
3362 }
3363 }
3364 }
3365 })
3366 }
3367 })
3368 .await;
3369 }
3370
3371 fn send_status_update(&self, scanning: bool, barrier: Option<barrier::Sender>) -> bool {
3372 let mut state = self.state.lock();
3373 if state.changed_paths.is_empty() && scanning {
3374 return true;
3375 }
3376
3377 let new_snapshot = state.snapshot.clone();
3378 let old_snapshot = mem::replace(&mut state.prev_snapshot, new_snapshot.snapshot.clone());
3379 let changes = self.build_change_set(&old_snapshot, &new_snapshot, &state.changed_paths);
3380 state.changed_paths.clear();
3381
3382 self.status_updates_tx
3383 .unbounded_send(ScanState::Updated {
3384 snapshot: new_snapshot,
3385 changes,
3386 scanning,
3387 barrier,
3388 })
3389 .is_ok()
3390 }
3391
3392 async fn scan_dir(&self, job: &ScanJob) -> Result<()> {
3393 log::debug!("scan directory {:?}", job.path);
3394
3395 let mut ignore_stack = job.ignore_stack.clone();
3396 let mut new_ignore = None;
3397 let (root_abs_path, root_char_bag, next_entry_id) = {
3398 let snapshot = &self.state.lock().snapshot;
3399 (
3400 snapshot.abs_path().clone(),
3401 snapshot.root_char_bag,
3402 self.next_entry_id.clone(),
3403 )
3404 };
3405
3406 let mut dotgit_path = None;
3407 let mut root_canonical_path = None;
3408 let mut new_entries: Vec<Entry> = Vec::new();
3409 let mut new_jobs: Vec<Option<ScanJob>> = Vec::new();
3410 let mut child_paths = self.fs.read_dir(&job.abs_path).await?;
3411 while let Some(child_abs_path) = child_paths.next().await {
3412 let child_abs_path: Arc<Path> = match child_abs_path {
3413 Ok(child_abs_path) => child_abs_path.into(),
3414 Err(error) => {
3415 log::error!("error processing entry {:?}", error);
3416 continue;
3417 }
3418 };
3419
3420 let child_name = child_abs_path.file_name().unwrap();
3421 let child_path: Arc<Path> = job.path.join(child_name).into();
3422 let child_metadata = match self.fs.metadata(&child_abs_path).await {
3423 Ok(Some(metadata)) => metadata,
3424 Ok(None) => continue,
3425 Err(err) => {
3426 log::error!("error processing {:?}: {:?}", child_abs_path, err);
3427 continue;
3428 }
3429 };
3430
3431 // If we find a .gitignore, add it to the stack of ignores used to determine which paths are ignored
3432 if child_name == *GITIGNORE {
3433 match build_gitignore(&child_abs_path, self.fs.as_ref()).await {
3434 Ok(ignore) => {
3435 let ignore = Arc::new(ignore);
3436 ignore_stack = ignore_stack.append(job.abs_path.clone(), ignore.clone());
3437 new_ignore = Some(ignore);
3438 }
3439 Err(error) => {
3440 log::error!(
3441 "error loading .gitignore file {:?} - {:?}",
3442 child_name,
3443 error
3444 );
3445 }
3446 }
3447
3448 // Update ignore status of any child entries we've already processed to reflect the
3449 // ignore file in the current directory. Because `.gitignore` starts with a `.`,
3450 // there should rarely be too numerous. Update the ignore stack associated with any
3451 // new jobs as well.
3452 let mut new_jobs = new_jobs.iter_mut();
3453 for entry in &mut new_entries {
3454 let entry_abs_path = root_abs_path.join(&entry.path);
3455 entry.is_ignored =
3456 ignore_stack.is_abs_path_ignored(&entry_abs_path, entry.is_dir());
3457
3458 if entry.is_dir() {
3459 if let Some(job) = new_jobs.next().expect("missing scan job for entry") {
3460 job.ignore_stack = if entry.is_ignored {
3461 IgnoreStack::all()
3462 } else {
3463 ignore_stack.clone()
3464 };
3465 }
3466 }
3467 }
3468 }
3469 // If we find a .git, we'll need to load the repository.
3470 else if child_name == *DOT_GIT {
3471 dotgit_path = Some(child_path.clone());
3472 }
3473
3474 let mut child_entry = Entry::new(
3475 child_path.clone(),
3476 &child_metadata,
3477 &next_entry_id,
3478 root_char_bag,
3479 );
3480
3481 if job.is_external {
3482 child_entry.is_external = true;
3483 } else if child_metadata.is_symlink {
3484 let canonical_path = match self.fs.canonicalize(&child_abs_path).await {
3485 Ok(path) => path,
3486 Err(err) => {
3487 log::error!(
3488 "error reading target of symlink {:?}: {:?}",
3489 child_abs_path,
3490 err
3491 );
3492 continue;
3493 }
3494 };
3495
3496 // lazily canonicalize the root path in order to determine if
3497 // symlinks point outside of the worktree.
3498 let root_canonical_path = match &root_canonical_path {
3499 Some(path) => path,
3500 None => match self.fs.canonicalize(&root_abs_path).await {
3501 Ok(path) => root_canonical_path.insert(path),
3502 Err(err) => {
3503 log::error!("error canonicalizing root {:?}: {:?}", root_abs_path, err);
3504 continue;
3505 }
3506 },
3507 };
3508
3509 if !canonical_path.starts_with(root_canonical_path) {
3510 child_entry.is_external = true;
3511 }
3512 }
3513
3514 if child_entry.is_dir() {
3515 child_entry.is_ignored = ignore_stack.is_abs_path_ignored(&child_abs_path, true);
3516
3517 // Avoid recursing until crash in the case of a recursive symlink
3518 if !job.ancestor_inodes.contains(&child_entry.inode) {
3519 let mut ancestor_inodes = job.ancestor_inodes.clone();
3520 ancestor_inodes.insert(child_entry.inode);
3521
3522 new_jobs.push(Some(ScanJob {
3523 abs_path: child_abs_path,
3524 path: child_path,
3525 is_external: child_entry.is_external,
3526 ignore_stack: if child_entry.is_ignored {
3527 IgnoreStack::all()
3528 } else {
3529 ignore_stack.clone()
3530 },
3531 ancestor_inodes,
3532 scan_queue: job.scan_queue.clone(),
3533 containing_repository: job.containing_repository.clone(),
3534 }));
3535 } else {
3536 new_jobs.push(None);
3537 }
3538 } else {
3539 child_entry.is_ignored = ignore_stack.is_abs_path_ignored(&child_abs_path, false);
3540 if !child_entry.is_ignored {
3541 if let Some((repository_dir, repository, staged_statuses)) =
3542 &job.containing_repository
3543 {
3544 if let Ok(repo_path) = child_entry.path.strip_prefix(&repository_dir.0) {
3545 let repo_path = RepoPath(repo_path.into());
3546 child_entry.git_status = combine_git_statuses(
3547 staged_statuses.get(&repo_path).copied(),
3548 repository
3549 .lock()
3550 .unstaged_status(&repo_path, child_entry.mtime),
3551 );
3552 }
3553 }
3554 }
3555 }
3556
3557 new_entries.push(child_entry);
3558 }
3559
3560 let mut state = self.state.lock();
3561
3562 // Identify any subdirectories that should not be scanned.
3563 let mut job_ix = 0;
3564 for entry in &mut new_entries {
3565 state.reuse_entry_id(entry);
3566 if entry.is_dir() {
3567 if state.should_scan_directory(&entry) {
3568 job_ix += 1;
3569 } else {
3570 log::debug!("defer scanning directory {:?}", entry.path);
3571 entry.kind = EntryKind::UnloadedDir;
3572 new_jobs.remove(job_ix);
3573 }
3574 }
3575 }
3576
3577 state.populate_dir(&job.path, new_entries, new_ignore);
3578
3579 let repository =
3580 dotgit_path.and_then(|path| state.build_git_repository(path, self.fs.as_ref()));
3581
3582 for new_job in new_jobs {
3583 if let Some(mut new_job) = new_job {
3584 if let Some(containing_repository) = &repository {
3585 new_job.containing_repository = Some(containing_repository.clone());
3586 }
3587
3588 job.scan_queue
3589 .try_send(new_job)
3590 .expect("channel is unbounded");
3591 }
3592 }
3593
3594 Ok(())
3595 }
3596
3597 async fn reload_entries_for_paths(
3598 &self,
3599 root_abs_path: Arc<Path>,
3600 root_canonical_path: PathBuf,
3601 relative_paths: &[Arc<Path>],
3602 abs_paths: Vec<PathBuf>,
3603 scan_queue_tx: Option<Sender<ScanJob>>,
3604 ) {
3605 let metadata = futures::future::join_all(
3606 abs_paths
3607 .iter()
3608 .map(|abs_path| async move {
3609 let metadata = self.fs.metadata(&abs_path).await?;
3610 if let Some(metadata) = metadata {
3611 let canonical_path = self.fs.canonicalize(&abs_path).await?;
3612 anyhow::Ok(Some((metadata, canonical_path)))
3613 } else {
3614 Ok(None)
3615 }
3616 })
3617 .collect::<Vec<_>>(),
3618 )
3619 .await;
3620
3621 let mut state = self.state.lock();
3622 let snapshot = &mut state.snapshot;
3623 let is_idle = snapshot.completed_scan_id == snapshot.scan_id;
3624 let doing_recursive_update = scan_queue_tx.is_some();
3625 snapshot.scan_id += 1;
3626 if is_idle && !doing_recursive_update {
3627 snapshot.completed_scan_id = snapshot.scan_id;
3628 }
3629
3630 // Remove any entries for paths that no longer exist or are being recursively
3631 // refreshed. Do this before adding any new entries, so that renames can be
3632 // detected regardless of the order of the paths.
3633 for (path, metadata) in relative_paths.iter().zip(metadata.iter()) {
3634 if matches!(metadata, Ok(None)) || doing_recursive_update {
3635 log::trace!("remove path {:?}", path);
3636 state.remove_path(path);
3637 }
3638 }
3639
3640 for (path, metadata) in relative_paths.iter().zip(metadata.iter()) {
3641 let abs_path: Arc<Path> = root_abs_path.join(&path).into();
3642 match metadata {
3643 Ok(Some((metadata, canonical_path))) => {
3644 let ignore_stack = state
3645 .snapshot
3646 .ignore_stack_for_abs_path(&abs_path, metadata.is_dir);
3647
3648 let mut fs_entry = Entry::new(
3649 path.clone(),
3650 metadata,
3651 self.next_entry_id.as_ref(),
3652 state.snapshot.root_char_bag,
3653 );
3654 fs_entry.is_ignored = ignore_stack.is_all();
3655 fs_entry.is_external = !canonical_path.starts_with(&root_canonical_path);
3656
3657 if !fs_entry.is_ignored {
3658 if !fs_entry.is_dir() {
3659 if let Some((work_dir, repo)) =
3660 state.snapshot.local_repo_for_path(&path)
3661 {
3662 if let Ok(repo_path) = path.strip_prefix(work_dir.0) {
3663 let repo_path = RepoPath(repo_path.into());
3664 let repo = repo.repo_ptr.lock();
3665 fs_entry.git_status = repo.status(&repo_path, fs_entry.mtime);
3666 }
3667 }
3668 }
3669 }
3670
3671 if let (Some(scan_queue_tx), true) = (&scan_queue_tx, fs_entry.is_dir()) {
3672 if state.should_scan_directory(&fs_entry) {
3673 state.enqueue_scan_dir(abs_path, &fs_entry, scan_queue_tx);
3674 } else {
3675 fs_entry.kind = EntryKind::UnloadedDir;
3676 }
3677 }
3678
3679 state.insert_entry(fs_entry, self.fs.as_ref());
3680 }
3681 Ok(None) => {
3682 self.remove_repo_path(&path, &mut state.snapshot);
3683 }
3684 Err(err) => {
3685 // TODO - create a special 'error' entry in the entries tree to mark this
3686 log::error!("error reading file on event {:?}", err);
3687 }
3688 }
3689 }
3690
3691 util::extend_sorted(
3692 &mut state.changed_paths,
3693 relative_paths.iter().cloned(),
3694 usize::MAX,
3695 Ord::cmp,
3696 );
3697 }
3698
3699 fn remove_repo_path(&self, path: &Path, snapshot: &mut LocalSnapshot) -> Option<()> {
3700 if !path
3701 .components()
3702 .any(|component| component.as_os_str() == *DOT_GIT)
3703 {
3704 if let Some(repository) = snapshot.repository_for_work_directory(path) {
3705 let entry = repository.work_directory.0;
3706 snapshot.git_repositories.remove(&entry);
3707 snapshot
3708 .snapshot
3709 .repository_entries
3710 .remove(&RepositoryWorkDirectory(path.into()));
3711 return Some(());
3712 }
3713 }
3714
3715 // TODO statuses
3716 // Track when a .git is removed and iterate over the file system there
3717
3718 Some(())
3719 }
3720
3721 async fn update_ignore_statuses(&self, scan_job_tx: Sender<ScanJob>) {
3722 use futures::FutureExt as _;
3723
3724 let mut snapshot = self.state.lock().snapshot.clone();
3725 let mut ignores_to_update = Vec::new();
3726 let mut ignores_to_delete = Vec::new();
3727 let abs_path = snapshot.abs_path.clone();
3728 for (parent_abs_path, (_, needs_update)) in &mut snapshot.ignores_by_parent_abs_path {
3729 if let Ok(parent_path) = parent_abs_path.strip_prefix(&abs_path) {
3730 if *needs_update {
3731 *needs_update = false;
3732 if snapshot.snapshot.entry_for_path(parent_path).is_some() {
3733 ignores_to_update.push(parent_abs_path.clone());
3734 }
3735 }
3736
3737 let ignore_path = parent_path.join(&*GITIGNORE);
3738 if snapshot.snapshot.entry_for_path(ignore_path).is_none() {
3739 ignores_to_delete.push(parent_abs_path.clone());
3740 }
3741 }
3742 }
3743
3744 for parent_abs_path in ignores_to_delete {
3745 snapshot.ignores_by_parent_abs_path.remove(&parent_abs_path);
3746 self.state
3747 .lock()
3748 .snapshot
3749 .ignores_by_parent_abs_path
3750 .remove(&parent_abs_path);
3751 }
3752
3753 let (ignore_queue_tx, ignore_queue_rx) = channel::unbounded();
3754 ignores_to_update.sort_unstable();
3755 let mut ignores_to_update = ignores_to_update.into_iter().peekable();
3756 while let Some(parent_abs_path) = ignores_to_update.next() {
3757 while ignores_to_update
3758 .peek()
3759 .map_or(false, |p| p.starts_with(&parent_abs_path))
3760 {
3761 ignores_to_update.next().unwrap();
3762 }
3763
3764 let ignore_stack = snapshot.ignore_stack_for_abs_path(&parent_abs_path, true);
3765 smol::block_on(ignore_queue_tx.send(UpdateIgnoreStatusJob {
3766 abs_path: parent_abs_path,
3767 ignore_stack,
3768 ignore_queue: ignore_queue_tx.clone(),
3769 scan_queue: scan_job_tx.clone(),
3770 }))
3771 .unwrap();
3772 }
3773 drop(ignore_queue_tx);
3774
3775 self.executor
3776 .scoped(|scope| {
3777 for _ in 0..self.executor.num_cpus() {
3778 scope.spawn(async {
3779 loop {
3780 select_biased! {
3781 // Process any path refresh requests before moving on to process
3782 // the queue of ignore statuses.
3783 request = self.scan_requests_rx.recv().fuse() => {
3784 let Ok(request) = request else { break };
3785 if !self.process_scan_request(request, true).await {
3786 return;
3787 }
3788 }
3789
3790 // Recursively process directories whose ignores have changed.
3791 job = ignore_queue_rx.recv().fuse() => {
3792 let Ok(job) = job else { break };
3793 self.update_ignore_status(job, &snapshot).await;
3794 }
3795 }
3796 }
3797 });
3798 }
3799 })
3800 .await;
3801 }
3802
3803 async fn update_ignore_status(&self, job: UpdateIgnoreStatusJob, snapshot: &LocalSnapshot) {
3804 log::trace!("update ignore status {:?}", job.abs_path);
3805
3806 let mut ignore_stack = job.ignore_stack;
3807 if let Some((ignore, _)) = snapshot.ignores_by_parent_abs_path.get(&job.abs_path) {
3808 ignore_stack = ignore_stack.append(job.abs_path.clone(), ignore.clone());
3809 }
3810
3811 let mut entries_by_id_edits = Vec::new();
3812 let mut entries_by_path_edits = Vec::new();
3813 let path = job.abs_path.strip_prefix(&snapshot.abs_path).unwrap();
3814 for mut entry in snapshot.child_entries(path).cloned() {
3815 let was_ignored = entry.is_ignored;
3816 let abs_path: Arc<Path> = snapshot.abs_path().join(&entry.path).into();
3817 entry.is_ignored = ignore_stack.is_abs_path_ignored(&abs_path, entry.is_dir());
3818 if entry.is_dir() {
3819 let child_ignore_stack = if entry.is_ignored {
3820 IgnoreStack::all()
3821 } else {
3822 ignore_stack.clone()
3823 };
3824
3825 // Scan any directories that were previously ignored and weren't
3826 // previously scanned.
3827 if was_ignored && !entry.is_ignored && entry.kind.is_unloaded() {
3828 let state = self.state.lock();
3829 if state.should_scan_directory(&entry) {
3830 state.enqueue_scan_dir(abs_path.clone(), &entry, &job.scan_queue);
3831 }
3832 }
3833
3834 job.ignore_queue
3835 .send(UpdateIgnoreStatusJob {
3836 abs_path: abs_path.clone(),
3837 ignore_stack: child_ignore_stack,
3838 ignore_queue: job.ignore_queue.clone(),
3839 scan_queue: job.scan_queue.clone(),
3840 })
3841 .await
3842 .unwrap();
3843 }
3844
3845 if entry.is_ignored != was_ignored {
3846 let mut path_entry = snapshot.entries_by_id.get(&entry.id, &()).unwrap().clone();
3847 path_entry.scan_id = snapshot.scan_id;
3848 path_entry.is_ignored = entry.is_ignored;
3849 entries_by_id_edits.push(Edit::Insert(path_entry));
3850 entries_by_path_edits.push(Edit::Insert(entry));
3851 }
3852 }
3853
3854 let state = &mut self.state.lock();
3855 for edit in &entries_by_path_edits {
3856 if let Edit::Insert(entry) = edit {
3857 if let Err(ix) = state.changed_paths.binary_search(&entry.path) {
3858 state.changed_paths.insert(ix, entry.path.clone());
3859 }
3860 }
3861 }
3862
3863 state
3864 .snapshot
3865 .entries_by_path
3866 .edit(entries_by_path_edits, &());
3867 state.snapshot.entries_by_id.edit(entries_by_id_edits, &());
3868 }
3869
3870 fn build_change_set(
3871 &self,
3872 old_snapshot: &Snapshot,
3873 new_snapshot: &Snapshot,
3874 event_paths: &[Arc<Path>],
3875 ) -> UpdatedEntriesSet {
3876 use BackgroundScannerPhase::*;
3877 use PathChange::{Added, AddedOrUpdated, Loaded, Removed, Updated};
3878
3879 // Identify which paths have changed. Use the known set of changed
3880 // parent paths to optimize the search.
3881 let mut changes = Vec::new();
3882 let mut old_paths = old_snapshot.entries_by_path.cursor::<PathKey>();
3883 let mut new_paths = new_snapshot.entries_by_path.cursor::<PathKey>();
3884 let mut last_newly_loaded_dir_path = None;
3885 old_paths.next(&());
3886 new_paths.next(&());
3887 for path in event_paths {
3888 let path = PathKey(path.clone());
3889 if old_paths.item().map_or(false, |e| e.path < path.0) {
3890 old_paths.seek_forward(&path, Bias::Left, &());
3891 }
3892 if new_paths.item().map_or(false, |e| e.path < path.0) {
3893 new_paths.seek_forward(&path, Bias::Left, &());
3894 }
3895 loop {
3896 match (old_paths.item(), new_paths.item()) {
3897 (Some(old_entry), Some(new_entry)) => {
3898 if old_entry.path > path.0
3899 && new_entry.path > path.0
3900 && !old_entry.path.starts_with(&path.0)
3901 && !new_entry.path.starts_with(&path.0)
3902 {
3903 break;
3904 }
3905
3906 match Ord::cmp(&old_entry.path, &new_entry.path) {
3907 Ordering::Less => {
3908 changes.push((old_entry.path.clone(), old_entry.id, Removed));
3909 old_paths.next(&());
3910 }
3911 Ordering::Equal => {
3912 if self.phase == EventsReceivedDuringInitialScan {
3913 if old_entry.id != new_entry.id {
3914 changes.push((
3915 old_entry.path.clone(),
3916 old_entry.id,
3917 Removed,
3918 ));
3919 }
3920 // If the worktree was not fully initialized when this event was generated,
3921 // we can't know whether this entry was added during the scan or whether
3922 // it was merely updated.
3923 changes.push((
3924 new_entry.path.clone(),
3925 new_entry.id,
3926 AddedOrUpdated,
3927 ));
3928 } else if old_entry.id != new_entry.id {
3929 changes.push((old_entry.path.clone(), old_entry.id, Removed));
3930 changes.push((new_entry.path.clone(), new_entry.id, Added));
3931 } else if old_entry != new_entry {
3932 if old_entry.kind.is_unloaded() {
3933 last_newly_loaded_dir_path = Some(&new_entry.path);
3934 changes.push((
3935 new_entry.path.clone(),
3936 new_entry.id,
3937 Loaded,
3938 ));
3939 } else {
3940 changes.push((
3941 new_entry.path.clone(),
3942 new_entry.id,
3943 Updated,
3944 ));
3945 }
3946 }
3947 old_paths.next(&());
3948 new_paths.next(&());
3949 }
3950 Ordering::Greater => {
3951 let is_newly_loaded = self.phase == InitialScan
3952 || last_newly_loaded_dir_path
3953 .as_ref()
3954 .map_or(false, |dir| new_entry.path.starts_with(&dir));
3955 changes.push((
3956 new_entry.path.clone(),
3957 new_entry.id,
3958 if is_newly_loaded { Loaded } else { Added },
3959 ));
3960 new_paths.next(&());
3961 }
3962 }
3963 }
3964 (Some(old_entry), None) => {
3965 changes.push((old_entry.path.clone(), old_entry.id, Removed));
3966 old_paths.next(&());
3967 }
3968 (None, Some(new_entry)) => {
3969 let is_newly_loaded = self.phase == InitialScan
3970 || last_newly_loaded_dir_path
3971 .as_ref()
3972 .map_or(false, |dir| new_entry.path.starts_with(&dir));
3973 changes.push((
3974 new_entry.path.clone(),
3975 new_entry.id,
3976 if is_newly_loaded { Loaded } else { Added },
3977 ));
3978 new_paths.next(&());
3979 }
3980 (None, None) => break,
3981 }
3982 }
3983 }
3984
3985 changes.into()
3986 }
3987
3988 async fn progress_timer(&self, running: bool) {
3989 if !running {
3990 return futures::future::pending().await;
3991 }
3992
3993 #[cfg(any(test, feature = "test-support"))]
3994 if self.fs.is_fake() {
3995 return self.executor.simulate_random_delay().await;
3996 }
3997
3998 smol::Timer::after(Duration::from_millis(100)).await;
3999 }
4000}
4001
4002fn char_bag_for_path(root_char_bag: CharBag, path: &Path) -> CharBag {
4003 let mut result = root_char_bag;
4004 result.extend(
4005 path.to_string_lossy()
4006 .chars()
4007 .map(|c| c.to_ascii_lowercase()),
4008 );
4009 result
4010}
4011
4012struct ScanJob {
4013 abs_path: Arc<Path>,
4014 path: Arc<Path>,
4015 ignore_stack: Arc<IgnoreStack>,
4016 scan_queue: Sender<ScanJob>,
4017 ancestor_inodes: TreeSet<u64>,
4018 is_external: bool,
4019 containing_repository: Option<(
4020 RepositoryWorkDirectory,
4021 Arc<Mutex<dyn GitRepository>>,
4022 TreeMap<RepoPath, GitFileStatus>,
4023 )>,
4024}
4025
4026struct UpdateIgnoreStatusJob {
4027 abs_path: Arc<Path>,
4028 ignore_stack: Arc<IgnoreStack>,
4029 ignore_queue: Sender<UpdateIgnoreStatusJob>,
4030 scan_queue: Sender<ScanJob>,
4031}
4032
4033// todo!("re-enable when we have tests")
4034// pub trait WorktreeModelHandle {
4035// #[cfg(any(test, feature = "test-support"))]
4036// fn flush_fs_events<'a>(
4037// &self,
4038// cx: &'a gpui::TestAppContext,
4039// ) -> futures::future::LocalBoxFuture<'a, ()>;
4040// }
4041
4042// impl WorktreeModelHandle for Handle<Worktree> {
4043// // When the worktree's FS event stream sometimes delivers "redundant" events for FS changes that
4044// // occurred before the worktree was constructed. These events can cause the worktree to perform
4045// // extra directory scans, and emit extra scan-state notifications.
4046// //
4047// // This function mutates the worktree's directory and waits for those mutations to be picked up,
4048// // to ensure that all redundant FS events have already been processed.
4049// #[cfg(any(test, feature = "test-support"))]
4050// fn flush_fs_events<'a>(
4051// &self,
4052// cx: &'a gpui::TestAppContext,
4053// ) -> futures::future::LocalBoxFuture<'a, ()> {
4054// let filename = "fs-event-sentinel";
4055// let tree = self.clone();
4056// let (fs, root_path) = self.read_with(cx, |tree, _| {
4057// let tree = tree.as_local().unwrap();
4058// (tree.fs.clone(), tree.abs_path().clone())
4059// });
4060
4061// async move {
4062// fs.create_file(&root_path.join(filename), Default::default())
4063// .await
4064// .unwrap();
4065// tree.condition(cx, |tree, _| tree.entry_for_path(filename).is_some())
4066// .await;
4067
4068// fs.remove_file(&root_path.join(filename), Default::default())
4069// .await
4070// .unwrap();
4071// tree.condition(cx, |tree, _| tree.entry_for_path(filename).is_none())
4072// .await;
4073
4074// cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
4075// .await;
4076// }
4077// .boxed_local()
4078// }
4079// }
4080
4081#[derive(Clone, Debug)]
4082struct TraversalProgress<'a> {
4083 max_path: &'a Path,
4084 count: usize,
4085 non_ignored_count: usize,
4086 file_count: usize,
4087 non_ignored_file_count: usize,
4088}
4089
4090impl<'a> TraversalProgress<'a> {
4091 fn count(&self, include_dirs: bool, include_ignored: bool) -> usize {
4092 match (include_ignored, include_dirs) {
4093 (true, true) => self.count,
4094 (true, false) => self.file_count,
4095 (false, true) => self.non_ignored_count,
4096 (false, false) => self.non_ignored_file_count,
4097 }
4098 }
4099}
4100
4101impl<'a> sum_tree::Dimension<'a, EntrySummary> for TraversalProgress<'a> {
4102 fn add_summary(&mut self, summary: &'a EntrySummary, _: &()) {
4103 self.max_path = summary.max_path.as_ref();
4104 self.count += summary.count;
4105 self.non_ignored_count += summary.non_ignored_count;
4106 self.file_count += summary.file_count;
4107 self.non_ignored_file_count += summary.non_ignored_file_count;
4108 }
4109}
4110
4111impl<'a> Default for TraversalProgress<'a> {
4112 fn default() -> Self {
4113 Self {
4114 max_path: Path::new(""),
4115 count: 0,
4116 non_ignored_count: 0,
4117 file_count: 0,
4118 non_ignored_file_count: 0,
4119 }
4120 }
4121}
4122
4123#[derive(Clone, Debug, Default, Copy)]
4124struct GitStatuses {
4125 added: usize,
4126 modified: usize,
4127 conflict: usize,
4128}
4129
4130impl AddAssign for GitStatuses {
4131 fn add_assign(&mut self, rhs: Self) {
4132 self.added += rhs.added;
4133 self.modified += rhs.modified;
4134 self.conflict += rhs.conflict;
4135 }
4136}
4137
4138impl Sub for GitStatuses {
4139 type Output = GitStatuses;
4140
4141 fn sub(self, rhs: Self) -> Self::Output {
4142 GitStatuses {
4143 added: self.added - rhs.added,
4144 modified: self.modified - rhs.modified,
4145 conflict: self.conflict - rhs.conflict,
4146 }
4147 }
4148}
4149
4150impl<'a> sum_tree::Dimension<'a, EntrySummary> for GitStatuses {
4151 fn add_summary(&mut self, summary: &'a EntrySummary, _: &()) {
4152 *self += summary.statuses
4153 }
4154}
4155
4156pub struct Traversal<'a> {
4157 cursor: sum_tree::Cursor<'a, Entry, TraversalProgress<'a>>,
4158 include_ignored: bool,
4159 include_dirs: bool,
4160}
4161
4162impl<'a> Traversal<'a> {
4163 pub fn advance(&mut self) -> bool {
4164 self.cursor.seek_forward(
4165 &TraversalTarget::Count {
4166 count: self.end_offset() + 1,
4167 include_dirs: self.include_dirs,
4168 include_ignored: self.include_ignored,
4169 },
4170 Bias::Left,
4171 &(),
4172 )
4173 }
4174
4175 pub fn advance_to_sibling(&mut self) -> bool {
4176 while let Some(entry) = self.cursor.item() {
4177 self.cursor.seek_forward(
4178 &TraversalTarget::PathSuccessor(&entry.path),
4179 Bias::Left,
4180 &(),
4181 );
4182 if let Some(entry) = self.cursor.item() {
4183 if (self.include_dirs || !entry.is_dir())
4184 && (self.include_ignored || !entry.is_ignored)
4185 {
4186 return true;
4187 }
4188 }
4189 }
4190 false
4191 }
4192
4193 pub fn entry(&self) -> Option<&'a Entry> {
4194 self.cursor.item()
4195 }
4196
4197 pub fn start_offset(&self) -> usize {
4198 self.cursor
4199 .start()
4200 .count(self.include_dirs, self.include_ignored)
4201 }
4202
4203 pub fn end_offset(&self) -> usize {
4204 self.cursor
4205 .end(&())
4206 .count(self.include_dirs, self.include_ignored)
4207 }
4208}
4209
4210impl<'a> Iterator for Traversal<'a> {
4211 type Item = &'a Entry;
4212
4213 fn next(&mut self) -> Option<Self::Item> {
4214 if let Some(item) = self.entry() {
4215 self.advance();
4216 Some(item)
4217 } else {
4218 None
4219 }
4220 }
4221}
4222
4223#[derive(Debug)]
4224enum TraversalTarget<'a> {
4225 Path(&'a Path),
4226 PathSuccessor(&'a Path),
4227 Count {
4228 count: usize,
4229 include_ignored: bool,
4230 include_dirs: bool,
4231 },
4232}
4233
4234impl<'a, 'b> SeekTarget<'a, EntrySummary, TraversalProgress<'a>> for TraversalTarget<'b> {
4235 fn cmp(&self, cursor_location: &TraversalProgress<'a>, _: &()) -> Ordering {
4236 match self {
4237 TraversalTarget::Path(path) => path.cmp(&cursor_location.max_path),
4238 TraversalTarget::PathSuccessor(path) => {
4239 if !cursor_location.max_path.starts_with(path) {
4240 Ordering::Equal
4241 } else {
4242 Ordering::Greater
4243 }
4244 }
4245 TraversalTarget::Count {
4246 count,
4247 include_dirs,
4248 include_ignored,
4249 } => Ord::cmp(
4250 count,
4251 &cursor_location.count(*include_dirs, *include_ignored),
4252 ),
4253 }
4254 }
4255}
4256
4257impl<'a, 'b> SeekTarget<'a, EntrySummary, (TraversalProgress<'a>, GitStatuses)>
4258 for TraversalTarget<'b>
4259{
4260 fn cmp(&self, cursor_location: &(TraversalProgress<'a>, GitStatuses), _: &()) -> Ordering {
4261 self.cmp(&cursor_location.0, &())
4262 }
4263}
4264
4265struct ChildEntriesIter<'a> {
4266 parent_path: &'a Path,
4267 traversal: Traversal<'a>,
4268}
4269
4270impl<'a> Iterator for ChildEntriesIter<'a> {
4271 type Item = &'a Entry;
4272
4273 fn next(&mut self) -> Option<Self::Item> {
4274 if let Some(item) = self.traversal.entry() {
4275 if item.path.starts_with(&self.parent_path) {
4276 self.traversal.advance_to_sibling();
4277 return Some(item);
4278 }
4279 }
4280 None
4281 }
4282}
4283
4284pub struct DescendentEntriesIter<'a> {
4285 parent_path: &'a Path,
4286 traversal: Traversal<'a>,
4287}
4288
4289impl<'a> Iterator for DescendentEntriesIter<'a> {
4290 type Item = &'a Entry;
4291
4292 fn next(&mut self) -> Option<Self::Item> {
4293 if let Some(item) = self.traversal.entry() {
4294 if item.path.starts_with(&self.parent_path) {
4295 self.traversal.advance();
4296 return Some(item);
4297 }
4298 }
4299 None
4300 }
4301}
4302
4303impl<'a> From<&'a Entry> for proto::Entry {
4304 fn from(entry: &'a Entry) -> Self {
4305 Self {
4306 id: entry.id.to_proto(),
4307 is_dir: entry.is_dir(),
4308 path: entry.path.to_string_lossy().into(),
4309 inode: entry.inode,
4310 mtime: Some(entry.mtime.into()),
4311 is_symlink: entry.is_symlink,
4312 is_ignored: entry.is_ignored,
4313 is_external: entry.is_external,
4314 git_status: entry.git_status.map(git_status_to_proto),
4315 }
4316 }
4317}
4318
4319impl<'a> TryFrom<(&'a CharBag, proto::Entry)> for Entry {
4320 type Error = anyhow::Error;
4321
4322 fn try_from((root_char_bag, entry): (&'a CharBag, proto::Entry)) -> Result<Self> {
4323 if let Some(mtime) = entry.mtime {
4324 let kind = if entry.is_dir {
4325 EntryKind::Dir
4326 } else {
4327 let mut char_bag = *root_char_bag;
4328 char_bag.extend(entry.path.chars().map(|c| c.to_ascii_lowercase()));
4329 EntryKind::File(char_bag)
4330 };
4331 let path: Arc<Path> = PathBuf::from(entry.path).into();
4332 Ok(Entry {
4333 id: ProjectEntryId::from_proto(entry.id),
4334 kind,
4335 path,
4336 inode: entry.inode,
4337 mtime: mtime.into(),
4338 is_symlink: entry.is_symlink,
4339 is_ignored: entry.is_ignored,
4340 is_external: entry.is_external,
4341 git_status: git_status_from_proto(entry.git_status),
4342 })
4343 } else {
4344 Err(anyhow!(
4345 "missing mtime in remote worktree entry {:?}",
4346 entry.path
4347 ))
4348 }
4349 }
4350}
4351
4352fn combine_git_statuses(
4353 staged: Option<GitFileStatus>,
4354 unstaged: Option<GitFileStatus>,
4355) -> Option<GitFileStatus> {
4356 if let Some(staged) = staged {
4357 if let Some(unstaged) = unstaged {
4358 if unstaged != staged {
4359 Some(GitFileStatus::Modified)
4360 } else {
4361 Some(staged)
4362 }
4363 } else {
4364 Some(staged)
4365 }
4366 } else {
4367 unstaged
4368 }
4369}
4370
4371fn git_status_from_proto(git_status: Option<i32>) -> Option<GitFileStatus> {
4372 git_status.and_then(|status| {
4373 proto::GitStatus::from_i32(status).map(|status| match status {
4374 proto::GitStatus::Added => GitFileStatus::Added,
4375 proto::GitStatus::Modified => GitFileStatus::Modified,
4376 proto::GitStatus::Conflict => GitFileStatus::Conflict,
4377 })
4378 })
4379}
4380
4381fn git_status_to_proto(status: GitFileStatus) -> i32 {
4382 match status {
4383 GitFileStatus::Added => proto::GitStatus::Added as i32,
4384 GitFileStatus::Modified => proto::GitStatus::Modified as i32,
4385 GitFileStatus::Conflict => proto::GitStatus::Conflict as i32,
4386 }
4387}