1use crate::{ProjectEntryId, RemoveOptions};
2
3use super::{
4 fs::{self, Fs},
5 ignore::IgnoreStack,
6 DiagnosticSummary,
7};
8use ::ignore::gitignore::{Gitignore, GitignoreBuilder};
9use anyhow::{anyhow, Context, Result};
10use client::{proto, Client, TypedEnvelope};
11use clock::ReplicaId;
12use collections::HashMap;
13use futures::{
14 channel::{
15 mpsc::{self, UnboundedSender},
16 oneshot,
17 },
18 Stream, StreamExt,
19};
20use fuzzy::CharBag;
21use gpui::{
22 executor, AppContext, AsyncAppContext, Entity, ModelContext, ModelHandle, MutableAppContext,
23 Task,
24};
25use language::{
26 proto::{deserialize_version, serialize_version},
27 Buffer, DiagnosticEntry, PointUtf16, Rope,
28};
29use lazy_static::lazy_static;
30use parking_lot::Mutex;
31use postage::{
32 prelude::{Sink as _, Stream as _},
33 watch,
34};
35use smol::channel::{self, Sender};
36use std::{
37 any::Any,
38 cmp::{self, Ordering},
39 convert::TryFrom,
40 ffi::{OsStr, OsString},
41 fmt,
42 future::Future,
43 mem,
44 ops::{Deref, DerefMut},
45 os::unix::prelude::{OsStrExt, OsStringExt},
46 path::{Path, PathBuf},
47 sync::{atomic::AtomicUsize, Arc},
48 time::{Duration, SystemTime},
49};
50use sum_tree::{Bias, Edit, SeekTarget, SumTree, TreeMap};
51use util::{ResultExt, TryFutureExt};
52
53lazy_static! {
54 static ref GITIGNORE: &'static OsStr = OsStr::new(".gitignore");
55}
56
57#[derive(Copy, Clone, PartialEq, Eq, Debug, Hash, PartialOrd, Ord)]
58pub struct WorktreeId(usize);
59
60pub enum Worktree {
61 Local(LocalWorktree),
62 Remote(RemoteWorktree),
63}
64
65pub struct LocalWorktree {
66 snapshot: LocalSnapshot,
67 background_snapshot: Arc<Mutex<LocalSnapshot>>,
68 last_scan_state_rx: watch::Receiver<ScanState>,
69 _background_scanner_task: Option<Task<()>>,
70 poll_task: Option<Task<()>>,
71 share: Option<ShareState>,
72 diagnostics: HashMap<Arc<Path>, Vec<DiagnosticEntry<PointUtf16>>>,
73 diagnostic_summaries: TreeMap<PathKey, DiagnosticSummary>,
74 client: Arc<Client>,
75 fs: Arc<dyn Fs>,
76 visible: bool,
77}
78
79pub struct RemoteWorktree {
80 pub snapshot: Snapshot,
81 pub(crate) background_snapshot: Arc<Mutex<Snapshot>>,
82 project_id: u64,
83 client: Arc<Client>,
84 updates_tx: Option<UnboundedSender<proto::UpdateWorktree>>,
85 last_scan_id_rx: watch::Receiver<usize>,
86 replica_id: ReplicaId,
87 diagnostic_summaries: TreeMap<PathKey, DiagnosticSummary>,
88 visible: bool,
89}
90
91#[derive(Clone)]
92pub struct Snapshot {
93 id: WorktreeId,
94 root_name: String,
95 root_char_bag: CharBag,
96 entries_by_path: SumTree<Entry>,
97 entries_by_id: SumTree<PathEntry>,
98 scan_id: usize,
99}
100
101#[derive(Clone)]
102pub struct LocalSnapshot {
103 abs_path: Arc<Path>,
104 ignores: HashMap<Arc<Path>, (Arc<Gitignore>, usize)>,
105 removed_entry_ids: HashMap<u64, ProjectEntryId>,
106 next_entry_id: Arc<AtomicUsize>,
107 snapshot: Snapshot,
108}
109
110impl Deref for LocalSnapshot {
111 type Target = Snapshot;
112
113 fn deref(&self) -> &Self::Target {
114 &self.snapshot
115 }
116}
117
118impl DerefMut for LocalSnapshot {
119 fn deref_mut(&mut self) -> &mut Self::Target {
120 &mut self.snapshot
121 }
122}
123
124#[derive(Clone, Debug)]
125enum ScanState {
126 Idle,
127 Scanning,
128 Err(Arc<anyhow::Error>),
129}
130
131struct ShareState {
132 project_id: u64,
133 snapshots_tx: Sender<LocalSnapshot>,
134 _maintain_remote_snapshot: Option<Task<Option<()>>>,
135}
136
137pub enum Event {
138 UpdatedEntries,
139}
140
141impl Entity for Worktree {
142 type Event = Event;
143}
144
145impl Worktree {
146 pub async fn local(
147 client: Arc<Client>,
148 path: impl Into<Arc<Path>>,
149 visible: bool,
150 fs: Arc<dyn Fs>,
151 next_entry_id: Arc<AtomicUsize>,
152 cx: &mut AsyncAppContext,
153 ) -> Result<ModelHandle<Self>> {
154 let (tree, scan_states_tx) =
155 LocalWorktree::new(client, path, visible, fs.clone(), next_entry_id, cx).await?;
156 tree.update(cx, |tree, cx| {
157 let tree = tree.as_local_mut().unwrap();
158 let abs_path = tree.abs_path().clone();
159 let background_snapshot = tree.background_snapshot.clone();
160 let background = cx.background().clone();
161 tree._background_scanner_task = Some(cx.background().spawn(async move {
162 let events = fs.watch(&abs_path, Duration::from_millis(100)).await;
163 let scanner =
164 BackgroundScanner::new(background_snapshot, scan_states_tx, fs, background);
165 scanner.run(events).await;
166 }));
167 });
168 Ok(tree)
169 }
170
171 pub fn remote(
172 project_remote_id: u64,
173 replica_id: ReplicaId,
174 worktree: proto::Worktree,
175 client: Arc<Client>,
176 cx: &mut MutableAppContext,
177 ) -> (ModelHandle<Self>, Task<()>) {
178 let remote_id = worktree.id;
179 let root_char_bag: CharBag = worktree
180 .root_name
181 .chars()
182 .map(|c| c.to_ascii_lowercase())
183 .collect();
184 let root_name = worktree.root_name.clone();
185 let visible = worktree.visible;
186 let snapshot = Snapshot {
187 id: WorktreeId(remote_id as usize),
188 root_name,
189 root_char_bag,
190 entries_by_path: Default::default(),
191 entries_by_id: Default::default(),
192 scan_id: worktree.scan_id as usize,
193 };
194
195 let (updates_tx, mut updates_rx) = mpsc::unbounded();
196 let background_snapshot = Arc::new(Mutex::new(snapshot.clone()));
197 let (mut snapshot_updated_tx, mut snapshot_updated_rx) = watch::channel();
198 let (mut last_scan_id_tx, last_scan_id_rx) = watch::channel_with(worktree.scan_id as usize);
199 let worktree_handle = cx.add_model(|_: &mut ModelContext<Worktree>| {
200 Worktree::Remote(RemoteWorktree {
201 project_id: project_remote_id,
202 replica_id,
203 snapshot: snapshot.clone(),
204 background_snapshot: background_snapshot.clone(),
205 updates_tx: Some(updates_tx),
206 last_scan_id_rx,
207 client: client.clone(),
208 diagnostic_summaries: TreeMap::from_ordered_entries(
209 worktree.diagnostic_summaries.into_iter().map(|summary| {
210 (
211 PathKey(PathBuf::from(summary.path).into()),
212 DiagnosticSummary {
213 language_server_id: summary.language_server_id as usize,
214 error_count: summary.error_count as usize,
215 warning_count: summary.warning_count as usize,
216 },
217 )
218 }),
219 ),
220 visible,
221 })
222 });
223
224 let deserialize_task = cx.spawn({
225 let worktree_handle = worktree_handle.clone();
226 |cx| async move {
227 let (entries_by_path, entries_by_id) = cx
228 .background()
229 .spawn(async move {
230 let mut entries_by_path_edits = Vec::new();
231 let mut entries_by_id_edits = Vec::new();
232 for entry in worktree.entries {
233 match Entry::try_from((&root_char_bag, entry)) {
234 Ok(entry) => {
235 entries_by_id_edits.push(Edit::Insert(PathEntry {
236 id: entry.id,
237 path: entry.path.clone(),
238 is_ignored: entry.is_ignored,
239 scan_id: 0,
240 }));
241 entries_by_path_edits.push(Edit::Insert(entry));
242 }
243 Err(err) => log::warn!("error for remote worktree entry {:?}", err),
244 }
245 }
246
247 let mut entries_by_path = SumTree::new();
248 let mut entries_by_id = SumTree::new();
249 entries_by_path.edit(entries_by_path_edits, &());
250 entries_by_id.edit(entries_by_id_edits, &());
251
252 (entries_by_path, entries_by_id)
253 })
254 .await;
255
256 {
257 let mut snapshot = background_snapshot.lock();
258 snapshot.entries_by_path = entries_by_path;
259 snapshot.entries_by_id = entries_by_id;
260 snapshot_updated_tx.send(()).await.ok();
261 }
262
263 cx.background()
264 .spawn(async move {
265 while let Some(update) = updates_rx.next().await {
266 if let Err(error) =
267 background_snapshot.lock().apply_remote_update(update)
268 {
269 log::error!("error applying worktree update: {}", error);
270 }
271 snapshot_updated_tx.send(()).await.ok();
272 }
273 })
274 .detach();
275
276 cx.spawn(|mut cx| {
277 let this = worktree_handle.downgrade();
278 async move {
279 while let Some(_) = snapshot_updated_rx.recv().await {
280 if let Some(this) = this.upgrade(&cx) {
281 this.update(&mut cx, |this, cx| {
282 this.poll_snapshot(cx);
283 let this = this.as_remote_mut().unwrap();
284 *last_scan_id_tx.borrow_mut() = this.snapshot.scan_id;
285 });
286 } else {
287 break;
288 }
289 }
290 }
291 })
292 .detach();
293 }
294 });
295 (worktree_handle, deserialize_task)
296 }
297
298 pub fn as_local(&self) -> Option<&LocalWorktree> {
299 if let Worktree::Local(worktree) = self {
300 Some(worktree)
301 } else {
302 None
303 }
304 }
305
306 pub fn as_remote(&self) -> Option<&RemoteWorktree> {
307 if let Worktree::Remote(worktree) = self {
308 Some(worktree)
309 } else {
310 None
311 }
312 }
313
314 pub fn as_local_mut(&mut self) -> Option<&mut LocalWorktree> {
315 if let Worktree::Local(worktree) = self {
316 Some(worktree)
317 } else {
318 None
319 }
320 }
321
322 pub fn as_remote_mut(&mut self) -> Option<&mut RemoteWorktree> {
323 if let Worktree::Remote(worktree) = self {
324 Some(worktree)
325 } else {
326 None
327 }
328 }
329
330 pub fn is_local(&self) -> bool {
331 matches!(self, Worktree::Local(_))
332 }
333
334 pub fn is_remote(&self) -> bool {
335 !self.is_local()
336 }
337
338 pub fn snapshot(&self) -> Snapshot {
339 match self {
340 Worktree::Local(worktree) => worktree.snapshot().snapshot,
341 Worktree::Remote(worktree) => worktree.snapshot(),
342 }
343 }
344
345 pub fn scan_id(&self) -> usize {
346 match self {
347 Worktree::Local(worktree) => worktree.snapshot.scan_id,
348 Worktree::Remote(worktree) => worktree.snapshot.scan_id,
349 }
350 }
351
352 pub fn is_visible(&self) -> bool {
353 match self {
354 Worktree::Local(worktree) => worktree.visible,
355 Worktree::Remote(worktree) => worktree.visible,
356 }
357 }
358
359 pub fn replica_id(&self) -> ReplicaId {
360 match self {
361 Worktree::Local(_) => 0,
362 Worktree::Remote(worktree) => worktree.replica_id,
363 }
364 }
365
366 pub fn diagnostic_summaries<'a>(
367 &'a self,
368 ) -> impl Iterator<Item = (Arc<Path>, DiagnosticSummary)> + 'a {
369 match self {
370 Worktree::Local(worktree) => &worktree.diagnostic_summaries,
371 Worktree::Remote(worktree) => &worktree.diagnostic_summaries,
372 }
373 .iter()
374 .map(|(path, summary)| (path.0.clone(), summary.clone()))
375 }
376
377 fn poll_snapshot(&mut self, cx: &mut ModelContext<Self>) {
378 match self {
379 Self::Local(worktree) => {
380 let is_fake_fs = worktree.fs.is_fake();
381 worktree.snapshot = worktree.background_snapshot.lock().clone();
382 if worktree.is_scanning() {
383 if worktree.poll_task.is_none() {
384 worktree.poll_task = Some(cx.spawn_weak(|this, mut cx| async move {
385 if is_fake_fs {
386 #[cfg(any(test, feature = "test-support"))]
387 cx.background().simulate_random_delay().await;
388 } else {
389 smol::Timer::after(Duration::from_millis(100)).await;
390 }
391 if let Some(this) = this.upgrade(&cx) {
392 this.update(&mut cx, |this, cx| {
393 this.as_local_mut().unwrap().poll_task = None;
394 this.poll_snapshot(cx);
395 });
396 }
397 }));
398 }
399 } else {
400 worktree.poll_task.take();
401 cx.emit(Event::UpdatedEntries);
402 }
403 }
404 Self::Remote(worktree) => {
405 worktree.snapshot = worktree.background_snapshot.lock().clone();
406 cx.emit(Event::UpdatedEntries);
407 }
408 };
409
410 cx.notify();
411 }
412}
413
414impl LocalWorktree {
415 async fn new(
416 client: Arc<Client>,
417 path: impl Into<Arc<Path>>,
418 visible: bool,
419 fs: Arc<dyn Fs>,
420 next_entry_id: Arc<AtomicUsize>,
421 cx: &mut AsyncAppContext,
422 ) -> Result<(ModelHandle<Worktree>, UnboundedSender<ScanState>)> {
423 let abs_path = path.into();
424 let path: Arc<Path> = Arc::from(Path::new(""));
425
426 // After determining whether the root entry is a file or a directory, populate the
427 // snapshot's "root name", which will be used for the purpose of fuzzy matching.
428 let root_name = abs_path
429 .file_name()
430 .map_or(String::new(), |f| f.to_string_lossy().to_string());
431 let root_char_bag = root_name.chars().map(|c| c.to_ascii_lowercase()).collect();
432 let metadata = fs
433 .metadata(&abs_path)
434 .await
435 .context("failed to stat worktree path")?;
436
437 let (scan_states_tx, mut scan_states_rx) = mpsc::unbounded();
438 let (mut last_scan_state_tx, last_scan_state_rx) = watch::channel_with(ScanState::Scanning);
439 let tree = cx.add_model(move |cx: &mut ModelContext<Worktree>| {
440 let mut snapshot = LocalSnapshot {
441 abs_path,
442 ignores: Default::default(),
443 removed_entry_ids: Default::default(),
444 next_entry_id,
445 snapshot: Snapshot {
446 id: WorktreeId::from_usize(cx.model_id()),
447 root_name: root_name.clone(),
448 root_char_bag,
449 entries_by_path: Default::default(),
450 entries_by_id: Default::default(),
451 scan_id: 0,
452 },
453 };
454 if let Some(metadata) = metadata {
455 let entry = Entry::new(
456 path.into(),
457 &metadata,
458 &snapshot.next_entry_id,
459 snapshot.root_char_bag,
460 );
461 snapshot.insert_entry(entry, fs.as_ref());
462 }
463
464 let tree = Self {
465 snapshot: snapshot.clone(),
466 background_snapshot: Arc::new(Mutex::new(snapshot)),
467 last_scan_state_rx,
468 _background_scanner_task: None,
469 share: None,
470 poll_task: None,
471 diagnostics: Default::default(),
472 diagnostic_summaries: Default::default(),
473 client,
474 fs,
475 visible,
476 };
477
478 cx.spawn_weak(|this, mut cx| async move {
479 while let Some(scan_state) = scan_states_rx.next().await {
480 if let Some(this) = this.upgrade(&cx) {
481 last_scan_state_tx.blocking_send(scan_state).ok();
482 this.update(&mut cx, |this, cx| {
483 this.poll_snapshot(cx);
484 this.as_local().unwrap().broadcast_snapshot()
485 })
486 .await;
487 } else {
488 break;
489 }
490 }
491 })
492 .detach();
493
494 Worktree::Local(tree)
495 });
496
497 Ok((tree, scan_states_tx))
498 }
499
500 pub fn contains_abs_path(&self, path: &Path) -> bool {
501 path.starts_with(&self.abs_path)
502 }
503
504 fn absolutize(&self, path: &Path) -> PathBuf {
505 if path.file_name().is_some() {
506 self.abs_path.join(path)
507 } else {
508 self.abs_path.to_path_buf()
509 }
510 }
511
512 pub(crate) fn load_buffer(
513 &mut self,
514 path: &Path,
515 cx: &mut ModelContext<Worktree>,
516 ) -> Task<Result<ModelHandle<Buffer>>> {
517 let path = Arc::from(path);
518 cx.spawn(move |this, mut cx| async move {
519 let (file, contents) = this
520 .update(&mut cx, |t, cx| t.as_local().unwrap().load(&path, cx))
521 .await?;
522 Ok(cx.add_model(|cx| Buffer::from_file(0, contents, Arc::new(file), cx)))
523 })
524 }
525
526 pub fn diagnostics_for_path(&self, path: &Path) -> Option<Vec<DiagnosticEntry<PointUtf16>>> {
527 self.diagnostics.get(path).cloned()
528 }
529
530 pub fn update_diagnostics(
531 &mut self,
532 language_server_id: usize,
533 worktree_path: Arc<Path>,
534 diagnostics: Vec<DiagnosticEntry<PointUtf16>>,
535 _: &mut ModelContext<Worktree>,
536 ) -> Result<bool> {
537 self.diagnostics.remove(&worktree_path);
538 let old_summary = self
539 .diagnostic_summaries
540 .remove(&PathKey(worktree_path.clone()))
541 .unwrap_or_default();
542 let new_summary = DiagnosticSummary::new(language_server_id, &diagnostics);
543 if !new_summary.is_empty() {
544 self.diagnostic_summaries
545 .insert(PathKey(worktree_path.clone()), new_summary);
546 self.diagnostics.insert(worktree_path.clone(), diagnostics);
547 }
548
549 let updated = !old_summary.is_empty() || !new_summary.is_empty();
550 if updated {
551 if let Some(share) = self.share.as_ref() {
552 self.client
553 .send(proto::UpdateDiagnosticSummary {
554 project_id: share.project_id,
555 worktree_id: self.id().to_proto(),
556 summary: Some(proto::DiagnosticSummary {
557 path: worktree_path.to_string_lossy().to_string(),
558 language_server_id: language_server_id as u64,
559 error_count: new_summary.error_count as u32,
560 warning_count: new_summary.warning_count as u32,
561 }),
562 })
563 .log_err();
564 }
565 }
566
567 Ok(updated)
568 }
569
570 pub fn scan_complete(&self) -> impl Future<Output = ()> {
571 let mut scan_state_rx = self.last_scan_state_rx.clone();
572 async move {
573 let mut scan_state = Some(scan_state_rx.borrow().clone());
574 while let Some(ScanState::Scanning) = scan_state {
575 scan_state = scan_state_rx.recv().await;
576 }
577 }
578 }
579
580 fn is_scanning(&self) -> bool {
581 if let ScanState::Scanning = *self.last_scan_state_rx.borrow() {
582 true
583 } else {
584 false
585 }
586 }
587
588 pub fn snapshot(&self) -> LocalSnapshot {
589 self.snapshot.clone()
590 }
591
592 pub fn metadata_proto(&self) -> proto::WorktreeMetadata {
593 proto::WorktreeMetadata {
594 id: self.id().to_proto(),
595 root_name: self.root_name().to_string(),
596 visible: self.visible,
597 }
598 }
599
600 fn load(&self, path: &Path, cx: &mut ModelContext<Worktree>) -> Task<Result<(File, String)>> {
601 let handle = cx.handle();
602 let path = Arc::from(path);
603 let abs_path = self.absolutize(&path);
604 let fs = self.fs.clone();
605 cx.spawn(|this, mut cx| async move {
606 let text = fs.load(&abs_path).await?;
607 // Eagerly populate the snapshot with an updated entry for the loaded file
608 let entry = this
609 .update(&mut cx, |this, cx| {
610 this.as_local()
611 .unwrap()
612 .refresh_entry(path, abs_path, None, cx)
613 })
614 .await?;
615 this.update(&mut cx, |this, cx| this.poll_snapshot(cx));
616 Ok((
617 File {
618 entry_id: Some(entry.id),
619 worktree: handle,
620 path: entry.path,
621 mtime: entry.mtime,
622 is_local: true,
623 },
624 text,
625 ))
626 })
627 }
628
629 pub fn save_buffer_as(
630 &self,
631 buffer_handle: ModelHandle<Buffer>,
632 path: impl Into<Arc<Path>>,
633 cx: &mut ModelContext<Worktree>,
634 ) -> Task<Result<()>> {
635 let buffer = buffer_handle.read(cx);
636 let text = buffer.as_rope().clone();
637 let fingerprint = text.fingerprint();
638 let version = buffer.version();
639 let save = self.write_file(path, text, cx);
640 let handle = cx.handle();
641 cx.as_mut().spawn(|mut cx| async move {
642 let entry = save.await?;
643 let file = File {
644 entry_id: Some(entry.id),
645 worktree: handle,
646 path: entry.path,
647 mtime: entry.mtime,
648 is_local: true,
649 };
650
651 buffer_handle.update(&mut cx, |buffer, cx| {
652 buffer.did_save(version, fingerprint, file.mtime, Some(Arc::new(file)), cx);
653 });
654
655 Ok(())
656 })
657 }
658
659 pub fn create_entry(
660 &self,
661 path: impl Into<Arc<Path>>,
662 is_dir: bool,
663 cx: &mut ModelContext<Worktree>,
664 ) -> Task<Result<Entry>> {
665 self.write_entry_internal(
666 path,
667 if is_dir {
668 None
669 } else {
670 Some(Default::default())
671 },
672 cx,
673 )
674 }
675
676 pub fn write_file(
677 &self,
678 path: impl Into<Arc<Path>>,
679 text: Rope,
680 cx: &mut ModelContext<Worktree>,
681 ) -> Task<Result<Entry>> {
682 self.write_entry_internal(path, Some(text), cx)
683 }
684
685 pub fn delete_entry(
686 &self,
687 entry_id: ProjectEntryId,
688 cx: &mut ModelContext<Worktree>,
689 ) -> Option<Task<Result<()>>> {
690 let entry = self.entry_for_id(entry_id)?.clone();
691 let abs_path = self.absolutize(&entry.path);
692 let delete = cx.background().spawn({
693 let fs = self.fs.clone();
694 let abs_path = abs_path.clone();
695 async move {
696 if entry.is_file() {
697 fs.remove_file(&abs_path, Default::default()).await
698 } else {
699 fs.remove_dir(
700 &abs_path,
701 RemoveOptions {
702 recursive: true,
703 ignore_if_not_exists: false,
704 },
705 )
706 .await
707 }
708 }
709 });
710
711 Some(cx.spawn(|this, mut cx| async move {
712 delete.await?;
713 this.update(&mut cx, |this, _| {
714 let this = this.as_local_mut().unwrap();
715 let mut snapshot = this.background_snapshot.lock();
716 snapshot.delete_entry(entry_id);
717 });
718 this.update(&mut cx, |this, cx| {
719 this.poll_snapshot(cx);
720 this.as_local().unwrap().broadcast_snapshot()
721 })
722 .await;
723 Ok(())
724 }))
725 }
726
727 pub fn rename_entry(
728 &self,
729 entry_id: ProjectEntryId,
730 new_path: impl Into<Arc<Path>>,
731 cx: &mut ModelContext<Worktree>,
732 ) -> Option<Task<Result<Entry>>> {
733 let old_path = self.entry_for_id(entry_id)?.path.clone();
734 let new_path = new_path.into();
735 let abs_old_path = self.absolutize(&old_path);
736 let abs_new_path = self.absolutize(&new_path);
737 let rename = cx.background().spawn({
738 let fs = self.fs.clone();
739 let abs_new_path = abs_new_path.clone();
740 async move {
741 fs.rename(&abs_old_path, &abs_new_path, Default::default())
742 .await
743 }
744 });
745
746 Some(cx.spawn(|this, mut cx| async move {
747 rename.await?;
748 let entry = this
749 .update(&mut cx, |this, cx| {
750 this.as_local_mut().unwrap().refresh_entry(
751 new_path.clone(),
752 abs_new_path,
753 Some(old_path),
754 cx,
755 )
756 })
757 .await?;
758 this.update(&mut cx, |this, cx| {
759 this.poll_snapshot(cx);
760 this.as_local().unwrap().broadcast_snapshot()
761 })
762 .await;
763 Ok(entry)
764 }))
765 }
766
767 pub fn copy_entry(
768 &self,
769 entry_id: ProjectEntryId,
770 new_path: impl Into<Arc<Path>>,
771 cx: &mut ModelContext<Worktree>,
772 ) -> Option<Task<Result<Entry>>> {
773 let old_path = self.entry_for_id(entry_id)?.path.clone();
774 let new_path = new_path.into();
775 let abs_old_path = self.absolutize(&old_path);
776 let abs_new_path = self.absolutize(&new_path);
777 let copy = cx.background().spawn({
778 let fs = self.fs.clone();
779 let abs_new_path = abs_new_path.clone();
780 async move {
781 fs.copy(&abs_old_path, &abs_new_path, Default::default())
782 .await
783 }
784 });
785
786 Some(cx.spawn(|this, mut cx| async move {
787 copy.await?;
788 let entry = this
789 .update(&mut cx, |this, cx| {
790 this.as_local_mut().unwrap().refresh_entry(
791 new_path.clone(),
792 abs_new_path,
793 None,
794 cx,
795 )
796 })
797 .await?;
798 this.update(&mut cx, |this, cx| {
799 this.poll_snapshot(cx);
800 this.as_local().unwrap().broadcast_snapshot()
801 })
802 .await;
803 Ok(entry)
804 }))
805 }
806
807 fn write_entry_internal(
808 &self,
809 path: impl Into<Arc<Path>>,
810 text_if_file: Option<Rope>,
811 cx: &mut ModelContext<Worktree>,
812 ) -> Task<Result<Entry>> {
813 let path = path.into();
814 let abs_path = self.absolutize(&path);
815 let write = cx.background().spawn({
816 let fs = self.fs.clone();
817 let abs_path = abs_path.clone();
818 async move {
819 if let Some(text) = text_if_file {
820 fs.save(&abs_path, &text).await
821 } else {
822 fs.create_dir(&abs_path).await
823 }
824 }
825 });
826
827 cx.spawn(|this, mut cx| async move {
828 write.await?;
829 let entry = this
830 .update(&mut cx, |this, cx| {
831 this.as_local_mut()
832 .unwrap()
833 .refresh_entry(path, abs_path, None, cx)
834 })
835 .await?;
836 this.update(&mut cx, |this, cx| {
837 this.poll_snapshot(cx);
838 this.as_local().unwrap().broadcast_snapshot()
839 })
840 .await;
841 Ok(entry)
842 })
843 }
844
845 fn refresh_entry(
846 &self,
847 path: Arc<Path>,
848 abs_path: PathBuf,
849 old_path: Option<Arc<Path>>,
850 cx: &mut ModelContext<Worktree>,
851 ) -> Task<Result<Entry>> {
852 let fs = self.fs.clone();
853 let root_char_bag;
854 let next_entry_id;
855 {
856 let snapshot = self.background_snapshot.lock();
857 root_char_bag = snapshot.root_char_bag;
858 next_entry_id = snapshot.next_entry_id.clone();
859 }
860 cx.spawn_weak(|this, mut cx| async move {
861 let mut entry = Entry::new(
862 path.clone(),
863 &fs.metadata(&abs_path)
864 .await?
865 .ok_or_else(|| anyhow!("could not read saved file metadata"))?,
866 &next_entry_id,
867 root_char_bag,
868 );
869
870 let this = this
871 .upgrade(&cx)
872 .ok_or_else(|| anyhow!("worktree was dropped"))?;
873 let (entry, snapshot, snapshots_tx) = this.read_with(&cx, |this, _| {
874 let this = this.as_local().unwrap();
875 let mut snapshot = this.background_snapshot.lock();
876 entry.is_ignored = snapshot
877 .ignore_stack_for_path(&path, entry.is_dir())
878 .is_path_ignored(&path, entry.is_dir());
879 if let Some(old_path) = old_path {
880 snapshot.remove_path(&old_path);
881 }
882 let entry = snapshot.insert_entry(entry, fs.as_ref());
883 snapshot.scan_id += 1;
884 let snapshots_tx = this.share.as_ref().map(|s| s.snapshots_tx.clone());
885 (entry, snapshot.clone(), snapshots_tx)
886 });
887 this.update(&mut cx, |this, cx| this.poll_snapshot(cx));
888
889 if let Some(snapshots_tx) = snapshots_tx {
890 snapshots_tx.send(snapshot).await.ok();
891 }
892
893 Ok(entry)
894 })
895 }
896
897 pub fn share(&mut self, project_id: u64, cx: &mut ModelContext<Worktree>) -> Task<Result<()>> {
898 let (share_tx, share_rx) = oneshot::channel();
899 let (snapshots_to_send_tx, snapshots_to_send_rx) =
900 smol::channel::unbounded::<LocalSnapshot>();
901 if self.share.is_some() {
902 let _ = share_tx.send(Ok(()));
903 } else {
904 let rpc = self.client.clone();
905 let worktree_id = cx.model_id() as u64;
906 let maintain_remote_snapshot = cx.background().spawn({
907 let rpc = rpc.clone();
908 let diagnostic_summaries = self.diagnostic_summaries.clone();
909 async move {
910 let mut prev_snapshot = match snapshots_to_send_rx.recv().await {
911 Ok(snapshot) => {
912 if let Err(error) = rpc
913 .request(proto::UpdateWorktree {
914 project_id,
915 worktree_id,
916 root_name: snapshot.root_name().to_string(),
917 updated_entries: snapshot
918 .entries_by_path
919 .iter()
920 .filter(|e| !e.is_ignored)
921 .map(Into::into)
922 .collect(),
923 removed_entries: Default::default(),
924 scan_id: snapshot.scan_id as u64,
925 })
926 .await
927 {
928 let _ = share_tx.send(Err(error));
929 return Err(anyhow!("failed to send initial update worktree"));
930 } else {
931 let _ = share_tx.send(Ok(()));
932 snapshot
933 }
934 }
935 Err(error) => {
936 let _ = share_tx.send(Err(error.into()));
937 return Err(anyhow!("failed to send initial update worktree"));
938 }
939 };
940
941 for (path, summary) in diagnostic_summaries.iter() {
942 rpc.send(proto::UpdateDiagnosticSummary {
943 project_id,
944 worktree_id,
945 summary: Some(summary.to_proto(&path.0)),
946 })?;
947 }
948
949 // Stream ignored entries in chunks.
950 {
951 let mut ignored_entries = prev_snapshot
952 .entries_by_path
953 .iter()
954 .filter(|e| e.is_ignored);
955 let mut ignored_entries_to_send = Vec::new();
956 loop {
957 #[cfg(any(test, feature = "test-support"))]
958 const CHUNK_SIZE: usize = 2;
959 #[cfg(not(any(test, feature = "test-support")))]
960 const CHUNK_SIZE: usize = 256;
961
962 let entry = ignored_entries.next();
963 if ignored_entries_to_send.len() >= CHUNK_SIZE || entry.is_none() {
964 rpc.request(proto::UpdateWorktree {
965 project_id,
966 worktree_id,
967 root_name: prev_snapshot.root_name().to_string(),
968 updated_entries: mem::take(&mut ignored_entries_to_send),
969 removed_entries: Default::default(),
970 scan_id: prev_snapshot.scan_id as u64,
971 })
972 .await?;
973 }
974
975 if let Some(entry) = entry {
976 ignored_entries_to_send.push(entry.into());
977 } else {
978 break;
979 }
980 }
981 }
982
983 while let Ok(mut snapshot) = snapshots_to_send_rx.recv().await {
984 while let Ok(newer_snapshot) = snapshots_to_send_rx.try_recv() {
985 snapshot = newer_snapshot;
986 }
987
988 let message =
989 snapshot.build_update(&prev_snapshot, project_id, worktree_id, true);
990 rpc.request(message).await?;
991 prev_snapshot = snapshot;
992 }
993
994 Ok::<_, anyhow::Error>(())
995 }
996 .log_err()
997 });
998 self.share = Some(ShareState {
999 project_id,
1000 snapshots_tx: snapshots_to_send_tx.clone(),
1001 _maintain_remote_snapshot: Some(maintain_remote_snapshot),
1002 });
1003 }
1004
1005 cx.spawn_weak(|this, cx| async move {
1006 if let Some(this) = this.upgrade(&cx) {
1007 this.read_with(&cx, |this, _| {
1008 let this = this.as_local().unwrap();
1009 let _ = snapshots_to_send_tx.try_send(this.snapshot());
1010 });
1011 }
1012 share_rx
1013 .await
1014 .unwrap_or_else(|_| Err(anyhow!("share ended")))
1015 })
1016 }
1017
1018 pub fn unshare(&mut self) {
1019 self.share.take();
1020 }
1021
1022 pub fn is_shared(&self) -> bool {
1023 self.share.is_some()
1024 }
1025
1026 fn broadcast_snapshot(&self) -> impl Future<Output = ()> {
1027 let mut to_send = None;
1028 if !self.is_scanning() {
1029 if let Some(share) = self.share.as_ref() {
1030 to_send = Some((self.snapshot(), share.snapshots_tx.clone()));
1031 }
1032 }
1033
1034 async move {
1035 if let Some((snapshot, snapshots_to_send_tx)) = to_send {
1036 if let Err(err) = snapshots_to_send_tx.send(snapshot).await {
1037 log::error!("error submitting snapshot to send {}", err);
1038 }
1039 }
1040 }
1041 }
1042}
1043
1044impl RemoteWorktree {
1045 fn snapshot(&self) -> Snapshot {
1046 self.snapshot.clone()
1047 }
1048
1049 pub fn disconnected_from_host(&mut self) {
1050 self.updates_tx.take();
1051 }
1052
1053 pub fn update_from_remote(
1054 &mut self,
1055 envelope: TypedEnvelope<proto::UpdateWorktree>,
1056 ) -> Result<()> {
1057 if let Some(updates_tx) = &self.updates_tx {
1058 updates_tx
1059 .unbounded_send(envelope.payload)
1060 .expect("consumer runs to completion");
1061 }
1062 Ok(())
1063 }
1064
1065 fn wait_for_snapshot(&self, scan_id: usize) -> impl Future<Output = ()> {
1066 let mut rx = self.last_scan_id_rx.clone();
1067 async move {
1068 while let Some(applied_scan_id) = rx.next().await {
1069 if applied_scan_id >= scan_id {
1070 return;
1071 }
1072 }
1073 }
1074 }
1075
1076 pub fn update_diagnostic_summary(
1077 &mut self,
1078 path: Arc<Path>,
1079 summary: &proto::DiagnosticSummary,
1080 ) {
1081 let summary = DiagnosticSummary {
1082 language_server_id: summary.language_server_id as usize,
1083 error_count: summary.error_count as usize,
1084 warning_count: summary.warning_count as usize,
1085 };
1086 if summary.is_empty() {
1087 self.diagnostic_summaries.remove(&PathKey(path.clone()));
1088 } else {
1089 self.diagnostic_summaries
1090 .insert(PathKey(path.clone()), summary);
1091 }
1092 }
1093
1094 pub fn insert_entry(
1095 &self,
1096 entry: proto::Entry,
1097 scan_id: usize,
1098 cx: &mut ModelContext<Worktree>,
1099 ) -> Task<Result<Entry>> {
1100 let wait_for_snapshot = self.wait_for_snapshot(scan_id);
1101 cx.spawn(|this, mut cx| async move {
1102 wait_for_snapshot.await;
1103 this.update(&mut cx, |worktree, _| {
1104 let worktree = worktree.as_remote_mut().unwrap();
1105 let mut snapshot = worktree.background_snapshot.lock();
1106 let entry = snapshot.insert_entry(entry);
1107 worktree.snapshot = snapshot.clone();
1108 entry
1109 })
1110 })
1111 }
1112
1113 pub(crate) fn delete_entry(
1114 &self,
1115 id: ProjectEntryId,
1116 scan_id: usize,
1117 cx: &mut ModelContext<Worktree>,
1118 ) -> Task<Result<()>> {
1119 let wait_for_snapshot = self.wait_for_snapshot(scan_id);
1120 cx.spawn(|this, mut cx| async move {
1121 wait_for_snapshot.await;
1122 this.update(&mut cx, |worktree, _| {
1123 let worktree = worktree.as_remote_mut().unwrap();
1124 let mut snapshot = worktree.background_snapshot.lock();
1125 snapshot.delete_entry(id);
1126 worktree.snapshot = snapshot.clone();
1127 });
1128 Ok(())
1129 })
1130 }
1131}
1132
1133impl Snapshot {
1134 pub fn id(&self) -> WorktreeId {
1135 self.id
1136 }
1137
1138 pub fn contains_entry(&self, entry_id: ProjectEntryId) -> bool {
1139 self.entries_by_id.get(&entry_id, &()).is_some()
1140 }
1141
1142 pub(crate) fn insert_entry(&mut self, entry: proto::Entry) -> Result<Entry> {
1143 let entry = Entry::try_from((&self.root_char_bag, entry))?;
1144 let old_entry = self.entries_by_id.insert_or_replace(
1145 PathEntry {
1146 id: entry.id,
1147 path: entry.path.clone(),
1148 is_ignored: entry.is_ignored,
1149 scan_id: 0,
1150 },
1151 &(),
1152 );
1153 if let Some(old_entry) = old_entry {
1154 self.entries_by_path.remove(&PathKey(old_entry.path), &());
1155 }
1156 self.entries_by_path.insert_or_replace(entry.clone(), &());
1157 Ok(entry)
1158 }
1159
1160 fn delete_entry(&mut self, entry_id: ProjectEntryId) -> bool {
1161 if let Some(removed_entry) = self.entries_by_id.remove(&entry_id, &()) {
1162 self.entries_by_path = {
1163 let mut cursor = self.entries_by_path.cursor();
1164 let mut new_entries_by_path =
1165 cursor.slice(&TraversalTarget::Path(&removed_entry.path), Bias::Left, &());
1166 while let Some(entry) = cursor.item() {
1167 if entry.path.starts_with(&removed_entry.path) {
1168 self.entries_by_id.remove(&entry.id, &());
1169 cursor.next(&());
1170 } else {
1171 break;
1172 }
1173 }
1174 new_entries_by_path.push_tree(cursor.suffix(&()), &());
1175 new_entries_by_path
1176 };
1177
1178 true
1179 } else {
1180 false
1181 }
1182 }
1183
1184 pub(crate) fn apply_remote_update(&mut self, update: proto::UpdateWorktree) -> Result<()> {
1185 let mut entries_by_path_edits = Vec::new();
1186 let mut entries_by_id_edits = Vec::new();
1187 for entry_id in update.removed_entries {
1188 let entry = self
1189 .entry_for_id(ProjectEntryId::from_proto(entry_id))
1190 .ok_or_else(|| anyhow!("unknown entry"))?;
1191 entries_by_path_edits.push(Edit::Remove(PathKey(entry.path.clone())));
1192 entries_by_id_edits.push(Edit::Remove(entry.id));
1193 }
1194
1195 for entry in update.updated_entries {
1196 let entry = Entry::try_from((&self.root_char_bag, entry))?;
1197 if let Some(PathEntry { path, .. }) = self.entries_by_id.get(&entry.id, &()) {
1198 entries_by_path_edits.push(Edit::Remove(PathKey(path.clone())));
1199 }
1200 entries_by_id_edits.push(Edit::Insert(PathEntry {
1201 id: entry.id,
1202 path: entry.path.clone(),
1203 is_ignored: entry.is_ignored,
1204 scan_id: 0,
1205 }));
1206 entries_by_path_edits.push(Edit::Insert(entry));
1207 }
1208
1209 self.entries_by_path.edit(entries_by_path_edits, &());
1210 self.entries_by_id.edit(entries_by_id_edits, &());
1211 self.scan_id = update.scan_id as usize;
1212
1213 Ok(())
1214 }
1215
1216 pub fn file_count(&self) -> usize {
1217 self.entries_by_path.summary().file_count
1218 }
1219
1220 pub fn visible_file_count(&self) -> usize {
1221 self.entries_by_path.summary().visible_file_count
1222 }
1223
1224 fn traverse_from_offset(
1225 &self,
1226 include_dirs: bool,
1227 include_ignored: bool,
1228 start_offset: usize,
1229 ) -> Traversal {
1230 let mut cursor = self.entries_by_path.cursor();
1231 cursor.seek(
1232 &TraversalTarget::Count {
1233 count: start_offset,
1234 include_dirs,
1235 include_ignored,
1236 },
1237 Bias::Right,
1238 &(),
1239 );
1240 Traversal {
1241 cursor,
1242 include_dirs,
1243 include_ignored,
1244 }
1245 }
1246
1247 fn traverse_from_path(
1248 &self,
1249 include_dirs: bool,
1250 include_ignored: bool,
1251 path: &Path,
1252 ) -> Traversal {
1253 let mut cursor = self.entries_by_path.cursor();
1254 cursor.seek(&TraversalTarget::Path(path), Bias::Left, &());
1255 Traversal {
1256 cursor,
1257 include_dirs,
1258 include_ignored,
1259 }
1260 }
1261
1262 pub fn files(&self, include_ignored: bool, start: usize) -> Traversal {
1263 self.traverse_from_offset(false, include_ignored, start)
1264 }
1265
1266 pub fn entries(&self, include_ignored: bool) -> Traversal {
1267 self.traverse_from_offset(true, include_ignored, 0)
1268 }
1269
1270 pub fn paths(&self) -> impl Iterator<Item = &Arc<Path>> {
1271 let empty_path = Path::new("");
1272 self.entries_by_path
1273 .cursor::<()>()
1274 .filter(move |entry| entry.path.as_ref() != empty_path)
1275 .map(|entry| &entry.path)
1276 }
1277
1278 fn child_entries<'a>(&'a self, parent_path: &'a Path) -> ChildEntriesIter<'a> {
1279 let mut cursor = self.entries_by_path.cursor();
1280 cursor.seek(&TraversalTarget::Path(parent_path), Bias::Right, &());
1281 let traversal = Traversal {
1282 cursor,
1283 include_dirs: true,
1284 include_ignored: true,
1285 };
1286 ChildEntriesIter {
1287 traversal,
1288 parent_path,
1289 }
1290 }
1291
1292 pub fn root_entry(&self) -> Option<&Entry> {
1293 self.entry_for_path("")
1294 }
1295
1296 pub fn root_name(&self) -> &str {
1297 &self.root_name
1298 }
1299
1300 pub fn scan_id(&self) -> usize {
1301 self.scan_id
1302 }
1303
1304 pub fn entry_for_path(&self, path: impl AsRef<Path>) -> Option<&Entry> {
1305 let path = path.as_ref();
1306 self.traverse_from_path(true, true, path)
1307 .entry()
1308 .and_then(|entry| {
1309 if entry.path.as_ref() == path {
1310 Some(entry)
1311 } else {
1312 None
1313 }
1314 })
1315 }
1316
1317 pub fn entry_for_id(&self, id: ProjectEntryId) -> Option<&Entry> {
1318 let entry = self.entries_by_id.get(&id, &())?;
1319 self.entry_for_path(&entry.path)
1320 }
1321
1322 pub fn inode_for_path(&self, path: impl AsRef<Path>) -> Option<u64> {
1323 self.entry_for_path(path.as_ref()).map(|e| e.inode)
1324 }
1325}
1326
1327impl LocalSnapshot {
1328 pub fn abs_path(&self) -> &Arc<Path> {
1329 &self.abs_path
1330 }
1331
1332 #[cfg(test)]
1333 pub(crate) fn to_proto(
1334 &self,
1335 diagnostic_summaries: &TreeMap<PathKey, DiagnosticSummary>,
1336 visible: bool,
1337 ) -> proto::Worktree {
1338 let root_name = self.root_name.clone();
1339 proto::Worktree {
1340 id: self.id.0 as u64,
1341 root_name,
1342 entries: self
1343 .entries_by_path
1344 .iter()
1345 .filter(|e| !e.is_ignored)
1346 .map(Into::into)
1347 .collect(),
1348 diagnostic_summaries: diagnostic_summaries
1349 .iter()
1350 .map(|(path, summary)| summary.to_proto(&path.0))
1351 .collect(),
1352 visible,
1353 scan_id: self.scan_id as u64,
1354 }
1355 }
1356
1357 pub(crate) fn build_update(
1358 &self,
1359 other: &Self,
1360 project_id: u64,
1361 worktree_id: u64,
1362 include_ignored: bool,
1363 ) -> proto::UpdateWorktree {
1364 let mut updated_entries = Vec::new();
1365 let mut removed_entries = Vec::new();
1366 let mut self_entries = self
1367 .entries_by_id
1368 .cursor::<()>()
1369 .filter(|e| include_ignored || !e.is_ignored)
1370 .peekable();
1371 let mut other_entries = other
1372 .entries_by_id
1373 .cursor::<()>()
1374 .filter(|e| include_ignored || !e.is_ignored)
1375 .peekable();
1376 loop {
1377 match (self_entries.peek(), other_entries.peek()) {
1378 (Some(self_entry), Some(other_entry)) => {
1379 match Ord::cmp(&self_entry.id, &other_entry.id) {
1380 Ordering::Less => {
1381 let entry = self.entry_for_id(self_entry.id).unwrap().into();
1382 updated_entries.push(entry);
1383 self_entries.next();
1384 }
1385 Ordering::Equal => {
1386 if self_entry.scan_id != other_entry.scan_id {
1387 let entry = self.entry_for_id(self_entry.id).unwrap().into();
1388 updated_entries.push(entry);
1389 }
1390
1391 self_entries.next();
1392 other_entries.next();
1393 }
1394 Ordering::Greater => {
1395 removed_entries.push(other_entry.id.to_proto());
1396 other_entries.next();
1397 }
1398 }
1399 }
1400 (Some(self_entry), None) => {
1401 let entry = self.entry_for_id(self_entry.id).unwrap().into();
1402 updated_entries.push(entry);
1403 self_entries.next();
1404 }
1405 (None, Some(other_entry)) => {
1406 removed_entries.push(other_entry.id.to_proto());
1407 other_entries.next();
1408 }
1409 (None, None) => break,
1410 }
1411 }
1412
1413 proto::UpdateWorktree {
1414 project_id,
1415 worktree_id,
1416 root_name: self.root_name().to_string(),
1417 updated_entries,
1418 removed_entries,
1419 scan_id: self.scan_id as u64,
1420 }
1421 }
1422
1423 fn insert_entry(&mut self, mut entry: Entry, fs: &dyn Fs) -> Entry {
1424 if !entry.is_dir() && entry.path.file_name() == Some(&GITIGNORE) {
1425 let abs_path = self.abs_path.join(&entry.path);
1426 match build_gitignore(&abs_path, fs) {
1427 Ok(ignore) => {
1428 let ignore_dir_path = entry.path.parent().unwrap();
1429 self.ignores
1430 .insert(ignore_dir_path.into(), (Arc::new(ignore), self.scan_id));
1431 }
1432 Err(error) => {
1433 log::error!(
1434 "error loading .gitignore file {:?} - {:?}",
1435 &entry.path,
1436 error
1437 );
1438 }
1439 }
1440 }
1441
1442 self.reuse_entry_id(&mut entry);
1443 self.entries_by_path.insert_or_replace(entry.clone(), &());
1444 let scan_id = self.scan_id;
1445 self.entries_by_id.insert_or_replace(
1446 PathEntry {
1447 id: entry.id,
1448 path: entry.path.clone(),
1449 is_ignored: entry.is_ignored,
1450 scan_id,
1451 },
1452 &(),
1453 );
1454 entry
1455 }
1456
1457 fn populate_dir(
1458 &mut self,
1459 parent_path: Arc<Path>,
1460 entries: impl IntoIterator<Item = Entry>,
1461 ignore: Option<Arc<Gitignore>>,
1462 ) {
1463 let mut parent_entry = if let Some(parent_entry) =
1464 self.entries_by_path.get(&PathKey(parent_path.clone()), &())
1465 {
1466 parent_entry.clone()
1467 } else {
1468 log::warn!(
1469 "populating a directory {:?} that has been removed",
1470 parent_path
1471 );
1472 return;
1473 };
1474
1475 if let Some(ignore) = ignore {
1476 self.ignores.insert(parent_path, (ignore, self.scan_id));
1477 }
1478 if matches!(parent_entry.kind, EntryKind::PendingDir) {
1479 parent_entry.kind = EntryKind::Dir;
1480 } else {
1481 unreachable!();
1482 }
1483
1484 let mut entries_by_path_edits = vec![Edit::Insert(parent_entry)];
1485 let mut entries_by_id_edits = Vec::new();
1486
1487 for mut entry in entries {
1488 self.reuse_entry_id(&mut entry);
1489 entries_by_id_edits.push(Edit::Insert(PathEntry {
1490 id: entry.id,
1491 path: entry.path.clone(),
1492 is_ignored: entry.is_ignored,
1493 scan_id: self.scan_id,
1494 }));
1495 entries_by_path_edits.push(Edit::Insert(entry));
1496 }
1497
1498 self.entries_by_path.edit(entries_by_path_edits, &());
1499 self.entries_by_id.edit(entries_by_id_edits, &());
1500 }
1501
1502 fn reuse_entry_id(&mut self, entry: &mut Entry) {
1503 if let Some(removed_entry_id) = self.removed_entry_ids.remove(&entry.inode) {
1504 entry.id = removed_entry_id;
1505 } else if let Some(existing_entry) = self.entry_for_path(&entry.path) {
1506 entry.id = existing_entry.id;
1507 }
1508 }
1509
1510 fn remove_path(&mut self, path: &Path) {
1511 let mut new_entries;
1512 let removed_entries;
1513 {
1514 let mut cursor = self.entries_by_path.cursor::<TraversalProgress>();
1515 new_entries = cursor.slice(&TraversalTarget::Path(path), Bias::Left, &());
1516 removed_entries = cursor.slice(&TraversalTarget::PathSuccessor(path), Bias::Left, &());
1517 new_entries.push_tree(cursor.suffix(&()), &());
1518 }
1519 self.entries_by_path = new_entries;
1520
1521 let mut entries_by_id_edits = Vec::new();
1522 for entry in removed_entries.cursor::<()>() {
1523 let removed_entry_id = self
1524 .removed_entry_ids
1525 .entry(entry.inode)
1526 .or_insert(entry.id);
1527 *removed_entry_id = cmp::max(*removed_entry_id, entry.id);
1528 entries_by_id_edits.push(Edit::Remove(entry.id));
1529 }
1530 self.entries_by_id.edit(entries_by_id_edits, &());
1531
1532 if path.file_name() == Some(&GITIGNORE) {
1533 if let Some((_, scan_id)) = self.ignores.get_mut(path.parent().unwrap()) {
1534 *scan_id = self.snapshot.scan_id;
1535 }
1536 }
1537 }
1538
1539 fn ignore_stack_for_path(&self, path: &Path, is_dir: bool) -> Arc<IgnoreStack> {
1540 let mut new_ignores = Vec::new();
1541 for ancestor in path.ancestors().skip(1) {
1542 if let Some((ignore, _)) = self.ignores.get(ancestor) {
1543 new_ignores.push((ancestor, Some(ignore.clone())));
1544 } else {
1545 new_ignores.push((ancestor, None));
1546 }
1547 }
1548
1549 let mut ignore_stack = IgnoreStack::none();
1550 for (parent_path, ignore) in new_ignores.into_iter().rev() {
1551 if ignore_stack.is_path_ignored(&parent_path, true) {
1552 ignore_stack = IgnoreStack::all();
1553 break;
1554 } else if let Some(ignore) = ignore {
1555 ignore_stack = ignore_stack.append(Arc::from(parent_path), ignore);
1556 }
1557 }
1558
1559 if ignore_stack.is_path_ignored(path, is_dir) {
1560 ignore_stack = IgnoreStack::all();
1561 }
1562
1563 ignore_stack
1564 }
1565}
1566
1567fn build_gitignore(abs_path: &Path, fs: &dyn Fs) -> Result<Gitignore> {
1568 let contents = smol::block_on(fs.load(&abs_path))?;
1569 let parent = abs_path.parent().unwrap_or(Path::new("/"));
1570 let mut builder = GitignoreBuilder::new(parent);
1571 for line in contents.lines() {
1572 builder.add_line(Some(abs_path.into()), line)?;
1573 }
1574 Ok(builder.build()?)
1575}
1576
1577impl WorktreeId {
1578 pub fn from_usize(handle_id: usize) -> Self {
1579 Self(handle_id)
1580 }
1581
1582 pub(crate) fn from_proto(id: u64) -> Self {
1583 Self(id as usize)
1584 }
1585
1586 pub fn to_proto(&self) -> u64 {
1587 self.0 as u64
1588 }
1589
1590 pub fn to_usize(&self) -> usize {
1591 self.0
1592 }
1593}
1594
1595impl fmt::Display for WorktreeId {
1596 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1597 self.0.fmt(f)
1598 }
1599}
1600
1601impl Deref for Worktree {
1602 type Target = Snapshot;
1603
1604 fn deref(&self) -> &Self::Target {
1605 match self {
1606 Worktree::Local(worktree) => &worktree.snapshot,
1607 Worktree::Remote(worktree) => &worktree.snapshot,
1608 }
1609 }
1610}
1611
1612impl Deref for LocalWorktree {
1613 type Target = LocalSnapshot;
1614
1615 fn deref(&self) -> &Self::Target {
1616 &self.snapshot
1617 }
1618}
1619
1620impl Deref for RemoteWorktree {
1621 type Target = Snapshot;
1622
1623 fn deref(&self) -> &Self::Target {
1624 &self.snapshot
1625 }
1626}
1627
1628impl fmt::Debug for LocalWorktree {
1629 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1630 self.snapshot.fmt(f)
1631 }
1632}
1633
1634impl fmt::Debug for Snapshot {
1635 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1636 struct EntriesById<'a>(&'a SumTree<PathEntry>);
1637 struct EntriesByPath<'a>(&'a SumTree<Entry>);
1638
1639 impl<'a> fmt::Debug for EntriesByPath<'a> {
1640 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1641 f.debug_map()
1642 .entries(self.0.iter().map(|entry| (&entry.path, entry.id)))
1643 .finish()
1644 }
1645 }
1646
1647 impl<'a> fmt::Debug for EntriesById<'a> {
1648 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1649 f.debug_list().entries(self.0.iter()).finish()
1650 }
1651 }
1652
1653 f.debug_struct("Snapshot")
1654 .field("id", &self.id)
1655 .field("root_name", &self.root_name)
1656 .field("entries_by_path", &EntriesByPath(&self.entries_by_path))
1657 .field("entries_by_id", &EntriesById(&self.entries_by_id))
1658 .finish()
1659 }
1660}
1661
1662#[derive(Clone, PartialEq)]
1663pub struct File {
1664 pub worktree: ModelHandle<Worktree>,
1665 pub path: Arc<Path>,
1666 pub mtime: SystemTime,
1667 pub(crate) entry_id: Option<ProjectEntryId>,
1668 pub(crate) is_local: bool,
1669}
1670
1671impl language::File for File {
1672 fn as_local(&self) -> Option<&dyn language::LocalFile> {
1673 if self.is_local {
1674 Some(self)
1675 } else {
1676 None
1677 }
1678 }
1679
1680 fn mtime(&self) -> SystemTime {
1681 self.mtime
1682 }
1683
1684 fn path(&self) -> &Arc<Path> {
1685 &self.path
1686 }
1687
1688 fn full_path(&self, cx: &AppContext) -> PathBuf {
1689 let mut full_path = PathBuf::new();
1690 full_path.push(self.worktree.read(cx).root_name());
1691 if self.path.components().next().is_some() {
1692 full_path.push(&self.path);
1693 }
1694 full_path
1695 }
1696
1697 /// Returns the last component of this handle's absolute path. If this handle refers to the root
1698 /// of its worktree, then this method will return the name of the worktree itself.
1699 fn file_name(&self, cx: &AppContext) -> OsString {
1700 self.path
1701 .file_name()
1702 .map(|name| name.into())
1703 .unwrap_or_else(|| OsString::from(&self.worktree.read(cx).root_name))
1704 }
1705
1706 fn is_deleted(&self) -> bool {
1707 self.entry_id.is_none()
1708 }
1709
1710 fn save(
1711 &self,
1712 buffer_id: u64,
1713 text: Rope,
1714 version: clock::Global,
1715 cx: &mut MutableAppContext,
1716 ) -> Task<Result<(clock::Global, String, SystemTime)>> {
1717 self.worktree.update(cx, |worktree, cx| match worktree {
1718 Worktree::Local(worktree) => {
1719 let rpc = worktree.client.clone();
1720 let project_id = worktree.share.as_ref().map(|share| share.project_id);
1721 let fingerprint = text.fingerprint();
1722 let save = worktree.write_file(self.path.clone(), text, cx);
1723 cx.background().spawn(async move {
1724 let entry = save.await?;
1725 if let Some(project_id) = project_id {
1726 rpc.send(proto::BufferSaved {
1727 project_id,
1728 buffer_id,
1729 version: serialize_version(&version),
1730 mtime: Some(entry.mtime.into()),
1731 fingerprint: fingerprint.clone(),
1732 })?;
1733 }
1734 Ok((version, fingerprint, entry.mtime))
1735 })
1736 }
1737 Worktree::Remote(worktree) => {
1738 let rpc = worktree.client.clone();
1739 let project_id = worktree.project_id;
1740 cx.foreground().spawn(async move {
1741 let response = rpc
1742 .request(proto::SaveBuffer {
1743 project_id,
1744 buffer_id,
1745 version: serialize_version(&version),
1746 })
1747 .await?;
1748 let version = deserialize_version(response.version);
1749 let mtime = response
1750 .mtime
1751 .ok_or_else(|| anyhow!("missing mtime"))?
1752 .into();
1753 Ok((version, response.fingerprint, mtime))
1754 })
1755 }
1756 })
1757 }
1758
1759 fn as_any(&self) -> &dyn Any {
1760 self
1761 }
1762
1763 fn to_proto(&self) -> rpc::proto::File {
1764 rpc::proto::File {
1765 worktree_id: self.worktree.id() as u64,
1766 entry_id: self.entry_id.map(|entry_id| entry_id.to_proto()),
1767 path: self.path.to_string_lossy().into(),
1768 mtime: Some(self.mtime.into()),
1769 }
1770 }
1771}
1772
1773impl language::LocalFile for File {
1774 fn abs_path(&self, cx: &AppContext) -> PathBuf {
1775 self.worktree
1776 .read(cx)
1777 .as_local()
1778 .unwrap()
1779 .abs_path
1780 .join(&self.path)
1781 }
1782
1783 fn load(&self, cx: &AppContext) -> Task<Result<String>> {
1784 let worktree = self.worktree.read(cx).as_local().unwrap();
1785 let abs_path = worktree.absolutize(&self.path);
1786 let fs = worktree.fs.clone();
1787 cx.background()
1788 .spawn(async move { fs.load(&abs_path).await })
1789 }
1790
1791 fn buffer_reloaded(
1792 &self,
1793 buffer_id: u64,
1794 version: &clock::Global,
1795 fingerprint: String,
1796 mtime: SystemTime,
1797 cx: &mut MutableAppContext,
1798 ) {
1799 let worktree = self.worktree.read(cx).as_local().unwrap();
1800 if let Some(project_id) = worktree.share.as_ref().map(|share| share.project_id) {
1801 worktree
1802 .client
1803 .send(proto::BufferReloaded {
1804 project_id,
1805 buffer_id,
1806 version: serialize_version(&version),
1807 mtime: Some(mtime.into()),
1808 fingerprint,
1809 })
1810 .log_err();
1811 }
1812 }
1813}
1814
1815impl File {
1816 pub fn from_proto(
1817 proto: rpc::proto::File,
1818 worktree: ModelHandle<Worktree>,
1819 cx: &AppContext,
1820 ) -> Result<Self> {
1821 let worktree_id = worktree
1822 .read(cx)
1823 .as_remote()
1824 .ok_or_else(|| anyhow!("not remote"))?
1825 .id();
1826
1827 if worktree_id.to_proto() != proto.worktree_id {
1828 return Err(anyhow!("worktree id does not match file"));
1829 }
1830
1831 Ok(Self {
1832 worktree,
1833 path: Path::new(&proto.path).into(),
1834 mtime: proto.mtime.ok_or_else(|| anyhow!("no timestamp"))?.into(),
1835 entry_id: proto.entry_id.map(ProjectEntryId::from_proto),
1836 is_local: false,
1837 })
1838 }
1839
1840 pub fn from_dyn(file: Option<&dyn language::File>) -> Option<&Self> {
1841 file.and_then(|f| f.as_any().downcast_ref())
1842 }
1843
1844 pub fn worktree_id(&self, cx: &AppContext) -> WorktreeId {
1845 self.worktree.read(cx).id()
1846 }
1847
1848 pub fn project_entry_id(&self, _: &AppContext) -> Option<ProjectEntryId> {
1849 self.entry_id
1850 }
1851}
1852
1853#[derive(Clone, Debug, PartialEq, Eq)]
1854pub struct Entry {
1855 pub id: ProjectEntryId,
1856 pub kind: EntryKind,
1857 pub path: Arc<Path>,
1858 pub inode: u64,
1859 pub mtime: SystemTime,
1860 pub is_symlink: bool,
1861 pub is_ignored: bool,
1862}
1863
1864#[derive(Clone, Copy, Debug, PartialEq, Eq)]
1865pub enum EntryKind {
1866 PendingDir,
1867 Dir,
1868 File(CharBag),
1869}
1870
1871impl Entry {
1872 fn new(
1873 path: Arc<Path>,
1874 metadata: &fs::Metadata,
1875 next_entry_id: &AtomicUsize,
1876 root_char_bag: CharBag,
1877 ) -> Self {
1878 Self {
1879 id: ProjectEntryId::new(next_entry_id),
1880 kind: if metadata.is_dir {
1881 EntryKind::PendingDir
1882 } else {
1883 EntryKind::File(char_bag_for_path(root_char_bag, &path))
1884 },
1885 path,
1886 inode: metadata.inode,
1887 mtime: metadata.mtime,
1888 is_symlink: metadata.is_symlink,
1889 is_ignored: false,
1890 }
1891 }
1892
1893 pub fn is_dir(&self) -> bool {
1894 matches!(self.kind, EntryKind::Dir | EntryKind::PendingDir)
1895 }
1896
1897 pub fn is_file(&self) -> bool {
1898 matches!(self.kind, EntryKind::File(_))
1899 }
1900}
1901
1902impl sum_tree::Item for Entry {
1903 type Summary = EntrySummary;
1904
1905 fn summary(&self) -> Self::Summary {
1906 let visible_count = if self.is_ignored { 0 } else { 1 };
1907 let file_count;
1908 let visible_file_count;
1909 if self.is_file() {
1910 file_count = 1;
1911 visible_file_count = visible_count;
1912 } else {
1913 file_count = 0;
1914 visible_file_count = 0;
1915 }
1916
1917 EntrySummary {
1918 max_path: self.path.clone(),
1919 count: 1,
1920 visible_count,
1921 file_count,
1922 visible_file_count,
1923 }
1924 }
1925}
1926
1927impl sum_tree::KeyedItem for Entry {
1928 type Key = PathKey;
1929
1930 fn key(&self) -> Self::Key {
1931 PathKey(self.path.clone())
1932 }
1933}
1934
1935#[derive(Clone, Debug)]
1936pub struct EntrySummary {
1937 max_path: Arc<Path>,
1938 count: usize,
1939 visible_count: usize,
1940 file_count: usize,
1941 visible_file_count: usize,
1942}
1943
1944impl Default for EntrySummary {
1945 fn default() -> Self {
1946 Self {
1947 max_path: Arc::from(Path::new("")),
1948 count: 0,
1949 visible_count: 0,
1950 file_count: 0,
1951 visible_file_count: 0,
1952 }
1953 }
1954}
1955
1956impl sum_tree::Summary for EntrySummary {
1957 type Context = ();
1958
1959 fn add_summary(&mut self, rhs: &Self, _: &()) {
1960 self.max_path = rhs.max_path.clone();
1961 self.count += rhs.count;
1962 self.visible_count += rhs.visible_count;
1963 self.file_count += rhs.file_count;
1964 self.visible_file_count += rhs.visible_file_count;
1965 }
1966}
1967
1968#[derive(Clone, Debug)]
1969struct PathEntry {
1970 id: ProjectEntryId,
1971 path: Arc<Path>,
1972 is_ignored: bool,
1973 scan_id: usize,
1974}
1975
1976impl sum_tree::Item for PathEntry {
1977 type Summary = PathEntrySummary;
1978
1979 fn summary(&self) -> Self::Summary {
1980 PathEntrySummary { max_id: self.id }
1981 }
1982}
1983
1984impl sum_tree::KeyedItem for PathEntry {
1985 type Key = ProjectEntryId;
1986
1987 fn key(&self) -> Self::Key {
1988 self.id
1989 }
1990}
1991
1992#[derive(Clone, Debug, Default)]
1993struct PathEntrySummary {
1994 max_id: ProjectEntryId,
1995}
1996
1997impl sum_tree::Summary for PathEntrySummary {
1998 type Context = ();
1999
2000 fn add_summary(&mut self, summary: &Self, _: &Self::Context) {
2001 self.max_id = summary.max_id;
2002 }
2003}
2004
2005impl<'a> sum_tree::Dimension<'a, PathEntrySummary> for ProjectEntryId {
2006 fn add_summary(&mut self, summary: &'a PathEntrySummary, _: &()) {
2007 *self = summary.max_id;
2008 }
2009}
2010
2011#[derive(Clone, Debug, Eq, PartialEq, Ord, PartialOrd)]
2012pub struct PathKey(Arc<Path>);
2013
2014impl Default for PathKey {
2015 fn default() -> Self {
2016 Self(Path::new("").into())
2017 }
2018}
2019
2020impl<'a> sum_tree::Dimension<'a, EntrySummary> for PathKey {
2021 fn add_summary(&mut self, summary: &'a EntrySummary, _: &()) {
2022 self.0 = summary.max_path.clone();
2023 }
2024}
2025
2026struct BackgroundScanner {
2027 fs: Arc<dyn Fs>,
2028 snapshot: Arc<Mutex<LocalSnapshot>>,
2029 notify: UnboundedSender<ScanState>,
2030 executor: Arc<executor::Background>,
2031}
2032
2033impl BackgroundScanner {
2034 fn new(
2035 snapshot: Arc<Mutex<LocalSnapshot>>,
2036 notify: UnboundedSender<ScanState>,
2037 fs: Arc<dyn Fs>,
2038 executor: Arc<executor::Background>,
2039 ) -> Self {
2040 Self {
2041 fs,
2042 snapshot,
2043 notify,
2044 executor,
2045 }
2046 }
2047
2048 fn abs_path(&self) -> Arc<Path> {
2049 self.snapshot.lock().abs_path.clone()
2050 }
2051
2052 fn snapshot(&self) -> LocalSnapshot {
2053 self.snapshot.lock().clone()
2054 }
2055
2056 async fn run(mut self, events_rx: impl Stream<Item = Vec<fsevent::Event>>) {
2057 if self.notify.unbounded_send(ScanState::Scanning).is_err() {
2058 return;
2059 }
2060
2061 if let Err(err) = self.scan_dirs().await {
2062 if self
2063 .notify
2064 .unbounded_send(ScanState::Err(Arc::new(err)))
2065 .is_err()
2066 {
2067 return;
2068 }
2069 }
2070
2071 if self.notify.unbounded_send(ScanState::Idle).is_err() {
2072 return;
2073 }
2074
2075 futures::pin_mut!(events_rx);
2076 while let Some(events) = events_rx.next().await {
2077 if self.notify.unbounded_send(ScanState::Scanning).is_err() {
2078 break;
2079 }
2080
2081 if !self.process_events(events).await {
2082 break;
2083 }
2084
2085 if self.notify.unbounded_send(ScanState::Idle).is_err() {
2086 break;
2087 }
2088 }
2089 }
2090
2091 async fn scan_dirs(&mut self) -> Result<()> {
2092 let root_char_bag;
2093 let next_entry_id;
2094 let is_dir;
2095 {
2096 let snapshot = self.snapshot.lock();
2097 root_char_bag = snapshot.root_char_bag;
2098 next_entry_id = snapshot.next_entry_id.clone();
2099 is_dir = snapshot.root_entry().map_or(false, |e| e.is_dir())
2100 };
2101
2102 if is_dir {
2103 let path: Arc<Path> = Arc::from(Path::new(""));
2104 let abs_path = self.abs_path();
2105 let (tx, rx) = channel::unbounded();
2106 self.executor
2107 .block(tx.send(ScanJob {
2108 abs_path: abs_path.to_path_buf(),
2109 path,
2110 ignore_stack: IgnoreStack::none(),
2111 scan_queue: tx.clone(),
2112 }))
2113 .unwrap();
2114 drop(tx);
2115
2116 self.executor
2117 .scoped(|scope| {
2118 for _ in 0..self.executor.num_cpus() {
2119 scope.spawn(async {
2120 while let Ok(job) = rx.recv().await {
2121 if let Err(err) = self
2122 .scan_dir(root_char_bag, next_entry_id.clone(), &job)
2123 .await
2124 {
2125 log::error!("error scanning {:?}: {}", job.abs_path, err);
2126 }
2127 }
2128 });
2129 }
2130 })
2131 .await;
2132 }
2133
2134 Ok(())
2135 }
2136
2137 async fn scan_dir(
2138 &self,
2139 root_char_bag: CharBag,
2140 next_entry_id: Arc<AtomicUsize>,
2141 job: &ScanJob,
2142 ) -> Result<()> {
2143 let mut new_entries: Vec<Entry> = Vec::new();
2144 let mut new_jobs: Vec<ScanJob> = Vec::new();
2145 let mut ignore_stack = job.ignore_stack.clone();
2146 let mut new_ignore = None;
2147
2148 let mut child_paths = self.fs.read_dir(&job.abs_path).await?;
2149 while let Some(child_abs_path) = child_paths.next().await {
2150 let child_abs_path = match child_abs_path {
2151 Ok(child_abs_path) => child_abs_path,
2152 Err(error) => {
2153 log::error!("error processing entry {:?}", error);
2154 continue;
2155 }
2156 };
2157 let child_name = child_abs_path.file_name().unwrap();
2158 let child_path: Arc<Path> = job.path.join(child_name).into();
2159 let child_metadata = match self.fs.metadata(&child_abs_path).await {
2160 Ok(Some(metadata)) => metadata,
2161 Ok(None) => continue,
2162 Err(err) => {
2163 log::error!("error processing {:?}: {:?}", child_abs_path, err);
2164 continue;
2165 }
2166 };
2167
2168 // If we find a .gitignore, add it to the stack of ignores used to determine which paths are ignored
2169 if child_name == *GITIGNORE {
2170 match build_gitignore(&child_abs_path, self.fs.as_ref()) {
2171 Ok(ignore) => {
2172 let ignore = Arc::new(ignore);
2173 ignore_stack = ignore_stack.append(job.path.clone(), ignore.clone());
2174 new_ignore = Some(ignore);
2175 }
2176 Err(error) => {
2177 log::error!(
2178 "error loading .gitignore file {:?} - {:?}",
2179 child_name,
2180 error
2181 );
2182 }
2183 }
2184
2185 // Update ignore status of any child entries we've already processed to reflect the
2186 // ignore file in the current directory. Because `.gitignore` starts with a `.`,
2187 // there should rarely be too numerous. Update the ignore stack associated with any
2188 // new jobs as well.
2189 let mut new_jobs = new_jobs.iter_mut();
2190 for entry in &mut new_entries {
2191 entry.is_ignored = ignore_stack.is_path_ignored(&entry.path, entry.is_dir());
2192 if entry.is_dir() {
2193 new_jobs.next().unwrap().ignore_stack = if entry.is_ignored {
2194 IgnoreStack::all()
2195 } else {
2196 ignore_stack.clone()
2197 };
2198 }
2199 }
2200 }
2201
2202 let mut child_entry = Entry::new(
2203 child_path.clone(),
2204 &child_metadata,
2205 &next_entry_id,
2206 root_char_bag,
2207 );
2208
2209 if child_metadata.is_dir {
2210 let is_ignored = ignore_stack.is_path_ignored(&child_path, true);
2211 child_entry.is_ignored = is_ignored;
2212 new_entries.push(child_entry);
2213 new_jobs.push(ScanJob {
2214 abs_path: child_abs_path,
2215 path: child_path,
2216 ignore_stack: if is_ignored {
2217 IgnoreStack::all()
2218 } else {
2219 ignore_stack.clone()
2220 },
2221 scan_queue: job.scan_queue.clone(),
2222 });
2223 } else {
2224 child_entry.is_ignored = ignore_stack.is_path_ignored(&child_path, false);
2225 new_entries.push(child_entry);
2226 };
2227 }
2228
2229 self.snapshot
2230 .lock()
2231 .populate_dir(job.path.clone(), new_entries, new_ignore);
2232 for new_job in new_jobs {
2233 job.scan_queue.send(new_job).await.unwrap();
2234 }
2235
2236 Ok(())
2237 }
2238
2239 async fn process_events(&mut self, mut events: Vec<fsevent::Event>) -> bool {
2240 events.sort_unstable_by(|a, b| a.path.cmp(&b.path));
2241 events.dedup_by(|a, b| a.path.starts_with(&b.path));
2242
2243 let root_char_bag;
2244 let root_abs_path;
2245 let next_entry_id;
2246 {
2247 let snapshot = self.snapshot.lock();
2248 root_char_bag = snapshot.root_char_bag;
2249 root_abs_path = snapshot.abs_path.clone();
2250 next_entry_id = snapshot.next_entry_id.clone();
2251 }
2252
2253 let root_abs_path = if let Ok(abs_path) = self.fs.canonicalize(&root_abs_path).await {
2254 abs_path
2255 } else {
2256 return false;
2257 };
2258 let metadata = futures::future::join_all(
2259 events
2260 .iter()
2261 .map(|event| self.fs.metadata(&event.path))
2262 .collect::<Vec<_>>(),
2263 )
2264 .await;
2265
2266 // Hold the snapshot lock while clearing and re-inserting the root entries
2267 // for each event. This way, the snapshot is not observable to the foreground
2268 // thread while this operation is in-progress.
2269 let (scan_queue_tx, scan_queue_rx) = channel::unbounded();
2270 {
2271 let mut snapshot = self.snapshot.lock();
2272 snapshot.scan_id += 1;
2273 for event in &events {
2274 if let Ok(path) = event.path.strip_prefix(&root_abs_path) {
2275 snapshot.remove_path(&path);
2276 }
2277 }
2278
2279 for (event, metadata) in events.into_iter().zip(metadata.into_iter()) {
2280 let path: Arc<Path> = match event.path.strip_prefix(&root_abs_path) {
2281 Ok(path) => Arc::from(path.to_path_buf()),
2282 Err(_) => {
2283 log::error!(
2284 "unexpected event {:?} for root path {:?}",
2285 event.path,
2286 root_abs_path
2287 );
2288 continue;
2289 }
2290 };
2291
2292 match metadata {
2293 Ok(Some(metadata)) => {
2294 let ignore_stack = snapshot.ignore_stack_for_path(&path, metadata.is_dir);
2295 let mut fs_entry = Entry::new(
2296 path.clone(),
2297 &metadata,
2298 snapshot.next_entry_id.as_ref(),
2299 snapshot.root_char_bag,
2300 );
2301 fs_entry.is_ignored = ignore_stack.is_all();
2302 snapshot.insert_entry(fs_entry, self.fs.as_ref());
2303 if metadata.is_dir {
2304 self.executor
2305 .block(scan_queue_tx.send(ScanJob {
2306 abs_path: event.path,
2307 path,
2308 ignore_stack,
2309 scan_queue: scan_queue_tx.clone(),
2310 }))
2311 .unwrap();
2312 }
2313 }
2314 Ok(None) => {}
2315 Err(err) => {
2316 // TODO - create a special 'error' entry in the entries tree to mark this
2317 log::error!("error reading file on event {:?}", err);
2318 }
2319 }
2320 }
2321 drop(scan_queue_tx);
2322 }
2323
2324 // Scan any directories that were created as part of this event batch.
2325 self.executor
2326 .scoped(|scope| {
2327 for _ in 0..self.executor.num_cpus() {
2328 scope.spawn(async {
2329 while let Ok(job) = scan_queue_rx.recv().await {
2330 if let Err(err) = self
2331 .scan_dir(root_char_bag, next_entry_id.clone(), &job)
2332 .await
2333 {
2334 log::error!("error scanning {:?}: {}", job.abs_path, err);
2335 }
2336 }
2337 });
2338 }
2339 })
2340 .await;
2341
2342 // Attempt to detect renames only over a single batch of file-system events.
2343 self.snapshot.lock().removed_entry_ids.clear();
2344
2345 self.update_ignore_statuses().await;
2346 true
2347 }
2348
2349 async fn update_ignore_statuses(&self) {
2350 let mut snapshot = self.snapshot();
2351
2352 let mut ignores_to_update = Vec::new();
2353 let mut ignores_to_delete = Vec::new();
2354 for (parent_path, (_, scan_id)) in &snapshot.ignores {
2355 if *scan_id == snapshot.scan_id && snapshot.entry_for_path(parent_path).is_some() {
2356 ignores_to_update.push(parent_path.clone());
2357 }
2358
2359 let ignore_path = parent_path.join(&*GITIGNORE);
2360 if snapshot.entry_for_path(ignore_path).is_none() {
2361 ignores_to_delete.push(parent_path.clone());
2362 }
2363 }
2364
2365 for parent_path in ignores_to_delete {
2366 snapshot.ignores.remove(&parent_path);
2367 self.snapshot.lock().ignores.remove(&parent_path);
2368 }
2369
2370 let (ignore_queue_tx, ignore_queue_rx) = channel::unbounded();
2371 ignores_to_update.sort_unstable();
2372 let mut ignores_to_update = ignores_to_update.into_iter().peekable();
2373 while let Some(parent_path) = ignores_to_update.next() {
2374 while ignores_to_update
2375 .peek()
2376 .map_or(false, |p| p.starts_with(&parent_path))
2377 {
2378 ignores_to_update.next().unwrap();
2379 }
2380
2381 let ignore_stack = snapshot.ignore_stack_for_path(&parent_path, true);
2382 ignore_queue_tx
2383 .send(UpdateIgnoreStatusJob {
2384 path: parent_path,
2385 ignore_stack,
2386 ignore_queue: ignore_queue_tx.clone(),
2387 })
2388 .await
2389 .unwrap();
2390 }
2391 drop(ignore_queue_tx);
2392
2393 self.executor
2394 .scoped(|scope| {
2395 for _ in 0..self.executor.num_cpus() {
2396 scope.spawn(async {
2397 while let Ok(job) = ignore_queue_rx.recv().await {
2398 self.update_ignore_status(job, &snapshot).await;
2399 }
2400 });
2401 }
2402 })
2403 .await;
2404 }
2405
2406 async fn update_ignore_status(&self, job: UpdateIgnoreStatusJob, snapshot: &LocalSnapshot) {
2407 let mut ignore_stack = job.ignore_stack;
2408 if let Some((ignore, _)) = snapshot.ignores.get(&job.path) {
2409 ignore_stack = ignore_stack.append(job.path.clone(), ignore.clone());
2410 }
2411
2412 let mut entries_by_id_edits = Vec::new();
2413 let mut entries_by_path_edits = Vec::new();
2414 for mut entry in snapshot.child_entries(&job.path).cloned() {
2415 let was_ignored = entry.is_ignored;
2416 entry.is_ignored = ignore_stack.is_path_ignored(&entry.path, entry.is_dir());
2417 if entry.is_dir() {
2418 let child_ignore_stack = if entry.is_ignored {
2419 IgnoreStack::all()
2420 } else {
2421 ignore_stack.clone()
2422 };
2423 job.ignore_queue
2424 .send(UpdateIgnoreStatusJob {
2425 path: entry.path.clone(),
2426 ignore_stack: child_ignore_stack,
2427 ignore_queue: job.ignore_queue.clone(),
2428 })
2429 .await
2430 .unwrap();
2431 }
2432
2433 if entry.is_ignored != was_ignored {
2434 let mut path_entry = snapshot.entries_by_id.get(&entry.id, &()).unwrap().clone();
2435 path_entry.scan_id = snapshot.scan_id;
2436 path_entry.is_ignored = entry.is_ignored;
2437 entries_by_id_edits.push(Edit::Insert(path_entry));
2438 entries_by_path_edits.push(Edit::Insert(entry));
2439 }
2440 }
2441
2442 let mut snapshot = self.snapshot.lock();
2443 snapshot.entries_by_path.edit(entries_by_path_edits, &());
2444 snapshot.entries_by_id.edit(entries_by_id_edits, &());
2445 }
2446}
2447
2448fn char_bag_for_path(root_char_bag: CharBag, path: &Path) -> CharBag {
2449 let mut result = root_char_bag;
2450 result.extend(
2451 path.to_string_lossy()
2452 .chars()
2453 .map(|c| c.to_ascii_lowercase()),
2454 );
2455 result
2456}
2457
2458struct ScanJob {
2459 abs_path: PathBuf,
2460 path: Arc<Path>,
2461 ignore_stack: Arc<IgnoreStack>,
2462 scan_queue: Sender<ScanJob>,
2463}
2464
2465struct UpdateIgnoreStatusJob {
2466 path: Arc<Path>,
2467 ignore_stack: Arc<IgnoreStack>,
2468 ignore_queue: Sender<UpdateIgnoreStatusJob>,
2469}
2470
2471pub trait WorktreeHandle {
2472 #[cfg(any(test, feature = "test-support"))]
2473 fn flush_fs_events<'a>(
2474 &self,
2475 cx: &'a gpui::TestAppContext,
2476 ) -> futures::future::LocalBoxFuture<'a, ()>;
2477}
2478
2479impl WorktreeHandle for ModelHandle<Worktree> {
2480 // When the worktree's FS event stream sometimes delivers "redundant" events for FS changes that
2481 // occurred before the worktree was constructed. These events can cause the worktree to perfrom
2482 // extra directory scans, and emit extra scan-state notifications.
2483 //
2484 // This function mutates the worktree's directory and waits for those mutations to be picked up,
2485 // to ensure that all redundant FS events have already been processed.
2486 #[cfg(any(test, feature = "test-support"))]
2487 fn flush_fs_events<'a>(
2488 &self,
2489 cx: &'a gpui::TestAppContext,
2490 ) -> futures::future::LocalBoxFuture<'a, ()> {
2491 use smol::future::FutureExt;
2492
2493 let filename = "fs-event-sentinel";
2494 let tree = self.clone();
2495 let (fs, root_path) = self.read_with(cx, |tree, _| {
2496 let tree = tree.as_local().unwrap();
2497 (tree.fs.clone(), tree.abs_path().clone())
2498 });
2499
2500 async move {
2501 fs.create_file(&root_path.join(filename), Default::default())
2502 .await
2503 .unwrap();
2504 tree.condition(&cx, |tree, _| tree.entry_for_path(filename).is_some())
2505 .await;
2506
2507 fs.remove_file(&root_path.join(filename), Default::default())
2508 .await
2509 .unwrap();
2510 tree.condition(&cx, |tree, _| tree.entry_for_path(filename).is_none())
2511 .await;
2512
2513 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
2514 .await;
2515 }
2516 .boxed_local()
2517 }
2518}
2519
2520#[derive(Clone, Debug)]
2521struct TraversalProgress<'a> {
2522 max_path: &'a Path,
2523 count: usize,
2524 visible_count: usize,
2525 file_count: usize,
2526 visible_file_count: usize,
2527}
2528
2529impl<'a> TraversalProgress<'a> {
2530 fn count(&self, include_dirs: bool, include_ignored: bool) -> usize {
2531 match (include_ignored, include_dirs) {
2532 (true, true) => self.count,
2533 (true, false) => self.file_count,
2534 (false, true) => self.visible_count,
2535 (false, false) => self.visible_file_count,
2536 }
2537 }
2538}
2539
2540impl<'a> sum_tree::Dimension<'a, EntrySummary> for TraversalProgress<'a> {
2541 fn add_summary(&mut self, summary: &'a EntrySummary, _: &()) {
2542 self.max_path = summary.max_path.as_ref();
2543 self.count += summary.count;
2544 self.visible_count += summary.visible_count;
2545 self.file_count += summary.file_count;
2546 self.visible_file_count += summary.visible_file_count;
2547 }
2548}
2549
2550impl<'a> Default for TraversalProgress<'a> {
2551 fn default() -> Self {
2552 Self {
2553 max_path: Path::new(""),
2554 count: 0,
2555 visible_count: 0,
2556 file_count: 0,
2557 visible_file_count: 0,
2558 }
2559 }
2560}
2561
2562pub struct Traversal<'a> {
2563 cursor: sum_tree::Cursor<'a, Entry, TraversalProgress<'a>>,
2564 include_ignored: bool,
2565 include_dirs: bool,
2566}
2567
2568impl<'a> Traversal<'a> {
2569 pub fn advance(&mut self) -> bool {
2570 self.advance_to_offset(self.offset() + 1)
2571 }
2572
2573 pub fn advance_to_offset(&mut self, offset: usize) -> bool {
2574 self.cursor.seek_forward(
2575 &TraversalTarget::Count {
2576 count: offset,
2577 include_dirs: self.include_dirs,
2578 include_ignored: self.include_ignored,
2579 },
2580 Bias::Right,
2581 &(),
2582 )
2583 }
2584
2585 pub fn advance_to_sibling(&mut self) -> bool {
2586 while let Some(entry) = self.cursor.item() {
2587 self.cursor.seek_forward(
2588 &TraversalTarget::PathSuccessor(&entry.path),
2589 Bias::Left,
2590 &(),
2591 );
2592 if let Some(entry) = self.cursor.item() {
2593 if (self.include_dirs || !entry.is_dir())
2594 && (self.include_ignored || !entry.is_ignored)
2595 {
2596 return true;
2597 }
2598 }
2599 }
2600 false
2601 }
2602
2603 pub fn entry(&self) -> Option<&'a Entry> {
2604 self.cursor.item()
2605 }
2606
2607 pub fn offset(&self) -> usize {
2608 self.cursor
2609 .start()
2610 .count(self.include_dirs, self.include_ignored)
2611 }
2612}
2613
2614impl<'a> Iterator for Traversal<'a> {
2615 type Item = &'a Entry;
2616
2617 fn next(&mut self) -> Option<Self::Item> {
2618 if let Some(item) = self.entry() {
2619 self.advance();
2620 Some(item)
2621 } else {
2622 None
2623 }
2624 }
2625}
2626
2627#[derive(Debug)]
2628enum TraversalTarget<'a> {
2629 Path(&'a Path),
2630 PathSuccessor(&'a Path),
2631 Count {
2632 count: usize,
2633 include_ignored: bool,
2634 include_dirs: bool,
2635 },
2636}
2637
2638impl<'a, 'b> SeekTarget<'a, EntrySummary, TraversalProgress<'a>> for TraversalTarget<'b> {
2639 fn cmp(&self, cursor_location: &TraversalProgress<'a>, _: &()) -> Ordering {
2640 match self {
2641 TraversalTarget::Path(path) => path.cmp(&cursor_location.max_path),
2642 TraversalTarget::PathSuccessor(path) => {
2643 if !cursor_location.max_path.starts_with(path) {
2644 Ordering::Equal
2645 } else {
2646 Ordering::Greater
2647 }
2648 }
2649 TraversalTarget::Count {
2650 count,
2651 include_dirs,
2652 include_ignored,
2653 } => Ord::cmp(
2654 count,
2655 &cursor_location.count(*include_dirs, *include_ignored),
2656 ),
2657 }
2658 }
2659}
2660
2661struct ChildEntriesIter<'a> {
2662 parent_path: &'a Path,
2663 traversal: Traversal<'a>,
2664}
2665
2666impl<'a> Iterator for ChildEntriesIter<'a> {
2667 type Item = &'a Entry;
2668
2669 fn next(&mut self) -> Option<Self::Item> {
2670 if let Some(item) = self.traversal.entry() {
2671 if item.path.starts_with(&self.parent_path) {
2672 self.traversal.advance_to_sibling();
2673 return Some(item);
2674 }
2675 }
2676 None
2677 }
2678}
2679
2680impl<'a> From<&'a Entry> for proto::Entry {
2681 fn from(entry: &'a Entry) -> Self {
2682 Self {
2683 id: entry.id.to_proto(),
2684 is_dir: entry.is_dir(),
2685 path: entry.path.as_os_str().as_bytes().to_vec(),
2686 inode: entry.inode,
2687 mtime: Some(entry.mtime.into()),
2688 is_symlink: entry.is_symlink,
2689 is_ignored: entry.is_ignored,
2690 }
2691 }
2692}
2693
2694impl<'a> TryFrom<(&'a CharBag, proto::Entry)> for Entry {
2695 type Error = anyhow::Error;
2696
2697 fn try_from((root_char_bag, entry): (&'a CharBag, proto::Entry)) -> Result<Self> {
2698 if let Some(mtime) = entry.mtime {
2699 let kind = if entry.is_dir {
2700 EntryKind::Dir
2701 } else {
2702 let mut char_bag = root_char_bag.clone();
2703 char_bag.extend(
2704 String::from_utf8_lossy(&entry.path)
2705 .chars()
2706 .map(|c| c.to_ascii_lowercase()),
2707 );
2708 EntryKind::File(char_bag)
2709 };
2710 let path: Arc<Path> = PathBuf::from(OsString::from_vec(entry.path)).into();
2711 Ok(Entry {
2712 id: ProjectEntryId::from_proto(entry.id),
2713 kind,
2714 path: path.clone(),
2715 inode: entry.inode,
2716 mtime: mtime.into(),
2717 is_symlink: entry.is_symlink,
2718 is_ignored: entry.is_ignored,
2719 })
2720 } else {
2721 Err(anyhow!(
2722 "missing mtime in remote worktree entry {:?}",
2723 entry.path
2724 ))
2725 }
2726 }
2727}
2728
2729#[cfg(test)]
2730mod tests {
2731 use super::*;
2732 use crate::fs::FakeFs;
2733 use anyhow::Result;
2734 use client::test::FakeHttpClient;
2735 use fs::RealFs;
2736 use gpui::TestAppContext;
2737 use rand::prelude::*;
2738 use serde_json::json;
2739 use std::{
2740 env,
2741 fmt::Write,
2742 time::{SystemTime, UNIX_EPOCH},
2743 };
2744 use util::test::temp_tree;
2745
2746 #[gpui::test]
2747 async fn test_traversal(cx: &mut TestAppContext) {
2748 let fs = FakeFs::new(cx.background());
2749 fs.insert_tree(
2750 "/root",
2751 json!({
2752 ".gitignore": "a/b\n",
2753 "a": {
2754 "b": "",
2755 "c": "",
2756 }
2757 }),
2758 )
2759 .await;
2760
2761 let http_client = FakeHttpClient::with_404_response();
2762 let client = Client::new(http_client);
2763
2764 let tree = Worktree::local(
2765 client,
2766 Arc::from(Path::new("/root")),
2767 true,
2768 fs,
2769 Default::default(),
2770 &mut cx.to_async(),
2771 )
2772 .await
2773 .unwrap();
2774 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
2775 .await;
2776
2777 tree.read_with(cx, |tree, _| {
2778 assert_eq!(
2779 tree.entries(false)
2780 .map(|entry| entry.path.as_ref())
2781 .collect::<Vec<_>>(),
2782 vec![
2783 Path::new(""),
2784 Path::new(".gitignore"),
2785 Path::new("a"),
2786 Path::new("a/c"),
2787 ]
2788 );
2789 assert_eq!(
2790 tree.entries(true)
2791 .map(|entry| entry.path.as_ref())
2792 .collect::<Vec<_>>(),
2793 vec![
2794 Path::new(""),
2795 Path::new(".gitignore"),
2796 Path::new("a"),
2797 Path::new("a/b"),
2798 Path::new("a/c"),
2799 ]
2800 );
2801 })
2802 }
2803
2804 #[gpui::test]
2805 async fn test_rescan_with_gitignore(cx: &mut TestAppContext) {
2806 let dir = temp_tree(json!({
2807 ".git": {},
2808 ".gitignore": "ignored-dir\n",
2809 "tracked-dir": {
2810 "tracked-file1": "tracked contents",
2811 },
2812 "ignored-dir": {
2813 "ignored-file1": "ignored contents",
2814 }
2815 }));
2816
2817 let http_client = FakeHttpClient::with_404_response();
2818 let client = Client::new(http_client.clone());
2819
2820 let tree = Worktree::local(
2821 client,
2822 dir.path(),
2823 true,
2824 Arc::new(RealFs),
2825 Default::default(),
2826 &mut cx.to_async(),
2827 )
2828 .await
2829 .unwrap();
2830 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
2831 .await;
2832 tree.flush_fs_events(&cx).await;
2833 cx.read(|cx| {
2834 let tree = tree.read(cx);
2835 let tracked = tree.entry_for_path("tracked-dir/tracked-file1").unwrap();
2836 let ignored = tree.entry_for_path("ignored-dir/ignored-file1").unwrap();
2837 assert_eq!(tracked.is_ignored, false);
2838 assert_eq!(ignored.is_ignored, true);
2839 });
2840
2841 std::fs::write(dir.path().join("tracked-dir/tracked-file2"), "").unwrap();
2842 std::fs::write(dir.path().join("ignored-dir/ignored-file2"), "").unwrap();
2843 tree.flush_fs_events(&cx).await;
2844 cx.read(|cx| {
2845 let tree = tree.read(cx);
2846 let dot_git = tree.entry_for_path(".git").unwrap();
2847 let tracked = tree.entry_for_path("tracked-dir/tracked-file2").unwrap();
2848 let ignored = tree.entry_for_path("ignored-dir/ignored-file2").unwrap();
2849 assert_eq!(tracked.is_ignored, false);
2850 assert_eq!(ignored.is_ignored, true);
2851 assert_eq!(dot_git.is_ignored, true);
2852 });
2853 }
2854
2855 #[gpui::test]
2856 async fn test_write_file(cx: &mut TestAppContext) {
2857 let dir = temp_tree(json!({
2858 ".git": {},
2859 ".gitignore": "ignored-dir\n",
2860 "tracked-dir": {},
2861 "ignored-dir": {}
2862 }));
2863
2864 let http_client = FakeHttpClient::with_404_response();
2865 let client = Client::new(http_client.clone());
2866
2867 let tree = Worktree::local(
2868 client,
2869 dir.path(),
2870 true,
2871 Arc::new(RealFs),
2872 Default::default(),
2873 &mut cx.to_async(),
2874 )
2875 .await
2876 .unwrap();
2877 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
2878 .await;
2879 tree.flush_fs_events(&cx).await;
2880
2881 tree.update(cx, |tree, cx| {
2882 tree.as_local().unwrap().write_file(
2883 Path::new("tracked-dir/file.txt"),
2884 "hello".into(),
2885 cx,
2886 )
2887 })
2888 .await
2889 .unwrap();
2890 tree.update(cx, |tree, cx| {
2891 tree.as_local().unwrap().write_file(
2892 Path::new("ignored-dir/file.txt"),
2893 "world".into(),
2894 cx,
2895 )
2896 })
2897 .await
2898 .unwrap();
2899
2900 tree.read_with(cx, |tree, _| {
2901 let tracked = tree.entry_for_path("tracked-dir/file.txt").unwrap();
2902 let ignored = tree.entry_for_path("ignored-dir/file.txt").unwrap();
2903 assert_eq!(tracked.is_ignored, false);
2904 assert_eq!(ignored.is_ignored, true);
2905 });
2906 }
2907
2908 #[gpui::test(iterations = 100)]
2909 fn test_random(mut rng: StdRng) {
2910 let operations = env::var("OPERATIONS")
2911 .map(|o| o.parse().unwrap())
2912 .unwrap_or(40);
2913 let initial_entries = env::var("INITIAL_ENTRIES")
2914 .map(|o| o.parse().unwrap())
2915 .unwrap_or(20);
2916
2917 let root_dir = tempdir::TempDir::new("worktree-test").unwrap();
2918 for _ in 0..initial_entries {
2919 randomly_mutate_tree(root_dir.path(), 1.0, &mut rng).unwrap();
2920 }
2921 log::info!("Generated initial tree");
2922
2923 let (notify_tx, _notify_rx) = mpsc::unbounded();
2924 let fs = Arc::new(RealFs);
2925 let next_entry_id = Arc::new(AtomicUsize::new(0));
2926 let mut initial_snapshot = LocalSnapshot {
2927 abs_path: root_dir.path().into(),
2928 removed_entry_ids: Default::default(),
2929 ignores: Default::default(),
2930 next_entry_id: next_entry_id.clone(),
2931 snapshot: Snapshot {
2932 id: WorktreeId::from_usize(0),
2933 entries_by_path: Default::default(),
2934 entries_by_id: Default::default(),
2935 root_name: Default::default(),
2936 root_char_bag: Default::default(),
2937 scan_id: 0,
2938 },
2939 };
2940 initial_snapshot.insert_entry(
2941 Entry::new(
2942 Path::new("").into(),
2943 &smol::block_on(fs.metadata(root_dir.path()))
2944 .unwrap()
2945 .unwrap(),
2946 &next_entry_id,
2947 Default::default(),
2948 ),
2949 fs.as_ref(),
2950 );
2951 let mut scanner = BackgroundScanner::new(
2952 Arc::new(Mutex::new(initial_snapshot.clone())),
2953 notify_tx,
2954 fs.clone(),
2955 Arc::new(gpui::executor::Background::new()),
2956 );
2957 smol::block_on(scanner.scan_dirs()).unwrap();
2958 scanner.snapshot().check_invariants();
2959
2960 let mut events = Vec::new();
2961 let mut snapshots = Vec::new();
2962 let mut mutations_len = operations;
2963 while mutations_len > 1 {
2964 if !events.is_empty() && rng.gen_bool(0.4) {
2965 let len = rng.gen_range(0..=events.len());
2966 let to_deliver = events.drain(0..len).collect::<Vec<_>>();
2967 log::info!("Delivering events: {:#?}", to_deliver);
2968 smol::block_on(scanner.process_events(to_deliver));
2969 scanner.snapshot().check_invariants();
2970 } else {
2971 events.extend(randomly_mutate_tree(root_dir.path(), 0.6, &mut rng).unwrap());
2972 mutations_len -= 1;
2973 }
2974
2975 if rng.gen_bool(0.2) {
2976 snapshots.push(scanner.snapshot());
2977 }
2978 }
2979 log::info!("Quiescing: {:#?}", events);
2980 smol::block_on(scanner.process_events(events));
2981 scanner.snapshot().check_invariants();
2982
2983 let (notify_tx, _notify_rx) = mpsc::unbounded();
2984 let mut new_scanner = BackgroundScanner::new(
2985 Arc::new(Mutex::new(initial_snapshot)),
2986 notify_tx,
2987 scanner.fs.clone(),
2988 scanner.executor.clone(),
2989 );
2990 smol::block_on(new_scanner.scan_dirs()).unwrap();
2991 assert_eq!(
2992 scanner.snapshot().to_vec(true),
2993 new_scanner.snapshot().to_vec(true)
2994 );
2995
2996 for mut prev_snapshot in snapshots {
2997 let include_ignored = rng.gen::<bool>();
2998 if !include_ignored {
2999 let mut entries_by_path_edits = Vec::new();
3000 let mut entries_by_id_edits = Vec::new();
3001 for entry in prev_snapshot
3002 .entries_by_id
3003 .cursor::<()>()
3004 .filter(|e| e.is_ignored)
3005 {
3006 entries_by_path_edits.push(Edit::Remove(PathKey(entry.path.clone())));
3007 entries_by_id_edits.push(Edit::Remove(entry.id));
3008 }
3009
3010 prev_snapshot
3011 .entries_by_path
3012 .edit(entries_by_path_edits, &());
3013 prev_snapshot.entries_by_id.edit(entries_by_id_edits, &());
3014 }
3015
3016 let update = scanner
3017 .snapshot()
3018 .build_update(&prev_snapshot, 0, 0, include_ignored);
3019 prev_snapshot.apply_remote_update(update).unwrap();
3020 assert_eq!(
3021 prev_snapshot.to_vec(true),
3022 scanner.snapshot().to_vec(include_ignored)
3023 );
3024 }
3025 }
3026
3027 fn randomly_mutate_tree(
3028 root_path: &Path,
3029 insertion_probability: f64,
3030 rng: &mut impl Rng,
3031 ) -> Result<Vec<fsevent::Event>> {
3032 let root_path = root_path.canonicalize().unwrap();
3033 let (dirs, files) = read_dir_recursive(root_path.clone());
3034
3035 let mut events = Vec::new();
3036 let mut record_event = |path: PathBuf| {
3037 events.push(fsevent::Event {
3038 event_id: SystemTime::now()
3039 .duration_since(UNIX_EPOCH)
3040 .unwrap()
3041 .as_secs(),
3042 flags: fsevent::StreamFlags::empty(),
3043 path,
3044 });
3045 };
3046
3047 if (files.is_empty() && dirs.len() == 1) || rng.gen_bool(insertion_probability) {
3048 let path = dirs.choose(rng).unwrap();
3049 let new_path = path.join(gen_name(rng));
3050
3051 if rng.gen() {
3052 log::info!("Creating dir {:?}", new_path.strip_prefix(root_path)?);
3053 std::fs::create_dir(&new_path)?;
3054 } else {
3055 log::info!("Creating file {:?}", new_path.strip_prefix(root_path)?);
3056 std::fs::write(&new_path, "")?;
3057 }
3058 record_event(new_path);
3059 } else if rng.gen_bool(0.05) {
3060 let ignore_dir_path = dirs.choose(rng).unwrap();
3061 let ignore_path = ignore_dir_path.join(&*GITIGNORE);
3062
3063 let (subdirs, subfiles) = read_dir_recursive(ignore_dir_path.clone());
3064 let files_to_ignore = {
3065 let len = rng.gen_range(0..=subfiles.len());
3066 subfiles.choose_multiple(rng, len)
3067 };
3068 let dirs_to_ignore = {
3069 let len = rng.gen_range(0..subdirs.len());
3070 subdirs.choose_multiple(rng, len)
3071 };
3072
3073 let mut ignore_contents = String::new();
3074 for path_to_ignore in files_to_ignore.chain(dirs_to_ignore) {
3075 write!(
3076 ignore_contents,
3077 "{}\n",
3078 path_to_ignore
3079 .strip_prefix(&ignore_dir_path)?
3080 .to_str()
3081 .unwrap()
3082 )
3083 .unwrap();
3084 }
3085 log::info!(
3086 "Creating {:?} with contents:\n{}",
3087 ignore_path.strip_prefix(&root_path)?,
3088 ignore_contents
3089 );
3090 std::fs::write(&ignore_path, ignore_contents).unwrap();
3091 record_event(ignore_path);
3092 } else {
3093 let old_path = {
3094 let file_path = files.choose(rng);
3095 let dir_path = dirs[1..].choose(rng);
3096 file_path.into_iter().chain(dir_path).choose(rng).unwrap()
3097 };
3098
3099 let is_rename = rng.gen();
3100 if is_rename {
3101 let new_path_parent = dirs
3102 .iter()
3103 .filter(|d| !d.starts_with(old_path))
3104 .choose(rng)
3105 .unwrap();
3106
3107 let overwrite_existing_dir =
3108 !old_path.starts_with(&new_path_parent) && rng.gen_bool(0.3);
3109 let new_path = if overwrite_existing_dir {
3110 std::fs::remove_dir_all(&new_path_parent).ok();
3111 new_path_parent.to_path_buf()
3112 } else {
3113 new_path_parent.join(gen_name(rng))
3114 };
3115
3116 log::info!(
3117 "Renaming {:?} to {}{:?}",
3118 old_path.strip_prefix(&root_path)?,
3119 if overwrite_existing_dir {
3120 "overwrite "
3121 } else {
3122 ""
3123 },
3124 new_path.strip_prefix(&root_path)?
3125 );
3126 std::fs::rename(&old_path, &new_path)?;
3127 record_event(old_path.clone());
3128 record_event(new_path);
3129 } else if old_path.is_dir() {
3130 let (dirs, files) = read_dir_recursive(old_path.clone());
3131
3132 log::info!("Deleting dir {:?}", old_path.strip_prefix(&root_path)?);
3133 std::fs::remove_dir_all(&old_path).unwrap();
3134 for file in files {
3135 record_event(file);
3136 }
3137 for dir in dirs {
3138 record_event(dir);
3139 }
3140 } else {
3141 log::info!("Deleting file {:?}", old_path.strip_prefix(&root_path)?);
3142 std::fs::remove_file(old_path).unwrap();
3143 record_event(old_path.clone());
3144 }
3145 }
3146
3147 Ok(events)
3148 }
3149
3150 fn read_dir_recursive(path: PathBuf) -> (Vec<PathBuf>, Vec<PathBuf>) {
3151 let child_entries = std::fs::read_dir(&path).unwrap();
3152 let mut dirs = vec![path];
3153 let mut files = Vec::new();
3154 for child_entry in child_entries {
3155 let child_path = child_entry.unwrap().path();
3156 if child_path.is_dir() {
3157 let (child_dirs, child_files) = read_dir_recursive(child_path);
3158 dirs.extend(child_dirs);
3159 files.extend(child_files);
3160 } else {
3161 files.push(child_path);
3162 }
3163 }
3164 (dirs, files)
3165 }
3166
3167 fn gen_name(rng: &mut impl Rng) -> String {
3168 (0..6)
3169 .map(|_| rng.sample(rand::distributions::Alphanumeric))
3170 .map(char::from)
3171 .collect()
3172 }
3173
3174 impl LocalSnapshot {
3175 fn check_invariants(&self) {
3176 let mut files = self.files(true, 0);
3177 let mut visible_files = self.files(false, 0);
3178 for entry in self.entries_by_path.cursor::<()>() {
3179 if entry.is_file() {
3180 assert_eq!(files.next().unwrap().inode, entry.inode);
3181 if !entry.is_ignored {
3182 assert_eq!(visible_files.next().unwrap().inode, entry.inode);
3183 }
3184 }
3185 }
3186 assert!(files.next().is_none());
3187 assert!(visible_files.next().is_none());
3188
3189 let mut bfs_paths = Vec::new();
3190 let mut stack = vec![Path::new("")];
3191 while let Some(path) = stack.pop() {
3192 bfs_paths.push(path);
3193 let ix = stack.len();
3194 for child_entry in self.child_entries(path) {
3195 stack.insert(ix, &child_entry.path);
3196 }
3197 }
3198
3199 let dfs_paths_via_iter = self
3200 .entries_by_path
3201 .cursor::<()>()
3202 .map(|e| e.path.as_ref())
3203 .collect::<Vec<_>>();
3204 assert_eq!(bfs_paths, dfs_paths_via_iter);
3205
3206 let dfs_paths_via_traversal = self
3207 .entries(true)
3208 .map(|e| e.path.as_ref())
3209 .collect::<Vec<_>>();
3210 assert_eq!(dfs_paths_via_traversal, dfs_paths_via_iter);
3211
3212 for (ignore_parent_path, _) in &self.ignores {
3213 assert!(self.entry_for_path(ignore_parent_path).is_some());
3214 assert!(self
3215 .entry_for_path(ignore_parent_path.join(&*GITIGNORE))
3216 .is_some());
3217 }
3218 }
3219
3220 fn to_vec(&self, include_ignored: bool) -> Vec<(&Path, u64, bool)> {
3221 let mut paths = Vec::new();
3222 for entry in self.entries_by_path.cursor::<()>() {
3223 if include_ignored || !entry.is_ignored {
3224 paths.push((entry.path.as_ref(), entry.inode, entry.is_ignored));
3225 }
3226 }
3227 paths.sort_by(|a, b| a.0.cmp(&b.0));
3228 paths
3229 }
3230 }
3231}