mod char_bag; mod fuzzy; mod ignore; use self::{char_bag::CharBag, ignore::IgnoreStack}; use crate::{ editor::{Buffer, History, Rope}, language::LanguageRegistry, rpc::{self, proto, ConnectionId}, sum_tree::{self, Cursor, Edit, SumTree}, time::ReplicaId, util::Bias, }; use ::ignore::gitignore::Gitignore; use anyhow::{anyhow, Context, Result}; pub use fuzzy::{match_paths, PathMatch}; use gpui::{ scoped_pool, AppContext, Entity, ModelContext, ModelHandle, MutableAppContext, Task, WeakModelHandle, }; use lazy_static::lazy_static; use parking_lot::Mutex; use postage::{ prelude::{Sink, Stream}, watch, }; use smol::channel::Sender; use std::{ cmp, collections::{HashMap, HashSet}, ffi::{OsStr, OsString}, fmt, fs, future::Future, io::{self, Read, Write}, ops::Deref, os::unix::fs::MetadataExt, path::{Path, PathBuf}, sync::Arc, time::{Duration, SystemTime, UNIX_EPOCH}, }; lazy_static! { static ref GITIGNORE: &'static OsStr = OsStr::new(".gitignore"); } #[derive(Clone, Debug)] enum ScanState { Idle(Option), Scanning, Err(Arc), } pub enum Worktree { Local(LocalWorktree), Remote(RemoteWorktree), } impl Entity for Worktree { type Event = Diff; } impl Worktree { pub fn local(path: impl Into>, cx: &mut ModelContext) -> Self { Worktree::Local(LocalWorktree::new(path, cx)) } pub fn remote( id: u64, worktree: proto::Worktree, rpc: rpc::Client, connection_id: ConnectionId, replica_id: ReplicaId, cx: &mut ModelContext, ) -> Self { Worktree::Remote(RemoteWorktree::new( id, worktree, rpc, connection_id, replica_id, cx, )) } pub fn as_local(&self) -> Option<&LocalWorktree> { if let Worktree::Local(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 snapshot(&self) -> Snapshot { match self { Worktree::Local(worktree) => worktree.snapshot(), Worktree::Remote(worktree) => worktree.snapshot.clone(), } } pub fn open_buffer( &mut self, path: impl AsRef, language_registry: Arc, cx: &mut ModelContext, ) -> Task>> { match self { Worktree::Local(worktree) => worktree.open_buffer(path.as_ref(), language_registry, cx), Worktree::Remote(worktree) => { worktree.open_buffer(path.as_ref(), language_registry, cx) } } } pub fn save( &self, path: &Path, content: Rope, cx: &mut ModelContext, ) -> impl Future> { match self { Worktree::Local(worktree) => worktree.save(path, content, cx), Worktree::Remote(_) => todo!(), } } } impl Deref for Worktree { type Target = Snapshot; fn deref(&self) -> &Self::Target { match self { Worktree::Local(worktree) => &worktree.snapshot, Worktree::Remote(worktree) => &worktree.snapshot, } } } pub struct LocalWorktree { snapshot: Snapshot, background_snapshot: Arc>, scan_state: (watch::Sender, watch::Receiver), _event_stream_handle: fsevent::Handle, poll_scheduled: bool, rpc: Option, open_buffers: HashMap>, } impl LocalWorktree { fn new(path: impl Into>, cx: &mut ModelContext) -> Self { let abs_path = path.into(); let (scan_state_tx, scan_state_rx) = smol::channel::unbounded(); let id = cx.model_id(); let snapshot = Snapshot { id, scan_id: 0, abs_path, root_name: Default::default(), root_char_bag: Default::default(), ignores: Default::default(), entries: Default::default(), }; let (event_stream, event_stream_handle) = fsevent::EventStream::new(&[snapshot.abs_path.as_ref()], Duration::from_millis(100)); let background_snapshot = Arc::new(Mutex::new(snapshot.clone())); let tree = Self { snapshot, background_snapshot: background_snapshot.clone(), open_buffers: Default::default(), scan_state: watch::channel_with(ScanState::Scanning), _event_stream_handle: event_stream_handle, poll_scheduled: false, rpc: None, }; std::thread::spawn(move || { let scanner = BackgroundScanner::new(background_snapshot, scan_state_tx, id); scanner.run(event_stream) }); cx.spawn(|this, mut cx| { let this = this.downgrade(); async move { while let Ok(scan_state) = scan_state_rx.recv().await { let alive = cx.update(|cx| { if let Some(handle) = this.upgrade(&cx) { handle.update(cx, |this, cx| { if let Worktree::Local(worktree) = this { worktree.observe_scan_state(scan_state, cx) } else { unreachable!() } }); true } else { false } }); if !alive { break; } } } }) .detach(); tree } pub fn open_buffer( &mut self, path: &Path, language_registry: Arc, cx: &mut ModelContext, ) -> Task>> { let handle = cx.handle(); // If there is already a buffer for the given path, then return it. let mut existing_buffer = None; self.open_buffers.retain(|_buffer_id, buffer| { if let Some(buffer) = buffer.upgrade(cx.as_ref()) { if let Some(file) = buffer.read(cx.as_ref()).file() { if file.worktree_id() == handle.id() && file.path.as_ref() == path { existing_buffer = Some(buffer); } } true } else { false } }); let path = Arc::from(path); cx.spawn(|this, mut cx| async move { if let Some(existing_buffer) = existing_buffer { Ok(existing_buffer) } else { let contents = this .read_with(&cx, |this, cx| { this.as_local().unwrap().load(&path, cx.as_ref()) }) .await?; let language = language_registry.select_language(&path).cloned(); let file = File::new(handle, path.into()); let buffer = cx.add_model(|cx| { Buffer::from_history(0, History::new(contents.into()), Some(file), language, cx) }); this.update(&mut cx, |this, _| { let this = this.as_local_mut().unwrap(); this.open_buffers.insert(buffer.id(), buffer.downgrade()); }); Ok(buffer) } }) } pub fn scan_complete(&self) -> impl Future { let mut scan_state_rx = self.scan_state.1.clone(); async move { let mut scan_state = Some(scan_state_rx.borrow().clone()); while let Some(ScanState::Scanning) = scan_state { scan_state = scan_state_rx.recv().await; } } } fn observe_scan_state(&mut self, mut scan_state: ScanState, cx: &mut ModelContext) { let diff = if let ScanState::Idle(diff) = &mut scan_state { diff.take() } else { None }; self.scan_state.0.blocking_send(scan_state).ok(); self.poll_snapshot(cx); if let Some(diff) = diff { self.observe_snapshot_diff(diff, cx); } } fn observe_snapshot_diff(&mut self, diff: Diff, cx: &mut ModelContext) { let handle = cx.handle(); self.open_buffers.retain(|_buffer_id, buffer| { if let Some(buffer) = buffer.upgrade(cx.as_ref()) { buffer.update(cx, |buffer, cx| { let handle = handle.clone(); if let Some(file) = buffer.file() { let mut path = file.path.clone(); if let Some(new_path) = diff.moved.get(&path) { buffer.file_was_moved(new_path.clone(), cx); path = new_path.clone(); } else if diff.added.contains(&path) { buffer.file_was_added(cx); } else if diff.removed.contains(&path) { buffer.file_was_deleted(cx); } if diff.modified.contains(&path) { cx.spawn(|buffer, mut cx| async move { let new_contents = handle .read_with(&cx, |this, cx| { let this = this.as_local().unwrap(); this.load(&path, cx) }) .await?; let mtime = handle.read_with(&cx, |this, _| { let this = this.as_local().unwrap(); this.entry_for_path(&path).map(|entry| entry.mtime) }); if let Some(mtime) = mtime { buffer.update(&mut cx, |buffer, cx| { buffer.file_was_modified(new_contents, mtime, cx) }); } Result::<_, anyhow::Error>::Ok(()) }) .detach(); } } }); true } else { false } }); cx.emit(diff); } fn poll_snapshot(&mut self, cx: &mut ModelContext) { self.snapshot = self.background_snapshot.lock().clone(); cx.notify(); if self.is_scanning() && !self.poll_scheduled { cx.spawn(|this, mut cx| async move { smol::Timer::after(Duration::from_millis(100)).await; this.update(&mut cx, |this, cx| { let worktree = this.as_local_mut().unwrap(); worktree.poll_scheduled = false; worktree.poll_snapshot(cx); }) }) .detach(); self.poll_scheduled = true; } } fn is_scanning(&self) -> bool { if let ScanState::Scanning = *self.scan_state.1.borrow() { true } else { false } } pub fn snapshot(&self) -> Snapshot { self.snapshot.clone() } pub fn abs_path(&self) -> &Path { self.snapshot.abs_path.as_ref() } pub fn contains_abs_path(&self, path: &Path) -> bool { path.starts_with(&self.snapshot.abs_path) } fn absolutize(&self, path: &Path) -> PathBuf { if path.file_name().is_some() { self.snapshot.abs_path.join(path) } else { self.snapshot.abs_path.to_path_buf() } } fn load(&self, path: &Path, cx: &AppContext) -> Task> { let abs_path = self.absolutize(path); cx.background_executor().spawn(async move { let mut file = fs::File::open(&abs_path)?; let mut contents = String::new(); file.read_to_string(&mut contents)?; Result::<_, anyhow::Error>::Ok(contents) }) } pub fn save( &self, path: impl Into>, content: Rope, cx: &mut ModelContext, ) -> Task> { let path = path.into(); let abs_path = self.absolutize(&path); let background_snapshot = self.background_snapshot.clone(); let save = { let path = path.clone(); cx.background_executor().spawn(async move { let buffer_size = content.summary().bytes.min(10 * 1024); let file = fs::File::create(&abs_path)?; let mut writer = io::BufWriter::with_capacity(buffer_size, &file); for chunk in content.chunks() { writer.write(chunk.as_bytes())?; } writer.flush()?; // Eagerly populate the snapshot with an updated entry for the saved file let root_char_bag = background_snapshot.lock().root_char_bag; let entry = fs_entry_for_path(root_char_bag, path, &abs_path)? .ok_or_else(|| anyhow!("could not read saved file metadata"))?; let added = background_snapshot.lock().entries.replace(entry, &()); Ok::(added) }) }; cx.spawn(|worktree, mut cx| async move { let added = save.await?; worktree.update(&mut cx, |worktree, cx| { let worktree = worktree.as_local_mut().unwrap(); worktree.poll_snapshot(cx); let mut diff = Diff::default(); if added { diff.added.insert(path.clone()); } diff.modified.insert(path); worktree.observe_snapshot_diff(diff, cx) }); Ok(()) }) } pub fn share( &mut self, client: rpc::Client, connection_id: ConnectionId, cx: &mut ModelContext, ) -> Task> { self.rpc = Some(client.clone()); let root_name = self.root_name.clone(); let snapshot = self.snapshot(); let handle = cx.handle(); cx.spawn(|_this, cx| async move { let entries = cx .background_executor() .spawn(async move { snapshot .entries .cursor::<(), ()>() .map(|entry| proto::Entry { is_dir: entry.is_dir(), path: entry.path.to_string_lossy().to_string(), inode: entry.inode, mtime: Some(entry.mtime.into()), is_symlink: entry.is_symlink, is_ignored: entry.is_ignored, }) .collect() }) .await; let share_response = client .request( connection_id, proto::ShareWorktree { worktree: Some(proto::Worktree { root_name, entries }), }, ) .await?; client .state .lock() .await .shared_worktrees .insert(share_response.worktree_id, handle); log::info!("sharing worktree {:?}", share_response); Ok((share_response.worktree_id, share_response.access_token)) }) } } impl Deref for LocalWorktree { 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) } } pub struct RemoteWorktree { remote_id: u64, snapshot: Snapshot, rpc: rpc::Client, connection_id: ConnectionId, replica_id: ReplicaId, open_buffers: HashMap>, } impl RemoteWorktree { fn new( remote_id: u64, worktree: proto::Worktree, rpc: rpc::Client, connection_id: ConnectionId, replica_id: ReplicaId, cx: &mut ModelContext, ) -> Self { let root_char_bag: CharBag = worktree .root_name .chars() .map(|c| c.to_ascii_lowercase()) .collect(); let mut entries = SumTree::new(); entries.extend( worktree.entries.into_iter().filter_map(|entry| { let kind = if entry.is_dir { EntryKind::Dir } else { let mut char_bag = root_char_bag.clone(); char_bag.extend(entry.path.chars().map(|c| c.to_ascii_lowercase())); EntryKind::File(char_bag) }; if let Some(mtime) = entry.mtime { Some(Entry { kind, path: Path::new(&entry.path).into(), inode: entry.inode, mtime: mtime.into(), is_symlink: entry.is_symlink, is_ignored: entry.is_ignored, }) } else { log::warn!("missing mtime in worktree entry message"); None } }), &(), ); let snapshot = Snapshot { id: cx.model_id(), scan_id: 0, abs_path: Path::new("").into(), root_name: worktree.root_name, root_char_bag, ignores: Default::default(), entries, }; Self { remote_id, snapshot, rpc, connection_id, replica_id, open_buffers: Default::default(), } } pub fn open_buffer( &mut self, path: &Path, language_registry: Arc, cx: &mut ModelContext, ) -> Task>> { let handle = cx.handle(); let mut existing_buffer = None; self.open_buffers.retain(|_buffer_id, buffer| { if let Some(buffer) = buffer.upgrade(cx.as_ref()) { if let Some(file) = buffer.read(cx.as_ref()).file() { if file.worktree_id() == handle.id() && file.path.as_ref() == path { existing_buffer = Some(buffer); } } true } else { false } }); let rpc = self.rpc.clone(); let replica_id = self.replica_id; let connection_id = self.connection_id; let remote_worktree_id = self.remote_id; let path = path.to_string_lossy().to_string(); cx.spawn(|this, mut cx| async move { if let Some(existing_buffer) = existing_buffer { Ok(existing_buffer) } else { let file = File::new(handle, Path::new(&path).into()); let language = language_registry.select_language(&path).cloned(); let response = rpc .request( connection_id, proto::OpenBuffer { worktree_id: remote_worktree_id as u64, path, }, ) .await?; let buffer_id = response.buffer_id; let remote_buffer = response.buffer.ok_or_else(|| anyhow!("empty buffer"))?; let buffer = cx.add_model(|cx| { Buffer::from_proto(replica_id, remote_buffer, Some(file), language, cx).unwrap() }); this.update(&mut cx, |this, _| { let this = this.as_remote_mut().unwrap(); this.open_buffers.insert(buffer_id, buffer.downgrade()); }); Ok(buffer) } }) } } #[derive(Clone)] pub struct Snapshot { id: usize, scan_id: usize, abs_path: Arc, root_name: String, root_char_bag: CharBag, ignores: HashMap, (Arc, usize)>, entries: SumTree, } impl Snapshot { pub fn file_count(&self) -> usize { self.entries.summary().file_count } pub fn visible_file_count(&self) -> usize { self.entries.summary().visible_file_count } pub fn files(&self, start: usize) -> FileIter { FileIter::all(self, start) } pub fn paths(&self) -> impl Iterator> { self.entries .cursor::<(), ()>() .skip(1) .map(|entry| entry.path()) } pub fn visible_files(&self, start: usize) -> FileIter { FileIter::visible(self, start) } fn child_entries<'a>(&'a self, path: &'a Path) -> ChildEntriesIter<'a> { ChildEntriesIter::new(path, self) } pub fn root_entry(&self) -> &Entry { self.entry_for_path("").unwrap() } /// Returns the filename of the snapshot's root, plus a trailing slash if the snapshot's root is /// a directory. pub fn root_name(&self) -> &str { &self.root_name } fn path_is_pending(&self, path: impl AsRef) -> bool { if self.entries.is_empty() { return true; } let path = path.as_ref(); let mut cursor = self.entries.cursor::<_, ()>(); if cursor.seek(&PathSearch::Exact(path), Bias::Left, &()) { let entry = cursor.item().unwrap(); if entry.path.as_ref() == path { return matches!(entry.kind, EntryKind::PendingDir); } } if let Some(entry) = cursor.prev_item() { matches!(entry.kind, EntryKind::PendingDir) && path.starts_with(entry.path.as_ref()) } else { false } } fn entry_for_path(&self, path: impl AsRef) -> Option<&Entry> { let mut cursor = self.entries.cursor::<_, ()>(); if cursor.seek(&PathSearch::Exact(path.as_ref()), Bias::Left, &()) { cursor.item() } else { None } } pub fn inode_for_path(&self, path: impl AsRef) -> Option { self.entry_for_path(path.as_ref()).map(|e| e.inode()) } fn insert_entry(&mut self, entry: Entry) { if !entry.is_dir() && entry.path().file_name() == Some(&GITIGNORE) { let (ignore, err) = Gitignore::new(self.abs_path.join(entry.path())); if let Some(err) = err { log::error!("error in ignore file {:?} - {:?}", entry.path(), err); } let ignore_dir_path = entry.path().parent().unwrap(); self.ignores .insert(ignore_dir_path.into(), (Arc::new(ignore), self.scan_id)); } self.entries.insert(entry, &()); } fn populate_dir( &mut self, parent_path: Arc, entries: impl IntoIterator, ignore: Option>, ) { let mut edits = Vec::new(); let mut parent_entry = self .entries .get(&PathKey(parent_path.clone()), &()) .unwrap() .clone(); if let Some(ignore) = ignore { self.ignores.insert(parent_path, (ignore, self.scan_id)); } if matches!(parent_entry.kind, EntryKind::PendingDir) { parent_entry.kind = EntryKind::Dir; } else { unreachable!(); } edits.push(Edit::Insert(parent_entry)); for entry in entries { edits.push(Edit::Insert(entry)); } self.entries.edit(edits, &()); } fn remove_path(&mut self, path: &Path) { let new_entries = { let mut cursor = self.entries.cursor::<_, ()>(); let mut new_entries = cursor.slice(&PathSearch::Exact(path), Bias::Left, &()); cursor.seek_forward(&PathSearch::Successor(path), Bias::Left, &()); new_entries.push_tree(cursor.suffix(&()), &()); new_entries }; self.entries = new_entries; if path.file_name() == Some(&GITIGNORE) { if let Some((_, scan_id)) = self.ignores.get_mut(path.parent().unwrap()) { *scan_id = self.scan_id; } } } fn ignore_stack_for_path(&self, path: &Path, is_dir: bool) -> Arc { let mut new_ignores = Vec::new(); for ancestor in path.ancestors().skip(1) { if let Some((ignore, _)) = self.ignores.get(ancestor) { new_ignores.push((ancestor, Some(ignore.clone()))); } else { new_ignores.push((ancestor, None)); } } let mut ignore_stack = IgnoreStack::none(); for (parent_path, ignore) in new_ignores.into_iter().rev() { if ignore_stack.is_path_ignored(&parent_path, true) { ignore_stack = IgnoreStack::all(); break; } else if let Some(ignore) = ignore { ignore_stack = ignore_stack.append(Arc::from(parent_path), ignore); } } if ignore_stack.is_path_ignored(path, is_dir) { ignore_stack = IgnoreStack::all(); } ignore_stack } fn diff(&self, old: &Self) -> Diff { let mut new = self.entries.cursor::<(), ()>().peekable(); let mut old = old.entries.cursor::<(), ()>().peekable(); let mut diff = Diff::default(); let mut removed = HashMap::new(); let mut added = HashMap::new(); loop { match (new.peek().copied(), old.peek().copied()) { (Some(new_entry), Some(old_entry)) => match new_entry.path.cmp(&old_entry.path) { cmp::Ordering::Equal => { if new_entry.mtime > old_entry.mtime { diff.modified.insert(new_entry.path.clone()); } new.next(); old.next(); } cmp::Ordering::Less => { added.insert(new_entry.inode, new_entry); diff.added.insert(new_entry.path.clone()); new.next(); } cmp::Ordering::Greater => { removed.insert(&old_entry.path, old_entry); diff.removed.insert(old_entry.path.clone()); old.next(); } }, (Some(new_entry), None) => { added.insert(new_entry.inode, new_entry); diff.added.insert(new_entry.path.clone()); new.next(); } (None, Some(old_entry)) => { removed.insert(&old_entry.path, old_entry); diff.removed.insert(old_entry.path.clone()); old.next(); } (None, None) => break, } } for (removed_path, removed_entry) in removed { if let Some(added_entry) = added.remove(&removed_entry.inode) { diff.removed.remove(removed_path); diff.added.remove(&added_entry.path); diff.moved .insert(removed_path.clone(), added_entry.path.clone()); if added_entry.mtime > removed_entry.mtime { diff.modified.insert(added_entry.path.clone()); } } } diff } } impl fmt::Debug for Snapshot { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { for entry in self.entries.cursor::<(), ()>() { for _ in entry.path().ancestors().skip(1) { write!(f, " ")?; } writeln!(f, "{:?} (inode: {})", entry.path(), entry.inode())?; } Ok(()) } } #[derive(Clone, Default, Debug, PartialEq)] pub struct Diff { pub moved: HashMap, Arc>, pub removed: HashSet>, pub added: HashSet>, pub modified: HashSet>, } #[derive(Clone, PartialEq)] pub struct File { worktree: ModelHandle, pub path: Arc, } impl File { pub fn new(worktree: ModelHandle, path: Arc) -> Self { Self { worktree, path } } pub fn saved_buffer(&self, buffer: ModelHandle, cx: &mut MutableAppContext) { self.worktree.update(cx, |worktree, _| { if let Worktree::Local(worktree) = worktree { worktree .open_buffers .insert(buffer.id(), buffer.downgrade()); } }) } /// Returns this file's path relative to the root of its worktree. pub fn path(&self) -> Arc { self.path.clone() } /// 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. pub fn file_name<'a>(&'a self, cx: &'a AppContext) -> Option { self.path .file_name() .or_else(|| Some(OsStr::new(self.worktree.read(cx).root_name()))) .map(Into::into) } pub fn is_deleted(&self, cx: &AppContext) -> bool { let snapshot = self.worktree.read(cx).snapshot(); snapshot.entry_for_path(&self.path).is_none() && !snapshot.path_is_pending(&self.path) } pub fn exists(&self, cx: &AppContext) -> bool { !self.is_deleted(cx) } pub fn mtime(&self, cx: &AppContext) -> SystemTime { let snapshot = self.worktree.read(cx).snapshot(); snapshot .entry_for_path(&self.path) .map_or(UNIX_EPOCH, |entry| entry.mtime) } pub fn save( &self, content: Rope, cx: &mut MutableAppContext, ) -> impl Future> { self.worktree .update(cx, |worktree, cx| worktree.save(&self.path(), content, cx)) } pub fn worktree_id(&self) -> usize { self.worktree.id() } pub fn entry_id(&self) -> (usize, Arc) { (self.worktree.id(), self.path()) } } #[derive(Clone, Debug)] pub struct Entry { kind: EntryKind, path: Arc, inode: u64, mtime: SystemTime, is_symlink: bool, is_ignored: bool, } #[derive(Clone, Debug)] pub enum EntryKind { PendingDir, Dir, File(CharBag), } impl Entry { pub fn path(&self) -> &Arc { &self.path } pub fn inode(&self) -> u64 { self.inode } pub fn is_ignored(&self) -> bool { self.is_ignored } fn is_dir(&self) -> bool { matches!(self.kind, EntryKind::Dir | EntryKind::PendingDir) } 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 file_count; let visible_file_count; if self.is_file() { file_count = 1; if self.is_ignored { visible_file_count = 0; } else { visible_file_count = 1; } } else { file_count = 0; visible_file_count = 0; } EntrySummary { max_path: self.path().clone(), 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, file_count: usize, visible_file_count: usize, } impl Default for EntrySummary { fn default() -> Self { Self { max_path: Arc::from(Path::new("")), 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.file_count += rhs.file_count; self.visible_file_count += rhs.visible_file_count; } } #[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(); } } #[derive(Copy, Clone, Debug, PartialEq, Eq)] enum PathSearch<'a> { Exact(&'a Path), Successor(&'a Path), } impl<'a> Ord for PathSearch<'a> { fn cmp(&self, other: &Self) -> cmp::Ordering { match (self, other) { (Self::Exact(a), Self::Exact(b)) => a.cmp(b), (Self::Successor(a), Self::Exact(b)) => { if b.starts_with(a) { cmp::Ordering::Greater } else { a.cmp(b) } } _ => todo!("not sure we need the other two cases"), } } } impl<'a> PartialOrd for PathSearch<'a> { fn partial_cmp(&self, other: &Self) -> Option { Some(self.cmp(other)) } } impl<'a> Default for PathSearch<'a> { fn default() -> Self { Self::Exact(Path::new("").into()) } } impl<'a: 'b, 'b> sum_tree::Dimension<'a, EntrySummary> for PathSearch<'b> { fn add_summary(&mut self, summary: &'a EntrySummary, _: &()) { *self = Self::Exact(summary.max_path.as_ref()); } } #[derive(Copy, Clone, Default, Debug, Eq, PartialEq, Ord, PartialOrd)] pub struct FileCount(usize); impl<'a> sum_tree::Dimension<'a, EntrySummary> for FileCount { fn add_summary(&mut self, summary: &'a EntrySummary, _: &()) { self.0 += summary.file_count; } } #[derive(Copy, Clone, Default, Debug, Eq, PartialEq, Ord, PartialOrd)] pub struct VisibleFileCount(usize); impl<'a> sum_tree::Dimension<'a, EntrySummary> for VisibleFileCount { fn add_summary(&mut self, summary: &'a EntrySummary, _: &()) { self.0 += summary.visible_file_count; } } struct BackgroundScanner { snapshot: Arc>, notify: Sender, thread_pool: scoped_pool::Pool, } impl BackgroundScanner { fn new(snapshot: Arc>, notify: Sender, worktree_id: usize) -> Self { Self { snapshot, notify, thread_pool: scoped_pool::Pool::new(16, format!("worktree-{}-scanner", worktree_id)), } } fn abs_path(&self) -> Arc { self.snapshot.lock().abs_path.clone() } fn snapshot(&self) -> Snapshot { self.snapshot.lock().clone() } fn run(mut self, event_stream: fsevent::EventStream) { if smol::block_on(self.notify.send(ScanState::Scanning)).is_err() { return; } if let Err(err) = self.scan_dirs() { if smol::block_on(self.notify.send(ScanState::Err(Arc::new(err)))).is_err() { return; } } if smol::block_on(self.notify.send(ScanState::Idle(None))).is_err() { return; } event_stream.run(move |events| { if smol::block_on(self.notify.send(ScanState::Scanning)).is_err() { return false; } let prev_snapshot = self.snapshot.lock().clone(); if !self.process_events(events) { return false; } let diff = self.snapshot.lock().diff(&prev_snapshot); if smol::block_on(self.notify.send(ScanState::Idle(Some(diff)))).is_err() { return false; } true }); } fn scan_dirs(&mut self) -> io::Result<()> { self.snapshot.lock().scan_id += 1; let path: Arc = Arc::from(Path::new("")); let abs_path = self.abs_path(); let metadata = fs::metadata(&abs_path)?; let inode = metadata.ino(); let is_symlink = fs::symlink_metadata(&abs_path)?.file_type().is_symlink(); let is_dir = metadata.file_type().is_dir(); let mtime = metadata.modified()?; // 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 mut root_name = abs_path .file_name() .map_or(String::new(), |f| f.to_string_lossy().to_string()); if is_dir { root_name.push('/'); } let root_char_bag = root_name.chars().map(|c| c.to_ascii_lowercase()).collect(); { let mut snapshot = self.snapshot.lock(); snapshot.root_name = root_name; snapshot.root_char_bag = root_char_bag; } if is_dir { self.snapshot.lock().insert_entry(Entry { kind: EntryKind::PendingDir, path: path.clone(), inode, mtime, is_symlink, is_ignored: false, }); let (tx, rx) = crossbeam_channel::unbounded(); tx.send(ScanJob { abs_path: abs_path.to_path_buf(), path, ignore_stack: IgnoreStack::none(), scan_queue: tx.clone(), }) .unwrap(); drop(tx); self.thread_pool.scoped(|pool| { for _ in 0..self.thread_pool.thread_count() { pool.execute(|| { while let Ok(job) = rx.recv() { if let Err(err) = self.scan_dir(root_char_bag, &job) { log::error!("error scanning {:?}: {}", job.abs_path, err); } } }); } }); } else { self.snapshot.lock().insert_entry(Entry { kind: EntryKind::File(char_bag_for_path(root_char_bag, &path)), path, inode, mtime, is_symlink, is_ignored: false, }); } Ok(()) } fn scan_dir(&self, root_char_bag: CharBag, job: &ScanJob) -> io::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; for child_entry in fs::read_dir(&job.abs_path)? { let child_entry = child_entry?; let child_name = child_entry.file_name(); let child_abs_path = job.abs_path.join(&child_name); let child_path: Arc = job.path.join(&child_name).into(); let child_is_symlink = child_entry.metadata()?.file_type().is_symlink(); let child_metadata = if let Ok(metadata) = fs::metadata(&child_abs_path) { metadata } else { log::error!("could not get metadata for path {:?}", child_abs_path); continue; }; let child_inode = child_metadata.ino(); let child_mtime = child_metadata.modified()?; // If we find a .gitignore, add it to the stack of ignores used to determine which paths are ignored if child_name == *GITIGNORE { let (ignore, err) = Gitignore::new(&child_abs_path); if let Some(err) = err { log::error!("error in ignore file {:?} - {:?}", child_path, err); } let ignore = Arc::new(ignore); ignore_stack = ignore_stack.append(job.path.clone(), ignore.clone()); new_ignore = Some(ignore); // 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 { entry.is_ignored = ignore_stack.is_path_ignored(&entry.path, entry.is_dir()); if entry.is_dir() { new_jobs.next().unwrap().ignore_stack = if entry.is_ignored { IgnoreStack::all() } else { ignore_stack.clone() }; } } } if child_metadata.is_dir() { let is_ignored = ignore_stack.is_path_ignored(&child_path, true); new_entries.push(Entry { kind: EntryKind::PendingDir, path: child_path.clone(), inode: child_inode, mtime: child_mtime, is_symlink: child_is_symlink, is_ignored, }); new_jobs.push(ScanJob { abs_path: child_abs_path, path: child_path, ignore_stack: if is_ignored { IgnoreStack::all() } else { ignore_stack.clone() }, scan_queue: job.scan_queue.clone(), }); } else { let is_ignored = ignore_stack.is_path_ignored(&child_path, false); new_entries.push(Entry { kind: EntryKind::File(char_bag_for_path(root_char_bag, &child_path)), path: child_path, inode: child_inode, mtime: child_mtime, is_symlink: child_is_symlink, is_ignored, }); }; } self.snapshot .lock() .populate_dir(job.path.clone(), new_entries, new_ignore); for new_job in new_jobs { job.scan_queue.send(new_job).unwrap(); } Ok(()) } fn process_events(&mut self, mut events: Vec) -> bool { let mut snapshot = self.snapshot(); snapshot.scan_id += 1; let root_abs_path = if let Ok(abs_path) = snapshot.abs_path.canonicalize() { abs_path } else { return false; }; let root_char_bag = snapshot.root_char_bag; events.sort_unstable_by(|a, b| a.path.cmp(&b.path)); let mut abs_paths = events.into_iter().map(|e| e.path).peekable(); let (scan_queue_tx, scan_queue_rx) = crossbeam_channel::unbounded(); while let Some(abs_path) = abs_paths.next() { let path = match abs_path.strip_prefix(&root_abs_path) { Ok(path) => Arc::from(path.to_path_buf()), Err(_) => { log::error!( "unexpected event {:?} for root path {:?}", abs_path, root_abs_path ); continue; } }; while abs_paths.peek().map_or(false, |p| p.starts_with(&abs_path)) { abs_paths.next(); } snapshot.remove_path(&path); match fs_entry_for_path(snapshot.root_char_bag, path.clone(), &abs_path) { Ok(Some(mut fs_entry)) => { let is_dir = fs_entry.is_dir(); let ignore_stack = snapshot.ignore_stack_for_path(&path, is_dir); fs_entry.is_ignored = ignore_stack.is_all(); snapshot.insert_entry(fs_entry); if is_dir { scan_queue_tx .send(ScanJob { abs_path, path, ignore_stack, 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); } } } *self.snapshot.lock() = snapshot; // Scan any directories that were created as part of this event batch. drop(scan_queue_tx); self.thread_pool.scoped(|pool| { for _ in 0..self.thread_pool.thread_count() { pool.execute(|| { while let Ok(job) = scan_queue_rx.recv() { if let Err(err) = self.scan_dir(root_char_bag, &job) { log::error!("error scanning {:?}: {}", job.abs_path, err); } } }); } }); self.update_ignore_statuses(); true } 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_path, (_, scan_id)) in &snapshot.ignores { if *scan_id == snapshot.scan_id && snapshot.entry_for_path(parent_path).is_some() { ignores_to_update.push(parent_path.clone()); } let ignore_path = parent_path.join(&*GITIGNORE); if snapshot.entry_for_path(ignore_path).is_none() { ignores_to_delete.push(parent_path.clone()); } } for parent_path in ignores_to_delete { snapshot.ignores.remove(&parent_path); self.snapshot.lock().ignores.remove(&parent_path); } let (ignore_queue_tx, ignore_queue_rx) = crossbeam_channel::unbounded(); ignores_to_update.sort_unstable(); let mut ignores_to_update = ignores_to_update.into_iter().peekable(); while let Some(parent_path) = ignores_to_update.next() { while ignores_to_update .peek() .map_or(false, |p| p.starts_with(&parent_path)) { ignores_to_update.next().unwrap(); } let ignore_stack = snapshot.ignore_stack_for_path(&parent_path, true); ignore_queue_tx .send(UpdateIgnoreStatusJob { path: parent_path, ignore_stack, ignore_queue: ignore_queue_tx.clone(), }) .unwrap(); } drop(ignore_queue_tx); self.thread_pool.scoped(|scope| { for _ in 0..self.thread_pool.thread_count() { scope.execute(|| { while let Ok(job) = ignore_queue_rx.recv() { self.update_ignore_status(job, &snapshot); } }); } }); } fn update_ignore_status(&self, job: UpdateIgnoreStatusJob, snapshot: &Snapshot) { let mut ignore_stack = job.ignore_stack; if let Some((ignore, _)) = snapshot.ignores.get(&job.path) { ignore_stack = ignore_stack.append(job.path.clone(), ignore.clone()); } let mut edits = Vec::new(); for mut entry in snapshot.child_entries(&job.path).cloned() { let was_ignored = entry.is_ignored; entry.is_ignored = ignore_stack.is_path_ignored(entry.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 { path: entry.path().clone(), ignore_stack: child_ignore_stack, ignore_queue: job.ignore_queue.clone(), }) .unwrap(); } if entry.is_ignored != was_ignored { edits.push(Edit::Insert(entry)); } } self.snapshot.lock().entries.edit(edits, &()); } } fn fs_entry_for_path( root_char_bag: CharBag, path: Arc, abs_path: &Path, ) -> Result> { let metadata = match fs::metadata(&abs_path) { Err(err) => { return match (err.kind(), err.raw_os_error()) { (io::ErrorKind::NotFound, _) => Ok(None), (io::ErrorKind::Other, Some(libc::ENOTDIR)) => Ok(None), _ => Err(anyhow::Error::new(err)), } } Ok(metadata) => metadata, }; let inode = metadata.ino(); let mtime = metadata.modified()?; let is_symlink = fs::symlink_metadata(&abs_path) .context("failed to read symlink metadata")? .file_type() .is_symlink(); let entry = Entry { kind: if metadata.file_type().is_dir() { EntryKind::PendingDir } else { EntryKind::File(char_bag_for_path(root_char_bag, &path)) }, path: Arc::from(path), inode, mtime, is_symlink, is_ignored: false, }; Ok(Some(entry)) } 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: crossbeam_channel::Sender, } struct UpdateIgnoreStatusJob { path: Arc, ignore_stack: Arc, ignore_queue: crossbeam_channel::Sender, } pub trait WorktreeHandle { fn file(&self, path: impl AsRef) -> File; #[cfg(test)] fn flush_fs_events<'a>( &self, cx: &'a gpui::TestAppContext, ) -> futures::future::LocalBoxFuture<'a, ()>; } impl WorktreeHandle for ModelHandle { fn file(&self, path: impl AsRef) -> File { let path = Arc::from(path.as_ref()); let handle = self.clone(); File::new(handle, path) } // 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(test)] fn flush_fs_events<'a>( &self, cx: &'a gpui::TestAppContext, ) -> futures::future::LocalBoxFuture<'a, ()> { use smol::future::FutureExt; let filename = "fs-event-sentinel"; let root_path = cx.read(|cx| self.read(cx).abs_path.clone()); let tree = self.clone(); async move { fs::write(root_path.join(filename), "").unwrap(); tree.condition(&cx, |tree, _| tree.entry_for_path(filename).is_some()) .await; fs::remove_file(root_path.join(filename)).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() } } pub enum FileIter<'a> { All(Cursor<'a, Entry, FileCount, FileCount>), Visible(Cursor<'a, Entry, VisibleFileCount, VisibleFileCount>), } impl<'a> FileIter<'a> { fn all(snapshot: &'a Snapshot, start: usize) -> Self { let mut cursor = snapshot.entries.cursor(); cursor.seek(&FileCount(start), Bias::Right, &()); Self::All(cursor) } fn visible(snapshot: &'a Snapshot, start: usize) -> Self { let mut cursor = snapshot.entries.cursor(); cursor.seek(&VisibleFileCount(start), Bias::Right, &()); Self::Visible(cursor) } fn next_internal(&mut self) { match self { Self::All(cursor) => { let ix = *cursor.start(); cursor.seek_forward(&FileCount(ix.0 + 1), Bias::Right, &()); } Self::Visible(cursor) => { let ix = *cursor.start(); cursor.seek_forward(&VisibleFileCount(ix.0 + 1), Bias::Right, &()); } } } fn item(&self) -> Option<&'a Entry> { match self { Self::All(cursor) => cursor.item(), Self::Visible(cursor) => cursor.item(), } } } impl<'a> Iterator for FileIter<'a> { type Item = &'a Entry; fn next(&mut self) -> Option { if let Some(entry) = self.item() { self.next_internal(); Some(entry) } else { None } } } struct ChildEntriesIter<'a> { parent_path: &'a Path, cursor: Cursor<'a, Entry, PathSearch<'a>, ()>, } impl<'a> ChildEntriesIter<'a> { fn new(parent_path: &'a Path, snapshot: &'a Snapshot) -> Self { let mut cursor = snapshot.entries.cursor(); cursor.seek(&PathSearch::Exact(parent_path), Bias::Right, &()); Self { parent_path, cursor, } } } impl<'a> Iterator for ChildEntriesIter<'a> { type Item = &'a Entry; fn next(&mut self) -> Option { if let Some(item) = self.cursor.item() { if item.path().starts_with(self.parent_path) { self.cursor .seek_forward(&PathSearch::Successor(item.path()), Bias::Left, &()); Some(item) } else { None } } else { None } } } #[cfg(test)] mod tests { use super::*; use crate::editor::Buffer; use crate::test::*; use anyhow::Result; use rand::prelude::*; use serde_json::json; use std::{cell::RefCell, env, fmt::Write, os::unix, rc::Rc, time::SystemTime}; #[gpui::test] async fn test_populate_and_search(mut cx: gpui::TestAppContext) { let dir = temp_tree(json!({ "root": { "apple": "", "banana": { "carrot": { "date": "", "endive": "", } }, "fennel": { "grape": "", } } })); let root_link_path = dir.path().join("root_link"); unix::fs::symlink(&dir.path().join("root"), &root_link_path).unwrap(); unix::fs::symlink( &dir.path().join("root/fennel"), &dir.path().join("root/finnochio"), ) .unwrap(); let tree = cx.add_model(|cx| Worktree::local(root_link_path, cx)); cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete()) .await; cx.read(|cx| { let tree = tree.read(cx); assert_eq!(tree.file_count(), 5); assert_eq!( tree.inode_for_path("fennel/grape"), tree.inode_for_path("finnochio/grape") ); let results = match_paths( Some(tree.snapshot()).iter(), "bna", false, false, false, 10, Default::default(), cx.thread_pool().clone(), ) .into_iter() .map(|result| result.path) .collect::>>(); assert_eq!( results, vec![ PathBuf::from("banana/carrot/date").into(), PathBuf::from("banana/carrot/endive").into(), ] ); }) } #[gpui::test] async fn test_save_file(mut cx: gpui::TestAppContext) { let dir = temp_tree(json!({ "file1": "the old contents", })); let tree = cx.add_model(|cx| Worktree::local(dir.path(), cx)); tree.read_with(&cx, |tree, _| tree.as_local().unwrap().scan_complete()) .await; let path = tree.read_with(&cx, |tree, _| { assert_eq!(tree.file_count(), 1); tree.files(0).next().unwrap().path().clone() }); assert_eq!(path.file_name().unwrap(), "file1"); let buffer = cx.add_model(|cx| Buffer::new(1, "a line of text.\n".repeat(10 * 1024), cx)); tree.update(&mut cx, |tree, cx| { let text = buffer.read(cx).snapshot().text(); tree.save(&path, text, cx) }) .await .unwrap(); let new_contents = fs::read_to_string(dir.path().join(path)).unwrap(); assert_eq!( new_contents, buffer.read_with(&cx, |buffer, _| buffer.text()) ); } #[gpui::test] async fn test_save_in_single_file_worktree(mut cx: gpui::TestAppContext) { let dir = temp_tree(json!({ "file1": "the old contents", })); let file_path = dir.path().join("file1"); let tree = cx.add_model(|cx| Worktree::local(file_path.clone(), cx)); cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete()) .await; cx.read(|cx| assert_eq!(tree.read(cx).file_count(), 1)); let buffer = cx.add_model(|cx| Buffer::new(1, "a line of text.\n".repeat(10 * 1024), cx)); let file = tree.file(""); cx.update(|cx| { assert_eq!(file.path().file_name(), None); let text = buffer.read(cx).snapshot().text(); file.save(text, cx) }) .await .unwrap(); let new_contents = fs::read_to_string(file_path).unwrap(); assert_eq!( new_contents, buffer.read_with(&cx, |buffer, _| buffer.text()) ); } #[gpui::test] async fn test_rescan_simple(mut cx: gpui::TestAppContext) { let dir = temp_tree(json!({ "a": { "file1": "", "file2": "", "file3": "", }, "b": { "c": { "file4": "", "file5": "", } } })); let language_registry = Arc::new(LanguageRegistry::new()); let tree = cx.add_model(|cx| Worktree::local(dir.path(), cx)); let mut buffer_for_path = |path: &'static str| { let buffer = tree.update(&mut cx, |tree, cx| { tree.open_buffer(path, language_registry.clone(), cx) }); async move { buffer.await.unwrap() } }; let buffer2 = buffer_for_path("a/file2").await; let buffer3 = buffer_for_path("a/file3").await; let buffer4 = buffer_for_path("b/c/file4").await; let buffer5 = buffer_for_path("b/c/file5").await; // After scanning, the worktree knows which files exist and which don't. cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete()) .await; cx.read(|cx| { assert!(!buffer2.read(cx).is_dirty(cx)); assert!(!buffer3.read(cx).is_dirty(cx)); assert!(!buffer4.read(cx).is_dirty(cx)); assert!(!buffer5.read(cx).is_dirty(cx)); }); tree.flush_fs_events(&cx).await; std::fs::rename(dir.path().join("a/file3"), dir.path().join("b/c/file3")).unwrap(); std::fs::remove_file(dir.path().join("b/c/file5")).unwrap(); std::fs::rename(dir.path().join("b/c"), dir.path().join("d")).unwrap(); std::fs::rename(dir.path().join("a/file2"), dir.path().join("a/file2.new")).unwrap(); tree.flush_fs_events(&cx).await; cx.read(|cx| { assert_eq!( tree.read(cx) .paths() .map(|p| p.to_str().unwrap()) .collect::>(), vec![ "a", "a/file1", "a/file2.new", "b", "d", "d/file3", "d/file4" ] ); assert_eq!( buffer2.read(cx).file().unwrap().path().as_ref(), Path::new("a/file2.new") ); assert_eq!( buffer3.read(cx).file().unwrap().path().as_ref(), Path::new("d/file3") ); assert_eq!( buffer4.read(cx).file().unwrap().path().as_ref(), Path::new("d/file4") ); assert_eq!( buffer5.read(cx).file().unwrap().path().as_ref(), Path::new("b/c/file5") ); assert!(!buffer2.read(cx).file().unwrap().is_deleted(cx)); assert!(!buffer3.read(cx).file().unwrap().is_deleted(cx)); assert!(!buffer4.read(cx).file().unwrap().is_deleted(cx)); assert!(buffer5.read(cx).file().unwrap().is_deleted(cx)); }); } #[gpui::test] async fn test_rescan_with_gitignore(mut cx: gpui::TestAppContext) { let dir = temp_tree(json!({ ".git": {}, ".gitignore": "ignored-dir\n", "tracked-dir": { "tracked-file1": "tracked contents", }, "ignored-dir": { "ignored-file1": "ignored contents", } })); let tree = cx.add_model(|cx| Worktree::local(dir.path(), cx)); 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); let tracked = tree.entry_for_path("tracked-dir/tracked-file1").unwrap(); let ignored = tree.entry_for_path("ignored-dir/ignored-file1").unwrap(); assert_eq!(tracked.is_ignored(), false); assert_eq!(ignored.is_ignored(), true); }); fs::write(dir.path().join("tracked-dir/tracked-file2"), "").unwrap(); fs::write(dir.path().join("ignored-dir/ignored-file2"), "").unwrap(); tree.flush_fs_events(&cx).await; cx.read(|cx| { let tree = tree.read(cx); let dot_git = tree.entry_for_path(".git").unwrap(); let tracked = tree.entry_for_path("tracked-dir/tracked-file2").unwrap(); let ignored = tree.entry_for_path("ignored-dir/ignored-file2").unwrap(); assert_eq!(tracked.is_ignored(), false); assert_eq!(ignored.is_ignored(), true); assert_eq!(dot_git.is_ignored(), true); }); } #[test] fn test_path_is_pending() { let mut snapshot = Snapshot { id: 0, scan_id: 0, abs_path: Path::new("").into(), entries: Default::default(), ignores: Default::default(), root_name: Default::default(), root_char_bag: Default::default(), }; snapshot.entries.edit( vec![ Edit::Insert(Entry { path: Path::new("b").into(), kind: EntryKind::Dir, inode: 0, mtime: UNIX_EPOCH, is_ignored: false, is_symlink: false, }), Edit::Insert(Entry { path: Path::new("b/a").into(), kind: EntryKind::Dir, inode: 0, mtime: UNIX_EPOCH, is_ignored: false, is_symlink: false, }), Edit::Insert(Entry { path: Path::new("b/c").into(), kind: EntryKind::PendingDir, inode: 0, mtime: UNIX_EPOCH, is_ignored: false, is_symlink: false, }), Edit::Insert(Entry { path: Path::new("b/e").into(), kind: EntryKind::Dir, inode: 0, mtime: UNIX_EPOCH, is_ignored: false, is_symlink: false, }), ], &(), ); assert!(!snapshot.path_is_pending("b/a")); assert!(!snapshot.path_is_pending("b/b")); assert!(snapshot.path_is_pending("b/c")); assert!(snapshot.path_is_pending("b/c/x")); assert!(!snapshot.path_is_pending("b/d")); assert!(!snapshot.path_is_pending("b/e")); } #[gpui::test] async fn test_file_change_events(mut cx: gpui::TestAppContext) { let dir = temp_tree(json!({ "dir_a": { "file1": "1", "file2": "2", "dir_b": { "file3": "3", } }, "dir_c": { "dir_d": { "file4": "4", "file5": "5", } } })); let root = dir.path(); let tree = cx.add_model(|cx| Worktree::local(root, cx)); cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete()) .await; tree.flush_fs_events(&cx).await; let events = Rc::new(RefCell::new(Vec::new())); tree.update(&mut cx, { let events = events.clone(); |_, cx| { cx.subscribe(&tree, move |_, event, _| { events.borrow_mut().push(event.clone()); }) } }); std::fs::remove_file(root.join("dir_a/file1")).unwrap(); std::fs::rename(root.join("dir_a/file2"), root.join("dir_c/file20")).unwrap(); std::fs::write(root.join("dir_c/dir_d/file4"), "modified 4").unwrap(); std::fs::write(root.join("dir_c/file10"), "hi").unwrap(); std::fs::rename( root.join("dir_c/dir_d/file5"), root.join("dir_c/dir_d/file50"), ) .unwrap(); std::fs::write(root.join("dir_c/dir_d/file50"), "modified after rename").unwrap(); tree.condition(&cx, |_, _| !events.borrow().is_empty()) .await; assert_eq!( *events.borrow(), &[Diff { moved: vec![ ( Path::new("dir_a/file2").into(), Path::new("dir_c/file20").into(), ), ( Path::new("dir_c/dir_d/file5").into(), Path::new("dir_c/dir_d/file50").into(), ) ] .into_iter() .collect(), added: vec![Path::new("dir_c/file10").into()].into_iter().collect(), removed: vec![Path::new("dir_a/file1").into()].into_iter().collect(), modified: vec![ Path::new("dir_c/dir_d/file4").into(), Path::new("dir_c/dir_d/file50").into() ] .into_iter() .collect(), }] ); } #[test] fn test_random() { let iterations = env::var("ITERATIONS") .map(|i| i.parse().unwrap()) .unwrap_or(100); 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 seeds = if let Ok(seed) = env::var("SEED").map(|s| s.parse().unwrap()) { seed..seed + 1 } else { 0..iterations }; for seed in seeds { dbg!(seed); let mut rng = StdRng::seed_from_u64(seed); let root_dir = tempdir::TempDir::new(&format!("test-{}", seed)).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) = smol::channel::unbounded(); let mut scanner = BackgroundScanner::new( Arc::new(Mutex::new(Snapshot { id: 0, scan_id: 0, abs_path: root_dir.path().into(), entries: Default::default(), ignores: Default::default(), root_name: Default::default(), root_char_bag: Default::default(), })), notify_tx, 0, ); scanner.scan_dirs().unwrap(); scanner.snapshot().check_invariants(); let mut events = 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); 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; } } log::info!("Quiescing: {:#?}", events); scanner.process_events(events); scanner.snapshot().check_invariants(); let (notify_tx, _notify_rx) = smol::channel::unbounded(); let mut new_scanner = BackgroundScanner::new( Arc::new(Mutex::new(Snapshot { id: 0, scan_id: 0, abs_path: root_dir.path().into(), entries: Default::default(), ignores: Default::default(), root_name: Default::default(), root_char_bag: Default::default(), })), notify_tx, 1, ); new_scanner.scan_dirs().unwrap(); assert_eq!(scanner.snapshot().to_vec(), new_scanner.snapshot().to_vec()); } } 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)?); fs::create_dir(&new_path)?; } else { log::info!("Creating file {:?}", new_path.strip_prefix(root_path)?); 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) { write!( ignore_contents, "{}\n", 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 ); 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 { 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)? ); 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)?); 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)?); fs::remove_file(old_path).unwrap(); record_event(old_path.clone()); } } Ok(events) } fn read_dir_recursive(path: PathBuf) -> (Vec, Vec) { let child_entries = 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 Snapshot { fn check_invariants(&self) { let mut files = self.files(0); let mut visible_files = self.visible_files(0); for entry in self.entries.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 = self .entries .cursor::<(), ()>() .map(|e| e.path().as_ref()) .collect::>(); assert_eq!(bfs_paths, dfs_paths); for (ignore_parent_path, _) in &self.ignores { assert!(self.entry_for_path(ignore_parent_path).is_some()); assert!(self .entry_for_path(ignore_parent_path.join(&*GITIGNORE)) .is_some()); } } fn to_vec(&self) -> Vec<(&Path, u64, bool)> { let mut paths = Vec::new(); for entry in self.entries.cursor::<(), ()>() { paths.push((entry.path().as_ref(), entry.inode(), entry.is_ignored())); } paths.sort_by(|a, b| a.0.cmp(&b.0)); paths } } }