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::{AddAssign, Deref, DerefMut, Sub},
49 path::{Path, PathBuf},
50 pin::Pin,
51 sync::{
52 atomic::{AtomicUsize, Ordering::SeqCst},
53 Arc,
54 },
55 time::{Duration, SystemTime},
56};
57use sum_tree::{Bias, Edit, SeekTarget, SumTree, TreeMap, TreeSet};
58use util::{paths::HOME, ResultExt};
59
60#[derive(Copy, Clone, PartialEq, Eq, Debug, Hash, PartialOrd, Ord)]
61pub struct WorktreeId(usize);
62
63pub enum Worktree {
64 Local(LocalWorktree),
65 Remote(RemoteWorktree),
66}
67
68pub struct LocalWorktree {
69 snapshot: LocalSnapshot,
70 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::<TraversalProgress>();
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 statuses_for_paths(&self, paths: &[&Path]) -> Vec<Option<GitFileStatus>> {
1674 let mut cursor = self
1675 .entries_by_path
1676 .cursor::<(TraversalProgress, GitStatuses)>();
1677 let mut paths = paths.iter().peekable();
1678 let mut path_stack = Vec::<(&Path, usize, GitStatuses)>::new();
1679 let mut result = Vec::new();
1680
1681 loop {
1682 let next_path = paths.peek();
1683 let containing_path = path_stack.last();
1684
1685 let mut entry_to_finish = None;
1686 let mut path_to_start = None;
1687 match (containing_path, next_path) {
1688 (Some((containing_path, _, _)), Some(next_path)) => {
1689 if next_path.starts_with(containing_path) {
1690 path_to_start = paths.next();
1691 } else {
1692 entry_to_finish = path_stack.pop();
1693 }
1694 }
1695 (None, Some(_)) => path_to_start = paths.next(),
1696 (Some(_), None) => entry_to_finish = path_stack.pop(),
1697 (None, None) => break,
1698 }
1699
1700 if let Some((containing_path, result_ix, prev_statuses)) = entry_to_finish {
1701 cursor.seek_forward(
1702 &TraversalTarget::PathSuccessor(containing_path),
1703 Bias::Left,
1704 &(),
1705 );
1706
1707 let statuses = cursor.start().1 - prev_statuses;
1708
1709 result[result_ix] = if statuses.conflict > 0 {
1710 Some(GitFileStatus::Conflict)
1711 } else if statuses.modified > 0 {
1712 Some(GitFileStatus::Modified)
1713 } else if statuses.added > 0 {
1714 Some(GitFileStatus::Added)
1715 } else {
1716 None
1717 };
1718 }
1719 if let Some(path_to_start) = path_to_start {
1720 cursor.seek_forward(&TraversalTarget::Path(path_to_start), Bias::Left, &());
1721 path_stack.push((path_to_start, result.len(), cursor.start().1));
1722 result.push(None);
1723 }
1724 }
1725
1726 return result;
1727 }
1728
1729 pub fn paths(&self) -> impl Iterator<Item = &Arc<Path>> {
1730 let empty_path = Path::new("");
1731 self.entries_by_path
1732 .cursor::<()>()
1733 .filter(move |entry| entry.path.as_ref() != empty_path)
1734 .map(|entry| &entry.path)
1735 }
1736
1737 fn child_entries<'a>(&'a self, parent_path: &'a Path) -> ChildEntriesIter<'a> {
1738 let mut cursor = self.entries_by_path.cursor();
1739 cursor.seek(&TraversalTarget::Path(parent_path), Bias::Right, &());
1740 let traversal = Traversal {
1741 cursor,
1742 include_dirs: true,
1743 include_ignored: true,
1744 };
1745 ChildEntriesIter {
1746 traversal,
1747 parent_path,
1748 }
1749 }
1750
1751 fn descendent_entries<'a>(
1752 &'a self,
1753 include_dirs: bool,
1754 include_ignored: bool,
1755 parent_path: &'a Path,
1756 ) -> DescendentEntriesIter<'a> {
1757 let mut cursor = self.entries_by_path.cursor();
1758 cursor.seek(&TraversalTarget::Path(parent_path), Bias::Left, &());
1759 let mut traversal = Traversal {
1760 cursor,
1761 include_dirs,
1762 include_ignored,
1763 };
1764
1765 if traversal.end_offset() == traversal.start_offset() {
1766 traversal.advance();
1767 }
1768
1769 DescendentEntriesIter {
1770 traversal,
1771 parent_path,
1772 }
1773 }
1774
1775 pub fn root_entry(&self) -> Option<&Entry> {
1776 self.entry_for_path("")
1777 }
1778
1779 pub fn root_name(&self) -> &str {
1780 &self.root_name
1781 }
1782
1783 pub fn root_git_entry(&self) -> Option<RepositoryEntry> {
1784 self.repository_entries
1785 .get(&RepositoryWorkDirectory(Path::new("").into()))
1786 .map(|entry| entry.to_owned())
1787 }
1788
1789 pub fn git_entries(&self) -> impl Iterator<Item = &RepositoryEntry> {
1790 self.repository_entries.values()
1791 }
1792
1793 pub fn scan_id(&self) -> usize {
1794 self.scan_id
1795 }
1796
1797 pub fn entry_for_path(&self, path: impl AsRef<Path>) -> Option<&Entry> {
1798 let path = path.as_ref();
1799 self.traverse_from_path(true, true, path)
1800 .entry()
1801 .and_then(|entry| {
1802 if entry.path.as_ref() == path {
1803 Some(entry)
1804 } else {
1805 None
1806 }
1807 })
1808 }
1809
1810 pub fn entry_for_id(&self, id: ProjectEntryId) -> Option<&Entry> {
1811 let entry = self.entries_by_id.get(&id, &())?;
1812 self.entry_for_path(&entry.path)
1813 }
1814
1815 pub fn inode_for_path(&self, path: impl AsRef<Path>) -> Option<u64> {
1816 self.entry_for_path(path.as_ref()).map(|e| e.inode)
1817 }
1818}
1819
1820impl LocalSnapshot {
1821 pub(crate) fn get_local_repo(&self, repo: &RepositoryEntry) -> Option<&LocalRepositoryEntry> {
1822 self.git_repositories.get(&repo.work_directory.0)
1823 }
1824
1825 pub(crate) fn local_repo_for_path(
1826 &self,
1827 path: &Path,
1828 ) -> Option<(RepositoryWorkDirectory, &LocalRepositoryEntry)> {
1829 let (path, repo) = self.repository_and_work_directory_for_path(path)?;
1830 Some((path, self.git_repositories.get(&repo.work_directory_id())?))
1831 }
1832
1833 pub(crate) fn repo_for_metadata(
1834 &self,
1835 path: &Path,
1836 ) -> Option<(&ProjectEntryId, &LocalRepositoryEntry)> {
1837 self.git_repositories
1838 .iter()
1839 .find(|(_, repo)| repo.in_dot_git(path))
1840 }
1841
1842 fn build_update(
1843 &self,
1844 project_id: u64,
1845 worktree_id: u64,
1846 entry_changes: UpdatedEntriesSet,
1847 repo_changes: UpdatedGitRepositoriesSet,
1848 ) -> proto::UpdateWorktree {
1849 let mut updated_entries = Vec::new();
1850 let mut removed_entries = Vec::new();
1851 let mut updated_repositories = Vec::new();
1852 let mut removed_repositories = Vec::new();
1853
1854 for (_, entry_id, path_change) in entry_changes.iter() {
1855 if let PathChange::Removed = path_change {
1856 removed_entries.push(entry_id.0 as u64);
1857 } else if let Some(entry) = self.entry_for_id(*entry_id) {
1858 updated_entries.push(proto::Entry::from(entry));
1859 }
1860 }
1861
1862 for (work_dir_path, change) in repo_changes.iter() {
1863 let new_repo = self
1864 .repository_entries
1865 .get(&RepositoryWorkDirectory(work_dir_path.clone()));
1866 match (&change.old_repository, new_repo) {
1867 (Some(old_repo), Some(new_repo)) => {
1868 updated_repositories.push(new_repo.build_update(old_repo));
1869 }
1870 (None, Some(new_repo)) => {
1871 updated_repositories.push(proto::RepositoryEntry::from(new_repo));
1872 }
1873 (Some(old_repo), None) => {
1874 removed_repositories.push(old_repo.work_directory.0.to_proto());
1875 }
1876 _ => {}
1877 }
1878 }
1879
1880 removed_entries.sort_unstable();
1881 updated_entries.sort_unstable_by_key(|e| e.id);
1882 removed_repositories.sort_unstable();
1883 updated_repositories.sort_unstable_by_key(|e| e.work_directory_id);
1884
1885 // TODO - optimize, knowing that removed_entries are sorted.
1886 removed_entries.retain(|id| updated_entries.binary_search_by_key(id, |e| e.id).is_err());
1887
1888 proto::UpdateWorktree {
1889 project_id,
1890 worktree_id,
1891 abs_path: self.abs_path().to_string_lossy().into(),
1892 root_name: self.root_name().to_string(),
1893 updated_entries,
1894 removed_entries,
1895 scan_id: self.scan_id as u64,
1896 is_last_update: self.completed_scan_id == self.scan_id,
1897 updated_repositories,
1898 removed_repositories,
1899 }
1900 }
1901
1902 fn build_initial_update(&self, project_id: u64, worktree_id: u64) -> proto::UpdateWorktree {
1903 let mut updated_entries = self
1904 .entries_by_path
1905 .iter()
1906 .map(proto::Entry::from)
1907 .collect::<Vec<_>>();
1908 updated_entries.sort_unstable_by_key(|e| e.id);
1909
1910 let mut updated_repositories = self
1911 .repository_entries
1912 .values()
1913 .map(proto::RepositoryEntry::from)
1914 .collect::<Vec<_>>();
1915 updated_repositories.sort_unstable_by_key(|e| e.work_directory_id);
1916
1917 proto::UpdateWorktree {
1918 project_id,
1919 worktree_id,
1920 abs_path: self.abs_path().to_string_lossy().into(),
1921 root_name: self.root_name().to_string(),
1922 updated_entries,
1923 removed_entries: Vec::new(),
1924 scan_id: self.scan_id as u64,
1925 is_last_update: self.completed_scan_id == self.scan_id,
1926 updated_repositories,
1927 removed_repositories: Vec::new(),
1928 }
1929 }
1930
1931 fn insert_entry(&mut self, mut entry: Entry, fs: &dyn Fs) -> Entry {
1932 if entry.is_file() && entry.path.file_name() == Some(&GITIGNORE) {
1933 let abs_path = self.abs_path.join(&entry.path);
1934 match smol::block_on(build_gitignore(&abs_path, fs)) {
1935 Ok(ignore) => {
1936 self.ignores_by_parent_abs_path
1937 .insert(abs_path.parent().unwrap().into(), (Arc::new(ignore), true));
1938 }
1939 Err(error) => {
1940 log::error!(
1941 "error loading .gitignore file {:?} - {:?}",
1942 &entry.path,
1943 error
1944 );
1945 }
1946 }
1947 }
1948
1949 if entry.kind == EntryKind::PendingDir {
1950 if let Some(existing_entry) =
1951 self.entries_by_path.get(&PathKey(entry.path.clone()), &())
1952 {
1953 entry.kind = existing_entry.kind;
1954 }
1955 }
1956
1957 let scan_id = self.scan_id;
1958 let removed = self.entries_by_path.insert_or_replace(entry.clone(), &());
1959 if let Some(removed) = removed {
1960 if removed.id != entry.id {
1961 self.entries_by_id.remove(&removed.id, &());
1962 }
1963 }
1964 self.entries_by_id.insert_or_replace(
1965 PathEntry {
1966 id: entry.id,
1967 path: entry.path.clone(),
1968 is_ignored: entry.is_ignored,
1969 scan_id,
1970 },
1971 &(),
1972 );
1973
1974 entry
1975 }
1976
1977 fn build_repo(&mut self, parent_path: Arc<Path>, fs: &dyn Fs) -> Option<()> {
1978 let abs_path = self.abs_path.join(&parent_path);
1979 let work_dir: Arc<Path> = parent_path.parent().unwrap().into();
1980
1981 // Guard against repositories inside the repository metadata
1982 if work_dir
1983 .components()
1984 .find(|component| component.as_os_str() == *DOT_GIT)
1985 .is_some()
1986 {
1987 return None;
1988 };
1989
1990 let work_dir_id = self
1991 .entry_for_path(work_dir.clone())
1992 .map(|entry| entry.id)?;
1993
1994 if self.git_repositories.get(&work_dir_id).is_none() {
1995 let repo = fs.open_repo(abs_path.as_path())?;
1996 let work_directory = RepositoryWorkDirectory(work_dir.clone());
1997
1998 let repo_lock = repo.lock();
1999
2000 self.repository_entries.insert(
2001 work_directory.clone(),
2002 RepositoryEntry {
2003 work_directory: work_dir_id.into(),
2004 branch: repo_lock.branch_name().map(Into::into),
2005 },
2006 );
2007
2008 self.scan_statuses(repo_lock.deref(), &work_directory);
2009
2010 drop(repo_lock);
2011
2012 self.git_repositories.insert(
2013 work_dir_id,
2014 LocalRepositoryEntry {
2015 git_dir_scan_id: 0,
2016 repo_ptr: repo,
2017 git_dir_path: parent_path.clone(),
2018 },
2019 )
2020 }
2021
2022 Some(())
2023 }
2024
2025 fn scan_statuses(
2026 &mut self,
2027 repo_ptr: &dyn GitRepository,
2028 work_directory: &RepositoryWorkDirectory,
2029 ) {
2030 let mut edits = vec![];
2031 for mut entry in self
2032 .descendent_entries(false, false, &work_directory.0)
2033 .cloned()
2034 {
2035 let Ok(repo_path) = entry.path.strip_prefix(&work_directory.0) else {
2036 continue;
2037 };
2038 let git_file_status = repo_ptr.status(&RepoPath(repo_path.into()));
2039 let status = git_file_status;
2040 entry.git_status = status;
2041 edits.push(Edit::Insert(entry));
2042 }
2043
2044 self.entries_by_path.edit(edits, &());
2045 }
2046
2047 fn ancestor_inodes_for_path(&self, path: &Path) -> TreeSet<u64> {
2048 let mut inodes = TreeSet::default();
2049 for ancestor in path.ancestors().skip(1) {
2050 if let Some(entry) = self.entry_for_path(ancestor) {
2051 inodes.insert(entry.inode);
2052 }
2053 }
2054 inodes
2055 }
2056
2057 fn ignore_stack_for_abs_path(&self, abs_path: &Path, is_dir: bool) -> Arc<IgnoreStack> {
2058 let mut new_ignores = Vec::new();
2059 for ancestor in abs_path.ancestors().skip(1) {
2060 if let Some((ignore, _)) = self.ignores_by_parent_abs_path.get(ancestor) {
2061 new_ignores.push((ancestor, Some(ignore.clone())));
2062 } else {
2063 new_ignores.push((ancestor, None));
2064 }
2065 }
2066
2067 let mut ignore_stack = IgnoreStack::none();
2068 for (parent_abs_path, ignore) in new_ignores.into_iter().rev() {
2069 if ignore_stack.is_abs_path_ignored(parent_abs_path, true) {
2070 ignore_stack = IgnoreStack::all();
2071 break;
2072 } else if let Some(ignore) = ignore {
2073 ignore_stack = ignore_stack.append(parent_abs_path.into(), ignore);
2074 }
2075 }
2076
2077 if ignore_stack.is_abs_path_ignored(abs_path, is_dir) {
2078 ignore_stack = IgnoreStack::all();
2079 }
2080
2081 ignore_stack
2082 }
2083}
2084
2085impl BackgroundScannerState {
2086 fn reuse_entry_id(&mut self, entry: &mut Entry) {
2087 if let Some(removed_entry_id) = self.removed_entry_ids.remove(&entry.inode) {
2088 entry.id = removed_entry_id;
2089 } else if let Some(existing_entry) = self.snapshot.entry_for_path(&entry.path) {
2090 entry.id = existing_entry.id;
2091 }
2092 }
2093
2094 fn insert_entry(&mut self, mut entry: Entry, fs: &dyn Fs) -> Entry {
2095 self.reuse_entry_id(&mut entry);
2096 self.snapshot.insert_entry(entry, fs)
2097 }
2098
2099 fn populate_dir(
2100 &mut self,
2101 parent_path: Arc<Path>,
2102 entries: impl IntoIterator<Item = Entry>,
2103 ignore: Option<Arc<Gitignore>>,
2104 fs: &dyn Fs,
2105 ) {
2106 let mut parent_entry = if let Some(parent_entry) = self
2107 .snapshot
2108 .entries_by_path
2109 .get(&PathKey(parent_path.clone()), &())
2110 {
2111 parent_entry.clone()
2112 } else {
2113 log::warn!(
2114 "populating a directory {:?} that has been removed",
2115 parent_path
2116 );
2117 return;
2118 };
2119
2120 match parent_entry.kind {
2121 EntryKind::PendingDir => {
2122 parent_entry.kind = EntryKind::Dir;
2123 }
2124 EntryKind::Dir => {}
2125 _ => return,
2126 }
2127
2128 if let Some(ignore) = ignore {
2129 let abs_parent_path = self.snapshot.abs_path.join(&parent_path).into();
2130 self.snapshot
2131 .ignores_by_parent_abs_path
2132 .insert(abs_parent_path, (ignore, false));
2133 }
2134
2135 let mut entries_by_path_edits = vec![Edit::Insert(parent_entry)];
2136 let mut entries_by_id_edits = Vec::new();
2137
2138 for mut entry in entries {
2139 self.reuse_entry_id(&mut entry);
2140 entries_by_id_edits.push(Edit::Insert(PathEntry {
2141 id: entry.id,
2142 path: entry.path.clone(),
2143 is_ignored: entry.is_ignored,
2144 scan_id: self.snapshot.scan_id,
2145 }));
2146 entries_by_path_edits.push(Edit::Insert(entry));
2147 }
2148
2149 self.snapshot
2150 .entries_by_path
2151 .edit(entries_by_path_edits, &());
2152 self.snapshot.entries_by_id.edit(entries_by_id_edits, &());
2153
2154 if parent_path.file_name() == Some(&DOT_GIT) {
2155 self.snapshot.build_repo(parent_path, fs);
2156 }
2157 }
2158
2159 fn remove_path(&mut self, path: &Path) {
2160 let mut new_entries;
2161 let removed_entries;
2162 {
2163 let mut cursor = self.snapshot.entries_by_path.cursor::<TraversalProgress>();
2164 new_entries = cursor.slice(&TraversalTarget::Path(path), Bias::Left, &());
2165 removed_entries = cursor.slice(&TraversalTarget::PathSuccessor(path), Bias::Left, &());
2166 new_entries.push_tree(cursor.suffix(&()), &());
2167 }
2168 self.snapshot.entries_by_path = new_entries;
2169
2170 let mut entries_by_id_edits = Vec::new();
2171 for entry in removed_entries.cursor::<()>() {
2172 let removed_entry_id = self
2173 .removed_entry_ids
2174 .entry(entry.inode)
2175 .or_insert(entry.id);
2176 *removed_entry_id = cmp::max(*removed_entry_id, entry.id);
2177 entries_by_id_edits.push(Edit::Remove(entry.id));
2178 }
2179 self.snapshot.entries_by_id.edit(entries_by_id_edits, &());
2180
2181 if path.file_name() == Some(&GITIGNORE) {
2182 let abs_parent_path = self.snapshot.abs_path.join(path.parent().unwrap());
2183 if let Some((_, needs_update)) = self
2184 .snapshot
2185 .ignores_by_parent_abs_path
2186 .get_mut(abs_parent_path.as_path())
2187 {
2188 *needs_update = true;
2189 }
2190 }
2191 }
2192}
2193
2194async fn build_gitignore(abs_path: &Path, fs: &dyn Fs) -> Result<Gitignore> {
2195 let contents = fs.load(abs_path).await?;
2196 let parent = abs_path.parent().unwrap_or_else(|| Path::new("/"));
2197 let mut builder = GitignoreBuilder::new(parent);
2198 for line in contents.lines() {
2199 builder.add_line(Some(abs_path.into()), line)?;
2200 }
2201 Ok(builder.build()?)
2202}
2203
2204impl WorktreeId {
2205 pub fn from_usize(handle_id: usize) -> Self {
2206 Self(handle_id)
2207 }
2208
2209 pub(crate) fn from_proto(id: u64) -> Self {
2210 Self(id as usize)
2211 }
2212
2213 pub fn to_proto(&self) -> u64 {
2214 self.0 as u64
2215 }
2216
2217 pub fn to_usize(&self) -> usize {
2218 self.0
2219 }
2220}
2221
2222impl fmt::Display for WorktreeId {
2223 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2224 self.0.fmt(f)
2225 }
2226}
2227
2228impl Deref for Worktree {
2229 type Target = Snapshot;
2230
2231 fn deref(&self) -> &Self::Target {
2232 match self {
2233 Worktree::Local(worktree) => &worktree.snapshot,
2234 Worktree::Remote(worktree) => &worktree.snapshot,
2235 }
2236 }
2237}
2238
2239impl Deref for LocalWorktree {
2240 type Target = LocalSnapshot;
2241
2242 fn deref(&self) -> &Self::Target {
2243 &self.snapshot
2244 }
2245}
2246
2247impl Deref for RemoteWorktree {
2248 type Target = Snapshot;
2249
2250 fn deref(&self) -> &Self::Target {
2251 &self.snapshot
2252 }
2253}
2254
2255impl fmt::Debug for LocalWorktree {
2256 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2257 self.snapshot.fmt(f)
2258 }
2259}
2260
2261impl fmt::Debug for Snapshot {
2262 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2263 struct EntriesById<'a>(&'a SumTree<PathEntry>);
2264 struct EntriesByPath<'a>(&'a SumTree<Entry>);
2265
2266 impl<'a> fmt::Debug for EntriesByPath<'a> {
2267 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2268 f.debug_map()
2269 .entries(self.0.iter().map(|entry| (&entry.path, entry.id)))
2270 .finish()
2271 }
2272 }
2273
2274 impl<'a> fmt::Debug for EntriesById<'a> {
2275 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2276 f.debug_list().entries(self.0.iter()).finish()
2277 }
2278 }
2279
2280 f.debug_struct("Snapshot")
2281 .field("id", &self.id)
2282 .field("root_name", &self.root_name)
2283 .field("entries_by_path", &EntriesByPath(&self.entries_by_path))
2284 .field("entries_by_id", &EntriesById(&self.entries_by_id))
2285 .finish()
2286 }
2287}
2288
2289#[derive(Clone, PartialEq)]
2290pub struct File {
2291 pub worktree: ModelHandle<Worktree>,
2292 pub path: Arc<Path>,
2293 pub mtime: SystemTime,
2294 pub(crate) entry_id: ProjectEntryId,
2295 pub(crate) is_local: bool,
2296 pub(crate) is_deleted: bool,
2297}
2298
2299impl language::File for File {
2300 fn as_local(&self) -> Option<&dyn language::LocalFile> {
2301 if self.is_local {
2302 Some(self)
2303 } else {
2304 None
2305 }
2306 }
2307
2308 fn mtime(&self) -> SystemTime {
2309 self.mtime
2310 }
2311
2312 fn path(&self) -> &Arc<Path> {
2313 &self.path
2314 }
2315
2316 fn full_path(&self, cx: &AppContext) -> PathBuf {
2317 let mut full_path = PathBuf::new();
2318 let worktree = self.worktree.read(cx);
2319
2320 if worktree.is_visible() {
2321 full_path.push(worktree.root_name());
2322 } else {
2323 let path = worktree.abs_path();
2324
2325 if worktree.is_local() && path.starts_with(HOME.as_path()) {
2326 full_path.push("~");
2327 full_path.push(path.strip_prefix(HOME.as_path()).unwrap());
2328 } else {
2329 full_path.push(path)
2330 }
2331 }
2332
2333 if self.path.components().next().is_some() {
2334 full_path.push(&self.path);
2335 }
2336
2337 full_path
2338 }
2339
2340 /// Returns the last component of this handle's absolute path. If this handle refers to the root
2341 /// of its worktree, then this method will return the name of the worktree itself.
2342 fn file_name<'a>(&'a self, cx: &'a AppContext) -> &'a OsStr {
2343 self.path
2344 .file_name()
2345 .unwrap_or_else(|| OsStr::new(&self.worktree.read(cx).root_name))
2346 }
2347
2348 fn is_deleted(&self) -> bool {
2349 self.is_deleted
2350 }
2351
2352 fn as_any(&self) -> &dyn Any {
2353 self
2354 }
2355
2356 fn to_proto(&self) -> rpc::proto::File {
2357 rpc::proto::File {
2358 worktree_id: self.worktree.id() as u64,
2359 entry_id: self.entry_id.to_proto(),
2360 path: self.path.to_string_lossy().into(),
2361 mtime: Some(self.mtime.into()),
2362 is_deleted: self.is_deleted,
2363 }
2364 }
2365}
2366
2367impl language::LocalFile for File {
2368 fn abs_path(&self, cx: &AppContext) -> PathBuf {
2369 self.worktree
2370 .read(cx)
2371 .as_local()
2372 .unwrap()
2373 .abs_path
2374 .join(&self.path)
2375 }
2376
2377 fn load(&self, cx: &AppContext) -> Task<Result<String>> {
2378 let worktree = self.worktree.read(cx).as_local().unwrap();
2379 let abs_path = worktree.absolutize(&self.path);
2380 let fs = worktree.fs.clone();
2381 cx.background()
2382 .spawn(async move { fs.load(&abs_path).await })
2383 }
2384
2385 fn buffer_reloaded(
2386 &self,
2387 buffer_id: u64,
2388 version: &clock::Global,
2389 fingerprint: RopeFingerprint,
2390 line_ending: LineEnding,
2391 mtime: SystemTime,
2392 cx: &mut AppContext,
2393 ) {
2394 let worktree = self.worktree.read(cx).as_local().unwrap();
2395 if let Some(project_id) = worktree.share.as_ref().map(|share| share.project_id) {
2396 worktree
2397 .client
2398 .send(proto::BufferReloaded {
2399 project_id,
2400 buffer_id,
2401 version: serialize_version(version),
2402 mtime: Some(mtime.into()),
2403 fingerprint: serialize_fingerprint(fingerprint),
2404 line_ending: serialize_line_ending(line_ending) as i32,
2405 })
2406 .log_err();
2407 }
2408 }
2409}
2410
2411impl File {
2412 pub fn from_proto(
2413 proto: rpc::proto::File,
2414 worktree: ModelHandle<Worktree>,
2415 cx: &AppContext,
2416 ) -> Result<Self> {
2417 let worktree_id = worktree
2418 .read(cx)
2419 .as_remote()
2420 .ok_or_else(|| anyhow!("not remote"))?
2421 .id();
2422
2423 if worktree_id.to_proto() != proto.worktree_id {
2424 return Err(anyhow!("worktree id does not match file"));
2425 }
2426
2427 Ok(Self {
2428 worktree,
2429 path: Path::new(&proto.path).into(),
2430 mtime: proto.mtime.ok_or_else(|| anyhow!("no timestamp"))?.into(),
2431 entry_id: ProjectEntryId::from_proto(proto.entry_id),
2432 is_local: false,
2433 is_deleted: proto.is_deleted,
2434 })
2435 }
2436
2437 pub fn from_dyn(file: Option<&Arc<dyn language::File>>) -> Option<&Self> {
2438 file.and_then(|f| f.as_any().downcast_ref())
2439 }
2440
2441 pub fn worktree_id(&self, cx: &AppContext) -> WorktreeId {
2442 self.worktree.read(cx).id()
2443 }
2444
2445 pub fn project_entry_id(&self, _: &AppContext) -> Option<ProjectEntryId> {
2446 if self.is_deleted {
2447 None
2448 } else {
2449 Some(self.entry_id)
2450 }
2451 }
2452}
2453
2454#[derive(Clone, Debug, PartialEq, Eq)]
2455pub struct Entry {
2456 pub id: ProjectEntryId,
2457 pub kind: EntryKind,
2458 pub path: Arc<Path>,
2459 pub inode: u64,
2460 pub mtime: SystemTime,
2461 pub is_symlink: bool,
2462 pub is_ignored: bool,
2463 pub git_status: Option<GitFileStatus>,
2464}
2465
2466#[derive(Clone, Copy, Debug, PartialEq, Eq)]
2467pub enum EntryKind {
2468 PendingDir,
2469 Dir,
2470 File(CharBag),
2471}
2472
2473#[derive(Clone, Copy, Debug)]
2474pub enum PathChange {
2475 /// A filesystem entry was was created.
2476 Added,
2477 /// A filesystem entry was removed.
2478 Removed,
2479 /// A filesystem entry was updated.
2480 Updated,
2481 /// A filesystem entry was either updated or added. We don't know
2482 /// whether or not it already existed, because the path had not
2483 /// been loaded before the event.
2484 AddedOrUpdated,
2485 /// A filesystem entry was found during the initial scan of the worktree.
2486 Loaded,
2487}
2488
2489pub struct GitRepositoryChange {
2490 /// The previous state of the repository, if it already existed.
2491 pub old_repository: Option<RepositoryEntry>,
2492}
2493
2494pub type UpdatedEntriesSet = Arc<[(Arc<Path>, ProjectEntryId, PathChange)]>;
2495pub type UpdatedGitRepositoriesSet = Arc<[(Arc<Path>, GitRepositoryChange)]>;
2496
2497impl Entry {
2498 fn new(
2499 path: Arc<Path>,
2500 metadata: &fs::Metadata,
2501 next_entry_id: &AtomicUsize,
2502 root_char_bag: CharBag,
2503 ) -> Self {
2504 Self {
2505 id: ProjectEntryId::new(next_entry_id),
2506 kind: if metadata.is_dir {
2507 EntryKind::PendingDir
2508 } else {
2509 EntryKind::File(char_bag_for_path(root_char_bag, &path))
2510 },
2511 path,
2512 inode: metadata.inode,
2513 mtime: metadata.mtime,
2514 is_symlink: metadata.is_symlink,
2515 is_ignored: false,
2516 git_status: None,
2517 }
2518 }
2519
2520 pub fn is_dir(&self) -> bool {
2521 matches!(self.kind, EntryKind::Dir | EntryKind::PendingDir)
2522 }
2523
2524 pub fn is_file(&self) -> bool {
2525 matches!(self.kind, EntryKind::File(_))
2526 }
2527
2528 pub fn git_status(&self) -> Option<GitFileStatus> {
2529 self.git_status /*.status() */
2530 }
2531}
2532
2533impl sum_tree::Item for Entry {
2534 type Summary = EntrySummary;
2535
2536 fn summary(&self) -> Self::Summary {
2537 let visible_count = if self.is_ignored { 0 } else { 1 };
2538 let file_count;
2539 let visible_file_count;
2540 if self.is_file() {
2541 file_count = 1;
2542 visible_file_count = visible_count;
2543 } else {
2544 file_count = 0;
2545 visible_file_count = 0;
2546 }
2547
2548 let mut statuses = GitStatuses::default();
2549 match self.git_status {
2550 Some(status) => match status {
2551 GitFileStatus::Added => statuses.added = 1,
2552 GitFileStatus::Modified => statuses.modified = 1,
2553 GitFileStatus::Conflict => statuses.conflict = 1,
2554 },
2555 None => {}
2556 }
2557
2558 EntrySummary {
2559 max_path: self.path.clone(),
2560 count: 1,
2561 visible_count,
2562 file_count,
2563 visible_file_count,
2564 statuses,
2565 }
2566 }
2567}
2568
2569impl sum_tree::KeyedItem for Entry {
2570 type Key = PathKey;
2571
2572 fn key(&self) -> Self::Key {
2573 PathKey(self.path.clone())
2574 }
2575}
2576
2577#[derive(Clone, Debug)]
2578pub struct EntrySummary {
2579 max_path: Arc<Path>,
2580 count: usize,
2581 visible_count: usize,
2582 file_count: usize,
2583 visible_file_count: usize,
2584 statuses: GitStatuses,
2585}
2586
2587impl Default for EntrySummary {
2588 fn default() -> Self {
2589 Self {
2590 max_path: Arc::from(Path::new("")),
2591 count: 0,
2592 visible_count: 0,
2593 file_count: 0,
2594 visible_file_count: 0,
2595 statuses: Default::default(),
2596 }
2597 }
2598}
2599
2600impl sum_tree::Summary for EntrySummary {
2601 type Context = ();
2602
2603 fn add_summary(&mut self, rhs: &Self, _: &()) {
2604 self.max_path = rhs.max_path.clone();
2605 self.count += rhs.count;
2606 self.visible_count += rhs.visible_count;
2607 self.file_count += rhs.file_count;
2608 self.visible_file_count += rhs.visible_file_count;
2609 self.statuses += rhs.statuses;
2610 }
2611}
2612
2613#[derive(Clone, Debug)]
2614struct PathEntry {
2615 id: ProjectEntryId,
2616 path: Arc<Path>,
2617 is_ignored: bool,
2618 scan_id: usize,
2619}
2620
2621impl sum_tree::Item for PathEntry {
2622 type Summary = PathEntrySummary;
2623
2624 fn summary(&self) -> Self::Summary {
2625 PathEntrySummary { max_id: self.id }
2626 }
2627}
2628
2629impl sum_tree::KeyedItem for PathEntry {
2630 type Key = ProjectEntryId;
2631
2632 fn key(&self) -> Self::Key {
2633 self.id
2634 }
2635}
2636
2637#[derive(Clone, Debug, Default)]
2638struct PathEntrySummary {
2639 max_id: ProjectEntryId,
2640}
2641
2642impl sum_tree::Summary for PathEntrySummary {
2643 type Context = ();
2644
2645 fn add_summary(&mut self, summary: &Self, _: &Self::Context) {
2646 self.max_id = summary.max_id;
2647 }
2648}
2649
2650impl<'a> sum_tree::Dimension<'a, PathEntrySummary> for ProjectEntryId {
2651 fn add_summary(&mut self, summary: &'a PathEntrySummary, _: &()) {
2652 *self = summary.max_id;
2653 }
2654}
2655
2656#[derive(Clone, Debug, Eq, PartialEq, Ord, PartialOrd)]
2657pub struct PathKey(Arc<Path>);
2658
2659impl Default for PathKey {
2660 fn default() -> Self {
2661 Self(Path::new("").into())
2662 }
2663}
2664
2665impl<'a> sum_tree::Dimension<'a, EntrySummary> for PathKey {
2666 fn add_summary(&mut self, summary: &'a EntrySummary, _: &()) {
2667 self.0 = summary.max_path.clone();
2668 }
2669}
2670
2671struct BackgroundScanner {
2672 state: Mutex<BackgroundScannerState>,
2673 fs: Arc<dyn Fs>,
2674 status_updates_tx: UnboundedSender<ScanState>,
2675 executor: Arc<executor::Background>,
2676 refresh_requests_rx: channel::Receiver<(Vec<PathBuf>, barrier::Sender)>,
2677 next_entry_id: Arc<AtomicUsize>,
2678 phase: BackgroundScannerPhase,
2679}
2680
2681#[derive(PartialEq)]
2682enum BackgroundScannerPhase {
2683 InitialScan,
2684 EventsReceivedDuringInitialScan,
2685 Events,
2686}
2687
2688impl BackgroundScanner {
2689 fn new(
2690 snapshot: LocalSnapshot,
2691 next_entry_id: Arc<AtomicUsize>,
2692 fs: Arc<dyn Fs>,
2693 status_updates_tx: UnboundedSender<ScanState>,
2694 executor: Arc<executor::Background>,
2695 refresh_requests_rx: channel::Receiver<(Vec<PathBuf>, barrier::Sender)>,
2696 ) -> Self {
2697 Self {
2698 fs,
2699 status_updates_tx,
2700 executor,
2701 refresh_requests_rx,
2702 next_entry_id,
2703 state: Mutex::new(BackgroundScannerState {
2704 prev_snapshot: snapshot.snapshot.clone(),
2705 snapshot,
2706 removed_entry_ids: Default::default(),
2707 changed_paths: Default::default(),
2708 }),
2709 phase: BackgroundScannerPhase::InitialScan,
2710 }
2711 }
2712
2713 async fn run(
2714 &mut self,
2715 mut events_rx: Pin<Box<dyn Send + Stream<Item = Vec<fsevent::Event>>>>,
2716 ) {
2717 use futures::FutureExt as _;
2718
2719 let (root_abs_path, root_inode) = {
2720 let snapshot = &self.state.lock().snapshot;
2721 (
2722 snapshot.abs_path.clone(),
2723 snapshot.root_entry().map(|e| e.inode),
2724 )
2725 };
2726
2727 // Populate ignores above the root.
2728 let ignore_stack;
2729 for ancestor in root_abs_path.ancestors().skip(1) {
2730 if let Ok(ignore) = build_gitignore(&ancestor.join(&*GITIGNORE), self.fs.as_ref()).await
2731 {
2732 self.state
2733 .lock()
2734 .snapshot
2735 .ignores_by_parent_abs_path
2736 .insert(ancestor.into(), (ignore.into(), false));
2737 }
2738 }
2739 {
2740 let mut state = self.state.lock();
2741 state.snapshot.scan_id += 1;
2742 ignore_stack = state
2743 .snapshot
2744 .ignore_stack_for_abs_path(&root_abs_path, true);
2745 if ignore_stack.is_all() {
2746 if let Some(mut root_entry) = state.snapshot.root_entry().cloned() {
2747 root_entry.is_ignored = true;
2748 state.insert_entry(root_entry, self.fs.as_ref());
2749 }
2750 }
2751 };
2752
2753 // Perform an initial scan of the directory.
2754 let (scan_job_tx, scan_job_rx) = channel::unbounded();
2755 smol::block_on(scan_job_tx.send(ScanJob {
2756 abs_path: root_abs_path,
2757 path: Arc::from(Path::new("")),
2758 ignore_stack,
2759 ancestor_inodes: TreeSet::from_ordered_entries(root_inode),
2760 scan_queue: scan_job_tx.clone(),
2761 }))
2762 .unwrap();
2763 drop(scan_job_tx);
2764 self.scan_dirs(true, scan_job_rx).await;
2765 {
2766 let mut state = self.state.lock();
2767 state.snapshot.completed_scan_id = state.snapshot.scan_id;
2768 }
2769
2770 self.send_status_update(false, None);
2771
2772 // Process any any FS events that occurred while performing the initial scan.
2773 // For these events, update events cannot be as precise, because we didn't
2774 // have the previous state loaded yet.
2775 self.phase = BackgroundScannerPhase::EventsReceivedDuringInitialScan;
2776 if let Poll::Ready(Some(events)) = futures::poll!(events_rx.next()) {
2777 let mut paths = events.into_iter().map(|e| e.path).collect::<Vec<_>>();
2778 while let Poll::Ready(Some(more_events)) = futures::poll!(events_rx.next()) {
2779 paths.extend(more_events.into_iter().map(|e| e.path));
2780 }
2781 self.process_events(paths).await;
2782 }
2783
2784 // Continue processing events until the worktree is dropped.
2785 self.phase = BackgroundScannerPhase::Events;
2786 loop {
2787 select_biased! {
2788 // Process any path refresh requests from the worktree. Prioritize
2789 // these before handling changes reported by the filesystem.
2790 request = self.refresh_requests_rx.recv().fuse() => {
2791 let Ok((paths, barrier)) = request else { break };
2792 if !self.process_refresh_request(paths.clone(), barrier).await {
2793 return;
2794 }
2795 }
2796
2797 events = events_rx.next().fuse() => {
2798 let Some(events) = events else { break };
2799 let mut paths = events.into_iter().map(|e| e.path).collect::<Vec<_>>();
2800 while let Poll::Ready(Some(more_events)) = futures::poll!(events_rx.next()) {
2801 paths.extend(more_events.into_iter().map(|e| e.path));
2802 }
2803 self.process_events(paths.clone()).await;
2804 }
2805 }
2806 }
2807 }
2808
2809 async fn process_refresh_request(&self, paths: Vec<PathBuf>, barrier: barrier::Sender) -> bool {
2810 self.reload_entries_for_paths(paths, None).await;
2811 self.send_status_update(false, Some(barrier))
2812 }
2813
2814 async fn process_events(&mut self, paths: Vec<PathBuf>) {
2815 let (scan_job_tx, scan_job_rx) = channel::unbounded();
2816 let paths = self
2817 .reload_entries_for_paths(paths, Some(scan_job_tx.clone()))
2818 .await;
2819 drop(scan_job_tx);
2820 self.scan_dirs(false, scan_job_rx).await;
2821
2822 self.update_ignore_statuses().await;
2823
2824 {
2825 let mut snapshot = &mut self.state.lock().snapshot;
2826
2827 if let Some(paths) = paths {
2828 for path in paths {
2829 self.reload_git_repo(&path, &mut *snapshot, self.fs.as_ref());
2830 }
2831 }
2832
2833 let mut git_repositories = mem::take(&mut snapshot.git_repositories);
2834 git_repositories.retain(|work_directory_id, _| {
2835 snapshot
2836 .entry_for_id(*work_directory_id)
2837 .map_or(false, |entry| {
2838 snapshot.entry_for_path(entry.path.join(*DOT_GIT)).is_some()
2839 })
2840 });
2841 snapshot.git_repositories = git_repositories;
2842
2843 let mut git_repository_entries = mem::take(&mut snapshot.snapshot.repository_entries);
2844 git_repository_entries.retain(|_, entry| {
2845 snapshot
2846 .git_repositories
2847 .get(&entry.work_directory.0)
2848 .is_some()
2849 });
2850 snapshot.snapshot.repository_entries = git_repository_entries;
2851 snapshot.completed_scan_id = snapshot.scan_id;
2852 }
2853
2854 self.send_status_update(false, None);
2855 }
2856
2857 async fn scan_dirs(
2858 &self,
2859 enable_progress_updates: bool,
2860 scan_jobs_rx: channel::Receiver<ScanJob>,
2861 ) {
2862 use futures::FutureExt as _;
2863
2864 if self
2865 .status_updates_tx
2866 .unbounded_send(ScanState::Started)
2867 .is_err()
2868 {
2869 return;
2870 }
2871
2872 let progress_update_count = AtomicUsize::new(0);
2873 self.executor
2874 .scoped(|scope| {
2875 for _ in 0..self.executor.num_cpus() {
2876 scope.spawn(async {
2877 let mut last_progress_update_count = 0;
2878 let progress_update_timer = self.progress_timer(enable_progress_updates).fuse();
2879 futures::pin_mut!(progress_update_timer);
2880
2881 loop {
2882 select_biased! {
2883 // Process any path refresh requests before moving on to process
2884 // the scan queue, so that user operations are prioritized.
2885 request = self.refresh_requests_rx.recv().fuse() => {
2886 let Ok((paths, barrier)) = request else { break };
2887 if !self.process_refresh_request(paths, barrier).await {
2888 return;
2889 }
2890 }
2891
2892 // Send periodic progress updates to the worktree. Use an atomic counter
2893 // to ensure that only one of the workers sends a progress update after
2894 // the update interval elapses.
2895 _ = progress_update_timer => {
2896 match progress_update_count.compare_exchange(
2897 last_progress_update_count,
2898 last_progress_update_count + 1,
2899 SeqCst,
2900 SeqCst
2901 ) {
2902 Ok(_) => {
2903 last_progress_update_count += 1;
2904 self.send_status_update(true, None);
2905 }
2906 Err(count) => {
2907 last_progress_update_count = count;
2908 }
2909 }
2910 progress_update_timer.set(self.progress_timer(enable_progress_updates).fuse());
2911 }
2912
2913 // Recursively load directories from the file system.
2914 job = scan_jobs_rx.recv().fuse() => {
2915 let Ok(job) = job else { break };
2916 if let Err(err) = self.scan_dir(&job).await {
2917 if job.path.as_ref() != Path::new("") {
2918 log::error!("error scanning directory {:?}: {}", job.abs_path, err);
2919 }
2920 }
2921 }
2922 }
2923 }
2924 })
2925 }
2926 })
2927 .await;
2928 }
2929
2930 fn send_status_update(&self, scanning: bool, barrier: Option<barrier::Sender>) -> bool {
2931 let mut state = self.state.lock();
2932 if state.changed_paths.is_empty() && scanning {
2933 return true;
2934 }
2935
2936 let new_snapshot = state.snapshot.clone();
2937 let old_snapshot = mem::replace(&mut state.prev_snapshot, new_snapshot.snapshot.clone());
2938 let changes = self.build_change_set(&old_snapshot, &new_snapshot, &state.changed_paths);
2939 state.changed_paths.clear();
2940
2941 self.status_updates_tx
2942 .unbounded_send(ScanState::Updated {
2943 snapshot: new_snapshot,
2944 changes,
2945 scanning,
2946 barrier,
2947 })
2948 .is_ok()
2949 }
2950
2951 async fn scan_dir(&self, job: &ScanJob) -> Result<()> {
2952 let mut new_entries: Vec<Entry> = Vec::new();
2953 let mut new_jobs: Vec<Option<ScanJob>> = Vec::new();
2954 let mut ignore_stack = job.ignore_stack.clone();
2955 let mut new_ignore = None;
2956 let (root_abs_path, root_char_bag, next_entry_id, repository) = {
2957 let snapshot = &self.state.lock().snapshot;
2958 (
2959 snapshot.abs_path().clone(),
2960 snapshot.root_char_bag,
2961 self.next_entry_id.clone(),
2962 snapshot
2963 .local_repo_for_path(&job.path)
2964 .map(|(work_dir, repo)| (work_dir, repo.clone())),
2965 )
2966 };
2967
2968 let mut child_paths = self.fs.read_dir(&job.abs_path).await?;
2969 while let Some(child_abs_path) = child_paths.next().await {
2970 let child_abs_path: Arc<Path> = match child_abs_path {
2971 Ok(child_abs_path) => child_abs_path.into(),
2972 Err(error) => {
2973 log::error!("error processing entry {:?}", error);
2974 continue;
2975 }
2976 };
2977
2978 let child_name = child_abs_path.file_name().unwrap();
2979 let child_path: Arc<Path> = job.path.join(child_name).into();
2980 let child_metadata = match self.fs.metadata(&child_abs_path).await {
2981 Ok(Some(metadata)) => metadata,
2982 Ok(None) => continue,
2983 Err(err) => {
2984 log::error!("error processing {:?}: {:?}", child_abs_path, err);
2985 continue;
2986 }
2987 };
2988
2989 // If we find a .gitignore, add it to the stack of ignores used to determine which paths are ignored
2990 if child_name == *GITIGNORE {
2991 match build_gitignore(&child_abs_path, self.fs.as_ref()).await {
2992 Ok(ignore) => {
2993 let ignore = Arc::new(ignore);
2994 ignore_stack = ignore_stack.append(job.abs_path.clone(), ignore.clone());
2995 new_ignore = Some(ignore);
2996 }
2997 Err(error) => {
2998 log::error!(
2999 "error loading .gitignore file {:?} - {:?}",
3000 child_name,
3001 error
3002 );
3003 }
3004 }
3005
3006 // Update ignore status of any child entries we've already processed to reflect the
3007 // ignore file in the current directory. Because `.gitignore` starts with a `.`,
3008 // there should rarely be too numerous. Update the ignore stack associated with any
3009 // new jobs as well.
3010 let mut new_jobs = new_jobs.iter_mut();
3011 for entry in &mut new_entries {
3012 let entry_abs_path = root_abs_path.join(&entry.path);
3013 entry.is_ignored =
3014 ignore_stack.is_abs_path_ignored(&entry_abs_path, entry.is_dir());
3015
3016 if entry.is_dir() {
3017 if let Some(job) = new_jobs.next().expect("Missing scan job for entry") {
3018 job.ignore_stack = if entry.is_ignored {
3019 IgnoreStack::all()
3020 } else {
3021 ignore_stack.clone()
3022 };
3023 }
3024 }
3025 }
3026 }
3027
3028 let mut child_entry = Entry::new(
3029 child_path.clone(),
3030 &child_metadata,
3031 &next_entry_id,
3032 root_char_bag,
3033 );
3034
3035 if child_entry.is_dir() {
3036 let is_ignored = ignore_stack.is_abs_path_ignored(&child_abs_path, true);
3037 child_entry.is_ignored = is_ignored;
3038
3039 // Avoid recursing until crash in the case of a recursive symlink
3040 if !job.ancestor_inodes.contains(&child_entry.inode) {
3041 let mut ancestor_inodes = job.ancestor_inodes.clone();
3042 ancestor_inodes.insert(child_entry.inode);
3043
3044 new_jobs.push(Some(ScanJob {
3045 abs_path: child_abs_path,
3046 path: child_path,
3047 ignore_stack: if is_ignored {
3048 IgnoreStack::all()
3049 } else {
3050 ignore_stack.clone()
3051 },
3052 ancestor_inodes,
3053 scan_queue: job.scan_queue.clone(),
3054 }));
3055 } else {
3056 new_jobs.push(None);
3057 }
3058 } else {
3059 child_entry.is_ignored = ignore_stack.is_abs_path_ignored(&child_abs_path, false);
3060
3061 if let Some((repo_path, repo)) = &repository {
3062 if let Ok(path) = child_path.strip_prefix(&repo_path.0) {
3063 child_entry.git_status =
3064 repo.repo_ptr.lock().status(&RepoPath(path.into()));
3065 }
3066 }
3067 }
3068
3069 new_entries.push(child_entry);
3070 }
3071
3072 {
3073 let mut state = self.state.lock();
3074 state.populate_dir(job.path.clone(), new_entries, new_ignore, self.fs.as_ref());
3075 if let Err(ix) = state.changed_paths.binary_search(&job.path) {
3076 state.changed_paths.insert(ix, job.path.clone());
3077 }
3078 }
3079
3080 for new_job in new_jobs {
3081 if let Some(new_job) = new_job {
3082 job.scan_queue.send(new_job).await.unwrap();
3083 }
3084 }
3085
3086 Ok(())
3087 }
3088
3089 async fn reload_entries_for_paths(
3090 &self,
3091 mut abs_paths: Vec<PathBuf>,
3092 scan_queue_tx: Option<Sender<ScanJob>>,
3093 ) -> Option<Vec<Arc<Path>>> {
3094 let doing_recursive_update = scan_queue_tx.is_some();
3095
3096 abs_paths.sort_unstable();
3097 abs_paths.dedup_by(|a, b| a.starts_with(&b));
3098
3099 let root_abs_path = self.state.lock().snapshot.abs_path.clone();
3100 let root_canonical_path = self.fs.canonicalize(&root_abs_path).await.log_err()?;
3101 let metadata = futures::future::join_all(
3102 abs_paths
3103 .iter()
3104 .map(|abs_path| self.fs.metadata(&abs_path))
3105 .collect::<Vec<_>>(),
3106 )
3107 .await;
3108
3109 let mut state = self.state.lock();
3110 let snapshot = &mut state.snapshot;
3111 let is_idle = snapshot.completed_scan_id == snapshot.scan_id;
3112 snapshot.scan_id += 1;
3113 if is_idle && !doing_recursive_update {
3114 snapshot.completed_scan_id = snapshot.scan_id;
3115 }
3116
3117 // Remove any entries for paths that no longer exist or are being recursively
3118 // refreshed. Do this before adding any new entries, so that renames can be
3119 // detected regardless of the order of the paths.
3120 let mut event_paths = Vec::<Arc<Path>>::with_capacity(abs_paths.len());
3121 for (abs_path, metadata) in abs_paths.iter().zip(metadata.iter()) {
3122 if let Ok(path) = abs_path.strip_prefix(&root_canonical_path) {
3123 if matches!(metadata, Ok(None)) || doing_recursive_update {
3124 state.remove_path(path);
3125 }
3126 event_paths.push(path.into());
3127 } else {
3128 log::error!(
3129 "unexpected event {:?} for root path {:?}",
3130 abs_path,
3131 root_canonical_path
3132 );
3133 }
3134 }
3135
3136 for (path, metadata) in event_paths.iter().cloned().zip(metadata.into_iter()) {
3137 let abs_path: Arc<Path> = root_abs_path.join(&path).into();
3138
3139 match metadata {
3140 Ok(Some(metadata)) => {
3141 let ignore_stack = state
3142 .snapshot
3143 .ignore_stack_for_abs_path(&abs_path, metadata.is_dir);
3144
3145 let mut fs_entry = Entry::new(
3146 path.clone(),
3147 &metadata,
3148 self.next_entry_id.as_ref(),
3149 state.snapshot.root_char_bag,
3150 );
3151 fs_entry.is_ignored = ignore_stack.is_all();
3152
3153 if !fs_entry.is_dir() {
3154 if let Some((work_dir, repo)) = state.snapshot.local_repo_for_path(&path) {
3155 if let Ok(path) = path.strip_prefix(work_dir.0) {
3156 fs_entry.git_status =
3157 repo.repo_ptr.lock().status(&RepoPath(path.into()))
3158 }
3159 }
3160 }
3161
3162 state.insert_entry(fs_entry, self.fs.as_ref());
3163
3164 if let Some(scan_queue_tx) = &scan_queue_tx {
3165 let mut ancestor_inodes = state.snapshot.ancestor_inodes_for_path(&path);
3166 if metadata.is_dir && !ancestor_inodes.contains(&metadata.inode) {
3167 ancestor_inodes.insert(metadata.inode);
3168 smol::block_on(scan_queue_tx.send(ScanJob {
3169 abs_path,
3170 path,
3171 ignore_stack,
3172 ancestor_inodes,
3173 scan_queue: scan_queue_tx.clone(),
3174 }))
3175 .unwrap();
3176 }
3177 }
3178 }
3179 Ok(None) => {
3180 self.remove_repo_path(&path, &mut state.snapshot);
3181 }
3182 Err(err) => {
3183 // TODO - create a special 'error' entry in the entries tree to mark this
3184 log::error!("error reading file on event {:?}", err);
3185 }
3186 }
3187 }
3188
3189 util::extend_sorted(
3190 &mut state.changed_paths,
3191 event_paths.iter().cloned(),
3192 usize::MAX,
3193 Ord::cmp,
3194 );
3195
3196 Some(event_paths)
3197 }
3198
3199 fn remove_repo_path(&self, path: &Path, snapshot: &mut LocalSnapshot) -> Option<()> {
3200 if !path
3201 .components()
3202 .any(|component| component.as_os_str() == *DOT_GIT)
3203 {
3204 if let Some(repository) = snapshot.repository_for_work_directory(path) {
3205 let entry = repository.work_directory.0;
3206 snapshot.git_repositories.remove(&entry);
3207 snapshot
3208 .snapshot
3209 .repository_entries
3210 .remove(&RepositoryWorkDirectory(path.into()));
3211 return Some(());
3212 }
3213 }
3214
3215 // TODO statuses
3216 // Track when a .git is removed and iterate over the file system there
3217
3218 Some(())
3219 }
3220
3221 fn reload_git_repo(
3222 &self,
3223 path: &Path,
3224 snapshot: &mut LocalSnapshot,
3225 fs: &dyn Fs,
3226 ) -> Option<()> {
3227 let scan_id = snapshot.scan_id;
3228
3229 if path
3230 .components()
3231 .any(|component| component.as_os_str() == *DOT_GIT)
3232 {
3233 let (entry_id, repo_ptr) = {
3234 let Some((entry_id, repo)) = snapshot.repo_for_metadata(&path) else {
3235 let dot_git_dir = path.ancestors()
3236 .skip_while(|ancestor| ancestor.file_name() != Some(&*DOT_GIT))
3237 .next()?;
3238
3239 snapshot.build_repo(dot_git_dir.into(), fs);
3240 return None;
3241 };
3242 if repo.git_dir_scan_id == scan_id {
3243 return None;
3244 }
3245
3246 (*entry_id, repo.repo_ptr.to_owned())
3247 };
3248
3249 let work_dir = snapshot
3250 .entry_for_id(entry_id)
3251 .map(|entry| RepositoryWorkDirectory(entry.path.clone()))?;
3252
3253 let repo = repo_ptr.lock();
3254 repo.reload_index();
3255 let branch = repo.branch_name();
3256
3257 snapshot.git_repositories.update(&entry_id, |entry| {
3258 entry.git_dir_scan_id = scan_id;
3259 });
3260
3261 snapshot
3262 .snapshot
3263 .repository_entries
3264 .update(&work_dir, |entry| {
3265 entry.branch = branch.map(Into::into);
3266 });
3267
3268 snapshot.scan_statuses(repo.deref(), &work_dir);
3269 }
3270
3271 Some(())
3272 }
3273
3274 async fn update_ignore_statuses(&self) {
3275 use futures::FutureExt as _;
3276
3277 let mut snapshot = self.state.lock().snapshot.clone();
3278 let mut ignores_to_update = Vec::new();
3279 let mut ignores_to_delete = Vec::new();
3280 let abs_path = snapshot.abs_path.clone();
3281 for (parent_abs_path, (_, needs_update)) in &mut snapshot.ignores_by_parent_abs_path {
3282 if let Ok(parent_path) = parent_abs_path.strip_prefix(&abs_path) {
3283 if *needs_update {
3284 *needs_update = false;
3285 if snapshot.snapshot.entry_for_path(parent_path).is_some() {
3286 ignores_to_update.push(parent_abs_path.clone());
3287 }
3288 }
3289
3290 let ignore_path = parent_path.join(&*GITIGNORE);
3291 if snapshot.snapshot.entry_for_path(ignore_path).is_none() {
3292 ignores_to_delete.push(parent_abs_path.clone());
3293 }
3294 }
3295 }
3296
3297 for parent_abs_path in ignores_to_delete {
3298 snapshot.ignores_by_parent_abs_path.remove(&parent_abs_path);
3299 self.state
3300 .lock()
3301 .snapshot
3302 .ignores_by_parent_abs_path
3303 .remove(&parent_abs_path);
3304 }
3305
3306 let (ignore_queue_tx, ignore_queue_rx) = channel::unbounded();
3307 ignores_to_update.sort_unstable();
3308 let mut ignores_to_update = ignores_to_update.into_iter().peekable();
3309 while let Some(parent_abs_path) = ignores_to_update.next() {
3310 while ignores_to_update
3311 .peek()
3312 .map_or(false, |p| p.starts_with(&parent_abs_path))
3313 {
3314 ignores_to_update.next().unwrap();
3315 }
3316
3317 let ignore_stack = snapshot.ignore_stack_for_abs_path(&parent_abs_path, true);
3318 smol::block_on(ignore_queue_tx.send(UpdateIgnoreStatusJob {
3319 abs_path: parent_abs_path,
3320 ignore_stack,
3321 ignore_queue: ignore_queue_tx.clone(),
3322 }))
3323 .unwrap();
3324 }
3325 drop(ignore_queue_tx);
3326
3327 self.executor
3328 .scoped(|scope| {
3329 for _ in 0..self.executor.num_cpus() {
3330 scope.spawn(async {
3331 loop {
3332 select_biased! {
3333 // Process any path refresh requests before moving on to process
3334 // the queue of ignore statuses.
3335 request = self.refresh_requests_rx.recv().fuse() => {
3336 let Ok((paths, barrier)) = request else { break };
3337 if !self.process_refresh_request(paths, barrier).await {
3338 return;
3339 }
3340 }
3341
3342 // Recursively process directories whose ignores have changed.
3343 job = ignore_queue_rx.recv().fuse() => {
3344 let Ok(job) = job else { break };
3345 self.update_ignore_status(job, &snapshot).await;
3346 }
3347 }
3348 }
3349 });
3350 }
3351 })
3352 .await;
3353 }
3354
3355 async fn update_ignore_status(&self, job: UpdateIgnoreStatusJob, snapshot: &LocalSnapshot) {
3356 let mut ignore_stack = job.ignore_stack;
3357 if let Some((ignore, _)) = snapshot.ignores_by_parent_abs_path.get(&job.abs_path) {
3358 ignore_stack = ignore_stack.append(job.abs_path.clone(), ignore.clone());
3359 }
3360
3361 let mut entries_by_id_edits = Vec::new();
3362 let mut entries_by_path_edits = Vec::new();
3363 let path = job.abs_path.strip_prefix(&snapshot.abs_path).unwrap();
3364 for mut entry in snapshot.child_entries(path).cloned() {
3365 let was_ignored = entry.is_ignored;
3366 let abs_path = snapshot.abs_path().join(&entry.path);
3367 entry.is_ignored = ignore_stack.is_abs_path_ignored(&abs_path, entry.is_dir());
3368 if entry.is_dir() {
3369 let child_ignore_stack = if entry.is_ignored {
3370 IgnoreStack::all()
3371 } else {
3372 ignore_stack.clone()
3373 };
3374 job.ignore_queue
3375 .send(UpdateIgnoreStatusJob {
3376 abs_path: abs_path.into(),
3377 ignore_stack: child_ignore_stack,
3378 ignore_queue: job.ignore_queue.clone(),
3379 })
3380 .await
3381 .unwrap();
3382 }
3383
3384 if entry.is_ignored != was_ignored {
3385 let mut path_entry = snapshot.entries_by_id.get(&entry.id, &()).unwrap().clone();
3386 path_entry.scan_id = snapshot.scan_id;
3387 path_entry.is_ignored = entry.is_ignored;
3388 entries_by_id_edits.push(Edit::Insert(path_entry));
3389 entries_by_path_edits.push(Edit::Insert(entry));
3390 }
3391 }
3392
3393 let state = &mut self.state.lock();
3394 for edit in &entries_by_path_edits {
3395 if let Edit::Insert(entry) = edit {
3396 if let Err(ix) = state.changed_paths.binary_search(&entry.path) {
3397 state.changed_paths.insert(ix, entry.path.clone());
3398 }
3399 }
3400 }
3401
3402 state
3403 .snapshot
3404 .entries_by_path
3405 .edit(entries_by_path_edits, &());
3406 state.snapshot.entries_by_id.edit(entries_by_id_edits, &());
3407 }
3408
3409 fn build_change_set(
3410 &self,
3411 old_snapshot: &Snapshot,
3412 new_snapshot: &Snapshot,
3413 event_paths: &[Arc<Path>],
3414 ) -> UpdatedEntriesSet {
3415 use BackgroundScannerPhase::*;
3416 use PathChange::{Added, AddedOrUpdated, Loaded, Removed, Updated};
3417
3418 // Identify which paths have changed. Use the known set of changed
3419 // parent paths to optimize the search.
3420 let mut changes = Vec::new();
3421 let mut old_paths = old_snapshot.entries_by_path.cursor::<PathKey>();
3422 let mut new_paths = new_snapshot.entries_by_path.cursor::<PathKey>();
3423 old_paths.next(&());
3424 new_paths.next(&());
3425 for path in event_paths {
3426 let path = PathKey(path.clone());
3427 if old_paths.item().map_or(false, |e| e.path < path.0) {
3428 old_paths.seek_forward(&path, Bias::Left, &());
3429 }
3430 if new_paths.item().map_or(false, |e| e.path < path.0) {
3431 new_paths.seek_forward(&path, Bias::Left, &());
3432 }
3433
3434 loop {
3435 match (old_paths.item(), new_paths.item()) {
3436 (Some(old_entry), Some(new_entry)) => {
3437 if old_entry.path > path.0
3438 && new_entry.path > path.0
3439 && !old_entry.path.starts_with(&path.0)
3440 && !new_entry.path.starts_with(&path.0)
3441 {
3442 break;
3443 }
3444
3445 match Ord::cmp(&old_entry.path, &new_entry.path) {
3446 Ordering::Less => {
3447 changes.push((old_entry.path.clone(), old_entry.id, Removed));
3448 old_paths.next(&());
3449 }
3450 Ordering::Equal => {
3451 if self.phase == EventsReceivedDuringInitialScan {
3452 // If the worktree was not fully initialized when this event was generated,
3453 // we can't know whether this entry was added during the scan or whether
3454 // it was merely updated.
3455 changes.push((
3456 new_entry.path.clone(),
3457 new_entry.id,
3458 AddedOrUpdated,
3459 ));
3460 } else if old_entry.id != new_entry.id {
3461 changes.push((old_entry.path.clone(), old_entry.id, Removed));
3462 changes.push((new_entry.path.clone(), new_entry.id, Added));
3463 } else if old_entry != new_entry {
3464 changes.push((new_entry.path.clone(), new_entry.id, Updated));
3465 }
3466 old_paths.next(&());
3467 new_paths.next(&());
3468 }
3469 Ordering::Greater => {
3470 changes.push((
3471 new_entry.path.clone(),
3472 new_entry.id,
3473 if self.phase == InitialScan {
3474 Loaded
3475 } else {
3476 Added
3477 },
3478 ));
3479 new_paths.next(&());
3480 }
3481 }
3482 }
3483 (Some(old_entry), None) => {
3484 changes.push((old_entry.path.clone(), old_entry.id, Removed));
3485 old_paths.next(&());
3486 }
3487 (None, Some(new_entry)) => {
3488 changes.push((
3489 new_entry.path.clone(),
3490 new_entry.id,
3491 if self.phase == InitialScan {
3492 Loaded
3493 } else {
3494 Added
3495 },
3496 ));
3497 new_paths.next(&());
3498 }
3499 (None, None) => break,
3500 }
3501 }
3502 }
3503
3504 changes.into()
3505 }
3506
3507 async fn progress_timer(&self, running: bool) {
3508 if !running {
3509 return futures::future::pending().await;
3510 }
3511
3512 #[cfg(any(test, feature = "test-support"))]
3513 if self.fs.is_fake() {
3514 return self.executor.simulate_random_delay().await;
3515 }
3516
3517 smol::Timer::after(Duration::from_millis(100)).await;
3518 }
3519}
3520
3521fn char_bag_for_path(root_char_bag: CharBag, path: &Path) -> CharBag {
3522 let mut result = root_char_bag;
3523 result.extend(
3524 path.to_string_lossy()
3525 .chars()
3526 .map(|c| c.to_ascii_lowercase()),
3527 );
3528 result
3529}
3530
3531struct ScanJob {
3532 abs_path: Arc<Path>,
3533 path: Arc<Path>,
3534 ignore_stack: Arc<IgnoreStack>,
3535 scan_queue: Sender<ScanJob>,
3536 ancestor_inodes: TreeSet<u64>,
3537}
3538
3539struct UpdateIgnoreStatusJob {
3540 abs_path: Arc<Path>,
3541 ignore_stack: Arc<IgnoreStack>,
3542 ignore_queue: Sender<UpdateIgnoreStatusJob>,
3543}
3544
3545pub trait WorktreeHandle {
3546 #[cfg(any(test, feature = "test-support"))]
3547 fn flush_fs_events<'a>(
3548 &self,
3549 cx: &'a gpui::TestAppContext,
3550 ) -> futures::future::LocalBoxFuture<'a, ()>;
3551}
3552
3553impl WorktreeHandle for ModelHandle<Worktree> {
3554 // When the worktree's FS event stream sometimes delivers "redundant" events for FS changes that
3555 // occurred before the worktree was constructed. These events can cause the worktree to perfrom
3556 // extra directory scans, and emit extra scan-state notifications.
3557 //
3558 // This function mutates the worktree's directory and waits for those mutations to be picked up,
3559 // to ensure that all redundant FS events have already been processed.
3560 #[cfg(any(test, feature = "test-support"))]
3561 fn flush_fs_events<'a>(
3562 &self,
3563 cx: &'a gpui::TestAppContext,
3564 ) -> futures::future::LocalBoxFuture<'a, ()> {
3565 let filename = "fs-event-sentinel";
3566 let tree = self.clone();
3567 let (fs, root_path) = self.read_with(cx, |tree, _| {
3568 let tree = tree.as_local().unwrap();
3569 (tree.fs.clone(), tree.abs_path().clone())
3570 });
3571
3572 async move {
3573 fs.create_file(&root_path.join(filename), Default::default())
3574 .await
3575 .unwrap();
3576 tree.condition(cx, |tree, _| tree.entry_for_path(filename).is_some())
3577 .await;
3578
3579 fs.remove_file(&root_path.join(filename), Default::default())
3580 .await
3581 .unwrap();
3582 tree.condition(cx, |tree, _| tree.entry_for_path(filename).is_none())
3583 .await;
3584
3585 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
3586 .await;
3587 }
3588 .boxed_local()
3589 }
3590}
3591
3592#[derive(Clone, Debug)]
3593struct TraversalProgress<'a> {
3594 max_path: &'a Path,
3595 count: usize,
3596 visible_count: usize,
3597 file_count: usize,
3598 visible_file_count: usize,
3599}
3600
3601impl<'a> TraversalProgress<'a> {
3602 fn count(&self, include_dirs: bool, include_ignored: bool) -> usize {
3603 match (include_ignored, include_dirs) {
3604 (true, true) => self.count,
3605 (true, false) => self.file_count,
3606 (false, true) => self.visible_count,
3607 (false, false) => self.visible_file_count,
3608 }
3609 }
3610}
3611
3612impl<'a> sum_tree::Dimension<'a, EntrySummary> for TraversalProgress<'a> {
3613 fn add_summary(&mut self, summary: &'a EntrySummary, _: &()) {
3614 self.max_path = summary.max_path.as_ref();
3615 self.count += summary.count;
3616 self.visible_count += summary.visible_count;
3617 self.file_count += summary.file_count;
3618 self.visible_file_count += summary.visible_file_count;
3619 }
3620}
3621
3622impl<'a> Default for TraversalProgress<'a> {
3623 fn default() -> Self {
3624 Self {
3625 max_path: Path::new(""),
3626 count: 0,
3627 visible_count: 0,
3628 file_count: 0,
3629 visible_file_count: 0,
3630 }
3631 }
3632}
3633
3634#[derive(Clone, Debug, Default, Copy)]
3635struct GitStatuses {
3636 added: usize,
3637 modified: usize,
3638 conflict: usize,
3639}
3640
3641impl AddAssign for GitStatuses {
3642 fn add_assign(&mut self, rhs: Self) {
3643 self.added += rhs.added;
3644 self.modified += rhs.modified;
3645 self.conflict += rhs.conflict;
3646 }
3647}
3648
3649impl Sub for GitStatuses {
3650 type Output = GitStatuses;
3651
3652 fn sub(self, rhs: Self) -> Self::Output {
3653 GitStatuses {
3654 added: self.added - rhs.added,
3655 modified: self.modified - rhs.modified,
3656 conflict: self.conflict - rhs.conflict,
3657 }
3658 }
3659}
3660
3661impl<'a> sum_tree::Dimension<'a, EntrySummary> for GitStatuses {
3662 fn add_summary(&mut self, summary: &'a EntrySummary, _: &()) {
3663 *self += summary.statuses
3664 }
3665}
3666
3667pub struct Traversal<'a> {
3668 cursor: sum_tree::Cursor<'a, Entry, TraversalProgress<'a>>,
3669 include_ignored: bool,
3670 include_dirs: bool,
3671}
3672
3673impl<'a> Traversal<'a> {
3674 pub fn advance(&mut self) -> bool {
3675 self.cursor.seek_forward(
3676 &TraversalTarget::Count {
3677 count: self.end_offset() + 1,
3678 include_dirs: self.include_dirs,
3679 include_ignored: self.include_ignored,
3680 },
3681 Bias::Left,
3682 &(),
3683 )
3684 }
3685
3686 pub fn advance_to_sibling(&mut self) -> bool {
3687 while let Some(entry) = self.cursor.item() {
3688 self.cursor.seek_forward(
3689 &TraversalTarget::PathSuccessor(&entry.path),
3690 Bias::Left,
3691 &(),
3692 );
3693 if let Some(entry) = self.cursor.item() {
3694 if (self.include_dirs || !entry.is_dir())
3695 && (self.include_ignored || !entry.is_ignored)
3696 {
3697 return true;
3698 }
3699 }
3700 }
3701 false
3702 }
3703
3704 pub fn entry(&self) -> Option<&'a Entry> {
3705 self.cursor.item()
3706 }
3707
3708 pub fn start_offset(&self) -> usize {
3709 self.cursor
3710 .start()
3711 .count(self.include_dirs, self.include_ignored)
3712 }
3713
3714 pub fn end_offset(&self) -> usize {
3715 self.cursor
3716 .end(&())
3717 .count(self.include_dirs, self.include_ignored)
3718 }
3719}
3720
3721impl<'a> Iterator for Traversal<'a> {
3722 type Item = &'a Entry;
3723
3724 fn next(&mut self) -> Option<Self::Item> {
3725 if let Some(item) = self.entry() {
3726 self.advance();
3727 Some(item)
3728 } else {
3729 None
3730 }
3731 }
3732}
3733
3734#[derive(Debug)]
3735enum TraversalTarget<'a> {
3736 Path(&'a Path),
3737 PathSuccessor(&'a Path),
3738 Count {
3739 count: usize,
3740 include_ignored: bool,
3741 include_dirs: bool,
3742 },
3743}
3744
3745impl<'a, 'b> SeekTarget<'a, EntrySummary, TraversalProgress<'a>> for TraversalTarget<'b> {
3746 fn cmp(&self, cursor_location: &TraversalProgress<'a>, _: &()) -> Ordering {
3747 match self {
3748 TraversalTarget::Path(path) => path.cmp(&cursor_location.max_path),
3749 TraversalTarget::PathSuccessor(path) => {
3750 if !cursor_location.max_path.starts_with(path) {
3751 Ordering::Equal
3752 } else {
3753 Ordering::Greater
3754 }
3755 }
3756 TraversalTarget::Count {
3757 count,
3758 include_dirs,
3759 include_ignored,
3760 } => Ord::cmp(
3761 count,
3762 &cursor_location.count(*include_dirs, *include_ignored),
3763 ),
3764 }
3765 }
3766}
3767
3768impl<'a, 'b> SeekTarget<'a, EntrySummary, (TraversalProgress<'a>, GitStatuses)>
3769 for TraversalTarget<'b>
3770{
3771 fn cmp(&self, cursor_location: &(TraversalProgress<'a>, GitStatuses), _: &()) -> Ordering {
3772 self.cmp(&cursor_location.0, &())
3773 }
3774}
3775
3776struct ChildEntriesIter<'a> {
3777 parent_path: &'a Path,
3778 traversal: Traversal<'a>,
3779}
3780
3781impl<'a> Iterator for ChildEntriesIter<'a> {
3782 type Item = &'a Entry;
3783
3784 fn next(&mut self) -> Option<Self::Item> {
3785 if let Some(item) = self.traversal.entry() {
3786 if item.path.starts_with(&self.parent_path) {
3787 self.traversal.advance_to_sibling();
3788 return Some(item);
3789 }
3790 }
3791 None
3792 }
3793}
3794
3795struct DescendentEntriesIter<'a> {
3796 parent_path: &'a Path,
3797 traversal: Traversal<'a>,
3798}
3799
3800impl<'a> Iterator for DescendentEntriesIter<'a> {
3801 type Item = &'a Entry;
3802
3803 fn next(&mut self) -> Option<Self::Item> {
3804 if let Some(item) = self.traversal.entry() {
3805 if item.path.starts_with(&self.parent_path) {
3806 self.traversal.advance();
3807 return Some(item);
3808 }
3809 }
3810 None
3811 }
3812}
3813
3814impl<'a> From<&'a Entry> for proto::Entry {
3815 fn from(entry: &'a Entry) -> Self {
3816 Self {
3817 id: entry.id.to_proto(),
3818 is_dir: entry.is_dir(),
3819 path: entry.path.to_string_lossy().into(),
3820 inode: entry.inode,
3821 mtime: Some(entry.mtime.into()),
3822 is_symlink: entry.is_symlink,
3823 is_ignored: entry.is_ignored,
3824 git_status: entry.git_status.map(|status| status.to_proto()),
3825 }
3826 }
3827}
3828
3829impl<'a> TryFrom<(&'a CharBag, proto::Entry)> for Entry {
3830 type Error = anyhow::Error;
3831
3832 fn try_from((root_char_bag, entry): (&'a CharBag, proto::Entry)) -> Result<Self> {
3833 if let Some(mtime) = entry.mtime {
3834 let kind = if entry.is_dir {
3835 EntryKind::Dir
3836 } else {
3837 let mut char_bag = *root_char_bag;
3838 char_bag.extend(entry.path.chars().map(|c| c.to_ascii_lowercase()));
3839 EntryKind::File(char_bag)
3840 };
3841 let path: Arc<Path> = PathBuf::from(entry.path).into();
3842 Ok(Entry {
3843 id: ProjectEntryId::from_proto(entry.id),
3844 kind,
3845 path,
3846 inode: entry.inode,
3847 mtime: mtime.into(),
3848 is_symlink: entry.is_symlink,
3849 is_ignored: entry.is_ignored,
3850 git_status: GitFileStatus::from_proto(entry.git_status),
3851 })
3852 } else {
3853 Err(anyhow!(
3854 "missing mtime in remote worktree entry {:?}",
3855 entry.path
3856 ))
3857 }
3858 }
3859}
3860
3861#[cfg(test)]
3862mod tests {
3863 use super::*;
3864 use fs::{FakeFs, RealFs};
3865 use gpui::{executor::Deterministic, TestAppContext};
3866 use pretty_assertions::assert_eq;
3867 use rand::prelude::*;
3868 use serde_json::json;
3869 use std::{env, fmt::Write};
3870 use util::{http::FakeHttpClient, test::temp_tree};
3871
3872 #[gpui::test]
3873 async fn test_traversal(cx: &mut TestAppContext) {
3874 let fs = FakeFs::new(cx.background());
3875 fs.insert_tree(
3876 "/root",
3877 json!({
3878 ".gitignore": "a/b\n",
3879 "a": {
3880 "b": "",
3881 "c": "",
3882 }
3883 }),
3884 )
3885 .await;
3886
3887 let http_client = FakeHttpClient::with_404_response();
3888 let client = cx.read(|cx| Client::new(http_client, cx));
3889
3890 let tree = Worktree::local(
3891 client,
3892 Path::new("/root"),
3893 true,
3894 fs,
3895 Default::default(),
3896 &mut cx.to_async(),
3897 )
3898 .await
3899 .unwrap();
3900 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
3901 .await;
3902
3903 tree.read_with(cx, |tree, _| {
3904 assert_eq!(
3905 tree.entries(false)
3906 .map(|entry| entry.path.as_ref())
3907 .collect::<Vec<_>>(),
3908 vec![
3909 Path::new(""),
3910 Path::new(".gitignore"),
3911 Path::new("a"),
3912 Path::new("a/c"),
3913 ]
3914 );
3915 assert_eq!(
3916 tree.entries(true)
3917 .map(|entry| entry.path.as_ref())
3918 .collect::<Vec<_>>(),
3919 vec![
3920 Path::new(""),
3921 Path::new(".gitignore"),
3922 Path::new("a"),
3923 Path::new("a/b"),
3924 Path::new("a/c"),
3925 ]
3926 );
3927 })
3928 }
3929
3930 #[gpui::test]
3931 async fn test_descendent_entries(cx: &mut TestAppContext) {
3932 let fs = FakeFs::new(cx.background());
3933 fs.insert_tree(
3934 "/root",
3935 json!({
3936 "a": "",
3937 "b": {
3938 "c": {
3939 "d": ""
3940 },
3941 "e": {}
3942 },
3943 "f": "",
3944 "g": {
3945 "h": {}
3946 },
3947 "i": {
3948 "j": {
3949 "k": ""
3950 },
3951 "l": {
3952
3953 }
3954 },
3955 ".gitignore": "i/j\n",
3956 }),
3957 )
3958 .await;
3959
3960 let http_client = FakeHttpClient::with_404_response();
3961 let client = cx.read(|cx| Client::new(http_client, cx));
3962
3963 let tree = Worktree::local(
3964 client,
3965 Path::new("/root"),
3966 true,
3967 fs,
3968 Default::default(),
3969 &mut cx.to_async(),
3970 )
3971 .await
3972 .unwrap();
3973 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
3974 .await;
3975
3976 tree.read_with(cx, |tree, _| {
3977 assert_eq!(
3978 tree.descendent_entries(false, false, Path::new("b"))
3979 .map(|entry| entry.path.as_ref())
3980 .collect::<Vec<_>>(),
3981 vec![Path::new("b/c/d"),]
3982 );
3983 assert_eq!(
3984 tree.descendent_entries(true, false, Path::new("b"))
3985 .map(|entry| entry.path.as_ref())
3986 .collect::<Vec<_>>(),
3987 vec![
3988 Path::new("b"),
3989 Path::new("b/c"),
3990 Path::new("b/c/d"),
3991 Path::new("b/e"),
3992 ]
3993 );
3994
3995 assert_eq!(
3996 tree.descendent_entries(false, false, Path::new("g"))
3997 .map(|entry| entry.path.as_ref())
3998 .collect::<Vec<_>>(),
3999 Vec::<PathBuf>::new()
4000 );
4001 assert_eq!(
4002 tree.descendent_entries(true, false, Path::new("g"))
4003 .map(|entry| entry.path.as_ref())
4004 .collect::<Vec<_>>(),
4005 vec![Path::new("g"), Path::new("g/h"),]
4006 );
4007
4008 assert_eq!(
4009 tree.descendent_entries(false, false, Path::new("i"))
4010 .map(|entry| entry.path.as_ref())
4011 .collect::<Vec<_>>(),
4012 Vec::<PathBuf>::new()
4013 );
4014 assert_eq!(
4015 tree.descendent_entries(false, true, Path::new("i"))
4016 .map(|entry| entry.path.as_ref())
4017 .collect::<Vec<_>>(),
4018 vec![Path::new("i/j/k")]
4019 );
4020 assert_eq!(
4021 tree.descendent_entries(true, false, Path::new("i"))
4022 .map(|entry| entry.path.as_ref())
4023 .collect::<Vec<_>>(),
4024 vec![Path::new("i"), Path::new("i/l"),]
4025 );
4026 })
4027 }
4028
4029 #[gpui::test(iterations = 10)]
4030 async fn test_circular_symlinks(executor: Arc<Deterministic>, cx: &mut TestAppContext) {
4031 let fs = FakeFs::new(cx.background());
4032 fs.insert_tree(
4033 "/root",
4034 json!({
4035 "lib": {
4036 "a": {
4037 "a.txt": ""
4038 },
4039 "b": {
4040 "b.txt": ""
4041 }
4042 }
4043 }),
4044 )
4045 .await;
4046 fs.insert_symlink("/root/lib/a/lib", "..".into()).await;
4047 fs.insert_symlink("/root/lib/b/lib", "..".into()).await;
4048
4049 let client = cx.read(|cx| Client::new(FakeHttpClient::with_404_response(), cx));
4050 let tree = Worktree::local(
4051 client,
4052 Path::new("/root"),
4053 true,
4054 fs.clone(),
4055 Default::default(),
4056 &mut cx.to_async(),
4057 )
4058 .await
4059 .unwrap();
4060
4061 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
4062 .await;
4063
4064 tree.read_with(cx, |tree, _| {
4065 assert_eq!(
4066 tree.entries(false)
4067 .map(|entry| entry.path.as_ref())
4068 .collect::<Vec<_>>(),
4069 vec![
4070 Path::new(""),
4071 Path::new("lib"),
4072 Path::new("lib/a"),
4073 Path::new("lib/a/a.txt"),
4074 Path::new("lib/a/lib"),
4075 Path::new("lib/b"),
4076 Path::new("lib/b/b.txt"),
4077 Path::new("lib/b/lib"),
4078 ]
4079 );
4080 });
4081
4082 fs.rename(
4083 Path::new("/root/lib/a/lib"),
4084 Path::new("/root/lib/a/lib-2"),
4085 Default::default(),
4086 )
4087 .await
4088 .unwrap();
4089 executor.run_until_parked();
4090 tree.read_with(cx, |tree, _| {
4091 assert_eq!(
4092 tree.entries(false)
4093 .map(|entry| entry.path.as_ref())
4094 .collect::<Vec<_>>(),
4095 vec![
4096 Path::new(""),
4097 Path::new("lib"),
4098 Path::new("lib/a"),
4099 Path::new("lib/a/a.txt"),
4100 Path::new("lib/a/lib-2"),
4101 Path::new("lib/b"),
4102 Path::new("lib/b/b.txt"),
4103 Path::new("lib/b/lib"),
4104 ]
4105 );
4106 });
4107 }
4108
4109 #[gpui::test]
4110 async fn test_rescan_with_gitignore(cx: &mut TestAppContext) {
4111 // .gitignores are handled explicitly by Zed and do not use the git
4112 // machinery that the git_tests module checks
4113 let parent_dir = temp_tree(json!({
4114 ".gitignore": "ancestor-ignored-file1\nancestor-ignored-file2\n",
4115 "tree": {
4116 ".git": {},
4117 ".gitignore": "ignored-dir\n",
4118 "tracked-dir": {
4119 "tracked-file1": "",
4120 "ancestor-ignored-file1": "",
4121 },
4122 "ignored-dir": {
4123 "ignored-file1": ""
4124 }
4125 }
4126 }));
4127 let dir = parent_dir.path().join("tree");
4128
4129 let client = cx.read(|cx| Client::new(FakeHttpClient::with_404_response(), cx));
4130
4131 let tree = Worktree::local(
4132 client,
4133 dir.as_path(),
4134 true,
4135 Arc::new(RealFs),
4136 Default::default(),
4137 &mut cx.to_async(),
4138 )
4139 .await
4140 .unwrap();
4141 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
4142 .await;
4143 tree.flush_fs_events(cx).await;
4144 cx.read(|cx| {
4145 let tree = tree.read(cx);
4146 assert!(
4147 !tree
4148 .entry_for_path("tracked-dir/tracked-file1")
4149 .unwrap()
4150 .is_ignored
4151 );
4152 assert!(
4153 tree.entry_for_path("tracked-dir/ancestor-ignored-file1")
4154 .unwrap()
4155 .is_ignored
4156 );
4157 assert!(
4158 tree.entry_for_path("ignored-dir/ignored-file1")
4159 .unwrap()
4160 .is_ignored
4161 );
4162 });
4163
4164 std::fs::write(dir.join("tracked-dir/tracked-file2"), "").unwrap();
4165 std::fs::write(dir.join("tracked-dir/ancestor-ignored-file2"), "").unwrap();
4166 std::fs::write(dir.join("ignored-dir/ignored-file2"), "").unwrap();
4167 tree.flush_fs_events(cx).await;
4168 cx.read(|cx| {
4169 let tree = tree.read(cx);
4170 assert!(
4171 !tree
4172 .entry_for_path("tracked-dir/tracked-file2")
4173 .unwrap()
4174 .is_ignored
4175 );
4176 assert!(
4177 tree.entry_for_path("tracked-dir/ancestor-ignored-file2")
4178 .unwrap()
4179 .is_ignored
4180 );
4181 assert!(
4182 tree.entry_for_path("ignored-dir/ignored-file2")
4183 .unwrap()
4184 .is_ignored
4185 );
4186 assert!(tree.entry_for_path(".git").unwrap().is_ignored);
4187 });
4188 }
4189
4190 #[gpui::test]
4191 async fn test_write_file(cx: &mut TestAppContext) {
4192 let dir = temp_tree(json!({
4193 ".git": {},
4194 ".gitignore": "ignored-dir\n",
4195 "tracked-dir": {},
4196 "ignored-dir": {}
4197 }));
4198
4199 let client = cx.read(|cx| Client::new(FakeHttpClient::with_404_response(), cx));
4200
4201 let tree = Worktree::local(
4202 client,
4203 dir.path(),
4204 true,
4205 Arc::new(RealFs),
4206 Default::default(),
4207 &mut cx.to_async(),
4208 )
4209 .await
4210 .unwrap();
4211 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
4212 .await;
4213 tree.flush_fs_events(cx).await;
4214
4215 tree.update(cx, |tree, cx| {
4216 tree.as_local().unwrap().write_file(
4217 Path::new("tracked-dir/file.txt"),
4218 "hello".into(),
4219 Default::default(),
4220 cx,
4221 )
4222 })
4223 .await
4224 .unwrap();
4225 tree.update(cx, |tree, cx| {
4226 tree.as_local().unwrap().write_file(
4227 Path::new("ignored-dir/file.txt"),
4228 "world".into(),
4229 Default::default(),
4230 cx,
4231 )
4232 })
4233 .await
4234 .unwrap();
4235
4236 tree.read_with(cx, |tree, _| {
4237 let tracked = tree.entry_for_path("tracked-dir/file.txt").unwrap();
4238 let ignored = tree.entry_for_path("ignored-dir/file.txt").unwrap();
4239 assert!(!tracked.is_ignored);
4240 assert!(ignored.is_ignored);
4241 });
4242 }
4243
4244 #[gpui::test(iterations = 30)]
4245 async fn test_create_directory_during_initial_scan(cx: &mut TestAppContext) {
4246 let client = cx.read(|cx| Client::new(FakeHttpClient::with_404_response(), cx));
4247
4248 let fs = FakeFs::new(cx.background());
4249 fs.insert_tree(
4250 "/root",
4251 json!({
4252 "b": {},
4253 "c": {},
4254 "d": {},
4255 }),
4256 )
4257 .await;
4258
4259 let tree = Worktree::local(
4260 client,
4261 "/root".as_ref(),
4262 true,
4263 fs,
4264 Default::default(),
4265 &mut cx.to_async(),
4266 )
4267 .await
4268 .unwrap();
4269
4270 let snapshot1 = tree.update(cx, |tree, cx| {
4271 let tree = tree.as_local_mut().unwrap();
4272 let snapshot = Arc::new(Mutex::new(tree.snapshot()));
4273 let _ = tree.observe_updates(0, cx, {
4274 let snapshot = snapshot.clone();
4275 move |update| {
4276 snapshot.lock().apply_remote_update(update).unwrap();
4277 async { true }
4278 }
4279 });
4280 snapshot
4281 });
4282
4283 let entry = tree
4284 .update(cx, |tree, cx| {
4285 tree.as_local_mut()
4286 .unwrap()
4287 .create_entry("a/e".as_ref(), true, cx)
4288 })
4289 .await
4290 .unwrap();
4291 assert!(entry.is_dir());
4292
4293 cx.foreground().run_until_parked();
4294 tree.read_with(cx, |tree, _| {
4295 assert_eq!(tree.entry_for_path("a/e").unwrap().kind, EntryKind::Dir);
4296 });
4297
4298 let snapshot2 = tree.update(cx, |tree, _| tree.as_local().unwrap().snapshot());
4299 assert_eq!(
4300 snapshot1.lock().entries(true).collect::<Vec<_>>(),
4301 snapshot2.entries(true).collect::<Vec<_>>()
4302 );
4303 }
4304
4305 #[gpui::test(iterations = 100)]
4306 async fn test_random_worktree_operations_during_initial_scan(
4307 cx: &mut TestAppContext,
4308 mut rng: StdRng,
4309 ) {
4310 let operations = env::var("OPERATIONS")
4311 .map(|o| o.parse().unwrap())
4312 .unwrap_or(5);
4313 let initial_entries = env::var("INITIAL_ENTRIES")
4314 .map(|o| o.parse().unwrap())
4315 .unwrap_or(20);
4316
4317 let root_dir = Path::new("/test");
4318 let fs = FakeFs::new(cx.background()) as Arc<dyn Fs>;
4319 fs.as_fake().insert_tree(root_dir, json!({})).await;
4320 for _ in 0..initial_entries {
4321 randomly_mutate_fs(&fs, root_dir, 1.0, &mut rng).await;
4322 }
4323 log::info!("generated initial tree");
4324
4325 let client = cx.read(|cx| Client::new(FakeHttpClient::with_404_response(), cx));
4326 let worktree = Worktree::local(
4327 client.clone(),
4328 root_dir,
4329 true,
4330 fs.clone(),
4331 Default::default(),
4332 &mut cx.to_async(),
4333 )
4334 .await
4335 .unwrap();
4336
4337 let mut snapshots =
4338 vec![worktree.read_with(cx, |tree, _| tree.as_local().unwrap().snapshot())];
4339 let updates = Arc::new(Mutex::new(Vec::new()));
4340 worktree.update(cx, |tree, cx| {
4341 check_worktree_change_events(tree, cx);
4342
4343 let _ = tree.as_local_mut().unwrap().observe_updates(0, cx, {
4344 let updates = updates.clone();
4345 move |update| {
4346 updates.lock().push(update);
4347 async { true }
4348 }
4349 });
4350 });
4351
4352 for _ in 0..operations {
4353 worktree
4354 .update(cx, |worktree, cx| {
4355 randomly_mutate_worktree(worktree, &mut rng, cx)
4356 })
4357 .await
4358 .log_err();
4359 worktree.read_with(cx, |tree, _| {
4360 tree.as_local().unwrap().snapshot.check_invariants()
4361 });
4362
4363 if rng.gen_bool(0.6) {
4364 snapshots
4365 .push(worktree.read_with(cx, |tree, _| tree.as_local().unwrap().snapshot()));
4366 }
4367 }
4368
4369 worktree
4370 .update(cx, |tree, _| tree.as_local_mut().unwrap().scan_complete())
4371 .await;
4372
4373 cx.foreground().run_until_parked();
4374
4375 let final_snapshot = worktree.read_with(cx, |tree, _| {
4376 let tree = tree.as_local().unwrap();
4377 tree.snapshot.check_invariants();
4378 tree.snapshot()
4379 });
4380
4381 for (i, snapshot) in snapshots.into_iter().enumerate().rev() {
4382 let mut updated_snapshot = snapshot.clone();
4383 for update in updates.lock().iter() {
4384 if update.scan_id >= updated_snapshot.scan_id() as u64 {
4385 updated_snapshot
4386 .apply_remote_update(update.clone())
4387 .unwrap();
4388 }
4389 }
4390
4391 assert_eq!(
4392 updated_snapshot.entries(true).collect::<Vec<_>>(),
4393 final_snapshot.entries(true).collect::<Vec<_>>(),
4394 "wrong updates after snapshot {i}: {snapshot:#?} {updates:#?}",
4395 );
4396 }
4397 }
4398
4399 #[gpui::test(iterations = 100)]
4400 async fn test_random_worktree_changes(cx: &mut TestAppContext, mut rng: StdRng) {
4401 let operations = env::var("OPERATIONS")
4402 .map(|o| o.parse().unwrap())
4403 .unwrap_or(40);
4404 let initial_entries = env::var("INITIAL_ENTRIES")
4405 .map(|o| o.parse().unwrap())
4406 .unwrap_or(20);
4407
4408 let root_dir = Path::new("/test");
4409 let fs = FakeFs::new(cx.background()) as Arc<dyn Fs>;
4410 fs.as_fake().insert_tree(root_dir, json!({})).await;
4411 for _ in 0..initial_entries {
4412 randomly_mutate_fs(&fs, root_dir, 1.0, &mut rng).await;
4413 }
4414 log::info!("generated initial tree");
4415
4416 let client = cx.read(|cx| Client::new(FakeHttpClient::with_404_response(), cx));
4417 let worktree = Worktree::local(
4418 client.clone(),
4419 root_dir,
4420 true,
4421 fs.clone(),
4422 Default::default(),
4423 &mut cx.to_async(),
4424 )
4425 .await
4426 .unwrap();
4427
4428 let updates = Arc::new(Mutex::new(Vec::new()));
4429 worktree.update(cx, |tree, cx| {
4430 check_worktree_change_events(tree, cx);
4431
4432 let _ = tree.as_local_mut().unwrap().observe_updates(0, cx, {
4433 let updates = updates.clone();
4434 move |update| {
4435 updates.lock().push(update);
4436 async { true }
4437 }
4438 });
4439 });
4440
4441 worktree
4442 .update(cx, |tree, _| tree.as_local_mut().unwrap().scan_complete())
4443 .await;
4444
4445 fs.as_fake().pause_events();
4446 let mut snapshots = Vec::new();
4447 let mut mutations_len = operations;
4448 while mutations_len > 1 {
4449 if rng.gen_bool(0.2) {
4450 worktree
4451 .update(cx, |worktree, cx| {
4452 randomly_mutate_worktree(worktree, &mut rng, cx)
4453 })
4454 .await
4455 .log_err();
4456 } else {
4457 randomly_mutate_fs(&fs, root_dir, 1.0, &mut rng).await;
4458 }
4459
4460 let buffered_event_count = fs.as_fake().buffered_event_count();
4461 if buffered_event_count > 0 && rng.gen_bool(0.3) {
4462 let len = rng.gen_range(0..=buffered_event_count);
4463 log::info!("flushing {} events", len);
4464 fs.as_fake().flush_events(len);
4465 } else {
4466 randomly_mutate_fs(&fs, root_dir, 0.6, &mut rng).await;
4467 mutations_len -= 1;
4468 }
4469
4470 cx.foreground().run_until_parked();
4471 if rng.gen_bool(0.2) {
4472 log::info!("storing snapshot {}", snapshots.len());
4473 let snapshot =
4474 worktree.read_with(cx, |tree, _| tree.as_local().unwrap().snapshot());
4475 snapshots.push(snapshot);
4476 }
4477 }
4478
4479 log::info!("quiescing");
4480 fs.as_fake().flush_events(usize::MAX);
4481 cx.foreground().run_until_parked();
4482 let snapshot = worktree.read_with(cx, |tree, _| tree.as_local().unwrap().snapshot());
4483 snapshot.check_invariants();
4484
4485 {
4486 let new_worktree = Worktree::local(
4487 client.clone(),
4488 root_dir,
4489 true,
4490 fs.clone(),
4491 Default::default(),
4492 &mut cx.to_async(),
4493 )
4494 .await
4495 .unwrap();
4496 new_worktree
4497 .update(cx, |tree, _| tree.as_local_mut().unwrap().scan_complete())
4498 .await;
4499 let new_snapshot =
4500 new_worktree.read_with(cx, |tree, _| tree.as_local().unwrap().snapshot());
4501 assert_eq!(
4502 snapshot.entries_without_ids(true),
4503 new_snapshot.entries_without_ids(true)
4504 );
4505 }
4506
4507 for (i, mut prev_snapshot) in snapshots.into_iter().enumerate().rev() {
4508 for update in updates.lock().iter() {
4509 if update.scan_id >= prev_snapshot.scan_id() as u64 {
4510 prev_snapshot.apply_remote_update(update.clone()).unwrap();
4511 }
4512 }
4513
4514 assert_eq!(
4515 prev_snapshot.entries(true).collect::<Vec<_>>(),
4516 snapshot.entries(true).collect::<Vec<_>>(),
4517 "wrong updates after snapshot {i}: {updates:#?}",
4518 );
4519 }
4520 }
4521
4522 // The worktree's `UpdatedEntries` event can be used to follow along with
4523 // all changes to the worktree's snapshot.
4524 fn check_worktree_change_events(tree: &mut Worktree, cx: &mut ModelContext<Worktree>) {
4525 let mut entries = tree.entries(true).cloned().collect::<Vec<_>>();
4526 cx.subscribe(&cx.handle(), move |tree, _, event, _| {
4527 if let Event::UpdatedEntries(changes) = event {
4528 for (path, _, change_type) in changes.iter() {
4529 let entry = tree.entry_for_path(&path).cloned();
4530 let ix = match entries.binary_search_by_key(&path, |e| &e.path) {
4531 Ok(ix) | Err(ix) => ix,
4532 };
4533 match change_type {
4534 PathChange::Loaded => entries.insert(ix, entry.unwrap()),
4535 PathChange::Added => entries.insert(ix, entry.unwrap()),
4536 PathChange::Removed => drop(entries.remove(ix)),
4537 PathChange::Updated => {
4538 let entry = entry.unwrap();
4539 let existing_entry = entries.get_mut(ix).unwrap();
4540 assert_eq!(existing_entry.path, entry.path);
4541 *existing_entry = entry;
4542 }
4543 PathChange::AddedOrUpdated => {
4544 let entry = entry.unwrap();
4545 if entries.get(ix).map(|e| &e.path) == Some(&entry.path) {
4546 *entries.get_mut(ix).unwrap() = entry;
4547 } else {
4548 entries.insert(ix, entry);
4549 }
4550 }
4551 }
4552 }
4553
4554 let new_entries = tree.entries(true).cloned().collect::<Vec<_>>();
4555 assert_eq!(entries, new_entries, "incorrect changes: {:?}", changes);
4556 }
4557 })
4558 .detach();
4559 }
4560
4561 fn randomly_mutate_worktree(
4562 worktree: &mut Worktree,
4563 rng: &mut impl Rng,
4564 cx: &mut ModelContext<Worktree>,
4565 ) -> Task<Result<()>> {
4566 log::info!("mutating worktree");
4567 let worktree = worktree.as_local_mut().unwrap();
4568 let snapshot = worktree.snapshot();
4569 let entry = snapshot.entries(false).choose(rng).unwrap();
4570
4571 match rng.gen_range(0_u32..100) {
4572 0..=33 if entry.path.as_ref() != Path::new("") => {
4573 log::info!("deleting entry {:?} ({})", entry.path, entry.id.0);
4574 worktree.delete_entry(entry.id, cx).unwrap()
4575 }
4576 ..=66 if entry.path.as_ref() != Path::new("") => {
4577 let other_entry = snapshot.entries(false).choose(rng).unwrap();
4578 let new_parent_path = if other_entry.is_dir() {
4579 other_entry.path.clone()
4580 } else {
4581 other_entry.path.parent().unwrap().into()
4582 };
4583 let mut new_path = new_parent_path.join(gen_name(rng));
4584 if new_path.starts_with(&entry.path) {
4585 new_path = gen_name(rng).into();
4586 }
4587
4588 log::info!(
4589 "renaming entry {:?} ({}) to {:?}",
4590 entry.path,
4591 entry.id.0,
4592 new_path
4593 );
4594 let task = worktree.rename_entry(entry.id, new_path, cx).unwrap();
4595 cx.foreground().spawn(async move {
4596 task.await?;
4597 Ok(())
4598 })
4599 }
4600 _ => {
4601 let task = if entry.is_dir() {
4602 let child_path = entry.path.join(gen_name(rng));
4603 let is_dir = rng.gen_bool(0.3);
4604 log::info!(
4605 "creating {} at {:?}",
4606 if is_dir { "dir" } else { "file" },
4607 child_path,
4608 );
4609 worktree.create_entry(child_path, is_dir, cx)
4610 } else {
4611 log::info!("overwriting file {:?} ({})", entry.path, entry.id.0);
4612 worktree.write_file(entry.path.clone(), "".into(), Default::default(), cx)
4613 };
4614 cx.foreground().spawn(async move {
4615 task.await?;
4616 Ok(())
4617 })
4618 }
4619 }
4620 }
4621
4622 async fn randomly_mutate_fs(
4623 fs: &Arc<dyn Fs>,
4624 root_path: &Path,
4625 insertion_probability: f64,
4626 rng: &mut impl Rng,
4627 ) {
4628 log::info!("mutating fs");
4629 let mut files = Vec::new();
4630 let mut dirs = Vec::new();
4631 for path in fs.as_fake().paths() {
4632 if path.starts_with(root_path) {
4633 if fs.is_file(&path).await {
4634 files.push(path);
4635 } else {
4636 dirs.push(path);
4637 }
4638 }
4639 }
4640
4641 if (files.is_empty() && dirs.len() == 1) || rng.gen_bool(insertion_probability) {
4642 let path = dirs.choose(rng).unwrap();
4643 let new_path = path.join(gen_name(rng));
4644
4645 if rng.gen() {
4646 log::info!(
4647 "creating dir {:?}",
4648 new_path.strip_prefix(root_path).unwrap()
4649 );
4650 fs.create_dir(&new_path).await.unwrap();
4651 } else {
4652 log::info!(
4653 "creating file {:?}",
4654 new_path.strip_prefix(root_path).unwrap()
4655 );
4656 fs.create_file(&new_path, Default::default()).await.unwrap();
4657 }
4658 } else if rng.gen_bool(0.05) {
4659 let ignore_dir_path = dirs.choose(rng).unwrap();
4660 let ignore_path = ignore_dir_path.join(&*GITIGNORE);
4661
4662 let subdirs = dirs
4663 .iter()
4664 .filter(|d| d.starts_with(&ignore_dir_path))
4665 .cloned()
4666 .collect::<Vec<_>>();
4667 let subfiles = files
4668 .iter()
4669 .filter(|d| d.starts_with(&ignore_dir_path))
4670 .cloned()
4671 .collect::<Vec<_>>();
4672 let files_to_ignore = {
4673 let len = rng.gen_range(0..=subfiles.len());
4674 subfiles.choose_multiple(rng, len)
4675 };
4676 let dirs_to_ignore = {
4677 let len = rng.gen_range(0..subdirs.len());
4678 subdirs.choose_multiple(rng, len)
4679 };
4680
4681 let mut ignore_contents = String::new();
4682 for path_to_ignore in files_to_ignore.chain(dirs_to_ignore) {
4683 writeln!(
4684 ignore_contents,
4685 "{}",
4686 path_to_ignore
4687 .strip_prefix(&ignore_dir_path)
4688 .unwrap()
4689 .to_str()
4690 .unwrap()
4691 )
4692 .unwrap();
4693 }
4694 log::info!(
4695 "creating gitignore {:?} with contents:\n{}",
4696 ignore_path.strip_prefix(&root_path).unwrap(),
4697 ignore_contents
4698 );
4699 fs.save(
4700 &ignore_path,
4701 &ignore_contents.as_str().into(),
4702 Default::default(),
4703 )
4704 .await
4705 .unwrap();
4706 } else {
4707 let old_path = {
4708 let file_path = files.choose(rng);
4709 let dir_path = dirs[1..].choose(rng);
4710 file_path.into_iter().chain(dir_path).choose(rng).unwrap()
4711 };
4712
4713 let is_rename = rng.gen();
4714 if is_rename {
4715 let new_path_parent = dirs
4716 .iter()
4717 .filter(|d| !d.starts_with(old_path))
4718 .choose(rng)
4719 .unwrap();
4720
4721 let overwrite_existing_dir =
4722 !old_path.starts_with(&new_path_parent) && rng.gen_bool(0.3);
4723 let new_path = if overwrite_existing_dir {
4724 fs.remove_dir(
4725 &new_path_parent,
4726 RemoveOptions {
4727 recursive: true,
4728 ignore_if_not_exists: true,
4729 },
4730 )
4731 .await
4732 .unwrap();
4733 new_path_parent.to_path_buf()
4734 } else {
4735 new_path_parent.join(gen_name(rng))
4736 };
4737
4738 log::info!(
4739 "renaming {:?} to {}{:?}",
4740 old_path.strip_prefix(&root_path).unwrap(),
4741 if overwrite_existing_dir {
4742 "overwrite "
4743 } else {
4744 ""
4745 },
4746 new_path.strip_prefix(&root_path).unwrap()
4747 );
4748 fs.rename(
4749 &old_path,
4750 &new_path,
4751 fs::RenameOptions {
4752 overwrite: true,
4753 ignore_if_exists: true,
4754 },
4755 )
4756 .await
4757 .unwrap();
4758 } else if fs.is_file(&old_path).await {
4759 log::info!(
4760 "deleting file {:?}",
4761 old_path.strip_prefix(&root_path).unwrap()
4762 );
4763 fs.remove_file(old_path, Default::default()).await.unwrap();
4764 } else {
4765 log::info!(
4766 "deleting dir {:?}",
4767 old_path.strip_prefix(&root_path).unwrap()
4768 );
4769 fs.remove_dir(
4770 &old_path,
4771 RemoveOptions {
4772 recursive: true,
4773 ignore_if_not_exists: true,
4774 },
4775 )
4776 .await
4777 .unwrap();
4778 }
4779 }
4780 }
4781
4782 fn gen_name(rng: &mut impl Rng) -> String {
4783 (0..6)
4784 .map(|_| rng.sample(rand::distributions::Alphanumeric))
4785 .map(char::from)
4786 .collect()
4787 }
4788
4789 impl LocalSnapshot {
4790 fn check_invariants(&self) {
4791 assert_eq!(
4792 self.entries_by_path
4793 .cursor::<()>()
4794 .map(|e| (&e.path, e.id))
4795 .collect::<Vec<_>>(),
4796 self.entries_by_id
4797 .cursor::<()>()
4798 .map(|e| (&e.path, e.id))
4799 .collect::<collections::BTreeSet<_>>()
4800 .into_iter()
4801 .collect::<Vec<_>>(),
4802 "entries_by_path and entries_by_id are inconsistent"
4803 );
4804
4805 let mut files = self.files(true, 0);
4806 let mut visible_files = self.files(false, 0);
4807 for entry in self.entries_by_path.cursor::<()>() {
4808 if entry.is_file() {
4809 assert_eq!(files.next().unwrap().inode, entry.inode);
4810 if !entry.is_ignored {
4811 assert_eq!(visible_files.next().unwrap().inode, entry.inode);
4812 }
4813 }
4814 }
4815
4816 assert!(files.next().is_none());
4817 assert!(visible_files.next().is_none());
4818
4819 let mut bfs_paths = Vec::new();
4820 let mut stack = vec![Path::new("")];
4821 while let Some(path) = stack.pop() {
4822 bfs_paths.push(path);
4823 let ix = stack.len();
4824 for child_entry in self.child_entries(path) {
4825 stack.insert(ix, &child_entry.path);
4826 }
4827 }
4828
4829 let dfs_paths_via_iter = self
4830 .entries_by_path
4831 .cursor::<()>()
4832 .map(|e| e.path.as_ref())
4833 .collect::<Vec<_>>();
4834 assert_eq!(bfs_paths, dfs_paths_via_iter);
4835
4836 let dfs_paths_via_traversal = self
4837 .entries(true)
4838 .map(|e| e.path.as_ref())
4839 .collect::<Vec<_>>();
4840 assert_eq!(dfs_paths_via_traversal, dfs_paths_via_iter);
4841
4842 for ignore_parent_abs_path in self.ignores_by_parent_abs_path.keys() {
4843 let ignore_parent_path =
4844 ignore_parent_abs_path.strip_prefix(&self.abs_path).unwrap();
4845 assert!(self.entry_for_path(&ignore_parent_path).is_some());
4846 assert!(self
4847 .entry_for_path(ignore_parent_path.join(&*GITIGNORE))
4848 .is_some());
4849 }
4850 }
4851
4852 fn entries_without_ids(&self, include_ignored: bool) -> Vec<(&Path, u64, bool)> {
4853 let mut paths = Vec::new();
4854 for entry in self.entries_by_path.cursor::<()>() {
4855 if include_ignored || !entry.is_ignored {
4856 paths.push((entry.path.as_ref(), entry.inode, entry.is_ignored));
4857 }
4858 }
4859 paths.sort_by(|a, b| a.0.cmp(b.0));
4860 paths
4861 }
4862 }
4863
4864 mod git_tests {
4865 use super::*;
4866 use pretty_assertions::assert_eq;
4867
4868 #[gpui::test]
4869 async fn test_rename_work_directory(cx: &mut TestAppContext) {
4870 let root = temp_tree(json!({
4871 "projects": {
4872 "project1": {
4873 "a": "",
4874 "b": "",
4875 }
4876 },
4877
4878 }));
4879 let root_path = root.path();
4880
4881 let http_client = FakeHttpClient::with_404_response();
4882 let client = cx.read(|cx| Client::new(http_client, cx));
4883 let tree = Worktree::local(
4884 client,
4885 root_path,
4886 true,
4887 Arc::new(RealFs),
4888 Default::default(),
4889 &mut cx.to_async(),
4890 )
4891 .await
4892 .unwrap();
4893
4894 let repo = git_init(&root_path.join("projects/project1"));
4895 git_add("a", &repo);
4896 git_commit("init", &repo);
4897 std::fs::write(root_path.join("projects/project1/a"), "aa").ok();
4898
4899 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
4900 .await;
4901
4902 tree.flush_fs_events(cx).await;
4903
4904 cx.read(|cx| {
4905 let tree = tree.read(cx);
4906 let (work_dir, _) = tree.repositories().next().unwrap();
4907 assert_eq!(work_dir.as_ref(), Path::new("projects/project1"));
4908 assert_eq!(
4909 tree.status_for_file(Path::new("projects/project1/a")),
4910 Some(GitFileStatus::Modified)
4911 );
4912 assert_eq!(
4913 tree.status_for_file(Path::new("projects/project1/b")),
4914 Some(GitFileStatus::Added)
4915 );
4916 });
4917
4918 std::fs::rename(
4919 root_path.join("projects/project1"),
4920 root_path.join("projects/project2"),
4921 )
4922 .ok();
4923 tree.flush_fs_events(cx).await;
4924
4925 cx.read(|cx| {
4926 let tree = tree.read(cx);
4927 let (work_dir, _) = tree.repositories().next().unwrap();
4928 assert_eq!(work_dir.as_ref(), Path::new("projects/project2"));
4929 assert_eq!(
4930 tree.status_for_file(Path::new("projects/project2/a")),
4931 Some(GitFileStatus::Modified)
4932 );
4933 assert_eq!(
4934 tree.status_for_file(Path::new("projects/project2/b")),
4935 Some(GitFileStatus::Added)
4936 );
4937 });
4938 }
4939
4940 #[gpui::test]
4941 async fn test_git_repository_for_path(cx: &mut TestAppContext) {
4942 let root = temp_tree(json!({
4943 "c.txt": "",
4944 "dir1": {
4945 ".git": {},
4946 "deps": {
4947 "dep1": {
4948 ".git": {},
4949 "src": {
4950 "a.txt": ""
4951 }
4952 }
4953 },
4954 "src": {
4955 "b.txt": ""
4956 }
4957 },
4958 }));
4959
4960 let http_client = FakeHttpClient::with_404_response();
4961 let client = cx.read(|cx| Client::new(http_client, cx));
4962 let tree = Worktree::local(
4963 client,
4964 root.path(),
4965 true,
4966 Arc::new(RealFs),
4967 Default::default(),
4968 &mut cx.to_async(),
4969 )
4970 .await
4971 .unwrap();
4972
4973 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
4974 .await;
4975 tree.flush_fs_events(cx).await;
4976
4977 tree.read_with(cx, |tree, _cx| {
4978 let tree = tree.as_local().unwrap();
4979
4980 assert!(tree.repository_for_path("c.txt".as_ref()).is_none());
4981
4982 let entry = tree.repository_for_path("dir1/src/b.txt".as_ref()).unwrap();
4983 assert_eq!(
4984 entry
4985 .work_directory(tree)
4986 .map(|directory| directory.as_ref().to_owned()),
4987 Some(Path::new("dir1").to_owned())
4988 );
4989
4990 let entry = tree
4991 .repository_for_path("dir1/deps/dep1/src/a.txt".as_ref())
4992 .unwrap();
4993 assert_eq!(
4994 entry
4995 .work_directory(tree)
4996 .map(|directory| directory.as_ref().to_owned()),
4997 Some(Path::new("dir1/deps/dep1").to_owned())
4998 );
4999
5000 let entries = tree.files(false, 0);
5001
5002 let paths_with_repos = tree
5003 .entries_with_repositories(entries)
5004 .map(|(entry, repo)| {
5005 (
5006 entry.path.as_ref(),
5007 repo.and_then(|repo| {
5008 repo.work_directory(&tree)
5009 .map(|work_directory| work_directory.0.to_path_buf())
5010 }),
5011 )
5012 })
5013 .collect::<Vec<_>>();
5014
5015 assert_eq!(
5016 paths_with_repos,
5017 &[
5018 (Path::new("c.txt"), None),
5019 (
5020 Path::new("dir1/deps/dep1/src/a.txt"),
5021 Some(Path::new("dir1/deps/dep1").into())
5022 ),
5023 (Path::new("dir1/src/b.txt"), Some(Path::new("dir1").into())),
5024 ]
5025 );
5026 });
5027
5028 let repo_update_events = Arc::new(Mutex::new(vec![]));
5029 tree.update(cx, |_, cx| {
5030 let repo_update_events = repo_update_events.clone();
5031 cx.subscribe(&tree, move |_, _, event, _| {
5032 if let Event::UpdatedGitRepositories(update) = event {
5033 repo_update_events.lock().push(update.clone());
5034 }
5035 })
5036 .detach();
5037 });
5038
5039 std::fs::write(root.path().join("dir1/.git/random_new_file"), "hello").unwrap();
5040 tree.flush_fs_events(cx).await;
5041
5042 assert_eq!(
5043 repo_update_events.lock()[0]
5044 .iter()
5045 .map(|e| e.0.clone())
5046 .collect::<Vec<Arc<Path>>>(),
5047 vec![Path::new("dir1").into()]
5048 );
5049
5050 std::fs::remove_dir_all(root.path().join("dir1/.git")).unwrap();
5051 tree.flush_fs_events(cx).await;
5052
5053 tree.read_with(cx, |tree, _cx| {
5054 let tree = tree.as_local().unwrap();
5055
5056 assert!(tree
5057 .repository_for_path("dir1/src/b.txt".as_ref())
5058 .is_none());
5059 });
5060 }
5061
5062 #[gpui::test]
5063 async fn test_git_status(deterministic: Arc<Deterministic>, cx: &mut TestAppContext) {
5064 const IGNORE_RULE: &'static str = "**/target";
5065
5066 let root = temp_tree(json!({
5067 "project": {
5068 "a.txt": "a",
5069 "b.txt": "bb",
5070 "c": {
5071 "d": {
5072 "e.txt": "eee"
5073 }
5074 },
5075 "f.txt": "ffff",
5076 "target": {
5077 "build_file": "???"
5078 },
5079 ".gitignore": IGNORE_RULE
5080 },
5081
5082 }));
5083
5084 let http_client = FakeHttpClient::with_404_response();
5085 let client = cx.read(|cx| Client::new(http_client, cx));
5086 let tree = Worktree::local(
5087 client,
5088 root.path(),
5089 true,
5090 Arc::new(RealFs),
5091 Default::default(),
5092 &mut cx.to_async(),
5093 )
5094 .await
5095 .unwrap();
5096
5097 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
5098 .await;
5099
5100 const A_TXT: &'static str = "a.txt";
5101 const B_TXT: &'static str = "b.txt";
5102 const E_TXT: &'static str = "c/d/e.txt";
5103 const F_TXT: &'static str = "f.txt";
5104 const DOTGITIGNORE: &'static str = ".gitignore";
5105 const BUILD_FILE: &'static str = "target/build_file";
5106 let project_path: &Path = &Path::new("project");
5107
5108 let work_dir = root.path().join("project");
5109 let mut repo = git_init(work_dir.as_path());
5110 repo.add_ignore_rule(IGNORE_RULE).unwrap();
5111 git_add(Path::new(A_TXT), &repo);
5112 git_add(Path::new(E_TXT), &repo);
5113 git_add(Path::new(DOTGITIGNORE), &repo);
5114 git_commit("Initial commit", &repo);
5115
5116 tree.flush_fs_events(cx).await;
5117 deterministic.run_until_parked();
5118
5119 // Check that the right git state is observed on startup
5120 tree.read_with(cx, |tree, _cx| {
5121 let snapshot = tree.snapshot();
5122 assert_eq!(snapshot.repository_entries.iter().count(), 1);
5123 let (dir, _) = snapshot.repository_entries.iter().next().unwrap();
5124 assert_eq!(dir.0.as_ref(), Path::new("project"));
5125
5126 assert_eq!(
5127 snapshot.status_for_file(project_path.join(B_TXT)),
5128 Some(GitFileStatus::Added)
5129 );
5130 assert_eq!(
5131 snapshot.status_for_file(project_path.join(F_TXT)),
5132 Some(GitFileStatus::Added)
5133 );
5134 });
5135
5136 std::fs::write(work_dir.join(A_TXT), "aa").unwrap();
5137
5138 tree.flush_fs_events(cx).await;
5139 deterministic.run_until_parked();
5140
5141 tree.read_with(cx, |tree, _cx| {
5142 let snapshot = tree.snapshot();
5143
5144 assert_eq!(
5145 snapshot.status_for_file(project_path.join(A_TXT)),
5146 Some(GitFileStatus::Modified)
5147 );
5148 });
5149
5150 git_add(Path::new(A_TXT), &repo);
5151 git_add(Path::new(B_TXT), &repo);
5152 git_commit("Committing modified and added", &repo);
5153 tree.flush_fs_events(cx).await;
5154 deterministic.run_until_parked();
5155
5156 // Check that repo only changes are tracked
5157 tree.read_with(cx, |tree, _cx| {
5158 let snapshot = tree.snapshot();
5159
5160 assert_eq!(
5161 snapshot.status_for_file(project_path.join(F_TXT)),
5162 Some(GitFileStatus::Added)
5163 );
5164
5165 assert_eq!(snapshot.status_for_file(project_path.join(B_TXT)), None);
5166 assert_eq!(snapshot.status_for_file(project_path.join(A_TXT)), None);
5167 });
5168
5169 git_reset(0, &repo);
5170 git_remove_index(Path::new(B_TXT), &repo);
5171 git_stash(&mut repo);
5172 std::fs::write(work_dir.join(E_TXT), "eeee").unwrap();
5173 std::fs::write(work_dir.join(BUILD_FILE), "this should be ignored").unwrap();
5174 tree.flush_fs_events(cx).await;
5175 deterministic.run_until_parked();
5176
5177 // Check that more complex repo changes are tracked
5178 tree.read_with(cx, |tree, _cx| {
5179 let snapshot = tree.snapshot();
5180
5181 assert_eq!(snapshot.status_for_file(project_path.join(A_TXT)), None);
5182 assert_eq!(
5183 snapshot.status_for_file(project_path.join(B_TXT)),
5184 Some(GitFileStatus::Added)
5185 );
5186 assert_eq!(
5187 snapshot.status_for_file(project_path.join(E_TXT)),
5188 Some(GitFileStatus::Modified)
5189 );
5190 });
5191
5192 std::fs::remove_file(work_dir.join(B_TXT)).unwrap();
5193 std::fs::remove_dir_all(work_dir.join("c")).unwrap();
5194 std::fs::write(
5195 work_dir.join(DOTGITIGNORE),
5196 [IGNORE_RULE, "f.txt"].join("\n"),
5197 )
5198 .unwrap();
5199
5200 git_add(Path::new(DOTGITIGNORE), &repo);
5201 git_commit("Committing modified git ignore", &repo);
5202
5203 tree.flush_fs_events(cx).await;
5204 deterministic.run_until_parked();
5205
5206 let mut renamed_dir_name = "first_directory/second_directory";
5207 const RENAMED_FILE: &'static str = "rf.txt";
5208
5209 std::fs::create_dir_all(work_dir.join(renamed_dir_name)).unwrap();
5210 std::fs::write(
5211 work_dir.join(renamed_dir_name).join(RENAMED_FILE),
5212 "new-contents",
5213 )
5214 .unwrap();
5215
5216 tree.flush_fs_events(cx).await;
5217 deterministic.run_until_parked();
5218
5219 tree.read_with(cx, |tree, _cx| {
5220 let snapshot = tree.snapshot();
5221 assert_eq!(
5222 snapshot
5223 .status_for_file(&project_path.join(renamed_dir_name).join(RENAMED_FILE)),
5224 Some(GitFileStatus::Added)
5225 );
5226 });
5227
5228 renamed_dir_name = "new_first_directory/second_directory";
5229
5230 std::fs::rename(
5231 work_dir.join("first_directory"),
5232 work_dir.join("new_first_directory"),
5233 )
5234 .unwrap();
5235
5236 tree.flush_fs_events(cx).await;
5237 deterministic.run_until_parked();
5238
5239 tree.read_with(cx, |tree, _cx| {
5240 let snapshot = tree.snapshot();
5241
5242 assert_eq!(
5243 snapshot.status_for_file(
5244 project_path
5245 .join(Path::new(renamed_dir_name))
5246 .join(RENAMED_FILE)
5247 ),
5248 Some(GitFileStatus::Added)
5249 );
5250 });
5251 }
5252
5253 #[gpui::test]
5254 async fn test_statuses_for_paths(cx: &mut TestAppContext) {
5255 let fs = FakeFs::new(cx.background());
5256 fs.insert_tree(
5257 "/root",
5258 json!({
5259 ".git": {},
5260 "a": {
5261 "b": {
5262 "c1.txt": "",
5263 "c2.txt": "",
5264 },
5265 "d": {
5266 "e1.txt": "",
5267 "e2.txt": "",
5268 "e3.txt": "",
5269 }
5270 },
5271 "f": {
5272 "no-status.txt": ""
5273 },
5274 "g": {
5275 "h1.txt": "",
5276 "h2.txt": ""
5277 },
5278
5279 }),
5280 )
5281 .await;
5282
5283 fs.set_status_for_repo(
5284 &Path::new("/root/.git"),
5285 &[
5286 (Path::new("a/b/c1.txt"), GitFileStatus::Added),
5287 (Path::new("a/d/e2.txt"), GitFileStatus::Modified),
5288 (Path::new("g/h2.txt"), GitFileStatus::Conflict),
5289 ],
5290 );
5291
5292 let http_client = FakeHttpClient::with_404_response();
5293 let client = cx.read(|cx| Client::new(http_client, cx));
5294 let tree = Worktree::local(
5295 client,
5296 Path::new("/root"),
5297 true,
5298 fs.clone(),
5299 Default::default(),
5300 &mut cx.to_async(),
5301 )
5302 .await
5303 .unwrap();
5304
5305 cx.foreground().run_until_parked();
5306
5307 let snapshot = tree.read_with(cx, |tree, _| tree.snapshot());
5308
5309 assert_eq!(
5310 snapshot.statuses_for_paths(&[
5311 Path::new(""),
5312 Path::new("a"),
5313 Path::new("a/b"),
5314 Path::new("a/d"),
5315 Path::new("f"),
5316 Path::new("g"),
5317 ]),
5318 &[
5319 Some(GitFileStatus::Conflict),
5320 Some(GitFileStatus::Modified),
5321 Some(GitFileStatus::Added),
5322 Some(GitFileStatus::Modified),
5323 None,
5324 Some(GitFileStatus::Conflict),
5325 ]
5326 )
5327 }
5328
5329 #[track_caller]
5330 fn git_init(path: &Path) -> git2::Repository {
5331 git2::Repository::init(path).expect("Failed to initialize git repository")
5332 }
5333
5334 #[track_caller]
5335 fn git_add<P: AsRef<Path>>(path: P, repo: &git2::Repository) {
5336 let path = path.as_ref();
5337 let mut index = repo.index().expect("Failed to get index");
5338 index.add_path(path).expect("Failed to add a.txt");
5339 index.write().expect("Failed to write index");
5340 }
5341
5342 #[track_caller]
5343 fn git_remove_index(path: &Path, repo: &git2::Repository) {
5344 let mut index = repo.index().expect("Failed to get index");
5345 index.remove_path(path).expect("Failed to add a.txt");
5346 index.write().expect("Failed to write index");
5347 }
5348
5349 #[track_caller]
5350 fn git_commit(msg: &'static str, repo: &git2::Repository) {
5351 use git2::Signature;
5352
5353 let signature = Signature::now("test", "test@zed.dev").unwrap();
5354 let oid = repo.index().unwrap().write_tree().unwrap();
5355 let tree = repo.find_tree(oid).unwrap();
5356 if let Some(head) = repo.head().ok() {
5357 let parent_obj = head.peel(git2::ObjectType::Commit).unwrap();
5358
5359 let parent_commit = parent_obj.as_commit().unwrap();
5360
5361 repo.commit(
5362 Some("HEAD"),
5363 &signature,
5364 &signature,
5365 msg,
5366 &tree,
5367 &[parent_commit],
5368 )
5369 .expect("Failed to commit with parent");
5370 } else {
5371 repo.commit(Some("HEAD"), &signature, &signature, msg, &tree, &[])
5372 .expect("Failed to commit");
5373 }
5374 }
5375
5376 #[track_caller]
5377 fn git_stash(repo: &mut git2::Repository) {
5378 use git2::Signature;
5379
5380 let signature = Signature::now("test", "test@zed.dev").unwrap();
5381 repo.stash_save(&signature, "N/A", None)
5382 .expect("Failed to stash");
5383 }
5384
5385 #[track_caller]
5386 fn git_reset(offset: usize, repo: &git2::Repository) {
5387 let head = repo.head().expect("Couldn't get repo head");
5388 let object = head.peel(git2::ObjectType::Commit).unwrap();
5389 let commit = object.as_commit().unwrap();
5390 let new_head = commit
5391 .parents()
5392 .inspect(|parnet| {
5393 parnet.message();
5394 })
5395 .skip(offset)
5396 .next()
5397 .expect("Not enough history");
5398 repo.reset(&new_head.as_object(), git2::ResetType::Soft, None)
5399 .expect("Could not reset");
5400 }
5401
5402 #[allow(dead_code)]
5403 #[track_caller]
5404 fn git_status(repo: &git2::Repository) -> HashMap<String, git2::Status> {
5405 repo.statuses(None)
5406 .unwrap()
5407 .iter()
5408 .map(|status| (status.path().unwrap().to_string(), status.status()))
5409 .collect()
5410 }
5411 }
5412}