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(snapshot) = snapshots_to_send_rx.recv().await {
984 let message =
985 snapshot.build_update(&prev_snapshot, project_id, worktree_id, true);
986 rpc.request(message).await?;
987 prev_snapshot = snapshot;
988 }
989
990 Ok::<_, anyhow::Error>(())
991 }
992 .log_err()
993 });
994 self.share = Some(ShareState {
995 project_id,
996 snapshots_tx: snapshots_to_send_tx.clone(),
997 _maintain_remote_snapshot: Some(maintain_remote_snapshot),
998 });
999 }
1000
1001 cx.spawn_weak(|this, cx| async move {
1002 if let Some(this) = this.upgrade(&cx) {
1003 this.read_with(&cx, |this, _| {
1004 let this = this.as_local().unwrap();
1005 let _ = snapshots_to_send_tx.try_send(this.snapshot());
1006 });
1007 }
1008 share_rx
1009 .await
1010 .unwrap_or_else(|_| Err(anyhow!("share ended")))
1011 })
1012 }
1013
1014 pub fn unshare(&mut self) {
1015 self.share.take();
1016 }
1017
1018 pub fn is_shared(&self) -> bool {
1019 self.share.is_some()
1020 }
1021
1022 fn broadcast_snapshot(&self) -> impl Future<Output = ()> {
1023 let mut to_send = None;
1024 if !self.is_scanning() {
1025 if let Some(share) = self.share.as_ref() {
1026 to_send = Some((self.snapshot(), share.snapshots_tx.clone()));
1027 }
1028 }
1029
1030 async move {
1031 if let Some((snapshot, snapshots_to_send_tx)) = to_send {
1032 if let Err(err) = snapshots_to_send_tx.send(snapshot).await {
1033 log::error!("error submitting snapshot to send {}", err);
1034 }
1035 }
1036 }
1037 }
1038}
1039
1040impl RemoteWorktree {
1041 fn snapshot(&self) -> Snapshot {
1042 self.snapshot.clone()
1043 }
1044
1045 pub fn disconnected_from_host(&mut self) {
1046 self.updates_tx.take();
1047 }
1048
1049 pub fn update_from_remote(
1050 &mut self,
1051 envelope: TypedEnvelope<proto::UpdateWorktree>,
1052 ) -> Result<()> {
1053 if let Some(updates_tx) = &self.updates_tx {
1054 updates_tx
1055 .unbounded_send(envelope.payload)
1056 .expect("consumer runs to completion");
1057 }
1058 Ok(())
1059 }
1060
1061 fn wait_for_snapshot(&self, scan_id: usize) -> impl Future<Output = ()> {
1062 let mut rx = self.last_scan_id_rx.clone();
1063 async move {
1064 while let Some(applied_scan_id) = rx.next().await {
1065 if applied_scan_id >= scan_id {
1066 return;
1067 }
1068 }
1069 }
1070 }
1071
1072 pub fn update_diagnostic_summary(
1073 &mut self,
1074 path: Arc<Path>,
1075 summary: &proto::DiagnosticSummary,
1076 ) {
1077 let summary = DiagnosticSummary {
1078 language_server_id: summary.language_server_id as usize,
1079 error_count: summary.error_count as usize,
1080 warning_count: summary.warning_count as usize,
1081 };
1082 if summary.is_empty() {
1083 self.diagnostic_summaries.remove(&PathKey(path.clone()));
1084 } else {
1085 self.diagnostic_summaries
1086 .insert(PathKey(path.clone()), summary);
1087 }
1088 }
1089
1090 pub fn insert_entry(
1091 &self,
1092 entry: proto::Entry,
1093 scan_id: usize,
1094 cx: &mut ModelContext<Worktree>,
1095 ) -> Task<Result<Entry>> {
1096 let wait_for_snapshot = self.wait_for_snapshot(scan_id);
1097 cx.spawn(|this, mut cx| async move {
1098 wait_for_snapshot.await;
1099 this.update(&mut cx, |worktree, _| {
1100 let worktree = worktree.as_remote_mut().unwrap();
1101 let mut snapshot = worktree.background_snapshot.lock();
1102 let entry = snapshot.insert_entry(entry);
1103 worktree.snapshot = snapshot.clone();
1104 entry
1105 })
1106 })
1107 }
1108
1109 pub(crate) fn delete_entry(
1110 &self,
1111 id: ProjectEntryId,
1112 scan_id: usize,
1113 cx: &mut ModelContext<Worktree>,
1114 ) -> Task<Result<()>> {
1115 let wait_for_snapshot = self.wait_for_snapshot(scan_id);
1116 cx.spawn(|this, mut cx| async move {
1117 wait_for_snapshot.await;
1118 this.update(&mut cx, |worktree, _| {
1119 let worktree = worktree.as_remote_mut().unwrap();
1120 let mut snapshot = worktree.background_snapshot.lock();
1121 snapshot.delete_entry(id);
1122 worktree.snapshot = snapshot.clone();
1123 });
1124 Ok(())
1125 })
1126 }
1127}
1128
1129impl Snapshot {
1130 pub fn id(&self) -> WorktreeId {
1131 self.id
1132 }
1133
1134 pub fn contains_entry(&self, entry_id: ProjectEntryId) -> bool {
1135 self.entries_by_id.get(&entry_id, &()).is_some()
1136 }
1137
1138 pub(crate) fn insert_entry(&mut self, entry: proto::Entry) -> Result<Entry> {
1139 let entry = Entry::try_from((&self.root_char_bag, entry))?;
1140 let old_entry = self.entries_by_id.insert_or_replace(
1141 PathEntry {
1142 id: entry.id,
1143 path: entry.path.clone(),
1144 is_ignored: entry.is_ignored,
1145 scan_id: 0,
1146 },
1147 &(),
1148 );
1149 if let Some(old_entry) = old_entry {
1150 self.entries_by_path.remove(&PathKey(old_entry.path), &());
1151 }
1152 self.entries_by_path.insert_or_replace(entry.clone(), &());
1153 Ok(entry)
1154 }
1155
1156 fn delete_entry(&mut self, entry_id: ProjectEntryId) -> bool {
1157 if let Some(removed_entry) = self.entries_by_id.remove(&entry_id, &()) {
1158 self.entries_by_path = {
1159 let mut cursor = self.entries_by_path.cursor();
1160 let mut new_entries_by_path =
1161 cursor.slice(&TraversalTarget::Path(&removed_entry.path), Bias::Left, &());
1162 while let Some(entry) = cursor.item() {
1163 if entry.path.starts_with(&removed_entry.path) {
1164 self.entries_by_id.remove(&entry.id, &());
1165 cursor.next(&());
1166 } else {
1167 break;
1168 }
1169 }
1170 new_entries_by_path.push_tree(cursor.suffix(&()), &());
1171 new_entries_by_path
1172 };
1173
1174 true
1175 } else {
1176 false
1177 }
1178 }
1179
1180 pub(crate) fn apply_remote_update(&mut self, update: proto::UpdateWorktree) -> Result<()> {
1181 let mut entries_by_path_edits = Vec::new();
1182 let mut entries_by_id_edits = Vec::new();
1183 for entry_id in update.removed_entries {
1184 let entry = self
1185 .entry_for_id(ProjectEntryId::from_proto(entry_id))
1186 .ok_or_else(|| anyhow!("unknown entry"))?;
1187 entries_by_path_edits.push(Edit::Remove(PathKey(entry.path.clone())));
1188 entries_by_id_edits.push(Edit::Remove(entry.id));
1189 }
1190
1191 for entry in update.updated_entries {
1192 let entry = Entry::try_from((&self.root_char_bag, entry))?;
1193 if let Some(PathEntry { path, .. }) = self.entries_by_id.get(&entry.id, &()) {
1194 entries_by_path_edits.push(Edit::Remove(PathKey(path.clone())));
1195 }
1196 entries_by_id_edits.push(Edit::Insert(PathEntry {
1197 id: entry.id,
1198 path: entry.path.clone(),
1199 is_ignored: entry.is_ignored,
1200 scan_id: 0,
1201 }));
1202 entries_by_path_edits.push(Edit::Insert(entry));
1203 }
1204
1205 self.entries_by_path.edit(entries_by_path_edits, &());
1206 self.entries_by_id.edit(entries_by_id_edits, &());
1207 self.scan_id = update.scan_id as usize;
1208
1209 Ok(())
1210 }
1211
1212 pub fn file_count(&self) -> usize {
1213 self.entries_by_path.summary().file_count
1214 }
1215
1216 pub fn visible_file_count(&self) -> usize {
1217 self.entries_by_path.summary().visible_file_count
1218 }
1219
1220 fn traverse_from_offset(
1221 &self,
1222 include_dirs: bool,
1223 include_ignored: bool,
1224 start_offset: usize,
1225 ) -> Traversal {
1226 let mut cursor = self.entries_by_path.cursor();
1227 cursor.seek(
1228 &TraversalTarget::Count {
1229 count: start_offset,
1230 include_dirs,
1231 include_ignored,
1232 },
1233 Bias::Right,
1234 &(),
1235 );
1236 Traversal {
1237 cursor,
1238 include_dirs,
1239 include_ignored,
1240 }
1241 }
1242
1243 fn traverse_from_path(
1244 &self,
1245 include_dirs: bool,
1246 include_ignored: bool,
1247 path: &Path,
1248 ) -> Traversal {
1249 let mut cursor = self.entries_by_path.cursor();
1250 cursor.seek(&TraversalTarget::Path(path), Bias::Left, &());
1251 Traversal {
1252 cursor,
1253 include_dirs,
1254 include_ignored,
1255 }
1256 }
1257
1258 pub fn files(&self, include_ignored: bool, start: usize) -> Traversal {
1259 self.traverse_from_offset(false, include_ignored, start)
1260 }
1261
1262 pub fn entries(&self, include_ignored: bool) -> Traversal {
1263 self.traverse_from_offset(true, include_ignored, 0)
1264 }
1265
1266 pub fn paths(&self) -> impl Iterator<Item = &Arc<Path>> {
1267 let empty_path = Path::new("");
1268 self.entries_by_path
1269 .cursor::<()>()
1270 .filter(move |entry| entry.path.as_ref() != empty_path)
1271 .map(|entry| &entry.path)
1272 }
1273
1274 fn child_entries<'a>(&'a self, parent_path: &'a Path) -> ChildEntriesIter<'a> {
1275 let mut cursor = self.entries_by_path.cursor();
1276 cursor.seek(&TraversalTarget::Path(parent_path), Bias::Right, &());
1277 let traversal = Traversal {
1278 cursor,
1279 include_dirs: true,
1280 include_ignored: true,
1281 };
1282 ChildEntriesIter {
1283 traversal,
1284 parent_path,
1285 }
1286 }
1287
1288 pub fn root_entry(&self) -> Option<&Entry> {
1289 self.entry_for_path("")
1290 }
1291
1292 pub fn root_name(&self) -> &str {
1293 &self.root_name
1294 }
1295
1296 pub fn scan_id(&self) -> usize {
1297 self.scan_id
1298 }
1299
1300 pub fn entry_for_path(&self, path: impl AsRef<Path>) -> Option<&Entry> {
1301 let path = path.as_ref();
1302 self.traverse_from_path(true, true, path)
1303 .entry()
1304 .and_then(|entry| {
1305 if entry.path.as_ref() == path {
1306 Some(entry)
1307 } else {
1308 None
1309 }
1310 })
1311 }
1312
1313 pub fn entry_for_id(&self, id: ProjectEntryId) -> Option<&Entry> {
1314 let entry = self.entries_by_id.get(&id, &())?;
1315 self.entry_for_path(&entry.path)
1316 }
1317
1318 pub fn inode_for_path(&self, path: impl AsRef<Path>) -> Option<u64> {
1319 self.entry_for_path(path.as_ref()).map(|e| e.inode)
1320 }
1321}
1322
1323impl LocalSnapshot {
1324 pub fn abs_path(&self) -> &Arc<Path> {
1325 &self.abs_path
1326 }
1327
1328 #[cfg(test)]
1329 pub(crate) fn to_proto(
1330 &self,
1331 diagnostic_summaries: &TreeMap<PathKey, DiagnosticSummary>,
1332 visible: bool,
1333 ) -> proto::Worktree {
1334 let root_name = self.root_name.clone();
1335 proto::Worktree {
1336 id: self.id.0 as u64,
1337 root_name,
1338 entries: self
1339 .entries_by_path
1340 .iter()
1341 .filter(|e| !e.is_ignored)
1342 .map(Into::into)
1343 .collect(),
1344 diagnostic_summaries: diagnostic_summaries
1345 .iter()
1346 .map(|(path, summary)| summary.to_proto(&path.0))
1347 .collect(),
1348 visible,
1349 scan_id: self.scan_id as u64,
1350 }
1351 }
1352
1353 pub(crate) fn build_update(
1354 &self,
1355 other: &Self,
1356 project_id: u64,
1357 worktree_id: u64,
1358 include_ignored: bool,
1359 ) -> proto::UpdateWorktree {
1360 let mut updated_entries = Vec::new();
1361 let mut removed_entries = Vec::new();
1362 let mut self_entries = self
1363 .entries_by_id
1364 .cursor::<()>()
1365 .filter(|e| include_ignored || !e.is_ignored)
1366 .peekable();
1367 let mut other_entries = other
1368 .entries_by_id
1369 .cursor::<()>()
1370 .filter(|e| include_ignored || !e.is_ignored)
1371 .peekable();
1372 loop {
1373 match (self_entries.peek(), other_entries.peek()) {
1374 (Some(self_entry), Some(other_entry)) => {
1375 match Ord::cmp(&self_entry.id, &other_entry.id) {
1376 Ordering::Less => {
1377 let entry = self.entry_for_id(self_entry.id).unwrap().into();
1378 updated_entries.push(entry);
1379 self_entries.next();
1380 }
1381 Ordering::Equal => {
1382 if self_entry.scan_id != other_entry.scan_id {
1383 let entry = self.entry_for_id(self_entry.id).unwrap().into();
1384 updated_entries.push(entry);
1385 }
1386
1387 self_entries.next();
1388 other_entries.next();
1389 }
1390 Ordering::Greater => {
1391 removed_entries.push(other_entry.id.to_proto());
1392 other_entries.next();
1393 }
1394 }
1395 }
1396 (Some(self_entry), None) => {
1397 let entry = self.entry_for_id(self_entry.id).unwrap().into();
1398 updated_entries.push(entry);
1399 self_entries.next();
1400 }
1401 (None, Some(other_entry)) => {
1402 removed_entries.push(other_entry.id.to_proto());
1403 other_entries.next();
1404 }
1405 (None, None) => break,
1406 }
1407 }
1408
1409 proto::UpdateWorktree {
1410 project_id,
1411 worktree_id,
1412 root_name: self.root_name().to_string(),
1413 updated_entries,
1414 removed_entries,
1415 scan_id: self.scan_id as u64,
1416 }
1417 }
1418
1419 fn insert_entry(&mut self, mut entry: Entry, fs: &dyn Fs) -> Entry {
1420 if !entry.is_dir() && entry.path.file_name() == Some(&GITIGNORE) {
1421 let abs_path = self.abs_path.join(&entry.path);
1422 match build_gitignore(&abs_path, fs) {
1423 Ok(ignore) => {
1424 let ignore_dir_path = entry.path.parent().unwrap();
1425 self.ignores
1426 .insert(ignore_dir_path.into(), (Arc::new(ignore), self.scan_id));
1427 }
1428 Err(error) => {
1429 log::error!(
1430 "error loading .gitignore file {:?} - {:?}",
1431 &entry.path,
1432 error
1433 );
1434 }
1435 }
1436 }
1437
1438 self.reuse_entry_id(&mut entry);
1439 self.entries_by_path.insert_or_replace(entry.clone(), &());
1440 let scan_id = self.scan_id;
1441 self.entries_by_id.insert_or_replace(
1442 PathEntry {
1443 id: entry.id,
1444 path: entry.path.clone(),
1445 is_ignored: entry.is_ignored,
1446 scan_id,
1447 },
1448 &(),
1449 );
1450 entry
1451 }
1452
1453 fn populate_dir(
1454 &mut self,
1455 parent_path: Arc<Path>,
1456 entries: impl IntoIterator<Item = Entry>,
1457 ignore: Option<Arc<Gitignore>>,
1458 ) {
1459 let mut parent_entry = if let Some(parent_entry) =
1460 self.entries_by_path.get(&PathKey(parent_path.clone()), &())
1461 {
1462 parent_entry.clone()
1463 } else {
1464 log::warn!(
1465 "populating a directory {:?} that has been removed",
1466 parent_path
1467 );
1468 return;
1469 };
1470
1471 if let Some(ignore) = ignore {
1472 self.ignores.insert(parent_path, (ignore, self.scan_id));
1473 }
1474 if matches!(parent_entry.kind, EntryKind::PendingDir) {
1475 parent_entry.kind = EntryKind::Dir;
1476 } else {
1477 unreachable!();
1478 }
1479
1480 let mut entries_by_path_edits = vec![Edit::Insert(parent_entry)];
1481 let mut entries_by_id_edits = Vec::new();
1482
1483 for mut entry in entries {
1484 self.reuse_entry_id(&mut entry);
1485 entries_by_id_edits.push(Edit::Insert(PathEntry {
1486 id: entry.id,
1487 path: entry.path.clone(),
1488 is_ignored: entry.is_ignored,
1489 scan_id: self.scan_id,
1490 }));
1491 entries_by_path_edits.push(Edit::Insert(entry));
1492 }
1493
1494 self.entries_by_path.edit(entries_by_path_edits, &());
1495 self.entries_by_id.edit(entries_by_id_edits, &());
1496 }
1497
1498 fn reuse_entry_id(&mut self, entry: &mut Entry) {
1499 if let Some(removed_entry_id) = self.removed_entry_ids.remove(&entry.inode) {
1500 entry.id = removed_entry_id;
1501 } else if let Some(existing_entry) = self.entry_for_path(&entry.path) {
1502 entry.id = existing_entry.id;
1503 }
1504 }
1505
1506 fn remove_path(&mut self, path: &Path) {
1507 let mut new_entries;
1508 let removed_entries;
1509 {
1510 let mut cursor = self.entries_by_path.cursor::<TraversalProgress>();
1511 new_entries = cursor.slice(&TraversalTarget::Path(path), Bias::Left, &());
1512 removed_entries = cursor.slice(&TraversalTarget::PathSuccessor(path), Bias::Left, &());
1513 new_entries.push_tree(cursor.suffix(&()), &());
1514 }
1515 self.entries_by_path = new_entries;
1516
1517 let mut entries_by_id_edits = Vec::new();
1518 for entry in removed_entries.cursor::<()>() {
1519 let removed_entry_id = self
1520 .removed_entry_ids
1521 .entry(entry.inode)
1522 .or_insert(entry.id);
1523 *removed_entry_id = cmp::max(*removed_entry_id, entry.id);
1524 entries_by_id_edits.push(Edit::Remove(entry.id));
1525 }
1526 self.entries_by_id.edit(entries_by_id_edits, &());
1527
1528 if path.file_name() == Some(&GITIGNORE) {
1529 if let Some((_, scan_id)) = self.ignores.get_mut(path.parent().unwrap()) {
1530 *scan_id = self.snapshot.scan_id;
1531 }
1532 }
1533 }
1534
1535 fn ignore_stack_for_path(&self, path: &Path, is_dir: bool) -> Arc<IgnoreStack> {
1536 let mut new_ignores = Vec::new();
1537 for ancestor in path.ancestors().skip(1) {
1538 if let Some((ignore, _)) = self.ignores.get(ancestor) {
1539 new_ignores.push((ancestor, Some(ignore.clone())));
1540 } else {
1541 new_ignores.push((ancestor, None));
1542 }
1543 }
1544
1545 let mut ignore_stack = IgnoreStack::none();
1546 for (parent_path, ignore) in new_ignores.into_iter().rev() {
1547 if ignore_stack.is_path_ignored(&parent_path, true) {
1548 ignore_stack = IgnoreStack::all();
1549 break;
1550 } else if let Some(ignore) = ignore {
1551 ignore_stack = ignore_stack.append(Arc::from(parent_path), ignore);
1552 }
1553 }
1554
1555 if ignore_stack.is_path_ignored(path, is_dir) {
1556 ignore_stack = IgnoreStack::all();
1557 }
1558
1559 ignore_stack
1560 }
1561}
1562
1563fn build_gitignore(abs_path: &Path, fs: &dyn Fs) -> Result<Gitignore> {
1564 let contents = smol::block_on(fs.load(&abs_path))?;
1565 let parent = abs_path.parent().unwrap_or(Path::new("/"));
1566 let mut builder = GitignoreBuilder::new(parent);
1567 for line in contents.lines() {
1568 builder.add_line(Some(abs_path.into()), line)?;
1569 }
1570 Ok(builder.build()?)
1571}
1572
1573impl WorktreeId {
1574 pub fn from_usize(handle_id: usize) -> Self {
1575 Self(handle_id)
1576 }
1577
1578 pub(crate) fn from_proto(id: u64) -> Self {
1579 Self(id as usize)
1580 }
1581
1582 pub fn to_proto(&self) -> u64 {
1583 self.0 as u64
1584 }
1585
1586 pub fn to_usize(&self) -> usize {
1587 self.0
1588 }
1589}
1590
1591impl fmt::Display for WorktreeId {
1592 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1593 self.0.fmt(f)
1594 }
1595}
1596
1597impl Deref for Worktree {
1598 type Target = Snapshot;
1599
1600 fn deref(&self) -> &Self::Target {
1601 match self {
1602 Worktree::Local(worktree) => &worktree.snapshot,
1603 Worktree::Remote(worktree) => &worktree.snapshot,
1604 }
1605 }
1606}
1607
1608impl Deref for LocalWorktree {
1609 type Target = LocalSnapshot;
1610
1611 fn deref(&self) -> &Self::Target {
1612 &self.snapshot
1613 }
1614}
1615
1616impl Deref for RemoteWorktree {
1617 type Target = Snapshot;
1618
1619 fn deref(&self) -> &Self::Target {
1620 &self.snapshot
1621 }
1622}
1623
1624impl fmt::Debug for LocalWorktree {
1625 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1626 self.snapshot.fmt(f)
1627 }
1628}
1629
1630impl fmt::Debug for Snapshot {
1631 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1632 struct EntriesById<'a>(&'a SumTree<PathEntry>);
1633 struct EntriesByPath<'a>(&'a SumTree<Entry>);
1634
1635 impl<'a> fmt::Debug for EntriesByPath<'a> {
1636 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1637 f.debug_map()
1638 .entries(self.0.iter().map(|entry| (&entry.path, entry.id)))
1639 .finish()
1640 }
1641 }
1642
1643 impl<'a> fmt::Debug for EntriesById<'a> {
1644 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1645 f.debug_list().entries(self.0.iter()).finish()
1646 }
1647 }
1648
1649 f.debug_struct("Snapshot")
1650 .field("id", &self.id)
1651 .field("root_name", &self.root_name)
1652 .field("entries_by_path", &EntriesByPath(&self.entries_by_path))
1653 .field("entries_by_id", &EntriesById(&self.entries_by_id))
1654 .finish()
1655 }
1656}
1657
1658#[derive(Clone, PartialEq)]
1659pub struct File {
1660 pub worktree: ModelHandle<Worktree>,
1661 pub path: Arc<Path>,
1662 pub mtime: SystemTime,
1663 pub(crate) entry_id: Option<ProjectEntryId>,
1664 pub(crate) is_local: bool,
1665}
1666
1667impl language::File for File {
1668 fn as_local(&self) -> Option<&dyn language::LocalFile> {
1669 if self.is_local {
1670 Some(self)
1671 } else {
1672 None
1673 }
1674 }
1675
1676 fn mtime(&self) -> SystemTime {
1677 self.mtime
1678 }
1679
1680 fn path(&self) -> &Arc<Path> {
1681 &self.path
1682 }
1683
1684 fn full_path(&self, cx: &AppContext) -> PathBuf {
1685 let mut full_path = PathBuf::new();
1686 full_path.push(self.worktree.read(cx).root_name());
1687 if self.path.components().next().is_some() {
1688 full_path.push(&self.path);
1689 }
1690 full_path
1691 }
1692
1693 /// Returns the last component of this handle's absolute path. If this handle refers to the root
1694 /// of its worktree, then this method will return the name of the worktree itself.
1695 fn file_name(&self, cx: &AppContext) -> OsString {
1696 self.path
1697 .file_name()
1698 .map(|name| name.into())
1699 .unwrap_or_else(|| OsString::from(&self.worktree.read(cx).root_name))
1700 }
1701
1702 fn is_deleted(&self) -> bool {
1703 self.entry_id.is_none()
1704 }
1705
1706 fn save(
1707 &self,
1708 buffer_id: u64,
1709 text: Rope,
1710 version: clock::Global,
1711 cx: &mut MutableAppContext,
1712 ) -> Task<Result<(clock::Global, String, SystemTime)>> {
1713 self.worktree.update(cx, |worktree, cx| match worktree {
1714 Worktree::Local(worktree) => {
1715 let rpc = worktree.client.clone();
1716 let project_id = worktree.share.as_ref().map(|share| share.project_id);
1717 let fingerprint = text.fingerprint();
1718 let save = worktree.write_file(self.path.clone(), text, cx);
1719 cx.background().spawn(async move {
1720 let entry = save.await?;
1721 if let Some(project_id) = project_id {
1722 rpc.send(proto::BufferSaved {
1723 project_id,
1724 buffer_id,
1725 version: serialize_version(&version),
1726 mtime: Some(entry.mtime.into()),
1727 fingerprint: fingerprint.clone(),
1728 })?;
1729 }
1730 Ok((version, fingerprint, entry.mtime))
1731 })
1732 }
1733 Worktree::Remote(worktree) => {
1734 let rpc = worktree.client.clone();
1735 let project_id = worktree.project_id;
1736 cx.foreground().spawn(async move {
1737 let response = rpc
1738 .request(proto::SaveBuffer {
1739 project_id,
1740 buffer_id,
1741 version: serialize_version(&version),
1742 })
1743 .await?;
1744 let version = deserialize_version(response.version);
1745 let mtime = response
1746 .mtime
1747 .ok_or_else(|| anyhow!("missing mtime"))?
1748 .into();
1749 Ok((version, response.fingerprint, mtime))
1750 })
1751 }
1752 })
1753 }
1754
1755 fn as_any(&self) -> &dyn Any {
1756 self
1757 }
1758
1759 fn to_proto(&self) -> rpc::proto::File {
1760 rpc::proto::File {
1761 worktree_id: self.worktree.id() as u64,
1762 entry_id: self.entry_id.map(|entry_id| entry_id.to_proto()),
1763 path: self.path.to_string_lossy().into(),
1764 mtime: Some(self.mtime.into()),
1765 }
1766 }
1767}
1768
1769impl language::LocalFile for File {
1770 fn abs_path(&self, cx: &AppContext) -> PathBuf {
1771 self.worktree
1772 .read(cx)
1773 .as_local()
1774 .unwrap()
1775 .abs_path
1776 .join(&self.path)
1777 }
1778
1779 fn load(&self, cx: &AppContext) -> Task<Result<String>> {
1780 let worktree = self.worktree.read(cx).as_local().unwrap();
1781 let abs_path = worktree.absolutize(&self.path);
1782 let fs = worktree.fs.clone();
1783 cx.background()
1784 .spawn(async move { fs.load(&abs_path).await })
1785 }
1786
1787 fn buffer_reloaded(
1788 &self,
1789 buffer_id: u64,
1790 version: &clock::Global,
1791 fingerprint: String,
1792 mtime: SystemTime,
1793 cx: &mut MutableAppContext,
1794 ) {
1795 let worktree = self.worktree.read(cx).as_local().unwrap();
1796 if let Some(project_id) = worktree.share.as_ref().map(|share| share.project_id) {
1797 worktree
1798 .client
1799 .send(proto::BufferReloaded {
1800 project_id,
1801 buffer_id,
1802 version: serialize_version(&version),
1803 mtime: Some(mtime.into()),
1804 fingerprint,
1805 })
1806 .log_err();
1807 }
1808 }
1809}
1810
1811impl File {
1812 pub fn from_proto(
1813 proto: rpc::proto::File,
1814 worktree: ModelHandle<Worktree>,
1815 cx: &AppContext,
1816 ) -> Result<Self> {
1817 let worktree_id = worktree
1818 .read(cx)
1819 .as_remote()
1820 .ok_or_else(|| anyhow!("not remote"))?
1821 .id();
1822
1823 if worktree_id.to_proto() != proto.worktree_id {
1824 return Err(anyhow!("worktree id does not match file"));
1825 }
1826
1827 Ok(Self {
1828 worktree,
1829 path: Path::new(&proto.path).into(),
1830 mtime: proto.mtime.ok_or_else(|| anyhow!("no timestamp"))?.into(),
1831 entry_id: proto.entry_id.map(ProjectEntryId::from_proto),
1832 is_local: false,
1833 })
1834 }
1835
1836 pub fn from_dyn(file: Option<&dyn language::File>) -> Option<&Self> {
1837 file.and_then(|f| f.as_any().downcast_ref())
1838 }
1839
1840 pub fn worktree_id(&self, cx: &AppContext) -> WorktreeId {
1841 self.worktree.read(cx).id()
1842 }
1843
1844 pub fn project_entry_id(&self, _: &AppContext) -> Option<ProjectEntryId> {
1845 self.entry_id
1846 }
1847}
1848
1849#[derive(Clone, Debug, PartialEq, Eq)]
1850pub struct Entry {
1851 pub id: ProjectEntryId,
1852 pub kind: EntryKind,
1853 pub path: Arc<Path>,
1854 pub inode: u64,
1855 pub mtime: SystemTime,
1856 pub is_symlink: bool,
1857 pub is_ignored: bool,
1858}
1859
1860#[derive(Clone, Copy, Debug, PartialEq, Eq)]
1861pub enum EntryKind {
1862 PendingDir,
1863 Dir,
1864 File(CharBag),
1865}
1866
1867impl Entry {
1868 fn new(
1869 path: Arc<Path>,
1870 metadata: &fs::Metadata,
1871 next_entry_id: &AtomicUsize,
1872 root_char_bag: CharBag,
1873 ) -> Self {
1874 Self {
1875 id: ProjectEntryId::new(next_entry_id),
1876 kind: if metadata.is_dir {
1877 EntryKind::PendingDir
1878 } else {
1879 EntryKind::File(char_bag_for_path(root_char_bag, &path))
1880 },
1881 path,
1882 inode: metadata.inode,
1883 mtime: metadata.mtime,
1884 is_symlink: metadata.is_symlink,
1885 is_ignored: false,
1886 }
1887 }
1888
1889 pub fn is_dir(&self) -> bool {
1890 matches!(self.kind, EntryKind::Dir | EntryKind::PendingDir)
1891 }
1892
1893 pub fn is_file(&self) -> bool {
1894 matches!(self.kind, EntryKind::File(_))
1895 }
1896}
1897
1898impl sum_tree::Item for Entry {
1899 type Summary = EntrySummary;
1900
1901 fn summary(&self) -> Self::Summary {
1902 let visible_count = if self.is_ignored { 0 } else { 1 };
1903 let file_count;
1904 let visible_file_count;
1905 if self.is_file() {
1906 file_count = 1;
1907 visible_file_count = visible_count;
1908 } else {
1909 file_count = 0;
1910 visible_file_count = 0;
1911 }
1912
1913 EntrySummary {
1914 max_path: self.path.clone(),
1915 count: 1,
1916 visible_count,
1917 file_count,
1918 visible_file_count,
1919 }
1920 }
1921}
1922
1923impl sum_tree::KeyedItem for Entry {
1924 type Key = PathKey;
1925
1926 fn key(&self) -> Self::Key {
1927 PathKey(self.path.clone())
1928 }
1929}
1930
1931#[derive(Clone, Debug)]
1932pub struct EntrySummary {
1933 max_path: Arc<Path>,
1934 count: usize,
1935 visible_count: usize,
1936 file_count: usize,
1937 visible_file_count: usize,
1938}
1939
1940impl Default for EntrySummary {
1941 fn default() -> Self {
1942 Self {
1943 max_path: Arc::from(Path::new("")),
1944 count: 0,
1945 visible_count: 0,
1946 file_count: 0,
1947 visible_file_count: 0,
1948 }
1949 }
1950}
1951
1952impl sum_tree::Summary for EntrySummary {
1953 type Context = ();
1954
1955 fn add_summary(&mut self, rhs: &Self, _: &()) {
1956 self.max_path = rhs.max_path.clone();
1957 self.count += rhs.count;
1958 self.visible_count += rhs.visible_count;
1959 self.file_count += rhs.file_count;
1960 self.visible_file_count += rhs.visible_file_count;
1961 }
1962}
1963
1964#[derive(Clone, Debug)]
1965struct PathEntry {
1966 id: ProjectEntryId,
1967 path: Arc<Path>,
1968 is_ignored: bool,
1969 scan_id: usize,
1970}
1971
1972impl sum_tree::Item for PathEntry {
1973 type Summary = PathEntrySummary;
1974
1975 fn summary(&self) -> Self::Summary {
1976 PathEntrySummary { max_id: self.id }
1977 }
1978}
1979
1980impl sum_tree::KeyedItem for PathEntry {
1981 type Key = ProjectEntryId;
1982
1983 fn key(&self) -> Self::Key {
1984 self.id
1985 }
1986}
1987
1988#[derive(Clone, Debug, Default)]
1989struct PathEntrySummary {
1990 max_id: ProjectEntryId,
1991}
1992
1993impl sum_tree::Summary for PathEntrySummary {
1994 type Context = ();
1995
1996 fn add_summary(&mut self, summary: &Self, _: &Self::Context) {
1997 self.max_id = summary.max_id;
1998 }
1999}
2000
2001impl<'a> sum_tree::Dimension<'a, PathEntrySummary> for ProjectEntryId {
2002 fn add_summary(&mut self, summary: &'a PathEntrySummary, _: &()) {
2003 *self = summary.max_id;
2004 }
2005}
2006
2007#[derive(Clone, Debug, Eq, PartialEq, Ord, PartialOrd)]
2008pub struct PathKey(Arc<Path>);
2009
2010impl Default for PathKey {
2011 fn default() -> Self {
2012 Self(Path::new("").into())
2013 }
2014}
2015
2016impl<'a> sum_tree::Dimension<'a, EntrySummary> for PathKey {
2017 fn add_summary(&mut self, summary: &'a EntrySummary, _: &()) {
2018 self.0 = summary.max_path.clone();
2019 }
2020}
2021
2022struct BackgroundScanner {
2023 fs: Arc<dyn Fs>,
2024 snapshot: Arc<Mutex<LocalSnapshot>>,
2025 notify: UnboundedSender<ScanState>,
2026 executor: Arc<executor::Background>,
2027}
2028
2029impl BackgroundScanner {
2030 fn new(
2031 snapshot: Arc<Mutex<LocalSnapshot>>,
2032 notify: UnboundedSender<ScanState>,
2033 fs: Arc<dyn Fs>,
2034 executor: Arc<executor::Background>,
2035 ) -> Self {
2036 Self {
2037 fs,
2038 snapshot,
2039 notify,
2040 executor,
2041 }
2042 }
2043
2044 fn abs_path(&self) -> Arc<Path> {
2045 self.snapshot.lock().abs_path.clone()
2046 }
2047
2048 fn snapshot(&self) -> LocalSnapshot {
2049 self.snapshot.lock().clone()
2050 }
2051
2052 async fn run(mut self, events_rx: impl Stream<Item = Vec<fsevent::Event>>) {
2053 if self.notify.unbounded_send(ScanState::Scanning).is_err() {
2054 return;
2055 }
2056
2057 if let Err(err) = self.scan_dirs().await {
2058 if self
2059 .notify
2060 .unbounded_send(ScanState::Err(Arc::new(err)))
2061 .is_err()
2062 {
2063 return;
2064 }
2065 }
2066
2067 if self.notify.unbounded_send(ScanState::Idle).is_err() {
2068 return;
2069 }
2070
2071 futures::pin_mut!(events_rx);
2072 while let Some(events) = events_rx.next().await {
2073 if self.notify.unbounded_send(ScanState::Scanning).is_err() {
2074 break;
2075 }
2076
2077 if !self.process_events(events).await {
2078 break;
2079 }
2080
2081 if self.notify.unbounded_send(ScanState::Idle).is_err() {
2082 break;
2083 }
2084 }
2085 }
2086
2087 async fn scan_dirs(&mut self) -> Result<()> {
2088 let root_char_bag;
2089 let next_entry_id;
2090 let is_dir;
2091 {
2092 let snapshot = self.snapshot.lock();
2093 root_char_bag = snapshot.root_char_bag;
2094 next_entry_id = snapshot.next_entry_id.clone();
2095 is_dir = snapshot.root_entry().map_or(false, |e| e.is_dir())
2096 };
2097
2098 if is_dir {
2099 let path: Arc<Path> = Arc::from(Path::new(""));
2100 let abs_path = self.abs_path();
2101 let (tx, rx) = channel::unbounded();
2102 self.executor
2103 .block(tx.send(ScanJob {
2104 abs_path: abs_path.to_path_buf(),
2105 path,
2106 ignore_stack: IgnoreStack::none(),
2107 scan_queue: tx.clone(),
2108 }))
2109 .unwrap();
2110 drop(tx);
2111
2112 self.executor
2113 .scoped(|scope| {
2114 for _ in 0..self.executor.num_cpus() {
2115 scope.spawn(async {
2116 while let Ok(job) = rx.recv().await {
2117 if let Err(err) = self
2118 .scan_dir(root_char_bag, next_entry_id.clone(), &job)
2119 .await
2120 {
2121 log::error!("error scanning {:?}: {}", job.abs_path, err);
2122 }
2123 }
2124 });
2125 }
2126 })
2127 .await;
2128 }
2129
2130 Ok(())
2131 }
2132
2133 async fn scan_dir(
2134 &self,
2135 root_char_bag: CharBag,
2136 next_entry_id: Arc<AtomicUsize>,
2137 job: &ScanJob,
2138 ) -> Result<()> {
2139 let mut new_entries: Vec<Entry> = Vec::new();
2140 let mut new_jobs: Vec<ScanJob> = Vec::new();
2141 let mut ignore_stack = job.ignore_stack.clone();
2142 let mut new_ignore = None;
2143
2144 let mut child_paths = self.fs.read_dir(&job.abs_path).await?;
2145 while let Some(child_abs_path) = child_paths.next().await {
2146 let child_abs_path = match child_abs_path {
2147 Ok(child_abs_path) => child_abs_path,
2148 Err(error) => {
2149 log::error!("error processing entry {:?}", error);
2150 continue;
2151 }
2152 };
2153 let child_name = child_abs_path.file_name().unwrap();
2154 let child_path: Arc<Path> = job.path.join(child_name).into();
2155 let child_metadata = match self.fs.metadata(&child_abs_path).await {
2156 Ok(Some(metadata)) => metadata,
2157 Ok(None) => continue,
2158 Err(err) => {
2159 log::error!("error processing {:?}: {:?}", child_abs_path, err);
2160 continue;
2161 }
2162 };
2163
2164 // If we find a .gitignore, add it to the stack of ignores used to determine which paths are ignored
2165 if child_name == *GITIGNORE {
2166 match build_gitignore(&child_abs_path, self.fs.as_ref()) {
2167 Ok(ignore) => {
2168 let ignore = Arc::new(ignore);
2169 ignore_stack = ignore_stack.append(job.path.clone(), ignore.clone());
2170 new_ignore = Some(ignore);
2171 }
2172 Err(error) => {
2173 log::error!(
2174 "error loading .gitignore file {:?} - {:?}",
2175 child_name,
2176 error
2177 );
2178 }
2179 }
2180
2181 // Update ignore status of any child entries we've already processed to reflect the
2182 // ignore file in the current directory. Because `.gitignore` starts with a `.`,
2183 // there should rarely be too numerous. Update the ignore stack associated with any
2184 // new jobs as well.
2185 let mut new_jobs = new_jobs.iter_mut();
2186 for entry in &mut new_entries {
2187 entry.is_ignored = ignore_stack.is_path_ignored(&entry.path, entry.is_dir());
2188 if entry.is_dir() {
2189 new_jobs.next().unwrap().ignore_stack = if entry.is_ignored {
2190 IgnoreStack::all()
2191 } else {
2192 ignore_stack.clone()
2193 };
2194 }
2195 }
2196 }
2197
2198 let mut child_entry = Entry::new(
2199 child_path.clone(),
2200 &child_metadata,
2201 &next_entry_id,
2202 root_char_bag,
2203 );
2204
2205 if child_metadata.is_dir {
2206 let is_ignored = ignore_stack.is_path_ignored(&child_path, true);
2207 child_entry.is_ignored = is_ignored;
2208 new_entries.push(child_entry);
2209 new_jobs.push(ScanJob {
2210 abs_path: child_abs_path,
2211 path: child_path,
2212 ignore_stack: if is_ignored {
2213 IgnoreStack::all()
2214 } else {
2215 ignore_stack.clone()
2216 },
2217 scan_queue: job.scan_queue.clone(),
2218 });
2219 } else {
2220 child_entry.is_ignored = ignore_stack.is_path_ignored(&child_path, false);
2221 new_entries.push(child_entry);
2222 };
2223 }
2224
2225 self.snapshot
2226 .lock()
2227 .populate_dir(job.path.clone(), new_entries, new_ignore);
2228 for new_job in new_jobs {
2229 job.scan_queue.send(new_job).await.unwrap();
2230 }
2231
2232 Ok(())
2233 }
2234
2235 async fn process_events(&mut self, mut events: Vec<fsevent::Event>) -> bool {
2236 events.sort_unstable_by(|a, b| a.path.cmp(&b.path));
2237 events.dedup_by(|a, b| a.path.starts_with(&b.path));
2238
2239 let root_char_bag;
2240 let root_abs_path;
2241 let next_entry_id;
2242 {
2243 let snapshot = self.snapshot.lock();
2244 root_char_bag = snapshot.root_char_bag;
2245 root_abs_path = snapshot.abs_path.clone();
2246 next_entry_id = snapshot.next_entry_id.clone();
2247 }
2248
2249 let root_abs_path = if let Ok(abs_path) = self.fs.canonicalize(&root_abs_path).await {
2250 abs_path
2251 } else {
2252 return false;
2253 };
2254 let metadata = futures::future::join_all(
2255 events
2256 .iter()
2257 .map(|event| self.fs.metadata(&event.path))
2258 .collect::<Vec<_>>(),
2259 )
2260 .await;
2261
2262 // Hold the snapshot lock while clearing and re-inserting the root entries
2263 // for each event. This way, the snapshot is not observable to the foreground
2264 // thread while this operation is in-progress.
2265 let (scan_queue_tx, scan_queue_rx) = channel::unbounded();
2266 {
2267 let mut snapshot = self.snapshot.lock();
2268 snapshot.scan_id += 1;
2269 for event in &events {
2270 if let Ok(path) = event.path.strip_prefix(&root_abs_path) {
2271 snapshot.remove_path(&path);
2272 }
2273 }
2274
2275 for (event, metadata) in events.into_iter().zip(metadata.into_iter()) {
2276 let path: Arc<Path> = match event.path.strip_prefix(&root_abs_path) {
2277 Ok(path) => Arc::from(path.to_path_buf()),
2278 Err(_) => {
2279 log::error!(
2280 "unexpected event {:?} for root path {:?}",
2281 event.path,
2282 root_abs_path
2283 );
2284 continue;
2285 }
2286 };
2287
2288 match metadata {
2289 Ok(Some(metadata)) => {
2290 let ignore_stack = snapshot.ignore_stack_for_path(&path, metadata.is_dir);
2291 let mut fs_entry = Entry::new(
2292 path.clone(),
2293 &metadata,
2294 snapshot.next_entry_id.as_ref(),
2295 snapshot.root_char_bag,
2296 );
2297 fs_entry.is_ignored = ignore_stack.is_all();
2298 snapshot.insert_entry(fs_entry, self.fs.as_ref());
2299 if metadata.is_dir {
2300 self.executor
2301 .block(scan_queue_tx.send(ScanJob {
2302 abs_path: event.path,
2303 path,
2304 ignore_stack,
2305 scan_queue: scan_queue_tx.clone(),
2306 }))
2307 .unwrap();
2308 }
2309 }
2310 Ok(None) => {}
2311 Err(err) => {
2312 // TODO - create a special 'error' entry in the entries tree to mark this
2313 log::error!("error reading file on event {:?}", err);
2314 }
2315 }
2316 }
2317 drop(scan_queue_tx);
2318 }
2319
2320 // Scan any directories that were created as part of this event batch.
2321 self.executor
2322 .scoped(|scope| {
2323 for _ in 0..self.executor.num_cpus() {
2324 scope.spawn(async {
2325 while let Ok(job) = scan_queue_rx.recv().await {
2326 if let Err(err) = self
2327 .scan_dir(root_char_bag, next_entry_id.clone(), &job)
2328 .await
2329 {
2330 log::error!("error scanning {:?}: {}", job.abs_path, err);
2331 }
2332 }
2333 });
2334 }
2335 })
2336 .await;
2337
2338 // Attempt to detect renames only over a single batch of file-system events.
2339 self.snapshot.lock().removed_entry_ids.clear();
2340
2341 self.update_ignore_statuses().await;
2342 true
2343 }
2344
2345 async fn update_ignore_statuses(&self) {
2346 let mut snapshot = self.snapshot();
2347
2348 let mut ignores_to_update = Vec::new();
2349 let mut ignores_to_delete = Vec::new();
2350 for (parent_path, (_, scan_id)) in &snapshot.ignores {
2351 if *scan_id == snapshot.scan_id && snapshot.entry_for_path(parent_path).is_some() {
2352 ignores_to_update.push(parent_path.clone());
2353 }
2354
2355 let ignore_path = parent_path.join(&*GITIGNORE);
2356 if snapshot.entry_for_path(ignore_path).is_none() {
2357 ignores_to_delete.push(parent_path.clone());
2358 }
2359 }
2360
2361 for parent_path in ignores_to_delete {
2362 snapshot.ignores.remove(&parent_path);
2363 self.snapshot.lock().ignores.remove(&parent_path);
2364 }
2365
2366 let (ignore_queue_tx, ignore_queue_rx) = channel::unbounded();
2367 ignores_to_update.sort_unstable();
2368 let mut ignores_to_update = ignores_to_update.into_iter().peekable();
2369 while let Some(parent_path) = ignores_to_update.next() {
2370 while ignores_to_update
2371 .peek()
2372 .map_or(false, |p| p.starts_with(&parent_path))
2373 {
2374 ignores_to_update.next().unwrap();
2375 }
2376
2377 let ignore_stack = snapshot.ignore_stack_for_path(&parent_path, true);
2378 ignore_queue_tx
2379 .send(UpdateIgnoreStatusJob {
2380 path: parent_path,
2381 ignore_stack,
2382 ignore_queue: ignore_queue_tx.clone(),
2383 })
2384 .await
2385 .unwrap();
2386 }
2387 drop(ignore_queue_tx);
2388
2389 self.executor
2390 .scoped(|scope| {
2391 for _ in 0..self.executor.num_cpus() {
2392 scope.spawn(async {
2393 while let Ok(job) = ignore_queue_rx.recv().await {
2394 self.update_ignore_status(job, &snapshot).await;
2395 }
2396 });
2397 }
2398 })
2399 .await;
2400 }
2401
2402 async fn update_ignore_status(&self, job: UpdateIgnoreStatusJob, snapshot: &LocalSnapshot) {
2403 let mut ignore_stack = job.ignore_stack;
2404 if let Some((ignore, _)) = snapshot.ignores.get(&job.path) {
2405 ignore_stack = ignore_stack.append(job.path.clone(), ignore.clone());
2406 }
2407
2408 let mut entries_by_id_edits = Vec::new();
2409 let mut entries_by_path_edits = Vec::new();
2410 for mut entry in snapshot.child_entries(&job.path).cloned() {
2411 let was_ignored = entry.is_ignored;
2412 entry.is_ignored = ignore_stack.is_path_ignored(&entry.path, entry.is_dir());
2413 if entry.is_dir() {
2414 let child_ignore_stack = if entry.is_ignored {
2415 IgnoreStack::all()
2416 } else {
2417 ignore_stack.clone()
2418 };
2419 job.ignore_queue
2420 .send(UpdateIgnoreStatusJob {
2421 path: entry.path.clone(),
2422 ignore_stack: child_ignore_stack,
2423 ignore_queue: job.ignore_queue.clone(),
2424 })
2425 .await
2426 .unwrap();
2427 }
2428
2429 if entry.is_ignored != was_ignored {
2430 let mut path_entry = snapshot.entries_by_id.get(&entry.id, &()).unwrap().clone();
2431 path_entry.scan_id = snapshot.scan_id;
2432 path_entry.is_ignored = entry.is_ignored;
2433 entries_by_id_edits.push(Edit::Insert(path_entry));
2434 entries_by_path_edits.push(Edit::Insert(entry));
2435 }
2436 }
2437
2438 let mut snapshot = self.snapshot.lock();
2439 snapshot.entries_by_path.edit(entries_by_path_edits, &());
2440 snapshot.entries_by_id.edit(entries_by_id_edits, &());
2441 }
2442}
2443
2444fn char_bag_for_path(root_char_bag: CharBag, path: &Path) -> CharBag {
2445 let mut result = root_char_bag;
2446 result.extend(
2447 path.to_string_lossy()
2448 .chars()
2449 .map(|c| c.to_ascii_lowercase()),
2450 );
2451 result
2452}
2453
2454struct ScanJob {
2455 abs_path: PathBuf,
2456 path: Arc<Path>,
2457 ignore_stack: Arc<IgnoreStack>,
2458 scan_queue: Sender<ScanJob>,
2459}
2460
2461struct UpdateIgnoreStatusJob {
2462 path: Arc<Path>,
2463 ignore_stack: Arc<IgnoreStack>,
2464 ignore_queue: Sender<UpdateIgnoreStatusJob>,
2465}
2466
2467pub trait WorktreeHandle {
2468 #[cfg(any(test, feature = "test-support"))]
2469 fn flush_fs_events<'a>(
2470 &self,
2471 cx: &'a gpui::TestAppContext,
2472 ) -> futures::future::LocalBoxFuture<'a, ()>;
2473}
2474
2475impl WorktreeHandle for ModelHandle<Worktree> {
2476 // When the worktree's FS event stream sometimes delivers "redundant" events for FS changes that
2477 // occurred before the worktree was constructed. These events can cause the worktree to perfrom
2478 // extra directory scans, and emit extra scan-state notifications.
2479 //
2480 // This function mutates the worktree's directory and waits for those mutations to be picked up,
2481 // to ensure that all redundant FS events have already been processed.
2482 #[cfg(any(test, feature = "test-support"))]
2483 fn flush_fs_events<'a>(
2484 &self,
2485 cx: &'a gpui::TestAppContext,
2486 ) -> futures::future::LocalBoxFuture<'a, ()> {
2487 use smol::future::FutureExt;
2488
2489 let filename = "fs-event-sentinel";
2490 let tree = self.clone();
2491 let (fs, root_path) = self.read_with(cx, |tree, _| {
2492 let tree = tree.as_local().unwrap();
2493 (tree.fs.clone(), tree.abs_path().clone())
2494 });
2495
2496 async move {
2497 fs.create_file(&root_path.join(filename), Default::default())
2498 .await
2499 .unwrap();
2500 tree.condition(&cx, |tree, _| tree.entry_for_path(filename).is_some())
2501 .await;
2502
2503 fs.remove_file(&root_path.join(filename), Default::default())
2504 .await
2505 .unwrap();
2506 tree.condition(&cx, |tree, _| tree.entry_for_path(filename).is_none())
2507 .await;
2508
2509 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
2510 .await;
2511 }
2512 .boxed_local()
2513 }
2514}
2515
2516#[derive(Clone, Debug)]
2517struct TraversalProgress<'a> {
2518 max_path: &'a Path,
2519 count: usize,
2520 visible_count: usize,
2521 file_count: usize,
2522 visible_file_count: usize,
2523}
2524
2525impl<'a> TraversalProgress<'a> {
2526 fn count(&self, include_dirs: bool, include_ignored: bool) -> usize {
2527 match (include_ignored, include_dirs) {
2528 (true, true) => self.count,
2529 (true, false) => self.file_count,
2530 (false, true) => self.visible_count,
2531 (false, false) => self.visible_file_count,
2532 }
2533 }
2534}
2535
2536impl<'a> sum_tree::Dimension<'a, EntrySummary> for TraversalProgress<'a> {
2537 fn add_summary(&mut self, summary: &'a EntrySummary, _: &()) {
2538 self.max_path = summary.max_path.as_ref();
2539 self.count += summary.count;
2540 self.visible_count += summary.visible_count;
2541 self.file_count += summary.file_count;
2542 self.visible_file_count += summary.visible_file_count;
2543 }
2544}
2545
2546impl<'a> Default for TraversalProgress<'a> {
2547 fn default() -> Self {
2548 Self {
2549 max_path: Path::new(""),
2550 count: 0,
2551 visible_count: 0,
2552 file_count: 0,
2553 visible_file_count: 0,
2554 }
2555 }
2556}
2557
2558pub struct Traversal<'a> {
2559 cursor: sum_tree::Cursor<'a, Entry, TraversalProgress<'a>>,
2560 include_ignored: bool,
2561 include_dirs: bool,
2562}
2563
2564impl<'a> Traversal<'a> {
2565 pub fn advance(&mut self) -> bool {
2566 self.advance_to_offset(self.offset() + 1)
2567 }
2568
2569 pub fn advance_to_offset(&mut self, offset: usize) -> bool {
2570 self.cursor.seek_forward(
2571 &TraversalTarget::Count {
2572 count: offset,
2573 include_dirs: self.include_dirs,
2574 include_ignored: self.include_ignored,
2575 },
2576 Bias::Right,
2577 &(),
2578 )
2579 }
2580
2581 pub fn advance_to_sibling(&mut self) -> bool {
2582 while let Some(entry) = self.cursor.item() {
2583 self.cursor.seek_forward(
2584 &TraversalTarget::PathSuccessor(&entry.path),
2585 Bias::Left,
2586 &(),
2587 );
2588 if let Some(entry) = self.cursor.item() {
2589 if (self.include_dirs || !entry.is_dir())
2590 && (self.include_ignored || !entry.is_ignored)
2591 {
2592 return true;
2593 }
2594 }
2595 }
2596 false
2597 }
2598
2599 pub fn entry(&self) -> Option<&'a Entry> {
2600 self.cursor.item()
2601 }
2602
2603 pub fn offset(&self) -> usize {
2604 self.cursor
2605 .start()
2606 .count(self.include_dirs, self.include_ignored)
2607 }
2608}
2609
2610impl<'a> Iterator for Traversal<'a> {
2611 type Item = &'a Entry;
2612
2613 fn next(&mut self) -> Option<Self::Item> {
2614 if let Some(item) = self.entry() {
2615 self.advance();
2616 Some(item)
2617 } else {
2618 None
2619 }
2620 }
2621}
2622
2623#[derive(Debug)]
2624enum TraversalTarget<'a> {
2625 Path(&'a Path),
2626 PathSuccessor(&'a Path),
2627 Count {
2628 count: usize,
2629 include_ignored: bool,
2630 include_dirs: bool,
2631 },
2632}
2633
2634impl<'a, 'b> SeekTarget<'a, EntrySummary, TraversalProgress<'a>> for TraversalTarget<'b> {
2635 fn cmp(&self, cursor_location: &TraversalProgress<'a>, _: &()) -> Ordering {
2636 match self {
2637 TraversalTarget::Path(path) => path.cmp(&cursor_location.max_path),
2638 TraversalTarget::PathSuccessor(path) => {
2639 if !cursor_location.max_path.starts_with(path) {
2640 Ordering::Equal
2641 } else {
2642 Ordering::Greater
2643 }
2644 }
2645 TraversalTarget::Count {
2646 count,
2647 include_dirs,
2648 include_ignored,
2649 } => Ord::cmp(
2650 count,
2651 &cursor_location.count(*include_dirs, *include_ignored),
2652 ),
2653 }
2654 }
2655}
2656
2657struct ChildEntriesIter<'a> {
2658 parent_path: &'a Path,
2659 traversal: Traversal<'a>,
2660}
2661
2662impl<'a> Iterator for ChildEntriesIter<'a> {
2663 type Item = &'a Entry;
2664
2665 fn next(&mut self) -> Option<Self::Item> {
2666 if let Some(item) = self.traversal.entry() {
2667 if item.path.starts_with(&self.parent_path) {
2668 self.traversal.advance_to_sibling();
2669 return Some(item);
2670 }
2671 }
2672 None
2673 }
2674}
2675
2676impl<'a> From<&'a Entry> for proto::Entry {
2677 fn from(entry: &'a Entry) -> Self {
2678 Self {
2679 id: entry.id.to_proto(),
2680 is_dir: entry.is_dir(),
2681 path: entry.path.as_os_str().as_bytes().to_vec(),
2682 inode: entry.inode,
2683 mtime: Some(entry.mtime.into()),
2684 is_symlink: entry.is_symlink,
2685 is_ignored: entry.is_ignored,
2686 }
2687 }
2688}
2689
2690impl<'a> TryFrom<(&'a CharBag, proto::Entry)> for Entry {
2691 type Error = anyhow::Error;
2692
2693 fn try_from((root_char_bag, entry): (&'a CharBag, proto::Entry)) -> Result<Self> {
2694 if let Some(mtime) = entry.mtime {
2695 let kind = if entry.is_dir {
2696 EntryKind::Dir
2697 } else {
2698 let mut char_bag = root_char_bag.clone();
2699 char_bag.extend(
2700 String::from_utf8_lossy(&entry.path)
2701 .chars()
2702 .map(|c| c.to_ascii_lowercase()),
2703 );
2704 EntryKind::File(char_bag)
2705 };
2706 let path: Arc<Path> = PathBuf::from(OsString::from_vec(entry.path)).into();
2707 Ok(Entry {
2708 id: ProjectEntryId::from_proto(entry.id),
2709 kind,
2710 path: path.clone(),
2711 inode: entry.inode,
2712 mtime: mtime.into(),
2713 is_symlink: entry.is_symlink,
2714 is_ignored: entry.is_ignored,
2715 })
2716 } else {
2717 Err(anyhow!(
2718 "missing mtime in remote worktree entry {:?}",
2719 entry.path
2720 ))
2721 }
2722 }
2723}
2724
2725#[cfg(test)]
2726mod tests {
2727 use super::*;
2728 use crate::fs::FakeFs;
2729 use anyhow::Result;
2730 use client::test::FakeHttpClient;
2731 use fs::RealFs;
2732 use gpui::TestAppContext;
2733 use rand::prelude::*;
2734 use serde_json::json;
2735 use std::{
2736 env,
2737 fmt::Write,
2738 time::{SystemTime, UNIX_EPOCH},
2739 };
2740 use util::test::temp_tree;
2741
2742 #[gpui::test]
2743 async fn test_traversal(cx: &mut TestAppContext) {
2744 let fs = FakeFs::new(cx.background());
2745 fs.insert_tree(
2746 "/root",
2747 json!({
2748 ".gitignore": "a/b\n",
2749 "a": {
2750 "b": "",
2751 "c": "",
2752 }
2753 }),
2754 )
2755 .await;
2756
2757 let http_client = FakeHttpClient::with_404_response();
2758 let client = Client::new(http_client);
2759
2760 let tree = Worktree::local(
2761 client,
2762 Arc::from(Path::new("/root")),
2763 true,
2764 fs,
2765 Default::default(),
2766 &mut cx.to_async(),
2767 )
2768 .await
2769 .unwrap();
2770 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
2771 .await;
2772
2773 tree.read_with(cx, |tree, _| {
2774 assert_eq!(
2775 tree.entries(false)
2776 .map(|entry| entry.path.as_ref())
2777 .collect::<Vec<_>>(),
2778 vec![
2779 Path::new(""),
2780 Path::new(".gitignore"),
2781 Path::new("a"),
2782 Path::new("a/c"),
2783 ]
2784 );
2785 assert_eq!(
2786 tree.entries(true)
2787 .map(|entry| entry.path.as_ref())
2788 .collect::<Vec<_>>(),
2789 vec![
2790 Path::new(""),
2791 Path::new(".gitignore"),
2792 Path::new("a"),
2793 Path::new("a/b"),
2794 Path::new("a/c"),
2795 ]
2796 );
2797 })
2798 }
2799
2800 #[gpui::test]
2801 async fn test_rescan_with_gitignore(cx: &mut TestAppContext) {
2802 let dir = temp_tree(json!({
2803 ".git": {},
2804 ".gitignore": "ignored-dir\n",
2805 "tracked-dir": {
2806 "tracked-file1": "tracked contents",
2807 },
2808 "ignored-dir": {
2809 "ignored-file1": "ignored contents",
2810 }
2811 }));
2812
2813 let http_client = FakeHttpClient::with_404_response();
2814 let client = Client::new(http_client.clone());
2815
2816 let tree = Worktree::local(
2817 client,
2818 dir.path(),
2819 true,
2820 Arc::new(RealFs),
2821 Default::default(),
2822 &mut cx.to_async(),
2823 )
2824 .await
2825 .unwrap();
2826 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
2827 .await;
2828 tree.flush_fs_events(&cx).await;
2829 cx.read(|cx| {
2830 let tree = tree.read(cx);
2831 let tracked = tree.entry_for_path("tracked-dir/tracked-file1").unwrap();
2832 let ignored = tree.entry_for_path("ignored-dir/ignored-file1").unwrap();
2833 assert_eq!(tracked.is_ignored, false);
2834 assert_eq!(ignored.is_ignored, true);
2835 });
2836
2837 std::fs::write(dir.path().join("tracked-dir/tracked-file2"), "").unwrap();
2838 std::fs::write(dir.path().join("ignored-dir/ignored-file2"), "").unwrap();
2839 tree.flush_fs_events(&cx).await;
2840 cx.read(|cx| {
2841 let tree = tree.read(cx);
2842 let dot_git = tree.entry_for_path(".git").unwrap();
2843 let tracked = tree.entry_for_path("tracked-dir/tracked-file2").unwrap();
2844 let ignored = tree.entry_for_path("ignored-dir/ignored-file2").unwrap();
2845 assert_eq!(tracked.is_ignored, false);
2846 assert_eq!(ignored.is_ignored, true);
2847 assert_eq!(dot_git.is_ignored, true);
2848 });
2849 }
2850
2851 #[gpui::test]
2852 async fn test_write_file(cx: &mut TestAppContext) {
2853 let dir = temp_tree(json!({
2854 ".git": {},
2855 ".gitignore": "ignored-dir\n",
2856 "tracked-dir": {},
2857 "ignored-dir": {}
2858 }));
2859
2860 let http_client = FakeHttpClient::with_404_response();
2861 let client = Client::new(http_client.clone());
2862
2863 let tree = Worktree::local(
2864 client,
2865 dir.path(),
2866 true,
2867 Arc::new(RealFs),
2868 Default::default(),
2869 &mut cx.to_async(),
2870 )
2871 .await
2872 .unwrap();
2873 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
2874 .await;
2875 tree.flush_fs_events(&cx).await;
2876
2877 tree.update(cx, |tree, cx| {
2878 tree.as_local().unwrap().write_file(
2879 Path::new("tracked-dir/file.txt"),
2880 "hello".into(),
2881 cx,
2882 )
2883 })
2884 .await
2885 .unwrap();
2886 tree.update(cx, |tree, cx| {
2887 tree.as_local().unwrap().write_file(
2888 Path::new("ignored-dir/file.txt"),
2889 "world".into(),
2890 cx,
2891 )
2892 })
2893 .await
2894 .unwrap();
2895
2896 tree.read_with(cx, |tree, _| {
2897 let tracked = tree.entry_for_path("tracked-dir/file.txt").unwrap();
2898 let ignored = tree.entry_for_path("ignored-dir/file.txt").unwrap();
2899 assert_eq!(tracked.is_ignored, false);
2900 assert_eq!(ignored.is_ignored, true);
2901 });
2902 }
2903
2904 #[gpui::test(iterations = 100)]
2905 fn test_random(mut rng: StdRng) {
2906 let operations = env::var("OPERATIONS")
2907 .map(|o| o.parse().unwrap())
2908 .unwrap_or(40);
2909 let initial_entries = env::var("INITIAL_ENTRIES")
2910 .map(|o| o.parse().unwrap())
2911 .unwrap_or(20);
2912
2913 let root_dir = tempdir::TempDir::new("worktree-test").unwrap();
2914 for _ in 0..initial_entries {
2915 randomly_mutate_tree(root_dir.path(), 1.0, &mut rng).unwrap();
2916 }
2917 log::info!("Generated initial tree");
2918
2919 let (notify_tx, _notify_rx) = mpsc::unbounded();
2920 let fs = Arc::new(RealFs);
2921 let next_entry_id = Arc::new(AtomicUsize::new(0));
2922 let mut initial_snapshot = LocalSnapshot {
2923 abs_path: root_dir.path().into(),
2924 removed_entry_ids: Default::default(),
2925 ignores: Default::default(),
2926 next_entry_id: next_entry_id.clone(),
2927 snapshot: Snapshot {
2928 id: WorktreeId::from_usize(0),
2929 entries_by_path: Default::default(),
2930 entries_by_id: Default::default(),
2931 root_name: Default::default(),
2932 root_char_bag: Default::default(),
2933 scan_id: 0,
2934 },
2935 };
2936 initial_snapshot.insert_entry(
2937 Entry::new(
2938 Path::new("").into(),
2939 &smol::block_on(fs.metadata(root_dir.path()))
2940 .unwrap()
2941 .unwrap(),
2942 &next_entry_id,
2943 Default::default(),
2944 ),
2945 fs.as_ref(),
2946 );
2947 let mut scanner = BackgroundScanner::new(
2948 Arc::new(Mutex::new(initial_snapshot.clone())),
2949 notify_tx,
2950 fs.clone(),
2951 Arc::new(gpui::executor::Background::new()),
2952 );
2953 smol::block_on(scanner.scan_dirs()).unwrap();
2954 scanner.snapshot().check_invariants();
2955
2956 let mut events = Vec::new();
2957 let mut snapshots = Vec::new();
2958 let mut mutations_len = operations;
2959 while mutations_len > 1 {
2960 if !events.is_empty() && rng.gen_bool(0.4) {
2961 let len = rng.gen_range(0..=events.len());
2962 let to_deliver = events.drain(0..len).collect::<Vec<_>>();
2963 log::info!("Delivering events: {:#?}", to_deliver);
2964 smol::block_on(scanner.process_events(to_deliver));
2965 scanner.snapshot().check_invariants();
2966 } else {
2967 events.extend(randomly_mutate_tree(root_dir.path(), 0.6, &mut rng).unwrap());
2968 mutations_len -= 1;
2969 }
2970
2971 if rng.gen_bool(0.2) {
2972 snapshots.push(scanner.snapshot());
2973 }
2974 }
2975 log::info!("Quiescing: {:#?}", events);
2976 smol::block_on(scanner.process_events(events));
2977 scanner.snapshot().check_invariants();
2978
2979 let (notify_tx, _notify_rx) = mpsc::unbounded();
2980 let mut new_scanner = BackgroundScanner::new(
2981 Arc::new(Mutex::new(initial_snapshot)),
2982 notify_tx,
2983 scanner.fs.clone(),
2984 scanner.executor.clone(),
2985 );
2986 smol::block_on(new_scanner.scan_dirs()).unwrap();
2987 assert_eq!(
2988 scanner.snapshot().to_vec(true),
2989 new_scanner.snapshot().to_vec(true)
2990 );
2991
2992 for mut prev_snapshot in snapshots {
2993 let include_ignored = rng.gen::<bool>();
2994 if !include_ignored {
2995 let mut entries_by_path_edits = Vec::new();
2996 let mut entries_by_id_edits = Vec::new();
2997 for entry in prev_snapshot
2998 .entries_by_id
2999 .cursor::<()>()
3000 .filter(|e| e.is_ignored)
3001 {
3002 entries_by_path_edits.push(Edit::Remove(PathKey(entry.path.clone())));
3003 entries_by_id_edits.push(Edit::Remove(entry.id));
3004 }
3005
3006 prev_snapshot
3007 .entries_by_path
3008 .edit(entries_by_path_edits, &());
3009 prev_snapshot.entries_by_id.edit(entries_by_id_edits, &());
3010 }
3011
3012 let update = scanner
3013 .snapshot()
3014 .build_update(&prev_snapshot, 0, 0, include_ignored);
3015 prev_snapshot.apply_remote_update(update).unwrap();
3016 assert_eq!(
3017 prev_snapshot.to_vec(true),
3018 scanner.snapshot().to_vec(include_ignored)
3019 );
3020 }
3021 }
3022
3023 fn randomly_mutate_tree(
3024 root_path: &Path,
3025 insertion_probability: f64,
3026 rng: &mut impl Rng,
3027 ) -> Result<Vec<fsevent::Event>> {
3028 let root_path = root_path.canonicalize().unwrap();
3029 let (dirs, files) = read_dir_recursive(root_path.clone());
3030
3031 let mut events = Vec::new();
3032 let mut record_event = |path: PathBuf| {
3033 events.push(fsevent::Event {
3034 event_id: SystemTime::now()
3035 .duration_since(UNIX_EPOCH)
3036 .unwrap()
3037 .as_secs(),
3038 flags: fsevent::StreamFlags::empty(),
3039 path,
3040 });
3041 };
3042
3043 if (files.is_empty() && dirs.len() == 1) || rng.gen_bool(insertion_probability) {
3044 let path = dirs.choose(rng).unwrap();
3045 let new_path = path.join(gen_name(rng));
3046
3047 if rng.gen() {
3048 log::info!("Creating dir {:?}", new_path.strip_prefix(root_path)?);
3049 std::fs::create_dir(&new_path)?;
3050 } else {
3051 log::info!("Creating file {:?}", new_path.strip_prefix(root_path)?);
3052 std::fs::write(&new_path, "")?;
3053 }
3054 record_event(new_path);
3055 } else if rng.gen_bool(0.05) {
3056 let ignore_dir_path = dirs.choose(rng).unwrap();
3057 let ignore_path = ignore_dir_path.join(&*GITIGNORE);
3058
3059 let (subdirs, subfiles) = read_dir_recursive(ignore_dir_path.clone());
3060 let files_to_ignore = {
3061 let len = rng.gen_range(0..=subfiles.len());
3062 subfiles.choose_multiple(rng, len)
3063 };
3064 let dirs_to_ignore = {
3065 let len = rng.gen_range(0..subdirs.len());
3066 subdirs.choose_multiple(rng, len)
3067 };
3068
3069 let mut ignore_contents = String::new();
3070 for path_to_ignore in files_to_ignore.chain(dirs_to_ignore) {
3071 write!(
3072 ignore_contents,
3073 "{}\n",
3074 path_to_ignore
3075 .strip_prefix(&ignore_dir_path)?
3076 .to_str()
3077 .unwrap()
3078 )
3079 .unwrap();
3080 }
3081 log::info!(
3082 "Creating {:?} with contents:\n{}",
3083 ignore_path.strip_prefix(&root_path)?,
3084 ignore_contents
3085 );
3086 std::fs::write(&ignore_path, ignore_contents).unwrap();
3087 record_event(ignore_path);
3088 } else {
3089 let old_path = {
3090 let file_path = files.choose(rng);
3091 let dir_path = dirs[1..].choose(rng);
3092 file_path.into_iter().chain(dir_path).choose(rng).unwrap()
3093 };
3094
3095 let is_rename = rng.gen();
3096 if is_rename {
3097 let new_path_parent = dirs
3098 .iter()
3099 .filter(|d| !d.starts_with(old_path))
3100 .choose(rng)
3101 .unwrap();
3102
3103 let overwrite_existing_dir =
3104 !old_path.starts_with(&new_path_parent) && rng.gen_bool(0.3);
3105 let new_path = if overwrite_existing_dir {
3106 std::fs::remove_dir_all(&new_path_parent).ok();
3107 new_path_parent.to_path_buf()
3108 } else {
3109 new_path_parent.join(gen_name(rng))
3110 };
3111
3112 log::info!(
3113 "Renaming {:?} to {}{:?}",
3114 old_path.strip_prefix(&root_path)?,
3115 if overwrite_existing_dir {
3116 "overwrite "
3117 } else {
3118 ""
3119 },
3120 new_path.strip_prefix(&root_path)?
3121 );
3122 std::fs::rename(&old_path, &new_path)?;
3123 record_event(old_path.clone());
3124 record_event(new_path);
3125 } else if old_path.is_dir() {
3126 let (dirs, files) = read_dir_recursive(old_path.clone());
3127
3128 log::info!("Deleting dir {:?}", old_path.strip_prefix(&root_path)?);
3129 std::fs::remove_dir_all(&old_path).unwrap();
3130 for file in files {
3131 record_event(file);
3132 }
3133 for dir in dirs {
3134 record_event(dir);
3135 }
3136 } else {
3137 log::info!("Deleting file {:?}", old_path.strip_prefix(&root_path)?);
3138 std::fs::remove_file(old_path).unwrap();
3139 record_event(old_path.clone());
3140 }
3141 }
3142
3143 Ok(events)
3144 }
3145
3146 fn read_dir_recursive(path: PathBuf) -> (Vec<PathBuf>, Vec<PathBuf>) {
3147 let child_entries = std::fs::read_dir(&path).unwrap();
3148 let mut dirs = vec![path];
3149 let mut files = Vec::new();
3150 for child_entry in child_entries {
3151 let child_path = child_entry.unwrap().path();
3152 if child_path.is_dir() {
3153 let (child_dirs, child_files) = read_dir_recursive(child_path);
3154 dirs.extend(child_dirs);
3155 files.extend(child_files);
3156 } else {
3157 files.push(child_path);
3158 }
3159 }
3160 (dirs, files)
3161 }
3162
3163 fn gen_name(rng: &mut impl Rng) -> String {
3164 (0..6)
3165 .map(|_| rng.sample(rand::distributions::Alphanumeric))
3166 .map(char::from)
3167 .collect()
3168 }
3169
3170 impl LocalSnapshot {
3171 fn check_invariants(&self) {
3172 let mut files = self.files(true, 0);
3173 let mut visible_files = self.files(false, 0);
3174 for entry in self.entries_by_path.cursor::<()>() {
3175 if entry.is_file() {
3176 assert_eq!(files.next().unwrap().inode, entry.inode);
3177 if !entry.is_ignored {
3178 assert_eq!(visible_files.next().unwrap().inode, entry.inode);
3179 }
3180 }
3181 }
3182 assert!(files.next().is_none());
3183 assert!(visible_files.next().is_none());
3184
3185 let mut bfs_paths = Vec::new();
3186 let mut stack = vec![Path::new("")];
3187 while let Some(path) = stack.pop() {
3188 bfs_paths.push(path);
3189 let ix = stack.len();
3190 for child_entry in self.child_entries(path) {
3191 stack.insert(ix, &child_entry.path);
3192 }
3193 }
3194
3195 let dfs_paths_via_iter = self
3196 .entries_by_path
3197 .cursor::<()>()
3198 .map(|e| e.path.as_ref())
3199 .collect::<Vec<_>>();
3200 assert_eq!(bfs_paths, dfs_paths_via_iter);
3201
3202 let dfs_paths_via_traversal = self
3203 .entries(true)
3204 .map(|e| e.path.as_ref())
3205 .collect::<Vec<_>>();
3206 assert_eq!(dfs_paths_via_traversal, dfs_paths_via_iter);
3207
3208 for (ignore_parent_path, _) in &self.ignores {
3209 assert!(self.entry_for_path(ignore_parent_path).is_some());
3210 assert!(self
3211 .entry_for_path(ignore_parent_path.join(&*GITIGNORE))
3212 .is_some());
3213 }
3214 }
3215
3216 fn to_vec(&self, include_ignored: bool) -> Vec<(&Path, u64, bool)> {
3217 let mut paths = Vec::new();
3218 for entry in self.entries_by_path.cursor::<()>() {
3219 if include_ignored || !entry.is_ignored {
3220 paths.push((entry.path.as_ref(), entry.inode, entry.is_ignored));
3221 }
3222 }
3223 paths.sort_by(|a, b| a.0.cmp(&b.0));
3224 paths
3225 }
3226 }
3227}