1pub mod repository;
   2
   3use anyhow::{anyhow, Result};
   4use fsevent::EventStream;
   5use futures::{future::BoxFuture, Stream, StreamExt};
   6use git2::Repository as LibGitRepository;
   7use lazy_static::lazy_static;
   8use parking_lot::Mutex;
   9use regex::Regex;
  10use repository::GitRepository;
  11use rope::Rope;
  12use smol::io::{AsyncReadExt, AsyncWriteExt};
  13use std::borrow::Cow;
  14use std::cmp;
  15use std::io::Write;
  16use std::sync::Arc;
  17use std::{
  18    io,
  19    os::unix::fs::MetadataExt,
  20    path::{Component, Path, PathBuf},
  21    pin::Pin,
  22    time::{Duration, SystemTime},
  23};
  24use tempfile::NamedTempFile;
  25use util::ResultExt;
  26
  27#[cfg(any(test, feature = "test-support"))]
  28use collections::{btree_map, BTreeMap};
  29#[cfg(any(test, feature = "test-support"))]
  30use repository::{FakeGitRepositoryState, GitFileStatus};
  31#[cfg(any(test, feature = "test-support"))]
  32use std::sync::Weak;
  33
  34lazy_static! {
  35    static ref LINE_SEPERATORS_REGEX: Regex = Regex::new("\r\n|\r|\u{2028}|\u{2029}").unwrap();
  36}
  37
  38#[derive(Clone, Copy, Debug, PartialEq)]
  39pub enum LineEnding {
  40    Unix,
  41    Windows,
  42}
  43
  44impl Default for LineEnding {
  45    fn default() -> Self {
  46        #[cfg(unix)]
  47        return Self::Unix;
  48
  49        #[cfg(not(unix))]
  50        return Self::CRLF;
  51    }
  52}
  53
  54impl LineEnding {
  55    pub fn as_str(&self) -> &'static str {
  56        match self {
  57            LineEnding::Unix => "\n",
  58            LineEnding::Windows => "\r\n",
  59        }
  60    }
  61
  62    pub fn detect(text: &str) -> Self {
  63        let mut max_ix = cmp::min(text.len(), 1000);
  64        while !text.is_char_boundary(max_ix) {
  65            max_ix -= 1;
  66        }
  67
  68        if let Some(ix) = text[..max_ix].find(&['\n']) {
  69            if ix > 0 && text.as_bytes()[ix - 1] == b'\r' {
  70                Self::Windows
  71            } else {
  72                Self::Unix
  73            }
  74        } else {
  75            Self::default()
  76        }
  77    }
  78
  79    pub fn normalize(text: &mut String) {
  80        if let Cow::Owned(replaced) = LINE_SEPERATORS_REGEX.replace_all(text, "\n") {
  81            *text = replaced;
  82        }
  83    }
  84
  85    pub fn normalize_arc(text: Arc<str>) -> Arc<str> {
  86        if let Cow::Owned(replaced) = LINE_SEPERATORS_REGEX.replace_all(&text, "\n") {
  87            replaced.into()
  88        } else {
  89            text
  90        }
  91    }
  92}
  93
  94#[async_trait::async_trait]
  95pub trait Fs: Send + Sync {
  96    async fn create_dir(&self, path: &Path) -> Result<()>;
  97    async fn create_file(&self, path: &Path, options: CreateOptions) -> Result<()>;
  98    async fn copy_file(&self, source: &Path, target: &Path, options: CopyOptions) -> Result<()>;
  99    async fn rename(&self, source: &Path, target: &Path, options: RenameOptions) -> Result<()>;
 100    async fn remove_dir(&self, path: &Path, options: RemoveOptions) -> Result<()>;
 101    async fn remove_file(&self, path: &Path, options: RemoveOptions) -> Result<()>;
 102    async fn open_sync(&self, path: &Path) -> Result<Box<dyn io::Read>>;
 103    async fn load(&self, path: &Path) -> Result<String>;
 104    async fn atomic_write(&self, path: PathBuf, text: String) -> Result<()>;
 105    async fn save(&self, path: &Path, text: &Rope, line_ending: LineEnding) -> Result<()>;
 106    async fn canonicalize(&self, path: &Path) -> Result<PathBuf>;
 107    async fn is_file(&self, path: &Path) -> bool;
 108    async fn metadata(&self, path: &Path) -> Result<Option<Metadata>>;
 109    async fn read_dir(
 110        &self,
 111        path: &Path,
 112    ) -> Result<Pin<Box<dyn Send + Stream<Item = Result<PathBuf>>>>>;
 113    async fn watch(
 114        &self,
 115        path: &Path,
 116        latency: Duration,
 117    ) -> Pin<Box<dyn Send + Stream<Item = Vec<fsevent::Event>>>>;
 118    fn open_repo(&self, abs_dot_git: &Path) -> Option<Arc<Mutex<dyn GitRepository>>>;
 119    fn is_fake(&self) -> bool;
 120    #[cfg(any(test, feature = "test-support"))]
 121    fn as_fake(&self) -> &FakeFs;
 122}
 123
 124#[derive(Copy, Clone, Default)]
 125pub struct CreateOptions {
 126    pub overwrite: bool,
 127    pub ignore_if_exists: bool,
 128}
 129
 130#[derive(Copy, Clone, Default)]
 131pub struct CopyOptions {
 132    pub overwrite: bool,
 133    pub ignore_if_exists: bool,
 134}
 135
 136#[derive(Copy, Clone, Default)]
 137pub struct RenameOptions {
 138    pub overwrite: bool,
 139    pub ignore_if_exists: bool,
 140}
 141
 142#[derive(Copy, Clone, Default)]
 143pub struct RemoveOptions {
 144    pub recursive: bool,
 145    pub ignore_if_not_exists: bool,
 146}
 147
 148#[derive(Clone, Debug)]
 149pub struct Metadata {
 150    pub inode: u64,
 151    pub mtime: SystemTime,
 152    pub is_symlink: bool,
 153    pub is_dir: bool,
 154}
 155
 156impl From<lsp::CreateFileOptions> for CreateOptions {
 157    fn from(options: lsp::CreateFileOptions) -> Self {
 158        Self {
 159            overwrite: options.overwrite.unwrap_or(false),
 160            ignore_if_exists: options.ignore_if_exists.unwrap_or(false),
 161        }
 162    }
 163}
 164
 165impl From<lsp::RenameFileOptions> for RenameOptions {
 166    fn from(options: lsp::RenameFileOptions) -> Self {
 167        Self {
 168            overwrite: options.overwrite.unwrap_or(false),
 169            ignore_if_exists: options.ignore_if_exists.unwrap_or(false),
 170        }
 171    }
 172}
 173
 174impl From<lsp::DeleteFileOptions> for RemoveOptions {
 175    fn from(options: lsp::DeleteFileOptions) -> Self {
 176        Self {
 177            recursive: options.recursive.unwrap_or(false),
 178            ignore_if_not_exists: options.ignore_if_not_exists.unwrap_or(false),
 179        }
 180    }
 181}
 182
 183pub struct RealFs;
 184
 185#[async_trait::async_trait]
 186impl Fs for RealFs {
 187    async fn create_dir(&self, path: &Path) -> Result<()> {
 188        Ok(smol::fs::create_dir_all(path).await?)
 189    }
 190
 191    async fn create_file(&self, path: &Path, options: CreateOptions) -> Result<()> {
 192        let mut open_options = smol::fs::OpenOptions::new();
 193        open_options.write(true).create(true);
 194        if options.overwrite {
 195            open_options.truncate(true);
 196        } else if !options.ignore_if_exists {
 197            open_options.create_new(true);
 198        }
 199        open_options.open(path).await?;
 200        Ok(())
 201    }
 202
 203    async fn copy_file(&self, source: &Path, target: &Path, options: CopyOptions) -> Result<()> {
 204        if !options.overwrite && smol::fs::metadata(target).await.is_ok() {
 205            if options.ignore_if_exists {
 206                return Ok(());
 207            } else {
 208                return Err(anyhow!("{target:?} already exists"));
 209            }
 210        }
 211
 212        smol::fs::copy(source, target).await?;
 213        Ok(())
 214    }
 215
 216    async fn rename(&self, source: &Path, target: &Path, options: RenameOptions) -> Result<()> {
 217        if !options.overwrite && smol::fs::metadata(target).await.is_ok() {
 218            if options.ignore_if_exists {
 219                return Ok(());
 220            } else {
 221                return Err(anyhow!("{target:?} already exists"));
 222            }
 223        }
 224
 225        smol::fs::rename(source, target).await?;
 226        Ok(())
 227    }
 228
 229    async fn remove_dir(&self, path: &Path, options: RemoveOptions) -> Result<()> {
 230        let result = if options.recursive {
 231            smol::fs::remove_dir_all(path).await
 232        } else {
 233            smol::fs::remove_dir(path).await
 234        };
 235        match result {
 236            Ok(()) => Ok(()),
 237            Err(err) if err.kind() == io::ErrorKind::NotFound && options.ignore_if_not_exists => {
 238                Ok(())
 239            }
 240            Err(err) => Err(err)?,
 241        }
 242    }
 243
 244    async fn remove_file(&self, path: &Path, options: RemoveOptions) -> Result<()> {
 245        match smol::fs::remove_file(path).await {
 246            Ok(()) => Ok(()),
 247            Err(err) if err.kind() == io::ErrorKind::NotFound && options.ignore_if_not_exists => {
 248                Ok(())
 249            }
 250            Err(err) => Err(err)?,
 251        }
 252    }
 253
 254    async fn open_sync(&self, path: &Path) -> Result<Box<dyn io::Read>> {
 255        Ok(Box::new(std::fs::File::open(path)?))
 256    }
 257
 258    async fn load(&self, path: &Path) -> Result<String> {
 259        let mut file = smol::fs::File::open(path).await?;
 260        let mut text = String::new();
 261        file.read_to_string(&mut text).await?;
 262        Ok(text)
 263    }
 264
 265    async fn atomic_write(&self, path: PathBuf, data: String) -> Result<()> {
 266        smol::unblock(move || {
 267            let mut tmp_file = NamedTempFile::new()?;
 268            tmp_file.write_all(data.as_bytes())?;
 269            tmp_file.persist(path)?;
 270            Ok::<(), anyhow::Error>(())
 271        })
 272        .await?;
 273
 274        Ok(())
 275    }
 276
 277    async fn save(&self, path: &Path, text: &Rope, line_ending: LineEnding) -> Result<()> {
 278        let buffer_size = text.summary().len.min(10 * 1024);
 279        let file = smol::fs::File::create(path).await?;
 280        let mut writer = smol::io::BufWriter::with_capacity(buffer_size, file);
 281        for chunk in chunks(text, line_ending) {
 282            writer.write_all(chunk.as_bytes()).await?;
 283        }
 284        writer.flush().await?;
 285        Ok(())
 286    }
 287
 288    async fn canonicalize(&self, path: &Path) -> Result<PathBuf> {
 289        Ok(smol::fs::canonicalize(path).await?)
 290    }
 291
 292    async fn is_file(&self, path: &Path) -> bool {
 293        smol::fs::metadata(path)
 294            .await
 295            .map_or(false, |metadata| metadata.is_file())
 296    }
 297
 298    async fn metadata(&self, path: &Path) -> Result<Option<Metadata>> {
 299        let symlink_metadata = match smol::fs::symlink_metadata(path).await {
 300            Ok(metadata) => metadata,
 301            Err(err) => {
 302                return match (err.kind(), err.raw_os_error()) {
 303                    (io::ErrorKind::NotFound, _) => Ok(None),
 304                    (io::ErrorKind::Other, Some(libc::ENOTDIR)) => Ok(None),
 305                    _ => Err(anyhow::Error::new(err)),
 306                }
 307            }
 308        };
 309
 310        let is_symlink = symlink_metadata.file_type().is_symlink();
 311        let metadata = if is_symlink {
 312            smol::fs::metadata(path).await?
 313        } else {
 314            symlink_metadata
 315        };
 316        Ok(Some(Metadata {
 317            inode: metadata.ino(),
 318            mtime: metadata.modified().unwrap(),
 319            is_symlink,
 320            is_dir: metadata.file_type().is_dir(),
 321        }))
 322    }
 323
 324    async fn read_dir(
 325        &self,
 326        path: &Path,
 327    ) -> Result<Pin<Box<dyn Send + Stream<Item = Result<PathBuf>>>>> {
 328        let result = smol::fs::read_dir(path).await?.map(|entry| match entry {
 329            Ok(entry) => Ok(entry.path()),
 330            Err(error) => Err(anyhow!("failed to read dir entry {:?}", error)),
 331        });
 332        Ok(Box::pin(result))
 333    }
 334
 335    async fn watch(
 336        &self,
 337        path: &Path,
 338        latency: Duration,
 339    ) -> Pin<Box<dyn Send + Stream<Item = Vec<fsevent::Event>>>> {
 340        let (tx, rx) = smol::channel::unbounded();
 341        let (stream, handle) = EventStream::new(&[path], latency);
 342        std::thread::spawn(move || {
 343            stream.run(move |events| smol::block_on(tx.send(events)).is_ok());
 344        });
 345        Box::pin(rx.chain(futures::stream::once(async move {
 346            drop(handle);
 347            vec![]
 348        })))
 349    }
 350
 351    fn open_repo(&self, dotgit_path: &Path) -> Option<Arc<Mutex<dyn GitRepository>>> {
 352        LibGitRepository::open(&dotgit_path)
 353            .log_err()
 354            .and_then::<Arc<Mutex<dyn GitRepository>>, _>(|libgit_repository| {
 355                Some(Arc::new(Mutex::new(libgit_repository)))
 356            })
 357    }
 358
 359    fn is_fake(&self) -> bool {
 360        false
 361    }
 362    #[cfg(any(test, feature = "test-support"))]
 363    fn as_fake(&self) -> &FakeFs {
 364        panic!("called `RealFs::as_fake`")
 365    }
 366}
 367
 368#[cfg(any(test, feature = "test-support"))]
 369pub struct FakeFs {
 370    // Use an unfair lock to ensure tests are deterministic.
 371    state: Mutex<FakeFsState>,
 372    executor: Weak<gpui::executor::Background>,
 373}
 374
 375#[cfg(any(test, feature = "test-support"))]
 376struct FakeFsState {
 377    root: Arc<Mutex<FakeFsEntry>>,
 378    next_inode: u64,
 379    next_mtime: SystemTime,
 380    event_txs: Vec<smol::channel::Sender<Vec<fsevent::Event>>>,
 381    events_paused: bool,
 382    buffered_events: Vec<fsevent::Event>,
 383}
 384
 385#[cfg(any(test, feature = "test-support"))]
 386#[derive(Debug)]
 387enum FakeFsEntry {
 388    File {
 389        inode: u64,
 390        mtime: SystemTime,
 391        content: String,
 392    },
 393    Dir {
 394        inode: u64,
 395        mtime: SystemTime,
 396        entries: BTreeMap<String, Arc<Mutex<FakeFsEntry>>>,
 397        git_repo_state: Option<Arc<Mutex<repository::FakeGitRepositoryState>>>,
 398    },
 399    Symlink {
 400        target: PathBuf,
 401    },
 402}
 403
 404#[cfg(any(test, feature = "test-support"))]
 405impl FakeFsState {
 406    fn read_path<'a>(&'a self, target: &Path) -> Result<Arc<Mutex<FakeFsEntry>>> {
 407        Ok(self
 408            .try_read_path(target)
 409            .ok_or_else(|| anyhow!("path does not exist: {}", target.display()))?
 410            .0)
 411    }
 412
 413    fn try_read_path<'a>(&'a self, target: &Path) -> Option<(Arc<Mutex<FakeFsEntry>>, PathBuf)> {
 414        let mut path = target.to_path_buf();
 415        let mut real_path = PathBuf::new();
 416        let mut entry_stack = Vec::new();
 417        'outer: loop {
 418            let mut path_components = path.components().collect::<collections::VecDeque<_>>();
 419            while let Some(component) = path_components.pop_front() {
 420                match component {
 421                    Component::Prefix(_) => panic!("prefix paths aren't supported"),
 422                    Component::RootDir => {
 423                        entry_stack.clear();
 424                        entry_stack.push(self.root.clone());
 425                        real_path.clear();
 426                        real_path.push("/");
 427                    }
 428                    Component::CurDir => {}
 429                    Component::ParentDir => {
 430                        entry_stack.pop()?;
 431                        real_path.pop();
 432                    }
 433                    Component::Normal(name) => {
 434                        let current_entry = entry_stack.last().cloned()?;
 435                        let current_entry = current_entry.lock();
 436                        if let FakeFsEntry::Dir { entries, .. } = &*current_entry {
 437                            let entry = entries.get(name.to_str().unwrap()).cloned()?;
 438                            let _entry = entry.lock();
 439                            if let FakeFsEntry::Symlink { target, .. } = &*_entry {
 440                                let mut target = target.clone();
 441                                target.extend(path_components);
 442                                path = target;
 443                                continue 'outer;
 444                            } else {
 445                                entry_stack.push(entry.clone());
 446                                real_path.push(name);
 447                            }
 448                        } else {
 449                            return None;
 450                        }
 451                    }
 452                }
 453            }
 454            break;
 455        }
 456        entry_stack.pop().map(|entry| (entry, real_path))
 457    }
 458
 459    fn write_path<Fn, T>(&self, path: &Path, callback: Fn) -> Result<T>
 460    where
 461        Fn: FnOnce(btree_map::Entry<String, Arc<Mutex<FakeFsEntry>>>) -> Result<T>,
 462    {
 463        let path = normalize_path(path);
 464        let filename = path
 465            .file_name()
 466            .ok_or_else(|| anyhow!("cannot overwrite the root"))?;
 467        let parent_path = path.parent().unwrap();
 468
 469        let parent = self.read_path(parent_path)?;
 470        let mut parent = parent.lock();
 471        let new_entry = parent
 472            .dir_entries(parent_path)?
 473            .entry(filename.to_str().unwrap().into());
 474        callback(new_entry)
 475    }
 476
 477    fn emit_event<I, T>(&mut self, paths: I)
 478    where
 479        I: IntoIterator<Item = T>,
 480        T: Into<PathBuf>,
 481    {
 482        self.buffered_events
 483            .extend(paths.into_iter().map(|path| fsevent::Event {
 484                event_id: 0,
 485                flags: fsevent::StreamFlags::empty(),
 486                path: path.into(),
 487            }));
 488
 489        if !self.events_paused {
 490            self.flush_events(self.buffered_events.len());
 491        }
 492    }
 493
 494    fn flush_events(&mut self, mut count: usize) {
 495        count = count.min(self.buffered_events.len());
 496        let events = self.buffered_events.drain(0..count).collect::<Vec<_>>();
 497        self.event_txs.retain(|tx| {
 498            let _ = tx.try_send(events.clone());
 499            !tx.is_closed()
 500        });
 501    }
 502}
 503
 504#[cfg(any(test, feature = "test-support"))]
 505impl FakeFs {
 506    pub fn new(executor: Arc<gpui::executor::Background>) -> Arc<Self> {
 507        Arc::new(Self {
 508            executor: Arc::downgrade(&executor),
 509            state: Mutex::new(FakeFsState {
 510                root: Arc::new(Mutex::new(FakeFsEntry::Dir {
 511                    inode: 0,
 512                    mtime: SystemTime::UNIX_EPOCH,
 513                    entries: Default::default(),
 514                    git_repo_state: None,
 515                })),
 516                next_mtime: SystemTime::UNIX_EPOCH,
 517                next_inode: 1,
 518                event_txs: Default::default(),
 519                buffered_events: Vec::new(),
 520                events_paused: false,
 521            }),
 522        })
 523    }
 524
 525    pub async fn insert_file(&self, path: impl AsRef<Path>, content: String) {
 526        self.write_file_internal(path, content).unwrap()
 527    }
 528
 529    pub async fn insert_symlink(&self, path: impl AsRef<Path>, target: PathBuf) {
 530        let mut state = self.state.lock();
 531        let path = path.as_ref();
 532        let file = Arc::new(Mutex::new(FakeFsEntry::Symlink { target }));
 533        state
 534            .write_path(path.as_ref(), move |e| match e {
 535                btree_map::Entry::Vacant(e) => {
 536                    e.insert(file);
 537                    Ok(())
 538                }
 539                btree_map::Entry::Occupied(mut e) => {
 540                    *e.get_mut() = file;
 541                    Ok(())
 542                }
 543            })
 544            .unwrap();
 545        state.emit_event(&[path]);
 546    }
 547
 548    fn write_file_internal(&self, path: impl AsRef<Path>, content: String) -> Result<()> {
 549        let mut state = self.state.lock();
 550        let path = path.as_ref();
 551        let inode = state.next_inode;
 552        let mtime = state.next_mtime;
 553        state.next_inode += 1;
 554        state.next_mtime += Duration::from_nanos(1);
 555        let file = Arc::new(Mutex::new(FakeFsEntry::File {
 556            inode,
 557            mtime,
 558            content,
 559        }));
 560        state.write_path(path, move |entry| {
 561            match entry {
 562                btree_map::Entry::Vacant(e) => {
 563                    e.insert(file);
 564                }
 565                btree_map::Entry::Occupied(mut e) => {
 566                    *e.get_mut() = file;
 567                }
 568            }
 569            Ok(())
 570        })?;
 571        state.emit_event(&[path]);
 572        Ok(())
 573    }
 574
 575    pub fn pause_events(&self) {
 576        self.state.lock().events_paused = true;
 577    }
 578
 579    pub fn buffered_event_count(&self) -> usize {
 580        self.state.lock().buffered_events.len()
 581    }
 582
 583    pub fn flush_events(&self, count: usize) {
 584        self.state.lock().flush_events(count);
 585    }
 586
 587    #[must_use]
 588    pub fn insert_tree<'a>(
 589        &'a self,
 590        path: impl 'a + AsRef<Path> + Send,
 591        tree: serde_json::Value,
 592    ) -> futures::future::BoxFuture<'a, ()> {
 593        use futures::FutureExt as _;
 594        use serde_json::Value::*;
 595
 596        async move {
 597            let path = path.as_ref();
 598
 599            match tree {
 600                Object(map) => {
 601                    self.create_dir(path).await.unwrap();
 602                    for (name, contents) in map {
 603                        let mut path = PathBuf::from(path);
 604                        path.push(name);
 605                        self.insert_tree(&path, contents).await;
 606                    }
 607                }
 608                Null => {
 609                    self.create_dir(path).await.unwrap();
 610                }
 611                String(contents) => {
 612                    self.insert_file(&path, contents).await;
 613                }
 614                _ => {
 615                    panic!("JSON object must contain only objects, strings, or null");
 616                }
 617            }
 618        }
 619        .boxed()
 620    }
 621
 622    pub fn with_git_state<F>(&self, dot_git: &Path, f: F)
 623    where
 624        F: FnOnce(&mut FakeGitRepositoryState),
 625    {
 626        let mut state = self.state.lock();
 627        let entry = state.read_path(dot_git).unwrap();
 628        let mut entry = entry.lock();
 629
 630        if let FakeFsEntry::Dir { git_repo_state, .. } = &mut *entry {
 631            let repo_state = git_repo_state.get_or_insert_with(Default::default);
 632            let mut repo_state = repo_state.lock();
 633
 634            f(&mut repo_state);
 635
 636            state.emit_event([dot_git]);
 637        } else {
 638            panic!("not a directory");
 639        }
 640    }
 641
 642    pub async fn set_branch_name(&self, dot_git: &Path, branch: Option<impl Into<String>>) {
 643        self.with_git_state(dot_git, |state| state.branch_name = branch.map(Into::into))
 644    }
 645
 646    pub async fn set_index_for_repo(&self, dot_git: &Path, head_state: &[(&Path, String)]) {
 647        self.with_git_state(dot_git, |state| {
 648            state.index_contents.clear();
 649            state.index_contents.extend(
 650                head_state
 651                    .iter()
 652                    .map(|(path, content)| (path.to_path_buf(), content.clone())),
 653            );
 654        });
 655    }
 656
 657    pub async fn set_status_for_repo(&self, dot_git: &Path, statuses: &[(&Path, GitFileStatus)]) {
 658        self.with_git_state(dot_git, |state| {
 659            state.worktree_statuses.clear();
 660            state.worktree_statuses.extend(
 661                statuses
 662                    .iter()
 663                    .map(|(path, content)| ((**path).into(), content.clone())),
 664            );
 665        });
 666    }
 667
 668    pub fn paths(&self) -> Vec<PathBuf> {
 669        let mut result = Vec::new();
 670        let mut queue = collections::VecDeque::new();
 671        queue.push_back((PathBuf::from("/"), self.state.lock().root.clone()));
 672        while let Some((path, entry)) = queue.pop_front() {
 673            if let FakeFsEntry::Dir { entries, .. } = &*entry.lock() {
 674                for (name, entry) in entries {
 675                    queue.push_back((path.join(name), entry.clone()));
 676                }
 677            }
 678            result.push(path);
 679        }
 680        result
 681    }
 682
 683    pub fn directories(&self) -> Vec<PathBuf> {
 684        let mut result = Vec::new();
 685        let mut queue = collections::VecDeque::new();
 686        queue.push_back((PathBuf::from("/"), self.state.lock().root.clone()));
 687        while let Some((path, entry)) = queue.pop_front() {
 688            if let FakeFsEntry::Dir { entries, .. } = &*entry.lock() {
 689                for (name, entry) in entries {
 690                    queue.push_back((path.join(name), entry.clone()));
 691                }
 692                result.push(path);
 693            }
 694        }
 695        result
 696    }
 697
 698    pub fn files(&self) -> Vec<PathBuf> {
 699        let mut result = Vec::new();
 700        let mut queue = collections::VecDeque::new();
 701        queue.push_back((PathBuf::from("/"), self.state.lock().root.clone()));
 702        while let Some((path, entry)) = queue.pop_front() {
 703            let e = entry.lock();
 704            match &*e {
 705                FakeFsEntry::File { .. } => result.push(path),
 706                FakeFsEntry::Dir { entries, .. } => {
 707                    for (name, entry) in entries {
 708                        queue.push_back((path.join(name), entry.clone()));
 709                    }
 710                }
 711                FakeFsEntry::Symlink { .. } => {}
 712            }
 713        }
 714        result
 715    }
 716
 717    async fn simulate_random_delay(&self) {
 718        self.executor
 719            .upgrade()
 720            .expect("executor has been dropped")
 721            .simulate_random_delay()
 722            .await;
 723    }
 724}
 725
 726#[cfg(any(test, feature = "test-support"))]
 727impl FakeFsEntry {
 728    fn is_file(&self) -> bool {
 729        matches!(self, Self::File { .. })
 730    }
 731
 732    fn file_content(&self, path: &Path) -> Result<&String> {
 733        if let Self::File { content, .. } = self {
 734            Ok(content)
 735        } else {
 736            Err(anyhow!("not a file: {}", path.display()))
 737        }
 738    }
 739
 740    fn set_file_content(&mut self, path: &Path, new_content: String) -> Result<()> {
 741        if let Self::File { content, mtime, .. } = self {
 742            *mtime = SystemTime::now();
 743            *content = new_content;
 744            Ok(())
 745        } else {
 746            Err(anyhow!("not a file: {}", path.display()))
 747        }
 748    }
 749
 750    fn dir_entries(
 751        &mut self,
 752        path: &Path,
 753    ) -> Result<&mut BTreeMap<String, Arc<Mutex<FakeFsEntry>>>> {
 754        if let Self::Dir { entries, .. } = self {
 755            Ok(entries)
 756        } else {
 757            Err(anyhow!("not a directory: {}", path.display()))
 758        }
 759    }
 760}
 761
 762#[cfg(any(test, feature = "test-support"))]
 763#[async_trait::async_trait]
 764impl Fs for FakeFs {
 765    async fn create_dir(&self, path: &Path) -> Result<()> {
 766        self.simulate_random_delay().await;
 767
 768        let mut created_dirs = Vec::new();
 769        let mut cur_path = PathBuf::new();
 770        for component in path.components() {
 771            let mut state = self.state.lock();
 772            cur_path.push(component);
 773            if cur_path == Path::new("/") {
 774                continue;
 775            }
 776
 777            let inode = state.next_inode;
 778            let mtime = state.next_mtime;
 779            state.next_mtime += Duration::from_nanos(1);
 780            state.next_inode += 1;
 781            state.write_path(&cur_path, |entry| {
 782                entry.or_insert_with(|| {
 783                    created_dirs.push(cur_path.clone());
 784                    Arc::new(Mutex::new(FakeFsEntry::Dir {
 785                        inode,
 786                        mtime,
 787                        entries: Default::default(),
 788                        git_repo_state: None,
 789                    }))
 790                });
 791                Ok(())
 792            })?
 793        }
 794
 795        self.state.lock().emit_event(&created_dirs);
 796        Ok(())
 797    }
 798
 799    async fn create_file(&self, path: &Path, options: CreateOptions) -> Result<()> {
 800        self.simulate_random_delay().await;
 801        let mut state = self.state.lock();
 802        let inode = state.next_inode;
 803        let mtime = state.next_mtime;
 804        state.next_mtime += Duration::from_nanos(1);
 805        state.next_inode += 1;
 806        let file = Arc::new(Mutex::new(FakeFsEntry::File {
 807            inode,
 808            mtime,
 809            content: String::new(),
 810        }));
 811        state.write_path(path, |entry| {
 812            match entry {
 813                btree_map::Entry::Occupied(mut e) => {
 814                    if options.overwrite {
 815                        *e.get_mut() = file;
 816                    } else if !options.ignore_if_exists {
 817                        return Err(anyhow!("path already exists: {}", path.display()));
 818                    }
 819                }
 820                btree_map::Entry::Vacant(e) => {
 821                    e.insert(file);
 822                }
 823            }
 824            Ok(())
 825        })?;
 826        state.emit_event(&[path]);
 827        Ok(())
 828    }
 829
 830    async fn rename(&self, old_path: &Path, new_path: &Path, options: RenameOptions) -> Result<()> {
 831        self.simulate_random_delay().await;
 832
 833        let old_path = normalize_path(old_path);
 834        let new_path = normalize_path(new_path);
 835
 836        let mut state = self.state.lock();
 837        let moved_entry = state.write_path(&old_path, |e| {
 838            if let btree_map::Entry::Occupied(e) = e {
 839                Ok(e.get().clone())
 840            } else {
 841                Err(anyhow!("path does not exist: {}", &old_path.display()))
 842            }
 843        })?;
 844
 845        state.write_path(&new_path, |e| {
 846            match e {
 847                btree_map::Entry::Occupied(mut e) => {
 848                    if options.overwrite {
 849                        *e.get_mut() = moved_entry;
 850                    } else if !options.ignore_if_exists {
 851                        return Err(anyhow!("path already exists: {}", new_path.display()));
 852                    }
 853                }
 854                btree_map::Entry::Vacant(e) => {
 855                    e.insert(moved_entry);
 856                }
 857            }
 858            Ok(())
 859        })?;
 860
 861        state
 862            .write_path(&old_path, |e| {
 863                if let btree_map::Entry::Occupied(e) = e {
 864                    Ok(e.remove())
 865                } else {
 866                    unreachable!()
 867                }
 868            })
 869            .unwrap();
 870
 871        state.emit_event(&[old_path, new_path]);
 872        Ok(())
 873    }
 874
 875    async fn copy_file(&self, source: &Path, target: &Path, options: CopyOptions) -> Result<()> {
 876        self.simulate_random_delay().await;
 877
 878        let source = normalize_path(source);
 879        let target = normalize_path(target);
 880        let mut state = self.state.lock();
 881        let mtime = state.next_mtime;
 882        let inode = util::post_inc(&mut state.next_inode);
 883        state.next_mtime += Duration::from_nanos(1);
 884        let source_entry = state.read_path(&source)?;
 885        let content = source_entry.lock().file_content(&source)?.clone();
 886        let entry = state.write_path(&target, |e| match e {
 887            btree_map::Entry::Occupied(e) => {
 888                if options.overwrite {
 889                    Ok(Some(e.get().clone()))
 890                } else if !options.ignore_if_exists {
 891                    return Err(anyhow!("{target:?} already exists"));
 892                } else {
 893                    Ok(None)
 894                }
 895            }
 896            btree_map::Entry::Vacant(e) => Ok(Some(
 897                e.insert(Arc::new(Mutex::new(FakeFsEntry::File {
 898                    inode,
 899                    mtime,
 900                    content: String::new(),
 901                })))
 902                .clone(),
 903            )),
 904        })?;
 905        if let Some(entry) = entry {
 906            entry.lock().set_file_content(&target, content)?;
 907        }
 908        state.emit_event(&[target]);
 909        Ok(())
 910    }
 911
 912    async fn remove_dir(&self, path: &Path, options: RemoveOptions) -> Result<()> {
 913        self.simulate_random_delay().await;
 914
 915        let path = normalize_path(path);
 916        let parent_path = path
 917            .parent()
 918            .ok_or_else(|| anyhow!("cannot remove the root"))?;
 919        let base_name = path.file_name().unwrap();
 920
 921        let mut state = self.state.lock();
 922        let parent_entry = state.read_path(parent_path)?;
 923        let mut parent_entry = parent_entry.lock();
 924        let entry = parent_entry
 925            .dir_entries(parent_path)?
 926            .entry(base_name.to_str().unwrap().into());
 927
 928        match entry {
 929            btree_map::Entry::Vacant(_) => {
 930                if !options.ignore_if_not_exists {
 931                    return Err(anyhow!("{path:?} does not exist"));
 932                }
 933            }
 934            btree_map::Entry::Occupied(e) => {
 935                {
 936                    let mut entry = e.get().lock();
 937                    let children = entry.dir_entries(&path)?;
 938                    if !options.recursive && !children.is_empty() {
 939                        return Err(anyhow!("{path:?} is not empty"));
 940                    }
 941                }
 942                e.remove();
 943            }
 944        }
 945        state.emit_event(&[path]);
 946        Ok(())
 947    }
 948
 949    async fn remove_file(&self, path: &Path, options: RemoveOptions) -> Result<()> {
 950        self.simulate_random_delay().await;
 951
 952        let path = normalize_path(path);
 953        let parent_path = path
 954            .parent()
 955            .ok_or_else(|| anyhow!("cannot remove the root"))?;
 956        let base_name = path.file_name().unwrap();
 957        let mut state = self.state.lock();
 958        let parent_entry = state.read_path(parent_path)?;
 959        let mut parent_entry = parent_entry.lock();
 960        let entry = parent_entry
 961            .dir_entries(parent_path)?
 962            .entry(base_name.to_str().unwrap().into());
 963        match entry {
 964            btree_map::Entry::Vacant(_) => {
 965                if !options.ignore_if_not_exists {
 966                    return Err(anyhow!("{path:?} does not exist"));
 967                }
 968            }
 969            btree_map::Entry::Occupied(e) => {
 970                e.get().lock().file_content(&path)?;
 971                e.remove();
 972            }
 973        }
 974        state.emit_event(&[path]);
 975        Ok(())
 976    }
 977
 978    async fn open_sync(&self, path: &Path) -> Result<Box<dyn io::Read>> {
 979        let text = self.load(path).await?;
 980        Ok(Box::new(io::Cursor::new(text)))
 981    }
 982
 983    async fn load(&self, path: &Path) -> Result<String> {
 984        let path = normalize_path(path);
 985        self.simulate_random_delay().await;
 986        let state = self.state.lock();
 987        let entry = state.read_path(&path)?;
 988        let entry = entry.lock();
 989        entry.file_content(&path).cloned()
 990    }
 991
 992    async fn atomic_write(&self, path: PathBuf, data: String) -> Result<()> {
 993        self.simulate_random_delay().await;
 994        let path = normalize_path(path.as_path());
 995        self.write_file_internal(path, data.to_string())?;
 996
 997        Ok(())
 998    }
 999
1000    async fn save(&self, path: &Path, text: &Rope, line_ending: LineEnding) -> Result<()> {
1001        self.simulate_random_delay().await;
1002        let path = normalize_path(path);
1003        let content = chunks(text, line_ending).collect();
1004        self.write_file_internal(path, content)?;
1005        Ok(())
1006    }
1007
1008    async fn canonicalize(&self, path: &Path) -> Result<PathBuf> {
1009        let path = normalize_path(path);
1010        self.simulate_random_delay().await;
1011        let state = self.state.lock();
1012        if let Some((_, real_path)) = state.try_read_path(&path) {
1013            Ok(real_path)
1014        } else {
1015            Err(anyhow!("path does not exist: {}", path.display()))
1016        }
1017    }
1018
1019    async fn is_file(&self, path: &Path) -> bool {
1020        let path = normalize_path(path);
1021        self.simulate_random_delay().await;
1022        let state = self.state.lock();
1023        if let Some((entry, _)) = state.try_read_path(&path) {
1024            entry.lock().is_file()
1025        } else {
1026            false
1027        }
1028    }
1029
1030    async fn metadata(&self, path: &Path) -> Result<Option<Metadata>> {
1031        self.simulate_random_delay().await;
1032        let path = normalize_path(path);
1033        let state = self.state.lock();
1034        if let Some((entry, real_path)) = state.try_read_path(&path) {
1035            let entry = entry.lock();
1036            let is_symlink = real_path != path;
1037
1038            Ok(Some(match &*entry {
1039                FakeFsEntry::File { inode, mtime, .. } => Metadata {
1040                    inode: *inode,
1041                    mtime: *mtime,
1042                    is_dir: false,
1043                    is_symlink,
1044                },
1045                FakeFsEntry::Dir { inode, mtime, .. } => Metadata {
1046                    inode: *inode,
1047                    mtime: *mtime,
1048                    is_dir: true,
1049                    is_symlink,
1050                },
1051                FakeFsEntry::Symlink { .. } => unreachable!(),
1052            }))
1053        } else {
1054            Ok(None)
1055        }
1056    }
1057
1058    async fn read_dir(
1059        &self,
1060        path: &Path,
1061    ) -> Result<Pin<Box<dyn Send + Stream<Item = Result<PathBuf>>>>> {
1062        self.simulate_random_delay().await;
1063        let path = normalize_path(path);
1064        let state = self.state.lock();
1065        let entry = state.read_path(&path)?;
1066        let mut entry = entry.lock();
1067        let children = entry.dir_entries(&path)?;
1068        let paths = children
1069            .keys()
1070            .map(|file_name| Ok(path.join(file_name)))
1071            .collect::<Vec<_>>();
1072        Ok(Box::pin(futures::stream::iter(paths)))
1073    }
1074
1075    async fn watch(
1076        &self,
1077        path: &Path,
1078        _: Duration,
1079    ) -> Pin<Box<dyn Send + Stream<Item = Vec<fsevent::Event>>>> {
1080        self.simulate_random_delay().await;
1081        let (tx, rx) = smol::channel::unbounded();
1082        self.state.lock().event_txs.push(tx);
1083        let path = path.to_path_buf();
1084        let executor = self.executor.clone();
1085        Box::pin(futures::StreamExt::filter(rx, move |events| {
1086            let result = events.iter().any(|event| event.path.starts_with(&path));
1087            let executor = executor.clone();
1088            async move {
1089                if let Some(executor) = executor.clone().upgrade() {
1090                    executor.simulate_random_delay().await;
1091                }
1092                result
1093            }
1094        }))
1095    }
1096
1097    fn open_repo(&self, abs_dot_git: &Path) -> Option<Arc<Mutex<dyn GitRepository>>> {
1098        let state = self.state.lock();
1099        let entry = state.read_path(abs_dot_git).unwrap();
1100        let mut entry = entry.lock();
1101        if let FakeFsEntry::Dir { git_repo_state, .. } = &mut *entry {
1102            let state = git_repo_state
1103                .get_or_insert_with(|| Arc::new(Mutex::new(FakeGitRepositoryState::default())))
1104                .clone();
1105            Some(repository::FakeGitRepository::open(state))
1106        } else {
1107            None
1108        }
1109    }
1110
1111    fn is_fake(&self) -> bool {
1112        true
1113    }
1114
1115    #[cfg(any(test, feature = "test-support"))]
1116    fn as_fake(&self) -> &FakeFs {
1117        self
1118    }
1119}
1120
1121fn chunks(rope: &Rope, line_ending: LineEnding) -> impl Iterator<Item = &str> {
1122    rope.chunks().flat_map(move |chunk| {
1123        let mut newline = false;
1124        chunk.split('\n').flat_map(move |line| {
1125            let ending = if newline {
1126                Some(line_ending.as_str())
1127            } else {
1128                None
1129            };
1130            newline = true;
1131            ending.into_iter().chain([line])
1132        })
1133    })
1134}
1135
1136pub fn normalize_path(path: &Path) -> PathBuf {
1137    let mut components = path.components().peekable();
1138    let mut ret = if let Some(c @ Component::Prefix(..)) = components.peek().cloned() {
1139        components.next();
1140        PathBuf::from(c.as_os_str())
1141    } else {
1142        PathBuf::new()
1143    };
1144
1145    for component in components {
1146        match component {
1147            Component::Prefix(..) => unreachable!(),
1148            Component::RootDir => {
1149                ret.push(component.as_os_str());
1150            }
1151            Component::CurDir => {}
1152            Component::ParentDir => {
1153                ret.pop();
1154            }
1155            Component::Normal(c) => {
1156                ret.push(c);
1157            }
1158        }
1159    }
1160    ret
1161}
1162
1163pub fn copy_recursive<'a>(
1164    fs: &'a dyn Fs,
1165    source: &'a Path,
1166    target: &'a Path,
1167    options: CopyOptions,
1168) -> BoxFuture<'a, Result<()>> {
1169    use futures::future::FutureExt;
1170
1171    async move {
1172        let metadata = fs
1173            .metadata(source)
1174            .await?
1175            .ok_or_else(|| anyhow!("path does not exist: {}", source.display()))?;
1176        if metadata.is_dir {
1177            if !options.overwrite && fs.metadata(target).await.is_ok() {
1178                if options.ignore_if_exists {
1179                    return Ok(());
1180                } else {
1181                    return Err(anyhow!("{target:?} already exists"));
1182                }
1183            }
1184
1185            let _ = fs
1186                .remove_dir(
1187                    target,
1188                    RemoveOptions {
1189                        recursive: true,
1190                        ignore_if_not_exists: true,
1191                    },
1192                )
1193                .await;
1194            fs.create_dir(target).await?;
1195            let mut children = fs.read_dir(source).await?;
1196            while let Some(child_path) = children.next().await {
1197                if let Ok(child_path) = child_path {
1198                    if let Some(file_name) = child_path.file_name() {
1199                        let child_target_path = target.join(file_name);
1200                        copy_recursive(fs, &child_path, &child_target_path, options).await?;
1201                    }
1202                }
1203            }
1204
1205            Ok(())
1206        } else {
1207            fs.copy_file(source, target, options).await
1208        }
1209    }
1210    .boxed()
1211}
1212
1213#[cfg(test)]
1214mod tests {
1215    use super::*;
1216    use gpui::TestAppContext;
1217    use serde_json::json;
1218
1219    #[gpui::test]
1220    async fn test_fake_fs(cx: &mut TestAppContext) {
1221        let fs = FakeFs::new(cx.background());
1222
1223        fs.insert_tree(
1224            "/root",
1225            json!({
1226                "dir1": {
1227                    "a": "A",
1228                    "b": "B"
1229                },
1230                "dir2": {
1231                    "c": "C",
1232                    "dir3": {
1233                        "d": "D"
1234                    }
1235                }
1236            }),
1237        )
1238        .await;
1239
1240        assert_eq!(
1241            fs.files(),
1242            vec![
1243                PathBuf::from("/root/dir1/a"),
1244                PathBuf::from("/root/dir1/b"),
1245                PathBuf::from("/root/dir2/c"),
1246                PathBuf::from("/root/dir2/dir3/d"),
1247            ]
1248        );
1249
1250        fs.insert_symlink("/root/dir2/link-to-dir3", "./dir3".into())
1251            .await;
1252
1253        assert_eq!(
1254            fs.canonicalize("/root/dir2/link-to-dir3".as_ref())
1255                .await
1256                .unwrap(),
1257            PathBuf::from("/root/dir2/dir3"),
1258        );
1259        assert_eq!(
1260            fs.canonicalize("/root/dir2/link-to-dir3/d".as_ref())
1261                .await
1262                .unwrap(),
1263            PathBuf::from("/root/dir2/dir3/d"),
1264        );
1265        assert_eq!(
1266            fs.load("/root/dir2/link-to-dir3/d".as_ref()).await.unwrap(),
1267            "D",
1268        );
1269    }
1270}