1use crate::{
2 copy_recursive, ignore::IgnoreStack, DiagnosticSummary, ProjectEntryId, RemoveOptions,
3};
4use ::ignore::gitignore::{Gitignore, GitignoreBuilder};
5use anyhow::{anyhow, Context, Result};
6use client::{proto, Client};
7use clock::ReplicaId;
8use collections::{HashMap, HashSet, VecDeque};
9use fs::{
10 repository::{GitFileStatus, GitRepository, RepoPath},
11 Fs,
12};
13use futures::{
14 channel::{
15 mpsc::{self, UnboundedSender},
16 oneshot,
17 },
18 select_biased,
19 task::Poll,
20 FutureExt, Stream, StreamExt,
21};
22use fuzzy::CharBag;
23use git::{DOT_GIT, GITIGNORE};
24use gpui::{executor, AppContext, AsyncAppContext, Entity, ModelContext, ModelHandle, Task};
25use language::{
26 proto::{
27 deserialize_fingerprint, deserialize_version, serialize_fingerprint, serialize_line_ending,
28 serialize_version,
29 },
30 Buffer, DiagnosticEntry, File as _, LineEnding, PointUtf16, Rope, RopeFingerprint, Unclipped,
31};
32use lsp::LanguageServerId;
33use parking_lot::Mutex;
34use postage::{
35 barrier,
36 prelude::{Sink as _, Stream as _},
37 watch,
38};
39use smol::channel::{self, Sender};
40use std::{
41 any::Any,
42 cmp::{self, Ordering},
43 convert::TryFrom,
44 ffi::OsStr,
45 fmt,
46 future::Future,
47 mem,
48 ops::{AddAssign, Deref, DerefMut, Sub},
49 path::{Path, PathBuf},
50 pin::Pin,
51 sync::{
52 atomic::{AtomicUsize, Ordering::SeqCst},
53 Arc,
54 },
55 time::{Duration, SystemTime},
56};
57use sum_tree::{Bias, Edit, SeekTarget, SumTree, TreeMap, TreeSet};
58use util::{paths::HOME, ResultExt};
59
60#[derive(Copy, Clone, PartialEq, Eq, Debug, Hash, PartialOrd, Ord)]
61pub struct WorktreeId(usize);
62
63pub enum Worktree {
64 Local(LocalWorktree),
65 Remote(RemoteWorktree),
66}
67
68pub struct LocalWorktree {
69 snapshot: LocalSnapshot,
70 scan_requests_tx: channel::Sender<ScanRequest>,
71 path_prefixes_to_scan_tx: channel::Sender<Arc<Path>>,
72 is_scanning: (watch::Sender<bool>, watch::Receiver<bool>),
73 _background_scanner_task: Task<()>,
74 share: Option<ShareState>,
75 diagnostics: HashMap<
76 Arc<Path>,
77 Vec<(
78 LanguageServerId,
79 Vec<DiagnosticEntry<Unclipped<PointUtf16>>>,
80 )>,
81 >,
82 diagnostic_summaries: HashMap<Arc<Path>, HashMap<LanguageServerId, DiagnosticSummary>>,
83 client: Arc<Client>,
84 fs: Arc<dyn Fs>,
85 visible: bool,
86}
87
88struct ScanRequest {
89 relative_paths: Vec<Arc<Path>>,
90 done: barrier::Sender,
91}
92
93pub struct RemoteWorktree {
94 snapshot: Snapshot,
95 background_snapshot: Arc<Mutex<Snapshot>>,
96 project_id: u64,
97 client: Arc<Client>,
98 updates_tx: Option<UnboundedSender<proto::UpdateWorktree>>,
99 snapshot_subscriptions: VecDeque<(usize, oneshot::Sender<()>)>,
100 replica_id: ReplicaId,
101 diagnostic_summaries: HashMap<Arc<Path>, HashMap<LanguageServerId, DiagnosticSummary>>,
102 visible: bool,
103 disconnected: bool,
104}
105
106#[derive(Clone)]
107pub struct Snapshot {
108 id: WorktreeId,
109 abs_path: Arc<Path>,
110 root_name: String,
111 root_char_bag: CharBag,
112 entries_by_path: SumTree<Entry>,
113 entries_by_id: SumTree<PathEntry>,
114 repository_entries: TreeMap<RepositoryWorkDirectory, RepositoryEntry>,
115
116 /// A number that increases every time the worktree begins scanning
117 /// a set of paths from the filesystem. This scanning could be caused
118 /// by some operation performed on the worktree, such as reading or
119 /// writing a file, or by an event reported by the filesystem.
120 scan_id: usize,
121
122 /// The latest scan id that has completed, and whose preceding scans
123 /// have all completed. The current `scan_id` could be more than one
124 /// greater than the `completed_scan_id` if operations are performed
125 /// on the worktree while it is processing a file-system event.
126 completed_scan_id: usize,
127}
128
129#[derive(Clone, Debug, PartialEq, Eq)]
130pub struct RepositoryEntry {
131 pub(crate) work_directory: WorkDirectoryEntry,
132 pub(crate) branch: Option<Arc<str>>,
133}
134
135impl RepositoryEntry {
136 pub fn branch(&self) -> Option<Arc<str>> {
137 self.branch.clone()
138 }
139
140 pub fn work_directory_id(&self) -> ProjectEntryId {
141 *self.work_directory
142 }
143
144 pub fn work_directory(&self, snapshot: &Snapshot) -> Option<RepositoryWorkDirectory> {
145 snapshot
146 .entry_for_id(self.work_directory_id())
147 .map(|entry| RepositoryWorkDirectory(entry.path.clone()))
148 }
149
150 pub fn build_update(&self, _: &Self) -> proto::RepositoryEntry {
151 proto::RepositoryEntry {
152 work_directory_id: self.work_directory_id().to_proto(),
153 branch: self.branch.as_ref().map(|str| str.to_string()),
154 }
155 }
156}
157
158impl From<&RepositoryEntry> for proto::RepositoryEntry {
159 fn from(value: &RepositoryEntry) -> Self {
160 proto::RepositoryEntry {
161 work_directory_id: value.work_directory.to_proto(),
162 branch: value.branch.as_ref().map(|str| str.to_string()),
163 }
164 }
165}
166
167/// This path corresponds to the 'content path' (the folder that contains the .git)
168#[derive(Clone, Debug, Ord, PartialOrd, Eq, PartialEq)]
169pub struct RepositoryWorkDirectory(pub(crate) Arc<Path>);
170
171impl Default for RepositoryWorkDirectory {
172 fn default() -> Self {
173 RepositoryWorkDirectory(Arc::from(Path::new("")))
174 }
175}
176
177impl AsRef<Path> for RepositoryWorkDirectory {
178 fn as_ref(&self) -> &Path {
179 self.0.as_ref()
180 }
181}
182
183#[derive(Clone, Debug, Ord, PartialOrd, Eq, PartialEq)]
184pub struct WorkDirectoryEntry(ProjectEntryId);
185
186impl WorkDirectoryEntry {
187 pub(crate) fn relativize(&self, worktree: &Snapshot, path: &Path) -> Option<RepoPath> {
188 worktree.entry_for_id(self.0).and_then(|entry| {
189 path.strip_prefix(&entry.path)
190 .ok()
191 .map(move |path| path.into())
192 })
193 }
194}
195
196impl Deref for WorkDirectoryEntry {
197 type Target = ProjectEntryId;
198
199 fn deref(&self) -> &Self::Target {
200 &self.0
201 }
202}
203
204impl<'a> From<ProjectEntryId> for WorkDirectoryEntry {
205 fn from(value: ProjectEntryId) -> Self {
206 WorkDirectoryEntry(value)
207 }
208}
209
210#[derive(Debug, Clone)]
211pub struct LocalSnapshot {
212 snapshot: Snapshot,
213 /// All of the gitignore files in the worktree, indexed by their relative path.
214 /// The boolean indicates whether the gitignore needs to be updated.
215 ignores_by_parent_abs_path: HashMap<Arc<Path>, (Arc<Gitignore>, bool)>,
216 /// All of the git repositories in the worktree, indexed by the project entry
217 /// id of their parent directory.
218 git_repositories: TreeMap<ProjectEntryId, LocalRepositoryEntry>,
219}
220
221struct BackgroundScannerState {
222 snapshot: LocalSnapshot,
223 scanned_dirs: HashSet<ProjectEntryId>,
224 path_prefixes_to_scan: HashSet<Arc<Path>>,
225 paths_to_scan: HashSet<Arc<Path>>,
226 /// The ids of all of the entries that were removed from the snapshot
227 /// as part of the current update. These entry ids may be re-used
228 /// if the same inode is discovered at a new path, or if the given
229 /// path is re-created after being deleted.
230 removed_entry_ids: HashMap<u64, ProjectEntryId>,
231 changed_paths: Vec<Arc<Path>>,
232 prev_snapshot: Snapshot,
233}
234
235#[derive(Debug, Clone)]
236pub struct LocalRepositoryEntry {
237 pub(crate) git_dir_scan_id: usize,
238 pub(crate) repo_ptr: Arc<Mutex<dyn GitRepository>>,
239 /// Path to the actual .git folder.
240 /// Note: if .git is a file, this points to the folder indicated by the .git file
241 pub(crate) git_dir_path: Arc<Path>,
242}
243
244impl Deref for LocalSnapshot {
245 type Target = Snapshot;
246
247 fn deref(&self) -> &Self::Target {
248 &self.snapshot
249 }
250}
251
252impl DerefMut for LocalSnapshot {
253 fn deref_mut(&mut self) -> &mut Self::Target {
254 &mut self.snapshot
255 }
256}
257
258enum ScanState {
259 Started,
260 Updated {
261 snapshot: LocalSnapshot,
262 changes: UpdatedEntriesSet,
263 barrier: Option<barrier::Sender>,
264 scanning: bool,
265 },
266}
267
268struct ShareState {
269 project_id: u64,
270 snapshots_tx:
271 mpsc::UnboundedSender<(LocalSnapshot, UpdatedEntriesSet, UpdatedGitRepositoriesSet)>,
272 resume_updates: watch::Sender<()>,
273 _maintain_remote_snapshot: Task<Option<()>>,
274}
275
276pub enum Event {
277 UpdatedEntries(UpdatedEntriesSet),
278 UpdatedGitRepositories(UpdatedGitRepositoriesSet),
279}
280
281impl Entity for Worktree {
282 type Event = Event;
283}
284
285impl Worktree {
286 pub async fn local(
287 client: Arc<Client>,
288 path: impl Into<Arc<Path>>,
289 visible: bool,
290 fs: Arc<dyn Fs>,
291 next_entry_id: Arc<AtomicUsize>,
292 cx: &mut AsyncAppContext,
293 ) -> Result<ModelHandle<Self>> {
294 // After determining whether the root entry is a file or a directory, populate the
295 // snapshot's "root name", which will be used for the purpose of fuzzy matching.
296 let abs_path = path.into();
297 let metadata = fs
298 .metadata(&abs_path)
299 .await
300 .context("failed to stat worktree path")?;
301
302 Ok(cx.add_model(move |cx: &mut ModelContext<Worktree>| {
303 let root_name = abs_path
304 .file_name()
305 .map_or(String::new(), |f| f.to_string_lossy().to_string());
306
307 let mut snapshot = LocalSnapshot {
308 ignores_by_parent_abs_path: Default::default(),
309 git_repositories: Default::default(),
310 snapshot: Snapshot {
311 id: WorktreeId::from_usize(cx.model_id()),
312 abs_path: abs_path.clone(),
313 root_name: root_name.clone(),
314 root_char_bag: root_name.chars().map(|c| c.to_ascii_lowercase()).collect(),
315 entries_by_path: Default::default(),
316 entries_by_id: Default::default(),
317 repository_entries: Default::default(),
318 scan_id: 1,
319 completed_scan_id: 0,
320 },
321 };
322
323 if let Some(metadata) = metadata {
324 snapshot.insert_entry(
325 Entry::new(
326 Arc::from(Path::new("")),
327 &metadata,
328 &next_entry_id,
329 snapshot.root_char_bag,
330 ),
331 fs.as_ref(),
332 );
333 }
334
335 let (scan_requests_tx, scan_requests_rx) = channel::unbounded();
336 let (path_prefixes_to_scan_tx, path_prefixes_to_scan_rx) = channel::unbounded();
337 let (scan_states_tx, mut scan_states_rx) = mpsc::unbounded();
338
339 cx.spawn_weak(|this, mut cx| async move {
340 while let Some((state, this)) = scan_states_rx.next().await.zip(this.upgrade(&cx)) {
341 this.update(&mut cx, |this, cx| {
342 let this = this.as_local_mut().unwrap();
343 match state {
344 ScanState::Started => {
345 *this.is_scanning.0.borrow_mut() = true;
346 }
347 ScanState::Updated {
348 snapshot,
349 changes,
350 barrier,
351 scanning,
352 } => {
353 *this.is_scanning.0.borrow_mut() = scanning;
354 this.set_snapshot(snapshot, changes, cx);
355 drop(barrier);
356 }
357 }
358 cx.notify();
359 });
360 }
361 })
362 .detach();
363
364 let background_scanner_task = cx.background().spawn({
365 let fs = fs.clone();
366 let snapshot = snapshot.clone();
367 let background = cx.background().clone();
368 async move {
369 let events = fs.watch(&abs_path, Duration::from_millis(100)).await;
370 BackgroundScanner::new(
371 snapshot,
372 next_entry_id,
373 fs,
374 scan_states_tx,
375 background,
376 scan_requests_rx,
377 path_prefixes_to_scan_rx,
378 )
379 .run(events)
380 .await;
381 }
382 });
383
384 Worktree::Local(LocalWorktree {
385 snapshot,
386 is_scanning: watch::channel_with(true),
387 share: None,
388 scan_requests_tx,
389 path_prefixes_to_scan_tx,
390 _background_scanner_task: background_scanner_task,
391 diagnostics: Default::default(),
392 diagnostic_summaries: Default::default(),
393 client,
394 fs,
395 visible,
396 })
397 }))
398 }
399
400 // abcdefghi
401 pub fn remote(
402 project_remote_id: u64,
403 replica_id: ReplicaId,
404 worktree: proto::WorktreeMetadata,
405 client: Arc<Client>,
406 cx: &mut AppContext,
407 ) -> ModelHandle<Self> {
408 cx.add_model(|cx: &mut ModelContext<Self>| {
409 let snapshot = Snapshot {
410 id: WorktreeId(worktree.id as usize),
411 abs_path: Arc::from(PathBuf::from(worktree.abs_path)),
412 root_name: worktree.root_name.clone(),
413 root_char_bag: worktree
414 .root_name
415 .chars()
416 .map(|c| c.to_ascii_lowercase())
417 .collect(),
418 entries_by_path: Default::default(),
419 entries_by_id: Default::default(),
420 repository_entries: Default::default(),
421 scan_id: 1,
422 completed_scan_id: 0,
423 };
424
425 let (updates_tx, mut updates_rx) = mpsc::unbounded();
426 let background_snapshot = Arc::new(Mutex::new(snapshot.clone()));
427 let (mut snapshot_updated_tx, mut snapshot_updated_rx) = watch::channel();
428
429 cx.background()
430 .spawn({
431 let background_snapshot = background_snapshot.clone();
432 async move {
433 while let Some(update) = updates_rx.next().await {
434 if let Err(error) =
435 background_snapshot.lock().apply_remote_update(update)
436 {
437 log::error!("error applying worktree update: {}", error);
438 }
439 snapshot_updated_tx.send(()).await.ok();
440 }
441 }
442 })
443 .detach();
444
445 cx.spawn_weak(|this, mut cx| async move {
446 while (snapshot_updated_rx.recv().await).is_some() {
447 if let Some(this) = this.upgrade(&cx) {
448 this.update(&mut cx, |this, cx| {
449 let this = this.as_remote_mut().unwrap();
450 this.snapshot = this.background_snapshot.lock().clone();
451 cx.emit(Event::UpdatedEntries(Arc::from([])));
452 cx.notify();
453 while let Some((scan_id, _)) = this.snapshot_subscriptions.front() {
454 if this.observed_snapshot(*scan_id) {
455 let (_, tx) = this.snapshot_subscriptions.pop_front().unwrap();
456 let _ = tx.send(());
457 } else {
458 break;
459 }
460 }
461 });
462 } else {
463 break;
464 }
465 }
466 })
467 .detach();
468
469 Worktree::Remote(RemoteWorktree {
470 project_id: project_remote_id,
471 replica_id,
472 snapshot: snapshot.clone(),
473 background_snapshot,
474 updates_tx: Some(updates_tx),
475 snapshot_subscriptions: Default::default(),
476 client: client.clone(),
477 diagnostic_summaries: Default::default(),
478 visible: worktree.visible,
479 disconnected: false,
480 })
481 })
482 }
483
484 pub fn as_local(&self) -> Option<&LocalWorktree> {
485 if let Worktree::Local(worktree) = self {
486 Some(worktree)
487 } else {
488 None
489 }
490 }
491
492 pub fn as_remote(&self) -> Option<&RemoteWorktree> {
493 if let Worktree::Remote(worktree) = self {
494 Some(worktree)
495 } else {
496 None
497 }
498 }
499
500 pub fn as_local_mut(&mut self) -> Option<&mut LocalWorktree> {
501 if let Worktree::Local(worktree) = self {
502 Some(worktree)
503 } else {
504 None
505 }
506 }
507
508 pub fn as_remote_mut(&mut self) -> Option<&mut RemoteWorktree> {
509 if let Worktree::Remote(worktree) = self {
510 Some(worktree)
511 } else {
512 None
513 }
514 }
515
516 pub fn is_local(&self) -> bool {
517 matches!(self, Worktree::Local(_))
518 }
519
520 pub fn is_remote(&self) -> bool {
521 !self.is_local()
522 }
523
524 pub fn snapshot(&self) -> Snapshot {
525 match self {
526 Worktree::Local(worktree) => worktree.snapshot().snapshot,
527 Worktree::Remote(worktree) => worktree.snapshot(),
528 }
529 }
530
531 pub fn scan_id(&self) -> usize {
532 match self {
533 Worktree::Local(worktree) => worktree.snapshot.scan_id,
534 Worktree::Remote(worktree) => worktree.snapshot.scan_id,
535 }
536 }
537
538 pub fn completed_scan_id(&self) -> usize {
539 match self {
540 Worktree::Local(worktree) => worktree.snapshot.completed_scan_id,
541 Worktree::Remote(worktree) => worktree.snapshot.completed_scan_id,
542 }
543 }
544
545 pub fn is_visible(&self) -> bool {
546 match self {
547 Worktree::Local(worktree) => worktree.visible,
548 Worktree::Remote(worktree) => worktree.visible,
549 }
550 }
551
552 pub fn replica_id(&self) -> ReplicaId {
553 match self {
554 Worktree::Local(_) => 0,
555 Worktree::Remote(worktree) => worktree.replica_id,
556 }
557 }
558
559 pub fn diagnostic_summaries(
560 &self,
561 ) -> impl Iterator<Item = (Arc<Path>, LanguageServerId, DiagnosticSummary)> + '_ {
562 match self {
563 Worktree::Local(worktree) => &worktree.diagnostic_summaries,
564 Worktree::Remote(worktree) => &worktree.diagnostic_summaries,
565 }
566 .iter()
567 .flat_map(|(path, summaries)| {
568 summaries
569 .iter()
570 .map(move |(&server_id, &summary)| (path.clone(), server_id, summary))
571 })
572 }
573
574 pub fn abs_path(&self) -> Arc<Path> {
575 match self {
576 Worktree::Local(worktree) => worktree.abs_path.clone(),
577 Worktree::Remote(worktree) => worktree.abs_path.clone(),
578 }
579 }
580
581 pub fn root_file(&self, cx: &mut ModelContext<Self>) -> Option<Arc<File>> {
582 let entry = self.root_entry()?;
583 Some(File::for_entry(entry.clone(), cx.handle()))
584 }
585}
586
587impl LocalWorktree {
588 pub fn contains_abs_path(&self, path: &Path) -> bool {
589 path.starts_with(&self.abs_path)
590 }
591
592 pub(crate) fn load_buffer(
593 &mut self,
594 id: u64,
595 path: &Path,
596 cx: &mut ModelContext<Worktree>,
597 ) -> Task<Result<ModelHandle<Buffer>>> {
598 let path = Arc::from(path);
599 cx.spawn(move |this, mut cx| async move {
600 let (file, contents, diff_base) = this
601 .update(&mut cx, |t, cx| t.as_local().unwrap().load(&path, cx))
602 .await?;
603 let text_buffer = cx
604 .background()
605 .spawn(async move { text::Buffer::new(0, id, contents) })
606 .await;
607 Ok(cx.add_model(|_| Buffer::build(text_buffer, diff_base, Some(Arc::new(file)))))
608 })
609 }
610
611 pub fn diagnostics_for_path(
612 &self,
613 path: &Path,
614 ) -> Vec<(
615 LanguageServerId,
616 Vec<DiagnosticEntry<Unclipped<PointUtf16>>>,
617 )> {
618 self.diagnostics.get(path).cloned().unwrap_or_default()
619 }
620
621 pub fn clear_diagnostics_for_language_server(
622 &mut self,
623 server_id: LanguageServerId,
624 _: &mut ModelContext<Worktree>,
625 ) {
626 let worktree_id = self.id().to_proto();
627 self.diagnostic_summaries
628 .retain(|path, summaries_by_server_id| {
629 if summaries_by_server_id.remove(&server_id).is_some() {
630 if let Some(share) = self.share.as_ref() {
631 self.client
632 .send(proto::UpdateDiagnosticSummary {
633 project_id: share.project_id,
634 worktree_id,
635 summary: Some(proto::DiagnosticSummary {
636 path: path.to_string_lossy().to_string(),
637 language_server_id: server_id.0 as u64,
638 error_count: 0,
639 warning_count: 0,
640 }),
641 })
642 .log_err();
643 }
644 !summaries_by_server_id.is_empty()
645 } else {
646 true
647 }
648 });
649
650 self.diagnostics.retain(|_, diagnostics_by_server_id| {
651 if let Ok(ix) = diagnostics_by_server_id.binary_search_by_key(&server_id, |e| e.0) {
652 diagnostics_by_server_id.remove(ix);
653 !diagnostics_by_server_id.is_empty()
654 } else {
655 true
656 }
657 });
658 }
659
660 pub fn update_diagnostics(
661 &mut self,
662 server_id: LanguageServerId,
663 worktree_path: Arc<Path>,
664 diagnostics: Vec<DiagnosticEntry<Unclipped<PointUtf16>>>,
665 _: &mut ModelContext<Worktree>,
666 ) -> Result<bool> {
667 let summaries_by_server_id = self
668 .diagnostic_summaries
669 .entry(worktree_path.clone())
670 .or_default();
671
672 let old_summary = summaries_by_server_id
673 .remove(&server_id)
674 .unwrap_or_default();
675
676 let new_summary = DiagnosticSummary::new(&diagnostics);
677 if new_summary.is_empty() {
678 if let Some(diagnostics_by_server_id) = self.diagnostics.get_mut(&worktree_path) {
679 if let Ok(ix) = diagnostics_by_server_id.binary_search_by_key(&server_id, |e| e.0) {
680 diagnostics_by_server_id.remove(ix);
681 }
682 if diagnostics_by_server_id.is_empty() {
683 self.diagnostics.remove(&worktree_path);
684 }
685 }
686 } else {
687 summaries_by_server_id.insert(server_id, new_summary);
688 let diagnostics_by_server_id =
689 self.diagnostics.entry(worktree_path.clone()).or_default();
690 match diagnostics_by_server_id.binary_search_by_key(&server_id, |e| e.0) {
691 Ok(ix) => {
692 diagnostics_by_server_id[ix] = (server_id, diagnostics);
693 }
694 Err(ix) => {
695 diagnostics_by_server_id.insert(ix, (server_id, diagnostics));
696 }
697 }
698 }
699
700 if !old_summary.is_empty() || !new_summary.is_empty() {
701 if let Some(share) = self.share.as_ref() {
702 self.client
703 .send(proto::UpdateDiagnosticSummary {
704 project_id: share.project_id,
705 worktree_id: self.id().to_proto(),
706 summary: Some(proto::DiagnosticSummary {
707 path: worktree_path.to_string_lossy().to_string(),
708 language_server_id: server_id.0 as u64,
709 error_count: new_summary.error_count as u32,
710 warning_count: new_summary.warning_count as u32,
711 }),
712 })
713 .log_err();
714 }
715 }
716
717 Ok(!old_summary.is_empty() || !new_summary.is_empty())
718 }
719
720 fn set_snapshot(
721 &mut self,
722 new_snapshot: LocalSnapshot,
723 entry_changes: UpdatedEntriesSet,
724 cx: &mut ModelContext<Worktree>,
725 ) {
726 let repo_changes = self.changed_repos(&self.snapshot, &new_snapshot);
727
728 self.snapshot = new_snapshot;
729
730 if let Some(share) = self.share.as_mut() {
731 share
732 .snapshots_tx
733 .unbounded_send((
734 self.snapshot.clone(),
735 entry_changes.clone(),
736 repo_changes.clone(),
737 ))
738 .ok();
739 }
740
741 if !entry_changes.is_empty() {
742 cx.emit(Event::UpdatedEntries(entry_changes));
743 }
744 if !repo_changes.is_empty() {
745 cx.emit(Event::UpdatedGitRepositories(repo_changes));
746 }
747 }
748
749 fn changed_repos(
750 &self,
751 old_snapshot: &LocalSnapshot,
752 new_snapshot: &LocalSnapshot,
753 ) -> UpdatedGitRepositoriesSet {
754 let mut changes = Vec::new();
755 let mut old_repos = old_snapshot.git_repositories.iter().peekable();
756 let mut new_repos = new_snapshot.git_repositories.iter().peekable();
757 loop {
758 match (new_repos.peek().map(clone), old_repos.peek().map(clone)) {
759 (Some((new_entry_id, new_repo)), Some((old_entry_id, old_repo))) => {
760 match Ord::cmp(&new_entry_id, &old_entry_id) {
761 Ordering::Less => {
762 if let Some(entry) = new_snapshot.entry_for_id(new_entry_id) {
763 changes.push((
764 entry.path.clone(),
765 GitRepositoryChange {
766 old_repository: None,
767 },
768 ));
769 }
770 new_repos.next();
771 }
772 Ordering::Equal => {
773 if new_repo.git_dir_scan_id != old_repo.git_dir_scan_id {
774 if let Some(entry) = new_snapshot.entry_for_id(new_entry_id) {
775 let old_repo = old_snapshot
776 .repository_entries
777 .get(&RepositoryWorkDirectory(entry.path.clone()))
778 .cloned();
779 changes.push((
780 entry.path.clone(),
781 GitRepositoryChange {
782 old_repository: old_repo,
783 },
784 ));
785 }
786 }
787 new_repos.next();
788 old_repos.next();
789 }
790 Ordering::Greater => {
791 if let Some(entry) = old_snapshot.entry_for_id(old_entry_id) {
792 let old_repo = old_snapshot
793 .repository_entries
794 .get(&RepositoryWorkDirectory(entry.path.clone()))
795 .cloned();
796 changes.push((
797 entry.path.clone(),
798 GitRepositoryChange {
799 old_repository: old_repo,
800 },
801 ));
802 }
803 old_repos.next();
804 }
805 }
806 }
807 (Some((entry_id, _)), None) => {
808 if let Some(entry) = new_snapshot.entry_for_id(entry_id) {
809 changes.push((
810 entry.path.clone(),
811 GitRepositoryChange {
812 old_repository: None,
813 },
814 ));
815 }
816 new_repos.next();
817 }
818 (None, Some((entry_id, _))) => {
819 if let Some(entry) = old_snapshot.entry_for_id(entry_id) {
820 let old_repo = old_snapshot
821 .repository_entries
822 .get(&RepositoryWorkDirectory(entry.path.clone()))
823 .cloned();
824 changes.push((
825 entry.path.clone(),
826 GitRepositoryChange {
827 old_repository: old_repo,
828 },
829 ));
830 }
831 old_repos.next();
832 }
833 (None, None) => break,
834 }
835 }
836
837 fn clone<T: Clone, U: Clone>(value: &(&T, &U)) -> (T, U) {
838 (value.0.clone(), value.1.clone())
839 }
840
841 changes.into()
842 }
843
844 pub fn scan_complete(&self) -> impl Future<Output = ()> {
845 let mut is_scanning_rx = self.is_scanning.1.clone();
846 async move {
847 let mut is_scanning = is_scanning_rx.borrow().clone();
848 while is_scanning {
849 if let Some(value) = is_scanning_rx.recv().await {
850 is_scanning = value;
851 } else {
852 break;
853 }
854 }
855 }
856 }
857
858 pub fn snapshot(&self) -> LocalSnapshot {
859 self.snapshot.clone()
860 }
861
862 pub fn metadata_proto(&self) -> proto::WorktreeMetadata {
863 proto::WorktreeMetadata {
864 id: self.id().to_proto(),
865 root_name: self.root_name().to_string(),
866 visible: self.visible,
867 abs_path: self.abs_path().as_os_str().to_string_lossy().into(),
868 }
869 }
870
871 fn load(
872 &self,
873 path: &Path,
874 cx: &mut ModelContext<Worktree>,
875 ) -> Task<Result<(File, String, Option<String>)>> {
876 let path = Arc::from(path);
877 let abs_path = self.absolutize(&path);
878 let fs = self.fs.clone();
879 let entry = self.refresh_entry(path.clone(), None, cx);
880
881 cx.spawn(|this, cx| async move {
882 let text = fs.load(&abs_path).await?;
883 let entry = entry.await?;
884
885 let mut index_task = None;
886 let snapshot = this.read_with(&cx, |this, _| this.as_local().unwrap().snapshot());
887 if let Some(repo) = snapshot.repository_for_path(&path) {
888 let repo_path = repo.work_directory.relativize(&snapshot, &path).unwrap();
889 if let Some(repo) = snapshot.git_repositories.get(&*repo.work_directory) {
890 let repo = repo.repo_ptr.clone();
891 index_task = Some(
892 cx.background()
893 .spawn(async move { repo.lock().load_index_text(&repo_path) }),
894 );
895 }
896 }
897
898 let diff_base = if let Some(index_task) = index_task {
899 index_task.await
900 } else {
901 None
902 };
903
904 Ok((
905 File {
906 entry_id: entry.id,
907 worktree: this,
908 path: entry.path,
909 mtime: entry.mtime,
910 is_local: true,
911 is_deleted: false,
912 },
913 text,
914 diff_base,
915 ))
916 })
917 }
918
919 pub fn save_buffer(
920 &self,
921 buffer_handle: ModelHandle<Buffer>,
922 path: Arc<Path>,
923 has_changed_file: bool,
924 cx: &mut ModelContext<Worktree>,
925 ) -> Task<Result<()>> {
926 let handle = cx.handle();
927 let buffer = buffer_handle.read(cx);
928
929 let rpc = self.client.clone();
930 let buffer_id = buffer.remote_id();
931 let project_id = self.share.as_ref().map(|share| share.project_id);
932
933 let text = buffer.as_rope().clone();
934 let fingerprint = text.fingerprint();
935 let version = buffer.version();
936 let save = self.write_file(path, text, buffer.line_ending(), cx);
937
938 cx.as_mut().spawn(|mut cx| async move {
939 let entry = save.await?;
940
941 if has_changed_file {
942 let new_file = Arc::new(File {
943 entry_id: entry.id,
944 worktree: handle,
945 path: entry.path,
946 mtime: entry.mtime,
947 is_local: true,
948 is_deleted: false,
949 });
950
951 if let Some(project_id) = project_id {
952 rpc.send(proto::UpdateBufferFile {
953 project_id,
954 buffer_id,
955 file: Some(new_file.to_proto()),
956 })
957 .log_err();
958 }
959
960 buffer_handle.update(&mut cx, |buffer, cx| {
961 if has_changed_file {
962 buffer.file_updated(new_file, cx).detach();
963 }
964 });
965 }
966
967 if let Some(project_id) = project_id {
968 rpc.send(proto::BufferSaved {
969 project_id,
970 buffer_id,
971 version: serialize_version(&version),
972 mtime: Some(entry.mtime.into()),
973 fingerprint: serialize_fingerprint(fingerprint),
974 })?;
975 }
976
977 buffer_handle.update(&mut cx, |buffer, cx| {
978 buffer.did_save(version.clone(), fingerprint, entry.mtime, cx);
979 });
980
981 Ok(())
982 })
983 }
984
985 /// Find the lowest path in the worktree's datastructures that is an ancestor
986 fn lowest_ancestor(&self, path: &Path) -> PathBuf {
987 let mut lowest_ancestor = None;
988 for path in path.ancestors() {
989 if self.entry_for_path(path).is_some() {
990 lowest_ancestor = Some(path.to_path_buf());
991 break;
992 }
993 }
994
995 lowest_ancestor.unwrap_or_else(|| PathBuf::from(""))
996 }
997
998 pub fn create_entry(
999 &self,
1000 path: impl Into<Arc<Path>>,
1001 is_dir: bool,
1002 cx: &mut ModelContext<Worktree>,
1003 ) -> Task<Result<Entry>> {
1004 let path = path.into();
1005 let lowest_ancestor = self.lowest_ancestor(&path);
1006 let abs_path = self.absolutize(&path);
1007 let fs = self.fs.clone();
1008 let write = cx.background().spawn(async move {
1009 if is_dir {
1010 fs.create_dir(&abs_path).await
1011 } else {
1012 fs.save(&abs_path, &Default::default(), Default::default())
1013 .await
1014 }
1015 });
1016
1017 cx.spawn(|this, mut cx| async move {
1018 write.await?;
1019 let (result, refreshes) = this.update(&mut cx, |this, cx| {
1020 let mut refreshes = Vec::<Task<anyhow::Result<Entry>>>::new();
1021 let refresh_paths = path.strip_prefix(&lowest_ancestor).unwrap();
1022 for refresh_path in refresh_paths.ancestors() {
1023 if refresh_path == Path::new("") {
1024 continue;
1025 }
1026 let refresh_full_path = lowest_ancestor.join(refresh_path);
1027
1028 refreshes.push(this.as_local_mut().unwrap().refresh_entry(
1029 refresh_full_path.into(),
1030 None,
1031 cx,
1032 ));
1033 }
1034 (
1035 this.as_local_mut().unwrap().refresh_entry(path, None, cx),
1036 refreshes,
1037 )
1038 });
1039 for refresh in refreshes {
1040 refresh.await.log_err();
1041 }
1042
1043 result.await
1044 })
1045 }
1046
1047 pub fn write_file(
1048 &self,
1049 path: impl Into<Arc<Path>>,
1050 text: Rope,
1051 line_ending: LineEnding,
1052 cx: &mut ModelContext<Worktree>,
1053 ) -> Task<Result<Entry>> {
1054 let path = path.into();
1055 let abs_path = self.absolutize(&path);
1056 let fs = self.fs.clone();
1057 let write = cx
1058 .background()
1059 .spawn(async move { fs.save(&abs_path, &text, line_ending).await });
1060
1061 cx.spawn(|this, mut cx| async move {
1062 write.await?;
1063 this.update(&mut cx, |this, cx| {
1064 this.as_local_mut().unwrap().refresh_entry(path, None, cx)
1065 })
1066 .await
1067 })
1068 }
1069
1070 pub fn delete_entry(
1071 &self,
1072 entry_id: ProjectEntryId,
1073 cx: &mut ModelContext<Worktree>,
1074 ) -> Option<Task<Result<()>>> {
1075 let entry = self.entry_for_id(entry_id)?.clone();
1076 let abs_path = self.absolutize(&entry.path);
1077 let fs = self.fs.clone();
1078
1079 let delete = cx.background().spawn(async move {
1080 if entry.is_file() {
1081 fs.remove_file(&abs_path, Default::default()).await?;
1082 } else {
1083 fs.remove_dir(
1084 &abs_path,
1085 RemoveOptions {
1086 recursive: true,
1087 ignore_if_not_exists: false,
1088 },
1089 )
1090 .await?;
1091 }
1092 anyhow::Ok(entry.path)
1093 });
1094
1095 Some(cx.spawn(|this, mut cx| async move {
1096 let path = delete.await?;
1097 this.update(&mut cx, |this, _| {
1098 this.as_local_mut()
1099 .unwrap()
1100 .refresh_entries_for_paths(vec![path])
1101 })
1102 .recv()
1103 .await;
1104 Ok(())
1105 }))
1106 }
1107
1108 pub fn rename_entry(
1109 &self,
1110 entry_id: ProjectEntryId,
1111 new_path: impl Into<Arc<Path>>,
1112 cx: &mut ModelContext<Worktree>,
1113 ) -> Option<Task<Result<Entry>>> {
1114 let old_path = self.entry_for_id(entry_id)?.path.clone();
1115 let new_path = new_path.into();
1116 let abs_old_path = self.absolutize(&old_path);
1117 let abs_new_path = self.absolutize(&new_path);
1118 let fs = self.fs.clone();
1119 let rename = cx.background().spawn(async move {
1120 fs.rename(&abs_old_path, &abs_new_path, Default::default())
1121 .await
1122 });
1123
1124 Some(cx.spawn(|this, mut cx| async move {
1125 rename.await?;
1126 this.update(&mut cx, |this, cx| {
1127 this.as_local_mut()
1128 .unwrap()
1129 .refresh_entry(new_path.clone(), Some(old_path), cx)
1130 })
1131 .await
1132 }))
1133 }
1134
1135 pub fn copy_entry(
1136 &self,
1137 entry_id: ProjectEntryId,
1138 new_path: impl Into<Arc<Path>>,
1139 cx: &mut ModelContext<Worktree>,
1140 ) -> Option<Task<Result<Entry>>> {
1141 let old_path = self.entry_for_id(entry_id)?.path.clone();
1142 let new_path = new_path.into();
1143 let abs_old_path = self.absolutize(&old_path);
1144 let abs_new_path = self.absolutize(&new_path);
1145 let fs = self.fs.clone();
1146 let copy = cx.background().spawn(async move {
1147 copy_recursive(
1148 fs.as_ref(),
1149 &abs_old_path,
1150 &abs_new_path,
1151 Default::default(),
1152 )
1153 .await
1154 });
1155
1156 Some(cx.spawn(|this, mut cx| async move {
1157 copy.await?;
1158 this.update(&mut cx, |this, cx| {
1159 this.as_local_mut()
1160 .unwrap()
1161 .refresh_entry(new_path.clone(), None, cx)
1162 })
1163 .await
1164 }))
1165 }
1166
1167 pub fn expand_entry(
1168 &mut self,
1169 entry_id: ProjectEntryId,
1170 cx: &mut ModelContext<Worktree>,
1171 ) -> Option<Task<Result<()>>> {
1172 let path = self.entry_for_id(entry_id)?.path.clone();
1173 let mut refresh = self.refresh_entries_for_paths(vec![path]);
1174 Some(cx.background().spawn(async move {
1175 refresh.next().await;
1176 Ok(())
1177 }))
1178 }
1179
1180 pub fn refresh_entries_for_paths(&self, paths: Vec<Arc<Path>>) -> barrier::Receiver {
1181 let (tx, rx) = barrier::channel();
1182 self.scan_requests_tx
1183 .try_send(ScanRequest {
1184 relative_paths: paths,
1185 done: tx,
1186 })
1187 .ok();
1188 rx
1189 }
1190
1191 pub fn add_path_prefix_to_scan(&self, path_prefix: Arc<Path>) {
1192 self.path_prefixes_to_scan_tx.try_send(path_prefix).ok();
1193 }
1194
1195 fn refresh_entry(
1196 &self,
1197 path: Arc<Path>,
1198 old_path: Option<Arc<Path>>,
1199 cx: &mut ModelContext<Worktree>,
1200 ) -> Task<Result<Entry>> {
1201 let paths = if let Some(old_path) = old_path.as_ref() {
1202 vec![old_path.clone(), path.clone()]
1203 } else {
1204 vec![path.clone()]
1205 };
1206 let mut refresh = self.refresh_entries_for_paths(paths);
1207 cx.spawn_weak(move |this, mut cx| async move {
1208 refresh.recv().await;
1209 this.upgrade(&cx)
1210 .ok_or_else(|| anyhow!("worktree was dropped"))?
1211 .update(&mut cx, |this, _| {
1212 this.entry_for_path(path)
1213 .cloned()
1214 .ok_or_else(|| anyhow!("failed to read path after update"))
1215 })
1216 })
1217 }
1218
1219 pub fn observe_updates<F, Fut>(
1220 &mut self,
1221 project_id: u64,
1222 cx: &mut ModelContext<Worktree>,
1223 callback: F,
1224 ) -> oneshot::Receiver<()>
1225 where
1226 F: 'static + Send + Fn(proto::UpdateWorktree) -> Fut,
1227 Fut: Send + Future<Output = bool>,
1228 {
1229 #[cfg(any(test, feature = "test-support"))]
1230 const MAX_CHUNK_SIZE: usize = 2;
1231 #[cfg(not(any(test, feature = "test-support")))]
1232 const MAX_CHUNK_SIZE: usize = 256;
1233
1234 let (share_tx, share_rx) = oneshot::channel();
1235
1236 if let Some(share) = self.share.as_mut() {
1237 share_tx.send(()).ok();
1238 *share.resume_updates.borrow_mut() = ();
1239 return share_rx;
1240 }
1241
1242 let (resume_updates_tx, mut resume_updates_rx) = watch::channel::<()>();
1243 let (snapshots_tx, mut snapshots_rx) =
1244 mpsc::unbounded::<(LocalSnapshot, UpdatedEntriesSet, UpdatedGitRepositoriesSet)>();
1245 snapshots_tx
1246 .unbounded_send((self.snapshot(), Arc::from([]), Arc::from([])))
1247 .ok();
1248
1249 let worktree_id = cx.model_id() as u64;
1250 let _maintain_remote_snapshot = cx.background().spawn(async move {
1251 let mut is_first = true;
1252 while let Some((snapshot, entry_changes, repo_changes)) = snapshots_rx.next().await {
1253 let update;
1254 if is_first {
1255 update = snapshot.build_initial_update(project_id, worktree_id);
1256 is_first = false;
1257 } else {
1258 update =
1259 snapshot.build_update(project_id, worktree_id, entry_changes, repo_changes);
1260 }
1261
1262 for update in proto::split_worktree_update(update, MAX_CHUNK_SIZE) {
1263 let _ = resume_updates_rx.try_recv();
1264 loop {
1265 let result = callback(update.clone());
1266 if result.await {
1267 break;
1268 } else {
1269 log::info!("waiting to resume updates");
1270 if resume_updates_rx.next().await.is_none() {
1271 return Some(());
1272 }
1273 }
1274 }
1275 }
1276 }
1277 share_tx.send(()).ok();
1278 Some(())
1279 });
1280
1281 self.share = Some(ShareState {
1282 project_id,
1283 snapshots_tx,
1284 resume_updates: resume_updates_tx,
1285 _maintain_remote_snapshot,
1286 });
1287 share_rx
1288 }
1289
1290 pub fn share(&mut self, project_id: u64, cx: &mut ModelContext<Worktree>) -> Task<Result<()>> {
1291 let client = self.client.clone();
1292
1293 for (path, summaries) in &self.diagnostic_summaries {
1294 for (&server_id, summary) in summaries {
1295 if let Err(e) = self.client.send(proto::UpdateDiagnosticSummary {
1296 project_id,
1297 worktree_id: cx.model_id() as u64,
1298 summary: Some(summary.to_proto(server_id, &path)),
1299 }) {
1300 return Task::ready(Err(e));
1301 }
1302 }
1303 }
1304
1305 let rx = self.observe_updates(project_id, cx, move |update| {
1306 client.request(update).map(|result| result.is_ok())
1307 });
1308 cx.foreground()
1309 .spawn(async move { rx.await.map_err(|_| anyhow!("share ended")) })
1310 }
1311
1312 pub fn unshare(&mut self) {
1313 self.share.take();
1314 }
1315
1316 pub fn is_shared(&self) -> bool {
1317 self.share.is_some()
1318 }
1319}
1320
1321impl RemoteWorktree {
1322 fn snapshot(&self) -> Snapshot {
1323 self.snapshot.clone()
1324 }
1325
1326 pub fn disconnected_from_host(&mut self) {
1327 self.updates_tx.take();
1328 self.snapshot_subscriptions.clear();
1329 self.disconnected = true;
1330 }
1331
1332 pub fn save_buffer(
1333 &self,
1334 buffer_handle: ModelHandle<Buffer>,
1335 cx: &mut ModelContext<Worktree>,
1336 ) -> Task<Result<()>> {
1337 let buffer = buffer_handle.read(cx);
1338 let buffer_id = buffer.remote_id();
1339 let version = buffer.version();
1340 let rpc = self.client.clone();
1341 let project_id = self.project_id;
1342 cx.as_mut().spawn(|mut cx| async move {
1343 let response = rpc
1344 .request(proto::SaveBuffer {
1345 project_id,
1346 buffer_id,
1347 version: serialize_version(&version),
1348 })
1349 .await?;
1350 let version = deserialize_version(&response.version);
1351 let fingerprint = deserialize_fingerprint(&response.fingerprint)?;
1352 let mtime = response
1353 .mtime
1354 .ok_or_else(|| anyhow!("missing mtime"))?
1355 .into();
1356
1357 buffer_handle.update(&mut cx, |buffer, cx| {
1358 buffer.did_save(version.clone(), fingerprint, mtime, cx);
1359 });
1360
1361 Ok(())
1362 })
1363 }
1364
1365 pub fn update_from_remote(&mut self, update: proto::UpdateWorktree) {
1366 if let Some(updates_tx) = &self.updates_tx {
1367 updates_tx
1368 .unbounded_send(update)
1369 .expect("consumer runs to completion");
1370 }
1371 }
1372
1373 fn observed_snapshot(&self, scan_id: usize) -> bool {
1374 self.completed_scan_id >= scan_id
1375 }
1376
1377 pub(crate) fn wait_for_snapshot(&mut self, scan_id: usize) -> impl Future<Output = Result<()>> {
1378 let (tx, rx) = oneshot::channel();
1379 if self.observed_snapshot(scan_id) {
1380 let _ = tx.send(());
1381 } else if self.disconnected {
1382 drop(tx);
1383 } else {
1384 match self
1385 .snapshot_subscriptions
1386 .binary_search_by_key(&scan_id, |probe| probe.0)
1387 {
1388 Ok(ix) | Err(ix) => self.snapshot_subscriptions.insert(ix, (scan_id, tx)),
1389 }
1390 }
1391
1392 async move {
1393 rx.await?;
1394 Ok(())
1395 }
1396 }
1397
1398 pub fn update_diagnostic_summary(
1399 &mut self,
1400 path: Arc<Path>,
1401 summary: &proto::DiagnosticSummary,
1402 ) {
1403 let server_id = LanguageServerId(summary.language_server_id as usize);
1404 let summary = DiagnosticSummary {
1405 error_count: summary.error_count as usize,
1406 warning_count: summary.warning_count as usize,
1407 };
1408
1409 if summary.is_empty() {
1410 if let Some(summaries) = self.diagnostic_summaries.get_mut(&path) {
1411 summaries.remove(&server_id);
1412 if summaries.is_empty() {
1413 self.diagnostic_summaries.remove(&path);
1414 }
1415 }
1416 } else {
1417 self.diagnostic_summaries
1418 .entry(path)
1419 .or_default()
1420 .insert(server_id, summary);
1421 }
1422 }
1423
1424 pub fn insert_entry(
1425 &mut self,
1426 entry: proto::Entry,
1427 scan_id: usize,
1428 cx: &mut ModelContext<Worktree>,
1429 ) -> Task<Result<Entry>> {
1430 let wait_for_snapshot = self.wait_for_snapshot(scan_id);
1431 cx.spawn(|this, mut cx| async move {
1432 wait_for_snapshot.await?;
1433 this.update(&mut cx, |worktree, _| {
1434 let worktree = worktree.as_remote_mut().unwrap();
1435 let mut snapshot = worktree.background_snapshot.lock();
1436 let entry = snapshot.insert_entry(entry);
1437 worktree.snapshot = snapshot.clone();
1438 entry
1439 })
1440 })
1441 }
1442
1443 pub(crate) fn delete_entry(
1444 &mut self,
1445 id: ProjectEntryId,
1446 scan_id: usize,
1447 cx: &mut ModelContext<Worktree>,
1448 ) -> Task<Result<()>> {
1449 let wait_for_snapshot = self.wait_for_snapshot(scan_id);
1450 cx.spawn(|this, mut cx| async move {
1451 wait_for_snapshot.await?;
1452 this.update(&mut cx, |worktree, _| {
1453 let worktree = worktree.as_remote_mut().unwrap();
1454 let mut snapshot = worktree.background_snapshot.lock();
1455 snapshot.delete_entry(id);
1456 worktree.snapshot = snapshot.clone();
1457 });
1458 Ok(())
1459 })
1460 }
1461}
1462
1463impl Snapshot {
1464 pub fn id(&self) -> WorktreeId {
1465 self.id
1466 }
1467
1468 pub fn abs_path(&self) -> &Arc<Path> {
1469 &self.abs_path
1470 }
1471
1472 pub fn absolutize(&self, path: &Path) -> PathBuf {
1473 if path.file_name().is_some() {
1474 self.abs_path.join(path)
1475 } else {
1476 self.abs_path.to_path_buf()
1477 }
1478 }
1479
1480 pub fn contains_entry(&self, entry_id: ProjectEntryId) -> bool {
1481 self.entries_by_id.get(&entry_id, &()).is_some()
1482 }
1483
1484 pub(crate) fn insert_entry(&mut self, entry: proto::Entry) -> Result<Entry> {
1485 let entry = Entry::try_from((&self.root_char_bag, entry))?;
1486 let old_entry = self.entries_by_id.insert_or_replace(
1487 PathEntry {
1488 id: entry.id,
1489 path: entry.path.clone(),
1490 is_ignored: entry.is_ignored,
1491 scan_id: 0,
1492 },
1493 &(),
1494 );
1495 if let Some(old_entry) = old_entry {
1496 self.entries_by_path.remove(&PathKey(old_entry.path), &());
1497 }
1498 self.entries_by_path.insert_or_replace(entry.clone(), &());
1499 Ok(entry)
1500 }
1501
1502 fn delete_entry(&mut self, entry_id: ProjectEntryId) -> Option<Arc<Path>> {
1503 let removed_entry = self.entries_by_id.remove(&entry_id, &())?;
1504 self.entries_by_path = {
1505 let mut cursor = self.entries_by_path.cursor::<TraversalProgress>();
1506 let mut new_entries_by_path =
1507 cursor.slice(&TraversalTarget::Path(&removed_entry.path), Bias::Left, &());
1508 while let Some(entry) = cursor.item() {
1509 if entry.path.starts_with(&removed_entry.path) {
1510 self.entries_by_id.remove(&entry.id, &());
1511 cursor.next(&());
1512 } else {
1513 break;
1514 }
1515 }
1516 new_entries_by_path.append(cursor.suffix(&()), &());
1517 new_entries_by_path
1518 };
1519
1520 Some(removed_entry.path)
1521 }
1522
1523 #[cfg(any(test, feature = "test-support"))]
1524 pub fn status_for_file(&self, path: impl Into<PathBuf>) -> Option<GitFileStatus> {
1525 let path = path.into();
1526 self.entries_by_path
1527 .get(&PathKey(Arc::from(path)), &())
1528 .and_then(|entry| entry.git_status)
1529 }
1530
1531 pub(crate) fn apply_remote_update(&mut self, mut update: proto::UpdateWorktree) -> Result<()> {
1532 let mut entries_by_path_edits = Vec::new();
1533 let mut entries_by_id_edits = Vec::new();
1534
1535 for entry_id in update.removed_entries {
1536 let entry_id = ProjectEntryId::from_proto(entry_id);
1537 entries_by_id_edits.push(Edit::Remove(entry_id));
1538 if let Some(entry) = self.entry_for_id(entry_id) {
1539 entries_by_path_edits.push(Edit::Remove(PathKey(entry.path.clone())));
1540 }
1541 }
1542
1543 for entry in update.updated_entries {
1544 let entry = Entry::try_from((&self.root_char_bag, entry))?;
1545 if let Some(PathEntry { path, .. }) = self.entries_by_id.get(&entry.id, &()) {
1546 entries_by_path_edits.push(Edit::Remove(PathKey(path.clone())));
1547 }
1548 if let Some(old_entry) = self.entries_by_path.get(&PathKey(entry.path.clone()), &()) {
1549 if old_entry.id != entry.id {
1550 entries_by_id_edits.push(Edit::Remove(old_entry.id));
1551 }
1552 }
1553 entries_by_id_edits.push(Edit::Insert(PathEntry {
1554 id: entry.id,
1555 path: entry.path.clone(),
1556 is_ignored: entry.is_ignored,
1557 scan_id: 0,
1558 }));
1559 entries_by_path_edits.push(Edit::Insert(entry));
1560 }
1561
1562 self.entries_by_path.edit(entries_by_path_edits, &());
1563 self.entries_by_id.edit(entries_by_id_edits, &());
1564
1565 update.removed_repositories.sort_unstable();
1566 self.repository_entries.retain(|_, entry| {
1567 if let Ok(_) = update
1568 .removed_repositories
1569 .binary_search(&entry.work_directory.to_proto())
1570 {
1571 false
1572 } else {
1573 true
1574 }
1575 });
1576
1577 for repository in update.updated_repositories {
1578 let work_directory_entry: WorkDirectoryEntry =
1579 ProjectEntryId::from_proto(repository.work_directory_id).into();
1580
1581 if let Some(entry) = self.entry_for_id(*work_directory_entry) {
1582 let work_directory = RepositoryWorkDirectory(entry.path.clone());
1583 if self.repository_entries.get(&work_directory).is_some() {
1584 self.repository_entries.update(&work_directory, |repo| {
1585 repo.branch = repository.branch.map(Into::into);
1586 });
1587 } else {
1588 self.repository_entries.insert(
1589 work_directory,
1590 RepositoryEntry {
1591 work_directory: work_directory_entry,
1592 branch: repository.branch.map(Into::into),
1593 },
1594 )
1595 }
1596 } else {
1597 log::error!("no work directory entry for repository {:?}", repository)
1598 }
1599 }
1600
1601 self.scan_id = update.scan_id as usize;
1602 if update.is_last_update {
1603 self.completed_scan_id = update.scan_id as usize;
1604 }
1605
1606 Ok(())
1607 }
1608
1609 pub fn file_count(&self) -> usize {
1610 self.entries_by_path.summary().file_count
1611 }
1612
1613 pub fn visible_file_count(&self) -> usize {
1614 self.entries_by_path.summary().non_ignored_file_count
1615 }
1616
1617 fn traverse_from_offset(
1618 &self,
1619 include_dirs: bool,
1620 include_ignored: bool,
1621 start_offset: usize,
1622 ) -> Traversal {
1623 let mut cursor = self.entries_by_path.cursor();
1624 cursor.seek(
1625 &TraversalTarget::Count {
1626 count: start_offset,
1627 include_dirs,
1628 include_ignored,
1629 },
1630 Bias::Right,
1631 &(),
1632 );
1633 Traversal {
1634 cursor,
1635 include_dirs,
1636 include_ignored,
1637 }
1638 }
1639
1640 fn traverse_from_path(
1641 &self,
1642 include_dirs: bool,
1643 include_ignored: bool,
1644 path: &Path,
1645 ) -> Traversal {
1646 let mut cursor = self.entries_by_path.cursor();
1647 cursor.seek(&TraversalTarget::Path(path), Bias::Left, &());
1648 Traversal {
1649 cursor,
1650 include_dirs,
1651 include_ignored,
1652 }
1653 }
1654
1655 pub fn files(&self, include_ignored: bool, start: usize) -> Traversal {
1656 self.traverse_from_offset(false, include_ignored, start)
1657 }
1658
1659 pub fn entries(&self, include_ignored: bool) -> Traversal {
1660 self.traverse_from_offset(true, include_ignored, 0)
1661 }
1662
1663 pub fn repositories(&self) -> impl Iterator<Item = (&Arc<Path>, &RepositoryEntry)> {
1664 self.repository_entries
1665 .iter()
1666 .map(|(path, entry)| (&path.0, entry))
1667 }
1668
1669 /// Get the repository whose work directory contains the given path.
1670 pub fn repository_for_work_directory(&self, path: &Path) -> Option<RepositoryEntry> {
1671 self.repository_entries
1672 .get(&RepositoryWorkDirectory(path.into()))
1673 .cloned()
1674 }
1675
1676 /// Get the repository whose work directory contains the given path.
1677 pub fn repository_for_path(&self, path: &Path) -> Option<RepositoryEntry> {
1678 self.repository_and_work_directory_for_path(path)
1679 .map(|e| e.1)
1680 }
1681
1682 pub fn repository_and_work_directory_for_path(
1683 &self,
1684 path: &Path,
1685 ) -> Option<(RepositoryWorkDirectory, RepositoryEntry)> {
1686 self.repository_entries
1687 .iter()
1688 .filter(|(workdir_path, _)| path.starts_with(workdir_path))
1689 .last()
1690 .map(|(path, repo)| (path.clone(), repo.clone()))
1691 }
1692
1693 /// Given an ordered iterator of entries, returns an iterator of those entries,
1694 /// along with their containing git repository.
1695 pub fn entries_with_repositories<'a>(
1696 &'a self,
1697 entries: impl 'a + Iterator<Item = &'a Entry>,
1698 ) -> impl 'a + Iterator<Item = (&'a Entry, Option<&'a RepositoryEntry>)> {
1699 let mut containing_repos = Vec::<(&Arc<Path>, &RepositoryEntry)>::new();
1700 let mut repositories = self.repositories().peekable();
1701 entries.map(move |entry| {
1702 while let Some((repo_path, _)) = containing_repos.last() {
1703 if !entry.path.starts_with(repo_path) {
1704 containing_repos.pop();
1705 } else {
1706 break;
1707 }
1708 }
1709 while let Some((repo_path, _)) = repositories.peek() {
1710 if entry.path.starts_with(repo_path) {
1711 containing_repos.push(repositories.next().unwrap());
1712 } else {
1713 break;
1714 }
1715 }
1716 let repo = containing_repos.last().map(|(_, repo)| *repo);
1717 (entry, repo)
1718 })
1719 }
1720
1721 /// Update the `git_status` of the given entries such that files'
1722 /// statuses bubble up to their ancestor directories.
1723 pub fn propagate_git_statuses(&self, result: &mut [Entry]) {
1724 let mut cursor = self
1725 .entries_by_path
1726 .cursor::<(TraversalProgress, GitStatuses)>();
1727 let mut entry_stack = Vec::<(usize, GitStatuses)>::new();
1728
1729 let mut result_ix = 0;
1730 loop {
1731 let next_entry = result.get(result_ix);
1732 let containing_entry = entry_stack.last().map(|(ix, _)| &result[*ix]);
1733
1734 let entry_to_finish = match (containing_entry, next_entry) {
1735 (Some(_), None) => entry_stack.pop(),
1736 (Some(containing_entry), Some(next_path)) => {
1737 if !next_path.path.starts_with(&containing_entry.path) {
1738 entry_stack.pop()
1739 } else {
1740 None
1741 }
1742 }
1743 (None, Some(_)) => None,
1744 (None, None) => break,
1745 };
1746
1747 if let Some((entry_ix, prev_statuses)) = entry_to_finish {
1748 cursor.seek_forward(
1749 &TraversalTarget::PathSuccessor(&result[entry_ix].path),
1750 Bias::Left,
1751 &(),
1752 );
1753
1754 let statuses = cursor.start().1 - prev_statuses;
1755
1756 result[entry_ix].git_status = if statuses.conflict > 0 {
1757 Some(GitFileStatus::Conflict)
1758 } else if statuses.modified > 0 {
1759 Some(GitFileStatus::Modified)
1760 } else if statuses.added > 0 {
1761 Some(GitFileStatus::Added)
1762 } else {
1763 None
1764 };
1765 } else {
1766 if result[result_ix].is_dir() {
1767 cursor.seek_forward(
1768 &TraversalTarget::Path(&result[result_ix].path),
1769 Bias::Left,
1770 &(),
1771 );
1772 entry_stack.push((result_ix, cursor.start().1));
1773 }
1774 result_ix += 1;
1775 }
1776 }
1777 }
1778
1779 pub fn paths(&self) -> impl Iterator<Item = &Arc<Path>> {
1780 let empty_path = Path::new("");
1781 self.entries_by_path
1782 .cursor::<()>()
1783 .filter(move |entry| entry.path.as_ref() != empty_path)
1784 .map(|entry| &entry.path)
1785 }
1786
1787 fn child_entries<'a>(&'a self, parent_path: &'a Path) -> ChildEntriesIter<'a> {
1788 let mut cursor = self.entries_by_path.cursor();
1789 cursor.seek(&TraversalTarget::Path(parent_path), Bias::Right, &());
1790 let traversal = Traversal {
1791 cursor,
1792 include_dirs: true,
1793 include_ignored: true,
1794 };
1795 ChildEntriesIter {
1796 traversal,
1797 parent_path,
1798 }
1799 }
1800
1801 pub fn descendent_entries<'a>(
1802 &'a self,
1803 include_dirs: bool,
1804 include_ignored: bool,
1805 parent_path: &'a Path,
1806 ) -> DescendentEntriesIter<'a> {
1807 let mut cursor = self.entries_by_path.cursor();
1808 cursor.seek(&TraversalTarget::Path(parent_path), Bias::Left, &());
1809 let mut traversal = Traversal {
1810 cursor,
1811 include_dirs,
1812 include_ignored,
1813 };
1814
1815 if traversal.end_offset() == traversal.start_offset() {
1816 traversal.advance();
1817 }
1818
1819 DescendentEntriesIter {
1820 traversal,
1821 parent_path,
1822 }
1823 }
1824
1825 pub fn root_entry(&self) -> Option<&Entry> {
1826 self.entry_for_path("")
1827 }
1828
1829 pub fn root_name(&self) -> &str {
1830 &self.root_name
1831 }
1832
1833 pub fn root_git_entry(&self) -> Option<RepositoryEntry> {
1834 self.repository_entries
1835 .get(&RepositoryWorkDirectory(Path::new("").into()))
1836 .map(|entry| entry.to_owned())
1837 }
1838
1839 pub fn git_entries(&self) -> impl Iterator<Item = &RepositoryEntry> {
1840 self.repository_entries.values()
1841 }
1842
1843 pub fn scan_id(&self) -> usize {
1844 self.scan_id
1845 }
1846
1847 pub fn entry_for_path(&self, path: impl AsRef<Path>) -> Option<&Entry> {
1848 let path = path.as_ref();
1849 self.traverse_from_path(true, true, path)
1850 .entry()
1851 .and_then(|entry| {
1852 if entry.path.as_ref() == path {
1853 Some(entry)
1854 } else {
1855 None
1856 }
1857 })
1858 }
1859
1860 pub fn entry_for_id(&self, id: ProjectEntryId) -> Option<&Entry> {
1861 let entry = self.entries_by_id.get(&id, &())?;
1862 self.entry_for_path(&entry.path)
1863 }
1864
1865 pub fn inode_for_path(&self, path: impl AsRef<Path>) -> Option<u64> {
1866 self.entry_for_path(path.as_ref()).map(|e| e.inode)
1867 }
1868}
1869
1870impl LocalSnapshot {
1871 pub(crate) fn get_local_repo(&self, repo: &RepositoryEntry) -> Option<&LocalRepositoryEntry> {
1872 self.git_repositories.get(&repo.work_directory.0)
1873 }
1874
1875 pub(crate) fn local_repo_for_path(
1876 &self,
1877 path: &Path,
1878 ) -> Option<(RepositoryWorkDirectory, &LocalRepositoryEntry)> {
1879 let (path, repo) = self.repository_and_work_directory_for_path(path)?;
1880 Some((path, self.git_repositories.get(&repo.work_directory_id())?))
1881 }
1882
1883 fn build_update(
1884 &self,
1885 project_id: u64,
1886 worktree_id: u64,
1887 entry_changes: UpdatedEntriesSet,
1888 repo_changes: UpdatedGitRepositoriesSet,
1889 ) -> proto::UpdateWorktree {
1890 let mut updated_entries = Vec::new();
1891 let mut removed_entries = Vec::new();
1892 let mut updated_repositories = Vec::new();
1893 let mut removed_repositories = Vec::new();
1894
1895 for (_, entry_id, path_change) in entry_changes.iter() {
1896 if let PathChange::Removed = path_change {
1897 removed_entries.push(entry_id.0 as u64);
1898 } else if let Some(entry) = self.entry_for_id(*entry_id) {
1899 updated_entries.push(proto::Entry::from(entry));
1900 }
1901 }
1902
1903 for (work_dir_path, change) in repo_changes.iter() {
1904 let new_repo = self
1905 .repository_entries
1906 .get(&RepositoryWorkDirectory(work_dir_path.clone()));
1907 match (&change.old_repository, new_repo) {
1908 (Some(old_repo), Some(new_repo)) => {
1909 updated_repositories.push(new_repo.build_update(old_repo));
1910 }
1911 (None, Some(new_repo)) => {
1912 updated_repositories.push(proto::RepositoryEntry::from(new_repo));
1913 }
1914 (Some(old_repo), None) => {
1915 removed_repositories.push(old_repo.work_directory.0.to_proto());
1916 }
1917 _ => {}
1918 }
1919 }
1920
1921 removed_entries.sort_unstable();
1922 updated_entries.sort_unstable_by_key(|e| e.id);
1923 removed_repositories.sort_unstable();
1924 updated_repositories.sort_unstable_by_key(|e| e.work_directory_id);
1925
1926 // TODO - optimize, knowing that removed_entries are sorted.
1927 removed_entries.retain(|id| updated_entries.binary_search_by_key(id, |e| e.id).is_err());
1928
1929 proto::UpdateWorktree {
1930 project_id,
1931 worktree_id,
1932 abs_path: self.abs_path().to_string_lossy().into(),
1933 root_name: self.root_name().to_string(),
1934 updated_entries,
1935 removed_entries,
1936 scan_id: self.scan_id as u64,
1937 is_last_update: self.completed_scan_id == self.scan_id,
1938 updated_repositories,
1939 removed_repositories,
1940 }
1941 }
1942
1943 fn build_initial_update(&self, project_id: u64, worktree_id: u64) -> proto::UpdateWorktree {
1944 let mut updated_entries = self
1945 .entries_by_path
1946 .iter()
1947 .map(proto::Entry::from)
1948 .collect::<Vec<_>>();
1949 updated_entries.sort_unstable_by_key(|e| e.id);
1950
1951 let mut updated_repositories = self
1952 .repository_entries
1953 .values()
1954 .map(proto::RepositoryEntry::from)
1955 .collect::<Vec<_>>();
1956 updated_repositories.sort_unstable_by_key(|e| e.work_directory_id);
1957
1958 proto::UpdateWorktree {
1959 project_id,
1960 worktree_id,
1961 abs_path: self.abs_path().to_string_lossy().into(),
1962 root_name: self.root_name().to_string(),
1963 updated_entries,
1964 removed_entries: Vec::new(),
1965 scan_id: self.scan_id as u64,
1966 is_last_update: self.completed_scan_id == self.scan_id,
1967 updated_repositories,
1968 removed_repositories: Vec::new(),
1969 }
1970 }
1971
1972 fn insert_entry(&mut self, mut entry: Entry, fs: &dyn Fs) -> Entry {
1973 if entry.is_file() && entry.path.file_name() == Some(&GITIGNORE) {
1974 let abs_path = self.abs_path.join(&entry.path);
1975 match smol::block_on(build_gitignore(&abs_path, fs)) {
1976 Ok(ignore) => {
1977 self.ignores_by_parent_abs_path
1978 .insert(abs_path.parent().unwrap().into(), (Arc::new(ignore), true));
1979 }
1980 Err(error) => {
1981 log::error!(
1982 "error loading .gitignore file {:?} - {:?}",
1983 &entry.path,
1984 error
1985 );
1986 }
1987 }
1988 }
1989
1990 if entry.kind == EntryKind::PendingDir {
1991 if let Some(existing_entry) =
1992 self.entries_by_path.get(&PathKey(entry.path.clone()), &())
1993 {
1994 entry.kind = existing_entry.kind;
1995 }
1996 }
1997
1998 let scan_id = self.scan_id;
1999 let removed = self.entries_by_path.insert_or_replace(entry.clone(), &());
2000 if let Some(removed) = removed {
2001 if removed.id != entry.id {
2002 self.entries_by_id.remove(&removed.id, &());
2003 }
2004 }
2005 self.entries_by_id.insert_or_replace(
2006 PathEntry {
2007 id: entry.id,
2008 path: entry.path.clone(),
2009 is_ignored: entry.is_ignored,
2010 scan_id,
2011 },
2012 &(),
2013 );
2014
2015 entry
2016 }
2017
2018 fn ancestor_inodes_for_path(&self, path: &Path) -> TreeSet<u64> {
2019 let mut inodes = TreeSet::default();
2020 for ancestor in path.ancestors().skip(1) {
2021 if let Some(entry) = self.entry_for_path(ancestor) {
2022 inodes.insert(entry.inode);
2023 }
2024 }
2025 inodes
2026 }
2027
2028 fn ignore_stack_for_abs_path(&self, abs_path: &Path, is_dir: bool) -> Arc<IgnoreStack> {
2029 let mut new_ignores = Vec::new();
2030 for ancestor in abs_path.ancestors().skip(1) {
2031 if let Some((ignore, _)) = self.ignores_by_parent_abs_path.get(ancestor) {
2032 new_ignores.push((ancestor, Some(ignore.clone())));
2033 } else {
2034 new_ignores.push((ancestor, None));
2035 }
2036 }
2037
2038 let mut ignore_stack = IgnoreStack::none();
2039 for (parent_abs_path, ignore) in new_ignores.into_iter().rev() {
2040 if ignore_stack.is_abs_path_ignored(parent_abs_path, true) {
2041 ignore_stack = IgnoreStack::all();
2042 break;
2043 } else if let Some(ignore) = ignore {
2044 ignore_stack = ignore_stack.append(parent_abs_path.into(), ignore);
2045 }
2046 }
2047
2048 if ignore_stack.is_abs_path_ignored(abs_path, is_dir) {
2049 ignore_stack = IgnoreStack::all();
2050 }
2051
2052 ignore_stack
2053 }
2054
2055 #[cfg(test)]
2056 pub(crate) fn expanded_entries(&self) -> impl Iterator<Item = &Entry> {
2057 self.entries_by_path
2058 .cursor::<()>()
2059 .filter(|entry| entry.kind == EntryKind::Dir && (entry.is_external || entry.is_ignored))
2060 }
2061
2062 #[cfg(test)]
2063 pub fn check_invariants(&self, git_state: bool) {
2064 use pretty_assertions::assert_eq;
2065
2066 assert_eq!(
2067 self.entries_by_path
2068 .cursor::<()>()
2069 .map(|e| (&e.path, e.id))
2070 .collect::<Vec<_>>(),
2071 self.entries_by_id
2072 .cursor::<()>()
2073 .map(|e| (&e.path, e.id))
2074 .collect::<collections::BTreeSet<_>>()
2075 .into_iter()
2076 .collect::<Vec<_>>(),
2077 "entries_by_path and entries_by_id are inconsistent"
2078 );
2079
2080 let mut files = self.files(true, 0);
2081 let mut visible_files = self.files(false, 0);
2082 for entry in self.entries_by_path.cursor::<()>() {
2083 if entry.is_file() {
2084 assert_eq!(files.next().unwrap().inode, entry.inode);
2085 if !entry.is_ignored && !entry.is_external {
2086 assert_eq!(visible_files.next().unwrap().inode, entry.inode);
2087 }
2088 }
2089 }
2090
2091 assert!(files.next().is_none());
2092 assert!(visible_files.next().is_none());
2093
2094 let mut bfs_paths = Vec::new();
2095 let mut stack = self
2096 .root_entry()
2097 .map(|e| e.path.as_ref())
2098 .into_iter()
2099 .collect::<Vec<_>>();
2100 while let Some(path) = stack.pop() {
2101 bfs_paths.push(path);
2102 let ix = stack.len();
2103 for child_entry in self.child_entries(path) {
2104 stack.insert(ix, &child_entry.path);
2105 }
2106 }
2107
2108 let dfs_paths_via_iter = self
2109 .entries_by_path
2110 .cursor::<()>()
2111 .map(|e| e.path.as_ref())
2112 .collect::<Vec<_>>();
2113 assert_eq!(bfs_paths, dfs_paths_via_iter);
2114
2115 let dfs_paths_via_traversal = self
2116 .entries(true)
2117 .map(|e| e.path.as_ref())
2118 .collect::<Vec<_>>();
2119 assert_eq!(dfs_paths_via_traversal, dfs_paths_via_iter);
2120
2121 if git_state {
2122 for ignore_parent_abs_path in self.ignores_by_parent_abs_path.keys() {
2123 let ignore_parent_path =
2124 ignore_parent_abs_path.strip_prefix(&self.abs_path).unwrap();
2125 assert!(self.entry_for_path(&ignore_parent_path).is_some());
2126 assert!(self
2127 .entry_for_path(ignore_parent_path.join(&*GITIGNORE))
2128 .is_some());
2129 }
2130 }
2131 }
2132
2133 #[cfg(test)]
2134 pub fn entries_without_ids(&self, include_ignored: bool) -> Vec<(&Path, u64, bool)> {
2135 let mut paths = Vec::new();
2136 for entry in self.entries_by_path.cursor::<()>() {
2137 if include_ignored || !entry.is_ignored {
2138 paths.push((entry.path.as_ref(), entry.inode, entry.is_ignored));
2139 }
2140 }
2141 paths.sort_by(|a, b| a.0.cmp(b.0));
2142 paths
2143 }
2144}
2145
2146impl BackgroundScannerState {
2147 fn should_scan_directory(&self, entry: &Entry) -> bool {
2148 (!entry.is_external && !entry.is_ignored)
2149 || entry.path.file_name() == Some(&*DOT_GIT)
2150 || self.scanned_dirs.contains(&entry.id) // If we've ever scanned it, keep scanning
2151 || self
2152 .paths_to_scan
2153 .iter()
2154 .any(|p| p.starts_with(&entry.path))
2155 || self
2156 .path_prefixes_to_scan
2157 .iter()
2158 .any(|p| entry.path.starts_with(p))
2159 }
2160
2161 fn enqueue_scan_dir(&self, abs_path: Arc<Path>, entry: &Entry, scan_job_tx: &Sender<ScanJob>) {
2162 let path = entry.path.clone();
2163 let ignore_stack = self.snapshot.ignore_stack_for_abs_path(&abs_path, true);
2164 let mut ancestor_inodes = self.snapshot.ancestor_inodes_for_path(&path);
2165 let mut containing_repository = None;
2166 if !ignore_stack.is_all() {
2167 if let Some((workdir_path, repo)) = self.snapshot.local_repo_for_path(&path) {
2168 if let Ok(repo_path) = path.strip_prefix(&workdir_path.0) {
2169 containing_repository = Some((
2170 workdir_path,
2171 repo.repo_ptr.clone(),
2172 repo.repo_ptr.lock().staged_statuses(repo_path),
2173 ));
2174 }
2175 }
2176 }
2177 if !ancestor_inodes.contains(&entry.inode) {
2178 ancestor_inodes.insert(entry.inode);
2179 scan_job_tx
2180 .try_send(ScanJob {
2181 abs_path,
2182 path,
2183 ignore_stack,
2184 scan_queue: scan_job_tx.clone(),
2185 ancestor_inodes,
2186 is_external: entry.is_external,
2187 containing_repository,
2188 })
2189 .unwrap();
2190 }
2191 }
2192
2193 fn reuse_entry_id(&mut self, entry: &mut Entry) {
2194 if let Some(removed_entry_id) = self.removed_entry_ids.remove(&entry.inode) {
2195 entry.id = removed_entry_id;
2196 } else if let Some(existing_entry) = self.snapshot.entry_for_path(&entry.path) {
2197 entry.id = existing_entry.id;
2198 }
2199 }
2200
2201 fn insert_entry(&mut self, mut entry: Entry, fs: &dyn Fs) -> Entry {
2202 self.reuse_entry_id(&mut entry);
2203 let entry = self.snapshot.insert_entry(entry, fs);
2204 if entry.path.file_name() == Some(&DOT_GIT) {
2205 self.build_git_repository(entry.path.clone(), fs);
2206 }
2207
2208 #[cfg(test)]
2209 self.snapshot.check_invariants(false);
2210
2211 entry
2212 }
2213
2214 fn populate_dir(
2215 &mut self,
2216 parent_path: &Arc<Path>,
2217 entries: impl IntoIterator<Item = Entry>,
2218 ignore: Option<Arc<Gitignore>>,
2219 ) {
2220 let mut parent_entry = if let Some(parent_entry) = self
2221 .snapshot
2222 .entries_by_path
2223 .get(&PathKey(parent_path.clone()), &())
2224 {
2225 parent_entry.clone()
2226 } else {
2227 log::warn!(
2228 "populating a directory {:?} that has been removed",
2229 parent_path
2230 );
2231 return;
2232 };
2233
2234 match parent_entry.kind {
2235 EntryKind::PendingDir | EntryKind::UnloadedDir => parent_entry.kind = EntryKind::Dir,
2236 EntryKind::Dir => {}
2237 _ => return,
2238 }
2239
2240 if let Some(ignore) = ignore {
2241 let abs_parent_path = self.snapshot.abs_path.join(&parent_path).into();
2242 self.snapshot
2243 .ignores_by_parent_abs_path
2244 .insert(abs_parent_path, (ignore, false));
2245 }
2246
2247 let parent_entry_id = parent_entry.id;
2248 self.scanned_dirs.insert(parent_entry_id);
2249 let mut entries_by_path_edits = vec![Edit::Insert(parent_entry)];
2250 let mut entries_by_id_edits = Vec::new();
2251
2252 for entry in entries {
2253 entries_by_id_edits.push(Edit::Insert(PathEntry {
2254 id: entry.id,
2255 path: entry.path.clone(),
2256 is_ignored: entry.is_ignored,
2257 scan_id: self.snapshot.scan_id,
2258 }));
2259 entries_by_path_edits.push(Edit::Insert(entry));
2260 }
2261
2262 self.snapshot
2263 .entries_by_path
2264 .edit(entries_by_path_edits, &());
2265 self.snapshot.entries_by_id.edit(entries_by_id_edits, &());
2266
2267 if let Err(ix) = self.changed_paths.binary_search(parent_path) {
2268 self.changed_paths.insert(ix, parent_path.clone());
2269 }
2270
2271 #[cfg(test)]
2272 self.snapshot.check_invariants(false);
2273 }
2274
2275 fn remove_path(&mut self, path: &Path) {
2276 let mut new_entries;
2277 let removed_entries;
2278 {
2279 let mut cursor = self.snapshot.entries_by_path.cursor::<TraversalProgress>();
2280 new_entries = cursor.slice(&TraversalTarget::Path(path), Bias::Left, &());
2281 removed_entries = cursor.slice(&TraversalTarget::PathSuccessor(path), Bias::Left, &());
2282 new_entries.append(cursor.suffix(&()), &());
2283 }
2284 self.snapshot.entries_by_path = new_entries;
2285
2286 let mut entries_by_id_edits = Vec::new();
2287 for entry in removed_entries.cursor::<()>() {
2288 let removed_entry_id = self
2289 .removed_entry_ids
2290 .entry(entry.inode)
2291 .or_insert(entry.id);
2292 *removed_entry_id = cmp::max(*removed_entry_id, entry.id);
2293 entries_by_id_edits.push(Edit::Remove(entry.id));
2294 }
2295 self.snapshot.entries_by_id.edit(entries_by_id_edits, &());
2296
2297 if path.file_name() == Some(&GITIGNORE) {
2298 let abs_parent_path = self.snapshot.abs_path.join(path.parent().unwrap());
2299 if let Some((_, needs_update)) = self
2300 .snapshot
2301 .ignores_by_parent_abs_path
2302 .get_mut(abs_parent_path.as_path())
2303 {
2304 *needs_update = true;
2305 }
2306 }
2307
2308 #[cfg(test)]
2309 self.snapshot.check_invariants(false);
2310 }
2311
2312 fn reload_repositories(&mut self, changed_paths: &[Arc<Path>], fs: &dyn Fs) {
2313 let scan_id = self.snapshot.scan_id;
2314
2315 // Find each of the .git directories that contain any of the given paths.
2316 let mut prev_dot_git_dir = None;
2317 for changed_path in changed_paths {
2318 let Some(dot_git_dir) = changed_path
2319 .ancestors()
2320 .find(|ancestor| ancestor.file_name() == Some(&*DOT_GIT))
2321 else {
2322 continue;
2323 };
2324
2325 // Avoid processing the same repository multiple times, if multiple paths
2326 // within it have changed.
2327 if prev_dot_git_dir == Some(dot_git_dir) {
2328 continue;
2329 }
2330 prev_dot_git_dir = Some(dot_git_dir);
2331
2332 // If there is already a repository for this .git directory, reload
2333 // the status for all of its files.
2334 let repository = self
2335 .snapshot
2336 .git_repositories
2337 .iter()
2338 .find_map(|(entry_id, repo)| {
2339 (repo.git_dir_path.as_ref() == dot_git_dir).then(|| (*entry_id, repo.clone()))
2340 });
2341 match repository {
2342 None => {
2343 self.build_git_repository(dot_git_dir.into(), fs);
2344 }
2345 Some((entry_id, repository)) => {
2346 if repository.git_dir_scan_id == scan_id {
2347 continue;
2348 }
2349 let Some(work_dir) = self
2350 .snapshot
2351 .entry_for_id(entry_id)
2352 .map(|entry| RepositoryWorkDirectory(entry.path.clone()))
2353 else {
2354 continue;
2355 };
2356
2357 log::info!("reload git repository {:?}", dot_git_dir);
2358 let repository = repository.repo_ptr.lock();
2359 let branch = repository.branch_name();
2360 repository.reload_index();
2361
2362 self.snapshot
2363 .git_repositories
2364 .update(&entry_id, |entry| entry.git_dir_scan_id = scan_id);
2365 self.snapshot
2366 .snapshot
2367 .repository_entries
2368 .update(&work_dir, |entry| entry.branch = branch.map(Into::into));
2369
2370 self.update_git_statuses(&work_dir, &*repository);
2371 }
2372 }
2373 }
2374
2375 // Remove any git repositories whose .git entry no longer exists.
2376 let snapshot = &mut self.snapshot;
2377 let mut repositories = mem::take(&mut snapshot.git_repositories);
2378 let mut repository_entries = mem::take(&mut snapshot.repository_entries);
2379 repositories.retain(|work_directory_id, _| {
2380 snapshot
2381 .entry_for_id(*work_directory_id)
2382 .map_or(false, |entry| {
2383 snapshot.entry_for_path(entry.path.join(*DOT_GIT)).is_some()
2384 })
2385 });
2386 repository_entries.retain(|_, entry| repositories.get(&entry.work_directory.0).is_some());
2387 snapshot.git_repositories = repositories;
2388 snapshot.repository_entries = repository_entries;
2389 }
2390
2391 fn build_git_repository(
2392 &mut self,
2393 dot_git_path: Arc<Path>,
2394 fs: &dyn Fs,
2395 ) -> Option<(
2396 RepositoryWorkDirectory,
2397 Arc<Mutex<dyn GitRepository>>,
2398 TreeMap<RepoPath, GitFileStatus>,
2399 )> {
2400 log::info!("build git repository {:?}", dot_git_path);
2401
2402 let work_dir_path: Arc<Path> = dot_git_path.parent().unwrap().into();
2403
2404 // Guard against repositories inside the repository metadata
2405 if work_dir_path.iter().any(|component| component == *DOT_GIT) {
2406 return None;
2407 };
2408
2409 let work_dir_id = self
2410 .snapshot
2411 .entry_for_path(work_dir_path.clone())
2412 .map(|entry| entry.id)?;
2413
2414 if self.snapshot.git_repositories.get(&work_dir_id).is_some() {
2415 return None;
2416 }
2417
2418 let abs_path = self.snapshot.abs_path.join(&dot_git_path);
2419 let repository = fs.open_repo(abs_path.as_path())?;
2420 let work_directory = RepositoryWorkDirectory(work_dir_path.clone());
2421
2422 let repo_lock = repository.lock();
2423 self.snapshot.repository_entries.insert(
2424 work_directory.clone(),
2425 RepositoryEntry {
2426 work_directory: work_dir_id.into(),
2427 branch: repo_lock.branch_name().map(Into::into),
2428 },
2429 );
2430
2431 let staged_statuses = self.update_git_statuses(&work_directory, &*repo_lock);
2432 drop(repo_lock);
2433
2434 self.snapshot.git_repositories.insert(
2435 work_dir_id,
2436 LocalRepositoryEntry {
2437 git_dir_scan_id: 0,
2438 repo_ptr: repository.clone(),
2439 git_dir_path: dot_git_path.clone(),
2440 },
2441 );
2442
2443 Some((work_directory, repository, staged_statuses))
2444 }
2445
2446 fn update_git_statuses(
2447 &mut self,
2448 work_directory: &RepositoryWorkDirectory,
2449 repo: &dyn GitRepository,
2450 ) -> TreeMap<RepoPath, GitFileStatus> {
2451 let staged_statuses = repo.staged_statuses(Path::new(""));
2452
2453 let mut changes = vec![];
2454 let mut edits = vec![];
2455
2456 for mut entry in self
2457 .snapshot
2458 .descendent_entries(false, false, &work_directory.0)
2459 .cloned()
2460 {
2461 let Ok(repo_path) = entry.path.strip_prefix(&work_directory.0) else {
2462 continue;
2463 };
2464 let repo_path = RepoPath(repo_path.to_path_buf());
2465 let git_file_status = combine_git_statuses(
2466 staged_statuses.get(&repo_path).copied(),
2467 repo.unstaged_status(&repo_path, entry.mtime),
2468 );
2469 if entry.git_status != git_file_status {
2470 entry.git_status = git_file_status;
2471 changes.push(entry.path.clone());
2472 edits.push(Edit::Insert(entry));
2473 }
2474 }
2475
2476 self.snapshot.entries_by_path.edit(edits, &());
2477 util::extend_sorted(&mut self.changed_paths, changes, usize::MAX, Ord::cmp);
2478 staged_statuses
2479 }
2480}
2481
2482async fn build_gitignore(abs_path: &Path, fs: &dyn Fs) -> Result<Gitignore> {
2483 let contents = fs.load(abs_path).await?;
2484 let parent = abs_path.parent().unwrap_or_else(|| Path::new("/"));
2485 let mut builder = GitignoreBuilder::new(parent);
2486 for line in contents.lines() {
2487 builder.add_line(Some(abs_path.into()), line)?;
2488 }
2489 Ok(builder.build()?)
2490}
2491
2492impl WorktreeId {
2493 pub fn from_usize(handle_id: usize) -> Self {
2494 Self(handle_id)
2495 }
2496
2497 pub(crate) fn from_proto(id: u64) -> Self {
2498 Self(id as usize)
2499 }
2500
2501 pub fn to_proto(&self) -> u64 {
2502 self.0 as u64
2503 }
2504
2505 pub fn to_usize(&self) -> usize {
2506 self.0
2507 }
2508}
2509
2510impl fmt::Display for WorktreeId {
2511 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2512 self.0.fmt(f)
2513 }
2514}
2515
2516impl Deref for Worktree {
2517 type Target = Snapshot;
2518
2519 fn deref(&self) -> &Self::Target {
2520 match self {
2521 Worktree::Local(worktree) => &worktree.snapshot,
2522 Worktree::Remote(worktree) => &worktree.snapshot,
2523 }
2524 }
2525}
2526
2527impl Deref for LocalWorktree {
2528 type Target = LocalSnapshot;
2529
2530 fn deref(&self) -> &Self::Target {
2531 &self.snapshot
2532 }
2533}
2534
2535impl Deref for RemoteWorktree {
2536 type Target = Snapshot;
2537
2538 fn deref(&self) -> &Self::Target {
2539 &self.snapshot
2540 }
2541}
2542
2543impl fmt::Debug for LocalWorktree {
2544 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2545 self.snapshot.fmt(f)
2546 }
2547}
2548
2549impl fmt::Debug for Snapshot {
2550 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2551 struct EntriesById<'a>(&'a SumTree<PathEntry>);
2552 struct EntriesByPath<'a>(&'a SumTree<Entry>);
2553
2554 impl<'a> fmt::Debug for EntriesByPath<'a> {
2555 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2556 f.debug_map()
2557 .entries(self.0.iter().map(|entry| (&entry.path, entry.id)))
2558 .finish()
2559 }
2560 }
2561
2562 impl<'a> fmt::Debug for EntriesById<'a> {
2563 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2564 f.debug_list().entries(self.0.iter()).finish()
2565 }
2566 }
2567
2568 f.debug_struct("Snapshot")
2569 .field("id", &self.id)
2570 .field("root_name", &self.root_name)
2571 .field("entries_by_path", &EntriesByPath(&self.entries_by_path))
2572 .field("entries_by_id", &EntriesById(&self.entries_by_id))
2573 .finish()
2574 }
2575}
2576
2577#[derive(Clone, PartialEq)]
2578pub struct File {
2579 pub worktree: ModelHandle<Worktree>,
2580 pub path: Arc<Path>,
2581 pub mtime: SystemTime,
2582 pub(crate) entry_id: ProjectEntryId,
2583 pub(crate) is_local: bool,
2584 pub(crate) is_deleted: bool,
2585}
2586
2587impl language::File for File {
2588 fn as_local(&self) -> Option<&dyn language::LocalFile> {
2589 if self.is_local {
2590 Some(self)
2591 } else {
2592 None
2593 }
2594 }
2595
2596 fn mtime(&self) -> SystemTime {
2597 self.mtime
2598 }
2599
2600 fn path(&self) -> &Arc<Path> {
2601 &self.path
2602 }
2603
2604 fn full_path(&self, cx: &AppContext) -> PathBuf {
2605 let mut full_path = PathBuf::new();
2606 let worktree = self.worktree.read(cx);
2607
2608 if worktree.is_visible() {
2609 full_path.push(worktree.root_name());
2610 } else {
2611 let path = worktree.abs_path();
2612
2613 if worktree.is_local() && path.starts_with(HOME.as_path()) {
2614 full_path.push("~");
2615 full_path.push(path.strip_prefix(HOME.as_path()).unwrap());
2616 } else {
2617 full_path.push(path)
2618 }
2619 }
2620
2621 if self.path.components().next().is_some() {
2622 full_path.push(&self.path);
2623 }
2624
2625 full_path
2626 }
2627
2628 /// Returns the last component of this handle's absolute path. If this handle refers to the root
2629 /// of its worktree, then this method will return the name of the worktree itself.
2630 fn file_name<'a>(&'a self, cx: &'a AppContext) -> &'a OsStr {
2631 self.path
2632 .file_name()
2633 .unwrap_or_else(|| OsStr::new(&self.worktree.read(cx).root_name))
2634 }
2635
2636 fn worktree_id(&self) -> usize {
2637 self.worktree.id()
2638 }
2639
2640 fn is_deleted(&self) -> bool {
2641 self.is_deleted
2642 }
2643
2644 fn as_any(&self) -> &dyn Any {
2645 self
2646 }
2647
2648 fn to_proto(&self) -> rpc::proto::File {
2649 rpc::proto::File {
2650 worktree_id: self.worktree.id() as u64,
2651 entry_id: self.entry_id.to_proto(),
2652 path: self.path.to_string_lossy().into(),
2653 mtime: Some(self.mtime.into()),
2654 is_deleted: self.is_deleted,
2655 }
2656 }
2657}
2658
2659impl language::LocalFile for File {
2660 fn abs_path(&self, cx: &AppContext) -> PathBuf {
2661 self.worktree
2662 .read(cx)
2663 .as_local()
2664 .unwrap()
2665 .abs_path
2666 .join(&self.path)
2667 }
2668
2669 fn load(&self, cx: &AppContext) -> Task<Result<String>> {
2670 let worktree = self.worktree.read(cx).as_local().unwrap();
2671 let abs_path = worktree.absolutize(&self.path);
2672 let fs = worktree.fs.clone();
2673 cx.background()
2674 .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: ModelHandle<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: rpc::proto::File,
2717 worktree: ModelHandle<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 language::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: Arc<executor::Background>,
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: Arc<executor::Background>,
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
4033pub trait WorktreeModelHandle {
4034 #[cfg(any(test, feature = "test-support"))]
4035 fn flush_fs_events<'a>(
4036 &self,
4037 cx: &'a gpui::TestAppContext,
4038 ) -> futures::future::LocalBoxFuture<'a, ()>;
4039}
4040
4041impl WorktreeModelHandle for ModelHandle<Worktree> {
4042 // When the worktree's FS event stream sometimes delivers "redundant" events for FS changes that
4043 // occurred before the worktree was constructed. These events can cause the worktree to perform
4044 // extra directory scans, and emit extra scan-state notifications.
4045 //
4046 // This function mutates the worktree's directory and waits for those mutations to be picked up,
4047 // to ensure that all redundant FS events have already been processed.
4048 #[cfg(any(test, feature = "test-support"))]
4049 fn flush_fs_events<'a>(
4050 &self,
4051 cx: &'a gpui::TestAppContext,
4052 ) -> futures::future::LocalBoxFuture<'a, ()> {
4053 let filename = "fs-event-sentinel";
4054 let tree = self.clone();
4055 let (fs, root_path) = self.read_with(cx, |tree, _| {
4056 let tree = tree.as_local().unwrap();
4057 (tree.fs.clone(), tree.abs_path().clone())
4058 });
4059
4060 async move {
4061 fs.create_file(&root_path.join(filename), Default::default())
4062 .await
4063 .unwrap();
4064 tree.condition(cx, |tree, _| tree.entry_for_path(filename).is_some())
4065 .await;
4066
4067 fs.remove_file(&root_path.join(filename), Default::default())
4068 .await
4069 .unwrap();
4070 tree.condition(cx, |tree, _| tree.entry_for_path(filename).is_none())
4071 .await;
4072
4073 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
4074 .await;
4075 }
4076 .boxed_local()
4077 }
4078}
4079
4080#[derive(Clone, Debug)]
4081struct TraversalProgress<'a> {
4082 max_path: &'a Path,
4083 count: usize,
4084 non_ignored_count: usize,
4085 file_count: usize,
4086 non_ignored_file_count: usize,
4087}
4088
4089impl<'a> TraversalProgress<'a> {
4090 fn count(&self, include_dirs: bool, include_ignored: bool) -> usize {
4091 match (include_ignored, include_dirs) {
4092 (true, true) => self.count,
4093 (true, false) => self.file_count,
4094 (false, true) => self.non_ignored_count,
4095 (false, false) => self.non_ignored_file_count,
4096 }
4097 }
4098}
4099
4100impl<'a> sum_tree::Dimension<'a, EntrySummary> for TraversalProgress<'a> {
4101 fn add_summary(&mut self, summary: &'a EntrySummary, _: &()) {
4102 self.max_path = summary.max_path.as_ref();
4103 self.count += summary.count;
4104 self.non_ignored_count += summary.non_ignored_count;
4105 self.file_count += summary.file_count;
4106 self.non_ignored_file_count += summary.non_ignored_file_count;
4107 }
4108}
4109
4110impl<'a> Default for TraversalProgress<'a> {
4111 fn default() -> Self {
4112 Self {
4113 max_path: Path::new(""),
4114 count: 0,
4115 non_ignored_count: 0,
4116 file_count: 0,
4117 non_ignored_file_count: 0,
4118 }
4119 }
4120}
4121
4122#[derive(Clone, Debug, Default, Copy)]
4123struct GitStatuses {
4124 added: usize,
4125 modified: usize,
4126 conflict: usize,
4127}
4128
4129impl AddAssign for GitStatuses {
4130 fn add_assign(&mut self, rhs: Self) {
4131 self.added += rhs.added;
4132 self.modified += rhs.modified;
4133 self.conflict += rhs.conflict;
4134 }
4135}
4136
4137impl Sub for GitStatuses {
4138 type Output = GitStatuses;
4139
4140 fn sub(self, rhs: Self) -> Self::Output {
4141 GitStatuses {
4142 added: self.added - rhs.added,
4143 modified: self.modified - rhs.modified,
4144 conflict: self.conflict - rhs.conflict,
4145 }
4146 }
4147}
4148
4149impl<'a> sum_tree::Dimension<'a, EntrySummary> for GitStatuses {
4150 fn add_summary(&mut self, summary: &'a EntrySummary, _: &()) {
4151 *self += summary.statuses
4152 }
4153}
4154
4155pub struct Traversal<'a> {
4156 cursor: sum_tree::Cursor<'a, Entry, TraversalProgress<'a>>,
4157 include_ignored: bool,
4158 include_dirs: bool,
4159}
4160
4161impl<'a> Traversal<'a> {
4162 pub fn advance(&mut self) -> bool {
4163 self.cursor.seek_forward(
4164 &TraversalTarget::Count {
4165 count: self.end_offset() + 1,
4166 include_dirs: self.include_dirs,
4167 include_ignored: self.include_ignored,
4168 },
4169 Bias::Left,
4170 &(),
4171 )
4172 }
4173
4174 pub fn advance_to_sibling(&mut self) -> bool {
4175 while let Some(entry) = self.cursor.item() {
4176 self.cursor.seek_forward(
4177 &TraversalTarget::PathSuccessor(&entry.path),
4178 Bias::Left,
4179 &(),
4180 );
4181 if let Some(entry) = self.cursor.item() {
4182 if (self.include_dirs || !entry.is_dir())
4183 && (self.include_ignored || !entry.is_ignored)
4184 {
4185 return true;
4186 }
4187 }
4188 }
4189 false
4190 }
4191
4192 pub fn entry(&self) -> Option<&'a Entry> {
4193 self.cursor.item()
4194 }
4195
4196 pub fn start_offset(&self) -> usize {
4197 self.cursor
4198 .start()
4199 .count(self.include_dirs, self.include_ignored)
4200 }
4201
4202 pub fn end_offset(&self) -> usize {
4203 self.cursor
4204 .end(&())
4205 .count(self.include_dirs, self.include_ignored)
4206 }
4207}
4208
4209impl<'a> Iterator for Traversal<'a> {
4210 type Item = &'a Entry;
4211
4212 fn next(&mut self) -> Option<Self::Item> {
4213 if let Some(item) = self.entry() {
4214 self.advance();
4215 Some(item)
4216 } else {
4217 None
4218 }
4219 }
4220}
4221
4222#[derive(Debug)]
4223enum TraversalTarget<'a> {
4224 Path(&'a Path),
4225 PathSuccessor(&'a Path),
4226 Count {
4227 count: usize,
4228 include_ignored: bool,
4229 include_dirs: bool,
4230 },
4231}
4232
4233impl<'a, 'b> SeekTarget<'a, EntrySummary, TraversalProgress<'a>> for TraversalTarget<'b> {
4234 fn cmp(&self, cursor_location: &TraversalProgress<'a>, _: &()) -> Ordering {
4235 match self {
4236 TraversalTarget::Path(path) => path.cmp(&cursor_location.max_path),
4237 TraversalTarget::PathSuccessor(path) => {
4238 if !cursor_location.max_path.starts_with(path) {
4239 Ordering::Equal
4240 } else {
4241 Ordering::Greater
4242 }
4243 }
4244 TraversalTarget::Count {
4245 count,
4246 include_dirs,
4247 include_ignored,
4248 } => Ord::cmp(
4249 count,
4250 &cursor_location.count(*include_dirs, *include_ignored),
4251 ),
4252 }
4253 }
4254}
4255
4256impl<'a, 'b> SeekTarget<'a, EntrySummary, (TraversalProgress<'a>, GitStatuses)>
4257 for TraversalTarget<'b>
4258{
4259 fn cmp(&self, cursor_location: &(TraversalProgress<'a>, GitStatuses), _: &()) -> Ordering {
4260 self.cmp(&cursor_location.0, &())
4261 }
4262}
4263
4264struct ChildEntriesIter<'a> {
4265 parent_path: &'a Path,
4266 traversal: Traversal<'a>,
4267}
4268
4269impl<'a> Iterator for ChildEntriesIter<'a> {
4270 type Item = &'a Entry;
4271
4272 fn next(&mut self) -> Option<Self::Item> {
4273 if let Some(item) = self.traversal.entry() {
4274 if item.path.starts_with(&self.parent_path) {
4275 self.traversal.advance_to_sibling();
4276 return Some(item);
4277 }
4278 }
4279 None
4280 }
4281}
4282
4283pub struct DescendentEntriesIter<'a> {
4284 parent_path: &'a Path,
4285 traversal: Traversal<'a>,
4286}
4287
4288impl<'a> Iterator for DescendentEntriesIter<'a> {
4289 type Item = &'a Entry;
4290
4291 fn next(&mut self) -> Option<Self::Item> {
4292 if let Some(item) = self.traversal.entry() {
4293 if item.path.starts_with(&self.parent_path) {
4294 self.traversal.advance();
4295 return Some(item);
4296 }
4297 }
4298 None
4299 }
4300}
4301
4302impl<'a> From<&'a Entry> for proto::Entry {
4303 fn from(entry: &'a Entry) -> Self {
4304 Self {
4305 id: entry.id.to_proto(),
4306 is_dir: entry.is_dir(),
4307 path: entry.path.to_string_lossy().into(),
4308 inode: entry.inode,
4309 mtime: Some(entry.mtime.into()),
4310 is_symlink: entry.is_symlink,
4311 is_ignored: entry.is_ignored,
4312 is_external: entry.is_external,
4313 git_status: entry.git_status.map(git_status_to_proto),
4314 }
4315 }
4316}
4317
4318impl<'a> TryFrom<(&'a CharBag, proto::Entry)> for Entry {
4319 type Error = anyhow::Error;
4320
4321 fn try_from((root_char_bag, entry): (&'a CharBag, proto::Entry)) -> Result<Self> {
4322 if let Some(mtime) = entry.mtime {
4323 let kind = if entry.is_dir {
4324 EntryKind::Dir
4325 } else {
4326 let mut char_bag = *root_char_bag;
4327 char_bag.extend(entry.path.chars().map(|c| c.to_ascii_lowercase()));
4328 EntryKind::File(char_bag)
4329 };
4330 let path: Arc<Path> = PathBuf::from(entry.path).into();
4331 Ok(Entry {
4332 id: ProjectEntryId::from_proto(entry.id),
4333 kind,
4334 path,
4335 inode: entry.inode,
4336 mtime: mtime.into(),
4337 is_symlink: entry.is_symlink,
4338 is_ignored: entry.is_ignored,
4339 is_external: entry.is_external,
4340 git_status: git_status_from_proto(entry.git_status),
4341 })
4342 } else {
4343 Err(anyhow!(
4344 "missing mtime in remote worktree entry {:?}",
4345 entry.path
4346 ))
4347 }
4348 }
4349}
4350
4351fn combine_git_statuses(
4352 staged: Option<GitFileStatus>,
4353 unstaged: Option<GitFileStatus>,
4354) -> Option<GitFileStatus> {
4355 if let Some(staged) = staged {
4356 if let Some(unstaged) = unstaged {
4357 if unstaged != staged {
4358 Some(GitFileStatus::Modified)
4359 } else {
4360 Some(staged)
4361 }
4362 } else {
4363 Some(staged)
4364 }
4365 } else {
4366 unstaged
4367 }
4368}
4369
4370fn git_status_from_proto(git_status: Option<i32>) -> Option<GitFileStatus> {
4371 git_status.and_then(|status| {
4372 proto::GitStatus::from_i32(status).map(|status| match status {
4373 proto::GitStatus::Added => GitFileStatus::Added,
4374 proto::GitStatus::Modified => GitFileStatus::Modified,
4375 proto::GitStatus::Conflict => GitFileStatus::Conflict,
4376 })
4377 })
4378}
4379
4380fn git_status_to_proto(status: GitFileStatus) -> i32 {
4381 match status {
4382 GitFileStatus::Added => proto::GitStatus::Added as i32,
4383 GitFileStatus::Modified => proto::GitStatus::Modified as i32,
4384 GitFileStatus::Conflict => proto::GitStatus::Conflict as i32,
4385 }
4386}