use super::{ignore::IgnoreStack, DiagnosticSummary}; use crate::{copy_recursive, ProjectEntryId, RemoveOptions}; use ::ignore::gitignore::{Gitignore, GitignoreBuilder}; use anyhow::{anyhow, Context, Result}; use client::{proto, Client}; use clock::ReplicaId; use collections::{HashMap, VecDeque}; use fs::LineEnding; use fs::{repository::GitRepository, Fs}; use futures::{ channel::{ mpsc::{self, UnboundedSender}, oneshot, }, Stream, StreamExt, }; use fuzzy::CharBag; use git::{DOT_GIT, GITIGNORE}; use gpui::{ executor, AppContext, AsyncAppContext, Entity, ModelContext, ModelHandle, MutableAppContext, Task, }; use language::{ proto::{deserialize_version, serialize_line_ending, serialize_version}, Buffer, DiagnosticEntry, Rope, }; use parking_lot::Mutex; use postage::{ prelude::{Sink as _, Stream as _}, watch, }; use rope::point_utf16::PointUtf16; use smol::channel::{self, Sender}; use std::{ any::Any, cmp::{self, Ordering}, convert::TryFrom, ffi::{OsStr, OsString}, fmt, future::Future, mem, ops::{Deref, DerefMut}, os::unix::prelude::{OsStrExt, OsStringExt}, path::{Path, PathBuf}, sync::{atomic::AtomicUsize, Arc}, task::Poll, time::{Duration, SystemTime}, }; use sum_tree::{Bias, Edit, SeekTarget, SumTree, TreeMap, TreeSet}; use util::{ResultExt, TryFutureExt}; #[derive(Copy, Clone, PartialEq, Eq, Debug, Hash, PartialOrd, Ord)] pub struct WorktreeId(usize); #[allow(clippy::large_enum_variant)] pub enum Worktree { Local(LocalWorktree), Remote(RemoteWorktree), } pub struct LocalWorktree { snapshot: LocalSnapshot, background_snapshot: Arc>, last_scan_state_rx: watch::Receiver, _background_scanner_task: Option>, poll_task: Option>, share: Option, diagnostics: HashMap, Vec>>, diagnostic_summaries: TreeMap, client: Arc, fs: Arc, visible: bool, } pub struct RemoteWorktree { pub snapshot: Snapshot, pub(crate) background_snapshot: Arc>, project_id: u64, client: Arc, updates_tx: Option>, snapshot_subscriptions: VecDeque<(usize, oneshot::Sender<()>)>, replica_id: ReplicaId, diagnostic_summaries: TreeMap, visible: bool, } #[derive(Clone)] pub struct Snapshot { id: WorktreeId, root_name: String, root_char_bag: CharBag, entries_by_path: SumTree, entries_by_id: SumTree, scan_id: usize, is_complete: bool, } #[derive(Clone)] pub struct GitRepositoryEntry { pub(crate) repo: Arc>, pub(crate) scan_id: usize, // Path to folder containing the .git file or directory pub(crate) content_path: Arc, // Path to the actual .git folder. // Note: if .git is a file, this points to the folder indicated by the .git file pub(crate) git_dir_path: Arc, } impl std::fmt::Debug for GitRepositoryEntry { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { f.debug_struct("GitRepositoryEntry") .field("content_path", &self.content_path) .field("git_dir_path", &self.git_dir_path) .field("libgit_repository", &"LibGitRepository") .finish() } } pub struct LocalSnapshot { abs_path: Arc, ignores_by_parent_abs_path: HashMap, (Arc, usize)>, git_repositories: Vec, removed_entry_ids: HashMap, next_entry_id: Arc, snapshot: Snapshot, extension_counts: HashMap, } impl Clone for LocalSnapshot { fn clone(&self) -> Self { Self { abs_path: self.abs_path.clone(), ignores_by_parent_abs_path: self.ignores_by_parent_abs_path.clone(), git_repositories: self.git_repositories.iter().cloned().collect(), removed_entry_ids: self.removed_entry_ids.clone(), next_entry_id: self.next_entry_id.clone(), snapshot: self.snapshot.clone(), extension_counts: self.extension_counts.clone(), } } } impl Deref for LocalSnapshot { type Target = Snapshot; fn deref(&self) -> &Self::Target { &self.snapshot } } impl DerefMut for LocalSnapshot { fn deref_mut(&mut self) -> &mut Self::Target { &mut self.snapshot } } #[derive(Clone, Debug)] enum ScanState { Idle, /// The worktree is performing its initial scan of the filesystem. Initializing, /// The worktree is updating in response to filesystem events. Updating, Err(Arc), } struct ShareState { project_id: u64, snapshots_tx: watch::Sender, _maintain_remote_snapshot: Option>>, } pub enum Event { UpdatedEntries, UpdatedGitRepositories(Vec), } impl Entity for Worktree { type Event = Event; } impl Worktree { pub async fn local( client: Arc, path: impl Into>, visible: bool, fs: Arc, next_entry_id: Arc, cx: &mut AsyncAppContext, ) -> Result> { let (tree, scan_states_tx) = LocalWorktree::create(client, path, visible, fs.clone(), next_entry_id, cx).await?; tree.update(cx, |tree, cx| { let tree = tree.as_local_mut().unwrap(); let abs_path = tree.abs_path().clone(); let background_snapshot = tree.background_snapshot.clone(); let background = cx.background().clone(); tree._background_scanner_task = Some(cx.background().spawn(async move { let events = fs.watch(&abs_path, Duration::from_millis(100)).await; let scanner = BackgroundScanner::new(background_snapshot, scan_states_tx, fs, background); scanner.run(events).await; })); }); Ok(tree) } pub fn remote( project_remote_id: u64, replica_id: ReplicaId, worktree: proto::WorktreeMetadata, client: Arc, cx: &mut MutableAppContext, ) -> ModelHandle { let remote_id = worktree.id; let root_char_bag: CharBag = worktree .root_name .chars() .map(|c| c.to_ascii_lowercase()) .collect(); let root_name = worktree.root_name.clone(); let visible = worktree.visible; let snapshot = Snapshot { id: WorktreeId(remote_id as usize), root_name, root_char_bag, entries_by_path: Default::default(), entries_by_id: Default::default(), scan_id: 0, is_complete: false, }; let (updates_tx, mut updates_rx) = mpsc::unbounded(); let background_snapshot = Arc::new(Mutex::new(snapshot.clone())); let (mut snapshot_updated_tx, mut snapshot_updated_rx) = watch::channel(); let worktree_handle = cx.add_model(|_: &mut ModelContext| { Worktree::Remote(RemoteWorktree { project_id: project_remote_id, replica_id, snapshot: snapshot.clone(), background_snapshot: background_snapshot.clone(), updates_tx: Some(updates_tx), snapshot_subscriptions: Default::default(), client: client.clone(), diagnostic_summaries: Default::default(), visible, }) }); cx.background() .spawn(async move { while let Some(update) = updates_rx.next().await { if let Err(error) = background_snapshot.lock().apply_remote_update(update) { log::error!("error applying worktree update: {}", error); } snapshot_updated_tx.send(()).await.ok(); } }) .detach(); cx.spawn(|mut cx| { let this = worktree_handle.downgrade(); async move { while (snapshot_updated_rx.recv().await).is_some() { if let Some(this) = this.upgrade(&cx) { this.update(&mut cx, |this, cx| { this.poll_snapshot(cx); let this = this.as_remote_mut().unwrap(); while let Some((scan_id, _)) = this.snapshot_subscriptions.front() { if this.observed_snapshot(*scan_id) { let (_, tx) = this.snapshot_subscriptions.pop_front().unwrap(); let _ = tx.send(()); } else { break; } } }); } else { break; } } } }) .detach(); worktree_handle } pub fn as_local(&self) -> Option<&LocalWorktree> { if let Worktree::Local(worktree) = self { Some(worktree) } else { None } } pub fn as_remote(&self) -> Option<&RemoteWorktree> { if let Worktree::Remote(worktree) = self { Some(worktree) } else { None } } pub fn as_local_mut(&mut self) -> Option<&mut LocalWorktree> { if let Worktree::Local(worktree) = self { Some(worktree) } else { None } } pub fn as_remote_mut(&mut self) -> Option<&mut RemoteWorktree> { if let Worktree::Remote(worktree) = self { Some(worktree) } else { None } } pub fn is_local(&self) -> bool { matches!(self, Worktree::Local(_)) } pub fn is_remote(&self) -> bool { !self.is_local() } pub fn snapshot(&self) -> Snapshot { match self { Worktree::Local(worktree) => worktree.snapshot().snapshot, Worktree::Remote(worktree) => worktree.snapshot(), } } pub fn scan_id(&self) -> usize { match self { Worktree::Local(worktree) => worktree.snapshot.scan_id, Worktree::Remote(worktree) => worktree.snapshot.scan_id, } } pub fn is_visible(&self) -> bool { match self { Worktree::Local(worktree) => worktree.visible, Worktree::Remote(worktree) => worktree.visible, } } pub fn replica_id(&self) -> ReplicaId { match self { Worktree::Local(_) => 0, Worktree::Remote(worktree) => worktree.replica_id, } } pub fn diagnostic_summaries( &self, ) -> impl Iterator, DiagnosticSummary)> + '_ { match self { Worktree::Local(worktree) => &worktree.diagnostic_summaries, Worktree::Remote(worktree) => &worktree.diagnostic_summaries, } .iter() .map(|(path, summary)| (path.0.clone(), *summary)) } fn poll_snapshot(&mut self, cx: &mut ModelContext) { match self { Self::Local(worktree) => worktree.poll_snapshot(false, cx), Self::Remote(worktree) => worktree.poll_snapshot(cx), }; } } impl LocalWorktree { async fn create( client: Arc, path: impl Into>, visible: bool, fs: Arc, next_entry_id: Arc, cx: &mut AsyncAppContext, ) -> Result<(ModelHandle, UnboundedSender)> { let abs_path = path.into(); let path: Arc = Arc::from(Path::new("")); // After determining whether the root entry is a file or a directory, populate the // snapshot's "root name", which will be used for the purpose of fuzzy matching. let root_name = abs_path .file_name() .map_or(String::new(), |f| f.to_string_lossy().to_string()); let root_char_bag = root_name.chars().map(|c| c.to_ascii_lowercase()).collect(); let metadata = fs .metadata(&abs_path) .await .context("failed to stat worktree path")?; let (scan_states_tx, mut scan_states_rx) = mpsc::unbounded(); let (mut last_scan_state_tx, last_scan_state_rx) = watch::channel_with(ScanState::Initializing); let tree = cx.add_model(move |cx: &mut ModelContext| { let mut snapshot = LocalSnapshot { abs_path, ignores_by_parent_abs_path: Default::default(), git_repositories: Default::default(), removed_entry_ids: Default::default(), next_entry_id, snapshot: Snapshot { id: WorktreeId::from_usize(cx.model_id()), root_name: root_name.clone(), root_char_bag, entries_by_path: Default::default(), entries_by_id: Default::default(), scan_id: 0, is_complete: true, }, extension_counts: Default::default(), }; if let Some(metadata) = metadata { let entry = Entry::new( path, &metadata, &snapshot.next_entry_id, snapshot.root_char_bag, ); snapshot.insert_entry(entry, fs.as_ref()); } let tree = Self { snapshot: snapshot.clone(), background_snapshot: Arc::new(Mutex::new(snapshot)), last_scan_state_rx, _background_scanner_task: None, share: None, poll_task: None, diagnostics: Default::default(), diagnostic_summaries: Default::default(), client, fs, visible, }; cx.spawn_weak(|this, mut cx| async move { while let Some(scan_state) = scan_states_rx.next().await { if let Some(this) = this.upgrade(&cx) { last_scan_state_tx.blocking_send(scan_state).ok(); this.update(&mut cx, |this, cx| this.poll_snapshot(cx)); } else { break; } } }) .detach(); Worktree::Local(tree) }); Ok((tree, scan_states_tx)) } pub fn contains_abs_path(&self, path: &Path) -> bool { path.starts_with(&self.abs_path) } fn absolutize(&self, path: &Path) -> PathBuf { if path.file_name().is_some() { self.abs_path.join(path) } else { self.abs_path.to_path_buf() } } pub(crate) fn load_buffer( &mut self, path: &Path, cx: &mut ModelContext, ) -> Task>> { let path = Arc::from(path); cx.spawn(move |this, mut cx| async move { let (file, contents, diff_base) = this .update(&mut cx, |t, cx| t.as_local().unwrap().load(&path, cx)) .await?; Ok(cx.add_model(|cx| { let mut buffer = Buffer::from_file(0, contents, diff_base, Arc::new(file), cx); buffer.git_diff_recalc(cx); buffer })) }) } pub fn diagnostics_for_path(&self, path: &Path) -> Option>> { self.diagnostics.get(path).cloned() } pub fn update_diagnostics( &mut self, language_server_id: usize, worktree_path: Arc, diagnostics: Vec>, _: &mut ModelContext, ) -> Result { self.diagnostics.remove(&worktree_path); let old_summary = self .diagnostic_summaries .remove(&PathKey(worktree_path.clone())) .unwrap_or_default(); let new_summary = DiagnosticSummary::new(language_server_id, &diagnostics); if !new_summary.is_empty() { self.diagnostic_summaries .insert(PathKey(worktree_path.clone()), new_summary); self.diagnostics.insert(worktree_path.clone(), diagnostics); } let updated = !old_summary.is_empty() || !new_summary.is_empty(); if updated { if let Some(share) = self.share.as_ref() { self.client .send(proto::UpdateDiagnosticSummary { project_id: share.project_id, worktree_id: self.id().to_proto(), summary: Some(proto::DiagnosticSummary { path: worktree_path.to_string_lossy().to_string(), language_server_id: language_server_id as u64, error_count: new_summary.error_count as u32, warning_count: new_summary.warning_count as u32, }), }) .log_err(); } } Ok(updated) } fn poll_snapshot(&mut self, force: bool, cx: &mut ModelContext) { self.poll_task.take(); match self.scan_state() { ScanState::Idle => { let new_snapshot = self.background_snapshot.lock().clone(); let updated_repos = Self::changed_repos( &self.snapshot.git_repositories, &new_snapshot.git_repositories, ); self.snapshot = new_snapshot; if let Some(share) = self.share.as_mut() { *share.snapshots_tx.borrow_mut() = self.snapshot.clone(); } cx.emit(Event::UpdatedEntries); if !updated_repos.is_empty() { cx.emit(Event::UpdatedGitRepositories(updated_repos)); } } ScanState::Initializing => { let is_fake_fs = self.fs.is_fake(); let new_snapshot = self.background_snapshot.lock().clone(); let updated_repos = Self::changed_repos( &self.snapshot.git_repositories, &new_snapshot.git_repositories, ); self.snapshot = new_snapshot; self.poll_task = Some(cx.spawn_weak(|this, mut cx| async move { if is_fake_fs { #[cfg(any(test, feature = "test-support"))] cx.background().simulate_random_delay().await; } else { smol::Timer::after(Duration::from_millis(100)).await; } if let Some(this) = this.upgrade(&cx) { this.update(&mut cx, |this, cx| this.poll_snapshot(cx)); } })); cx.emit(Event::UpdatedEntries); if !updated_repos.is_empty() { cx.emit(Event::UpdatedGitRepositories(updated_repos)); } } _ => { if force { self.snapshot = self.background_snapshot.lock().clone(); } } } cx.notify(); } fn changed_repos( old_repos: &[GitRepositoryEntry], new_repos: &[GitRepositoryEntry], ) -> Vec { fn diff<'a>( a: &'a [GitRepositoryEntry], b: &'a [GitRepositoryEntry], updated: &mut HashMap<&'a Path, GitRepositoryEntry>, ) { for a_repo in a { let matched = b.iter().find(|b_repo| { a_repo.git_dir_path == b_repo.git_dir_path && a_repo.scan_id == b_repo.scan_id }); if matched.is_none() { updated.insert(a_repo.git_dir_path.as_ref(), a_repo.clone()); } } } let mut updated = HashMap::<&Path, GitRepositoryEntry>::default(); diff(old_repos, new_repos, &mut updated); diff(new_repos, old_repos, &mut updated); updated.into_values().collect() } pub fn scan_complete(&self) -> impl Future { let mut scan_state_rx = self.last_scan_state_rx.clone(); async move { let mut scan_state = Some(scan_state_rx.borrow().clone()); while let Some(ScanState::Initializing | ScanState::Updating) = scan_state { scan_state = scan_state_rx.recv().await; } } } fn scan_state(&self) -> ScanState { self.last_scan_state_rx.borrow().clone() } pub fn snapshot(&self) -> LocalSnapshot { self.snapshot.clone() } pub fn metadata_proto(&self) -> proto::WorktreeMetadata { proto::WorktreeMetadata { id: self.id().to_proto(), root_name: self.root_name().to_string(), visible: self.visible, } } fn load( &self, path: &Path, cx: &mut ModelContext, ) -> Task)>> { let handle = cx.handle(); let path = Arc::from(path); let abs_path = self.absolutize(&path); let fs = self.fs.clone(); let snapshot = self.snapshot(); cx.spawn(|this, mut cx| async move { let text = fs.load(&abs_path).await?; let diff_base = if let Some(repo) = snapshot.repo_for(&path) { if let Ok(repo_relative) = path.strip_prefix(repo.content_path) { let repo_relative = repo_relative.to_owned(); cx.background() .spawn(async move { repo.repo.lock().load_index_text(&repo_relative) }) .await } else { None } } else { None }; // Eagerly populate the snapshot with an updated entry for the loaded file let entry = this .update(&mut cx, |this, cx| { this.as_local() .unwrap() .refresh_entry(path, abs_path, None, cx) }) .await?; Ok(( File { entry_id: Some(entry.id), worktree: handle, path: entry.path, mtime: entry.mtime, is_local: true, }, text, diff_base, )) }) } pub fn save_buffer_as( &self, buffer_handle: ModelHandle, path: impl Into>, cx: &mut ModelContext, ) -> Task> { let buffer = buffer_handle.read(cx); let text = buffer.as_rope().clone(); let fingerprint = text.fingerprint(); let version = buffer.version(); let save = self.write_file(path, text, buffer.line_ending(), cx); let handle = cx.handle(); cx.as_mut().spawn(|mut cx| async move { let entry = save.await?; let file = File { entry_id: Some(entry.id), worktree: handle, path: entry.path, mtime: entry.mtime, is_local: true, }; buffer_handle.update(&mut cx, |buffer, cx| { buffer.did_save(version, fingerprint, file.mtime, Some(Arc::new(file)), cx); }); Ok(()) }) } pub fn create_entry( &self, path: impl Into>, is_dir: bool, cx: &mut ModelContext, ) -> Task> { self.write_entry_internal( path, if is_dir { None } else { Some(Default::default()) }, cx, ) } pub fn write_file( &self, path: impl Into>, text: Rope, line_ending: LineEnding, cx: &mut ModelContext, ) -> Task> { self.write_entry_internal(path, Some((text, line_ending)), cx) } pub fn delete_entry( &self, entry_id: ProjectEntryId, cx: &mut ModelContext, ) -> Option>> { let entry = self.entry_for_id(entry_id)?.clone(); let abs_path = self.absolutize(&entry.path); let delete = cx.background().spawn({ let fs = self.fs.clone(); let abs_path = abs_path; async move { if entry.is_file() { fs.remove_file(&abs_path, Default::default()).await } else { fs.remove_dir( &abs_path, RemoveOptions { recursive: true, ignore_if_not_exists: false, }, ) .await } } }); Some(cx.spawn(|this, mut cx| async move { delete.await?; this.update(&mut cx, |this, cx| { let this = this.as_local_mut().unwrap(); { let mut snapshot = this.background_snapshot.lock(); snapshot.delete_entry(entry_id); } this.poll_snapshot(true, cx); }); Ok(()) })) } pub fn rename_entry( &self, entry_id: ProjectEntryId, new_path: impl Into>, cx: &mut ModelContext, ) -> Option>> { let old_path = self.entry_for_id(entry_id)?.path.clone(); let new_path = new_path.into(); let abs_old_path = self.absolutize(&old_path); let abs_new_path = self.absolutize(&new_path); let rename = cx.background().spawn({ let fs = self.fs.clone(); let abs_new_path = abs_new_path.clone(); async move { fs.rename(&abs_old_path, &abs_new_path, Default::default()) .await } }); Some(cx.spawn(|this, mut cx| async move { rename.await?; let entry = this .update(&mut cx, |this, cx| { this.as_local_mut().unwrap().refresh_entry( new_path.clone(), abs_new_path, Some(old_path), cx, ) }) .await?; Ok(entry) })) } pub fn copy_entry( &self, entry_id: ProjectEntryId, new_path: impl Into>, cx: &mut ModelContext, ) -> Option>> { let old_path = self.entry_for_id(entry_id)?.path.clone(); let new_path = new_path.into(); let abs_old_path = self.absolutize(&old_path); let abs_new_path = self.absolutize(&new_path); let copy = cx.background().spawn({ let fs = self.fs.clone(); let abs_new_path = abs_new_path.clone(); async move { copy_recursive( fs.as_ref(), &abs_old_path, &abs_new_path, Default::default(), ) .await } }); Some(cx.spawn(|this, mut cx| async move { copy.await?; let entry = this .update(&mut cx, |this, cx| { this.as_local_mut().unwrap().refresh_entry( new_path.clone(), abs_new_path, None, cx, ) }) .await?; Ok(entry) })) } fn write_entry_internal( &self, path: impl Into>, text_if_file: Option<(Rope, LineEnding)>, cx: &mut ModelContext, ) -> Task> { let path = path.into(); let abs_path = self.absolutize(&path); let write = cx.background().spawn({ let fs = self.fs.clone(); let abs_path = abs_path.clone(); async move { if let Some((text, line_ending)) = text_if_file { fs.save(&abs_path, &text, line_ending).await } else { fs.create_dir(&abs_path).await } } }); cx.spawn(|this, mut cx| async move { write.await?; let entry = this .update(&mut cx, |this, cx| { this.as_local_mut() .unwrap() .refresh_entry(path, abs_path, None, cx) }) .await?; Ok(entry) }) } fn refresh_entry( &self, path: Arc, abs_path: PathBuf, old_path: Option>, cx: &mut ModelContext, ) -> Task> { let fs = self.fs.clone(); let root_char_bag; let next_entry_id; { let snapshot = self.background_snapshot.lock(); root_char_bag = snapshot.root_char_bag; next_entry_id = snapshot.next_entry_id.clone(); } cx.spawn_weak(|this, mut cx| async move { let metadata = fs .metadata(&abs_path) .await? .ok_or_else(|| anyhow!("could not read saved file metadata"))?; let this = this .upgrade(&cx) .ok_or_else(|| anyhow!("worktree was dropped"))?; this.update(&mut cx, |this, cx| { let this = this.as_local_mut().unwrap(); let inserted_entry; { let mut snapshot = this.background_snapshot.lock(); let mut entry = Entry::new(path, &metadata, &next_entry_id, root_char_bag); entry.is_ignored = snapshot .ignore_stack_for_abs_path(&abs_path, entry.is_dir()) .is_abs_path_ignored(&abs_path, entry.is_dir()); if let Some(old_path) = old_path { snapshot.remove_path(&old_path); } inserted_entry = snapshot.insert_entry(entry, fs.as_ref()); snapshot.scan_id += 1; } this.poll_snapshot(true, cx); Ok(inserted_entry) }) }) } pub fn share(&mut self, project_id: u64, cx: &mut ModelContext) -> Task> { let (share_tx, share_rx) = oneshot::channel(); if self.share.is_some() { let _ = share_tx.send(Ok(())); } else { let (snapshots_tx, mut snapshots_rx) = watch::channel_with(self.snapshot()); let rpc = self.client.clone(); let worktree_id = cx.model_id() as u64; let maintain_remote_snapshot = cx.background().spawn({ let rpc = rpc; let diagnostic_summaries = self.diagnostic_summaries.clone(); async move { let mut prev_snapshot = match snapshots_rx.recv().await { Some(snapshot) => { let update = proto::UpdateWorktree { project_id, worktree_id, root_name: snapshot.root_name().to_string(), updated_entries: snapshot .entries_by_path .iter() .map(Into::into) .collect(), removed_entries: Default::default(), scan_id: snapshot.scan_id as u64, is_last_update: true, }; if let Err(error) = send_worktree_update(&rpc, update).await { let _ = share_tx.send(Err(error)); return Err(anyhow!("failed to send initial update worktree")); } else { let _ = share_tx.send(Ok(())); snapshot } } None => { share_tx .send(Err(anyhow!("worktree dropped before share completed"))) .ok(); return Err(anyhow!("failed to send initial update worktree")); } }; for (path, summary) in diagnostic_summaries.iter() { rpc.send(proto::UpdateDiagnosticSummary { project_id, worktree_id, summary: Some(summary.to_proto(&path.0)), })?; } while let Some(snapshot) = snapshots_rx.recv().await { send_worktree_update( &rpc, snapshot.build_update(&prev_snapshot, project_id, worktree_id, true), ) .await?; prev_snapshot = snapshot; } Ok::<_, anyhow::Error>(()) } .log_err() }); self.share = Some(ShareState { project_id, snapshots_tx, _maintain_remote_snapshot: Some(maintain_remote_snapshot), }); } cx.foreground().spawn(async move { share_rx .await .unwrap_or_else(|_| Err(anyhow!("share ended"))) }) } pub fn unshare(&mut self) { self.share.take(); } pub fn is_shared(&self) -> bool { self.share.is_some() } pub fn send_extension_counts(&self, project_id: u64) { let mut extensions = Vec::new(); let mut counts = Vec::new(); for (extension, count) in self.extension_counts() { extensions.push(extension.to_string_lossy().to_string()); counts.push(*count as u32); } self.client .send(proto::UpdateWorktreeExtensions { project_id, worktree_id: self.id().to_proto(), extensions, counts, }) .log_err(); } } impl RemoteWorktree { fn snapshot(&self) -> Snapshot { self.snapshot.clone() } fn poll_snapshot(&mut self, cx: &mut ModelContext) { self.snapshot = self.background_snapshot.lock().clone(); cx.emit(Event::UpdatedEntries); cx.notify(); } pub fn disconnected_from_host(&mut self) { self.updates_tx.take(); self.snapshot_subscriptions.clear(); } pub fn update_from_remote(&mut self, update: proto::UpdateWorktree) { if let Some(updates_tx) = &self.updates_tx { updates_tx .unbounded_send(update) .expect("consumer runs to completion"); } } fn observed_snapshot(&self, scan_id: usize) -> bool { self.scan_id > scan_id || (self.scan_id == scan_id && self.is_complete) } fn wait_for_snapshot(&mut self, scan_id: usize) -> impl Future { let (tx, rx) = oneshot::channel(); if self.observed_snapshot(scan_id) { let _ = tx.send(()); } else { match self .snapshot_subscriptions .binary_search_by_key(&scan_id, |probe| probe.0) { Ok(ix) | Err(ix) => self.snapshot_subscriptions.insert(ix, (scan_id, tx)), } } async move { let _ = rx.await; } } pub fn update_diagnostic_summary( &mut self, path: Arc, summary: &proto::DiagnosticSummary, ) { let summary = DiagnosticSummary { language_server_id: summary.language_server_id as usize, error_count: summary.error_count as usize, warning_count: summary.warning_count as usize, }; if summary.is_empty() { self.diagnostic_summaries.remove(&PathKey(path)); } else { self.diagnostic_summaries.insert(PathKey(path), summary); } } pub fn insert_entry( &mut self, entry: proto::Entry, scan_id: usize, cx: &mut ModelContext, ) -> Task> { let wait_for_snapshot = self.wait_for_snapshot(scan_id); cx.spawn(|this, mut cx| async move { wait_for_snapshot.await; this.update(&mut cx, |worktree, _| { let worktree = worktree.as_remote_mut().unwrap(); let mut snapshot = worktree.background_snapshot.lock(); let entry = snapshot.insert_entry(entry); worktree.snapshot = snapshot.clone(); entry }) }) } pub(crate) fn delete_entry( &mut self, id: ProjectEntryId, scan_id: usize, cx: &mut ModelContext, ) -> Task> { let wait_for_snapshot = self.wait_for_snapshot(scan_id); cx.spawn(|this, mut cx| async move { wait_for_snapshot.await; this.update(&mut cx, |worktree, _| { let worktree = worktree.as_remote_mut().unwrap(); let mut snapshot = worktree.background_snapshot.lock(); snapshot.delete_entry(id); worktree.snapshot = snapshot.clone(); }); Ok(()) }) } } impl Snapshot { pub fn id(&self) -> WorktreeId { self.id } pub fn contains_entry(&self, entry_id: ProjectEntryId) -> bool { self.entries_by_id.get(&entry_id, &()).is_some() } pub(crate) fn insert_entry(&mut self, entry: proto::Entry) -> Result { let entry = Entry::try_from((&self.root_char_bag, entry))?; let old_entry = self.entries_by_id.insert_or_replace( PathEntry { id: entry.id, path: entry.path.clone(), is_ignored: entry.is_ignored, scan_id: 0, }, &(), ); if let Some(old_entry) = old_entry { self.entries_by_path.remove(&PathKey(old_entry.path), &()); } self.entries_by_path.insert_or_replace(entry.clone(), &()); Ok(entry) } fn delete_entry(&mut self, entry_id: ProjectEntryId) -> bool { if let Some(removed_entry) = self.entries_by_id.remove(&entry_id, &()) { self.entries_by_path = { let mut cursor = self.entries_by_path.cursor(); let mut new_entries_by_path = cursor.slice(&TraversalTarget::Path(&removed_entry.path), Bias::Left, &()); while let Some(entry) = cursor.item() { if entry.path.starts_with(&removed_entry.path) { self.entries_by_id.remove(&entry.id, &()); cursor.next(&()); } else { break; } } new_entries_by_path.push_tree(cursor.suffix(&()), &()); new_entries_by_path }; true } else { false } } pub(crate) fn apply_remote_update(&mut self, update: proto::UpdateWorktree) -> Result<()> { let mut entries_by_path_edits = Vec::new(); let mut entries_by_id_edits = Vec::new(); for entry_id in update.removed_entries { let entry = self .entry_for_id(ProjectEntryId::from_proto(entry_id)) .ok_or_else(|| anyhow!("unknown entry {}", entry_id))?; entries_by_path_edits.push(Edit::Remove(PathKey(entry.path.clone()))); entries_by_id_edits.push(Edit::Remove(entry.id)); } for entry in update.updated_entries { let entry = Entry::try_from((&self.root_char_bag, entry))?; if let Some(PathEntry { path, .. }) = self.entries_by_id.get(&entry.id, &()) { entries_by_path_edits.push(Edit::Remove(PathKey(path.clone()))); } entries_by_id_edits.push(Edit::Insert(PathEntry { id: entry.id, path: entry.path.clone(), is_ignored: entry.is_ignored, scan_id: 0, })); entries_by_path_edits.push(Edit::Insert(entry)); } self.entries_by_path.edit(entries_by_path_edits, &()); self.entries_by_id.edit(entries_by_id_edits, &()); self.scan_id = update.scan_id as usize; self.is_complete = update.is_last_update; Ok(()) } pub fn file_count(&self) -> usize { self.entries_by_path.summary().file_count } pub fn visible_file_count(&self) -> usize { self.entries_by_path.summary().visible_file_count } fn traverse_from_offset( &self, include_dirs: bool, include_ignored: bool, start_offset: usize, ) -> Traversal { let mut cursor = self.entries_by_path.cursor(); cursor.seek( &TraversalTarget::Count { count: start_offset, include_dirs, include_ignored, }, Bias::Right, &(), ); Traversal { cursor, include_dirs, include_ignored, } } fn traverse_from_path( &self, include_dirs: bool, include_ignored: bool, path: &Path, ) -> Traversal { let mut cursor = self.entries_by_path.cursor(); cursor.seek(&TraversalTarget::Path(path), Bias::Left, &()); Traversal { cursor, include_dirs, include_ignored, } } pub fn files(&self, include_ignored: bool, start: usize) -> Traversal { self.traverse_from_offset(false, include_ignored, start) } pub fn entries(&self, include_ignored: bool) -> Traversal { self.traverse_from_offset(true, include_ignored, 0) } pub fn paths(&self) -> impl Iterator> { let empty_path = Path::new(""); self.entries_by_path .cursor::<()>() .filter(move |entry| entry.path.as_ref() != empty_path) .map(|entry| &entry.path) } fn child_entries<'a>(&'a self, parent_path: &'a Path) -> ChildEntriesIter<'a> { let mut cursor = self.entries_by_path.cursor(); cursor.seek(&TraversalTarget::Path(parent_path), Bias::Right, &()); let traversal = Traversal { cursor, include_dirs: true, include_ignored: true, }; ChildEntriesIter { traversal, parent_path, } } pub fn root_entry(&self) -> Option<&Entry> { self.entry_for_path("") } pub fn root_name(&self) -> &str { &self.root_name } pub fn scan_id(&self) -> usize { self.scan_id } pub fn entry_for_path(&self, path: impl AsRef) -> Option<&Entry> { let path = path.as_ref(); self.traverse_from_path(true, true, path) .entry() .and_then(|entry| { if entry.path.as_ref() == path { Some(entry) } else { None } }) } pub fn entry_for_id(&self, id: ProjectEntryId) -> Option<&Entry> { let entry = self.entries_by_id.get(&id, &())?; self.entry_for_path(&entry.path) } pub fn inode_for_path(&self, path: impl AsRef) -> Option { self.entry_for_path(path.as_ref()).map(|e| e.inode) } } impl LocalSnapshot { pub fn abs_path(&self) -> &Arc { &self.abs_path } pub fn extension_counts(&self) -> &HashMap { &self.extension_counts } // Gives the most specific git repository for a given path pub(crate) fn repo_for(&self, path: &Path) -> Option { self.git_repositories .iter() .rev() //git_repository is ordered lexicographically .find(|repo| repo.manages(path)) .cloned() } pub(crate) fn in_dot_git(&mut self, path: &Path) -> Option<&mut GitRepositoryEntry> { // Git repositories cannot be nested, so we don't need to reverse the order self.git_repositories .iter_mut() .find(|repo| repo.in_dot_git(path)) } #[cfg(test)] pub(crate) fn build_initial_update(&self, project_id: u64) -> proto::UpdateWorktree { let root_name = self.root_name.clone(); proto::UpdateWorktree { project_id, worktree_id: self.id().to_proto(), root_name, updated_entries: self.entries_by_path.iter().map(Into::into).collect(), removed_entries: Default::default(), scan_id: self.scan_id as u64, is_last_update: true, } } pub(crate) fn build_update( &self, other: &Self, project_id: u64, worktree_id: u64, include_ignored: bool, ) -> proto::UpdateWorktree { let mut updated_entries = Vec::new(); let mut removed_entries = Vec::new(); let mut self_entries = self .entries_by_id .cursor::<()>() .filter(|e| include_ignored || !e.is_ignored) .peekable(); let mut other_entries = other .entries_by_id .cursor::<()>() .filter(|e| include_ignored || !e.is_ignored) .peekable(); loop { match (self_entries.peek(), other_entries.peek()) { (Some(self_entry), Some(other_entry)) => { match Ord::cmp(&self_entry.id, &other_entry.id) { Ordering::Less => { let entry = self.entry_for_id(self_entry.id).unwrap().into(); updated_entries.push(entry); self_entries.next(); } Ordering::Equal => { if self_entry.scan_id != other_entry.scan_id { let entry = self.entry_for_id(self_entry.id).unwrap().into(); updated_entries.push(entry); } self_entries.next(); other_entries.next(); } Ordering::Greater => { removed_entries.push(other_entry.id.to_proto()); other_entries.next(); } } } (Some(self_entry), None) => { let entry = self.entry_for_id(self_entry.id).unwrap().into(); updated_entries.push(entry); self_entries.next(); } (None, Some(other_entry)) => { removed_entries.push(other_entry.id.to_proto()); other_entries.next(); } (None, None) => break, } } proto::UpdateWorktree { project_id, worktree_id, root_name: self.root_name().to_string(), updated_entries, removed_entries, scan_id: self.scan_id as u64, is_last_update: true, } } fn insert_entry(&mut self, mut entry: Entry, fs: &dyn Fs) -> Entry { if entry.is_file() && entry.path.file_name() == Some(&GITIGNORE) { let abs_path = self.abs_path.join(&entry.path); match smol::block_on(build_gitignore(&abs_path, fs)) { Ok(ignore) => { self.ignores_by_parent_abs_path.insert( abs_path.parent().unwrap().into(), (Arc::new(ignore), self.scan_id), ); } Err(error) => { log::error!( "error loading .gitignore file {:?} - {:?}", &entry.path, error ); } } } self.reuse_entry_id(&mut entry); if entry.kind == EntryKind::PendingDir { if let Some(existing_entry) = self.entries_by_path.get(&PathKey(entry.path.clone()), &()) { entry.kind = existing_entry.kind; } } self.entries_by_path.insert_or_replace(entry.clone(), &()); let scan_id = self.scan_id; let removed_entry = self.entries_by_id.insert_or_replace( PathEntry { id: entry.id, path: entry.path.clone(), is_ignored: entry.is_ignored, scan_id, }, &(), ); if let Some(removed_entry) = removed_entry { self.dec_extension_count(&removed_entry.path, removed_entry.is_ignored); } self.inc_extension_count(&entry.path, entry.is_ignored); entry } fn populate_dir( &mut self, parent_path: Arc, entries: impl IntoIterator, ignore: Option>, fs: &dyn Fs, ) { let mut parent_entry = if let Some(parent_entry) = self.entries_by_path.get(&PathKey(parent_path.clone()), &()) { parent_entry.clone() } else { log::warn!( "populating a directory {:?} that has been removed", parent_path ); return; }; if let Some(ignore) = ignore { self.ignores_by_parent_abs_path.insert( self.abs_path.join(&parent_path).into(), (ignore, self.scan_id), ); } if matches!(parent_entry.kind, EntryKind::PendingDir) { parent_entry.kind = EntryKind::Dir; } else { unreachable!(); } if parent_path.file_name() == Some(&DOT_GIT) { let abs_path = self.abs_path.join(&parent_path); let content_path: Arc = parent_path.parent().unwrap().into(); if let Err(ix) = self .git_repositories .binary_search_by_key(&&content_path, |repo| &repo.content_path) { if let Some(repo) = fs.open_repo(abs_path.as_path()) { self.git_repositories.insert( ix, GitRepositoryEntry { repo, scan_id: 0, content_path, git_dir_path: parent_path, }, ); } } } let mut entries_by_path_edits = vec![Edit::Insert(parent_entry)]; let mut entries_by_id_edits = Vec::new(); for mut entry in entries { self.reuse_entry_id(&mut entry); self.inc_extension_count(&entry.path, entry.is_ignored); entries_by_id_edits.push(Edit::Insert(PathEntry { id: entry.id, path: entry.path.clone(), is_ignored: entry.is_ignored, scan_id: self.scan_id, })); entries_by_path_edits.push(Edit::Insert(entry)); } self.entries_by_path.edit(entries_by_path_edits, &()); let removed_entries = self.entries_by_id.edit(entries_by_id_edits, &()); for removed_entry in removed_entries { self.dec_extension_count(&removed_entry.path, removed_entry.is_ignored); } } fn inc_extension_count(&mut self, path: &Path, ignored: bool) { if !ignored { if let Some(extension) = path.extension() { if let Some(count) = self.extension_counts.get_mut(extension) { *count += 1; } else { self.extension_counts.insert(extension.into(), 1); } } } } fn dec_extension_count(&mut self, path: &Path, ignored: bool) { if !ignored { if let Some(extension) = path.extension() { if let Some(count) = self.extension_counts.get_mut(extension) { *count -= 1; } } } } fn reuse_entry_id(&mut self, entry: &mut Entry) { if let Some(removed_entry_id) = self.removed_entry_ids.remove(&entry.inode) { entry.id = removed_entry_id; } else if let Some(existing_entry) = self.entry_for_path(&entry.path) { entry.id = existing_entry.id; } } fn remove_path(&mut self, path: &Path) { let mut new_entries; let removed_entries; { let mut cursor = self.entries_by_path.cursor::(); new_entries = cursor.slice(&TraversalTarget::Path(path), Bias::Left, &()); removed_entries = cursor.slice(&TraversalTarget::PathSuccessor(path), Bias::Left, &()); new_entries.push_tree(cursor.suffix(&()), &()); } self.entries_by_path = new_entries; let mut entries_by_id_edits = Vec::new(); for entry in removed_entries.cursor::<()>() { let removed_entry_id = self .removed_entry_ids .entry(entry.inode) .or_insert(entry.id); *removed_entry_id = cmp::max(*removed_entry_id, entry.id); entries_by_id_edits.push(Edit::Remove(entry.id)); self.dec_extension_count(&entry.path, entry.is_ignored); } self.entries_by_id.edit(entries_by_id_edits, &()); if path.file_name() == Some(&GITIGNORE) { let abs_parent_path = self.abs_path.join(path.parent().unwrap()); if let Some((_, scan_id)) = self .ignores_by_parent_abs_path .get_mut(abs_parent_path.as_path()) { *scan_id = self.snapshot.scan_id; } } else if path.file_name() == Some(&DOT_GIT) { let parent_path = path.parent().unwrap(); if let Ok(ix) = self .git_repositories .binary_search_by_key(&parent_path, |repo| repo.git_dir_path.as_ref()) { self.git_repositories[ix].scan_id = self.snapshot.scan_id; } } } fn ancestor_inodes_for_path(&self, path: &Path) -> TreeSet { let mut inodes = TreeSet::default(); for ancestor in path.ancestors().skip(1) { if let Some(entry) = self.entry_for_path(ancestor) { inodes.insert(entry.inode); } } inodes } fn ignore_stack_for_abs_path(&self, abs_path: &Path, is_dir: bool) -> Arc { let mut new_ignores = Vec::new(); for ancestor in abs_path.ancestors().skip(1) { if let Some((ignore, _)) = self.ignores_by_parent_abs_path.get(ancestor) { new_ignores.push((ancestor, Some(ignore.clone()))); } else { new_ignores.push((ancestor, None)); } } let mut ignore_stack = IgnoreStack::none(); for (parent_abs_path, ignore) in new_ignores.into_iter().rev() { if ignore_stack.is_abs_path_ignored(parent_abs_path, true) { ignore_stack = IgnoreStack::all(); break; } else if let Some(ignore) = ignore { ignore_stack = ignore_stack.append(parent_abs_path.into(), ignore); } } if ignore_stack.is_abs_path_ignored(abs_path, is_dir) { ignore_stack = IgnoreStack::all(); } ignore_stack } pub fn git_repo_entries(&self) -> &[GitRepositoryEntry] { &self.git_repositories } } impl GitRepositoryEntry { // Note that these paths should be relative to the worktree root. pub(crate) fn manages(&self, path: &Path) -> bool { path.starts_with(self.content_path.as_ref()) } // Note that theis path should be relative to the worktree root. pub(crate) fn in_dot_git(&self, path: &Path) -> bool { path.starts_with(self.git_dir_path.as_ref()) } } async fn build_gitignore(abs_path: &Path, fs: &dyn Fs) -> Result { let contents = fs.load(abs_path).await?; let parent = abs_path.parent().unwrap_or_else(|| Path::new("/")); let mut builder = GitignoreBuilder::new(parent); for line in contents.lines() { builder.add_line(Some(abs_path.into()), line)?; } Ok(builder.build()?) } impl WorktreeId { pub fn from_usize(handle_id: usize) -> Self { Self(handle_id) } pub(crate) fn from_proto(id: u64) -> Self { Self(id as usize) } pub fn to_proto(&self) -> u64 { self.0 as u64 } pub fn to_usize(&self) -> usize { self.0 } } impl fmt::Display for WorktreeId { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { self.0.fmt(f) } } impl Deref for Worktree { type Target = Snapshot; fn deref(&self) -> &Self::Target { match self { Worktree::Local(worktree) => &worktree.snapshot, Worktree::Remote(worktree) => &worktree.snapshot, } } } impl Deref for LocalWorktree { type Target = LocalSnapshot; fn deref(&self) -> &Self::Target { &self.snapshot } } impl Deref for RemoteWorktree { type Target = Snapshot; fn deref(&self) -> &Self::Target { &self.snapshot } } impl fmt::Debug for LocalWorktree { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { self.snapshot.fmt(f) } } impl fmt::Debug for Snapshot { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { struct EntriesById<'a>(&'a SumTree); struct EntriesByPath<'a>(&'a SumTree); impl<'a> fmt::Debug for EntriesByPath<'a> { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { f.debug_map() .entries(self.0.iter().map(|entry| (&entry.path, entry.id))) .finish() } } impl<'a> fmt::Debug for EntriesById<'a> { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { f.debug_list().entries(self.0.iter()).finish() } } f.debug_struct("Snapshot") .field("id", &self.id) .field("root_name", &self.root_name) .field("entries_by_path", &EntriesByPath(&self.entries_by_path)) .field("entries_by_id", &EntriesById(&self.entries_by_id)) .finish() } } #[derive(Clone, PartialEq)] pub struct File { pub worktree: ModelHandle, pub path: Arc, pub mtime: SystemTime, pub(crate) entry_id: Option, pub(crate) is_local: bool, } impl language::File for File { fn as_local(&self) -> Option<&dyn language::LocalFile> { if self.is_local { Some(self) } else { None } } fn mtime(&self) -> SystemTime { self.mtime } fn path(&self) -> &Arc { &self.path } fn full_path(&self, cx: &AppContext) -> PathBuf { let mut full_path = PathBuf::new(); full_path.push(self.worktree.read(cx).root_name()); if self.path.components().next().is_some() { full_path.push(&self.path); } full_path } /// Returns the last component of this handle's absolute path. If this handle refers to the root /// of its worktree, then this method will return the name of the worktree itself. fn file_name<'a>(&'a self, cx: &'a AppContext) -> &'a OsStr { self.path .file_name() .unwrap_or_else(|| OsStr::new(&self.worktree.read(cx).root_name)) } fn is_deleted(&self) -> bool { self.entry_id.is_none() } fn save( &self, buffer_id: u64, text: Rope, version: clock::Global, line_ending: LineEnding, cx: &mut MutableAppContext, ) -> Task> { self.worktree.update(cx, |worktree, cx| match worktree { Worktree::Local(worktree) => { let rpc = worktree.client.clone(); let project_id = worktree.share.as_ref().map(|share| share.project_id); let fingerprint = text.fingerprint(); let save = worktree.write_file(self.path.clone(), text, line_ending, cx); cx.background().spawn(async move { let entry = save.await?; if let Some(project_id) = project_id { rpc.send(proto::BufferSaved { project_id, buffer_id, version: serialize_version(&version), mtime: Some(entry.mtime.into()), fingerprint: fingerprint.clone(), })?; } Ok((version, fingerprint, entry.mtime)) }) } Worktree::Remote(worktree) => { let rpc = worktree.client.clone(); let project_id = worktree.project_id; cx.foreground().spawn(async move { let response = rpc .request(proto::SaveBuffer { project_id, buffer_id, version: serialize_version(&version), }) .await?; let version = deserialize_version(response.version); let mtime = response .mtime .ok_or_else(|| anyhow!("missing mtime"))? .into(); Ok((version, response.fingerprint, mtime)) }) } }) } fn as_any(&self) -> &dyn Any { self } fn to_proto(&self) -> rpc::proto::File { rpc::proto::File { worktree_id: self.worktree.id() as u64, entry_id: self.entry_id.map(|entry_id| entry_id.to_proto()), path: self.path.to_string_lossy().into(), mtime: Some(self.mtime.into()), } } } impl language::LocalFile for File { fn abs_path(&self, cx: &AppContext) -> PathBuf { self.worktree .read(cx) .as_local() .unwrap() .abs_path .join(&self.path) } fn load(&self, cx: &AppContext) -> Task> { let worktree = self.worktree.read(cx).as_local().unwrap(); let abs_path = worktree.absolutize(&self.path); let fs = worktree.fs.clone(); cx.background() .spawn(async move { fs.load(&abs_path).await }) } fn buffer_reloaded( &self, buffer_id: u64, version: &clock::Global, fingerprint: String, line_ending: LineEnding, mtime: SystemTime, cx: &mut MutableAppContext, ) { let worktree = self.worktree.read(cx).as_local().unwrap(); if let Some(project_id) = worktree.share.as_ref().map(|share| share.project_id) { worktree .client .send(proto::BufferReloaded { project_id, buffer_id, version: serialize_version(version), mtime: Some(mtime.into()), fingerprint, line_ending: serialize_line_ending(line_ending) as i32, }) .log_err(); } } } impl File { pub fn from_proto( proto: rpc::proto::File, worktree: ModelHandle, cx: &AppContext, ) -> Result { let worktree_id = worktree .read(cx) .as_remote() .ok_or_else(|| anyhow!("not remote"))? .id(); if worktree_id.to_proto() != proto.worktree_id { return Err(anyhow!("worktree id does not match file")); } Ok(Self { worktree, path: Path::new(&proto.path).into(), mtime: proto.mtime.ok_or_else(|| anyhow!("no timestamp"))?.into(), entry_id: proto.entry_id.map(ProjectEntryId::from_proto), is_local: false, }) } pub fn from_dyn(file: Option<&dyn language::File>) -> Option<&Self> { file.and_then(|f| f.as_any().downcast_ref()) } pub fn worktree_id(&self, cx: &AppContext) -> WorktreeId { self.worktree.read(cx).id() } pub fn project_entry_id(&self, _: &AppContext) -> Option { self.entry_id } } #[derive(Clone, Debug, PartialEq, Eq)] pub struct Entry { pub id: ProjectEntryId, pub kind: EntryKind, pub path: Arc, pub inode: u64, pub mtime: SystemTime, pub is_symlink: bool, pub is_ignored: bool, } #[derive(Clone, Copy, Debug, PartialEq, Eq)] pub enum EntryKind { PendingDir, Dir, File(CharBag), } impl Entry { fn new( path: Arc, metadata: &fs::Metadata, next_entry_id: &AtomicUsize, root_char_bag: CharBag, ) -> Self { Self { id: ProjectEntryId::new(next_entry_id), kind: if metadata.is_dir { EntryKind::PendingDir } else { EntryKind::File(char_bag_for_path(root_char_bag, &path)) }, path, inode: metadata.inode, mtime: metadata.mtime, is_symlink: metadata.is_symlink, is_ignored: false, } } pub fn is_dir(&self) -> bool { matches!(self.kind, EntryKind::Dir | EntryKind::PendingDir) } pub fn is_file(&self) -> bool { matches!(self.kind, EntryKind::File(_)) } } impl sum_tree::Item for Entry { type Summary = EntrySummary; fn summary(&self) -> Self::Summary { let visible_count = if self.is_ignored { 0 } else { 1 }; let file_count; let visible_file_count; if self.is_file() { file_count = 1; visible_file_count = visible_count; } else { file_count = 0; visible_file_count = 0; } EntrySummary { max_path: self.path.clone(), count: 1, visible_count, file_count, visible_file_count, } } } impl sum_tree::KeyedItem for Entry { type Key = PathKey; fn key(&self) -> Self::Key { PathKey(self.path.clone()) } } #[derive(Clone, Debug)] pub struct EntrySummary { max_path: Arc, count: usize, visible_count: usize, file_count: usize, visible_file_count: usize, } impl Default for EntrySummary { fn default() -> Self { Self { max_path: Arc::from(Path::new("")), count: 0, visible_count: 0, file_count: 0, visible_file_count: 0, } } } impl sum_tree::Summary for EntrySummary { type Context = (); fn add_summary(&mut self, rhs: &Self, _: &()) { self.max_path = rhs.max_path.clone(); self.count += rhs.count; self.visible_count += rhs.visible_count; self.file_count += rhs.file_count; self.visible_file_count += rhs.visible_file_count; } } #[derive(Clone, Debug)] struct PathEntry { id: ProjectEntryId, path: Arc, is_ignored: bool, scan_id: usize, } impl sum_tree::Item for PathEntry { type Summary = PathEntrySummary; fn summary(&self) -> Self::Summary { PathEntrySummary { max_id: self.id } } } impl sum_tree::KeyedItem for PathEntry { type Key = ProjectEntryId; fn key(&self) -> Self::Key { self.id } } #[derive(Clone, Debug, Default)] struct PathEntrySummary { max_id: ProjectEntryId, } impl sum_tree::Summary for PathEntrySummary { type Context = (); fn add_summary(&mut self, summary: &Self, _: &Self::Context) { self.max_id = summary.max_id; } } impl<'a> sum_tree::Dimension<'a, PathEntrySummary> for ProjectEntryId { fn add_summary(&mut self, summary: &'a PathEntrySummary, _: &()) { *self = summary.max_id; } } #[derive(Clone, Debug, Eq, PartialEq, Ord, PartialOrd)] pub struct PathKey(Arc); impl Default for PathKey { fn default() -> Self { Self(Path::new("").into()) } } impl<'a> sum_tree::Dimension<'a, EntrySummary> for PathKey { fn add_summary(&mut self, summary: &'a EntrySummary, _: &()) { self.0 = summary.max_path.clone(); } } struct BackgroundScanner { fs: Arc, snapshot: Arc>, notify: UnboundedSender, executor: Arc, } impl BackgroundScanner { fn new( snapshot: Arc>, notify: UnboundedSender, fs: Arc, executor: Arc, ) -> Self { Self { fs, snapshot, notify, executor, } } fn abs_path(&self) -> Arc { self.snapshot.lock().abs_path.clone() } fn snapshot(&self) -> LocalSnapshot { self.snapshot.lock().clone() } async fn run(mut self, events_rx: impl Stream>) { if self.notify.unbounded_send(ScanState::Initializing).is_err() { return; } if let Err(err) = self.scan_dirs().await { if self .notify .unbounded_send(ScanState::Err(Arc::new(err))) .is_err() { return; } } if self.notify.unbounded_send(ScanState::Idle).is_err() { return; } futures::pin_mut!(events_rx); while let Some(mut events) = events_rx.next().await { while let Poll::Ready(Some(additional_events)) = futures::poll!(events_rx.next()) { events.extend(additional_events); } if self.notify.unbounded_send(ScanState::Updating).is_err() { break; } if !self.process_events(events).await { break; } if self.notify.unbounded_send(ScanState::Idle).is_err() { break; } } } async fn scan_dirs(&mut self) -> Result<()> { let root_char_bag; let root_abs_path; let root_inode; let is_dir; let next_entry_id; { let snapshot = self.snapshot.lock(); root_char_bag = snapshot.root_char_bag; root_abs_path = snapshot.abs_path.clone(); root_inode = snapshot.root_entry().map(|e| e.inode); is_dir = snapshot.root_entry().map_or(false, |e| e.is_dir()); next_entry_id = snapshot.next_entry_id.clone(); }; // Populate ignores above the root. for ancestor in root_abs_path.ancestors().skip(1) { if let Ok(ignore) = build_gitignore(&ancestor.join(&*GITIGNORE), self.fs.as_ref()).await { self.snapshot .lock() .ignores_by_parent_abs_path .insert(ancestor.into(), (ignore.into(), 0)); } } let ignore_stack = { let mut snapshot = self.snapshot.lock(); let ignore_stack = snapshot.ignore_stack_for_abs_path(&root_abs_path, true); if ignore_stack.is_all() { if let Some(mut root_entry) = snapshot.root_entry().cloned() { root_entry.is_ignored = true; snapshot.insert_entry(root_entry, self.fs.as_ref()); } } ignore_stack }; if is_dir { let path: Arc = Arc::from(Path::new("")); let mut ancestor_inodes = TreeSet::default(); if let Some(root_inode) = root_inode { ancestor_inodes.insert(root_inode); } let (tx, rx) = channel::unbounded(); self.executor .block(tx.send(ScanJob { abs_path: root_abs_path.to_path_buf(), path, ignore_stack, ancestor_inodes, scan_queue: tx.clone(), })) .unwrap(); drop(tx); self.executor .scoped(|scope| { for _ in 0..self.executor.num_cpus() { scope.spawn(async { while let Ok(job) = rx.recv().await { if let Err(err) = self .scan_dir(root_char_bag, next_entry_id.clone(), &job) .await { log::error!("error scanning {:?}: {}", job.abs_path, err); } } }); } }) .await; } Ok(()) } async fn scan_dir( &self, root_char_bag: CharBag, next_entry_id: Arc, job: &ScanJob, ) -> Result<()> { let mut new_entries: Vec = Vec::new(); let mut new_jobs: Vec = Vec::new(); let mut ignore_stack = job.ignore_stack.clone(); let mut new_ignore = None; let mut child_paths = self.fs.read_dir(&job.abs_path).await?; while let Some(child_abs_path) = child_paths.next().await { let child_abs_path = match child_abs_path { Ok(child_abs_path) => child_abs_path, Err(error) => { log::error!("error processing entry {:?}", error); continue; } }; let child_name = child_abs_path.file_name().unwrap(); let child_path: Arc = job.path.join(child_name).into(); let child_metadata = match self.fs.metadata(&child_abs_path).await { Ok(Some(metadata)) => metadata, Ok(None) => continue, Err(err) => { log::error!("error processing {:?}: {:?}", child_abs_path, err); continue; } }; // If we find a .gitignore, add it to the stack of ignores used to determine which paths are ignored if child_name == *GITIGNORE { match build_gitignore(&child_abs_path, self.fs.as_ref()).await { Ok(ignore) => { let ignore = Arc::new(ignore); ignore_stack = ignore_stack.append(job.abs_path.as_path().into(), ignore.clone()); new_ignore = Some(ignore); } Err(error) => { log::error!( "error loading .gitignore file {:?} - {:?}", child_name, error ); } } // Update ignore status of any child entries we've already processed to reflect the // ignore file in the current directory. Because `.gitignore` starts with a `.`, // there should rarely be too numerous. Update the ignore stack associated with any // new jobs as well. let mut new_jobs = new_jobs.iter_mut(); for entry in &mut new_entries { let entry_abs_path = self.abs_path().join(&entry.path); entry.is_ignored = ignore_stack.is_abs_path_ignored(&entry_abs_path, entry.is_dir()); if entry.is_dir() { new_jobs.next().unwrap().ignore_stack = if entry.is_ignored { IgnoreStack::all() } else { ignore_stack.clone() }; } } } let mut child_entry = Entry::new( child_path.clone(), &child_metadata, &next_entry_id, root_char_bag, ); if child_entry.is_dir() { let is_ignored = ignore_stack.is_abs_path_ignored(&child_abs_path, true); child_entry.is_ignored = is_ignored; if !job.ancestor_inodes.contains(&child_entry.inode) { let mut ancestor_inodes = job.ancestor_inodes.clone(); ancestor_inodes.insert(child_entry.inode); new_jobs.push(ScanJob { abs_path: child_abs_path, path: child_path, ignore_stack: if is_ignored { IgnoreStack::all() } else { ignore_stack.clone() }, ancestor_inodes, scan_queue: job.scan_queue.clone(), }); } } else { child_entry.is_ignored = ignore_stack.is_abs_path_ignored(&child_abs_path, false); } new_entries.push(child_entry); } self.snapshot.lock().populate_dir( job.path.clone(), new_entries, new_ignore, self.fs.as_ref(), ); for new_job in new_jobs { job.scan_queue.send(new_job).await.unwrap(); } Ok(()) } async fn process_events(&mut self, mut events: Vec) -> bool { events.sort_unstable_by(|a, b| a.path.cmp(&b.path)); events.dedup_by(|a, b| a.path.starts_with(&b.path)); let root_char_bag; let root_abs_path; let next_entry_id; { let snapshot = self.snapshot.lock(); root_char_bag = snapshot.root_char_bag; root_abs_path = snapshot.abs_path.clone(); next_entry_id = snapshot.next_entry_id.clone(); } let root_canonical_path = if let Ok(path) = self.fs.canonicalize(&root_abs_path).await { path } else { return false; }; let metadata = futures::future::join_all( events .iter() .map(|event| self.fs.metadata(&event.path)) .collect::>(), ) .await; // Hold the snapshot lock while clearing and re-inserting the root entries // for each event. This way, the snapshot is not observable to the foreground // thread while this operation is in-progress. let (scan_queue_tx, scan_queue_rx) = channel::unbounded(); { let mut snapshot = self.snapshot.lock(); snapshot.scan_id += 1; for event in &events { if let Ok(path) = event.path.strip_prefix(&root_canonical_path) { snapshot.remove_path(path); } } for (event, metadata) in events.into_iter().zip(metadata.into_iter()) { let path: Arc = match event.path.strip_prefix(&root_canonical_path) { Ok(path) => Arc::from(path.to_path_buf()), Err(_) => { log::error!( "unexpected event {:?} for root path {:?}", event.path, root_canonical_path ); continue; } }; let abs_path = root_abs_path.join(&path); match metadata { Ok(Some(metadata)) => { let ignore_stack = snapshot.ignore_stack_for_abs_path(&abs_path, metadata.is_dir); let mut fs_entry = Entry::new( path.clone(), &metadata, snapshot.next_entry_id.as_ref(), snapshot.root_char_bag, ); fs_entry.is_ignored = ignore_stack.is_all(); snapshot.insert_entry(fs_entry, self.fs.as_ref()); let scan_id = snapshot.scan_id; if let Some(repo) = snapshot.in_dot_git(&path) { repo.repo.lock().reload_index(); repo.scan_id = scan_id; } let mut ancestor_inodes = snapshot.ancestor_inodes_for_path(&path); if metadata.is_dir && !ancestor_inodes.contains(&metadata.inode) { ancestor_inodes.insert(metadata.inode); self.executor .block(scan_queue_tx.send(ScanJob { abs_path, path, ignore_stack, ancestor_inodes, scan_queue: scan_queue_tx.clone(), })) .unwrap(); } } Ok(None) => {} Err(err) => { // TODO - create a special 'error' entry in the entries tree to mark this log::error!("error reading file on event {:?}", err); } } } drop(scan_queue_tx); } // Scan any directories that were created as part of this event batch. self.executor .scoped(|scope| { for _ in 0..self.executor.num_cpus() { scope.spawn(async { while let Ok(job) = scan_queue_rx.recv().await { if let Err(err) = self .scan_dir(root_char_bag, next_entry_id.clone(), &job) .await { log::error!("error scanning {:?}: {}", job.abs_path, err); } } }); } }) .await; // Attempt to detect renames only over a single batch of file-system events. self.snapshot.lock().removed_entry_ids.clear(); self.update_ignore_statuses().await; self.update_git_repositories(); true } async fn update_ignore_statuses(&self) { let mut snapshot = self.snapshot(); let mut ignores_to_update = Vec::new(); let mut ignores_to_delete = Vec::new(); for (parent_abs_path, (_, scan_id)) in &snapshot.ignores_by_parent_abs_path { if let Ok(parent_path) = parent_abs_path.strip_prefix(&snapshot.abs_path) { if *scan_id == snapshot.scan_id && snapshot.entry_for_path(parent_path).is_some() { ignores_to_update.push(parent_abs_path.clone()); } let ignore_path = parent_path.join(&*GITIGNORE); if snapshot.entry_for_path(ignore_path).is_none() { ignores_to_delete.push(parent_abs_path.clone()); } } } for parent_abs_path in ignores_to_delete { snapshot.ignores_by_parent_abs_path.remove(&parent_abs_path); self.snapshot .lock() .ignores_by_parent_abs_path .remove(&parent_abs_path); } let (ignore_queue_tx, ignore_queue_rx) = channel::unbounded(); ignores_to_update.sort_unstable(); let mut ignores_to_update = ignores_to_update.into_iter().peekable(); while let Some(parent_abs_path) = ignores_to_update.next() { while ignores_to_update .peek() .map_or(false, |p| p.starts_with(&parent_abs_path)) { ignores_to_update.next().unwrap(); } let ignore_stack = snapshot.ignore_stack_for_abs_path(&parent_abs_path, true); ignore_queue_tx .send(UpdateIgnoreStatusJob { abs_path: parent_abs_path, ignore_stack, ignore_queue: ignore_queue_tx.clone(), }) .await .unwrap(); } drop(ignore_queue_tx); self.executor .scoped(|scope| { for _ in 0..self.executor.num_cpus() { scope.spawn(async { while let Ok(job) = ignore_queue_rx.recv().await { self.update_ignore_status(job, &snapshot).await; } }); } }) .await; } fn update_git_repositories(&self) { let mut snapshot = self.snapshot.lock(); let mut git_repositories = mem::take(&mut snapshot.git_repositories); git_repositories.retain(|repo| snapshot.entry_for_path(&repo.git_dir_path).is_some()); snapshot.git_repositories = git_repositories; } async fn update_ignore_status(&self, job: UpdateIgnoreStatusJob, snapshot: &LocalSnapshot) { let mut ignore_stack = job.ignore_stack; if let Some((ignore, _)) = snapshot.ignores_by_parent_abs_path.get(&job.abs_path) { ignore_stack = ignore_stack.append(job.abs_path.clone(), ignore.clone()); } let mut entries_by_id_edits = Vec::new(); let mut entries_by_path_edits = Vec::new(); let path = job.abs_path.strip_prefix(&snapshot.abs_path).unwrap(); for mut entry in snapshot.child_entries(path).cloned() { let was_ignored = entry.is_ignored; let abs_path = self.abs_path().join(&entry.path); entry.is_ignored = ignore_stack.is_abs_path_ignored(&abs_path, entry.is_dir()); if entry.is_dir() { let child_ignore_stack = if entry.is_ignored { IgnoreStack::all() } else { ignore_stack.clone() }; job.ignore_queue .send(UpdateIgnoreStatusJob { abs_path: abs_path.into(), ignore_stack: child_ignore_stack, ignore_queue: job.ignore_queue.clone(), }) .await .unwrap(); } if entry.is_ignored != was_ignored { let mut path_entry = snapshot.entries_by_id.get(&entry.id, &()).unwrap().clone(); path_entry.scan_id = snapshot.scan_id; path_entry.is_ignored = entry.is_ignored; entries_by_id_edits.push(Edit::Insert(path_entry)); entries_by_path_edits.push(Edit::Insert(entry)); } } let mut snapshot = self.snapshot.lock(); snapshot.entries_by_path.edit(entries_by_path_edits, &()); snapshot.entries_by_id.edit(entries_by_id_edits, &()); } } fn char_bag_for_path(root_char_bag: CharBag, path: &Path) -> CharBag { let mut result = root_char_bag; result.extend( path.to_string_lossy() .chars() .map(|c| c.to_ascii_lowercase()), ); result } struct ScanJob { abs_path: PathBuf, path: Arc, ignore_stack: Arc, scan_queue: Sender, ancestor_inodes: TreeSet, } struct UpdateIgnoreStatusJob { abs_path: Arc, ignore_stack: Arc, ignore_queue: Sender, } pub trait WorktreeHandle { #[cfg(any(test, feature = "test-support"))] fn flush_fs_events<'a>( &self, cx: &'a gpui::TestAppContext, ) -> futures::future::LocalBoxFuture<'a, ()>; } impl WorktreeHandle for ModelHandle { // When the worktree's FS event stream sometimes delivers "redundant" events for FS changes that // occurred before the worktree was constructed. These events can cause the worktree to perfrom // extra directory scans, and emit extra scan-state notifications. // // This function mutates the worktree's directory and waits for those mutations to be picked up, // to ensure that all redundant FS events have already been processed. #[cfg(any(test, feature = "test-support"))] fn flush_fs_events<'a>( &self, cx: &'a gpui::TestAppContext, ) -> futures::future::LocalBoxFuture<'a, ()> { use smol::future::FutureExt; let filename = "fs-event-sentinel"; let tree = self.clone(); let (fs, root_path) = self.read_with(cx, |tree, _| { let tree = tree.as_local().unwrap(); (tree.fs.clone(), tree.abs_path().clone()) }); async move { fs.create_file(&root_path.join(filename), Default::default()) .await .unwrap(); tree.condition(cx, |tree, _| tree.entry_for_path(filename).is_some()) .await; fs.remove_file(&root_path.join(filename), Default::default()) .await .unwrap(); tree.condition(cx, |tree, _| tree.entry_for_path(filename).is_none()) .await; cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete()) .await; } .boxed_local() } } #[derive(Clone, Debug)] struct TraversalProgress<'a> { max_path: &'a Path, count: usize, visible_count: usize, file_count: usize, visible_file_count: usize, } impl<'a> TraversalProgress<'a> { fn count(&self, include_dirs: bool, include_ignored: bool) -> usize { match (include_ignored, include_dirs) { (true, true) => self.count, (true, false) => self.file_count, (false, true) => self.visible_count, (false, false) => self.visible_file_count, } } } impl<'a> sum_tree::Dimension<'a, EntrySummary> for TraversalProgress<'a> { fn add_summary(&mut self, summary: &'a EntrySummary, _: &()) { self.max_path = summary.max_path.as_ref(); self.count += summary.count; self.visible_count += summary.visible_count; self.file_count += summary.file_count; self.visible_file_count += summary.visible_file_count; } } impl<'a> Default for TraversalProgress<'a> { fn default() -> Self { Self { max_path: Path::new(""), count: 0, visible_count: 0, file_count: 0, visible_file_count: 0, } } } pub struct Traversal<'a> { cursor: sum_tree::Cursor<'a, Entry, TraversalProgress<'a>>, include_ignored: bool, include_dirs: bool, } impl<'a> Traversal<'a> { pub fn advance(&mut self) -> bool { self.advance_to_offset(self.offset() + 1) } pub fn advance_to_offset(&mut self, offset: usize) -> bool { self.cursor.seek_forward( &TraversalTarget::Count { count: offset, include_dirs: self.include_dirs, include_ignored: self.include_ignored, }, Bias::Right, &(), ) } pub fn advance_to_sibling(&mut self) -> bool { while let Some(entry) = self.cursor.item() { self.cursor.seek_forward( &TraversalTarget::PathSuccessor(&entry.path), Bias::Left, &(), ); if let Some(entry) = self.cursor.item() { if (self.include_dirs || !entry.is_dir()) && (self.include_ignored || !entry.is_ignored) { return true; } } } false } pub fn entry(&self) -> Option<&'a Entry> { self.cursor.item() } pub fn offset(&self) -> usize { self.cursor .start() .count(self.include_dirs, self.include_ignored) } } impl<'a> Iterator for Traversal<'a> { type Item = &'a Entry; fn next(&mut self) -> Option { if let Some(item) = self.entry() { self.advance(); Some(item) } else { None } } } #[derive(Debug)] enum TraversalTarget<'a> { Path(&'a Path), PathSuccessor(&'a Path), Count { count: usize, include_ignored: bool, include_dirs: bool, }, } impl<'a, 'b> SeekTarget<'a, EntrySummary, TraversalProgress<'a>> for TraversalTarget<'b> { fn cmp(&self, cursor_location: &TraversalProgress<'a>, _: &()) -> Ordering { match self { TraversalTarget::Path(path) => path.cmp(&cursor_location.max_path), TraversalTarget::PathSuccessor(path) => { if !cursor_location.max_path.starts_with(path) { Ordering::Equal } else { Ordering::Greater } } TraversalTarget::Count { count, include_dirs, include_ignored, } => Ord::cmp( count, &cursor_location.count(*include_dirs, *include_ignored), ), } } } struct ChildEntriesIter<'a> { parent_path: &'a Path, traversal: Traversal<'a>, } impl<'a> Iterator for ChildEntriesIter<'a> { type Item = &'a Entry; fn next(&mut self) -> Option { if let Some(item) = self.traversal.entry() { if item.path.starts_with(&self.parent_path) { self.traversal.advance_to_sibling(); return Some(item); } } None } } impl<'a> From<&'a Entry> for proto::Entry { fn from(entry: &'a Entry) -> Self { Self { id: entry.id.to_proto(), is_dir: entry.is_dir(), path: entry.path.as_os_str().as_bytes().to_vec(), inode: entry.inode, mtime: Some(entry.mtime.into()), is_symlink: entry.is_symlink, is_ignored: entry.is_ignored, } } } impl<'a> TryFrom<(&'a CharBag, proto::Entry)> for Entry { type Error = anyhow::Error; fn try_from((root_char_bag, entry): (&'a CharBag, proto::Entry)) -> Result { if let Some(mtime) = entry.mtime { let kind = if entry.is_dir { EntryKind::Dir } else { let mut char_bag = *root_char_bag; char_bag.extend( String::from_utf8_lossy(&entry.path) .chars() .map(|c| c.to_ascii_lowercase()), ); EntryKind::File(char_bag) }; let path: Arc = PathBuf::from(OsString::from_vec(entry.path)).into(); Ok(Entry { id: ProjectEntryId::from_proto(entry.id), kind, path, inode: entry.inode, mtime: mtime.into(), is_symlink: entry.is_symlink, is_ignored: entry.is_ignored, }) } else { Err(anyhow!( "missing mtime in remote worktree entry {:?}", entry.path )) } } } async fn send_worktree_update(client: &Arc, update: proto::UpdateWorktree) -> Result<()> { #[cfg(any(test, feature = "test-support"))] const MAX_CHUNK_SIZE: usize = 2; #[cfg(not(any(test, feature = "test-support")))] const MAX_CHUNK_SIZE: usize = 256; for update in proto::split_worktree_update(update, MAX_CHUNK_SIZE) { client.request(update).await?; } Ok(()) } #[cfg(test)] mod tests { use super::*; use anyhow::Result; use client::test::FakeHttpClient; use fs::repository::FakeGitRepository; use fs::{FakeFs, RealFs}; use gpui::{executor::Deterministic, TestAppContext}; use rand::prelude::*; use serde_json::json; use std::{ env, fmt::Write, time::{SystemTime, UNIX_EPOCH}, }; use util::test::temp_tree; #[gpui::test] async fn test_traversal(cx: &mut TestAppContext) { let fs = FakeFs::new(cx.background()); fs.insert_tree( "/root", json!({ ".gitignore": "a/b\n", "a": { "b": "", "c": "", } }), ) .await; let http_client = FakeHttpClient::with_404_response(); let client = cx.read(|cx| Client::new(http_client, cx)); let tree = Worktree::local( client, Arc::from(Path::new("/root")), true, fs, Default::default(), &mut cx.to_async(), ) .await .unwrap(); cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete()) .await; tree.read_with(cx, |tree, _| { assert_eq!( tree.entries(false) .map(|entry| entry.path.as_ref()) .collect::>(), vec![ Path::new(""), Path::new(".gitignore"), Path::new("a"), Path::new("a/c"), ] ); assert_eq!( tree.entries(true) .map(|entry| entry.path.as_ref()) .collect::>(), vec![ Path::new(""), Path::new(".gitignore"), Path::new("a"), Path::new("a/b"), Path::new("a/c"), ] ); }) } #[gpui::test(iterations = 10)] async fn test_circular_symlinks(executor: Arc, cx: &mut TestAppContext) { let fs = FakeFs::new(cx.background()); fs.insert_tree( "/root", json!({ "lib": { "a": { "a.txt": "" }, "b": { "b.txt": "" } } }), ) .await; fs.insert_symlink("/root/lib/a/lib", "..".into()).await; fs.insert_symlink("/root/lib/b/lib", "..".into()).await; let client = cx.read(|cx| Client::new(FakeHttpClient::with_404_response(), cx)); let tree = Worktree::local( client, Arc::from(Path::new("/root")), true, fs.clone(), Default::default(), &mut cx.to_async(), ) .await .unwrap(); cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete()) .await; tree.read_with(cx, |tree, _| { assert_eq!( tree.entries(false) .map(|entry| entry.path.as_ref()) .collect::>(), vec![ Path::new(""), Path::new("lib"), Path::new("lib/a"), Path::new("lib/a/a.txt"), Path::new("lib/a/lib"), Path::new("lib/b"), Path::new("lib/b/b.txt"), Path::new("lib/b/lib"), ] ); }); fs.rename( Path::new("/root/lib/a/lib"), Path::new("/root/lib/a/lib-2"), Default::default(), ) .await .unwrap(); executor.run_until_parked(); tree.read_with(cx, |tree, _| { assert_eq!( tree.entries(false) .map(|entry| entry.path.as_ref()) .collect::>(), vec![ Path::new(""), Path::new("lib"), Path::new("lib/a"), Path::new("lib/a/a.txt"), Path::new("lib/a/lib-2"), Path::new("lib/b"), Path::new("lib/b/b.txt"), Path::new("lib/b/lib"), ] ); }); } #[gpui::test] async fn test_rescan_with_gitignore(cx: &mut TestAppContext) { let parent_dir = temp_tree(json!({ ".gitignore": "ancestor-ignored-file1\nancestor-ignored-file2\n", "tree": { ".git": {}, ".gitignore": "ignored-dir\n", "tracked-dir": { "tracked-file1": "", "ancestor-ignored-file1": "", }, "ignored-dir": { "ignored-file1": "" } } })); let dir = parent_dir.path().join("tree"); let client = cx.read(|cx| Client::new(FakeHttpClient::with_404_response(), cx)); let tree = Worktree::local( client, dir.as_path(), true, Arc::new(RealFs), Default::default(), &mut cx.to_async(), ) .await .unwrap(); cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete()) .await; tree.flush_fs_events(cx).await; cx.read(|cx| { let tree = tree.read(cx); assert!( !tree .entry_for_path("tracked-dir/tracked-file1") .unwrap() .is_ignored ); assert!( tree.entry_for_path("tracked-dir/ancestor-ignored-file1") .unwrap() .is_ignored ); assert!( tree.entry_for_path("ignored-dir/ignored-file1") .unwrap() .is_ignored ); }); std::fs::write(dir.join("tracked-dir/tracked-file2"), "").unwrap(); std::fs::write(dir.join("tracked-dir/ancestor-ignored-file2"), "").unwrap(); std::fs::write(dir.join("ignored-dir/ignored-file2"), "").unwrap(); tree.flush_fs_events(cx).await; cx.read(|cx| { let tree = tree.read(cx); assert!( !tree .entry_for_path("tracked-dir/tracked-file2") .unwrap() .is_ignored ); assert!( tree.entry_for_path("tracked-dir/ancestor-ignored-file2") .unwrap() .is_ignored ); assert!( tree.entry_for_path("ignored-dir/ignored-file2") .unwrap() .is_ignored ); assert!(tree.entry_for_path(".git").unwrap().is_ignored); }); } #[gpui::test] async fn test_git_repository_for_path(cx: &mut TestAppContext) { let root = temp_tree(json!({ "dir1": { ".git": {}, "deps": { "dep1": { ".git": {}, "src": { "a.txt": "" } } }, "src": { "b.txt": "" } }, "c.txt": "", })); let http_client = FakeHttpClient::with_404_response(); let client = cx.read(|cx| Client::new(http_client, cx)); let tree = Worktree::local( client, root.path(), true, Arc::new(RealFs), Default::default(), &mut cx.to_async(), ) .await .unwrap(); cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete()) .await; tree.flush_fs_events(cx).await; tree.read_with(cx, |tree, _cx| { let tree = tree.as_local().unwrap(); assert!(tree.repo_for("c.txt".as_ref()).is_none()); let repo = tree.repo_for("dir1/src/b.txt".as_ref()).unwrap(); assert_eq!(repo.content_path.as_ref(), Path::new("dir1")); assert_eq!(repo.git_dir_path.as_ref(), Path::new("dir1/.git")); let repo = tree.repo_for("dir1/deps/dep1/src/a.txt".as_ref()).unwrap(); assert_eq!(repo.content_path.as_ref(), Path::new("dir1/deps/dep1")); assert_eq!(repo.git_dir_path.as_ref(), Path::new("dir1/deps/dep1/.git"),); }); let original_scan_id = tree.read_with(cx, |tree, _cx| { let tree = tree.as_local().unwrap(); tree.repo_for("dir1/src/b.txt".as_ref()).unwrap().scan_id }); std::fs::write(root.path().join("dir1/.git/random_new_file"), "hello").unwrap(); tree.flush_fs_events(cx).await; tree.read_with(cx, |tree, _cx| { let tree = tree.as_local().unwrap(); let new_scan_id = tree.repo_for("dir1/src/b.txt".as_ref()).unwrap().scan_id; assert_ne!( original_scan_id, new_scan_id, "original {original_scan_id}, new {new_scan_id}" ); }); std::fs::remove_dir_all(root.path().join("dir1/.git")).unwrap(); tree.flush_fs_events(cx).await; tree.read_with(cx, |tree, _cx| { let tree = tree.as_local().unwrap(); assert!(tree.repo_for("dir1/src/b.txt".as_ref()).is_none()); }); } #[test] fn test_changed_repos() { fn fake_entry(git_dir_path: impl AsRef, scan_id: usize) -> GitRepositoryEntry { GitRepositoryEntry { repo: Arc::new(Mutex::new(FakeGitRepository::default())), scan_id, content_path: git_dir_path.as_ref().parent().unwrap().into(), git_dir_path: git_dir_path.as_ref().into(), } } let prev_repos: Vec = vec![ fake_entry("/.git", 0), fake_entry("/a/.git", 0), fake_entry("/a/b/.git", 0), ]; let new_repos: Vec = vec![ fake_entry("/a/.git", 1), fake_entry("/a/b/.git", 0), fake_entry("/a/c/.git", 0), ]; let res = LocalWorktree::changed_repos(&prev_repos, &new_repos); // Deletion retained assert!(res .iter() .find(|repo| repo.git_dir_path.as_ref() == Path::new("/.git") && repo.scan_id == 0) .is_some()); // Update retained assert!(res .iter() .find(|repo| repo.git_dir_path.as_ref() == Path::new("/a/.git") && repo.scan_id == 1) .is_some()); // Addition retained assert!(res .iter() .find(|repo| repo.git_dir_path.as_ref() == Path::new("/a/c/.git") && repo.scan_id == 0) .is_some()); // Nochange, not retained assert!(res .iter() .find(|repo| repo.git_dir_path.as_ref() == Path::new("/a/b/.git") && repo.scan_id == 0) .is_none()); } #[gpui::test] async fn test_write_file(cx: &mut TestAppContext) { let dir = temp_tree(json!({ ".git": {}, ".gitignore": "ignored-dir\n", "tracked-dir": {}, "ignored-dir": {} })); let client = cx.read(|cx| Client::new(FakeHttpClient::with_404_response(), cx)); let tree = Worktree::local( client, dir.path(), true, Arc::new(RealFs), Default::default(), &mut cx.to_async(), ) .await .unwrap(); cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete()) .await; tree.flush_fs_events(cx).await; tree.update(cx, |tree, cx| { tree.as_local().unwrap().write_file( Path::new("tracked-dir/file.txt"), "hello".into(), Default::default(), cx, ) }) .await .unwrap(); tree.update(cx, |tree, cx| { tree.as_local().unwrap().write_file( Path::new("ignored-dir/file.txt"), "world".into(), Default::default(), cx, ) }) .await .unwrap(); tree.read_with(cx, |tree, _| { let tracked = tree.entry_for_path("tracked-dir/file.txt").unwrap(); let ignored = tree.entry_for_path("ignored-dir/file.txt").unwrap(); assert!(!tracked.is_ignored); assert!(ignored.is_ignored); }); } #[gpui::test(iterations = 30)] async fn test_create_directory(cx: &mut TestAppContext) { let client = cx.read(|cx| Client::new(FakeHttpClient::with_404_response(), cx)); let fs = FakeFs::new(cx.background()); fs.insert_tree( "/a", json!({ "b": {}, "c": {}, "d": {}, }), ) .await; let tree = Worktree::local( client, "/a".as_ref(), true, fs, Default::default(), &mut cx.to_async(), ) .await .unwrap(); let entry = tree .update(cx, |tree, cx| { tree.as_local_mut() .unwrap() .create_entry("a/e".as_ref(), true, cx) }) .await .unwrap(); assert!(entry.is_dir()); cx.foreground().run_until_parked(); tree.read_with(cx, |tree, _| { assert_eq!(tree.entry_for_path("a/e").unwrap().kind, EntryKind::Dir); }); } #[gpui::test(iterations = 100)] fn test_random(mut rng: StdRng) { let operations = env::var("OPERATIONS") .map(|o| o.parse().unwrap()) .unwrap_or(40); let initial_entries = env::var("INITIAL_ENTRIES") .map(|o| o.parse().unwrap()) .unwrap_or(20); let root_dir = tempdir::TempDir::new("worktree-test").unwrap(); for _ in 0..initial_entries { randomly_mutate_tree(root_dir.path(), 1.0, &mut rng).unwrap(); } log::info!("Generated initial tree"); let (notify_tx, _notify_rx) = mpsc::unbounded(); let fs = Arc::new(RealFs); let next_entry_id = Arc::new(AtomicUsize::new(0)); let mut initial_snapshot = LocalSnapshot { abs_path: root_dir.path().into(), removed_entry_ids: Default::default(), ignores_by_parent_abs_path: Default::default(), git_repositories: Default::default(), next_entry_id: next_entry_id.clone(), snapshot: Snapshot { id: WorktreeId::from_usize(0), entries_by_path: Default::default(), entries_by_id: Default::default(), root_name: Default::default(), root_char_bag: Default::default(), scan_id: 0, is_complete: true, }, extension_counts: Default::default(), }; initial_snapshot.insert_entry( Entry::new( Path::new("").into(), &smol::block_on(fs.metadata(root_dir.path())) .unwrap() .unwrap(), &next_entry_id, Default::default(), ), fs.as_ref(), ); let mut scanner = BackgroundScanner::new( Arc::new(Mutex::new(initial_snapshot.clone())), notify_tx, fs.clone(), Arc::new(gpui::executor::Background::new()), ); smol::block_on(scanner.scan_dirs()).unwrap(); scanner.snapshot().check_invariants(); let mut events = Vec::new(); let mut snapshots = Vec::new(); let mut mutations_len = operations; while mutations_len > 1 { if !events.is_empty() && rng.gen_bool(0.4) { let len = rng.gen_range(0..=events.len()); let to_deliver = events.drain(0..len).collect::>(); log::info!("Delivering events: {:#?}", to_deliver); smol::block_on(scanner.process_events(to_deliver)); scanner.snapshot().check_invariants(); } else { events.extend(randomly_mutate_tree(root_dir.path(), 0.6, &mut rng).unwrap()); mutations_len -= 1; } if rng.gen_bool(0.2) { snapshots.push(scanner.snapshot()); } } log::info!("Quiescing: {:#?}", events); smol::block_on(scanner.process_events(events)); scanner.snapshot().check_invariants(); let (notify_tx, _notify_rx) = mpsc::unbounded(); let mut new_scanner = BackgroundScanner::new( Arc::new(Mutex::new(initial_snapshot)), notify_tx, scanner.fs.clone(), scanner.executor.clone(), ); smol::block_on(new_scanner.scan_dirs()).unwrap(); assert_eq!( scanner.snapshot().to_vec(true), new_scanner.snapshot().to_vec(true) ); for mut prev_snapshot in snapshots { let include_ignored = rng.gen::(); if !include_ignored { let mut entries_by_path_edits = Vec::new(); let mut entries_by_id_edits = Vec::new(); for entry in prev_snapshot .entries_by_id .cursor::<()>() .filter(|e| e.is_ignored) { entries_by_path_edits.push(Edit::Remove(PathKey(entry.path.clone()))); entries_by_id_edits.push(Edit::Remove(entry.id)); } prev_snapshot .entries_by_path .edit(entries_by_path_edits, &()); prev_snapshot.entries_by_id.edit(entries_by_id_edits, &()); } let update = scanner .snapshot() .build_update(&prev_snapshot, 0, 0, include_ignored); prev_snapshot.apply_remote_update(update).unwrap(); assert_eq!( prev_snapshot.to_vec(true), scanner.snapshot().to_vec(include_ignored) ); } } fn randomly_mutate_tree( root_path: &Path, insertion_probability: f64, rng: &mut impl Rng, ) -> Result> { let root_path = root_path.canonicalize().unwrap(); let (dirs, files) = read_dir_recursive(root_path.clone()); let mut events = Vec::new(); let mut record_event = |path: PathBuf| { events.push(fsevent::Event { event_id: SystemTime::now() .duration_since(UNIX_EPOCH) .unwrap() .as_secs(), flags: fsevent::StreamFlags::empty(), path, }); }; if (files.is_empty() && dirs.len() == 1) || rng.gen_bool(insertion_probability) { let path = dirs.choose(rng).unwrap(); let new_path = path.join(gen_name(rng)); if rng.gen() { log::info!("Creating dir {:?}", new_path.strip_prefix(root_path)?); std::fs::create_dir(&new_path)?; } else { log::info!("Creating file {:?}", new_path.strip_prefix(root_path)?); std::fs::write(&new_path, "")?; } record_event(new_path); } else if rng.gen_bool(0.05) { let ignore_dir_path = dirs.choose(rng).unwrap(); let ignore_path = ignore_dir_path.join(&*GITIGNORE); let (subdirs, subfiles) = read_dir_recursive(ignore_dir_path.clone()); let files_to_ignore = { let len = rng.gen_range(0..=subfiles.len()); subfiles.choose_multiple(rng, len) }; let dirs_to_ignore = { let len = rng.gen_range(0..subdirs.len()); subdirs.choose_multiple(rng, len) }; let mut ignore_contents = String::new(); for path_to_ignore in files_to_ignore.chain(dirs_to_ignore) { writeln!( ignore_contents, "{}", path_to_ignore .strip_prefix(&ignore_dir_path)? .to_str() .unwrap() ) .unwrap(); } log::info!( "Creating {:?} with contents:\n{}", ignore_path.strip_prefix(&root_path)?, ignore_contents ); std::fs::write(&ignore_path, ignore_contents).unwrap(); record_event(ignore_path); } else { let old_path = { let file_path = files.choose(rng); let dir_path = dirs[1..].choose(rng); file_path.into_iter().chain(dir_path).choose(rng).unwrap() }; let is_rename = rng.gen(); if is_rename { let new_path_parent = dirs .iter() .filter(|d| !d.starts_with(old_path)) .choose(rng) .unwrap(); let overwrite_existing_dir = !old_path.starts_with(&new_path_parent) && rng.gen_bool(0.3); let new_path = if overwrite_existing_dir { std::fs::remove_dir_all(&new_path_parent).ok(); new_path_parent.to_path_buf() } else { new_path_parent.join(gen_name(rng)) }; log::info!( "Renaming {:?} to {}{:?}", old_path.strip_prefix(&root_path)?, if overwrite_existing_dir { "overwrite " } else { "" }, new_path.strip_prefix(&root_path)? ); std::fs::rename(&old_path, &new_path)?; record_event(old_path.clone()); record_event(new_path); } else if old_path.is_dir() { let (dirs, files) = read_dir_recursive(old_path.clone()); log::info!("Deleting dir {:?}", old_path.strip_prefix(&root_path)?); std::fs::remove_dir_all(&old_path).unwrap(); for file in files { record_event(file); } for dir in dirs { record_event(dir); } } else { log::info!("Deleting file {:?}", old_path.strip_prefix(&root_path)?); std::fs::remove_file(old_path).unwrap(); record_event(old_path.clone()); } } Ok(events) } fn read_dir_recursive(path: PathBuf) -> (Vec, Vec) { let child_entries = std::fs::read_dir(&path).unwrap(); let mut dirs = vec![path]; let mut files = Vec::new(); for child_entry in child_entries { let child_path = child_entry.unwrap().path(); if child_path.is_dir() { let (child_dirs, child_files) = read_dir_recursive(child_path); dirs.extend(child_dirs); files.extend(child_files); } else { files.push(child_path); } } (dirs, files) } fn gen_name(rng: &mut impl Rng) -> String { (0..6) .map(|_| rng.sample(rand::distributions::Alphanumeric)) .map(char::from) .collect() } impl LocalSnapshot { fn check_invariants(&self) { let mut files = self.files(true, 0); let mut visible_files = self.files(false, 0); for entry in self.entries_by_path.cursor::<()>() { if entry.is_file() { assert_eq!(files.next().unwrap().inode, entry.inode); if !entry.is_ignored { assert_eq!(visible_files.next().unwrap().inode, entry.inode); } } } assert!(files.next().is_none()); assert!(visible_files.next().is_none()); let mut bfs_paths = Vec::new(); let mut stack = vec![Path::new("")]; while let Some(path) = stack.pop() { bfs_paths.push(path); let ix = stack.len(); for child_entry in self.child_entries(path) { stack.insert(ix, &child_entry.path); } } let dfs_paths_via_iter = self .entries_by_path .cursor::<()>() .map(|e| e.path.as_ref()) .collect::>(); assert_eq!(bfs_paths, dfs_paths_via_iter); let dfs_paths_via_traversal = self .entries(true) .map(|e| e.path.as_ref()) .collect::>(); assert_eq!(dfs_paths_via_traversal, dfs_paths_via_iter); for ignore_parent_abs_path in self.ignores_by_parent_abs_path.keys() { let ignore_parent_path = ignore_parent_abs_path.strip_prefix(&self.abs_path).unwrap(); assert!(self.entry_for_path(&ignore_parent_path).is_some()); assert!(self .entry_for_path(ignore_parent_path.join(&*GITIGNORE)) .is_some()); } // Ensure extension counts are correct. let mut expected_extension_counts = HashMap::default(); for extension in self.entries(false).filter_map(|e| e.path.extension()) { *expected_extension_counts .entry(extension.into()) .or_insert(0) += 1; } assert_eq!(self.extension_counts, expected_extension_counts); } fn to_vec(&self, include_ignored: bool) -> Vec<(&Path, u64, bool)> { let mut paths = Vec::new(); for entry in self.entries_by_path.cursor::<()>() { if include_ignored || !entry.is_ignored { paths.push((entry.path.as_ref(), entry.inode, entry.is_ignored)); } } paths.sort_by(|a, b| a.0.cmp(b.0)); paths } } }