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