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