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, VecDeque};
9use fs::{
10 repository::{GitFileStatus, GitRepository, RepoPath},
11 Fs, LineEnding,
12};
13use futures::{
14 channel::{
15 mpsc::{self, UnboundedSender},
16 oneshot,
17 },
18 select_biased,
19 task::Poll,
20 FutureExt, Stream, StreamExt,
21};
22use fuzzy::CharBag;
23use git::{DOT_GIT, GITIGNORE};
24use gpui::{executor, AppContext, AsyncAppContext, Entity, ModelContext, ModelHandle, Task};
25use language::{
26 proto::{
27 deserialize_fingerprint, deserialize_version, serialize_fingerprint, serialize_line_ending,
28 serialize_version,
29 },
30 Buffer, DiagnosticEntry, File as _, PointUtf16, Rope, RopeFingerprint, Unclipped,
31};
32use lsp::LanguageServerId;
33use parking_lot::Mutex;
34use postage::{
35 barrier,
36 prelude::{Sink as _, Stream as _},
37 watch,
38};
39use smol::channel::{self, Sender};
40use std::{
41 any::Any,
42 cmp::{self, Ordering},
43 convert::TryFrom,
44 ffi::OsStr,
45 fmt,
46 future::Future,
47 mem,
48 ops::{Deref, DerefMut},
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 path_changes_tx: channel::Sender<(Vec<PathBuf>, barrier::Sender)>,
71 is_scanning: (watch::Sender<bool>, watch::Receiver<bool>),
72 _background_scanner_task: Task<()>,
73 share: Option<ShareState>,
74 diagnostics: HashMap<
75 Arc<Path>,
76 Vec<(
77 LanguageServerId,
78 Vec<DiagnosticEntry<Unclipped<PointUtf16>>>,
79 )>,
80 >,
81 diagnostic_summaries: HashMap<Arc<Path>, HashMap<LanguageServerId, DiagnosticSummary>>,
82 client: Arc<Client>,
83 fs: Arc<dyn Fs>,
84 visible: bool,
85}
86
87pub struct RemoteWorktree {
88 snapshot: Snapshot,
89 background_snapshot: Arc<Mutex<Snapshot>>,
90 project_id: u64,
91 client: Arc<Client>,
92 updates_tx: Option<UnboundedSender<proto::UpdateWorktree>>,
93 snapshot_subscriptions: VecDeque<(usize, oneshot::Sender<()>)>,
94 replica_id: ReplicaId,
95 diagnostic_summaries: HashMap<Arc<Path>, HashMap<LanguageServerId, DiagnosticSummary>>,
96 visible: bool,
97 disconnected: bool,
98}
99
100#[derive(Clone)]
101pub struct Snapshot {
102 id: WorktreeId,
103 abs_path: Arc<Path>,
104 root_name: String,
105 root_char_bag: CharBag,
106 entries_by_path: SumTree<Entry>,
107 entries_by_id: SumTree<PathEntry>,
108 repository_entries: TreeMap<RepositoryWorkDirectory, RepositoryEntry>,
109
110 /// A number that increases every time the worktree begins scanning
111 /// a set of paths from the filesystem. This scanning could be caused
112 /// by some operation performed on the worktree, such as reading or
113 /// writing a file, or by an event reported by the filesystem.
114 scan_id: usize,
115
116 /// The latest scan id that has completed, and whose preceding scans
117 /// have all completed. The current `scan_id` could be more than one
118 /// greater than the `completed_scan_id` if operations are performed
119 /// on the worktree while it is processing a file-system event.
120 completed_scan_id: usize,
121}
122
123#[derive(Clone, Debug, PartialEq, Eq)]
124pub struct RepositoryEntry {
125 pub(crate) work_directory: WorkDirectoryEntry,
126 pub(crate) branch: Option<Arc<str>>,
127}
128
129impl RepositoryEntry {
130 pub fn branch(&self) -> Option<Arc<str>> {
131 self.branch.clone()
132 }
133
134 pub fn work_directory_id(&self) -> ProjectEntryId {
135 *self.work_directory
136 }
137
138 pub fn work_directory(&self, snapshot: &Snapshot) -> Option<RepositoryWorkDirectory> {
139 snapshot
140 .entry_for_id(self.work_directory_id())
141 .map(|entry| RepositoryWorkDirectory(entry.path.clone()))
142 }
143
144 pub fn build_update(&self, _: &Self) -> proto::RepositoryEntry {
145 proto::RepositoryEntry {
146 work_directory_id: self.work_directory_id().to_proto(),
147 branch: self.branch.as_ref().map(|str| str.to_string()),
148 }
149 }
150}
151
152impl From<&RepositoryEntry> for proto::RepositoryEntry {
153 fn from(value: &RepositoryEntry) -> Self {
154 proto::RepositoryEntry {
155 work_directory_id: value.work_directory.to_proto(),
156 branch: value.branch.as_ref().map(|str| str.to_string()),
157 }
158 }
159}
160
161/// This path corresponds to the 'content path' (the folder that contains the .git)
162#[derive(Clone, Debug, Ord, PartialOrd, Eq, PartialEq)]
163pub struct RepositoryWorkDirectory(Arc<Path>);
164
165impl Default for RepositoryWorkDirectory {
166 fn default() -> Self {
167 RepositoryWorkDirectory(Arc::from(Path::new("")))
168 }
169}
170
171impl AsRef<Path> for RepositoryWorkDirectory {
172 fn as_ref(&self) -> &Path {
173 self.0.as_ref()
174 }
175}
176
177#[derive(Clone, Debug, Ord, PartialOrd, Eq, PartialEq)]
178pub struct WorkDirectoryEntry(ProjectEntryId);
179
180impl WorkDirectoryEntry {
181 pub(crate) fn relativize(&self, worktree: &Snapshot, path: &Path) -> Option<RepoPath> {
182 worktree.entry_for_id(self.0).and_then(|entry| {
183 path.strip_prefix(&entry.path)
184 .ok()
185 .map(move |path| path.into())
186 })
187 }
188}
189
190impl Deref for WorkDirectoryEntry {
191 type Target = ProjectEntryId;
192
193 fn deref(&self) -> &Self::Target {
194 &self.0
195 }
196}
197
198impl<'a> From<ProjectEntryId> for WorkDirectoryEntry {
199 fn from(value: ProjectEntryId) -> Self {
200 WorkDirectoryEntry(value)
201 }
202}
203
204#[derive(Debug, Clone)]
205pub struct LocalSnapshot {
206 snapshot: Snapshot,
207 /// All of the gitignore files in the worktree, indexed by their relative path.
208 /// The boolean indicates whether the gitignore needs to be updated.
209 ignores_by_parent_abs_path: HashMap<Arc<Path>, (Arc<Gitignore>, bool)>,
210 /// All of the git repositories in the worktree, indexed by the project entry
211 /// id of their parent directory.
212 git_repositories: TreeMap<ProjectEntryId, LocalRepositoryEntry>,
213}
214
215pub struct BackgroundScannerState {
216 snapshot: LocalSnapshot,
217 /// The ids of all of the entries that were removed from the snapshot
218 /// as part of the current update. These entry ids may be re-used
219 /// if the same inode is discovered at a new path, or if the given
220 /// path is re-created after being deleted.
221 removed_entry_ids: HashMap<u64, ProjectEntryId>,
222 changed_paths: Vec<Arc<Path>>,
223 prev_snapshot: Snapshot,
224}
225
226#[derive(Debug, Clone)]
227pub struct LocalRepositoryEntry {
228 pub(crate) git_dir_scan_id: usize,
229 pub(crate) repo_ptr: Arc<Mutex<dyn GitRepository>>,
230 /// Path to the actual .git folder.
231 /// Note: if .git is a file, this points to the folder indicated by the .git file
232 pub(crate) git_dir_path: Arc<Path>,
233}
234
235impl LocalRepositoryEntry {
236 // Note that this path should be relative to the worktree root.
237 pub(crate) fn in_dot_git(&self, path: &Path) -> bool {
238 path.starts_with(self.git_dir_path.as_ref())
239 }
240}
241
242impl Deref for LocalSnapshot {
243 type Target = Snapshot;
244
245 fn deref(&self) -> &Self::Target {
246 &self.snapshot
247 }
248}
249
250impl DerefMut for LocalSnapshot {
251 fn deref_mut(&mut self) -> &mut Self::Target {
252 &mut self.snapshot
253 }
254}
255
256enum ScanState {
257 Started,
258 Updated {
259 snapshot: LocalSnapshot,
260 changes: UpdatedEntriesSet,
261 barrier: Option<barrier::Sender>,
262 scanning: bool,
263 },
264}
265
266struct ShareState {
267 project_id: u64,
268 snapshots_tx:
269 mpsc::UnboundedSender<(LocalSnapshot, UpdatedEntriesSet, UpdatedGitRepositoriesSet)>,
270 resume_updates: watch::Sender<()>,
271 _maintain_remote_snapshot: Task<Option<()>>,
272}
273
274pub enum Event {
275 UpdatedEntries(UpdatedEntriesSet),
276 UpdatedGitRepositories(UpdatedGitRepositoriesSet),
277}
278
279impl Entity for Worktree {
280 type Event = Event;
281}
282
283impl Worktree {
284 pub async fn local(
285 client: Arc<Client>,
286 path: impl Into<Arc<Path>>,
287 visible: bool,
288 fs: Arc<dyn Fs>,
289 next_entry_id: Arc<AtomicUsize>,
290 cx: &mut AsyncAppContext,
291 ) -> Result<ModelHandle<Self>> {
292 // After determining whether the root entry is a file or a directory, populate the
293 // snapshot's "root name", which will be used for the purpose of fuzzy matching.
294 let abs_path = path.into();
295 let metadata = fs
296 .metadata(&abs_path)
297 .await
298 .context("failed to stat worktree path")?;
299
300 Ok(cx.add_model(move |cx: &mut ModelContext<Worktree>| {
301 let root_name = abs_path
302 .file_name()
303 .map_or(String::new(), |f| f.to_string_lossy().to_string());
304
305 let mut snapshot = LocalSnapshot {
306 ignores_by_parent_abs_path: Default::default(),
307 git_repositories: Default::default(),
308 snapshot: Snapshot {
309 id: WorktreeId::from_usize(cx.model_id()),
310 abs_path: abs_path.clone(),
311 root_name: root_name.clone(),
312 root_char_bag: root_name.chars().map(|c| c.to_ascii_lowercase()).collect(),
313 entries_by_path: Default::default(),
314 entries_by_id: Default::default(),
315 repository_entries: Default::default(),
316 scan_id: 1,
317 completed_scan_id: 0,
318 },
319 };
320
321 if let Some(metadata) = metadata {
322 snapshot.insert_entry(
323 Entry::new(
324 Arc::from(Path::new("")),
325 &metadata,
326 &next_entry_id,
327 snapshot.root_char_bag,
328 ),
329 fs.as_ref(),
330 );
331 }
332
333 let (path_changes_tx, path_changes_rx) = channel::unbounded();
334 let (scan_states_tx, mut scan_states_rx) = mpsc::unbounded();
335
336 cx.spawn_weak(|this, mut cx| async move {
337 while let Some((state, this)) = scan_states_rx.next().await.zip(this.upgrade(&cx)) {
338 this.update(&mut cx, |this, cx| {
339 let this = this.as_local_mut().unwrap();
340 match state {
341 ScanState::Started => {
342 *this.is_scanning.0.borrow_mut() = true;
343 }
344 ScanState::Updated {
345 snapshot,
346 changes,
347 barrier,
348 scanning,
349 } => {
350 *this.is_scanning.0.borrow_mut() = scanning;
351 this.set_snapshot(snapshot, changes, cx);
352 drop(barrier);
353 }
354 }
355 cx.notify();
356 });
357 }
358 })
359 .detach();
360
361 let background_scanner_task = cx.background().spawn({
362 let fs = fs.clone();
363 let snapshot = snapshot.clone();
364 let background = cx.background().clone();
365 async move {
366 let events = fs.watch(&abs_path, Duration::from_millis(100)).await;
367 BackgroundScanner::new(
368 snapshot,
369 next_entry_id,
370 fs,
371 scan_states_tx,
372 background,
373 path_changes_rx,
374 )
375 .run(events)
376 .await;
377 }
378 });
379
380 Worktree::Local(LocalWorktree {
381 snapshot,
382 is_scanning: watch::channel_with(true),
383 share: None,
384 path_changes_tx,
385 _background_scanner_task: background_scanner_task,
386 diagnostics: Default::default(),
387 diagnostic_summaries: Default::default(),
388 client,
389 fs,
390 visible,
391 })
392 }))
393 }
394
395 pub fn remote(
396 project_remote_id: u64,
397 replica_id: ReplicaId,
398 worktree: proto::WorktreeMetadata,
399 client: Arc<Client>,
400 cx: &mut AppContext,
401 ) -> ModelHandle<Self> {
402 cx.add_model(|cx: &mut ModelContext<Self>| {
403 let snapshot = Snapshot {
404 id: WorktreeId(worktree.id as usize),
405 abs_path: Arc::from(PathBuf::from(worktree.abs_path)),
406 root_name: worktree.root_name.clone(),
407 root_char_bag: worktree
408 .root_name
409 .chars()
410 .map(|c| c.to_ascii_lowercase())
411 .collect(),
412 entries_by_path: Default::default(),
413 entries_by_id: Default::default(),
414 repository_entries: Default::default(),
415 scan_id: 1,
416 completed_scan_id: 0,
417 };
418
419 let (updates_tx, mut updates_rx) = mpsc::unbounded();
420 let background_snapshot = Arc::new(Mutex::new(snapshot.clone()));
421 let (mut snapshot_updated_tx, mut snapshot_updated_rx) = watch::channel();
422
423 cx.background()
424 .spawn({
425 let background_snapshot = background_snapshot.clone();
426 async move {
427 while let Some(update) = updates_rx.next().await {
428 if let Err(error) =
429 background_snapshot.lock().apply_remote_update(update)
430 {
431 log::error!("error applying worktree update: {}", error);
432 }
433 snapshot_updated_tx.send(()).await.ok();
434 }
435 }
436 })
437 .detach();
438
439 cx.spawn_weak(|this, mut cx| async move {
440 while (snapshot_updated_rx.recv().await).is_some() {
441 if let Some(this) = this.upgrade(&cx) {
442 this.update(&mut cx, |this, cx| {
443 let this = this.as_remote_mut().unwrap();
444 this.snapshot = this.background_snapshot.lock().clone();
445 cx.emit(Event::UpdatedEntries(Arc::from([])));
446 cx.notify();
447 while let Some((scan_id, _)) = this.snapshot_subscriptions.front() {
448 if this.observed_snapshot(*scan_id) {
449 let (_, tx) = this.snapshot_subscriptions.pop_front().unwrap();
450 let _ = tx.send(());
451 } else {
452 break;
453 }
454 }
455 });
456 } else {
457 break;
458 }
459 }
460 })
461 .detach();
462
463 Worktree::Remote(RemoteWorktree {
464 project_id: project_remote_id,
465 replica_id,
466 snapshot: snapshot.clone(),
467 background_snapshot,
468 updates_tx: Some(updates_tx),
469 snapshot_subscriptions: Default::default(),
470 client: client.clone(),
471 diagnostic_summaries: Default::default(),
472 visible: worktree.visible,
473 disconnected: false,
474 })
475 })
476 }
477
478 pub fn as_local(&self) -> Option<&LocalWorktree> {
479 if let Worktree::Local(worktree) = self {
480 Some(worktree)
481 } else {
482 None
483 }
484 }
485
486 pub fn as_remote(&self) -> Option<&RemoteWorktree> {
487 if let Worktree::Remote(worktree) = self {
488 Some(worktree)
489 } else {
490 None
491 }
492 }
493
494 pub fn as_local_mut(&mut self) -> Option<&mut LocalWorktree> {
495 if let Worktree::Local(worktree) = self {
496 Some(worktree)
497 } else {
498 None
499 }
500 }
501
502 pub fn as_remote_mut(&mut self) -> Option<&mut RemoteWorktree> {
503 if let Worktree::Remote(worktree) = self {
504 Some(worktree)
505 } else {
506 None
507 }
508 }
509
510 pub fn is_local(&self) -> bool {
511 matches!(self, Worktree::Local(_))
512 }
513
514 pub fn is_remote(&self) -> bool {
515 !self.is_local()
516 }
517
518 pub fn snapshot(&self) -> Snapshot {
519 match self {
520 Worktree::Local(worktree) => worktree.snapshot().snapshot,
521 Worktree::Remote(worktree) => worktree.snapshot(),
522 }
523 }
524
525 pub fn scan_id(&self) -> usize {
526 match self {
527 Worktree::Local(worktree) => worktree.snapshot.scan_id,
528 Worktree::Remote(worktree) => worktree.snapshot.scan_id,
529 }
530 }
531
532 pub fn completed_scan_id(&self) -> usize {
533 match self {
534 Worktree::Local(worktree) => worktree.snapshot.completed_scan_id,
535 Worktree::Remote(worktree) => worktree.snapshot.completed_scan_id,
536 }
537 }
538
539 pub fn is_visible(&self) -> bool {
540 match self {
541 Worktree::Local(worktree) => worktree.visible,
542 Worktree::Remote(worktree) => worktree.visible,
543 }
544 }
545
546 pub fn replica_id(&self) -> ReplicaId {
547 match self {
548 Worktree::Local(_) => 0,
549 Worktree::Remote(worktree) => worktree.replica_id,
550 }
551 }
552
553 pub fn diagnostic_summaries(
554 &self,
555 ) -> impl Iterator<Item = (Arc<Path>, LanguageServerId, DiagnosticSummary)> + '_ {
556 match self {
557 Worktree::Local(worktree) => &worktree.diagnostic_summaries,
558 Worktree::Remote(worktree) => &worktree.diagnostic_summaries,
559 }
560 .iter()
561 .flat_map(|(path, summaries)| {
562 summaries
563 .iter()
564 .map(move |(&server_id, &summary)| (path.clone(), server_id, summary))
565 })
566 }
567
568 pub fn abs_path(&self) -> Arc<Path> {
569 match self {
570 Worktree::Local(worktree) => worktree.abs_path.clone(),
571 Worktree::Remote(worktree) => worktree.abs_path.clone(),
572 }
573 }
574}
575
576impl LocalWorktree {
577 pub fn contains_abs_path(&self, path: &Path) -> bool {
578 path.starts_with(&self.abs_path)
579 }
580
581 fn absolutize(&self, path: &Path) -> PathBuf {
582 if path.file_name().is_some() {
583 self.abs_path.join(path)
584 } else {
585 self.abs_path.to_path_buf()
586 }
587 }
588
589 pub(crate) fn load_buffer(
590 &mut self,
591 id: u64,
592 path: &Path,
593 cx: &mut ModelContext<Worktree>,
594 ) -> Task<Result<ModelHandle<Buffer>>> {
595 let path = Arc::from(path);
596 cx.spawn(move |this, mut cx| async move {
597 let (file, contents, diff_base) = this
598 .update(&mut cx, |t, cx| t.as_local().unwrap().load(&path, cx))
599 .await?;
600 let text_buffer = cx
601 .background()
602 .spawn(async move { text::Buffer::new(0, id, contents) })
603 .await;
604 Ok(cx.add_model(|_| Buffer::build(text_buffer, diff_base, Some(Arc::new(file)))))
605 })
606 }
607
608 pub fn diagnostics_for_path(
609 &self,
610 path: &Path,
611 ) -> Vec<(
612 LanguageServerId,
613 Vec<DiagnosticEntry<Unclipped<PointUtf16>>>,
614 )> {
615 self.diagnostics.get(path).cloned().unwrap_or_default()
616 }
617
618 pub fn clear_diagnostics_for_language_server(
619 &mut self,
620 server_id: LanguageServerId,
621 _: &mut ModelContext<Worktree>,
622 ) {
623 let worktree_id = self.id().to_proto();
624 self.diagnostic_summaries
625 .retain(|path, summaries_by_server_id| {
626 if summaries_by_server_id.remove(&server_id).is_some() {
627 if let Some(share) = self.share.as_ref() {
628 self.client
629 .send(proto::UpdateDiagnosticSummary {
630 project_id: share.project_id,
631 worktree_id,
632 summary: Some(proto::DiagnosticSummary {
633 path: path.to_string_lossy().to_string(),
634 language_server_id: server_id.0 as u64,
635 error_count: 0,
636 warning_count: 0,
637 }),
638 })
639 .log_err();
640 }
641 !summaries_by_server_id.is_empty()
642 } else {
643 true
644 }
645 });
646
647 self.diagnostics.retain(|_, diagnostics_by_server_id| {
648 if let Ok(ix) = diagnostics_by_server_id.binary_search_by_key(&server_id, |e| e.0) {
649 diagnostics_by_server_id.remove(ix);
650 !diagnostics_by_server_id.is_empty()
651 } else {
652 true
653 }
654 });
655 }
656
657 pub fn update_diagnostics(
658 &mut self,
659 server_id: LanguageServerId,
660 worktree_path: Arc<Path>,
661 diagnostics: Vec<DiagnosticEntry<Unclipped<PointUtf16>>>,
662 _: &mut ModelContext<Worktree>,
663 ) -> Result<bool> {
664 let summaries_by_server_id = self
665 .diagnostic_summaries
666 .entry(worktree_path.clone())
667 .or_default();
668
669 let old_summary = summaries_by_server_id
670 .remove(&server_id)
671 .unwrap_or_default();
672
673 let new_summary = DiagnosticSummary::new(&diagnostics);
674 if new_summary.is_empty() {
675 if let Some(diagnostics_by_server_id) = self.diagnostics.get_mut(&worktree_path) {
676 if let Ok(ix) = diagnostics_by_server_id.binary_search_by_key(&server_id, |e| e.0) {
677 diagnostics_by_server_id.remove(ix);
678 }
679 if diagnostics_by_server_id.is_empty() {
680 self.diagnostics.remove(&worktree_path);
681 }
682 }
683 } else {
684 summaries_by_server_id.insert(server_id, new_summary);
685 let diagnostics_by_server_id =
686 self.diagnostics.entry(worktree_path.clone()).or_default();
687 match diagnostics_by_server_id.binary_search_by_key(&server_id, |e| e.0) {
688 Ok(ix) => {
689 diagnostics_by_server_id[ix] = (server_id, diagnostics);
690 }
691 Err(ix) => {
692 diagnostics_by_server_id.insert(ix, (server_id, diagnostics));
693 }
694 }
695 }
696
697 if !old_summary.is_empty() || !new_summary.is_empty() {
698 if let Some(share) = self.share.as_ref() {
699 self.client
700 .send(proto::UpdateDiagnosticSummary {
701 project_id: share.project_id,
702 worktree_id: self.id().to_proto(),
703 summary: Some(proto::DiagnosticSummary {
704 path: worktree_path.to_string_lossy().to_string(),
705 language_server_id: server_id.0 as u64,
706 error_count: new_summary.error_count as u32,
707 warning_count: new_summary.warning_count as u32,
708 }),
709 })
710 .log_err();
711 }
712 }
713
714 Ok(!old_summary.is_empty() || !new_summary.is_empty())
715 }
716
717 fn set_snapshot(
718 &mut self,
719 new_snapshot: LocalSnapshot,
720 entry_changes: UpdatedEntriesSet,
721 cx: &mut ModelContext<Worktree>,
722 ) {
723 let repo_changes = self.changed_repos(&self.snapshot, &new_snapshot);
724
725 self.snapshot = new_snapshot;
726
727 if let Some(share) = self.share.as_mut() {
728 share
729 .snapshots_tx
730 .unbounded_send((
731 self.snapshot.clone(),
732 entry_changes.clone(),
733 repo_changes.clone(),
734 ))
735 .ok();
736 }
737
738 if !entry_changes.is_empty() {
739 cx.emit(Event::UpdatedEntries(entry_changes));
740 }
741 if !repo_changes.is_empty() {
742 cx.emit(Event::UpdatedGitRepositories(repo_changes));
743 }
744 }
745
746 fn changed_repos(
747 &self,
748 old_snapshot: &LocalSnapshot,
749 new_snapshot: &LocalSnapshot,
750 ) -> UpdatedGitRepositoriesSet {
751 let mut changes = Vec::new();
752 let mut old_repos = old_snapshot.git_repositories.iter().peekable();
753 let mut new_repos = new_snapshot.git_repositories.iter().peekable();
754 loop {
755 match (new_repos.peek().map(clone), old_repos.peek().map(clone)) {
756 (Some((new_entry_id, new_repo)), Some((old_entry_id, old_repo))) => {
757 match Ord::cmp(&new_entry_id, &old_entry_id) {
758 Ordering::Less => {
759 if let Some(entry) = new_snapshot.entry_for_id(new_entry_id) {
760 changes.push((
761 entry.path.clone(),
762 GitRepositoryChange {
763 old_repository: None,
764 },
765 ));
766 }
767 new_repos.next();
768 }
769 Ordering::Equal => {
770 if new_repo.git_dir_scan_id != old_repo.git_dir_scan_id {
771 if let Some(entry) = new_snapshot.entry_for_id(new_entry_id) {
772 let old_repo = old_snapshot
773 .repository_entries
774 .get(&RepositoryWorkDirectory(entry.path.clone()))
775 .cloned();
776 changes.push((
777 entry.path.clone(),
778 GitRepositoryChange {
779 old_repository: old_repo,
780 },
781 ));
782 }
783 }
784 new_repos.next();
785 old_repos.next();
786 }
787 Ordering::Greater => {
788 if let Some(entry) = old_snapshot.entry_for_id(old_entry_id) {
789 let old_repo = old_snapshot
790 .repository_entries
791 .get(&RepositoryWorkDirectory(entry.path.clone()))
792 .cloned();
793 changes.push((
794 entry.path.clone(),
795 GitRepositoryChange {
796 old_repository: old_repo,
797 },
798 ));
799 }
800 old_repos.next();
801 }
802 }
803 }
804 (Some((entry_id, _)), None) => {
805 if let Some(entry) = new_snapshot.entry_for_id(entry_id) {
806 changes.push((
807 entry.path.clone(),
808 GitRepositoryChange {
809 old_repository: None,
810 },
811 ));
812 }
813 new_repos.next();
814 }
815 (None, Some((entry_id, _))) => {
816 if let Some(entry) = old_snapshot.entry_for_id(entry_id) {
817 let old_repo = old_snapshot
818 .repository_entries
819 .get(&RepositoryWorkDirectory(entry.path.clone()))
820 .cloned();
821 changes.push((
822 entry.path.clone(),
823 GitRepositoryChange {
824 old_repository: old_repo,
825 },
826 ));
827 }
828 old_repos.next();
829 }
830 (None, None) => break,
831 }
832 }
833
834 fn clone<T: Clone, U: Clone>(value: &(&T, &U)) -> (T, U) {
835 (value.0.clone(), value.1.clone())
836 }
837
838 changes.into()
839 }
840
841 pub fn scan_complete(&self) -> impl Future<Output = ()> {
842 let mut is_scanning_rx = self.is_scanning.1.clone();
843 async move {
844 let mut is_scanning = is_scanning_rx.borrow().clone();
845 while is_scanning {
846 if let Some(value) = is_scanning_rx.recv().await {
847 is_scanning = value;
848 } else {
849 break;
850 }
851 }
852 }
853 }
854
855 pub fn snapshot(&self) -> LocalSnapshot {
856 self.snapshot.clone()
857 }
858
859 pub fn metadata_proto(&self) -> proto::WorktreeMetadata {
860 proto::WorktreeMetadata {
861 id: self.id().to_proto(),
862 root_name: self.root_name().to_string(),
863 visible: self.visible,
864 abs_path: self.abs_path().as_os_str().to_string_lossy().into(),
865 }
866 }
867
868 fn load(
869 &self,
870 path: &Path,
871 cx: &mut ModelContext<Worktree>,
872 ) -> Task<Result<(File, String, Option<String>)>> {
873 let handle = cx.handle();
874 let path = Arc::from(path);
875 let abs_path = self.absolutize(&path);
876 let fs = self.fs.clone();
877 let snapshot = self.snapshot();
878
879 let mut index_task = None;
880
881 if let Some(repo) = snapshot.repository_for_path(&path) {
882 let repo_path = repo.work_directory.relativize(self, &path).unwrap();
883 if let Some(repo) = self.git_repositories.get(&*repo.work_directory) {
884 let repo = repo.repo_ptr.to_owned();
885 index_task = Some(
886 cx.background()
887 .spawn(async move { repo.lock().load_index_text(&repo_path) }),
888 );
889 }
890 }
891
892 cx.spawn(|this, mut cx| async move {
893 let text = fs.load(&abs_path).await?;
894
895 let diff_base = if let Some(index_task) = index_task {
896 index_task.await
897 } else {
898 None
899 };
900
901 // Eagerly populate the snapshot with an updated entry for the loaded file
902 let entry = this
903 .update(&mut cx, |this, cx| {
904 this.as_local().unwrap().refresh_entry(path, None, cx)
905 })
906 .await?;
907
908 Ok((
909 File {
910 entry_id: entry.id,
911 worktree: handle,
912 path: entry.path,
913 mtime: entry.mtime,
914 is_local: true,
915 is_deleted: false,
916 },
917 text,
918 diff_base,
919 ))
920 })
921 }
922
923 pub fn save_buffer(
924 &self,
925 buffer_handle: ModelHandle<Buffer>,
926 path: Arc<Path>,
927 has_changed_file: bool,
928 cx: &mut ModelContext<Worktree>,
929 ) -> Task<Result<(clock::Global, RopeFingerprint, SystemTime)>> {
930 let handle = cx.handle();
931 let buffer = buffer_handle.read(cx);
932
933 let rpc = self.client.clone();
934 let buffer_id = buffer.remote_id();
935 let project_id = self.share.as_ref().map(|share| share.project_id);
936
937 let text = buffer.as_rope().clone();
938 let fingerprint = text.fingerprint();
939 let version = buffer.version();
940 let save = self.write_file(path, text, buffer.line_ending(), cx);
941
942 cx.as_mut().spawn(|mut cx| async move {
943 let entry = save.await?;
944
945 if has_changed_file {
946 let new_file = Arc::new(File {
947 entry_id: entry.id,
948 worktree: handle,
949 path: entry.path,
950 mtime: entry.mtime,
951 is_local: true,
952 is_deleted: false,
953 });
954
955 if let Some(project_id) = project_id {
956 rpc.send(proto::UpdateBufferFile {
957 project_id,
958 buffer_id,
959 file: Some(new_file.to_proto()),
960 })
961 .log_err();
962 }
963
964 buffer_handle.update(&mut cx, |buffer, cx| {
965 if has_changed_file {
966 buffer.file_updated(new_file, cx).detach();
967 }
968 });
969 }
970
971 if let Some(project_id) = project_id {
972 rpc.send(proto::BufferSaved {
973 project_id,
974 buffer_id,
975 version: serialize_version(&version),
976 mtime: Some(entry.mtime.into()),
977 fingerprint: serialize_fingerprint(fingerprint),
978 })?;
979 }
980
981 buffer_handle.update(&mut cx, |buffer, cx| {
982 buffer.did_save(version.clone(), fingerprint, entry.mtime, cx);
983 });
984
985 Ok((version, fingerprint, entry.mtime))
986 })
987 }
988
989 pub fn create_entry(
990 &self,
991 path: impl Into<Arc<Path>>,
992 is_dir: bool,
993 cx: &mut ModelContext<Worktree>,
994 ) -> Task<Result<Entry>> {
995 let path = path.into();
996 let abs_path = self.absolutize(&path);
997 let fs = self.fs.clone();
998 let write = cx.background().spawn(async move {
999 if is_dir {
1000 fs.create_dir(&abs_path).await
1001 } else {
1002 fs.save(&abs_path, &Default::default(), Default::default())
1003 .await
1004 }
1005 });
1006
1007 cx.spawn(|this, mut cx| async move {
1008 write.await?;
1009 this.update(&mut cx, |this, cx| {
1010 this.as_local_mut().unwrap().refresh_entry(path, None, cx)
1011 })
1012 .await
1013 })
1014 }
1015
1016 pub fn write_file(
1017 &self,
1018 path: impl Into<Arc<Path>>,
1019 text: Rope,
1020 line_ending: LineEnding,
1021 cx: &mut ModelContext<Worktree>,
1022 ) -> Task<Result<Entry>> {
1023 let path = path.into();
1024 let abs_path = self.absolutize(&path);
1025 let fs = self.fs.clone();
1026 let write = cx
1027 .background()
1028 .spawn(async move { fs.save(&abs_path, &text, line_ending).await });
1029
1030 cx.spawn(|this, mut cx| async move {
1031 write.await?;
1032 this.update(&mut cx, |this, cx| {
1033 this.as_local_mut().unwrap().refresh_entry(path, None, cx)
1034 })
1035 .await
1036 })
1037 }
1038
1039 pub fn delete_entry(
1040 &self,
1041 entry_id: ProjectEntryId,
1042 cx: &mut ModelContext<Worktree>,
1043 ) -> Option<Task<Result<()>>> {
1044 let entry = self.entry_for_id(entry_id)?.clone();
1045 let abs_path = self.abs_path.clone();
1046 let fs = self.fs.clone();
1047
1048 let delete = cx.background().spawn(async move {
1049 let mut abs_path = fs.canonicalize(&abs_path).await?;
1050 if entry.path.file_name().is_some() {
1051 abs_path = abs_path.join(&entry.path);
1052 }
1053 if entry.is_file() {
1054 fs.remove_file(&abs_path, Default::default()).await?;
1055 } else {
1056 fs.remove_dir(
1057 &abs_path,
1058 RemoveOptions {
1059 recursive: true,
1060 ignore_if_not_exists: false,
1061 },
1062 )
1063 .await?;
1064 }
1065 anyhow::Ok(abs_path)
1066 });
1067
1068 Some(cx.spawn(|this, mut cx| async move {
1069 let abs_path = delete.await?;
1070 let (tx, mut rx) = barrier::channel();
1071 this.update(&mut cx, |this, _| {
1072 this.as_local_mut()
1073 .unwrap()
1074 .path_changes_tx
1075 .try_send((vec![abs_path], tx))
1076 })?;
1077 rx.recv().await;
1078 Ok(())
1079 }))
1080 }
1081
1082 pub fn rename_entry(
1083 &self,
1084 entry_id: ProjectEntryId,
1085 new_path: impl Into<Arc<Path>>,
1086 cx: &mut ModelContext<Worktree>,
1087 ) -> Option<Task<Result<Entry>>> {
1088 let old_path = self.entry_for_id(entry_id)?.path.clone();
1089 let new_path = new_path.into();
1090 let abs_old_path = self.absolutize(&old_path);
1091 let abs_new_path = self.absolutize(&new_path);
1092 let fs = self.fs.clone();
1093 let rename = cx.background().spawn(async move {
1094 fs.rename(&abs_old_path, &abs_new_path, Default::default())
1095 .await
1096 });
1097
1098 Some(cx.spawn(|this, mut cx| async move {
1099 rename.await?;
1100 this.update(&mut cx, |this, cx| {
1101 this.as_local_mut()
1102 .unwrap()
1103 .refresh_entry(new_path.clone(), Some(old_path), cx)
1104 })
1105 .await
1106 }))
1107 }
1108
1109 pub fn copy_entry(
1110 &self,
1111 entry_id: ProjectEntryId,
1112 new_path: impl Into<Arc<Path>>,
1113 cx: &mut ModelContext<Worktree>,
1114 ) -> Option<Task<Result<Entry>>> {
1115 let old_path = self.entry_for_id(entry_id)?.path.clone();
1116 let new_path = new_path.into();
1117 let abs_old_path = self.absolutize(&old_path);
1118 let abs_new_path = self.absolutize(&new_path);
1119 let fs = self.fs.clone();
1120 let copy = cx.background().spawn(async move {
1121 copy_recursive(
1122 fs.as_ref(),
1123 &abs_old_path,
1124 &abs_new_path,
1125 Default::default(),
1126 )
1127 .await
1128 });
1129
1130 Some(cx.spawn(|this, mut cx| async move {
1131 copy.await?;
1132 this.update(&mut cx, |this, cx| {
1133 this.as_local_mut()
1134 .unwrap()
1135 .refresh_entry(new_path.clone(), None, cx)
1136 })
1137 .await
1138 }))
1139 }
1140
1141 fn refresh_entry(
1142 &self,
1143 path: Arc<Path>,
1144 old_path: Option<Arc<Path>>,
1145 cx: &mut ModelContext<Worktree>,
1146 ) -> Task<Result<Entry>> {
1147 let fs = self.fs.clone();
1148 let abs_root_path = self.abs_path.clone();
1149 let path_changes_tx = self.path_changes_tx.clone();
1150 cx.spawn_weak(move |this, mut cx| async move {
1151 let abs_path = fs.canonicalize(&abs_root_path).await?;
1152 let mut paths = Vec::with_capacity(2);
1153 paths.push(if path.file_name().is_some() {
1154 abs_path.join(&path)
1155 } else {
1156 abs_path.clone()
1157 });
1158 if let Some(old_path) = old_path {
1159 paths.push(if old_path.file_name().is_some() {
1160 abs_path.join(&old_path)
1161 } else {
1162 abs_path.clone()
1163 });
1164 }
1165
1166 let (tx, mut rx) = barrier::channel();
1167 path_changes_tx.try_send((paths, tx))?;
1168 rx.recv().await;
1169 this.upgrade(&cx)
1170 .ok_or_else(|| anyhow!("worktree was dropped"))?
1171 .update(&mut cx, |this, _| {
1172 this.entry_for_path(path)
1173 .cloned()
1174 .ok_or_else(|| anyhow!("failed to read path after update"))
1175 })
1176 })
1177 }
1178
1179 pub fn observe_updates<F, Fut>(
1180 &mut self,
1181 project_id: u64,
1182 cx: &mut ModelContext<Worktree>,
1183 callback: F,
1184 ) -> oneshot::Receiver<()>
1185 where
1186 F: 'static + Send + Fn(proto::UpdateWorktree) -> Fut,
1187 Fut: Send + Future<Output = bool>,
1188 {
1189 #[cfg(any(test, feature = "test-support"))]
1190 const MAX_CHUNK_SIZE: usize = 2;
1191 #[cfg(not(any(test, feature = "test-support")))]
1192 const MAX_CHUNK_SIZE: usize = 256;
1193
1194 let (share_tx, share_rx) = oneshot::channel();
1195
1196 if let Some(share) = self.share.as_mut() {
1197 share_tx.send(()).ok();
1198 *share.resume_updates.borrow_mut() = ();
1199 return share_rx;
1200 }
1201
1202 let (resume_updates_tx, mut resume_updates_rx) = watch::channel::<()>();
1203 let (snapshots_tx, mut snapshots_rx) =
1204 mpsc::unbounded::<(LocalSnapshot, UpdatedEntriesSet, UpdatedGitRepositoriesSet)>();
1205 snapshots_tx
1206 .unbounded_send((self.snapshot(), Arc::from([]), Arc::from([])))
1207 .ok();
1208
1209 let worktree_id = cx.model_id() as u64;
1210 let _maintain_remote_snapshot = cx.background().spawn(async move {
1211 let mut is_first = true;
1212 while let Some((snapshot, entry_changes, repo_changes)) = snapshots_rx.next().await {
1213 let update;
1214 if is_first {
1215 update = snapshot.build_initial_update(project_id, worktree_id);
1216 is_first = false;
1217 } else {
1218 update =
1219 snapshot.build_update(project_id, worktree_id, entry_changes, repo_changes);
1220 }
1221
1222 for update in proto::split_worktree_update(update, MAX_CHUNK_SIZE) {
1223 let _ = resume_updates_rx.try_recv();
1224 loop {
1225 let result = callback(update.clone());
1226 if result.await {
1227 break;
1228 } else {
1229 log::info!("waiting to resume updates");
1230 if resume_updates_rx.next().await.is_none() {
1231 return Some(());
1232 }
1233 }
1234 }
1235 }
1236 }
1237 share_tx.send(()).ok();
1238 Some(())
1239 });
1240
1241 self.share = Some(ShareState {
1242 project_id,
1243 snapshots_tx,
1244 resume_updates: resume_updates_tx,
1245 _maintain_remote_snapshot,
1246 });
1247 share_rx
1248 }
1249
1250 pub fn share(&mut self, project_id: u64, cx: &mut ModelContext<Worktree>) -> Task<Result<()>> {
1251 let client = self.client.clone();
1252
1253 for (path, summaries) in &self.diagnostic_summaries {
1254 for (&server_id, summary) in summaries {
1255 if let Err(e) = self.client.send(proto::UpdateDiagnosticSummary {
1256 project_id,
1257 worktree_id: cx.model_id() as u64,
1258 summary: Some(summary.to_proto(server_id, &path)),
1259 }) {
1260 return Task::ready(Err(e));
1261 }
1262 }
1263 }
1264
1265 let rx = self.observe_updates(project_id, cx, move |update| {
1266 client.request(update).map(|result| result.is_ok())
1267 });
1268 cx.foreground()
1269 .spawn(async move { rx.await.map_err(|_| anyhow!("share ended")) })
1270 }
1271
1272 pub fn unshare(&mut self) {
1273 self.share.take();
1274 }
1275
1276 pub fn is_shared(&self) -> bool {
1277 self.share.is_some()
1278 }
1279}
1280
1281impl RemoteWorktree {
1282 fn snapshot(&self) -> Snapshot {
1283 self.snapshot.clone()
1284 }
1285
1286 pub fn disconnected_from_host(&mut self) {
1287 self.updates_tx.take();
1288 self.snapshot_subscriptions.clear();
1289 self.disconnected = true;
1290 }
1291
1292 pub fn save_buffer(
1293 &self,
1294 buffer_handle: ModelHandle<Buffer>,
1295 cx: &mut ModelContext<Worktree>,
1296 ) -> Task<Result<(clock::Global, RopeFingerprint, SystemTime)>> {
1297 let buffer = buffer_handle.read(cx);
1298 let buffer_id = buffer.remote_id();
1299 let version = buffer.version();
1300 let rpc = self.client.clone();
1301 let project_id = self.project_id;
1302 cx.as_mut().spawn(|mut cx| async move {
1303 let response = rpc
1304 .request(proto::SaveBuffer {
1305 project_id,
1306 buffer_id,
1307 version: serialize_version(&version),
1308 })
1309 .await?;
1310 let version = deserialize_version(&response.version);
1311 let fingerprint = deserialize_fingerprint(&response.fingerprint)?;
1312 let mtime = response
1313 .mtime
1314 .ok_or_else(|| anyhow!("missing mtime"))?
1315 .into();
1316
1317 buffer_handle.update(&mut cx, |buffer, cx| {
1318 buffer.did_save(version.clone(), fingerprint, mtime, cx);
1319 });
1320
1321 Ok((version, fingerprint, mtime))
1322 })
1323 }
1324
1325 pub fn update_from_remote(&mut self, update: proto::UpdateWorktree) {
1326 if let Some(updates_tx) = &self.updates_tx {
1327 updates_tx
1328 .unbounded_send(update)
1329 .expect("consumer runs to completion");
1330 }
1331 }
1332
1333 fn observed_snapshot(&self, scan_id: usize) -> bool {
1334 self.completed_scan_id >= scan_id
1335 }
1336
1337 fn wait_for_snapshot(&mut self, scan_id: usize) -> impl Future<Output = Result<()>> {
1338 let (tx, rx) = oneshot::channel();
1339 if self.observed_snapshot(scan_id) {
1340 let _ = tx.send(());
1341 } else if self.disconnected {
1342 drop(tx);
1343 } else {
1344 match self
1345 .snapshot_subscriptions
1346 .binary_search_by_key(&scan_id, |probe| probe.0)
1347 {
1348 Ok(ix) | Err(ix) => self.snapshot_subscriptions.insert(ix, (scan_id, tx)),
1349 }
1350 }
1351
1352 async move {
1353 rx.await?;
1354 Ok(())
1355 }
1356 }
1357
1358 pub fn update_diagnostic_summary(
1359 &mut self,
1360 path: Arc<Path>,
1361 summary: &proto::DiagnosticSummary,
1362 ) {
1363 let server_id = LanguageServerId(summary.language_server_id as usize);
1364 let summary = DiagnosticSummary {
1365 error_count: summary.error_count as usize,
1366 warning_count: summary.warning_count as usize,
1367 };
1368
1369 if summary.is_empty() {
1370 if let Some(summaries) = self.diagnostic_summaries.get_mut(&path) {
1371 summaries.remove(&server_id);
1372 if summaries.is_empty() {
1373 self.diagnostic_summaries.remove(&path);
1374 }
1375 }
1376 } else {
1377 self.diagnostic_summaries
1378 .entry(path)
1379 .or_default()
1380 .insert(server_id, summary);
1381 }
1382 }
1383
1384 pub fn insert_entry(
1385 &mut self,
1386 entry: proto::Entry,
1387 scan_id: usize,
1388 cx: &mut ModelContext<Worktree>,
1389 ) -> Task<Result<Entry>> {
1390 let wait_for_snapshot = self.wait_for_snapshot(scan_id);
1391 cx.spawn(|this, mut cx| async move {
1392 wait_for_snapshot.await?;
1393 this.update(&mut cx, |worktree, _| {
1394 let worktree = worktree.as_remote_mut().unwrap();
1395 let mut snapshot = worktree.background_snapshot.lock();
1396 let entry = snapshot.insert_entry(entry);
1397 worktree.snapshot = snapshot.clone();
1398 entry
1399 })
1400 })
1401 }
1402
1403 pub(crate) fn delete_entry(
1404 &mut self,
1405 id: ProjectEntryId,
1406 scan_id: usize,
1407 cx: &mut ModelContext<Worktree>,
1408 ) -> Task<Result<()>> {
1409 let wait_for_snapshot = self.wait_for_snapshot(scan_id);
1410 cx.spawn(|this, mut cx| async move {
1411 wait_for_snapshot.await?;
1412 this.update(&mut cx, |worktree, _| {
1413 let worktree = worktree.as_remote_mut().unwrap();
1414 let mut snapshot = worktree.background_snapshot.lock();
1415 snapshot.delete_entry(id);
1416 worktree.snapshot = snapshot.clone();
1417 });
1418 Ok(())
1419 })
1420 }
1421}
1422
1423impl Snapshot {
1424 pub fn id(&self) -> WorktreeId {
1425 self.id
1426 }
1427
1428 pub fn abs_path(&self) -> &Arc<Path> {
1429 &self.abs_path
1430 }
1431
1432 pub fn contains_entry(&self, entry_id: ProjectEntryId) -> bool {
1433 self.entries_by_id.get(&entry_id, &()).is_some()
1434 }
1435
1436 pub(crate) fn insert_entry(&mut self, entry: proto::Entry) -> Result<Entry> {
1437 let entry = Entry::try_from((&self.root_char_bag, entry))?;
1438 let old_entry = self.entries_by_id.insert_or_replace(
1439 PathEntry {
1440 id: entry.id,
1441 path: entry.path.clone(),
1442 is_ignored: entry.is_ignored,
1443 scan_id: 0,
1444 },
1445 &(),
1446 );
1447 if let Some(old_entry) = old_entry {
1448 self.entries_by_path.remove(&PathKey(old_entry.path), &());
1449 }
1450 self.entries_by_path.insert_or_replace(entry.clone(), &());
1451 Ok(entry)
1452 }
1453
1454 fn delete_entry(&mut self, entry_id: ProjectEntryId) -> Option<Arc<Path>> {
1455 let removed_entry = self.entries_by_id.remove(&entry_id, &())?;
1456 self.entries_by_path = {
1457 let mut cursor = self.entries_by_path.cursor();
1458 let mut new_entries_by_path =
1459 cursor.slice(&TraversalTarget::Path(&removed_entry.path), Bias::Left, &());
1460 while let Some(entry) = cursor.item() {
1461 if entry.path.starts_with(&removed_entry.path) {
1462 self.entries_by_id.remove(&entry.id, &());
1463 cursor.next(&());
1464 } else {
1465 break;
1466 }
1467 }
1468 new_entries_by_path.push_tree(cursor.suffix(&()), &());
1469 new_entries_by_path
1470 };
1471
1472 Some(removed_entry.path)
1473 }
1474
1475 #[cfg(any(test, feature = "test-support"))]
1476 pub fn status_for_file(&self, path: impl Into<PathBuf>) -> Option<GitFileStatus> {
1477 let path = path.into();
1478 self.entries_by_path
1479 .get(&PathKey(Arc::from(path)), &())
1480 .and_then(|entry| entry.git_status)
1481 }
1482
1483 pub(crate) fn apply_remote_update(&mut self, mut update: proto::UpdateWorktree) -> Result<()> {
1484 let mut entries_by_path_edits = Vec::new();
1485 let mut entries_by_id_edits = Vec::new();
1486
1487 for entry_id in update.removed_entries {
1488 let entry_id = ProjectEntryId::from_proto(entry_id);
1489 entries_by_id_edits.push(Edit::Remove(entry_id));
1490 if let Some(entry) = self.entry_for_id(entry_id) {
1491 entries_by_path_edits.push(Edit::Remove(PathKey(entry.path.clone())));
1492 }
1493 }
1494
1495 for entry in update.updated_entries {
1496 let entry = Entry::try_from((&self.root_char_bag, entry))?;
1497 if let Some(PathEntry { path, .. }) = self.entries_by_id.get(&entry.id, &()) {
1498 entries_by_path_edits.push(Edit::Remove(PathKey(path.clone())));
1499 }
1500 if let Some(old_entry) = self.entries_by_path.get(&PathKey(entry.path.clone()), &()) {
1501 if old_entry.id != entry.id {
1502 entries_by_id_edits.push(Edit::Remove(old_entry.id));
1503 }
1504 }
1505 entries_by_id_edits.push(Edit::Insert(PathEntry {
1506 id: entry.id,
1507 path: entry.path.clone(),
1508 is_ignored: entry.is_ignored,
1509 scan_id: 0,
1510 }));
1511 entries_by_path_edits.push(Edit::Insert(entry));
1512 }
1513
1514 self.entries_by_path.edit(entries_by_path_edits, &());
1515 self.entries_by_id.edit(entries_by_id_edits, &());
1516
1517 update.removed_repositories.sort_unstable();
1518 self.repository_entries.retain(|_, entry| {
1519 if let Ok(_) = update
1520 .removed_repositories
1521 .binary_search(&entry.work_directory.to_proto())
1522 {
1523 false
1524 } else {
1525 true
1526 }
1527 });
1528
1529 for repository in update.updated_repositories {
1530 let work_directory_entry: WorkDirectoryEntry =
1531 ProjectEntryId::from_proto(repository.work_directory_id).into();
1532
1533 if let Some(entry) = self.entry_for_id(*work_directory_entry) {
1534 let work_directory = RepositoryWorkDirectory(entry.path.clone());
1535 if self.repository_entries.get(&work_directory).is_some() {
1536 self.repository_entries.update(&work_directory, |repo| {
1537 repo.branch = repository.branch.map(Into::into);
1538 });
1539 } else {
1540 self.repository_entries.insert(
1541 work_directory,
1542 RepositoryEntry {
1543 work_directory: work_directory_entry,
1544 branch: repository.branch.map(Into::into),
1545 },
1546 )
1547 }
1548 } else {
1549 log::error!("no work directory entry for repository {:?}", repository)
1550 }
1551 }
1552
1553 self.scan_id = update.scan_id as usize;
1554 if update.is_last_update {
1555 self.completed_scan_id = update.scan_id as usize;
1556 }
1557
1558 Ok(())
1559 }
1560
1561 pub fn file_count(&self) -> usize {
1562 self.entries_by_path.summary().file_count
1563 }
1564
1565 pub fn visible_file_count(&self) -> usize {
1566 self.entries_by_path.summary().visible_file_count
1567 }
1568
1569 fn traverse_from_offset(
1570 &self,
1571 include_dirs: bool,
1572 include_ignored: bool,
1573 start_offset: usize,
1574 ) -> Traversal {
1575 let mut cursor = self.entries_by_path.cursor();
1576 cursor.seek(
1577 &TraversalTarget::Count {
1578 count: start_offset,
1579 include_dirs,
1580 include_ignored,
1581 },
1582 Bias::Right,
1583 &(),
1584 );
1585 Traversal {
1586 cursor,
1587 include_dirs,
1588 include_ignored,
1589 }
1590 }
1591
1592 fn traverse_from_path(
1593 &self,
1594 include_dirs: bool,
1595 include_ignored: bool,
1596 path: &Path,
1597 ) -> Traversal {
1598 let mut cursor = self.entries_by_path.cursor();
1599 cursor.seek(&TraversalTarget::Path(path), Bias::Left, &());
1600 Traversal {
1601 cursor,
1602 include_dirs,
1603 include_ignored,
1604 }
1605 }
1606
1607 pub fn files(&self, include_ignored: bool, start: usize) -> Traversal {
1608 self.traverse_from_offset(false, include_ignored, start)
1609 }
1610
1611 pub fn entries(&self, include_ignored: bool) -> Traversal {
1612 self.traverse_from_offset(true, include_ignored, 0)
1613 }
1614
1615 pub fn repositories(&self) -> impl Iterator<Item = (&Arc<Path>, &RepositoryEntry)> {
1616 self.repository_entries
1617 .iter()
1618 .map(|(path, entry)| (&path.0, entry))
1619 }
1620
1621 /// Get the repository whose work directory contains the given path.
1622 pub fn repository_for_work_directory(&self, path: &Path) -> Option<RepositoryEntry> {
1623 self.repository_entries
1624 .get(&RepositoryWorkDirectory(path.into()))
1625 .cloned()
1626 }
1627
1628 /// Get the repository whose work directory contains the given path.
1629 pub fn repository_for_path(&self, path: &Path) -> Option<RepositoryEntry> {
1630 self.repository_and_work_directory_for_path(path)
1631 .map(|e| e.1)
1632 }
1633
1634 pub fn repository_and_work_directory_for_path(
1635 &self,
1636 path: &Path,
1637 ) -> Option<(RepositoryWorkDirectory, RepositoryEntry)> {
1638 self.repository_entries
1639 .iter()
1640 .filter(|(workdir_path, _)| path.starts_with(workdir_path))
1641 .last()
1642 .map(|(path, repo)| (path.clone(), repo.clone()))
1643 }
1644
1645 /// Given an ordered iterator of entries, returns an iterator of those entries,
1646 /// along with their containing git repository.
1647 pub fn entries_with_repositories<'a>(
1648 &'a self,
1649 entries: impl 'a + Iterator<Item = &'a Entry>,
1650 ) -> impl 'a + Iterator<Item = (&'a Entry, Option<&'a RepositoryEntry>)> {
1651 let mut containing_repos = Vec::<(&Arc<Path>, &RepositoryEntry)>::new();
1652 let mut repositories = self.repositories().peekable();
1653 entries.map(move |entry| {
1654 while let Some((repo_path, _)) = containing_repos.last() {
1655 if !entry.path.starts_with(repo_path) {
1656 containing_repos.pop();
1657 } else {
1658 break;
1659 }
1660 }
1661 while let Some((repo_path, _)) = repositories.peek() {
1662 if entry.path.starts_with(repo_path) {
1663 containing_repos.push(repositories.next().unwrap());
1664 } else {
1665 break;
1666 }
1667 }
1668 let repo = containing_repos.last().map(|(_, repo)| *repo);
1669 (entry, repo)
1670 })
1671 }
1672
1673 pub fn paths(&self) -> impl Iterator<Item = &Arc<Path>> {
1674 let empty_path = Path::new("");
1675 self.entries_by_path
1676 .cursor::<()>()
1677 .filter(move |entry| entry.path.as_ref() != empty_path)
1678 .map(|entry| &entry.path)
1679 }
1680
1681 fn child_entries<'a>(&'a self, parent_path: &'a Path) -> ChildEntriesIter<'a> {
1682 let mut cursor = self.entries_by_path.cursor();
1683 cursor.seek(&TraversalTarget::Path(parent_path), Bias::Right, &());
1684 let traversal = Traversal {
1685 cursor,
1686 include_dirs: true,
1687 include_ignored: true,
1688 };
1689 ChildEntriesIter {
1690 traversal,
1691 parent_path,
1692 }
1693 }
1694
1695 fn descendent_entries<'a>(
1696 &'a self,
1697 include_dirs: bool,
1698 include_ignored: bool,
1699 parent_path: &'a Path,
1700 ) -> DescendentEntriesIter<'a> {
1701 let mut cursor = self.entries_by_path.cursor();
1702 cursor.seek(&TraversalTarget::Path(parent_path), Bias::Left, &());
1703 let mut traversal = Traversal {
1704 cursor,
1705 include_dirs,
1706 include_ignored,
1707 };
1708
1709 if traversal.end_offset() == traversal.start_offset() {
1710 traversal.advance();
1711 }
1712
1713 DescendentEntriesIter {
1714 traversal,
1715 parent_path,
1716 }
1717 }
1718
1719 pub fn root_entry(&self) -> Option<&Entry> {
1720 self.entry_for_path("")
1721 }
1722
1723 pub fn root_name(&self) -> &str {
1724 &self.root_name
1725 }
1726
1727 pub fn root_git_entry(&self) -> Option<RepositoryEntry> {
1728 self.repository_entries
1729 .get(&RepositoryWorkDirectory(Path::new("").into()))
1730 .map(|entry| entry.to_owned())
1731 }
1732
1733 pub fn git_entries(&self) -> impl Iterator<Item = &RepositoryEntry> {
1734 self.repository_entries.values()
1735 }
1736
1737 pub fn scan_id(&self) -> usize {
1738 self.scan_id
1739 }
1740
1741 pub fn entry_for_path(&self, path: impl AsRef<Path>) -> Option<&Entry> {
1742 let path = path.as_ref();
1743 self.traverse_from_path(true, true, path)
1744 .entry()
1745 .and_then(|entry| {
1746 if entry.path.as_ref() == path {
1747 Some(entry)
1748 } else {
1749 None
1750 }
1751 })
1752 }
1753
1754 pub fn entry_for_id(&self, id: ProjectEntryId) -> Option<&Entry> {
1755 let entry = self.entries_by_id.get(&id, &())?;
1756 self.entry_for_path(&entry.path)
1757 }
1758
1759 pub fn inode_for_path(&self, path: impl AsRef<Path>) -> Option<u64> {
1760 self.entry_for_path(path.as_ref()).map(|e| e.inode)
1761 }
1762}
1763
1764impl LocalSnapshot {
1765 pub(crate) fn get_local_repo(&self, repo: &RepositoryEntry) -> Option<&LocalRepositoryEntry> {
1766 self.git_repositories.get(&repo.work_directory.0)
1767 }
1768
1769 pub(crate) fn repo_for_metadata(
1770 &self,
1771 path: &Path,
1772 ) -> Option<(&ProjectEntryId, &LocalRepositoryEntry)> {
1773 self.git_repositories
1774 .iter()
1775 .find(|(_, repo)| repo.in_dot_git(path))
1776 }
1777
1778 fn build_update(
1779 &self,
1780 project_id: u64,
1781 worktree_id: u64,
1782 entry_changes: UpdatedEntriesSet,
1783 repo_changes: UpdatedGitRepositoriesSet,
1784 ) -> proto::UpdateWorktree {
1785 let mut updated_entries = Vec::new();
1786 let mut removed_entries = Vec::new();
1787 let mut updated_repositories = Vec::new();
1788 let mut removed_repositories = Vec::new();
1789
1790 for (_, entry_id, path_change) in entry_changes.iter() {
1791 if let PathChange::Removed = path_change {
1792 removed_entries.push(entry_id.0 as u64);
1793 } else if let Some(entry) = self.entry_for_id(*entry_id) {
1794 updated_entries.push(proto::Entry::from(entry));
1795 }
1796 }
1797
1798 for (work_dir_path, change) in repo_changes.iter() {
1799 let new_repo = self
1800 .repository_entries
1801 .get(&RepositoryWorkDirectory(work_dir_path.clone()));
1802 match (&change.old_repository, new_repo) {
1803 (Some(old_repo), Some(new_repo)) => {
1804 updated_repositories.push(new_repo.build_update(old_repo));
1805 }
1806 (None, Some(new_repo)) => {
1807 updated_repositories.push(proto::RepositoryEntry::from(new_repo));
1808 }
1809 (Some(old_repo), None) => {
1810 removed_repositories.push(old_repo.work_directory.0.to_proto());
1811 }
1812 _ => {}
1813 }
1814 }
1815
1816 removed_entries.sort_unstable();
1817 updated_entries.sort_unstable_by_key(|e| e.id);
1818 removed_repositories.sort_unstable();
1819 updated_repositories.sort_unstable_by_key(|e| e.work_directory_id);
1820
1821 // TODO - optimize, knowing that removed_entries are sorted.
1822 removed_entries.retain(|id| updated_entries.binary_search_by_key(id, |e| e.id).is_err());
1823
1824 proto::UpdateWorktree {
1825 project_id,
1826 worktree_id,
1827 abs_path: self.abs_path().to_string_lossy().into(),
1828 root_name: self.root_name().to_string(),
1829 updated_entries,
1830 removed_entries,
1831 scan_id: self.scan_id as u64,
1832 is_last_update: self.completed_scan_id == self.scan_id,
1833 updated_repositories,
1834 removed_repositories,
1835 }
1836 }
1837
1838 fn build_initial_update(&self, project_id: u64, worktree_id: u64) -> proto::UpdateWorktree {
1839 let mut updated_entries = self
1840 .entries_by_path
1841 .iter()
1842 .map(proto::Entry::from)
1843 .collect::<Vec<_>>();
1844 updated_entries.sort_unstable_by_key(|e| e.id);
1845
1846 let mut updated_repositories = self
1847 .repository_entries
1848 .values()
1849 .map(proto::RepositoryEntry::from)
1850 .collect::<Vec<_>>();
1851 updated_repositories.sort_unstable_by_key(|e| e.work_directory_id);
1852
1853 proto::UpdateWorktree {
1854 project_id,
1855 worktree_id,
1856 abs_path: self.abs_path().to_string_lossy().into(),
1857 root_name: self.root_name().to_string(),
1858 updated_entries,
1859 removed_entries: Vec::new(),
1860 scan_id: self.scan_id as u64,
1861 is_last_update: self.completed_scan_id == self.scan_id,
1862 updated_repositories,
1863 removed_repositories: Vec::new(),
1864 }
1865 }
1866
1867 fn insert_entry(&mut self, mut entry: Entry, fs: &dyn Fs) -> Entry {
1868 if entry.is_file() && entry.path.file_name() == Some(&GITIGNORE) {
1869 let abs_path = self.abs_path.join(&entry.path);
1870 match smol::block_on(build_gitignore(&abs_path, fs)) {
1871 Ok(ignore) => {
1872 self.ignores_by_parent_abs_path
1873 .insert(abs_path.parent().unwrap().into(), (Arc::new(ignore), true));
1874 }
1875 Err(error) => {
1876 log::error!(
1877 "error loading .gitignore file {:?} - {:?}",
1878 &entry.path,
1879 error
1880 );
1881 }
1882 }
1883 }
1884
1885 if entry.kind == EntryKind::PendingDir {
1886 if let Some(existing_entry) =
1887 self.entries_by_path.get(&PathKey(entry.path.clone()), &())
1888 {
1889 entry.kind = existing_entry.kind;
1890 }
1891 }
1892
1893 let scan_id = self.scan_id;
1894 let removed = self.entries_by_path.insert_or_replace(entry.clone(), &());
1895 if let Some(removed) = removed {
1896 if removed.id != entry.id {
1897 self.entries_by_id.remove(&removed.id, &());
1898 }
1899 }
1900 self.entries_by_id.insert_or_replace(
1901 PathEntry {
1902 id: entry.id,
1903 path: entry.path.clone(),
1904 is_ignored: entry.is_ignored,
1905 scan_id,
1906 },
1907 &(),
1908 );
1909
1910 entry
1911 }
1912
1913 fn build_repo(&mut self, parent_path: Arc<Path>, fs: &dyn Fs) -> Option<()> {
1914 let abs_path = self.abs_path.join(&parent_path);
1915 let work_dir: Arc<Path> = parent_path.parent().unwrap().into();
1916
1917 // Guard against repositories inside the repository metadata
1918 if work_dir
1919 .components()
1920 .find(|component| component.as_os_str() == *DOT_GIT)
1921 .is_some()
1922 {
1923 return None;
1924 };
1925
1926 let work_dir_id = self
1927 .entry_for_path(work_dir.clone())
1928 .map(|entry| entry.id)?;
1929
1930 if self.git_repositories.get(&work_dir_id).is_none() {
1931 let repo = fs.open_repo(abs_path.as_path())?;
1932 let work_directory = RepositoryWorkDirectory(work_dir.clone());
1933
1934 let repo_lock = repo.lock();
1935
1936 self.repository_entries.insert(
1937 work_directory.clone(),
1938 RepositoryEntry {
1939 work_directory: work_dir_id.into(),
1940 branch: repo_lock.branch_name().map(Into::into),
1941 },
1942 );
1943
1944 self.scan_statuses(repo_lock.deref(), &work_directory);
1945
1946 drop(repo_lock);
1947
1948 self.git_repositories.insert(
1949 work_dir_id,
1950 LocalRepositoryEntry {
1951 git_dir_scan_id: 0,
1952 repo_ptr: repo,
1953 git_dir_path: parent_path.clone(),
1954 },
1955 )
1956 }
1957
1958 Some(())
1959 }
1960
1961 fn scan_statuses(
1962 &mut self,
1963 repo_ptr: &dyn GitRepository,
1964 work_directory: &RepositoryWorkDirectory,
1965 ) {
1966 let statuses = repo_ptr.statuses().unwrap_or_default();
1967 let mut edits = vec![];
1968 for (repo_path, status) in statuses.iter() {
1969 self.set_git_status(&work_directory.0.join(repo_path), Some(*status), &mut edits);
1970 }
1971 self.entries_by_path.edit(edits, &());
1972 }
1973
1974 fn set_git_status(
1975 &self,
1976 path: &Path,
1977 status: Option<GitFileStatus>,
1978 edits: &mut Vec<Edit<Entry>>,
1979 ) {
1980 for path in path.ancestors() {
1981 let Some(entry) = self.entry_for_path(path) else {
1982 continue;
1983 };
1984 let mut entry = entry.clone();
1985 entry.git_status = GitFileStatus::merge(entry.git_status, status);
1986 edits.push(Edit::Insert(entry))
1987 }
1988 }
1989
1990 fn ancestor_inodes_for_path(&self, path: &Path) -> TreeSet<u64> {
1991 let mut inodes = TreeSet::default();
1992 for ancestor in path.ancestors().skip(1) {
1993 if let Some(entry) = self.entry_for_path(ancestor) {
1994 inodes.insert(entry.inode);
1995 }
1996 }
1997 inodes
1998 }
1999
2000 fn ignore_stack_for_abs_path(&self, abs_path: &Path, is_dir: bool) -> Arc<IgnoreStack> {
2001 let mut new_ignores = Vec::new();
2002 for ancestor in abs_path.ancestors().skip(1) {
2003 if let Some((ignore, _)) = self.ignores_by_parent_abs_path.get(ancestor) {
2004 new_ignores.push((ancestor, Some(ignore.clone())));
2005 } else {
2006 new_ignores.push((ancestor, None));
2007 }
2008 }
2009
2010 let mut ignore_stack = IgnoreStack::none();
2011 for (parent_abs_path, ignore) in new_ignores.into_iter().rev() {
2012 if ignore_stack.is_abs_path_ignored(parent_abs_path, true) {
2013 ignore_stack = IgnoreStack::all();
2014 break;
2015 } else if let Some(ignore) = ignore {
2016 ignore_stack = ignore_stack.append(parent_abs_path.into(), ignore);
2017 }
2018 }
2019
2020 if ignore_stack.is_abs_path_ignored(abs_path, is_dir) {
2021 ignore_stack = IgnoreStack::all();
2022 }
2023
2024 ignore_stack
2025 }
2026}
2027
2028impl BackgroundScannerState {
2029 fn reuse_entry_id(&mut self, entry: &mut Entry) {
2030 if let Some(removed_entry_id) = self.removed_entry_ids.remove(&entry.inode) {
2031 entry.id = removed_entry_id;
2032 } else if let Some(existing_entry) = self.snapshot.entry_for_path(&entry.path) {
2033 entry.id = existing_entry.id;
2034 }
2035 }
2036
2037 fn insert_entry(&mut self, mut entry: Entry, fs: &dyn Fs) -> Entry {
2038 self.reuse_entry_id(&mut entry);
2039 self.snapshot.insert_entry(entry, fs)
2040 }
2041
2042 fn populate_dir(
2043 &mut self,
2044 parent_path: Arc<Path>,
2045 entries: impl IntoIterator<Item = Entry>,
2046 ignore: Option<Arc<Gitignore>>,
2047 fs: &dyn Fs,
2048 ) {
2049 let mut parent_entry = if let Some(parent_entry) = self
2050 .snapshot
2051 .entries_by_path
2052 .get(&PathKey(parent_path.clone()), &())
2053 {
2054 parent_entry.clone()
2055 } else {
2056 log::warn!(
2057 "populating a directory {:?} that has been removed",
2058 parent_path
2059 );
2060 return;
2061 };
2062
2063 match parent_entry.kind {
2064 EntryKind::PendingDir => {
2065 parent_entry.kind = EntryKind::Dir;
2066 }
2067 EntryKind::Dir => {}
2068 _ => return,
2069 }
2070
2071 if let Some(ignore) = ignore {
2072 let abs_parent_path = self.snapshot.abs_path.join(&parent_path).into();
2073 self.snapshot
2074 .ignores_by_parent_abs_path
2075 .insert(abs_parent_path, (ignore, false));
2076 }
2077
2078 if parent_path.file_name() == Some(&DOT_GIT) {
2079 self.snapshot.build_repo(parent_path, fs);
2080 }
2081
2082 let mut entries_by_path_edits = vec![Edit::Insert(parent_entry)];
2083 let mut entries_by_id_edits = Vec::new();
2084
2085 for mut entry in entries {
2086 self.reuse_entry_id(&mut entry);
2087 entries_by_id_edits.push(Edit::Insert(PathEntry {
2088 id: entry.id,
2089 path: entry.path.clone(),
2090 is_ignored: entry.is_ignored,
2091 scan_id: self.snapshot.scan_id,
2092 }));
2093 entries_by_path_edits.push(Edit::Insert(entry));
2094 }
2095
2096 self.snapshot
2097 .entries_by_path
2098 .edit(entries_by_path_edits, &());
2099 self.snapshot.entries_by_id.edit(entries_by_id_edits, &());
2100 }
2101
2102 fn remove_path(&mut self, path: &Path) {
2103 let mut new_entries;
2104 let removed_entries;
2105 {
2106 let mut cursor = self.snapshot.entries_by_path.cursor::<TraversalProgress>();
2107 new_entries = cursor.slice(&TraversalTarget::Path(path), Bias::Left, &());
2108 removed_entries = cursor.slice(&TraversalTarget::PathSuccessor(path), Bias::Left, &());
2109 new_entries.push_tree(cursor.suffix(&()), &());
2110 }
2111 self.snapshot.entries_by_path = new_entries;
2112
2113 let mut entries_by_id_edits = Vec::new();
2114 for entry in removed_entries.cursor::<()>() {
2115 let removed_entry_id = self
2116 .removed_entry_ids
2117 .entry(entry.inode)
2118 .or_insert(entry.id);
2119 *removed_entry_id = cmp::max(*removed_entry_id, entry.id);
2120 entries_by_id_edits.push(Edit::Remove(entry.id));
2121 }
2122 self.snapshot.entries_by_id.edit(entries_by_id_edits, &());
2123
2124 if path.file_name() == Some(&GITIGNORE) {
2125 let abs_parent_path = self.snapshot.abs_path.join(path.parent().unwrap());
2126 if let Some((_, needs_update)) = self
2127 .snapshot
2128 .ignores_by_parent_abs_path
2129 .get_mut(abs_parent_path.as_path())
2130 {
2131 *needs_update = true;
2132 }
2133 }
2134 }
2135}
2136
2137async fn build_gitignore(abs_path: &Path, fs: &dyn Fs) -> Result<Gitignore> {
2138 let contents = fs.load(abs_path).await?;
2139 let parent = abs_path.parent().unwrap_or_else(|| Path::new("/"));
2140 let mut builder = GitignoreBuilder::new(parent);
2141 for line in contents.lines() {
2142 builder.add_line(Some(abs_path.into()), line)?;
2143 }
2144 Ok(builder.build()?)
2145}
2146
2147impl WorktreeId {
2148 pub fn from_usize(handle_id: usize) -> Self {
2149 Self(handle_id)
2150 }
2151
2152 pub(crate) fn from_proto(id: u64) -> Self {
2153 Self(id as usize)
2154 }
2155
2156 pub fn to_proto(&self) -> u64 {
2157 self.0 as u64
2158 }
2159
2160 pub fn to_usize(&self) -> usize {
2161 self.0
2162 }
2163}
2164
2165impl fmt::Display for WorktreeId {
2166 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2167 self.0.fmt(f)
2168 }
2169}
2170
2171impl Deref for Worktree {
2172 type Target = Snapshot;
2173
2174 fn deref(&self) -> &Self::Target {
2175 match self {
2176 Worktree::Local(worktree) => &worktree.snapshot,
2177 Worktree::Remote(worktree) => &worktree.snapshot,
2178 }
2179 }
2180}
2181
2182impl Deref for LocalWorktree {
2183 type Target = LocalSnapshot;
2184
2185 fn deref(&self) -> &Self::Target {
2186 &self.snapshot
2187 }
2188}
2189
2190impl Deref for RemoteWorktree {
2191 type Target = Snapshot;
2192
2193 fn deref(&self) -> &Self::Target {
2194 &self.snapshot
2195 }
2196}
2197
2198impl fmt::Debug for LocalWorktree {
2199 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2200 self.snapshot.fmt(f)
2201 }
2202}
2203
2204impl fmt::Debug for Snapshot {
2205 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2206 struct EntriesById<'a>(&'a SumTree<PathEntry>);
2207 struct EntriesByPath<'a>(&'a SumTree<Entry>);
2208
2209 impl<'a> fmt::Debug for EntriesByPath<'a> {
2210 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2211 f.debug_map()
2212 .entries(self.0.iter().map(|entry| (&entry.path, entry.id)))
2213 .finish()
2214 }
2215 }
2216
2217 impl<'a> fmt::Debug for EntriesById<'a> {
2218 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2219 f.debug_list().entries(self.0.iter()).finish()
2220 }
2221 }
2222
2223 f.debug_struct("Snapshot")
2224 .field("id", &self.id)
2225 .field("root_name", &self.root_name)
2226 .field("entries_by_path", &EntriesByPath(&self.entries_by_path))
2227 .field("entries_by_id", &EntriesById(&self.entries_by_id))
2228 .finish()
2229 }
2230}
2231
2232#[derive(Clone, PartialEq)]
2233pub struct File {
2234 pub worktree: ModelHandle<Worktree>,
2235 pub path: Arc<Path>,
2236 pub mtime: SystemTime,
2237 pub(crate) entry_id: ProjectEntryId,
2238 pub(crate) is_local: bool,
2239 pub(crate) is_deleted: bool,
2240}
2241
2242impl language::File for File {
2243 fn as_local(&self) -> Option<&dyn language::LocalFile> {
2244 if self.is_local {
2245 Some(self)
2246 } else {
2247 None
2248 }
2249 }
2250
2251 fn mtime(&self) -> SystemTime {
2252 self.mtime
2253 }
2254
2255 fn path(&self) -> &Arc<Path> {
2256 &self.path
2257 }
2258
2259 fn full_path(&self, cx: &AppContext) -> PathBuf {
2260 let mut full_path = PathBuf::new();
2261 let worktree = self.worktree.read(cx);
2262
2263 if worktree.is_visible() {
2264 full_path.push(worktree.root_name());
2265 } else {
2266 let path = worktree.abs_path();
2267
2268 if worktree.is_local() && path.starts_with(HOME.as_path()) {
2269 full_path.push("~");
2270 full_path.push(path.strip_prefix(HOME.as_path()).unwrap());
2271 } else {
2272 full_path.push(path)
2273 }
2274 }
2275
2276 if self.path.components().next().is_some() {
2277 full_path.push(&self.path);
2278 }
2279
2280 full_path
2281 }
2282
2283 /// Returns the last component of this handle's absolute path. If this handle refers to the root
2284 /// of its worktree, then this method will return the name of the worktree itself.
2285 fn file_name<'a>(&'a self, cx: &'a AppContext) -> &'a OsStr {
2286 self.path
2287 .file_name()
2288 .unwrap_or_else(|| OsStr::new(&self.worktree.read(cx).root_name))
2289 }
2290
2291 fn is_deleted(&self) -> bool {
2292 self.is_deleted
2293 }
2294
2295 fn as_any(&self) -> &dyn Any {
2296 self
2297 }
2298
2299 fn to_proto(&self) -> rpc::proto::File {
2300 rpc::proto::File {
2301 worktree_id: self.worktree.id() as u64,
2302 entry_id: self.entry_id.to_proto(),
2303 path: self.path.to_string_lossy().into(),
2304 mtime: Some(self.mtime.into()),
2305 is_deleted: self.is_deleted,
2306 }
2307 }
2308}
2309
2310impl language::LocalFile for File {
2311 fn abs_path(&self, cx: &AppContext) -> PathBuf {
2312 self.worktree
2313 .read(cx)
2314 .as_local()
2315 .unwrap()
2316 .abs_path
2317 .join(&self.path)
2318 }
2319
2320 fn load(&self, cx: &AppContext) -> Task<Result<String>> {
2321 let worktree = self.worktree.read(cx).as_local().unwrap();
2322 let abs_path = worktree.absolutize(&self.path);
2323 let fs = worktree.fs.clone();
2324 cx.background()
2325 .spawn(async move { fs.load(&abs_path).await })
2326 }
2327
2328 fn buffer_reloaded(
2329 &self,
2330 buffer_id: u64,
2331 version: &clock::Global,
2332 fingerprint: RopeFingerprint,
2333 line_ending: LineEnding,
2334 mtime: SystemTime,
2335 cx: &mut AppContext,
2336 ) {
2337 let worktree = self.worktree.read(cx).as_local().unwrap();
2338 if let Some(project_id) = worktree.share.as_ref().map(|share| share.project_id) {
2339 worktree
2340 .client
2341 .send(proto::BufferReloaded {
2342 project_id,
2343 buffer_id,
2344 version: serialize_version(version),
2345 mtime: Some(mtime.into()),
2346 fingerprint: serialize_fingerprint(fingerprint),
2347 line_ending: serialize_line_ending(line_ending) as i32,
2348 })
2349 .log_err();
2350 }
2351 }
2352}
2353
2354impl File {
2355 pub fn from_proto(
2356 proto: rpc::proto::File,
2357 worktree: ModelHandle<Worktree>,
2358 cx: &AppContext,
2359 ) -> Result<Self> {
2360 let worktree_id = worktree
2361 .read(cx)
2362 .as_remote()
2363 .ok_or_else(|| anyhow!("not remote"))?
2364 .id();
2365
2366 if worktree_id.to_proto() != proto.worktree_id {
2367 return Err(anyhow!("worktree id does not match file"));
2368 }
2369
2370 Ok(Self {
2371 worktree,
2372 path: Path::new(&proto.path).into(),
2373 mtime: proto.mtime.ok_or_else(|| anyhow!("no timestamp"))?.into(),
2374 entry_id: ProjectEntryId::from_proto(proto.entry_id),
2375 is_local: false,
2376 is_deleted: proto.is_deleted,
2377 })
2378 }
2379
2380 pub fn from_dyn(file: Option<&Arc<dyn language::File>>) -> Option<&Self> {
2381 file.and_then(|f| f.as_any().downcast_ref())
2382 }
2383
2384 pub fn worktree_id(&self, cx: &AppContext) -> WorktreeId {
2385 self.worktree.read(cx).id()
2386 }
2387
2388 pub fn project_entry_id(&self, _: &AppContext) -> Option<ProjectEntryId> {
2389 if self.is_deleted {
2390 None
2391 } else {
2392 Some(self.entry_id)
2393 }
2394 }
2395}
2396
2397#[derive(Clone, Debug, PartialEq, Eq)]
2398pub struct Entry {
2399 pub id: ProjectEntryId,
2400 pub kind: EntryKind,
2401 pub path: Arc<Path>,
2402 pub inode: u64,
2403 pub mtime: SystemTime,
2404 pub is_symlink: bool,
2405 pub is_ignored: bool,
2406 pub git_status: Option<GitFileStatus>,
2407}
2408
2409#[derive(Clone, Copy, Debug, PartialEq, Eq)]
2410pub enum EntryKind {
2411 PendingDir,
2412 Dir,
2413 File(CharBag),
2414}
2415
2416#[derive(Clone, Copy, Debug)]
2417pub enum PathChange {
2418 /// A filesystem entry was was created.
2419 Added,
2420 /// A filesystem entry was removed.
2421 Removed,
2422 /// A filesystem entry was updated.
2423 Updated,
2424 /// A filesystem entry was either updated or added. We don't know
2425 /// whether or not it already existed, because the path had not
2426 /// been loaded before the event.
2427 AddedOrUpdated,
2428 /// A filesystem entry was found during the initial scan of the worktree.
2429 Loaded,
2430}
2431
2432pub struct GitRepositoryChange {
2433 /// The previous state of the repository, if it already existed.
2434 pub old_repository: Option<RepositoryEntry>,
2435}
2436
2437pub type UpdatedEntriesSet = Arc<[(Arc<Path>, ProjectEntryId, PathChange)]>;
2438pub type UpdatedGitRepositoriesSet = Arc<[(Arc<Path>, GitRepositoryChange)]>;
2439
2440impl Entry {
2441 fn new(
2442 path: Arc<Path>,
2443 metadata: &fs::Metadata,
2444 next_entry_id: &AtomicUsize,
2445 root_char_bag: CharBag,
2446 ) -> Self {
2447 Self {
2448 id: ProjectEntryId::new(next_entry_id),
2449 kind: if metadata.is_dir {
2450 EntryKind::PendingDir
2451 } else {
2452 EntryKind::File(char_bag_for_path(root_char_bag, &path))
2453 },
2454 path,
2455 inode: metadata.inode,
2456 mtime: metadata.mtime,
2457 is_symlink: metadata.is_symlink,
2458 is_ignored: false,
2459 git_status: None,
2460 }
2461 }
2462
2463 pub fn is_dir(&self) -> bool {
2464 matches!(self.kind, EntryKind::Dir | EntryKind::PendingDir)
2465 }
2466
2467 pub fn is_file(&self) -> bool {
2468 matches!(self.kind, EntryKind::File(_))
2469 }
2470}
2471
2472impl sum_tree::Item for Entry {
2473 type Summary = EntrySummary;
2474
2475 fn summary(&self) -> Self::Summary {
2476 let visible_count = if self.is_ignored { 0 } else { 1 };
2477 let file_count;
2478 let visible_file_count;
2479 if self.is_file() {
2480 file_count = 1;
2481 visible_file_count = visible_count;
2482 } else {
2483 file_count = 0;
2484 visible_file_count = 0;
2485 }
2486
2487 EntrySummary {
2488 max_path: self.path.clone(),
2489 count: 1,
2490 visible_count,
2491 file_count,
2492 visible_file_count,
2493 }
2494 }
2495}
2496
2497impl sum_tree::KeyedItem for Entry {
2498 type Key = PathKey;
2499
2500 fn key(&self) -> Self::Key {
2501 PathKey(self.path.clone())
2502 }
2503}
2504
2505#[derive(Clone, Debug)]
2506pub struct EntrySummary {
2507 max_path: Arc<Path>,
2508 count: usize,
2509 visible_count: usize,
2510 file_count: usize,
2511 visible_file_count: usize,
2512}
2513
2514impl Default for EntrySummary {
2515 fn default() -> Self {
2516 Self {
2517 max_path: Arc::from(Path::new("")),
2518 count: 0,
2519 visible_count: 0,
2520 file_count: 0,
2521 visible_file_count: 0,
2522 }
2523 }
2524}
2525
2526impl sum_tree::Summary for EntrySummary {
2527 type Context = ();
2528
2529 fn add_summary(&mut self, rhs: &Self, _: &()) {
2530 self.max_path = rhs.max_path.clone();
2531 self.count += rhs.count;
2532 self.visible_count += rhs.visible_count;
2533 self.file_count += rhs.file_count;
2534 self.visible_file_count += rhs.visible_file_count;
2535 }
2536}
2537
2538#[derive(Clone, Debug)]
2539struct PathEntry {
2540 id: ProjectEntryId,
2541 path: Arc<Path>,
2542 is_ignored: bool,
2543 scan_id: usize,
2544}
2545
2546impl sum_tree::Item for PathEntry {
2547 type Summary = PathEntrySummary;
2548
2549 fn summary(&self) -> Self::Summary {
2550 PathEntrySummary { max_id: self.id }
2551 }
2552}
2553
2554impl sum_tree::KeyedItem for PathEntry {
2555 type Key = ProjectEntryId;
2556
2557 fn key(&self) -> Self::Key {
2558 self.id
2559 }
2560}
2561
2562#[derive(Clone, Debug, Default)]
2563struct PathEntrySummary {
2564 max_id: ProjectEntryId,
2565}
2566
2567impl sum_tree::Summary for PathEntrySummary {
2568 type Context = ();
2569
2570 fn add_summary(&mut self, summary: &Self, _: &Self::Context) {
2571 self.max_id = summary.max_id;
2572 }
2573}
2574
2575impl<'a> sum_tree::Dimension<'a, PathEntrySummary> for ProjectEntryId {
2576 fn add_summary(&mut self, summary: &'a PathEntrySummary, _: &()) {
2577 *self = summary.max_id;
2578 }
2579}
2580
2581#[derive(Clone, Debug, Eq, PartialEq, Ord, PartialOrd)]
2582pub struct PathKey(Arc<Path>);
2583
2584impl Default for PathKey {
2585 fn default() -> Self {
2586 Self(Path::new("").into())
2587 }
2588}
2589
2590impl<'a> sum_tree::Dimension<'a, EntrySummary> for PathKey {
2591 fn add_summary(&mut self, summary: &'a EntrySummary, _: &()) {
2592 self.0 = summary.max_path.clone();
2593 }
2594}
2595
2596struct BackgroundScanner {
2597 state: Mutex<BackgroundScannerState>,
2598 fs: Arc<dyn Fs>,
2599 status_updates_tx: UnboundedSender<ScanState>,
2600 executor: Arc<executor::Background>,
2601 refresh_requests_rx: channel::Receiver<(Vec<PathBuf>, barrier::Sender)>,
2602 next_entry_id: Arc<AtomicUsize>,
2603 phase: BackgroundScannerPhase,
2604}
2605
2606#[derive(PartialEq)]
2607enum BackgroundScannerPhase {
2608 InitialScan,
2609 EventsReceivedDuringInitialScan,
2610 Events,
2611}
2612
2613impl BackgroundScanner {
2614 fn new(
2615 snapshot: LocalSnapshot,
2616 next_entry_id: Arc<AtomicUsize>,
2617 fs: Arc<dyn Fs>,
2618 status_updates_tx: UnboundedSender<ScanState>,
2619 executor: Arc<executor::Background>,
2620 refresh_requests_rx: channel::Receiver<(Vec<PathBuf>, barrier::Sender)>,
2621 ) -> Self {
2622 Self {
2623 fs,
2624 status_updates_tx,
2625 executor,
2626 refresh_requests_rx,
2627 next_entry_id,
2628 state: Mutex::new(BackgroundScannerState {
2629 prev_snapshot: snapshot.snapshot.clone(),
2630 snapshot,
2631 removed_entry_ids: Default::default(),
2632 changed_paths: Default::default(),
2633 }),
2634 phase: BackgroundScannerPhase::InitialScan,
2635 }
2636 }
2637
2638 async fn run(
2639 &mut self,
2640 mut events_rx: Pin<Box<dyn Send + Stream<Item = Vec<fsevent::Event>>>>,
2641 ) {
2642 use futures::FutureExt as _;
2643
2644 let (root_abs_path, root_inode) = {
2645 let snapshot = &self.state.lock().snapshot;
2646 (
2647 snapshot.abs_path.clone(),
2648 snapshot.root_entry().map(|e| e.inode),
2649 )
2650 };
2651
2652 // Populate ignores above the root.
2653 let ignore_stack;
2654 for ancestor in root_abs_path.ancestors().skip(1) {
2655 if let Ok(ignore) = build_gitignore(&ancestor.join(&*GITIGNORE), self.fs.as_ref()).await
2656 {
2657 self.state
2658 .lock()
2659 .snapshot
2660 .ignores_by_parent_abs_path
2661 .insert(ancestor.into(), (ignore.into(), false));
2662 }
2663 }
2664 {
2665 let mut state = self.state.lock();
2666 state.snapshot.scan_id += 1;
2667 ignore_stack = state
2668 .snapshot
2669 .ignore_stack_for_abs_path(&root_abs_path, true);
2670 if ignore_stack.is_all() {
2671 if let Some(mut root_entry) = state.snapshot.root_entry().cloned() {
2672 root_entry.is_ignored = true;
2673 state.insert_entry(root_entry, self.fs.as_ref());
2674 }
2675 }
2676 };
2677
2678 // Perform an initial scan of the directory.
2679 let (scan_job_tx, scan_job_rx) = channel::unbounded();
2680 smol::block_on(scan_job_tx.send(ScanJob {
2681 abs_path: root_abs_path,
2682 path: Arc::from(Path::new("")),
2683 ignore_stack,
2684 ancestor_inodes: TreeSet::from_ordered_entries(root_inode),
2685 scan_queue: scan_job_tx.clone(),
2686 }))
2687 .unwrap();
2688 drop(scan_job_tx);
2689 self.scan_dirs(true, scan_job_rx).await;
2690 {
2691 let mut state = self.state.lock();
2692 state.snapshot.completed_scan_id = state.snapshot.scan_id;
2693 }
2694 self.send_status_update(false, None);
2695
2696 // Process any any FS events that occurred while performing the initial scan.
2697 // For these events, update events cannot be as precise, because we didn't
2698 // have the previous state loaded yet.
2699 self.phase = BackgroundScannerPhase::EventsReceivedDuringInitialScan;
2700 if let Poll::Ready(Some(events)) = futures::poll!(events_rx.next()) {
2701 let mut paths = events.into_iter().map(|e| e.path).collect::<Vec<_>>();
2702 while let Poll::Ready(Some(more_events)) = futures::poll!(events_rx.next()) {
2703 paths.extend(more_events.into_iter().map(|e| e.path));
2704 }
2705 self.process_events(paths).await;
2706 }
2707
2708 // Continue processing events until the worktree is dropped.
2709 self.phase = BackgroundScannerPhase::Events;
2710 loop {
2711 select_biased! {
2712 // Process any path refresh requests from the worktree. Prioritize
2713 // these before handling changes reported by the filesystem.
2714 request = self.refresh_requests_rx.recv().fuse() => {
2715 let Ok((paths, barrier)) = request else { break };
2716 if !self.process_refresh_request(paths.clone(), barrier).await {
2717 return;
2718 }
2719 }
2720
2721 events = events_rx.next().fuse() => {
2722 let Some(events) = events else { break };
2723 let mut paths = events.into_iter().map(|e| e.path).collect::<Vec<_>>();
2724 while let Poll::Ready(Some(more_events)) = futures::poll!(events_rx.next()) {
2725 paths.extend(more_events.into_iter().map(|e| e.path));
2726 }
2727 self.process_events(paths.clone()).await;
2728 }
2729 }
2730 }
2731 }
2732
2733 async fn process_refresh_request(&self, paths: Vec<PathBuf>, barrier: barrier::Sender) -> bool {
2734 self.reload_entries_for_paths(paths, None).await;
2735 self.send_status_update(false, Some(barrier))
2736 }
2737
2738 async fn process_events(&mut self, paths: Vec<PathBuf>) {
2739 let (scan_job_tx, scan_job_rx) = channel::unbounded();
2740 let paths = self
2741 .reload_entries_for_paths(paths, Some(scan_job_tx.clone()))
2742 .await;
2743 drop(scan_job_tx);
2744 self.scan_dirs(false, scan_job_rx).await;
2745
2746 self.update_ignore_statuses().await;
2747
2748 {
2749 let mut snapshot = &mut self.state.lock().snapshot;
2750
2751 if let Some(paths) = paths {
2752 for path in paths {
2753 self.reload_repo_for_file_path(&path, &mut *snapshot, self.fs.as_ref());
2754 }
2755 }
2756
2757 let mut git_repositories = mem::take(&mut snapshot.git_repositories);
2758 git_repositories.retain(|work_directory_id, _| {
2759 snapshot
2760 .entry_for_id(*work_directory_id)
2761 .map_or(false, |entry| {
2762 snapshot.entry_for_path(entry.path.join(*DOT_GIT)).is_some()
2763 })
2764 });
2765 snapshot.git_repositories = git_repositories;
2766
2767 let mut git_repository_entries = mem::take(&mut snapshot.snapshot.repository_entries);
2768 git_repository_entries.retain(|_, entry| {
2769 snapshot
2770 .git_repositories
2771 .get(&entry.work_directory.0)
2772 .is_some()
2773 });
2774 snapshot.snapshot.repository_entries = git_repository_entries;
2775 snapshot.completed_scan_id = snapshot.scan_id;
2776 }
2777
2778 self.send_status_update(false, None);
2779 }
2780
2781 async fn scan_dirs(
2782 &self,
2783 enable_progress_updates: bool,
2784 scan_jobs_rx: channel::Receiver<ScanJob>,
2785 ) {
2786 use futures::FutureExt as _;
2787
2788 if self
2789 .status_updates_tx
2790 .unbounded_send(ScanState::Started)
2791 .is_err()
2792 {
2793 return;
2794 }
2795
2796 let progress_update_count = AtomicUsize::new(0);
2797 self.executor
2798 .scoped(|scope| {
2799 for _ in 0..self.executor.num_cpus() {
2800 scope.spawn(async {
2801 let mut last_progress_update_count = 0;
2802 let progress_update_timer = self.progress_timer(enable_progress_updates).fuse();
2803 futures::pin_mut!(progress_update_timer);
2804
2805 loop {
2806 select_biased! {
2807 // Process any path refresh requests before moving on to process
2808 // the scan queue, so that user operations are prioritized.
2809 request = self.refresh_requests_rx.recv().fuse() => {
2810 let Ok((paths, barrier)) = request else { break };
2811 if !self.process_refresh_request(paths, barrier).await {
2812 return;
2813 }
2814 }
2815
2816 // Send periodic progress updates to the worktree. Use an atomic counter
2817 // to ensure that only one of the workers sends a progress update after
2818 // the update interval elapses.
2819 _ = progress_update_timer => {
2820 match progress_update_count.compare_exchange(
2821 last_progress_update_count,
2822 last_progress_update_count + 1,
2823 SeqCst,
2824 SeqCst
2825 ) {
2826 Ok(_) => {
2827 last_progress_update_count += 1;
2828 self.send_status_update(true, None);
2829 }
2830 Err(count) => {
2831 last_progress_update_count = count;
2832 }
2833 }
2834 progress_update_timer.set(self.progress_timer(enable_progress_updates).fuse());
2835 }
2836
2837 // Recursively load directories from the file system.
2838 job = scan_jobs_rx.recv().fuse() => {
2839 let Ok(job) = job else { break };
2840 if let Err(err) = self.scan_dir(&job).await {
2841 if job.path.as_ref() != Path::new("") {
2842 log::error!("error scanning directory {:?}: {}", job.abs_path, err);
2843 }
2844 }
2845 }
2846 }
2847 }
2848 })
2849 }
2850 })
2851 .await;
2852 }
2853
2854 fn send_status_update(&self, scanning: bool, barrier: Option<barrier::Sender>) -> bool {
2855 let mut state = self.state.lock();
2856 if state.changed_paths.is_empty() && scanning {
2857 return true;
2858 }
2859
2860 let new_snapshot = state.snapshot.clone();
2861 let old_snapshot = mem::replace(&mut state.prev_snapshot, new_snapshot.snapshot.clone());
2862 let changes = self.build_change_set(&old_snapshot, &new_snapshot, &state.changed_paths);
2863 state.changed_paths.clear();
2864
2865 self.status_updates_tx
2866 .unbounded_send(ScanState::Updated {
2867 snapshot: new_snapshot,
2868 changes,
2869 scanning,
2870 barrier,
2871 })
2872 .is_ok()
2873 }
2874
2875 async fn scan_dir(&self, job: &ScanJob) -> Result<()> {
2876 let mut new_entries: Vec<Entry> = Vec::new();
2877 let mut new_jobs: Vec<Option<ScanJob>> = Vec::new();
2878 let mut ignore_stack = job.ignore_stack.clone();
2879 let mut new_ignore = None;
2880 let (root_abs_path, root_char_bag, next_entry_id) = {
2881 let snapshot = &self.state.lock().snapshot;
2882 (
2883 snapshot.abs_path().clone(),
2884 snapshot.root_char_bag,
2885 self.next_entry_id.clone(),
2886 )
2887 };
2888 let mut child_paths = self.fs.read_dir(&job.abs_path).await?;
2889 while let Some(child_abs_path) = child_paths.next().await {
2890 let child_abs_path: Arc<Path> = match child_abs_path {
2891 Ok(child_abs_path) => child_abs_path.into(),
2892 Err(error) => {
2893 log::error!("error processing entry {:?}", error);
2894 continue;
2895 }
2896 };
2897
2898 let child_name = child_abs_path.file_name().unwrap();
2899 let child_path: Arc<Path> = job.path.join(child_name).into();
2900 let child_metadata = match self.fs.metadata(&child_abs_path).await {
2901 Ok(Some(metadata)) => metadata,
2902 Ok(None) => continue,
2903 Err(err) => {
2904 log::error!("error processing {:?}: {:?}", child_abs_path, err);
2905 continue;
2906 }
2907 };
2908
2909 // If we find a .gitignore, add it to the stack of ignores used to determine which paths are ignored
2910 if child_name == *GITIGNORE {
2911 match build_gitignore(&child_abs_path, self.fs.as_ref()).await {
2912 Ok(ignore) => {
2913 let ignore = Arc::new(ignore);
2914 ignore_stack = ignore_stack.append(job.abs_path.clone(), ignore.clone());
2915 new_ignore = Some(ignore);
2916 }
2917 Err(error) => {
2918 log::error!(
2919 "error loading .gitignore file {:?} - {:?}",
2920 child_name,
2921 error
2922 );
2923 }
2924 }
2925
2926 // Update ignore status of any child entries we've already processed to reflect the
2927 // ignore file in the current directory. Because `.gitignore` starts with a `.`,
2928 // there should rarely be too numerous. Update the ignore stack associated with any
2929 // new jobs as well.
2930 let mut new_jobs = new_jobs.iter_mut();
2931 for entry in &mut new_entries {
2932 let entry_abs_path = root_abs_path.join(&entry.path);
2933 entry.is_ignored =
2934 ignore_stack.is_abs_path_ignored(&entry_abs_path, entry.is_dir());
2935
2936 if entry.is_dir() {
2937 if let Some(job) = new_jobs.next().expect("Missing scan job for entry") {
2938 job.ignore_stack = if entry.is_ignored {
2939 IgnoreStack::all()
2940 } else {
2941 ignore_stack.clone()
2942 };
2943 }
2944 }
2945 }
2946 }
2947
2948 let mut child_entry = Entry::new(
2949 child_path.clone(),
2950 &child_metadata,
2951 &next_entry_id,
2952 root_char_bag,
2953 );
2954
2955 if child_entry.is_dir() {
2956 let is_ignored = ignore_stack.is_abs_path_ignored(&child_abs_path, true);
2957 child_entry.is_ignored = is_ignored;
2958
2959 // Avoid recursing until crash in the case of a recursive symlink
2960 if !job.ancestor_inodes.contains(&child_entry.inode) {
2961 let mut ancestor_inodes = job.ancestor_inodes.clone();
2962 ancestor_inodes.insert(child_entry.inode);
2963
2964 new_jobs.push(Some(ScanJob {
2965 abs_path: child_abs_path,
2966 path: child_path,
2967 ignore_stack: if is_ignored {
2968 IgnoreStack::all()
2969 } else {
2970 ignore_stack.clone()
2971 },
2972 ancestor_inodes,
2973 scan_queue: job.scan_queue.clone(),
2974 }));
2975 } else {
2976 new_jobs.push(None);
2977 }
2978 } else {
2979 child_entry.is_ignored = ignore_stack.is_abs_path_ignored(&child_abs_path, false);
2980 }
2981
2982 new_entries.push(child_entry);
2983 }
2984
2985 {
2986 let mut state = self.state.lock();
2987 state.populate_dir(job.path.clone(), new_entries, new_ignore, self.fs.as_ref());
2988 if let Err(ix) = state.changed_paths.binary_search(&job.path) {
2989 state.changed_paths.insert(ix, job.path.clone());
2990 }
2991 }
2992
2993 for new_job in new_jobs {
2994 if let Some(new_job) = new_job {
2995 job.scan_queue.send(new_job).await.unwrap();
2996 }
2997 }
2998
2999 Ok(())
3000 }
3001
3002 async fn reload_entries_for_paths(
3003 &self,
3004 mut abs_paths: Vec<PathBuf>,
3005 scan_queue_tx: Option<Sender<ScanJob>>,
3006 ) -> Option<Vec<Arc<Path>>> {
3007 let doing_recursive_update = scan_queue_tx.is_some();
3008
3009 abs_paths.sort_unstable();
3010 abs_paths.dedup_by(|a, b| a.starts_with(&b));
3011
3012 let root_abs_path = self.state.lock().snapshot.abs_path.clone();
3013 let root_canonical_path = self.fs.canonicalize(&root_abs_path).await.log_err()?;
3014 let metadata = futures::future::join_all(
3015 abs_paths
3016 .iter()
3017 .map(|abs_path| self.fs.metadata(&abs_path))
3018 .collect::<Vec<_>>(),
3019 )
3020 .await;
3021
3022 let mut state = self.state.lock();
3023 let snapshot = &mut state.snapshot;
3024 let is_idle = snapshot.completed_scan_id == snapshot.scan_id;
3025 snapshot.scan_id += 1;
3026 if is_idle && !doing_recursive_update {
3027 snapshot.completed_scan_id = snapshot.scan_id;
3028 }
3029
3030 // Remove any entries for paths that no longer exist or are being recursively
3031 // refreshed. Do this before adding any new entries, so that renames can be
3032 // detected regardless of the order of the paths.
3033 let mut event_paths = Vec::<Arc<Path>>::with_capacity(abs_paths.len());
3034 for (abs_path, metadata) in abs_paths.iter().zip(metadata.iter()) {
3035 if let Ok(path) = abs_path.strip_prefix(&root_canonical_path) {
3036 if matches!(metadata, Ok(None)) || doing_recursive_update {
3037 state.remove_path(path);
3038 }
3039 event_paths.push(path.into());
3040 } else {
3041 log::error!(
3042 "unexpected event {:?} for root path {:?}",
3043 abs_path,
3044 root_canonical_path
3045 );
3046 }
3047 }
3048
3049 for (path, metadata) in event_paths.iter().cloned().zip(metadata.into_iter()) {
3050 let abs_path: Arc<Path> = root_abs_path.join(&path).into();
3051
3052 match metadata {
3053 Ok(Some(metadata)) => {
3054 let ignore_stack = state
3055 .snapshot
3056 .ignore_stack_for_abs_path(&abs_path, metadata.is_dir);
3057 let mut fs_entry = Entry::new(
3058 path.clone(),
3059 &metadata,
3060 self.next_entry_id.as_ref(),
3061 state.snapshot.root_char_bag,
3062 );
3063 fs_entry.is_ignored = ignore_stack.is_all();
3064 state.insert_entry(fs_entry, self.fs.as_ref());
3065
3066 if let Some(scan_queue_tx) = &scan_queue_tx {
3067 let mut ancestor_inodes = state.snapshot.ancestor_inodes_for_path(&path);
3068 if metadata.is_dir && !ancestor_inodes.contains(&metadata.inode) {
3069 ancestor_inodes.insert(metadata.inode);
3070 smol::block_on(scan_queue_tx.send(ScanJob {
3071 abs_path,
3072 path,
3073 ignore_stack,
3074 ancestor_inodes,
3075 scan_queue: scan_queue_tx.clone(),
3076 }))
3077 .unwrap();
3078 }
3079 }
3080 }
3081 Ok(None) => {
3082 self.remove_repo_path(&path, &mut state.snapshot);
3083 }
3084 Err(err) => {
3085 // TODO - create a special 'error' entry in the entries tree to mark this
3086 log::error!("error reading file on event {:?}", err);
3087 }
3088 }
3089 }
3090
3091 util::extend_sorted(
3092 &mut state.changed_paths,
3093 event_paths.iter().cloned(),
3094 usize::MAX,
3095 Ord::cmp,
3096 );
3097
3098 Some(event_paths)
3099 }
3100
3101 fn remove_repo_path(&self, path: &Path, snapshot: &mut LocalSnapshot) -> Option<()> {
3102 if !path
3103 .components()
3104 .any(|component| component.as_os_str() == *DOT_GIT)
3105 {
3106 if let Some(repository) = snapshot.repository_for_work_directory(path) {
3107 let entry = repository.work_directory.0;
3108 snapshot.git_repositories.remove(&entry);
3109 snapshot
3110 .snapshot
3111 .repository_entries
3112 .remove(&RepositoryWorkDirectory(path.into()));
3113 return Some(());
3114 }
3115 }
3116
3117 // TODO statuses
3118 // Track when a .git is removed and iterate over the file system there
3119
3120 Some(())
3121 }
3122
3123 fn reload_repo_for_file_path(
3124 &self,
3125 path: &Path,
3126 snapshot: &mut LocalSnapshot,
3127 fs: &dyn Fs,
3128 ) -> Option<()> {
3129 let scan_id = snapshot.scan_id;
3130
3131 if path
3132 .components()
3133 .any(|component| component.as_os_str() == *DOT_GIT)
3134 {
3135 let (entry_id, repo_ptr) = {
3136 let Some((entry_id, repo)) = snapshot.repo_for_metadata(&path) else {
3137 let dot_git_dir = path.ancestors()
3138 .skip_while(|ancestor| ancestor.file_name() != Some(&*DOT_GIT))
3139 .next()?;
3140
3141 snapshot.build_repo(dot_git_dir.into(), fs);
3142 return None;
3143 };
3144 if repo.git_dir_scan_id == scan_id {
3145 return None;
3146 }
3147
3148 (*entry_id, repo.repo_ptr.to_owned())
3149 };
3150 /*
3151 1. Populate dir, initializes the git repo
3152 2. Sometimes, we get a file event inside the .git repo, before it's initializaed
3153 In both cases, we should end up with an initialized repo and a full status scan
3154
3155 */
3156
3157 let work_dir = snapshot
3158 .entry_for_id(entry_id)
3159 .map(|entry| RepositoryWorkDirectory(entry.path.clone()))?;
3160
3161 let repo = repo_ptr.lock();
3162 repo.reload_index();
3163 let branch = repo.branch_name();
3164
3165 snapshot.git_repositories.update(&entry_id, |entry| {
3166 entry.git_dir_scan_id = scan_id;
3167 });
3168
3169 snapshot
3170 .snapshot
3171 .repository_entries
3172 .update(&work_dir, |entry| {
3173 entry.branch = branch.map(Into::into);
3174 });
3175
3176 snapshot.scan_statuses(repo.deref(), &work_dir);
3177 } else {
3178 if snapshot
3179 .entry_for_path(&path)
3180 .map(|entry| entry.is_ignored)
3181 .unwrap_or(false)
3182 {
3183 return None;
3184 }
3185
3186 let repo = snapshot.repository_for_path(&path)?;
3187
3188 let work_dir_id = repo.work_directory.clone();
3189 let (local_repo, git_dir_scan_id) =
3190 snapshot.git_repositories.update(&work_dir_id, |entry| {
3191 (entry.repo_ptr.clone(), entry.git_dir_scan_id)
3192 })?;
3193
3194 // Short circuit if we've already scanned everything
3195 if git_dir_scan_id == scan_id {
3196 return None;
3197 }
3198
3199 let mut edits = vec![];
3200
3201 for path in snapshot
3202 .descendent_entries(false, false, path)
3203 .map(|entry| &entry.path)
3204 {
3205 let Some(repo_path) = repo.work_directory.relativize(snapshot, &path) else {
3206 continue;
3207 };
3208
3209 let Some(status) = local_repo.lock().status(&repo_path) else {
3210 continue;
3211 };
3212
3213 snapshot.set_git_status(&path, Some(status), &mut edits);
3214 }
3215
3216 snapshot.entries_by_path.edit(edits, &());
3217 }
3218
3219 Some(())
3220 }
3221
3222 async fn update_ignore_statuses(&self) {
3223 use futures::FutureExt as _;
3224
3225 let mut snapshot = self.state.lock().snapshot.clone();
3226 let mut ignores_to_update = Vec::new();
3227 let mut ignores_to_delete = Vec::new();
3228 let abs_path = snapshot.abs_path.clone();
3229 for (parent_abs_path, (_, needs_update)) in &mut snapshot.ignores_by_parent_abs_path {
3230 if let Ok(parent_path) = parent_abs_path.strip_prefix(&abs_path) {
3231 if *needs_update {
3232 *needs_update = false;
3233 if snapshot.snapshot.entry_for_path(parent_path).is_some() {
3234 ignores_to_update.push(parent_abs_path.clone());
3235 }
3236 }
3237
3238 let ignore_path = parent_path.join(&*GITIGNORE);
3239 if snapshot.snapshot.entry_for_path(ignore_path).is_none() {
3240 ignores_to_delete.push(parent_abs_path.clone());
3241 }
3242 }
3243 }
3244
3245 for parent_abs_path in ignores_to_delete {
3246 snapshot.ignores_by_parent_abs_path.remove(&parent_abs_path);
3247 self.state
3248 .lock()
3249 .snapshot
3250 .ignores_by_parent_abs_path
3251 .remove(&parent_abs_path);
3252 }
3253
3254 let (ignore_queue_tx, ignore_queue_rx) = channel::unbounded();
3255 ignores_to_update.sort_unstable();
3256 let mut ignores_to_update = ignores_to_update.into_iter().peekable();
3257 while let Some(parent_abs_path) = ignores_to_update.next() {
3258 while ignores_to_update
3259 .peek()
3260 .map_or(false, |p| p.starts_with(&parent_abs_path))
3261 {
3262 ignores_to_update.next().unwrap();
3263 }
3264
3265 let ignore_stack = snapshot.ignore_stack_for_abs_path(&parent_abs_path, true);
3266 smol::block_on(ignore_queue_tx.send(UpdateIgnoreStatusJob {
3267 abs_path: parent_abs_path,
3268 ignore_stack,
3269 ignore_queue: ignore_queue_tx.clone(),
3270 }))
3271 .unwrap();
3272 }
3273 drop(ignore_queue_tx);
3274
3275 self.executor
3276 .scoped(|scope| {
3277 for _ in 0..self.executor.num_cpus() {
3278 scope.spawn(async {
3279 loop {
3280 select_biased! {
3281 // Process any path refresh requests before moving on to process
3282 // the queue of ignore statuses.
3283 request = self.refresh_requests_rx.recv().fuse() => {
3284 let Ok((paths, barrier)) = request else { break };
3285 if !self.process_refresh_request(paths, barrier).await {
3286 return;
3287 }
3288 }
3289
3290 // Recursively process directories whose ignores have changed.
3291 job = ignore_queue_rx.recv().fuse() => {
3292 let Ok(job) = job else { break };
3293 self.update_ignore_status(job, &snapshot).await;
3294 }
3295 }
3296 }
3297 });
3298 }
3299 })
3300 .await;
3301 }
3302
3303 async fn update_ignore_status(&self, job: UpdateIgnoreStatusJob, snapshot: &LocalSnapshot) {
3304 let mut ignore_stack = job.ignore_stack;
3305 if let Some((ignore, _)) = snapshot.ignores_by_parent_abs_path.get(&job.abs_path) {
3306 ignore_stack = ignore_stack.append(job.abs_path.clone(), ignore.clone());
3307 }
3308
3309 let mut entries_by_id_edits = Vec::new();
3310 let mut entries_by_path_edits = Vec::new();
3311 let path = job.abs_path.strip_prefix(&snapshot.abs_path).unwrap();
3312 for mut entry in snapshot.child_entries(path).cloned() {
3313 let was_ignored = entry.is_ignored;
3314 let abs_path = snapshot.abs_path().join(&entry.path);
3315 entry.is_ignored = ignore_stack.is_abs_path_ignored(&abs_path, entry.is_dir());
3316 if entry.is_dir() {
3317 let child_ignore_stack = if entry.is_ignored {
3318 IgnoreStack::all()
3319 } else {
3320 ignore_stack.clone()
3321 };
3322 job.ignore_queue
3323 .send(UpdateIgnoreStatusJob {
3324 abs_path: abs_path.into(),
3325 ignore_stack: child_ignore_stack,
3326 ignore_queue: job.ignore_queue.clone(),
3327 })
3328 .await
3329 .unwrap();
3330 }
3331
3332 if entry.is_ignored != was_ignored {
3333 let mut path_entry = snapshot.entries_by_id.get(&entry.id, &()).unwrap().clone();
3334 path_entry.scan_id = snapshot.scan_id;
3335 path_entry.is_ignored = entry.is_ignored;
3336 entries_by_id_edits.push(Edit::Insert(path_entry));
3337 entries_by_path_edits.push(Edit::Insert(entry));
3338 }
3339 }
3340
3341 let state = &mut self.state.lock();
3342 for edit in &entries_by_path_edits {
3343 if let Edit::Insert(entry) = edit {
3344 if let Err(ix) = state.changed_paths.binary_search(&entry.path) {
3345 state.changed_paths.insert(ix, entry.path.clone());
3346 }
3347 }
3348 }
3349
3350 state
3351 .snapshot
3352 .entries_by_path
3353 .edit(entries_by_path_edits, &());
3354 state.snapshot.entries_by_id.edit(entries_by_id_edits, &());
3355 }
3356
3357 fn build_change_set(
3358 &self,
3359 old_snapshot: &Snapshot,
3360 new_snapshot: &Snapshot,
3361 event_paths: &[Arc<Path>],
3362 ) -> UpdatedEntriesSet {
3363 use BackgroundScannerPhase::*;
3364 use PathChange::{Added, AddedOrUpdated, Loaded, Removed, Updated};
3365
3366 // Identify which paths have changed. Use the known set of changed
3367 // parent paths to optimize the search.
3368 let mut changes = Vec::new();
3369 let mut old_paths = old_snapshot.entries_by_path.cursor::<PathKey>();
3370 let mut new_paths = new_snapshot.entries_by_path.cursor::<PathKey>();
3371 old_paths.next(&());
3372 new_paths.next(&());
3373 for path in event_paths {
3374 let path = PathKey(path.clone());
3375 if old_paths.item().map_or(false, |e| e.path < path.0) {
3376 old_paths.seek_forward(&path, Bias::Left, &());
3377 }
3378 if new_paths.item().map_or(false, |e| e.path < path.0) {
3379 new_paths.seek_forward(&path, Bias::Left, &());
3380 }
3381
3382 loop {
3383 match (old_paths.item(), new_paths.item()) {
3384 (Some(old_entry), Some(new_entry)) => {
3385 if old_entry.path > path.0
3386 && new_entry.path > path.0
3387 && !old_entry.path.starts_with(&path.0)
3388 && !new_entry.path.starts_with(&path.0)
3389 {
3390 break;
3391 }
3392
3393 match Ord::cmp(&old_entry.path, &new_entry.path) {
3394 Ordering::Less => {
3395 changes.push((old_entry.path.clone(), old_entry.id, Removed));
3396 old_paths.next(&());
3397 }
3398 Ordering::Equal => {
3399 if self.phase == EventsReceivedDuringInitialScan {
3400 // If the worktree was not fully initialized when this event was generated,
3401 // we can't know whether this entry was added during the scan or whether
3402 // it was merely updated.
3403 changes.push((
3404 new_entry.path.clone(),
3405 new_entry.id,
3406 AddedOrUpdated,
3407 ));
3408 } else if old_entry.id != new_entry.id {
3409 changes.push((old_entry.path.clone(), old_entry.id, Removed));
3410 changes.push((new_entry.path.clone(), new_entry.id, Added));
3411 } else if old_entry != new_entry {
3412 changes.push((new_entry.path.clone(), new_entry.id, Updated));
3413 }
3414 old_paths.next(&());
3415 new_paths.next(&());
3416 }
3417 Ordering::Greater => {
3418 changes.push((
3419 new_entry.path.clone(),
3420 new_entry.id,
3421 if self.phase == InitialScan {
3422 Loaded
3423 } else {
3424 Added
3425 },
3426 ));
3427 new_paths.next(&());
3428 }
3429 }
3430 }
3431 (Some(old_entry), None) => {
3432 changes.push((old_entry.path.clone(), old_entry.id, Removed));
3433 old_paths.next(&());
3434 }
3435 (None, Some(new_entry)) => {
3436 changes.push((
3437 new_entry.path.clone(),
3438 new_entry.id,
3439 if self.phase == InitialScan {
3440 Loaded
3441 } else {
3442 Added
3443 },
3444 ));
3445 new_paths.next(&());
3446 }
3447 (None, None) => break,
3448 }
3449 }
3450 }
3451
3452 changes.into()
3453 }
3454
3455 async fn progress_timer(&self, running: bool) {
3456 if !running {
3457 return futures::future::pending().await;
3458 }
3459
3460 #[cfg(any(test, feature = "test-support"))]
3461 if self.fs.is_fake() {
3462 return self.executor.simulate_random_delay().await;
3463 }
3464
3465 smol::Timer::after(Duration::from_millis(100)).await;
3466 }
3467}
3468
3469fn char_bag_for_path(root_char_bag: CharBag, path: &Path) -> CharBag {
3470 let mut result = root_char_bag;
3471 result.extend(
3472 path.to_string_lossy()
3473 .chars()
3474 .map(|c| c.to_ascii_lowercase()),
3475 );
3476 result
3477}
3478
3479struct ScanJob {
3480 abs_path: Arc<Path>,
3481 path: Arc<Path>,
3482 ignore_stack: Arc<IgnoreStack>,
3483 scan_queue: Sender<ScanJob>,
3484 ancestor_inodes: TreeSet<u64>,
3485}
3486
3487struct UpdateIgnoreStatusJob {
3488 abs_path: Arc<Path>,
3489 ignore_stack: Arc<IgnoreStack>,
3490 ignore_queue: Sender<UpdateIgnoreStatusJob>,
3491}
3492
3493pub trait WorktreeHandle {
3494 #[cfg(any(test, feature = "test-support"))]
3495 fn flush_fs_events<'a>(
3496 &self,
3497 cx: &'a gpui::TestAppContext,
3498 ) -> futures::future::LocalBoxFuture<'a, ()>;
3499}
3500
3501impl WorktreeHandle for ModelHandle<Worktree> {
3502 // When the worktree's FS event stream sometimes delivers "redundant" events for FS changes that
3503 // occurred before the worktree was constructed. These events can cause the worktree to perfrom
3504 // extra directory scans, and emit extra scan-state notifications.
3505 //
3506 // This function mutates the worktree's directory and waits for those mutations to be picked up,
3507 // to ensure that all redundant FS events have already been processed.
3508 #[cfg(any(test, feature = "test-support"))]
3509 fn flush_fs_events<'a>(
3510 &self,
3511 cx: &'a gpui::TestAppContext,
3512 ) -> futures::future::LocalBoxFuture<'a, ()> {
3513 let filename = "fs-event-sentinel";
3514 let tree = self.clone();
3515 let (fs, root_path) = self.read_with(cx, |tree, _| {
3516 let tree = tree.as_local().unwrap();
3517 (tree.fs.clone(), tree.abs_path().clone())
3518 });
3519
3520 async move {
3521 fs.create_file(&root_path.join(filename), Default::default())
3522 .await
3523 .unwrap();
3524 tree.condition(cx, |tree, _| tree.entry_for_path(filename).is_some())
3525 .await;
3526
3527 fs.remove_file(&root_path.join(filename), Default::default())
3528 .await
3529 .unwrap();
3530 tree.condition(cx, |tree, _| tree.entry_for_path(filename).is_none())
3531 .await;
3532
3533 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
3534 .await;
3535 }
3536 .boxed_local()
3537 }
3538}
3539
3540#[derive(Clone, Debug)]
3541struct TraversalProgress<'a> {
3542 max_path: &'a Path,
3543 count: usize,
3544 visible_count: usize,
3545 file_count: usize,
3546 visible_file_count: usize,
3547}
3548
3549impl<'a> TraversalProgress<'a> {
3550 fn count(&self, include_dirs: bool, include_ignored: bool) -> usize {
3551 match (include_ignored, include_dirs) {
3552 (true, true) => self.count,
3553 (true, false) => self.file_count,
3554 (false, true) => self.visible_count,
3555 (false, false) => self.visible_file_count,
3556 }
3557 }
3558}
3559
3560impl<'a> sum_tree::Dimension<'a, EntrySummary> for TraversalProgress<'a> {
3561 fn add_summary(&mut self, summary: &'a EntrySummary, _: &()) {
3562 self.max_path = summary.max_path.as_ref();
3563 self.count += summary.count;
3564 self.visible_count += summary.visible_count;
3565 self.file_count += summary.file_count;
3566 self.visible_file_count += summary.visible_file_count;
3567 }
3568}
3569
3570impl<'a> Default for TraversalProgress<'a> {
3571 fn default() -> Self {
3572 Self {
3573 max_path: Path::new(""),
3574 count: 0,
3575 visible_count: 0,
3576 file_count: 0,
3577 visible_file_count: 0,
3578 }
3579 }
3580}
3581
3582pub struct Traversal<'a> {
3583 cursor: sum_tree::Cursor<'a, Entry, TraversalProgress<'a>>,
3584 include_ignored: bool,
3585 include_dirs: bool,
3586}
3587
3588impl<'a> Traversal<'a> {
3589 pub fn advance(&mut self) -> bool {
3590 self.cursor.seek_forward(
3591 &TraversalTarget::Count {
3592 count: self.end_offset() + 1,
3593 include_dirs: self.include_dirs,
3594 include_ignored: self.include_ignored,
3595 },
3596 Bias::Left,
3597 &(),
3598 )
3599 }
3600
3601 pub fn advance_to_sibling(&mut self) -> bool {
3602 while let Some(entry) = self.cursor.item() {
3603 self.cursor.seek_forward(
3604 &TraversalTarget::PathSuccessor(&entry.path),
3605 Bias::Left,
3606 &(),
3607 );
3608 if let Some(entry) = self.cursor.item() {
3609 if (self.include_dirs || !entry.is_dir())
3610 && (self.include_ignored || !entry.is_ignored)
3611 {
3612 return true;
3613 }
3614 }
3615 }
3616 false
3617 }
3618
3619 pub fn entry(&self) -> Option<&'a Entry> {
3620 self.cursor.item()
3621 }
3622
3623 pub fn start_offset(&self) -> usize {
3624 self.cursor
3625 .start()
3626 .count(self.include_dirs, self.include_ignored)
3627 }
3628
3629 pub fn end_offset(&self) -> usize {
3630 self.cursor
3631 .end(&())
3632 .count(self.include_dirs, self.include_ignored)
3633 }
3634}
3635
3636impl<'a> Iterator for Traversal<'a> {
3637 type Item = &'a Entry;
3638
3639 fn next(&mut self) -> Option<Self::Item> {
3640 if let Some(item) = self.entry() {
3641 self.advance();
3642 Some(item)
3643 } else {
3644 None
3645 }
3646 }
3647}
3648
3649#[derive(Debug)]
3650enum TraversalTarget<'a> {
3651 Path(&'a Path),
3652 PathSuccessor(&'a Path),
3653 Count {
3654 count: usize,
3655 include_ignored: bool,
3656 include_dirs: bool,
3657 },
3658}
3659
3660impl<'a, 'b> SeekTarget<'a, EntrySummary, TraversalProgress<'a>> for TraversalTarget<'b> {
3661 fn cmp(&self, cursor_location: &TraversalProgress<'a>, _: &()) -> Ordering {
3662 match self {
3663 TraversalTarget::Path(path) => path.cmp(&cursor_location.max_path),
3664 TraversalTarget::PathSuccessor(path) => {
3665 if !cursor_location.max_path.starts_with(path) {
3666 Ordering::Equal
3667 } else {
3668 Ordering::Greater
3669 }
3670 }
3671 TraversalTarget::Count {
3672 count,
3673 include_dirs,
3674 include_ignored,
3675 } => Ord::cmp(
3676 count,
3677 &cursor_location.count(*include_dirs, *include_ignored),
3678 ),
3679 }
3680 }
3681}
3682
3683struct ChildEntriesIter<'a> {
3684 parent_path: &'a Path,
3685 traversal: Traversal<'a>,
3686}
3687
3688impl<'a> Iterator for ChildEntriesIter<'a> {
3689 type Item = &'a Entry;
3690
3691 fn next(&mut self) -> Option<Self::Item> {
3692 if let Some(item) = self.traversal.entry() {
3693 if item.path.starts_with(&self.parent_path) {
3694 self.traversal.advance_to_sibling();
3695 return Some(item);
3696 }
3697 }
3698 None
3699 }
3700}
3701
3702struct DescendentEntriesIter<'a> {
3703 parent_path: &'a Path,
3704 traversal: Traversal<'a>,
3705}
3706
3707impl<'a> Iterator for DescendentEntriesIter<'a> {
3708 type Item = &'a Entry;
3709
3710 fn next(&mut self) -> Option<Self::Item> {
3711 if let Some(item) = self.traversal.entry() {
3712 if item.path.starts_with(&self.parent_path) {
3713 self.traversal.advance();
3714 return Some(item);
3715 }
3716 }
3717 None
3718 }
3719}
3720
3721impl<'a> From<&'a Entry> for proto::Entry {
3722 fn from(entry: &'a Entry) -> Self {
3723 Self {
3724 id: entry.id.to_proto(),
3725 is_dir: entry.is_dir(),
3726 path: entry.path.to_string_lossy().into(),
3727 inode: entry.inode,
3728 mtime: Some(entry.mtime.into()),
3729 is_symlink: entry.is_symlink,
3730 is_ignored: entry.is_ignored,
3731 git_status: entry.git_status.map(|status| status.to_proto()),
3732 }
3733 }
3734}
3735
3736impl<'a> TryFrom<(&'a CharBag, proto::Entry)> for Entry {
3737 type Error = anyhow::Error;
3738
3739 fn try_from((root_char_bag, entry): (&'a CharBag, proto::Entry)) -> Result<Self> {
3740 if let Some(mtime) = entry.mtime {
3741 let kind = if entry.is_dir {
3742 EntryKind::Dir
3743 } else {
3744 let mut char_bag = *root_char_bag;
3745 char_bag.extend(entry.path.chars().map(|c| c.to_ascii_lowercase()));
3746 EntryKind::File(char_bag)
3747 };
3748 let path: Arc<Path> = PathBuf::from(entry.path).into();
3749 Ok(Entry {
3750 id: ProjectEntryId::from_proto(entry.id),
3751 kind,
3752 path,
3753 inode: entry.inode,
3754 mtime: mtime.into(),
3755 is_symlink: entry.is_symlink,
3756 is_ignored: entry.is_ignored,
3757 git_status: GitFileStatus::from_proto(entry.git_status),
3758 })
3759 } else {
3760 Err(anyhow!(
3761 "missing mtime in remote worktree entry {:?}",
3762 entry.path
3763 ))
3764 }
3765 }
3766}
3767
3768#[cfg(test)]
3769mod tests {
3770 use super::*;
3771 use fs::{FakeFs, RealFs};
3772 use gpui::{executor::Deterministic, TestAppContext};
3773 use pretty_assertions::assert_eq;
3774 use rand::prelude::*;
3775 use serde_json::json;
3776 use std::{env, fmt::Write};
3777 use util::{http::FakeHttpClient, test::temp_tree};
3778
3779 #[gpui::test]
3780 async fn test_traversal(cx: &mut TestAppContext) {
3781 let fs = FakeFs::new(cx.background());
3782 fs.insert_tree(
3783 "/root",
3784 json!({
3785 ".gitignore": "a/b\n",
3786 "a": {
3787 "b": "",
3788 "c": "",
3789 }
3790 }),
3791 )
3792 .await;
3793
3794 let http_client = FakeHttpClient::with_404_response();
3795 let client = cx.read(|cx| Client::new(http_client, cx));
3796
3797 let tree = Worktree::local(
3798 client,
3799 Path::new("/root"),
3800 true,
3801 fs,
3802 Default::default(),
3803 &mut cx.to_async(),
3804 )
3805 .await
3806 .unwrap();
3807 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
3808 .await;
3809
3810 tree.read_with(cx, |tree, _| {
3811 assert_eq!(
3812 tree.entries(false)
3813 .map(|entry| entry.path.as_ref())
3814 .collect::<Vec<_>>(),
3815 vec![
3816 Path::new(""),
3817 Path::new(".gitignore"),
3818 Path::new("a"),
3819 Path::new("a/c"),
3820 ]
3821 );
3822 assert_eq!(
3823 tree.entries(true)
3824 .map(|entry| entry.path.as_ref())
3825 .collect::<Vec<_>>(),
3826 vec![
3827 Path::new(""),
3828 Path::new(".gitignore"),
3829 Path::new("a"),
3830 Path::new("a/b"),
3831 Path::new("a/c"),
3832 ]
3833 );
3834 })
3835 }
3836
3837 #[gpui::test]
3838 async fn test_descendent_entries(cx: &mut TestAppContext) {
3839 let fs = FakeFs::new(cx.background());
3840 fs.insert_tree(
3841 "/root",
3842 json!({
3843 "a": "",
3844 "b": {
3845 "c": {
3846 "d": ""
3847 },
3848 "e": {}
3849 },
3850 "f": "",
3851 "g": {
3852 "h": {}
3853 },
3854 "i": {
3855 "j": {
3856 "k": ""
3857 },
3858 "l": {
3859
3860 }
3861 },
3862 ".gitignore": "i/j\n",
3863 }),
3864 )
3865 .await;
3866
3867 let http_client = FakeHttpClient::with_404_response();
3868 let client = cx.read(|cx| Client::new(http_client, cx));
3869
3870 let tree = Worktree::local(
3871 client,
3872 Path::new("/root"),
3873 true,
3874 fs,
3875 Default::default(),
3876 &mut cx.to_async(),
3877 )
3878 .await
3879 .unwrap();
3880 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
3881 .await;
3882
3883 tree.read_with(cx, |tree, _| {
3884 assert_eq!(
3885 tree.descendent_entries(false, false, Path::new("b"))
3886 .map(|entry| entry.path.as_ref())
3887 .collect::<Vec<_>>(),
3888 vec![Path::new("b/c/d"),]
3889 );
3890 assert_eq!(
3891 tree.descendent_entries(true, false, Path::new("b"))
3892 .map(|entry| entry.path.as_ref())
3893 .collect::<Vec<_>>(),
3894 vec![
3895 Path::new("b"),
3896 Path::new("b/c"),
3897 Path::new("b/c/d"),
3898 Path::new("b/e"),
3899 ]
3900 );
3901
3902 assert_eq!(
3903 tree.descendent_entries(false, false, Path::new("g"))
3904 .map(|entry| entry.path.as_ref())
3905 .collect::<Vec<_>>(),
3906 Vec::<PathBuf>::new()
3907 );
3908 assert_eq!(
3909 tree.descendent_entries(true, false, Path::new("g"))
3910 .map(|entry| entry.path.as_ref())
3911 .collect::<Vec<_>>(),
3912 vec![Path::new("g"), Path::new("g/h"),]
3913 );
3914
3915 assert_eq!(
3916 tree.descendent_entries(false, false, Path::new("i"))
3917 .map(|entry| entry.path.as_ref())
3918 .collect::<Vec<_>>(),
3919 Vec::<PathBuf>::new()
3920 );
3921 assert_eq!(
3922 tree.descendent_entries(false, true, Path::new("i"))
3923 .map(|entry| entry.path.as_ref())
3924 .collect::<Vec<_>>(),
3925 vec![Path::new("i/j/k")]
3926 );
3927 assert_eq!(
3928 tree.descendent_entries(true, false, Path::new("i"))
3929 .map(|entry| entry.path.as_ref())
3930 .collect::<Vec<_>>(),
3931 vec![Path::new("i"), Path::new("i/l"),]
3932 );
3933 })
3934 }
3935
3936 #[gpui::test(iterations = 10)]
3937 async fn test_circular_symlinks(executor: Arc<Deterministic>, cx: &mut TestAppContext) {
3938 let fs = FakeFs::new(cx.background());
3939 fs.insert_tree(
3940 "/root",
3941 json!({
3942 "lib": {
3943 "a": {
3944 "a.txt": ""
3945 },
3946 "b": {
3947 "b.txt": ""
3948 }
3949 }
3950 }),
3951 )
3952 .await;
3953 fs.insert_symlink("/root/lib/a/lib", "..".into()).await;
3954 fs.insert_symlink("/root/lib/b/lib", "..".into()).await;
3955
3956 let client = cx.read(|cx| Client::new(FakeHttpClient::with_404_response(), cx));
3957 let tree = Worktree::local(
3958 client,
3959 Path::new("/root"),
3960 true,
3961 fs.clone(),
3962 Default::default(),
3963 &mut cx.to_async(),
3964 )
3965 .await
3966 .unwrap();
3967
3968 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
3969 .await;
3970
3971 tree.read_with(cx, |tree, _| {
3972 assert_eq!(
3973 tree.entries(false)
3974 .map(|entry| entry.path.as_ref())
3975 .collect::<Vec<_>>(),
3976 vec![
3977 Path::new(""),
3978 Path::new("lib"),
3979 Path::new("lib/a"),
3980 Path::new("lib/a/a.txt"),
3981 Path::new("lib/a/lib"),
3982 Path::new("lib/b"),
3983 Path::new("lib/b/b.txt"),
3984 Path::new("lib/b/lib"),
3985 ]
3986 );
3987 });
3988
3989 fs.rename(
3990 Path::new("/root/lib/a/lib"),
3991 Path::new("/root/lib/a/lib-2"),
3992 Default::default(),
3993 )
3994 .await
3995 .unwrap();
3996 executor.run_until_parked();
3997 tree.read_with(cx, |tree, _| {
3998 assert_eq!(
3999 tree.entries(false)
4000 .map(|entry| entry.path.as_ref())
4001 .collect::<Vec<_>>(),
4002 vec![
4003 Path::new(""),
4004 Path::new("lib"),
4005 Path::new("lib/a"),
4006 Path::new("lib/a/a.txt"),
4007 Path::new("lib/a/lib-2"),
4008 Path::new("lib/b"),
4009 Path::new("lib/b/b.txt"),
4010 Path::new("lib/b/lib"),
4011 ]
4012 );
4013 });
4014 }
4015
4016 #[gpui::test]
4017 async fn test_rescan_with_gitignore(cx: &mut TestAppContext) {
4018 // .gitignores are handled explicitly by Zed and do not use the git
4019 // machinery that the git_tests module checks
4020 let parent_dir = temp_tree(json!({
4021 ".gitignore": "ancestor-ignored-file1\nancestor-ignored-file2\n",
4022 "tree": {
4023 ".git": {},
4024 ".gitignore": "ignored-dir\n",
4025 "tracked-dir": {
4026 "tracked-file1": "",
4027 "ancestor-ignored-file1": "",
4028 },
4029 "ignored-dir": {
4030 "ignored-file1": ""
4031 }
4032 }
4033 }));
4034 let dir = parent_dir.path().join("tree");
4035
4036 let client = cx.read(|cx| Client::new(FakeHttpClient::with_404_response(), cx));
4037
4038 let tree = Worktree::local(
4039 client,
4040 dir.as_path(),
4041 true,
4042 Arc::new(RealFs),
4043 Default::default(),
4044 &mut cx.to_async(),
4045 )
4046 .await
4047 .unwrap();
4048 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
4049 .await;
4050 tree.flush_fs_events(cx).await;
4051 cx.read(|cx| {
4052 let tree = tree.read(cx);
4053 assert!(
4054 !tree
4055 .entry_for_path("tracked-dir/tracked-file1")
4056 .unwrap()
4057 .is_ignored
4058 );
4059 assert!(
4060 tree.entry_for_path("tracked-dir/ancestor-ignored-file1")
4061 .unwrap()
4062 .is_ignored
4063 );
4064 assert!(
4065 tree.entry_for_path("ignored-dir/ignored-file1")
4066 .unwrap()
4067 .is_ignored
4068 );
4069 });
4070
4071 std::fs::write(dir.join("tracked-dir/tracked-file2"), "").unwrap();
4072 std::fs::write(dir.join("tracked-dir/ancestor-ignored-file2"), "").unwrap();
4073 std::fs::write(dir.join("ignored-dir/ignored-file2"), "").unwrap();
4074 tree.flush_fs_events(cx).await;
4075 cx.read(|cx| {
4076 let tree = tree.read(cx);
4077 assert!(
4078 !tree
4079 .entry_for_path("tracked-dir/tracked-file2")
4080 .unwrap()
4081 .is_ignored
4082 );
4083 assert!(
4084 tree.entry_for_path("tracked-dir/ancestor-ignored-file2")
4085 .unwrap()
4086 .is_ignored
4087 );
4088 assert!(
4089 tree.entry_for_path("ignored-dir/ignored-file2")
4090 .unwrap()
4091 .is_ignored
4092 );
4093 assert!(tree.entry_for_path(".git").unwrap().is_ignored);
4094 });
4095 }
4096
4097 #[gpui::test]
4098 async fn test_write_file(cx: &mut TestAppContext) {
4099 let dir = temp_tree(json!({
4100 ".git": {},
4101 ".gitignore": "ignored-dir\n",
4102 "tracked-dir": {},
4103 "ignored-dir": {}
4104 }));
4105
4106 let client = cx.read(|cx| Client::new(FakeHttpClient::with_404_response(), cx));
4107
4108 let tree = Worktree::local(
4109 client,
4110 dir.path(),
4111 true,
4112 Arc::new(RealFs),
4113 Default::default(),
4114 &mut cx.to_async(),
4115 )
4116 .await
4117 .unwrap();
4118 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
4119 .await;
4120 tree.flush_fs_events(cx).await;
4121
4122 tree.update(cx, |tree, cx| {
4123 tree.as_local().unwrap().write_file(
4124 Path::new("tracked-dir/file.txt"),
4125 "hello".into(),
4126 Default::default(),
4127 cx,
4128 )
4129 })
4130 .await
4131 .unwrap();
4132 tree.update(cx, |tree, cx| {
4133 tree.as_local().unwrap().write_file(
4134 Path::new("ignored-dir/file.txt"),
4135 "world".into(),
4136 Default::default(),
4137 cx,
4138 )
4139 })
4140 .await
4141 .unwrap();
4142
4143 tree.read_with(cx, |tree, _| {
4144 let tracked = tree.entry_for_path("tracked-dir/file.txt").unwrap();
4145 let ignored = tree.entry_for_path("ignored-dir/file.txt").unwrap();
4146 assert!(!tracked.is_ignored);
4147 assert!(ignored.is_ignored);
4148 });
4149 }
4150
4151 #[gpui::test(iterations = 30)]
4152 async fn test_create_directory_during_initial_scan(cx: &mut TestAppContext) {
4153 let client = cx.read(|cx| Client::new(FakeHttpClient::with_404_response(), cx));
4154
4155 let fs = FakeFs::new(cx.background());
4156 fs.insert_tree(
4157 "/root",
4158 json!({
4159 "b": {},
4160 "c": {},
4161 "d": {},
4162 }),
4163 )
4164 .await;
4165
4166 let tree = Worktree::local(
4167 client,
4168 "/root".as_ref(),
4169 true,
4170 fs,
4171 Default::default(),
4172 &mut cx.to_async(),
4173 )
4174 .await
4175 .unwrap();
4176
4177 let snapshot1 = tree.update(cx, |tree, cx| {
4178 let tree = tree.as_local_mut().unwrap();
4179 let snapshot = Arc::new(Mutex::new(tree.snapshot()));
4180 let _ = tree.observe_updates(0, cx, {
4181 let snapshot = snapshot.clone();
4182 move |update| {
4183 snapshot.lock().apply_remote_update(update).unwrap();
4184 async { true }
4185 }
4186 });
4187 snapshot
4188 });
4189
4190 let entry = tree
4191 .update(cx, |tree, cx| {
4192 tree.as_local_mut()
4193 .unwrap()
4194 .create_entry("a/e".as_ref(), true, cx)
4195 })
4196 .await
4197 .unwrap();
4198 assert!(entry.is_dir());
4199
4200 cx.foreground().run_until_parked();
4201 tree.read_with(cx, |tree, _| {
4202 assert_eq!(tree.entry_for_path("a/e").unwrap().kind, EntryKind::Dir);
4203 });
4204
4205 let snapshot2 = tree.update(cx, |tree, _| tree.as_local().unwrap().snapshot());
4206 assert_eq!(
4207 snapshot1.lock().entries(true).collect::<Vec<_>>(),
4208 snapshot2.entries(true).collect::<Vec<_>>()
4209 );
4210 }
4211
4212 #[gpui::test(iterations = 100)]
4213 async fn test_random_worktree_operations_during_initial_scan(
4214 cx: &mut TestAppContext,
4215 mut rng: StdRng,
4216 ) {
4217 let operations = env::var("OPERATIONS")
4218 .map(|o| o.parse().unwrap())
4219 .unwrap_or(5);
4220 let initial_entries = env::var("INITIAL_ENTRIES")
4221 .map(|o| o.parse().unwrap())
4222 .unwrap_or(20);
4223
4224 let root_dir = Path::new("/test");
4225 let fs = FakeFs::new(cx.background()) as Arc<dyn Fs>;
4226 fs.as_fake().insert_tree(root_dir, json!({})).await;
4227 for _ in 0..initial_entries {
4228 randomly_mutate_fs(&fs, root_dir, 1.0, &mut rng).await;
4229 }
4230 log::info!("generated initial tree");
4231
4232 let client = cx.read(|cx| Client::new(FakeHttpClient::with_404_response(), cx));
4233 let worktree = Worktree::local(
4234 client.clone(),
4235 root_dir,
4236 true,
4237 fs.clone(),
4238 Default::default(),
4239 &mut cx.to_async(),
4240 )
4241 .await
4242 .unwrap();
4243
4244 let mut snapshots =
4245 vec![worktree.read_with(cx, |tree, _| tree.as_local().unwrap().snapshot())];
4246 let updates = Arc::new(Mutex::new(Vec::new()));
4247 worktree.update(cx, |tree, cx| {
4248 check_worktree_change_events(tree, cx);
4249
4250 let _ = tree.as_local_mut().unwrap().observe_updates(0, cx, {
4251 let updates = updates.clone();
4252 move |update| {
4253 updates.lock().push(update);
4254 async { true }
4255 }
4256 });
4257 });
4258
4259 for _ in 0..operations {
4260 worktree
4261 .update(cx, |worktree, cx| {
4262 randomly_mutate_worktree(worktree, &mut rng, cx)
4263 })
4264 .await
4265 .log_err();
4266 worktree.read_with(cx, |tree, _| {
4267 tree.as_local().unwrap().snapshot.check_invariants()
4268 });
4269
4270 if rng.gen_bool(0.6) {
4271 snapshots
4272 .push(worktree.read_with(cx, |tree, _| tree.as_local().unwrap().snapshot()));
4273 }
4274 }
4275
4276 worktree
4277 .update(cx, |tree, _| tree.as_local_mut().unwrap().scan_complete())
4278 .await;
4279
4280 cx.foreground().run_until_parked();
4281
4282 let final_snapshot = worktree.read_with(cx, |tree, _| {
4283 let tree = tree.as_local().unwrap();
4284 tree.snapshot.check_invariants();
4285 tree.snapshot()
4286 });
4287
4288 for (i, snapshot) in snapshots.into_iter().enumerate().rev() {
4289 let mut updated_snapshot = snapshot.clone();
4290 for update in updates.lock().iter() {
4291 if update.scan_id >= updated_snapshot.scan_id() as u64 {
4292 updated_snapshot
4293 .apply_remote_update(update.clone())
4294 .unwrap();
4295 }
4296 }
4297
4298 assert_eq!(
4299 updated_snapshot.entries(true).collect::<Vec<_>>(),
4300 final_snapshot.entries(true).collect::<Vec<_>>(),
4301 "wrong updates after snapshot {i}: {snapshot:#?} {updates:#?}",
4302 );
4303 }
4304 }
4305
4306 #[gpui::test(iterations = 100)]
4307 async fn test_random_worktree_changes(cx: &mut TestAppContext, mut rng: StdRng) {
4308 let operations = env::var("OPERATIONS")
4309 .map(|o| o.parse().unwrap())
4310 .unwrap_or(40);
4311 let initial_entries = env::var("INITIAL_ENTRIES")
4312 .map(|o| o.parse().unwrap())
4313 .unwrap_or(20);
4314
4315 let root_dir = Path::new("/test");
4316 let fs = FakeFs::new(cx.background()) as Arc<dyn Fs>;
4317 fs.as_fake().insert_tree(root_dir, json!({})).await;
4318 for _ in 0..initial_entries {
4319 randomly_mutate_fs(&fs, root_dir, 1.0, &mut rng).await;
4320 }
4321 log::info!("generated initial tree");
4322
4323 let client = cx.read(|cx| Client::new(FakeHttpClient::with_404_response(), cx));
4324 let worktree = Worktree::local(
4325 client.clone(),
4326 root_dir,
4327 true,
4328 fs.clone(),
4329 Default::default(),
4330 &mut cx.to_async(),
4331 )
4332 .await
4333 .unwrap();
4334
4335 let updates = Arc::new(Mutex::new(Vec::new()));
4336 worktree.update(cx, |tree, cx| {
4337 check_worktree_change_events(tree, cx);
4338
4339 let _ = tree.as_local_mut().unwrap().observe_updates(0, cx, {
4340 let updates = updates.clone();
4341 move |update| {
4342 updates.lock().push(update);
4343 async { true }
4344 }
4345 });
4346 });
4347
4348 worktree
4349 .update(cx, |tree, _| tree.as_local_mut().unwrap().scan_complete())
4350 .await;
4351
4352 fs.as_fake().pause_events();
4353 let mut snapshots = Vec::new();
4354 let mut mutations_len = operations;
4355 while mutations_len > 1 {
4356 if rng.gen_bool(0.2) {
4357 worktree
4358 .update(cx, |worktree, cx| {
4359 randomly_mutate_worktree(worktree, &mut rng, cx)
4360 })
4361 .await
4362 .log_err();
4363 } else {
4364 randomly_mutate_fs(&fs, root_dir, 1.0, &mut rng).await;
4365 }
4366
4367 let buffered_event_count = fs.as_fake().buffered_event_count();
4368 if buffered_event_count > 0 && rng.gen_bool(0.3) {
4369 let len = rng.gen_range(0..=buffered_event_count);
4370 log::info!("flushing {} events", len);
4371 fs.as_fake().flush_events(len);
4372 } else {
4373 randomly_mutate_fs(&fs, root_dir, 0.6, &mut rng).await;
4374 mutations_len -= 1;
4375 }
4376
4377 cx.foreground().run_until_parked();
4378 if rng.gen_bool(0.2) {
4379 log::info!("storing snapshot {}", snapshots.len());
4380 let snapshot =
4381 worktree.read_with(cx, |tree, _| tree.as_local().unwrap().snapshot());
4382 snapshots.push(snapshot);
4383 }
4384 }
4385
4386 log::info!("quiescing");
4387 fs.as_fake().flush_events(usize::MAX);
4388 cx.foreground().run_until_parked();
4389 let snapshot = worktree.read_with(cx, |tree, _| tree.as_local().unwrap().snapshot());
4390 snapshot.check_invariants();
4391
4392 {
4393 let new_worktree = Worktree::local(
4394 client.clone(),
4395 root_dir,
4396 true,
4397 fs.clone(),
4398 Default::default(),
4399 &mut cx.to_async(),
4400 )
4401 .await
4402 .unwrap();
4403 new_worktree
4404 .update(cx, |tree, _| tree.as_local_mut().unwrap().scan_complete())
4405 .await;
4406 let new_snapshot =
4407 new_worktree.read_with(cx, |tree, _| tree.as_local().unwrap().snapshot());
4408 assert_eq!(
4409 snapshot.entries_without_ids(true),
4410 new_snapshot.entries_without_ids(true)
4411 );
4412 }
4413
4414 for (i, mut prev_snapshot) in snapshots.into_iter().enumerate().rev() {
4415 for update in updates.lock().iter() {
4416 if update.scan_id >= prev_snapshot.scan_id() as u64 {
4417 prev_snapshot.apply_remote_update(update.clone()).unwrap();
4418 }
4419 }
4420
4421 assert_eq!(
4422 prev_snapshot.entries(true).collect::<Vec<_>>(),
4423 snapshot.entries(true).collect::<Vec<_>>(),
4424 "wrong updates after snapshot {i}: {updates:#?}",
4425 );
4426 }
4427 }
4428
4429 // The worktree's `UpdatedEntries` event can be used to follow along with
4430 // all changes to the worktree's snapshot.
4431 fn check_worktree_change_events(tree: &mut Worktree, cx: &mut ModelContext<Worktree>) {
4432 let mut entries = tree.entries(true).cloned().collect::<Vec<_>>();
4433 cx.subscribe(&cx.handle(), move |tree, _, event, _| {
4434 if let Event::UpdatedEntries(changes) = event {
4435 for (path, _, change_type) in changes.iter() {
4436 let entry = tree.entry_for_path(&path).cloned();
4437 let ix = match entries.binary_search_by_key(&path, |e| &e.path) {
4438 Ok(ix) | Err(ix) => ix,
4439 };
4440 match change_type {
4441 PathChange::Loaded => entries.insert(ix, entry.unwrap()),
4442 PathChange::Added => entries.insert(ix, entry.unwrap()),
4443 PathChange::Removed => drop(entries.remove(ix)),
4444 PathChange::Updated => {
4445 let entry = entry.unwrap();
4446 let existing_entry = entries.get_mut(ix).unwrap();
4447 assert_eq!(existing_entry.path, entry.path);
4448 *existing_entry = entry;
4449 }
4450 PathChange::AddedOrUpdated => {
4451 let entry = entry.unwrap();
4452 if entries.get(ix).map(|e| &e.path) == Some(&entry.path) {
4453 *entries.get_mut(ix).unwrap() = entry;
4454 } else {
4455 entries.insert(ix, entry);
4456 }
4457 }
4458 }
4459 }
4460
4461 let new_entries = tree.entries(true).cloned().collect::<Vec<_>>();
4462 assert_eq!(entries, new_entries, "incorrect changes: {:?}", changes);
4463 }
4464 })
4465 .detach();
4466 }
4467
4468 fn randomly_mutate_worktree(
4469 worktree: &mut Worktree,
4470 rng: &mut impl Rng,
4471 cx: &mut ModelContext<Worktree>,
4472 ) -> Task<Result<()>> {
4473 log::info!("mutating worktree");
4474 let worktree = worktree.as_local_mut().unwrap();
4475 let snapshot = worktree.snapshot();
4476 let entry = snapshot.entries(false).choose(rng).unwrap();
4477
4478 match rng.gen_range(0_u32..100) {
4479 0..=33 if entry.path.as_ref() != Path::new("") => {
4480 log::info!("deleting entry {:?} ({})", entry.path, entry.id.0);
4481 worktree.delete_entry(entry.id, cx).unwrap()
4482 }
4483 ..=66 if entry.path.as_ref() != Path::new("") => {
4484 let other_entry = snapshot.entries(false).choose(rng).unwrap();
4485 let new_parent_path = if other_entry.is_dir() {
4486 other_entry.path.clone()
4487 } else {
4488 other_entry.path.parent().unwrap().into()
4489 };
4490 let mut new_path = new_parent_path.join(gen_name(rng));
4491 if new_path.starts_with(&entry.path) {
4492 new_path = gen_name(rng).into();
4493 }
4494
4495 log::info!(
4496 "renaming entry {:?} ({}) to {:?}",
4497 entry.path,
4498 entry.id.0,
4499 new_path
4500 );
4501 let task = worktree.rename_entry(entry.id, new_path, cx).unwrap();
4502 cx.foreground().spawn(async move {
4503 task.await?;
4504 Ok(())
4505 })
4506 }
4507 _ => {
4508 let task = if entry.is_dir() {
4509 let child_path = entry.path.join(gen_name(rng));
4510 let is_dir = rng.gen_bool(0.3);
4511 log::info!(
4512 "creating {} at {:?}",
4513 if is_dir { "dir" } else { "file" },
4514 child_path,
4515 );
4516 worktree.create_entry(child_path, is_dir, cx)
4517 } else {
4518 log::info!("overwriting file {:?} ({})", entry.path, entry.id.0);
4519 worktree.write_file(entry.path.clone(), "".into(), Default::default(), cx)
4520 };
4521 cx.foreground().spawn(async move {
4522 task.await?;
4523 Ok(())
4524 })
4525 }
4526 }
4527 }
4528
4529 async fn randomly_mutate_fs(
4530 fs: &Arc<dyn Fs>,
4531 root_path: &Path,
4532 insertion_probability: f64,
4533 rng: &mut impl Rng,
4534 ) {
4535 log::info!("mutating fs");
4536 let mut files = Vec::new();
4537 let mut dirs = Vec::new();
4538 for path in fs.as_fake().paths() {
4539 if path.starts_with(root_path) {
4540 if fs.is_file(&path).await {
4541 files.push(path);
4542 } else {
4543 dirs.push(path);
4544 }
4545 }
4546 }
4547
4548 if (files.is_empty() && dirs.len() == 1) || rng.gen_bool(insertion_probability) {
4549 let path = dirs.choose(rng).unwrap();
4550 let new_path = path.join(gen_name(rng));
4551
4552 if rng.gen() {
4553 log::info!(
4554 "creating dir {:?}",
4555 new_path.strip_prefix(root_path).unwrap()
4556 );
4557 fs.create_dir(&new_path).await.unwrap();
4558 } else {
4559 log::info!(
4560 "creating file {:?}",
4561 new_path.strip_prefix(root_path).unwrap()
4562 );
4563 fs.create_file(&new_path, Default::default()).await.unwrap();
4564 }
4565 } else if rng.gen_bool(0.05) {
4566 let ignore_dir_path = dirs.choose(rng).unwrap();
4567 let ignore_path = ignore_dir_path.join(&*GITIGNORE);
4568
4569 let subdirs = dirs
4570 .iter()
4571 .filter(|d| d.starts_with(&ignore_dir_path))
4572 .cloned()
4573 .collect::<Vec<_>>();
4574 let subfiles = files
4575 .iter()
4576 .filter(|d| d.starts_with(&ignore_dir_path))
4577 .cloned()
4578 .collect::<Vec<_>>();
4579 let files_to_ignore = {
4580 let len = rng.gen_range(0..=subfiles.len());
4581 subfiles.choose_multiple(rng, len)
4582 };
4583 let dirs_to_ignore = {
4584 let len = rng.gen_range(0..subdirs.len());
4585 subdirs.choose_multiple(rng, len)
4586 };
4587
4588 let mut ignore_contents = String::new();
4589 for path_to_ignore in files_to_ignore.chain(dirs_to_ignore) {
4590 writeln!(
4591 ignore_contents,
4592 "{}",
4593 path_to_ignore
4594 .strip_prefix(&ignore_dir_path)
4595 .unwrap()
4596 .to_str()
4597 .unwrap()
4598 )
4599 .unwrap();
4600 }
4601 log::info!(
4602 "creating gitignore {:?} with contents:\n{}",
4603 ignore_path.strip_prefix(&root_path).unwrap(),
4604 ignore_contents
4605 );
4606 fs.save(
4607 &ignore_path,
4608 &ignore_contents.as_str().into(),
4609 Default::default(),
4610 )
4611 .await
4612 .unwrap();
4613 } else {
4614 let old_path = {
4615 let file_path = files.choose(rng);
4616 let dir_path = dirs[1..].choose(rng);
4617 file_path.into_iter().chain(dir_path).choose(rng).unwrap()
4618 };
4619
4620 let is_rename = rng.gen();
4621 if is_rename {
4622 let new_path_parent = dirs
4623 .iter()
4624 .filter(|d| !d.starts_with(old_path))
4625 .choose(rng)
4626 .unwrap();
4627
4628 let overwrite_existing_dir =
4629 !old_path.starts_with(&new_path_parent) && rng.gen_bool(0.3);
4630 let new_path = if overwrite_existing_dir {
4631 fs.remove_dir(
4632 &new_path_parent,
4633 RemoveOptions {
4634 recursive: true,
4635 ignore_if_not_exists: true,
4636 },
4637 )
4638 .await
4639 .unwrap();
4640 new_path_parent.to_path_buf()
4641 } else {
4642 new_path_parent.join(gen_name(rng))
4643 };
4644
4645 log::info!(
4646 "renaming {:?} to {}{:?}",
4647 old_path.strip_prefix(&root_path).unwrap(),
4648 if overwrite_existing_dir {
4649 "overwrite "
4650 } else {
4651 ""
4652 },
4653 new_path.strip_prefix(&root_path).unwrap()
4654 );
4655 fs.rename(
4656 &old_path,
4657 &new_path,
4658 fs::RenameOptions {
4659 overwrite: true,
4660 ignore_if_exists: true,
4661 },
4662 )
4663 .await
4664 .unwrap();
4665 } else if fs.is_file(&old_path).await {
4666 log::info!(
4667 "deleting file {:?}",
4668 old_path.strip_prefix(&root_path).unwrap()
4669 );
4670 fs.remove_file(old_path, Default::default()).await.unwrap();
4671 } else {
4672 log::info!(
4673 "deleting dir {:?}",
4674 old_path.strip_prefix(&root_path).unwrap()
4675 );
4676 fs.remove_dir(
4677 &old_path,
4678 RemoveOptions {
4679 recursive: true,
4680 ignore_if_not_exists: true,
4681 },
4682 )
4683 .await
4684 .unwrap();
4685 }
4686 }
4687 }
4688
4689 fn gen_name(rng: &mut impl Rng) -> String {
4690 (0..6)
4691 .map(|_| rng.sample(rand::distributions::Alphanumeric))
4692 .map(char::from)
4693 .collect()
4694 }
4695
4696 impl LocalSnapshot {
4697 fn check_invariants(&self) {
4698 assert_eq!(
4699 self.entries_by_path
4700 .cursor::<()>()
4701 .map(|e| (&e.path, e.id))
4702 .collect::<Vec<_>>(),
4703 self.entries_by_id
4704 .cursor::<()>()
4705 .map(|e| (&e.path, e.id))
4706 .collect::<collections::BTreeSet<_>>()
4707 .into_iter()
4708 .collect::<Vec<_>>(),
4709 "entries_by_path and entries_by_id are inconsistent"
4710 );
4711
4712 let mut files = self.files(true, 0);
4713 let mut visible_files = self.files(false, 0);
4714 for entry in self.entries_by_path.cursor::<()>() {
4715 if entry.is_file() {
4716 assert_eq!(files.next().unwrap().inode, entry.inode);
4717 if !entry.is_ignored {
4718 assert_eq!(visible_files.next().unwrap().inode, entry.inode);
4719 }
4720 }
4721 }
4722
4723 assert!(files.next().is_none());
4724 assert!(visible_files.next().is_none());
4725
4726 let mut bfs_paths = Vec::new();
4727 let mut stack = vec![Path::new("")];
4728 while let Some(path) = stack.pop() {
4729 bfs_paths.push(path);
4730 let ix = stack.len();
4731 for child_entry in self.child_entries(path) {
4732 stack.insert(ix, &child_entry.path);
4733 }
4734 }
4735
4736 let dfs_paths_via_iter = self
4737 .entries_by_path
4738 .cursor::<()>()
4739 .map(|e| e.path.as_ref())
4740 .collect::<Vec<_>>();
4741 assert_eq!(bfs_paths, dfs_paths_via_iter);
4742
4743 let dfs_paths_via_traversal = self
4744 .entries(true)
4745 .map(|e| e.path.as_ref())
4746 .collect::<Vec<_>>();
4747 assert_eq!(dfs_paths_via_traversal, dfs_paths_via_iter);
4748
4749 for ignore_parent_abs_path in self.ignores_by_parent_abs_path.keys() {
4750 let ignore_parent_path =
4751 ignore_parent_abs_path.strip_prefix(&self.abs_path).unwrap();
4752 assert!(self.entry_for_path(&ignore_parent_path).is_some());
4753 assert!(self
4754 .entry_for_path(ignore_parent_path.join(&*GITIGNORE))
4755 .is_some());
4756 }
4757 }
4758
4759 fn entries_without_ids(&self, include_ignored: bool) -> Vec<(&Path, u64, bool)> {
4760 let mut paths = Vec::new();
4761 for entry in self.entries_by_path.cursor::<()>() {
4762 if include_ignored || !entry.is_ignored {
4763 paths.push((entry.path.as_ref(), entry.inode, entry.is_ignored));
4764 }
4765 }
4766 paths.sort_by(|a, b| a.0.cmp(b.0));
4767 paths
4768 }
4769 }
4770
4771 mod git_tests {
4772 use super::*;
4773 use pretty_assertions::assert_eq;
4774
4775 #[gpui::test]
4776 async fn test_rename_work_directory(cx: &mut TestAppContext) {
4777 let root = temp_tree(json!({
4778 "projects": {
4779 "project1": {
4780 "a": "",
4781 "b": "",
4782 }
4783 },
4784
4785 }));
4786 let root_path = root.path();
4787
4788 let http_client = FakeHttpClient::with_404_response();
4789 let client = cx.read(|cx| Client::new(http_client, cx));
4790 let tree = Worktree::local(
4791 client,
4792 root_path,
4793 true,
4794 Arc::new(RealFs),
4795 Default::default(),
4796 &mut cx.to_async(),
4797 )
4798 .await
4799 .unwrap();
4800
4801 let repo = git_init(&root_path.join("projects/project1"));
4802 git_add("a", &repo);
4803 git_commit("init", &repo);
4804 std::fs::write(root_path.join("projects/project1/a"), "aa").ok();
4805
4806 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
4807 .await;
4808
4809 tree.flush_fs_events(cx).await;
4810
4811 cx.read(|cx| {
4812 let tree = tree.read(cx);
4813 let (work_dir, _) = tree.repositories().next().unwrap();
4814 assert_eq!(work_dir.as_ref(), Path::new("projects/project1"));
4815 assert_eq!(
4816 tree.status_for_file(Path::new("projects/project1/a")),
4817 Some(GitFileStatus::Modified)
4818 );
4819 assert_eq!(
4820 tree.status_for_file(Path::new("projects/project1/b")),
4821 Some(GitFileStatus::Added)
4822 );
4823 });
4824
4825 std::fs::rename(
4826 root_path.join("projects/project1"),
4827 root_path.join("projects/project2"),
4828 )
4829 .ok();
4830 tree.flush_fs_events(cx).await;
4831
4832 cx.read(|cx| {
4833 let tree = tree.read(cx);
4834 let (work_dir, _) = tree.repositories().next().unwrap();
4835 assert_eq!(work_dir.as_ref(), Path::new("projects/project2"));
4836 assert_eq!(
4837 tree.status_for_file(Path::new("projects/project2/a")),
4838 Some(GitFileStatus::Modified)
4839 );
4840 assert_eq!(
4841 tree.status_for_file(Path::new("projects/project2/b")),
4842 Some(GitFileStatus::Added)
4843 );
4844 });
4845 }
4846
4847 #[gpui::test]
4848 async fn test_git_repository_for_path(cx: &mut TestAppContext) {
4849 let root = temp_tree(json!({
4850 "c.txt": "",
4851 "dir1": {
4852 ".git": {},
4853 "deps": {
4854 "dep1": {
4855 ".git": {},
4856 "src": {
4857 "a.txt": ""
4858 }
4859 }
4860 },
4861 "src": {
4862 "b.txt": ""
4863 }
4864 },
4865 }));
4866
4867 let http_client = FakeHttpClient::with_404_response();
4868 let client = cx.read(|cx| Client::new(http_client, cx));
4869 let tree = Worktree::local(
4870 client,
4871 root.path(),
4872 true,
4873 Arc::new(RealFs),
4874 Default::default(),
4875 &mut cx.to_async(),
4876 )
4877 .await
4878 .unwrap();
4879
4880 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
4881 .await;
4882 tree.flush_fs_events(cx).await;
4883
4884 tree.read_with(cx, |tree, _cx| {
4885 let tree = tree.as_local().unwrap();
4886
4887 assert!(tree.repository_for_path("c.txt".as_ref()).is_none());
4888
4889 let entry = tree.repository_for_path("dir1/src/b.txt".as_ref()).unwrap();
4890 assert_eq!(
4891 entry
4892 .work_directory(tree)
4893 .map(|directory| directory.as_ref().to_owned()),
4894 Some(Path::new("dir1").to_owned())
4895 );
4896
4897 let entry = tree
4898 .repository_for_path("dir1/deps/dep1/src/a.txt".as_ref())
4899 .unwrap();
4900 assert_eq!(
4901 entry
4902 .work_directory(tree)
4903 .map(|directory| directory.as_ref().to_owned()),
4904 Some(Path::new("dir1/deps/dep1").to_owned())
4905 );
4906
4907 let entries = tree.files(false, 0);
4908
4909 let paths_with_repos = tree
4910 .entries_with_repositories(entries)
4911 .map(|(entry, repo)| {
4912 (
4913 entry.path.as_ref(),
4914 repo.and_then(|repo| {
4915 repo.work_directory(&tree)
4916 .map(|work_directory| work_directory.0.to_path_buf())
4917 }),
4918 )
4919 })
4920 .collect::<Vec<_>>();
4921
4922 assert_eq!(
4923 paths_with_repos,
4924 &[
4925 (Path::new("c.txt"), None),
4926 (
4927 Path::new("dir1/deps/dep1/src/a.txt"),
4928 Some(Path::new("dir1/deps/dep1").into())
4929 ),
4930 (Path::new("dir1/src/b.txt"), Some(Path::new("dir1").into())),
4931 ]
4932 );
4933 });
4934
4935 let repo_update_events = Arc::new(Mutex::new(vec![]));
4936 tree.update(cx, |_, cx| {
4937 let repo_update_events = repo_update_events.clone();
4938 cx.subscribe(&tree, move |_, _, event, _| {
4939 if let Event::UpdatedGitRepositories(update) = event {
4940 repo_update_events.lock().push(update.clone());
4941 }
4942 })
4943 .detach();
4944 });
4945
4946 std::fs::write(root.path().join("dir1/.git/random_new_file"), "hello").unwrap();
4947 tree.flush_fs_events(cx).await;
4948
4949 assert_eq!(
4950 repo_update_events.lock()[0]
4951 .iter()
4952 .map(|e| e.0.clone())
4953 .collect::<Vec<Arc<Path>>>(),
4954 vec![Path::new("dir1").into()]
4955 );
4956
4957 std::fs::remove_dir_all(root.path().join("dir1/.git")).unwrap();
4958 tree.flush_fs_events(cx).await;
4959
4960 tree.read_with(cx, |tree, _cx| {
4961 let tree = tree.as_local().unwrap();
4962
4963 assert!(tree
4964 .repository_for_path("dir1/src/b.txt".as_ref())
4965 .is_none());
4966 });
4967 }
4968
4969 // TODO: Stream statuses UPDATE THIS TO CHECK BUBBLIBG BEHAVIOR
4970 #[gpui::test]
4971 async fn test_git_status(deterministic: Arc<Deterministic>, cx: &mut TestAppContext) {
4972 const IGNORE_RULE: &'static str = "**/target";
4973
4974 let root = temp_tree(json!({
4975 "project": {
4976 "a.txt": "a",
4977 "b.txt": "bb",
4978 "c": {
4979 "d": {
4980 "e.txt": "eee"
4981 }
4982 },
4983 "f.txt": "ffff",
4984 "target": {
4985 "build_file": "???"
4986 },
4987 ".gitignore": IGNORE_RULE
4988 },
4989
4990 }));
4991
4992 let http_client = FakeHttpClient::with_404_response();
4993 let client = cx.read(|cx| Client::new(http_client, cx));
4994 let tree = Worktree::local(
4995 client,
4996 root.path(),
4997 true,
4998 Arc::new(RealFs),
4999 Default::default(),
5000 &mut cx.to_async(),
5001 )
5002 .await
5003 .unwrap();
5004
5005 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
5006 .await;
5007
5008 const A_TXT: &'static str = "a.txt";
5009 const B_TXT: &'static str = "b.txt";
5010 const E_TXT: &'static str = "c/d/e.txt";
5011 const F_TXT: &'static str = "f.txt";
5012 const DOTGITIGNORE: &'static str = ".gitignore";
5013 const BUILD_FILE: &'static str = "target/build_file";
5014 let project_path: &Path = &Path::new("project");
5015
5016 let work_dir = root.path().join("project");
5017 let mut repo = git_init(work_dir.as_path());
5018 repo.add_ignore_rule(IGNORE_RULE).unwrap();
5019 git_add(Path::new(A_TXT), &repo);
5020 git_add(Path::new(E_TXT), &repo);
5021 git_add(Path::new(DOTGITIGNORE), &repo);
5022 git_commit("Initial commit", &repo);
5023
5024 tree.flush_fs_events(cx).await;
5025 deterministic.run_until_parked();
5026
5027 // Check that the right git state is observed on startup
5028 tree.read_with(cx, |tree, _cx| {
5029 let snapshot = tree.snapshot();
5030 assert_eq!(snapshot.repository_entries.iter().count(), 1);
5031 let (dir, _) = snapshot.repository_entries.iter().next().unwrap();
5032 assert_eq!(dir.0.as_ref(), Path::new("project"));
5033
5034 assert_eq!(
5035 snapshot.status_for_file(project_path.join(B_TXT)),
5036 Some(GitFileStatus::Added)
5037 );
5038 assert_eq!(
5039 snapshot.status_for_file(project_path.join(F_TXT)),
5040 Some(GitFileStatus::Added)
5041 );
5042
5043 // Check stateful bubbling works
5044 assert_eq!(
5045 snapshot.status_for_file(project_path),
5046 Some(GitFileStatus::Added)
5047 );
5048
5049 assert_eq!(snapshot.status_for_file(""), Some(GitFileStatus::Added));
5050 });
5051
5052 std::fs::write(work_dir.join(A_TXT), "aa").unwrap();
5053
5054 tree.flush_fs_events(cx).await;
5055 deterministic.run_until_parked();
5056
5057 tree.read_with(cx, |tree, _cx| {
5058 let snapshot = tree.snapshot();
5059
5060 assert_eq!(
5061 snapshot.status_for_file(project_path.join(A_TXT)),
5062 Some(GitFileStatus::Modified)
5063 );
5064
5065 // Check stateful bubbling works, modified overrules added
5066 assert_eq!(
5067 snapshot.status_for_file(project_path),
5068 Some(GitFileStatus::Modified)
5069 );
5070
5071 assert_eq!(snapshot.status_for_file(""), Some(GitFileStatus::Modified));
5072 });
5073
5074 git_add(Path::new(A_TXT), &repo);
5075 git_add(Path::new(B_TXT), &repo);
5076 git_commit("Committing modified and added", &repo);
5077 tree.flush_fs_events(cx).await;
5078 deterministic.run_until_parked();
5079
5080 // Check that repo only changes are tracked
5081 tree.read_with(cx, |tree, _cx| {
5082 let snapshot = tree.snapshot();
5083
5084 assert_eq!(
5085 snapshot.status_for_file(project_path.join(F_TXT)),
5086 Some(GitFileStatus::Added)
5087 );
5088
5089 assert_eq!(snapshot.status_for_file(project_path.join(B_TXT)), None);
5090 assert_eq!(snapshot.status_for_file(project_path.join(A_TXT)), None);
5091
5092 // Check bubbling
5093 assert_eq!(
5094 snapshot.status_for_file(project_path),
5095 Some(GitFileStatus::Added)
5096 );
5097
5098 assert_eq!(snapshot.status_for_file(""), Some(GitFileStatus::Added));
5099 });
5100
5101 git_reset(0, &repo);
5102 git_remove_index(Path::new(B_TXT), &repo);
5103 git_stash(&mut repo);
5104 std::fs::write(work_dir.join(E_TXT), "eeee").unwrap();
5105 std::fs::write(work_dir.join(BUILD_FILE), "this should be ignored").unwrap();
5106 tree.flush_fs_events(cx).await;
5107 deterministic.run_until_parked();
5108
5109 // Check that more complex repo changes are tracked
5110 tree.read_with(cx, |tree, _cx| {
5111 let snapshot = tree.snapshot();
5112
5113 assert_eq!(snapshot.status_for_file(project_path.join(A_TXT)), None);
5114 assert_eq!(
5115 snapshot.status_for_file(project_path.join(B_TXT)),
5116 Some(GitFileStatus::Added)
5117 );
5118 assert_eq!(
5119 snapshot.status_for_file(project_path.join(E_TXT)),
5120 Some(GitFileStatus::Modified)
5121 );
5122
5123 // Check status bubbling
5124 assert_eq!(
5125 snapshot.status_for_file(project_path.join(Path::new(E_TXT).parent().unwrap())),
5126 Some(GitFileStatus::Modified)
5127 );
5128 assert_eq!(
5129 snapshot.status_for_file(
5130 project_path.join(Path::new(E_TXT).parent().unwrap().parent().unwrap())
5131 ),
5132 Some(GitFileStatus::Modified)
5133 );
5134 assert_eq!(
5135 snapshot.status_for_file(project_path),
5136 Some(GitFileStatus::Modified)
5137 );
5138
5139 assert_eq!(
5140 snapshot.status_for_file(project_path.join(F_TXT)),
5141 Some(GitFileStatus::Added)
5142 );
5143 });
5144
5145 std::fs::remove_file(work_dir.join(B_TXT)).unwrap();
5146 std::fs::remove_dir_all(work_dir.join("c")).unwrap();
5147 std::fs::write(
5148 work_dir.join(DOTGITIGNORE),
5149 [IGNORE_RULE, "f.txt"].join("\n"),
5150 )
5151 .unwrap();
5152
5153 git_add(Path::new(DOTGITIGNORE), &repo);
5154 git_commit("Committing modified git ignore", &repo);
5155
5156 tree.flush_fs_events(cx).await;
5157 deterministic.run_until_parked();
5158
5159 let mut renamed_dir_name = "first_directory/second_directory";
5160 const RENAMED_FILE: &'static str = "rf.txt";
5161
5162 std::fs::create_dir_all(work_dir.join(renamed_dir_name)).unwrap();
5163 std::fs::write(
5164 work_dir.join(renamed_dir_name).join(RENAMED_FILE),
5165 "new-contents",
5166 )
5167 .unwrap();
5168
5169 tree.flush_fs_events(cx).await;
5170 deterministic.run_until_parked();
5171
5172 tree.read_with(cx, |tree, _cx| {
5173 let snapshot = tree.snapshot();
5174 assert_eq!(
5175 snapshot
5176 .status_for_file(&project_path.join(renamed_dir_name).join(RENAMED_FILE)),
5177 Some(GitFileStatus::Added)
5178 );
5179 });
5180
5181 renamed_dir_name = "new_first_directory/second_directory";
5182
5183 std::fs::rename(
5184 work_dir.join("first_directory"),
5185 work_dir.join("new_first_directory"),
5186 )
5187 .unwrap();
5188
5189 tree.flush_fs_events(cx).await;
5190 deterministic.run_until_parked();
5191
5192 tree.read_with(cx, |tree, _cx| {
5193 let snapshot = tree.snapshot();
5194
5195 assert_eq!(
5196 snapshot.status_for_file(
5197 project_path
5198 .join(Path::new(renamed_dir_name))
5199 .join(RENAMED_FILE)
5200 ),
5201 Some(GitFileStatus::Added)
5202 );
5203 });
5204 }
5205
5206 #[track_caller]
5207 fn git_init(path: &Path) -> git2::Repository {
5208 git2::Repository::init(path).expect("Failed to initialize git repository")
5209 }
5210
5211 #[track_caller]
5212 fn git_add<P: AsRef<Path>>(path: P, repo: &git2::Repository) {
5213 let path = path.as_ref();
5214 let mut index = repo.index().expect("Failed to get index");
5215 index.add_path(path).expect("Failed to add a.txt");
5216 index.write().expect("Failed to write index");
5217 }
5218
5219 #[track_caller]
5220 fn git_remove_index(path: &Path, repo: &git2::Repository) {
5221 let mut index = repo.index().expect("Failed to get index");
5222 index.remove_path(path).expect("Failed to add a.txt");
5223 index.write().expect("Failed to write index");
5224 }
5225
5226 #[track_caller]
5227 fn git_commit(msg: &'static str, repo: &git2::Repository) {
5228 use git2::Signature;
5229
5230 let signature = Signature::now("test", "test@zed.dev").unwrap();
5231 let oid = repo.index().unwrap().write_tree().unwrap();
5232 let tree = repo.find_tree(oid).unwrap();
5233 if let Some(head) = repo.head().ok() {
5234 let parent_obj = head.peel(git2::ObjectType::Commit).unwrap();
5235
5236 let parent_commit = parent_obj.as_commit().unwrap();
5237
5238 repo.commit(
5239 Some("HEAD"),
5240 &signature,
5241 &signature,
5242 msg,
5243 &tree,
5244 &[parent_commit],
5245 )
5246 .expect("Failed to commit with parent");
5247 } else {
5248 repo.commit(Some("HEAD"), &signature, &signature, msg, &tree, &[])
5249 .expect("Failed to commit");
5250 }
5251 }
5252
5253 #[track_caller]
5254 fn git_stash(repo: &mut git2::Repository) {
5255 use git2::Signature;
5256
5257 let signature = Signature::now("test", "test@zed.dev").unwrap();
5258 repo.stash_save(&signature, "N/A", None)
5259 .expect("Failed to stash");
5260 }
5261
5262 #[track_caller]
5263 fn git_reset(offset: usize, repo: &git2::Repository) {
5264 let head = repo.head().expect("Couldn't get repo head");
5265 let object = head.peel(git2::ObjectType::Commit).unwrap();
5266 let commit = object.as_commit().unwrap();
5267 let new_head = commit
5268 .parents()
5269 .inspect(|parnet| {
5270 parnet.message();
5271 })
5272 .skip(offset)
5273 .next()
5274 .expect("Not enough history");
5275 repo.reset(&new_head.as_object(), git2::ResetType::Soft, None)
5276 .expect("Could not reset");
5277 }
5278
5279 #[allow(dead_code)]
5280 #[track_caller]
5281 fn git_status(repo: &git2::Repository) -> HashMap<String, git2::Status> {
5282 repo.statuses(None)
5283 .unwrap()
5284 .iter()
5285 .map(|status| (status.path().unwrap().to_string(), status.status()))
5286 .collect()
5287 }
5288 }
5289}