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