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 mtime: SystemTime,
1740 cx: &mut MutableAppContext,
1741 ) {
1742 let worktree = self.worktree.read(cx).as_local().unwrap();
1743 if let Some(project_id) = worktree.share.as_ref().map(|share| share.project_id) {
1744 worktree
1745 .client
1746 .send(proto::BufferReloaded {
1747 project_id,
1748 buffer_id,
1749 version: serialize_version(&version),
1750 mtime: Some(mtime.into()),
1751 fingerprint,
1752 })
1753 .log_err();
1754 }
1755 }
1756}
1757
1758impl File {
1759 pub fn from_proto(
1760 proto: rpc::proto::File,
1761 worktree: ModelHandle<Worktree>,
1762 cx: &AppContext,
1763 ) -> Result<Self> {
1764 let worktree_id = worktree
1765 .read(cx)
1766 .as_remote()
1767 .ok_or_else(|| anyhow!("not remote"))?
1768 .id();
1769
1770 if worktree_id.to_proto() != proto.worktree_id {
1771 return Err(anyhow!("worktree id does not match file"));
1772 }
1773
1774 Ok(Self {
1775 worktree,
1776 path: Path::new(&proto.path).into(),
1777 mtime: proto.mtime.ok_or_else(|| anyhow!("no timestamp"))?.into(),
1778 entry_id: proto.entry_id.map(ProjectEntryId::from_proto),
1779 is_local: false,
1780 })
1781 }
1782
1783 pub fn from_dyn(file: Option<&dyn language::File>) -> Option<&Self> {
1784 file.and_then(|f| f.as_any().downcast_ref())
1785 }
1786
1787 pub fn worktree_id(&self, cx: &AppContext) -> WorktreeId {
1788 self.worktree.read(cx).id()
1789 }
1790
1791 pub fn project_entry_id(&self, _: &AppContext) -> Option<ProjectEntryId> {
1792 self.entry_id
1793 }
1794}
1795
1796#[derive(Clone, Debug, PartialEq, Eq)]
1797pub struct Entry {
1798 pub id: ProjectEntryId,
1799 pub kind: EntryKind,
1800 pub path: Arc<Path>,
1801 pub inode: u64,
1802 pub mtime: SystemTime,
1803 pub is_symlink: bool,
1804 pub is_ignored: bool,
1805}
1806
1807#[derive(Clone, Copy, Debug, PartialEq, Eq)]
1808pub enum EntryKind {
1809 PendingDir,
1810 Dir,
1811 File(CharBag),
1812}
1813
1814impl Entry {
1815 fn new(
1816 path: Arc<Path>,
1817 metadata: &fs::Metadata,
1818 next_entry_id: &AtomicUsize,
1819 root_char_bag: CharBag,
1820 ) -> Self {
1821 Self {
1822 id: ProjectEntryId::new(next_entry_id),
1823 kind: if metadata.is_dir {
1824 EntryKind::PendingDir
1825 } else {
1826 EntryKind::File(char_bag_for_path(root_char_bag, &path))
1827 },
1828 path,
1829 inode: metadata.inode,
1830 mtime: metadata.mtime,
1831 is_symlink: metadata.is_symlink,
1832 is_ignored: false,
1833 }
1834 }
1835
1836 pub fn is_dir(&self) -> bool {
1837 matches!(self.kind, EntryKind::Dir | EntryKind::PendingDir)
1838 }
1839
1840 pub fn is_file(&self) -> bool {
1841 matches!(self.kind, EntryKind::File(_))
1842 }
1843}
1844
1845impl sum_tree::Item for Entry {
1846 type Summary = EntrySummary;
1847
1848 fn summary(&self) -> Self::Summary {
1849 let visible_count = if self.is_ignored { 0 } else { 1 };
1850 let file_count;
1851 let visible_file_count;
1852 if self.is_file() {
1853 file_count = 1;
1854 visible_file_count = visible_count;
1855 } else {
1856 file_count = 0;
1857 visible_file_count = 0;
1858 }
1859
1860 EntrySummary {
1861 max_path: self.path.clone(),
1862 count: 1,
1863 visible_count,
1864 file_count,
1865 visible_file_count,
1866 }
1867 }
1868}
1869
1870impl sum_tree::KeyedItem for Entry {
1871 type Key = PathKey;
1872
1873 fn key(&self) -> Self::Key {
1874 PathKey(self.path.clone())
1875 }
1876}
1877
1878#[derive(Clone, Debug)]
1879pub struct EntrySummary {
1880 max_path: Arc<Path>,
1881 count: usize,
1882 visible_count: usize,
1883 file_count: usize,
1884 visible_file_count: usize,
1885}
1886
1887impl Default for EntrySummary {
1888 fn default() -> Self {
1889 Self {
1890 max_path: Arc::from(Path::new("")),
1891 count: 0,
1892 visible_count: 0,
1893 file_count: 0,
1894 visible_file_count: 0,
1895 }
1896 }
1897}
1898
1899impl sum_tree::Summary for EntrySummary {
1900 type Context = ();
1901
1902 fn add_summary(&mut self, rhs: &Self, _: &()) {
1903 self.max_path = rhs.max_path.clone();
1904 self.count += rhs.count;
1905 self.visible_count += rhs.visible_count;
1906 self.file_count += rhs.file_count;
1907 self.visible_file_count += rhs.visible_file_count;
1908 }
1909}
1910
1911#[derive(Clone, Debug)]
1912struct PathEntry {
1913 id: ProjectEntryId,
1914 path: Arc<Path>,
1915 is_ignored: bool,
1916 scan_id: usize,
1917}
1918
1919impl sum_tree::Item for PathEntry {
1920 type Summary = PathEntrySummary;
1921
1922 fn summary(&self) -> Self::Summary {
1923 PathEntrySummary { max_id: self.id }
1924 }
1925}
1926
1927impl sum_tree::KeyedItem for PathEntry {
1928 type Key = ProjectEntryId;
1929
1930 fn key(&self) -> Self::Key {
1931 self.id
1932 }
1933}
1934
1935#[derive(Clone, Debug, Default)]
1936struct PathEntrySummary {
1937 max_id: ProjectEntryId,
1938}
1939
1940impl sum_tree::Summary for PathEntrySummary {
1941 type Context = ();
1942
1943 fn add_summary(&mut self, summary: &Self, _: &Self::Context) {
1944 self.max_id = summary.max_id;
1945 }
1946}
1947
1948impl<'a> sum_tree::Dimension<'a, PathEntrySummary> for ProjectEntryId {
1949 fn add_summary(&mut self, summary: &'a PathEntrySummary, _: &()) {
1950 *self = summary.max_id;
1951 }
1952}
1953
1954#[derive(Clone, Debug, Eq, PartialEq, Ord, PartialOrd)]
1955pub struct PathKey(Arc<Path>);
1956
1957impl Default for PathKey {
1958 fn default() -> Self {
1959 Self(Path::new("").into())
1960 }
1961}
1962
1963impl<'a> sum_tree::Dimension<'a, EntrySummary> for PathKey {
1964 fn add_summary(&mut self, summary: &'a EntrySummary, _: &()) {
1965 self.0 = summary.max_path.clone();
1966 }
1967}
1968
1969struct BackgroundScanner {
1970 fs: Arc<dyn Fs>,
1971 snapshot: Arc<Mutex<LocalSnapshot>>,
1972 notify: UnboundedSender<ScanState>,
1973 executor: Arc<executor::Background>,
1974}
1975
1976impl BackgroundScanner {
1977 fn new(
1978 snapshot: Arc<Mutex<LocalSnapshot>>,
1979 notify: UnboundedSender<ScanState>,
1980 fs: Arc<dyn Fs>,
1981 executor: Arc<executor::Background>,
1982 ) -> Self {
1983 Self {
1984 fs,
1985 snapshot,
1986 notify,
1987 executor,
1988 }
1989 }
1990
1991 fn abs_path(&self) -> Arc<Path> {
1992 self.snapshot.lock().abs_path.clone()
1993 }
1994
1995 fn snapshot(&self) -> LocalSnapshot {
1996 self.snapshot.lock().clone()
1997 }
1998
1999 async fn run(mut self, events_rx: impl Stream<Item = Vec<fsevent::Event>>) {
2000 if self.notify.unbounded_send(ScanState::Initializing).is_err() {
2001 return;
2002 }
2003
2004 if let Err(err) = self.scan_dirs().await {
2005 if self
2006 .notify
2007 .unbounded_send(ScanState::Err(Arc::new(err)))
2008 .is_err()
2009 {
2010 return;
2011 }
2012 }
2013
2014 if self.notify.unbounded_send(ScanState::Idle).is_err() {
2015 return;
2016 }
2017
2018 futures::pin_mut!(events_rx);
2019
2020 while let Some(mut events) = events_rx.next().await {
2021 while let Poll::Ready(Some(additional_events)) = futures::poll!(events_rx.next()) {
2022 events.extend(additional_events);
2023 }
2024
2025 if self.notify.unbounded_send(ScanState::Updating).is_err() {
2026 break;
2027 }
2028
2029 if !self.process_events(events).await {
2030 break;
2031 }
2032
2033 if self.notify.unbounded_send(ScanState::Idle).is_err() {
2034 break;
2035 }
2036 }
2037 }
2038
2039 async fn scan_dirs(&mut self) -> Result<()> {
2040 let root_char_bag;
2041 let next_entry_id;
2042 let is_dir;
2043 {
2044 let snapshot = self.snapshot.lock();
2045 root_char_bag = snapshot.root_char_bag;
2046 next_entry_id = snapshot.next_entry_id.clone();
2047 is_dir = snapshot.root_entry().map_or(false, |e| e.is_dir())
2048 };
2049
2050 if is_dir {
2051 let path: Arc<Path> = Arc::from(Path::new(""));
2052 let abs_path = self.abs_path();
2053 let (tx, rx) = channel::unbounded();
2054 self.executor
2055 .block(tx.send(ScanJob {
2056 abs_path: abs_path.to_path_buf(),
2057 path,
2058 ignore_stack: IgnoreStack::none(),
2059 scan_queue: tx.clone(),
2060 }))
2061 .unwrap();
2062 drop(tx);
2063
2064 self.executor
2065 .scoped(|scope| {
2066 for _ in 0..self.executor.num_cpus() {
2067 scope.spawn(async {
2068 while let Ok(job) = rx.recv().await {
2069 if let Err(err) = self
2070 .scan_dir(root_char_bag, next_entry_id.clone(), &job)
2071 .await
2072 {
2073 log::error!("error scanning {:?}: {}", job.abs_path, err);
2074 }
2075 }
2076 });
2077 }
2078 })
2079 .await;
2080 }
2081
2082 Ok(())
2083 }
2084
2085 async fn scan_dir(
2086 &self,
2087 root_char_bag: CharBag,
2088 next_entry_id: Arc<AtomicUsize>,
2089 job: &ScanJob,
2090 ) -> Result<()> {
2091 let mut new_entries: Vec<Entry> = Vec::new();
2092 let mut new_jobs: Vec<ScanJob> = Vec::new();
2093 let mut ignore_stack = job.ignore_stack.clone();
2094 let mut new_ignore = None;
2095
2096 let mut child_paths = self.fs.read_dir(&job.abs_path).await?;
2097 while let Some(child_abs_path) = child_paths.next().await {
2098 let child_abs_path = match child_abs_path {
2099 Ok(child_abs_path) => child_abs_path,
2100 Err(error) => {
2101 log::error!("error processing entry {:?}", error);
2102 continue;
2103 }
2104 };
2105 let child_name = child_abs_path.file_name().unwrap();
2106 let child_path: Arc<Path> = job.path.join(child_name).into();
2107 let child_metadata = match self.fs.metadata(&child_abs_path).await {
2108 Ok(Some(metadata)) => metadata,
2109 Ok(None) => continue,
2110 Err(err) => {
2111 log::error!("error processing {:?}: {:?}", child_abs_path, err);
2112 continue;
2113 }
2114 };
2115
2116 // If we find a .gitignore, add it to the stack of ignores used to determine which paths are ignored
2117 if child_name == *GITIGNORE {
2118 match build_gitignore(&child_abs_path, self.fs.as_ref()) {
2119 Ok(ignore) => {
2120 let ignore = Arc::new(ignore);
2121 ignore_stack = ignore_stack.append(job.path.clone(), ignore.clone());
2122 new_ignore = Some(ignore);
2123 }
2124 Err(error) => {
2125 log::error!(
2126 "error loading .gitignore file {:?} - {:?}",
2127 child_name,
2128 error
2129 );
2130 }
2131 }
2132
2133 // Update ignore status of any child entries we've already processed to reflect the
2134 // ignore file in the current directory. Because `.gitignore` starts with a `.`,
2135 // there should rarely be too numerous. Update the ignore stack associated with any
2136 // new jobs as well.
2137 let mut new_jobs = new_jobs.iter_mut();
2138 for entry in &mut new_entries {
2139 entry.is_ignored = ignore_stack.is_path_ignored(&entry.path, entry.is_dir());
2140 if entry.is_dir() {
2141 new_jobs.next().unwrap().ignore_stack = if entry.is_ignored {
2142 IgnoreStack::all()
2143 } else {
2144 ignore_stack.clone()
2145 };
2146 }
2147 }
2148 }
2149
2150 let mut child_entry = Entry::new(
2151 child_path.clone(),
2152 &child_metadata,
2153 &next_entry_id,
2154 root_char_bag,
2155 );
2156
2157 if child_metadata.is_dir {
2158 let is_ignored = ignore_stack.is_path_ignored(&child_path, true);
2159 child_entry.is_ignored = is_ignored;
2160 new_entries.push(child_entry);
2161 new_jobs.push(ScanJob {
2162 abs_path: child_abs_path,
2163 path: child_path,
2164 ignore_stack: if is_ignored {
2165 IgnoreStack::all()
2166 } else {
2167 ignore_stack.clone()
2168 },
2169 scan_queue: job.scan_queue.clone(),
2170 });
2171 } else {
2172 child_entry.is_ignored = ignore_stack.is_path_ignored(&child_path, false);
2173 new_entries.push(child_entry);
2174 };
2175 }
2176
2177 self.snapshot
2178 .lock()
2179 .populate_dir(job.path.clone(), new_entries, new_ignore);
2180 for new_job in new_jobs {
2181 job.scan_queue.send(new_job).await.unwrap();
2182 }
2183
2184 Ok(())
2185 }
2186
2187 async fn process_events(&mut self, mut events: Vec<fsevent::Event>) -> bool {
2188 events.sort_unstable_by(|a, b| a.path.cmp(&b.path));
2189 events.dedup_by(|a, b| a.path.starts_with(&b.path));
2190
2191 let root_char_bag;
2192 let root_abs_path;
2193 let next_entry_id;
2194 {
2195 let snapshot = self.snapshot.lock();
2196 root_char_bag = snapshot.root_char_bag;
2197 root_abs_path = snapshot.abs_path.clone();
2198 next_entry_id = snapshot.next_entry_id.clone();
2199 }
2200
2201 let root_abs_path = if let Ok(abs_path) = self.fs.canonicalize(&root_abs_path).await {
2202 abs_path
2203 } else {
2204 return false;
2205 };
2206 let metadata = futures::future::join_all(
2207 events
2208 .iter()
2209 .map(|event| self.fs.metadata(&event.path))
2210 .collect::<Vec<_>>(),
2211 )
2212 .await;
2213
2214 // Hold the snapshot lock while clearing and re-inserting the root entries
2215 // for each event. This way, the snapshot is not observable to the foreground
2216 // thread while this operation is in-progress.
2217 let (scan_queue_tx, scan_queue_rx) = channel::unbounded();
2218 {
2219 let mut snapshot = self.snapshot.lock();
2220 snapshot.scan_id += 1;
2221 for event in &events {
2222 if let Ok(path) = event.path.strip_prefix(&root_abs_path) {
2223 snapshot.remove_path(&path);
2224 }
2225 }
2226
2227 for (event, metadata) in events.into_iter().zip(metadata.into_iter()) {
2228 let path: Arc<Path> = match event.path.strip_prefix(&root_abs_path) {
2229 Ok(path) => Arc::from(path.to_path_buf()),
2230 Err(_) => {
2231 log::error!(
2232 "unexpected event {:?} for root path {:?}",
2233 event.path,
2234 root_abs_path
2235 );
2236 continue;
2237 }
2238 };
2239
2240 match metadata {
2241 Ok(Some(metadata)) => {
2242 let ignore_stack = snapshot.ignore_stack_for_path(&path, metadata.is_dir);
2243 let mut fs_entry = Entry::new(
2244 path.clone(),
2245 &metadata,
2246 snapshot.next_entry_id.as_ref(),
2247 snapshot.root_char_bag,
2248 );
2249 fs_entry.is_ignored = ignore_stack.is_all();
2250 snapshot.insert_entry(fs_entry, self.fs.as_ref());
2251 if metadata.is_dir {
2252 self.executor
2253 .block(scan_queue_tx.send(ScanJob {
2254 abs_path: event.path,
2255 path,
2256 ignore_stack,
2257 scan_queue: scan_queue_tx.clone(),
2258 }))
2259 .unwrap();
2260 }
2261 }
2262 Ok(None) => {}
2263 Err(err) => {
2264 // TODO - create a special 'error' entry in the entries tree to mark this
2265 log::error!("error reading file on event {:?}", err);
2266 }
2267 }
2268 }
2269 drop(scan_queue_tx);
2270 }
2271
2272 // Scan any directories that were created as part of this event batch.
2273 self.executor
2274 .scoped(|scope| {
2275 for _ in 0..self.executor.num_cpus() {
2276 scope.spawn(async {
2277 while let Ok(job) = scan_queue_rx.recv().await {
2278 if let Err(err) = self
2279 .scan_dir(root_char_bag, next_entry_id.clone(), &job)
2280 .await
2281 {
2282 log::error!("error scanning {:?}: {}", job.abs_path, err);
2283 }
2284 }
2285 });
2286 }
2287 })
2288 .await;
2289
2290 // Attempt to detect renames only over a single batch of file-system events.
2291 self.snapshot.lock().removed_entry_ids.clear();
2292
2293 self.update_ignore_statuses().await;
2294 true
2295 }
2296
2297 async fn update_ignore_statuses(&self) {
2298 let mut snapshot = self.snapshot();
2299
2300 let mut ignores_to_update = Vec::new();
2301 let mut ignores_to_delete = Vec::new();
2302 for (parent_path, (_, scan_id)) in &snapshot.ignores {
2303 if *scan_id == snapshot.scan_id && snapshot.entry_for_path(parent_path).is_some() {
2304 ignores_to_update.push(parent_path.clone());
2305 }
2306
2307 let ignore_path = parent_path.join(&*GITIGNORE);
2308 if snapshot.entry_for_path(ignore_path).is_none() {
2309 ignores_to_delete.push(parent_path.clone());
2310 }
2311 }
2312
2313 for parent_path in ignores_to_delete {
2314 snapshot.ignores.remove(&parent_path);
2315 self.snapshot.lock().ignores.remove(&parent_path);
2316 }
2317
2318 let (ignore_queue_tx, ignore_queue_rx) = channel::unbounded();
2319 ignores_to_update.sort_unstable();
2320 let mut ignores_to_update = ignores_to_update.into_iter().peekable();
2321 while let Some(parent_path) = ignores_to_update.next() {
2322 while ignores_to_update
2323 .peek()
2324 .map_or(false, |p| p.starts_with(&parent_path))
2325 {
2326 ignores_to_update.next().unwrap();
2327 }
2328
2329 let ignore_stack = snapshot.ignore_stack_for_path(&parent_path, true);
2330 ignore_queue_tx
2331 .send(UpdateIgnoreStatusJob {
2332 path: parent_path,
2333 ignore_stack,
2334 ignore_queue: ignore_queue_tx.clone(),
2335 })
2336 .await
2337 .unwrap();
2338 }
2339 drop(ignore_queue_tx);
2340
2341 self.executor
2342 .scoped(|scope| {
2343 for _ in 0..self.executor.num_cpus() {
2344 scope.spawn(async {
2345 while let Ok(job) = ignore_queue_rx.recv().await {
2346 self.update_ignore_status(job, &snapshot).await;
2347 }
2348 });
2349 }
2350 })
2351 .await;
2352 }
2353
2354 async fn update_ignore_status(&self, job: UpdateIgnoreStatusJob, snapshot: &LocalSnapshot) {
2355 let mut ignore_stack = job.ignore_stack;
2356 if let Some((ignore, _)) = snapshot.ignores.get(&job.path) {
2357 ignore_stack = ignore_stack.append(job.path.clone(), ignore.clone());
2358 }
2359
2360 let mut entries_by_id_edits = Vec::new();
2361 let mut entries_by_path_edits = Vec::new();
2362 for mut entry in snapshot.child_entries(&job.path).cloned() {
2363 let was_ignored = entry.is_ignored;
2364 entry.is_ignored = ignore_stack.is_path_ignored(&entry.path, entry.is_dir());
2365 if entry.is_dir() {
2366 let child_ignore_stack = if entry.is_ignored {
2367 IgnoreStack::all()
2368 } else {
2369 ignore_stack.clone()
2370 };
2371 job.ignore_queue
2372 .send(UpdateIgnoreStatusJob {
2373 path: entry.path.clone(),
2374 ignore_stack: child_ignore_stack,
2375 ignore_queue: job.ignore_queue.clone(),
2376 })
2377 .await
2378 .unwrap();
2379 }
2380
2381 if entry.is_ignored != was_ignored {
2382 let mut path_entry = snapshot.entries_by_id.get(&entry.id, &()).unwrap().clone();
2383 path_entry.scan_id = snapshot.scan_id;
2384 path_entry.is_ignored = entry.is_ignored;
2385 entries_by_id_edits.push(Edit::Insert(path_entry));
2386 entries_by_path_edits.push(Edit::Insert(entry));
2387 }
2388 }
2389
2390 let mut snapshot = self.snapshot.lock();
2391 snapshot.entries_by_path.edit(entries_by_path_edits, &());
2392 snapshot.entries_by_id.edit(entries_by_id_edits, &());
2393 }
2394}
2395
2396fn char_bag_for_path(root_char_bag: CharBag, path: &Path) -> CharBag {
2397 let mut result = root_char_bag;
2398 result.extend(
2399 path.to_string_lossy()
2400 .chars()
2401 .map(|c| c.to_ascii_lowercase()),
2402 );
2403 result
2404}
2405
2406struct ScanJob {
2407 abs_path: PathBuf,
2408 path: Arc<Path>,
2409 ignore_stack: Arc<IgnoreStack>,
2410 scan_queue: Sender<ScanJob>,
2411}
2412
2413struct UpdateIgnoreStatusJob {
2414 path: Arc<Path>,
2415 ignore_stack: Arc<IgnoreStack>,
2416 ignore_queue: Sender<UpdateIgnoreStatusJob>,
2417}
2418
2419pub trait WorktreeHandle {
2420 #[cfg(any(test, feature = "test-support"))]
2421 fn flush_fs_events<'a>(
2422 &self,
2423 cx: &'a gpui::TestAppContext,
2424 ) -> futures::future::LocalBoxFuture<'a, ()>;
2425}
2426
2427impl WorktreeHandle for ModelHandle<Worktree> {
2428 // When the worktree's FS event stream sometimes delivers "redundant" events for FS changes that
2429 // occurred before the worktree was constructed. These events can cause the worktree to perfrom
2430 // extra directory scans, and emit extra scan-state notifications.
2431 //
2432 // This function mutates the worktree's directory and waits for those mutations to be picked up,
2433 // to ensure that all redundant FS events have already been processed.
2434 #[cfg(any(test, feature = "test-support"))]
2435 fn flush_fs_events<'a>(
2436 &self,
2437 cx: &'a gpui::TestAppContext,
2438 ) -> futures::future::LocalBoxFuture<'a, ()> {
2439 use smol::future::FutureExt;
2440
2441 let filename = "fs-event-sentinel";
2442 let tree = self.clone();
2443 let (fs, root_path) = self.read_with(cx, |tree, _| {
2444 let tree = tree.as_local().unwrap();
2445 (tree.fs.clone(), tree.abs_path().clone())
2446 });
2447
2448 async move {
2449 fs.create_file(&root_path.join(filename), Default::default())
2450 .await
2451 .unwrap();
2452 tree.condition(&cx, |tree, _| tree.entry_for_path(filename).is_some())
2453 .await;
2454
2455 fs.remove_file(&root_path.join(filename), Default::default())
2456 .await
2457 .unwrap();
2458 tree.condition(&cx, |tree, _| tree.entry_for_path(filename).is_none())
2459 .await;
2460
2461 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
2462 .await;
2463 }
2464 .boxed_local()
2465 }
2466}
2467
2468#[derive(Clone, Debug)]
2469struct TraversalProgress<'a> {
2470 max_path: &'a Path,
2471 count: usize,
2472 visible_count: usize,
2473 file_count: usize,
2474 visible_file_count: usize,
2475}
2476
2477impl<'a> TraversalProgress<'a> {
2478 fn count(&self, include_dirs: bool, include_ignored: bool) -> usize {
2479 match (include_ignored, include_dirs) {
2480 (true, true) => self.count,
2481 (true, false) => self.file_count,
2482 (false, true) => self.visible_count,
2483 (false, false) => self.visible_file_count,
2484 }
2485 }
2486}
2487
2488impl<'a> sum_tree::Dimension<'a, EntrySummary> for TraversalProgress<'a> {
2489 fn add_summary(&mut self, summary: &'a EntrySummary, _: &()) {
2490 self.max_path = summary.max_path.as_ref();
2491 self.count += summary.count;
2492 self.visible_count += summary.visible_count;
2493 self.file_count += summary.file_count;
2494 self.visible_file_count += summary.visible_file_count;
2495 }
2496}
2497
2498impl<'a> Default for TraversalProgress<'a> {
2499 fn default() -> Self {
2500 Self {
2501 max_path: Path::new(""),
2502 count: 0,
2503 visible_count: 0,
2504 file_count: 0,
2505 visible_file_count: 0,
2506 }
2507 }
2508}
2509
2510pub struct Traversal<'a> {
2511 cursor: sum_tree::Cursor<'a, Entry, TraversalProgress<'a>>,
2512 include_ignored: bool,
2513 include_dirs: bool,
2514}
2515
2516impl<'a> Traversal<'a> {
2517 pub fn advance(&mut self) -> bool {
2518 self.advance_to_offset(self.offset() + 1)
2519 }
2520
2521 pub fn advance_to_offset(&mut self, offset: usize) -> bool {
2522 self.cursor.seek_forward(
2523 &TraversalTarget::Count {
2524 count: offset,
2525 include_dirs: self.include_dirs,
2526 include_ignored: self.include_ignored,
2527 },
2528 Bias::Right,
2529 &(),
2530 )
2531 }
2532
2533 pub fn advance_to_sibling(&mut self) -> bool {
2534 while let Some(entry) = self.cursor.item() {
2535 self.cursor.seek_forward(
2536 &TraversalTarget::PathSuccessor(&entry.path),
2537 Bias::Left,
2538 &(),
2539 );
2540 if let Some(entry) = self.cursor.item() {
2541 if (self.include_dirs || !entry.is_dir())
2542 && (self.include_ignored || !entry.is_ignored)
2543 {
2544 return true;
2545 }
2546 }
2547 }
2548 false
2549 }
2550
2551 pub fn entry(&self) -> Option<&'a Entry> {
2552 self.cursor.item()
2553 }
2554
2555 pub fn offset(&self) -> usize {
2556 self.cursor
2557 .start()
2558 .count(self.include_dirs, self.include_ignored)
2559 }
2560}
2561
2562impl<'a> Iterator for Traversal<'a> {
2563 type Item = &'a Entry;
2564
2565 fn next(&mut self) -> Option<Self::Item> {
2566 if let Some(item) = self.entry() {
2567 self.advance();
2568 Some(item)
2569 } else {
2570 None
2571 }
2572 }
2573}
2574
2575#[derive(Debug)]
2576enum TraversalTarget<'a> {
2577 Path(&'a Path),
2578 PathSuccessor(&'a Path),
2579 Count {
2580 count: usize,
2581 include_ignored: bool,
2582 include_dirs: bool,
2583 },
2584}
2585
2586impl<'a, 'b> SeekTarget<'a, EntrySummary, TraversalProgress<'a>> for TraversalTarget<'b> {
2587 fn cmp(&self, cursor_location: &TraversalProgress<'a>, _: &()) -> Ordering {
2588 match self {
2589 TraversalTarget::Path(path) => path.cmp(&cursor_location.max_path),
2590 TraversalTarget::PathSuccessor(path) => {
2591 if !cursor_location.max_path.starts_with(path) {
2592 Ordering::Equal
2593 } else {
2594 Ordering::Greater
2595 }
2596 }
2597 TraversalTarget::Count {
2598 count,
2599 include_dirs,
2600 include_ignored,
2601 } => Ord::cmp(
2602 count,
2603 &cursor_location.count(*include_dirs, *include_ignored),
2604 ),
2605 }
2606 }
2607}
2608
2609struct ChildEntriesIter<'a> {
2610 parent_path: &'a Path,
2611 traversal: Traversal<'a>,
2612}
2613
2614impl<'a> Iterator for ChildEntriesIter<'a> {
2615 type Item = &'a Entry;
2616
2617 fn next(&mut self) -> Option<Self::Item> {
2618 if let Some(item) = self.traversal.entry() {
2619 if item.path.starts_with(&self.parent_path) {
2620 self.traversal.advance_to_sibling();
2621 return Some(item);
2622 }
2623 }
2624 None
2625 }
2626}
2627
2628impl<'a> From<&'a Entry> for proto::Entry {
2629 fn from(entry: &'a Entry) -> Self {
2630 Self {
2631 id: entry.id.to_proto(),
2632 is_dir: entry.is_dir(),
2633 path: entry.path.as_os_str().as_bytes().to_vec(),
2634 inode: entry.inode,
2635 mtime: Some(entry.mtime.into()),
2636 is_symlink: entry.is_symlink,
2637 is_ignored: entry.is_ignored,
2638 }
2639 }
2640}
2641
2642impl<'a> TryFrom<(&'a CharBag, proto::Entry)> for Entry {
2643 type Error = anyhow::Error;
2644
2645 fn try_from((root_char_bag, entry): (&'a CharBag, proto::Entry)) -> Result<Self> {
2646 if let Some(mtime) = entry.mtime {
2647 let kind = if entry.is_dir {
2648 EntryKind::Dir
2649 } else {
2650 let mut char_bag = root_char_bag.clone();
2651 char_bag.extend(
2652 String::from_utf8_lossy(&entry.path)
2653 .chars()
2654 .map(|c| c.to_ascii_lowercase()),
2655 );
2656 EntryKind::File(char_bag)
2657 };
2658 let path: Arc<Path> = PathBuf::from(OsString::from_vec(entry.path)).into();
2659 Ok(Entry {
2660 id: ProjectEntryId::from_proto(entry.id),
2661 kind,
2662 path: path.clone(),
2663 inode: entry.inode,
2664 mtime: mtime.into(),
2665 is_symlink: entry.is_symlink,
2666 is_ignored: entry.is_ignored,
2667 })
2668 } else {
2669 Err(anyhow!(
2670 "missing mtime in remote worktree entry {:?}",
2671 entry.path
2672 ))
2673 }
2674 }
2675}
2676
2677async fn send_worktree_update(client: &Arc<Client>, update: proto::UpdateWorktree) -> Result<()> {
2678 #[cfg(any(test, feature = "test-support"))]
2679 const MAX_CHUNK_SIZE: usize = 2;
2680 #[cfg(not(any(test, feature = "test-support")))]
2681 const MAX_CHUNK_SIZE: usize = 256;
2682
2683 for update in proto::split_worktree_update(update, MAX_CHUNK_SIZE) {
2684 client.request(update).await?;
2685 }
2686
2687 Ok(())
2688}
2689
2690#[cfg(test)]
2691mod tests {
2692 use super::*;
2693 use crate::fs::FakeFs;
2694 use anyhow::Result;
2695 use client::test::FakeHttpClient;
2696 use fs::RealFs;
2697 use gpui::TestAppContext;
2698 use rand::prelude::*;
2699 use serde_json::json;
2700 use std::{
2701 env,
2702 fmt::Write,
2703 time::{SystemTime, UNIX_EPOCH},
2704 };
2705 use util::test::temp_tree;
2706
2707 #[gpui::test]
2708 async fn test_traversal(cx: &mut TestAppContext) {
2709 let fs = FakeFs::new(cx.background());
2710 fs.insert_tree(
2711 "/root",
2712 json!({
2713 ".gitignore": "a/b\n",
2714 "a": {
2715 "b": "",
2716 "c": "",
2717 }
2718 }),
2719 )
2720 .await;
2721
2722 let http_client = FakeHttpClient::with_404_response();
2723 let client = Client::new(http_client);
2724
2725 let tree = Worktree::local(
2726 client,
2727 Arc::from(Path::new("/root")),
2728 true,
2729 fs,
2730 Default::default(),
2731 &mut cx.to_async(),
2732 )
2733 .await
2734 .unwrap();
2735 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
2736 .await;
2737
2738 tree.read_with(cx, |tree, _| {
2739 assert_eq!(
2740 tree.entries(false)
2741 .map(|entry| entry.path.as_ref())
2742 .collect::<Vec<_>>(),
2743 vec![
2744 Path::new(""),
2745 Path::new(".gitignore"),
2746 Path::new("a"),
2747 Path::new("a/c"),
2748 ]
2749 );
2750 assert_eq!(
2751 tree.entries(true)
2752 .map(|entry| entry.path.as_ref())
2753 .collect::<Vec<_>>(),
2754 vec![
2755 Path::new(""),
2756 Path::new(".gitignore"),
2757 Path::new("a"),
2758 Path::new("a/b"),
2759 Path::new("a/c"),
2760 ]
2761 );
2762 })
2763 }
2764
2765 #[gpui::test]
2766 async fn test_rescan_with_gitignore(cx: &mut TestAppContext) {
2767 let dir = temp_tree(json!({
2768 ".git": {},
2769 ".gitignore": "ignored-dir\n",
2770 "tracked-dir": {
2771 "tracked-file1": "tracked contents",
2772 },
2773 "ignored-dir": {
2774 "ignored-file1": "ignored contents",
2775 }
2776 }));
2777
2778 let http_client = FakeHttpClient::with_404_response();
2779 let client = Client::new(http_client.clone());
2780
2781 let tree = Worktree::local(
2782 client,
2783 dir.path(),
2784 true,
2785 Arc::new(RealFs),
2786 Default::default(),
2787 &mut cx.to_async(),
2788 )
2789 .await
2790 .unwrap();
2791 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
2792 .await;
2793 tree.flush_fs_events(&cx).await;
2794 cx.read(|cx| {
2795 let tree = tree.read(cx);
2796 let tracked = tree.entry_for_path("tracked-dir/tracked-file1").unwrap();
2797 let ignored = tree.entry_for_path("ignored-dir/ignored-file1").unwrap();
2798 assert_eq!(tracked.is_ignored, false);
2799 assert_eq!(ignored.is_ignored, true);
2800 });
2801
2802 std::fs::write(dir.path().join("tracked-dir/tracked-file2"), "").unwrap();
2803 std::fs::write(dir.path().join("ignored-dir/ignored-file2"), "").unwrap();
2804 tree.flush_fs_events(&cx).await;
2805 cx.read(|cx| {
2806 let tree = tree.read(cx);
2807 let dot_git = tree.entry_for_path(".git").unwrap();
2808 let tracked = tree.entry_for_path("tracked-dir/tracked-file2").unwrap();
2809 let ignored = tree.entry_for_path("ignored-dir/ignored-file2").unwrap();
2810 assert_eq!(tracked.is_ignored, false);
2811 assert_eq!(ignored.is_ignored, true);
2812 assert_eq!(dot_git.is_ignored, true);
2813 });
2814 }
2815
2816 #[gpui::test]
2817 async fn test_write_file(cx: &mut TestAppContext) {
2818 let dir = temp_tree(json!({
2819 ".git": {},
2820 ".gitignore": "ignored-dir\n",
2821 "tracked-dir": {},
2822 "ignored-dir": {}
2823 }));
2824
2825 let http_client = FakeHttpClient::with_404_response();
2826 let client = Client::new(http_client.clone());
2827
2828 let tree = Worktree::local(
2829 client,
2830 dir.path(),
2831 true,
2832 Arc::new(RealFs),
2833 Default::default(),
2834 &mut cx.to_async(),
2835 )
2836 .await
2837 .unwrap();
2838 cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
2839 .await;
2840 tree.flush_fs_events(&cx).await;
2841
2842 tree.update(cx, |tree, cx| {
2843 tree.as_local().unwrap().write_file(
2844 Path::new("tracked-dir/file.txt"),
2845 "hello".into(),
2846 Default::default(),
2847 cx,
2848 )
2849 })
2850 .await
2851 .unwrap();
2852 tree.update(cx, |tree, cx| {
2853 tree.as_local().unwrap().write_file(
2854 Path::new("ignored-dir/file.txt"),
2855 "world".into(),
2856 Default::default(),
2857 cx,
2858 )
2859 })
2860 .await
2861 .unwrap();
2862
2863 tree.read_with(cx, |tree, _| {
2864 let tracked = tree.entry_for_path("tracked-dir/file.txt").unwrap();
2865 let ignored = tree.entry_for_path("ignored-dir/file.txt").unwrap();
2866 assert_eq!(tracked.is_ignored, false);
2867 assert_eq!(ignored.is_ignored, true);
2868 });
2869 }
2870
2871 #[gpui::test(iterations = 100)]
2872 fn test_random(mut rng: StdRng) {
2873 let operations = env::var("OPERATIONS")
2874 .map(|o| o.parse().unwrap())
2875 .unwrap_or(40);
2876 let initial_entries = env::var("INITIAL_ENTRIES")
2877 .map(|o| o.parse().unwrap())
2878 .unwrap_or(20);
2879
2880 let root_dir = tempdir::TempDir::new("worktree-test").unwrap();
2881 for _ in 0..initial_entries {
2882 randomly_mutate_tree(root_dir.path(), 1.0, &mut rng).unwrap();
2883 }
2884 log::info!("Generated initial tree");
2885
2886 let (notify_tx, _notify_rx) = mpsc::unbounded();
2887 let fs = Arc::new(RealFs);
2888 let next_entry_id = Arc::new(AtomicUsize::new(0));
2889 let mut initial_snapshot = LocalSnapshot {
2890 abs_path: root_dir.path().into(),
2891 removed_entry_ids: Default::default(),
2892 ignores: Default::default(),
2893 next_entry_id: next_entry_id.clone(),
2894 snapshot: Snapshot {
2895 id: WorktreeId::from_usize(0),
2896 entries_by_path: Default::default(),
2897 entries_by_id: Default::default(),
2898 root_name: Default::default(),
2899 root_char_bag: Default::default(),
2900 scan_id: 0,
2901 is_complete: true,
2902 },
2903 extension_counts: Default::default(),
2904 };
2905 initial_snapshot.insert_entry(
2906 Entry::new(
2907 Path::new("").into(),
2908 &smol::block_on(fs.metadata(root_dir.path()))
2909 .unwrap()
2910 .unwrap(),
2911 &next_entry_id,
2912 Default::default(),
2913 ),
2914 fs.as_ref(),
2915 );
2916 let mut scanner = BackgroundScanner::new(
2917 Arc::new(Mutex::new(initial_snapshot.clone())),
2918 notify_tx,
2919 fs.clone(),
2920 Arc::new(gpui::executor::Background::new()),
2921 );
2922 smol::block_on(scanner.scan_dirs()).unwrap();
2923 scanner.snapshot().check_invariants();
2924
2925 let mut events = Vec::new();
2926 let mut snapshots = Vec::new();
2927 let mut mutations_len = operations;
2928 while mutations_len > 1 {
2929 if !events.is_empty() && rng.gen_bool(0.4) {
2930 let len = rng.gen_range(0..=events.len());
2931 let to_deliver = events.drain(0..len).collect::<Vec<_>>();
2932 log::info!("Delivering events: {:#?}", to_deliver);
2933 smol::block_on(scanner.process_events(to_deliver));
2934 scanner.snapshot().check_invariants();
2935 } else {
2936 events.extend(randomly_mutate_tree(root_dir.path(), 0.6, &mut rng).unwrap());
2937 mutations_len -= 1;
2938 }
2939
2940 if rng.gen_bool(0.2) {
2941 snapshots.push(scanner.snapshot());
2942 }
2943 }
2944 log::info!("Quiescing: {:#?}", events);
2945 smol::block_on(scanner.process_events(events));
2946 scanner.snapshot().check_invariants();
2947
2948 let (notify_tx, _notify_rx) = mpsc::unbounded();
2949 let mut new_scanner = BackgroundScanner::new(
2950 Arc::new(Mutex::new(initial_snapshot)),
2951 notify_tx,
2952 scanner.fs.clone(),
2953 scanner.executor.clone(),
2954 );
2955 smol::block_on(new_scanner.scan_dirs()).unwrap();
2956 assert_eq!(
2957 scanner.snapshot().to_vec(true),
2958 new_scanner.snapshot().to_vec(true)
2959 );
2960
2961 for mut prev_snapshot in snapshots {
2962 let include_ignored = rng.gen::<bool>();
2963 if !include_ignored {
2964 let mut entries_by_path_edits = Vec::new();
2965 let mut entries_by_id_edits = Vec::new();
2966 for entry in prev_snapshot
2967 .entries_by_id
2968 .cursor::<()>()
2969 .filter(|e| e.is_ignored)
2970 {
2971 entries_by_path_edits.push(Edit::Remove(PathKey(entry.path.clone())));
2972 entries_by_id_edits.push(Edit::Remove(entry.id));
2973 }
2974
2975 prev_snapshot
2976 .entries_by_path
2977 .edit(entries_by_path_edits, &());
2978 prev_snapshot.entries_by_id.edit(entries_by_id_edits, &());
2979 }
2980
2981 let update = scanner
2982 .snapshot()
2983 .build_update(&prev_snapshot, 0, 0, include_ignored);
2984 prev_snapshot.apply_remote_update(update).unwrap();
2985 assert_eq!(
2986 prev_snapshot.to_vec(true),
2987 scanner.snapshot().to_vec(include_ignored)
2988 );
2989 }
2990 }
2991
2992 fn randomly_mutate_tree(
2993 root_path: &Path,
2994 insertion_probability: f64,
2995 rng: &mut impl Rng,
2996 ) -> Result<Vec<fsevent::Event>> {
2997 let root_path = root_path.canonicalize().unwrap();
2998 let (dirs, files) = read_dir_recursive(root_path.clone());
2999
3000 let mut events = Vec::new();
3001 let mut record_event = |path: PathBuf| {
3002 events.push(fsevent::Event {
3003 event_id: SystemTime::now()
3004 .duration_since(UNIX_EPOCH)
3005 .unwrap()
3006 .as_secs(),
3007 flags: fsevent::StreamFlags::empty(),
3008 path,
3009 });
3010 };
3011
3012 if (files.is_empty() && dirs.len() == 1) || rng.gen_bool(insertion_probability) {
3013 let path = dirs.choose(rng).unwrap();
3014 let new_path = path.join(gen_name(rng));
3015
3016 if rng.gen() {
3017 log::info!("Creating dir {:?}", new_path.strip_prefix(root_path)?);
3018 std::fs::create_dir(&new_path)?;
3019 } else {
3020 log::info!("Creating file {:?}", new_path.strip_prefix(root_path)?);
3021 std::fs::write(&new_path, "")?;
3022 }
3023 record_event(new_path);
3024 } else if rng.gen_bool(0.05) {
3025 let ignore_dir_path = dirs.choose(rng).unwrap();
3026 let ignore_path = ignore_dir_path.join(&*GITIGNORE);
3027
3028 let (subdirs, subfiles) = read_dir_recursive(ignore_dir_path.clone());
3029 let files_to_ignore = {
3030 let len = rng.gen_range(0..=subfiles.len());
3031 subfiles.choose_multiple(rng, len)
3032 };
3033 let dirs_to_ignore = {
3034 let len = rng.gen_range(0..subdirs.len());
3035 subdirs.choose_multiple(rng, len)
3036 };
3037
3038 let mut ignore_contents = String::new();
3039 for path_to_ignore in files_to_ignore.chain(dirs_to_ignore) {
3040 write!(
3041 ignore_contents,
3042 "{}\n",
3043 path_to_ignore
3044 .strip_prefix(&ignore_dir_path)?
3045 .to_str()
3046 .unwrap()
3047 )
3048 .unwrap();
3049 }
3050 log::info!(
3051 "Creating {:?} with contents:\n{}",
3052 ignore_path.strip_prefix(&root_path)?,
3053 ignore_contents
3054 );
3055 std::fs::write(&ignore_path, ignore_contents).unwrap();
3056 record_event(ignore_path);
3057 } else {
3058 let old_path = {
3059 let file_path = files.choose(rng);
3060 let dir_path = dirs[1..].choose(rng);
3061 file_path.into_iter().chain(dir_path).choose(rng).unwrap()
3062 };
3063
3064 let is_rename = rng.gen();
3065 if is_rename {
3066 let new_path_parent = dirs
3067 .iter()
3068 .filter(|d| !d.starts_with(old_path))
3069 .choose(rng)
3070 .unwrap();
3071
3072 let overwrite_existing_dir =
3073 !old_path.starts_with(&new_path_parent) && rng.gen_bool(0.3);
3074 let new_path = if overwrite_existing_dir {
3075 std::fs::remove_dir_all(&new_path_parent).ok();
3076 new_path_parent.to_path_buf()
3077 } else {
3078 new_path_parent.join(gen_name(rng))
3079 };
3080
3081 log::info!(
3082 "Renaming {:?} to {}{:?}",
3083 old_path.strip_prefix(&root_path)?,
3084 if overwrite_existing_dir {
3085 "overwrite "
3086 } else {
3087 ""
3088 },
3089 new_path.strip_prefix(&root_path)?
3090 );
3091 std::fs::rename(&old_path, &new_path)?;
3092 record_event(old_path.clone());
3093 record_event(new_path);
3094 } else if old_path.is_dir() {
3095 let (dirs, files) = read_dir_recursive(old_path.clone());
3096
3097 log::info!("Deleting dir {:?}", old_path.strip_prefix(&root_path)?);
3098 std::fs::remove_dir_all(&old_path).unwrap();
3099 for file in files {
3100 record_event(file);
3101 }
3102 for dir in dirs {
3103 record_event(dir);
3104 }
3105 } else {
3106 log::info!("Deleting file {:?}", old_path.strip_prefix(&root_path)?);
3107 std::fs::remove_file(old_path).unwrap();
3108 record_event(old_path.clone());
3109 }
3110 }
3111
3112 Ok(events)
3113 }
3114
3115 fn read_dir_recursive(path: PathBuf) -> (Vec<PathBuf>, Vec<PathBuf>) {
3116 let child_entries = std::fs::read_dir(&path).unwrap();
3117 let mut dirs = vec![path];
3118 let mut files = Vec::new();
3119 for child_entry in child_entries {
3120 let child_path = child_entry.unwrap().path();
3121 if child_path.is_dir() {
3122 let (child_dirs, child_files) = read_dir_recursive(child_path);
3123 dirs.extend(child_dirs);
3124 files.extend(child_files);
3125 } else {
3126 files.push(child_path);
3127 }
3128 }
3129 (dirs, files)
3130 }
3131
3132 fn gen_name(rng: &mut impl Rng) -> String {
3133 (0..6)
3134 .map(|_| rng.sample(rand::distributions::Alphanumeric))
3135 .map(char::from)
3136 .collect()
3137 }
3138
3139 impl LocalSnapshot {
3140 fn check_invariants(&self) {
3141 let mut files = self.files(true, 0);
3142 let mut visible_files = self.files(false, 0);
3143 for entry in self.entries_by_path.cursor::<()>() {
3144 if entry.is_file() {
3145 assert_eq!(files.next().unwrap().inode, entry.inode);
3146 if !entry.is_ignored {
3147 assert_eq!(visible_files.next().unwrap().inode, entry.inode);
3148 }
3149 }
3150 }
3151 assert!(files.next().is_none());
3152 assert!(visible_files.next().is_none());
3153
3154 let mut bfs_paths = Vec::new();
3155 let mut stack = vec![Path::new("")];
3156 while let Some(path) = stack.pop() {
3157 bfs_paths.push(path);
3158 let ix = stack.len();
3159 for child_entry in self.child_entries(path) {
3160 stack.insert(ix, &child_entry.path);
3161 }
3162 }
3163
3164 let dfs_paths_via_iter = self
3165 .entries_by_path
3166 .cursor::<()>()
3167 .map(|e| e.path.as_ref())
3168 .collect::<Vec<_>>();
3169 assert_eq!(bfs_paths, dfs_paths_via_iter);
3170
3171 let dfs_paths_via_traversal = self
3172 .entries(true)
3173 .map(|e| e.path.as_ref())
3174 .collect::<Vec<_>>();
3175 assert_eq!(dfs_paths_via_traversal, dfs_paths_via_iter);
3176
3177 for (ignore_parent_path, _) in &self.ignores {
3178 assert!(self.entry_for_path(ignore_parent_path).is_some());
3179 assert!(self
3180 .entry_for_path(ignore_parent_path.join(&*GITIGNORE))
3181 .is_some());
3182 }
3183
3184 // Ensure extension counts are correct.
3185 let mut expected_extension_counts = HashMap::default();
3186 for extension in self.entries(false).filter_map(|e| e.path.extension()) {
3187 *expected_extension_counts
3188 .entry(extension.into())
3189 .or_insert(0) += 1;
3190 }
3191 assert_eq!(self.extension_counts, expected_extension_counts);
3192 }
3193
3194 fn to_vec(&self, include_ignored: bool) -> Vec<(&Path, u64, bool)> {
3195 let mut paths = Vec::new();
3196 for entry in self.entries_by_path.cursor::<()>() {
3197 if include_ignored || !entry.is_ignored {
3198 paths.push((entry.path.as_ref(), entry.inode, entry.is_ignored));
3199 }
3200 }
3201 paths.sort_by(|a, b| a.0.cmp(&b.0));
3202 paths
3203 }
3204 }
3205}