1use crate::{
   2    copy_recursive, ignore::IgnoreStack, DiagnosticSummary, ProjectEntryId, RemoveOptions,
   3};
   4use ::ignore::gitignore::{Gitignore, GitignoreBuilder};
   5use anyhow::{anyhow, Context, Result};
   6use client::{proto, Client};
   7use clock::ReplicaId;
   8use collections::{HashMap, HashSet, VecDeque};
   9use fs::{
  10    repository::{GitFileStatus, GitRepository, RepoPath},
  11    Fs,
  12};
  13use futures::{
  14    channel::{
  15        mpsc::{self, UnboundedSender},
  16        oneshot,
  17    },
  18    select_biased,
  19    task::Poll,
  20    FutureExt, Stream, StreamExt,
  21};
  22use fuzzy::CharBag;
  23use git::{DOT_GIT, GITIGNORE};
  24use gpui::{executor, AppContext, AsyncAppContext, Entity, ModelContext, ModelHandle, Task};
  25use language::{
  26    proto::{
  27        deserialize_fingerprint, deserialize_version, serialize_fingerprint, serialize_line_ending,
  28        serialize_version,
  29    },
  30    Buffer, DiagnosticEntry, File as _, LineEnding, PointUtf16, Rope, RopeFingerprint, Unclipped,
  31};
  32use lsp::LanguageServerId;
  33use parking_lot::Mutex;
  34use postage::{
  35    barrier,
  36    prelude::{Sink as _, Stream as _},
  37    watch,
  38};
  39use smol::channel::{self, Sender};
  40use std::{
  41    any::Any,
  42    cmp::{self, Ordering},
  43    convert::TryFrom,
  44    ffi::OsStr,
  45    fmt,
  46    future::Future,
  47    mem,
  48    ops::{AddAssign, Deref, DerefMut, Sub},
  49    path::{Path, PathBuf},
  50    pin::Pin,
  51    sync::{
  52        atomic::{AtomicUsize, Ordering::SeqCst},
  53        Arc,
  54    },
  55    time::{Duration, SystemTime},
  56};
  57use sum_tree::{Bias, Edit, SeekTarget, SumTree, TreeMap, TreeSet};
  58use util::{paths::HOME, ResultExt};
  59
  60#[derive(Copy, Clone, PartialEq, Eq, Debug, Hash, PartialOrd, Ord)]
  61pub struct WorktreeId(usize);
  62
  63pub enum Worktree {
  64    Local(LocalWorktree),
  65    Remote(RemoteWorktree),
  66}
  67
  68pub struct LocalWorktree {
  69    snapshot: LocalSnapshot,
  70    scan_requests_tx: channel::Sender<ScanRequest>,
  71    path_prefixes_to_scan_tx: channel::Sender<Arc<Path>>,
  72    is_scanning: (watch::Sender<bool>, watch::Receiver<bool>),
  73    _background_scanner_task: Task<()>,
  74    share: Option<ShareState>,
  75    diagnostics: HashMap<
  76        Arc<Path>,
  77        Vec<(
  78            LanguageServerId,
  79            Vec<DiagnosticEntry<Unclipped<PointUtf16>>>,
  80        )>,
  81    >,
  82    diagnostic_summaries: HashMap<Arc<Path>, HashMap<LanguageServerId, DiagnosticSummary>>,
  83    client: Arc<Client>,
  84    fs: Arc<dyn Fs>,
  85    visible: bool,
  86}
  87
  88struct ScanRequest {
  89    relative_paths: Vec<Arc<Path>>,
  90    done: barrier::Sender,
  91}
  92
  93pub struct RemoteWorktree {
  94    snapshot: Snapshot,
  95    background_snapshot: Arc<Mutex<Snapshot>>,
  96    project_id: u64,
  97    client: Arc<Client>,
  98    updates_tx: Option<UnboundedSender<proto::UpdateWorktree>>,
  99    snapshot_subscriptions: VecDeque<(usize, oneshot::Sender<()>)>,
 100    replica_id: ReplicaId,
 101    diagnostic_summaries: HashMap<Arc<Path>, HashMap<LanguageServerId, DiagnosticSummary>>,
 102    visible: bool,
 103    disconnected: bool,
 104}
 105
 106#[derive(Clone)]
 107pub struct Snapshot {
 108    id: WorktreeId,
 109    abs_path: Arc<Path>,
 110    root_name: String,
 111    root_char_bag: CharBag,
 112    entries_by_path: SumTree<Entry>,
 113    entries_by_id: SumTree<PathEntry>,
 114    repository_entries: TreeMap<RepositoryWorkDirectory, RepositoryEntry>,
 115
 116    /// A number that increases every time the worktree begins scanning
 117    /// a set of paths from the filesystem. This scanning could be caused
 118    /// by some operation performed on the worktree, such as reading or
 119    /// writing a file, or by an event reported by the filesystem.
 120    scan_id: usize,
 121
 122    /// The latest scan id that has completed, and whose preceding scans
 123    /// have all completed. The current `scan_id` could be more than one
 124    /// greater than the `completed_scan_id` if operations are performed
 125    /// on the worktree while it is processing a file-system event.
 126    completed_scan_id: usize,
 127}
 128
 129#[derive(Clone, Debug, PartialEq, Eq)]
 130pub struct RepositoryEntry {
 131    pub(crate) work_directory: WorkDirectoryEntry,
 132    pub(crate) branch: Option<Arc<str>>,
 133}
 134
 135impl RepositoryEntry {
 136    pub fn branch(&self) -> Option<Arc<str>> {
 137        self.branch.clone()
 138    }
 139
 140    pub fn work_directory_id(&self) -> ProjectEntryId {
 141        *self.work_directory
 142    }
 143
 144    pub fn work_directory(&self, snapshot: &Snapshot) -> Option<RepositoryWorkDirectory> {
 145        snapshot
 146            .entry_for_id(self.work_directory_id())
 147            .map(|entry| RepositoryWorkDirectory(entry.path.clone()))
 148    }
 149
 150    pub fn build_update(&self, _: &Self) -> proto::RepositoryEntry {
 151        proto::RepositoryEntry {
 152            work_directory_id: self.work_directory_id().to_proto(),
 153            branch: self.branch.as_ref().map(|str| str.to_string()),
 154        }
 155    }
 156}
 157
 158impl From<&RepositoryEntry> for proto::RepositoryEntry {
 159    fn from(value: &RepositoryEntry) -> Self {
 160        proto::RepositoryEntry {
 161            work_directory_id: value.work_directory.to_proto(),
 162            branch: value.branch.as_ref().map(|str| str.to_string()),
 163        }
 164    }
 165}
 166
 167/// This path corresponds to the 'content path' (the folder that contains the .git)
 168#[derive(Clone, Debug, Ord, PartialOrd, Eq, PartialEq)]
 169pub struct RepositoryWorkDirectory(pub(crate) Arc<Path>);
 170
 171impl Default for RepositoryWorkDirectory {
 172    fn default() -> Self {
 173        RepositoryWorkDirectory(Arc::from(Path::new("")))
 174    }
 175}
 176
 177impl AsRef<Path> for RepositoryWorkDirectory {
 178    fn as_ref(&self) -> &Path {
 179        self.0.as_ref()
 180    }
 181}
 182
 183#[derive(Clone, Debug, Ord, PartialOrd, Eq, PartialEq)]
 184pub struct WorkDirectoryEntry(ProjectEntryId);
 185
 186impl WorkDirectoryEntry {
 187    pub(crate) fn relativize(&self, worktree: &Snapshot, path: &Path) -> Option<RepoPath> {
 188        worktree.entry_for_id(self.0).and_then(|entry| {
 189            path.strip_prefix(&entry.path)
 190                .ok()
 191                .map(move |path| path.into())
 192        })
 193    }
 194}
 195
 196impl Deref for WorkDirectoryEntry {
 197    type Target = ProjectEntryId;
 198
 199    fn deref(&self) -> &Self::Target {
 200        &self.0
 201    }
 202}
 203
 204impl<'a> From<ProjectEntryId> for WorkDirectoryEntry {
 205    fn from(value: ProjectEntryId) -> Self {
 206        WorkDirectoryEntry(value)
 207    }
 208}
 209
 210#[derive(Debug, Clone)]
 211pub struct LocalSnapshot {
 212    snapshot: Snapshot,
 213    /// All of the gitignore files in the worktree, indexed by their relative path.
 214    /// The boolean indicates whether the gitignore needs to be updated.
 215    ignores_by_parent_abs_path: HashMap<Arc<Path>, (Arc<Gitignore>, bool)>,
 216    /// All of the git repositories in the worktree, indexed by the project entry
 217    /// id of their parent directory.
 218    git_repositories: TreeMap<ProjectEntryId, LocalRepositoryEntry>,
 219}
 220
 221struct BackgroundScannerState {
 222    snapshot: LocalSnapshot,
 223    scanned_dirs: HashSet<ProjectEntryId>,
 224    path_prefixes_to_scan: HashSet<Arc<Path>>,
 225    paths_to_scan: HashSet<Arc<Path>>,
 226    /// The ids of all of the entries that were removed from the snapshot
 227    /// as part of the current update. These entry ids may be re-used
 228    /// if the same inode is discovered at a new path, or if the given
 229    /// path is re-created after being deleted.
 230    removed_entry_ids: HashMap<u64, ProjectEntryId>,
 231    changed_paths: Vec<Arc<Path>>,
 232    prev_snapshot: Snapshot,
 233}
 234
 235#[derive(Debug, Clone)]
 236pub struct LocalRepositoryEntry {
 237    pub(crate) git_dir_scan_id: usize,
 238    pub(crate) repo_ptr: Arc<Mutex<dyn GitRepository>>,
 239    /// Path to the actual .git folder.
 240    /// Note: if .git is a file, this points to the folder indicated by the .git file
 241    pub(crate) git_dir_path: Arc<Path>,
 242}
 243
 244impl Deref for LocalSnapshot {
 245    type Target = Snapshot;
 246
 247    fn deref(&self) -> &Self::Target {
 248        &self.snapshot
 249    }
 250}
 251
 252impl DerefMut for LocalSnapshot {
 253    fn deref_mut(&mut self) -> &mut Self::Target {
 254        &mut self.snapshot
 255    }
 256}
 257
 258enum ScanState {
 259    Started,
 260    Updated {
 261        snapshot: LocalSnapshot,
 262        changes: UpdatedEntriesSet,
 263        barrier: Option<barrier::Sender>,
 264        scanning: bool,
 265    },
 266}
 267
 268struct ShareState {
 269    project_id: u64,
 270    snapshots_tx:
 271        mpsc::UnboundedSender<(LocalSnapshot, UpdatedEntriesSet, UpdatedGitRepositoriesSet)>,
 272    resume_updates: watch::Sender<()>,
 273    _maintain_remote_snapshot: Task<Option<()>>,
 274}
 275
 276pub enum Event {
 277    UpdatedEntries(UpdatedEntriesSet),
 278    UpdatedGitRepositories(UpdatedGitRepositoriesSet),
 279}
 280
 281impl Entity for Worktree {
 282    type Event = Event;
 283}
 284
 285impl Worktree {
 286    pub async fn local(
 287        client: Arc<Client>,
 288        path: impl Into<Arc<Path>>,
 289        visible: bool,
 290        fs: Arc<dyn Fs>,
 291        next_entry_id: Arc<AtomicUsize>,
 292        cx: &mut AsyncAppContext,
 293    ) -> Result<ModelHandle<Self>> {
 294        // After determining whether the root entry is a file or a directory, populate the
 295        // snapshot's "root name", which will be used for the purpose of fuzzy matching.
 296        let abs_path = path.into();
 297        let metadata = fs
 298            .metadata(&abs_path)
 299            .await
 300            .context("failed to stat worktree path")?;
 301
 302        Ok(cx.add_model(move |cx: &mut ModelContext<Worktree>| {
 303            let root_name = abs_path
 304                .file_name()
 305                .map_or(String::new(), |f| f.to_string_lossy().to_string());
 306
 307            let mut snapshot = LocalSnapshot {
 308                ignores_by_parent_abs_path: Default::default(),
 309                git_repositories: Default::default(),
 310                snapshot: Snapshot {
 311                    id: WorktreeId::from_usize(cx.model_id()),
 312                    abs_path: abs_path.clone(),
 313                    root_name: root_name.clone(),
 314                    root_char_bag: root_name.chars().map(|c| c.to_ascii_lowercase()).collect(),
 315                    entries_by_path: Default::default(),
 316                    entries_by_id: Default::default(),
 317                    repository_entries: Default::default(),
 318                    scan_id: 1,
 319                    completed_scan_id: 0,
 320                },
 321            };
 322
 323            if let Some(metadata) = metadata {
 324                snapshot.insert_entry(
 325                    Entry::new(
 326                        Arc::from(Path::new("")),
 327                        &metadata,
 328                        &next_entry_id,
 329                        snapshot.root_char_bag,
 330                    ),
 331                    fs.as_ref(),
 332                );
 333            }
 334
 335            let (scan_requests_tx, scan_requests_rx) = channel::unbounded();
 336            let (path_prefixes_to_scan_tx, path_prefixes_to_scan_rx) = channel::unbounded();
 337            let (scan_states_tx, mut scan_states_rx) = mpsc::unbounded();
 338
 339            cx.spawn_weak(|this, mut cx| async move {
 340                while let Some((state, this)) = scan_states_rx.next().await.zip(this.upgrade(&cx)) {
 341                    this.update(&mut cx, |this, cx| {
 342                        let this = this.as_local_mut().unwrap();
 343                        match state {
 344                            ScanState::Started => {
 345                                *this.is_scanning.0.borrow_mut() = true;
 346                            }
 347                            ScanState::Updated {
 348                                snapshot,
 349                                changes,
 350                                barrier,
 351                                scanning,
 352                            } => {
 353                                *this.is_scanning.0.borrow_mut() = scanning;
 354                                this.set_snapshot(snapshot, changes, cx);
 355                                drop(barrier);
 356                            }
 357                        }
 358                        cx.notify();
 359                    });
 360                }
 361            })
 362            .detach();
 363
 364            let background_scanner_task = cx.background().spawn({
 365                let fs = fs.clone();
 366                let snapshot = snapshot.clone();
 367                let background = cx.background().clone();
 368                async move {
 369                    let events = fs.watch(&abs_path, Duration::from_millis(100)).await;
 370                    BackgroundScanner::new(
 371                        snapshot,
 372                        next_entry_id,
 373                        fs,
 374                        scan_states_tx,
 375                        background,
 376                        scan_requests_rx,
 377                        path_prefixes_to_scan_rx,
 378                    )
 379                    .run(events)
 380                    .await;
 381                }
 382            });
 383
 384            Worktree::Local(LocalWorktree {
 385                snapshot,
 386                is_scanning: watch::channel_with(true),
 387                share: None,
 388                scan_requests_tx,
 389                path_prefixes_to_scan_tx,
 390                _background_scanner_task: background_scanner_task,
 391                diagnostics: Default::default(),
 392                diagnostic_summaries: Default::default(),
 393                client,
 394                fs,
 395                visible,
 396            })
 397        }))
 398    }
 399
 400    // abcdefghi
 401    pub fn remote(
 402        project_remote_id: u64,
 403        replica_id: ReplicaId,
 404        worktree: proto::WorktreeMetadata,
 405        client: Arc<Client>,
 406        cx: &mut AppContext,
 407    ) -> ModelHandle<Self> {
 408        cx.add_model(|cx: &mut ModelContext<Self>| {
 409            let snapshot = Snapshot {
 410                id: WorktreeId(worktree.id as usize),
 411                abs_path: Arc::from(PathBuf::from(worktree.abs_path)),
 412                root_name: worktree.root_name.clone(),
 413                root_char_bag: worktree
 414                    .root_name
 415                    .chars()
 416                    .map(|c| c.to_ascii_lowercase())
 417                    .collect(),
 418                entries_by_path: Default::default(),
 419                entries_by_id: Default::default(),
 420                repository_entries: Default::default(),
 421                scan_id: 1,
 422                completed_scan_id: 0,
 423            };
 424
 425            let (updates_tx, mut updates_rx) = mpsc::unbounded();
 426            let background_snapshot = Arc::new(Mutex::new(snapshot.clone()));
 427            let (mut snapshot_updated_tx, mut snapshot_updated_rx) = watch::channel();
 428
 429            cx.background()
 430                .spawn({
 431                    let background_snapshot = background_snapshot.clone();
 432                    async move {
 433                        while let Some(update) = updates_rx.next().await {
 434                            if let Err(error) =
 435                                background_snapshot.lock().apply_remote_update(update)
 436                            {
 437                                log::error!("error applying worktree update: {}", error);
 438                            }
 439                            snapshot_updated_tx.send(()).await.ok();
 440                        }
 441                    }
 442                })
 443                .detach();
 444
 445            cx.spawn_weak(|this, mut cx| async move {
 446                while (snapshot_updated_rx.recv().await).is_some() {
 447                    if let Some(this) = this.upgrade(&cx) {
 448                        this.update(&mut cx, |this, cx| {
 449                            let this = this.as_remote_mut().unwrap();
 450                            this.snapshot = this.background_snapshot.lock().clone();
 451                            cx.emit(Event::UpdatedEntries(Arc::from([])));
 452                            cx.notify();
 453                            while let Some((scan_id, _)) = this.snapshot_subscriptions.front() {
 454                                if this.observed_snapshot(*scan_id) {
 455                                    let (_, tx) = this.snapshot_subscriptions.pop_front().unwrap();
 456                                    let _ = tx.send(());
 457                                } else {
 458                                    break;
 459                                }
 460                            }
 461                        });
 462                    } else {
 463                        break;
 464                    }
 465                }
 466            })
 467            .detach();
 468
 469            Worktree::Remote(RemoteWorktree {
 470                project_id: project_remote_id,
 471                replica_id,
 472                snapshot: snapshot.clone(),
 473                background_snapshot,
 474                updates_tx: Some(updates_tx),
 475                snapshot_subscriptions: Default::default(),
 476                client: client.clone(),
 477                diagnostic_summaries: Default::default(),
 478                visible: worktree.visible,
 479                disconnected: false,
 480            })
 481        })
 482    }
 483
 484    pub fn as_local(&self) -> Option<&LocalWorktree> {
 485        if let Worktree::Local(worktree) = self {
 486            Some(worktree)
 487        } else {
 488            None
 489        }
 490    }
 491
 492    pub fn as_remote(&self) -> Option<&RemoteWorktree> {
 493        if let Worktree::Remote(worktree) = self {
 494            Some(worktree)
 495        } else {
 496            None
 497        }
 498    }
 499
 500    pub fn as_local_mut(&mut self) -> Option<&mut LocalWorktree> {
 501        if let Worktree::Local(worktree) = self {
 502            Some(worktree)
 503        } else {
 504            None
 505        }
 506    }
 507
 508    pub fn as_remote_mut(&mut self) -> Option<&mut RemoteWorktree> {
 509        if let Worktree::Remote(worktree) = self {
 510            Some(worktree)
 511        } else {
 512            None
 513        }
 514    }
 515
 516    pub fn is_local(&self) -> bool {
 517        matches!(self, Worktree::Local(_))
 518    }
 519
 520    pub fn is_remote(&self) -> bool {
 521        !self.is_local()
 522    }
 523
 524    pub fn snapshot(&self) -> Snapshot {
 525        match self {
 526            Worktree::Local(worktree) => worktree.snapshot().snapshot,
 527            Worktree::Remote(worktree) => worktree.snapshot(),
 528        }
 529    }
 530
 531    pub fn scan_id(&self) -> usize {
 532        match self {
 533            Worktree::Local(worktree) => worktree.snapshot.scan_id,
 534            Worktree::Remote(worktree) => worktree.snapshot.scan_id,
 535        }
 536    }
 537
 538    pub fn completed_scan_id(&self) -> usize {
 539        match self {
 540            Worktree::Local(worktree) => worktree.snapshot.completed_scan_id,
 541            Worktree::Remote(worktree) => worktree.snapshot.completed_scan_id,
 542        }
 543    }
 544
 545    pub fn is_visible(&self) -> bool {
 546        match self {
 547            Worktree::Local(worktree) => worktree.visible,
 548            Worktree::Remote(worktree) => worktree.visible,
 549        }
 550    }
 551
 552    pub fn replica_id(&self) -> ReplicaId {
 553        match self {
 554            Worktree::Local(_) => 0,
 555            Worktree::Remote(worktree) => worktree.replica_id,
 556        }
 557    }
 558
 559    pub fn diagnostic_summaries(
 560        &self,
 561    ) -> impl Iterator<Item = (Arc<Path>, LanguageServerId, DiagnosticSummary)> + '_ {
 562        match self {
 563            Worktree::Local(worktree) => &worktree.diagnostic_summaries,
 564            Worktree::Remote(worktree) => &worktree.diagnostic_summaries,
 565        }
 566        .iter()
 567        .flat_map(|(path, summaries)| {
 568            summaries
 569                .iter()
 570                .map(move |(&server_id, &summary)| (path.clone(), server_id, summary))
 571        })
 572    }
 573
 574    pub fn abs_path(&self) -> Arc<Path> {
 575        match self {
 576            Worktree::Local(worktree) => worktree.abs_path.clone(),
 577            Worktree::Remote(worktree) => worktree.abs_path.clone(),
 578        }
 579    }
 580
 581    pub fn root_file(&self, cx: &mut ModelContext<Self>) -> Option<Arc<File>> {
 582        let entry = self.root_entry()?;
 583        Some(File::for_entry(entry.clone(), cx.handle()))
 584    }
 585}
 586
 587impl LocalWorktree {
 588    pub fn contains_abs_path(&self, path: &Path) -> bool {
 589        path.starts_with(&self.abs_path)
 590    }
 591
 592    pub(crate) fn load_buffer(
 593        &mut self,
 594        id: u64,
 595        path: &Path,
 596        cx: &mut ModelContext<Worktree>,
 597    ) -> Task<Result<ModelHandle<Buffer>>> {
 598        let path = Arc::from(path);
 599        cx.spawn(move |this, mut cx| async move {
 600            let (file, contents, diff_base) = this
 601                .update(&mut cx, |t, cx| t.as_local().unwrap().load(&path, cx))
 602                .await?;
 603            let text_buffer = cx
 604                .background()
 605                .spawn(async move { text::Buffer::new(0, id, contents) })
 606                .await;
 607            Ok(cx.add_model(|_| Buffer::build(text_buffer, diff_base, Some(Arc::new(file)))))
 608        })
 609    }
 610
 611    pub fn diagnostics_for_path(
 612        &self,
 613        path: &Path,
 614    ) -> Vec<(
 615        LanguageServerId,
 616        Vec<DiagnosticEntry<Unclipped<PointUtf16>>>,
 617    )> {
 618        self.diagnostics.get(path).cloned().unwrap_or_default()
 619    }
 620
 621    pub fn clear_diagnostics_for_language_server(
 622        &mut self,
 623        server_id: LanguageServerId,
 624        _: &mut ModelContext<Worktree>,
 625    ) {
 626        let worktree_id = self.id().to_proto();
 627        self.diagnostic_summaries
 628            .retain(|path, summaries_by_server_id| {
 629                if summaries_by_server_id.remove(&server_id).is_some() {
 630                    if let Some(share) = self.share.as_ref() {
 631                        self.client
 632                            .send(proto::UpdateDiagnosticSummary {
 633                                project_id: share.project_id,
 634                                worktree_id,
 635                                summary: Some(proto::DiagnosticSummary {
 636                                    path: path.to_string_lossy().to_string(),
 637                                    language_server_id: server_id.0 as u64,
 638                                    error_count: 0,
 639                                    warning_count: 0,
 640                                }),
 641                            })
 642                            .log_err();
 643                    }
 644                    !summaries_by_server_id.is_empty()
 645                } else {
 646                    true
 647                }
 648            });
 649
 650        self.diagnostics.retain(|_, diagnostics_by_server_id| {
 651            if let Ok(ix) = diagnostics_by_server_id.binary_search_by_key(&server_id, |e| e.0) {
 652                diagnostics_by_server_id.remove(ix);
 653                !diagnostics_by_server_id.is_empty()
 654            } else {
 655                true
 656            }
 657        });
 658    }
 659
 660    pub fn update_diagnostics(
 661        &mut self,
 662        server_id: LanguageServerId,
 663        worktree_path: Arc<Path>,
 664        diagnostics: Vec<DiagnosticEntry<Unclipped<PointUtf16>>>,
 665        _: &mut ModelContext<Worktree>,
 666    ) -> Result<bool> {
 667        let summaries_by_server_id = self
 668            .diagnostic_summaries
 669            .entry(worktree_path.clone())
 670            .or_default();
 671
 672        let old_summary = summaries_by_server_id
 673            .remove(&server_id)
 674            .unwrap_or_default();
 675
 676        let new_summary = DiagnosticSummary::new(&diagnostics);
 677        if new_summary.is_empty() {
 678            if let Some(diagnostics_by_server_id) = self.diagnostics.get_mut(&worktree_path) {
 679                if let Ok(ix) = diagnostics_by_server_id.binary_search_by_key(&server_id, |e| e.0) {
 680                    diagnostics_by_server_id.remove(ix);
 681                }
 682                if diagnostics_by_server_id.is_empty() {
 683                    self.diagnostics.remove(&worktree_path);
 684                }
 685            }
 686        } else {
 687            summaries_by_server_id.insert(server_id, new_summary);
 688            let diagnostics_by_server_id =
 689                self.diagnostics.entry(worktree_path.clone()).or_default();
 690            match diagnostics_by_server_id.binary_search_by_key(&server_id, |e| e.0) {
 691                Ok(ix) => {
 692                    diagnostics_by_server_id[ix] = (server_id, diagnostics);
 693                }
 694                Err(ix) => {
 695                    diagnostics_by_server_id.insert(ix, (server_id, diagnostics));
 696                }
 697            }
 698        }
 699
 700        if !old_summary.is_empty() || !new_summary.is_empty() {
 701            if let Some(share) = self.share.as_ref() {
 702                self.client
 703                    .send(proto::UpdateDiagnosticSummary {
 704                        project_id: share.project_id,
 705                        worktree_id: self.id().to_proto(),
 706                        summary: Some(proto::DiagnosticSummary {
 707                            path: worktree_path.to_string_lossy().to_string(),
 708                            language_server_id: server_id.0 as u64,
 709                            error_count: new_summary.error_count as u32,
 710                            warning_count: new_summary.warning_count as u32,
 711                        }),
 712                    })
 713                    .log_err();
 714            }
 715        }
 716
 717        Ok(!old_summary.is_empty() || !new_summary.is_empty())
 718    }
 719
 720    fn set_snapshot(
 721        &mut self,
 722        new_snapshot: LocalSnapshot,
 723        entry_changes: UpdatedEntriesSet,
 724        cx: &mut ModelContext<Worktree>,
 725    ) {
 726        let repo_changes = self.changed_repos(&self.snapshot, &new_snapshot);
 727
 728        self.snapshot = new_snapshot;
 729
 730        if let Some(share) = self.share.as_mut() {
 731            share
 732                .snapshots_tx
 733                .unbounded_send((
 734                    self.snapshot.clone(),
 735                    entry_changes.clone(),
 736                    repo_changes.clone(),
 737                ))
 738                .ok();
 739        }
 740
 741        if !entry_changes.is_empty() {
 742            cx.emit(Event::UpdatedEntries(entry_changes));
 743        }
 744        if !repo_changes.is_empty() {
 745            cx.emit(Event::UpdatedGitRepositories(repo_changes));
 746        }
 747    }
 748
 749    fn changed_repos(
 750        &self,
 751        old_snapshot: &LocalSnapshot,
 752        new_snapshot: &LocalSnapshot,
 753    ) -> UpdatedGitRepositoriesSet {
 754        let mut changes = Vec::new();
 755        let mut old_repos = old_snapshot.git_repositories.iter().peekable();
 756        let mut new_repos = new_snapshot.git_repositories.iter().peekable();
 757        loop {
 758            match (new_repos.peek().map(clone), old_repos.peek().map(clone)) {
 759                (Some((new_entry_id, new_repo)), Some((old_entry_id, old_repo))) => {
 760                    match Ord::cmp(&new_entry_id, &old_entry_id) {
 761                        Ordering::Less => {
 762                            if let Some(entry) = new_snapshot.entry_for_id(new_entry_id) {
 763                                changes.push((
 764                                    entry.path.clone(),
 765                                    GitRepositoryChange {
 766                                        old_repository: None,
 767                                    },
 768                                ));
 769                            }
 770                            new_repos.next();
 771                        }
 772                        Ordering::Equal => {
 773                            if new_repo.git_dir_scan_id != old_repo.git_dir_scan_id {
 774                                if let Some(entry) = new_snapshot.entry_for_id(new_entry_id) {
 775                                    let old_repo = old_snapshot
 776                                        .repository_entries
 777                                        .get(&RepositoryWorkDirectory(entry.path.clone()))
 778                                        .cloned();
 779                                    changes.push((
 780                                        entry.path.clone(),
 781                                        GitRepositoryChange {
 782                                            old_repository: old_repo,
 783                                        },
 784                                    ));
 785                                }
 786                            }
 787                            new_repos.next();
 788                            old_repos.next();
 789                        }
 790                        Ordering::Greater => {
 791                            if let Some(entry) = old_snapshot.entry_for_id(old_entry_id) {
 792                                let old_repo = old_snapshot
 793                                    .repository_entries
 794                                    .get(&RepositoryWorkDirectory(entry.path.clone()))
 795                                    .cloned();
 796                                changes.push((
 797                                    entry.path.clone(),
 798                                    GitRepositoryChange {
 799                                        old_repository: old_repo,
 800                                    },
 801                                ));
 802                            }
 803                            old_repos.next();
 804                        }
 805                    }
 806                }
 807                (Some((entry_id, _)), None) => {
 808                    if let Some(entry) = new_snapshot.entry_for_id(entry_id) {
 809                        changes.push((
 810                            entry.path.clone(),
 811                            GitRepositoryChange {
 812                                old_repository: None,
 813                            },
 814                        ));
 815                    }
 816                    new_repos.next();
 817                }
 818                (None, Some((entry_id, _))) => {
 819                    if let Some(entry) = old_snapshot.entry_for_id(entry_id) {
 820                        let old_repo = old_snapshot
 821                            .repository_entries
 822                            .get(&RepositoryWorkDirectory(entry.path.clone()))
 823                            .cloned();
 824                        changes.push((
 825                            entry.path.clone(),
 826                            GitRepositoryChange {
 827                                old_repository: old_repo,
 828                            },
 829                        ));
 830                    }
 831                    old_repos.next();
 832                }
 833                (None, None) => break,
 834            }
 835        }
 836
 837        fn clone<T: Clone, U: Clone>(value: &(&T, &U)) -> (T, U) {
 838            (value.0.clone(), value.1.clone())
 839        }
 840
 841        changes.into()
 842    }
 843
 844    pub fn scan_complete(&self) -> impl Future<Output = ()> {
 845        let mut is_scanning_rx = self.is_scanning.1.clone();
 846        async move {
 847            let mut is_scanning = is_scanning_rx.borrow().clone();
 848            while is_scanning {
 849                if let Some(value) = is_scanning_rx.recv().await {
 850                    is_scanning = value;
 851                } else {
 852                    break;
 853                }
 854            }
 855        }
 856    }
 857
 858    pub fn snapshot(&self) -> LocalSnapshot {
 859        self.snapshot.clone()
 860    }
 861
 862    pub fn metadata_proto(&self) -> proto::WorktreeMetadata {
 863        proto::WorktreeMetadata {
 864            id: self.id().to_proto(),
 865            root_name: self.root_name().to_string(),
 866            visible: self.visible,
 867            abs_path: self.abs_path().as_os_str().to_string_lossy().into(),
 868        }
 869    }
 870
 871    fn load(
 872        &self,
 873        path: &Path,
 874        cx: &mut ModelContext<Worktree>,
 875    ) -> Task<Result<(File, String, Option<String>)>> {
 876        let path = Arc::from(path);
 877        let abs_path = self.absolutize(&path);
 878        let fs = self.fs.clone();
 879        let entry = self.refresh_entry(path.clone(), None, cx);
 880
 881        cx.spawn(|this, cx| async move {
 882            let text = fs.load(&abs_path).await?;
 883            let entry = entry.await?;
 884
 885            let mut index_task = None;
 886            let snapshot = this.read_with(&cx, |this, _| this.as_local().unwrap().snapshot());
 887            if let Some(repo) = snapshot.repository_for_path(&path) {
 888                let repo_path = repo.work_directory.relativize(&snapshot, &path).unwrap();
 889                if let Some(repo) = snapshot.git_repositories.get(&*repo.work_directory) {
 890                    let repo = repo.repo_ptr.clone();
 891                    index_task = Some(
 892                        cx.background()
 893                            .spawn(async move { repo.lock().load_index_text(&repo_path) }),
 894                    );
 895                }
 896            }
 897
 898            let diff_base = if let Some(index_task) = index_task {
 899                index_task.await
 900            } else {
 901                None
 902            };
 903
 904            Ok((
 905                File {
 906                    entry_id: entry.id,
 907                    worktree: this,
 908                    path: entry.path,
 909                    mtime: entry.mtime,
 910                    is_local: true,
 911                    is_deleted: false,
 912                },
 913                text,
 914                diff_base,
 915            ))
 916        })
 917    }
 918
 919    pub fn save_buffer(
 920        &self,
 921        buffer_handle: ModelHandle<Buffer>,
 922        path: Arc<Path>,
 923        has_changed_file: bool,
 924        cx: &mut ModelContext<Worktree>,
 925    ) -> Task<Result<()>> {
 926        let handle = cx.handle();
 927        let buffer = buffer_handle.read(cx);
 928
 929        let rpc = self.client.clone();
 930        let buffer_id = buffer.remote_id();
 931        let project_id = self.share.as_ref().map(|share| share.project_id);
 932
 933        let text = buffer.as_rope().clone();
 934        let fingerprint = text.fingerprint();
 935        let version = buffer.version();
 936        let save = self.write_file(path, text, buffer.line_ending(), cx);
 937
 938        cx.as_mut().spawn(|mut cx| async move {
 939            let entry = save.await?;
 940
 941            if has_changed_file {
 942                let new_file = Arc::new(File {
 943                    entry_id: entry.id,
 944                    worktree: handle,
 945                    path: entry.path,
 946                    mtime: entry.mtime,
 947                    is_local: true,
 948                    is_deleted: false,
 949                });
 950
 951                if let Some(project_id) = project_id {
 952                    rpc.send(proto::UpdateBufferFile {
 953                        project_id,
 954                        buffer_id,
 955                        file: Some(new_file.to_proto()),
 956                    })
 957                    .log_err();
 958                }
 959
 960                buffer_handle.update(&mut cx, |buffer, cx| {
 961                    if has_changed_file {
 962                        buffer.file_updated(new_file, cx).detach();
 963                    }
 964                });
 965            }
 966
 967            if let Some(project_id) = project_id {
 968                rpc.send(proto::BufferSaved {
 969                    project_id,
 970                    buffer_id,
 971                    version: serialize_version(&version),
 972                    mtime: Some(entry.mtime.into()),
 973                    fingerprint: serialize_fingerprint(fingerprint),
 974                })?;
 975            }
 976
 977            buffer_handle.update(&mut cx, |buffer, cx| {
 978                buffer.did_save(version.clone(), fingerprint, entry.mtime, cx);
 979            });
 980
 981            Ok(())
 982        })
 983    }
 984
 985    /// Find the lowest path in the worktree's datastructures that is an ancestor
 986    fn lowest_ancestor(&self, path: &Path) -> PathBuf {
 987        let mut lowest_ancestor = None;
 988        for path in path.ancestors() {
 989            if self.entry_for_path(path).is_some() {
 990                lowest_ancestor = Some(path.to_path_buf());
 991                break;
 992            }
 993        }
 994
 995        lowest_ancestor.unwrap_or_else(|| PathBuf::from(""))
 996    }
 997
 998    pub fn create_entry(
 999        &self,
1000        path: impl Into<Arc<Path>>,
1001        is_dir: bool,
1002        cx: &mut ModelContext<Worktree>,
1003    ) -> Task<Result<Entry>> {
1004        let path = path.into();
1005        let lowest_ancestor = self.lowest_ancestor(&path);
1006        let abs_path = self.absolutize(&path);
1007        let fs = self.fs.clone();
1008        let write = cx.background().spawn(async move {
1009            if is_dir {
1010                fs.create_dir(&abs_path).await
1011            } else {
1012                fs.save(&abs_path, &Default::default(), Default::default())
1013                    .await
1014            }
1015        });
1016
1017        cx.spawn(|this, mut cx| async move {
1018            write.await?;
1019            let (result, refreshes) = this.update(&mut cx, |this, cx| {
1020                let mut refreshes = Vec::<Task<anyhow::Result<Entry>>>::new();
1021                let refresh_paths = path.strip_prefix(&lowest_ancestor).unwrap();
1022                for refresh_path in refresh_paths.ancestors() {
1023                    if refresh_path == Path::new("") {
1024                        continue;
1025                    }
1026                    let refresh_full_path = lowest_ancestor.join(refresh_path);
1027
1028                    refreshes.push(this.as_local_mut().unwrap().refresh_entry(
1029                        refresh_full_path.into(),
1030                        None,
1031                        cx,
1032                    ));
1033                }
1034                (
1035                    this.as_local_mut().unwrap().refresh_entry(path, None, cx),
1036                    refreshes,
1037                )
1038            });
1039            for refresh in refreshes {
1040                refresh.await.log_err();
1041            }
1042
1043            result.await
1044        })
1045    }
1046
1047    pub fn write_file(
1048        &self,
1049        path: impl Into<Arc<Path>>,
1050        text: Rope,
1051        line_ending: LineEnding,
1052        cx: &mut ModelContext<Worktree>,
1053    ) -> Task<Result<Entry>> {
1054        let path = path.into();
1055        let abs_path = self.absolutize(&path);
1056        let fs = self.fs.clone();
1057        let write = cx
1058            .background()
1059            .spawn(async move { fs.save(&abs_path, &text, line_ending).await });
1060
1061        cx.spawn(|this, mut cx| async move {
1062            write.await?;
1063            this.update(&mut cx, |this, cx| {
1064                this.as_local_mut().unwrap().refresh_entry(path, None, cx)
1065            })
1066            .await
1067        })
1068    }
1069
1070    pub fn delete_entry(
1071        &self,
1072        entry_id: ProjectEntryId,
1073        cx: &mut ModelContext<Worktree>,
1074    ) -> Option<Task<Result<()>>> {
1075        let entry = self.entry_for_id(entry_id)?.clone();
1076        let abs_path = self.absolutize(&entry.path);
1077        let fs = self.fs.clone();
1078
1079        let delete = cx.background().spawn(async move {
1080            if entry.is_file() {
1081                fs.remove_file(&abs_path, Default::default()).await?;
1082            } else {
1083                fs.remove_dir(
1084                    &abs_path,
1085                    RemoveOptions {
1086                        recursive: true,
1087                        ignore_if_not_exists: false,
1088                    },
1089                )
1090                .await?;
1091            }
1092            anyhow::Ok(entry.path)
1093        });
1094
1095        Some(cx.spawn(|this, mut cx| async move {
1096            let path = delete.await?;
1097            this.update(&mut cx, |this, _| {
1098                this.as_local_mut()
1099                    .unwrap()
1100                    .refresh_entries_for_paths(vec![path])
1101            })
1102            .recv()
1103            .await;
1104            Ok(())
1105        }))
1106    }
1107
1108    pub fn rename_entry(
1109        &self,
1110        entry_id: ProjectEntryId,
1111        new_path: impl Into<Arc<Path>>,
1112        cx: &mut ModelContext<Worktree>,
1113    ) -> Option<Task<Result<Entry>>> {
1114        let old_path = self.entry_for_id(entry_id)?.path.clone();
1115        let new_path = new_path.into();
1116        let abs_old_path = self.absolutize(&old_path);
1117        let abs_new_path = self.absolutize(&new_path);
1118        let fs = self.fs.clone();
1119        let rename = cx.background().spawn(async move {
1120            fs.rename(&abs_old_path, &abs_new_path, Default::default())
1121                .await
1122        });
1123
1124        Some(cx.spawn(|this, mut cx| async move {
1125            rename.await?;
1126            this.update(&mut cx, |this, cx| {
1127                this.as_local_mut()
1128                    .unwrap()
1129                    .refresh_entry(new_path.clone(), Some(old_path), cx)
1130            })
1131            .await
1132        }))
1133    }
1134
1135    pub fn copy_entry(
1136        &self,
1137        entry_id: ProjectEntryId,
1138        new_path: impl Into<Arc<Path>>,
1139        cx: &mut ModelContext<Worktree>,
1140    ) -> Option<Task<Result<Entry>>> {
1141        let old_path = self.entry_for_id(entry_id)?.path.clone();
1142        let new_path = new_path.into();
1143        let abs_old_path = self.absolutize(&old_path);
1144        let abs_new_path = self.absolutize(&new_path);
1145        let fs = self.fs.clone();
1146        let copy = cx.background().spawn(async move {
1147            copy_recursive(
1148                fs.as_ref(),
1149                &abs_old_path,
1150                &abs_new_path,
1151                Default::default(),
1152            )
1153            .await
1154        });
1155
1156        Some(cx.spawn(|this, mut cx| async move {
1157            copy.await?;
1158            this.update(&mut cx, |this, cx| {
1159                this.as_local_mut()
1160                    .unwrap()
1161                    .refresh_entry(new_path.clone(), None, cx)
1162            })
1163            .await
1164        }))
1165    }
1166
1167    pub fn expand_entry(
1168        &mut self,
1169        entry_id: ProjectEntryId,
1170        cx: &mut ModelContext<Worktree>,
1171    ) -> Option<Task<Result<()>>> {
1172        let path = self.entry_for_id(entry_id)?.path.clone();
1173        let mut refresh = self.refresh_entries_for_paths(vec![path]);
1174        Some(cx.background().spawn(async move {
1175            refresh.next().await;
1176            Ok(())
1177        }))
1178    }
1179
1180    pub fn refresh_entries_for_paths(&self, paths: Vec<Arc<Path>>) -> barrier::Receiver {
1181        let (tx, rx) = barrier::channel();
1182        self.scan_requests_tx
1183            .try_send(ScanRequest {
1184                relative_paths: paths,
1185                done: tx,
1186            })
1187            .ok();
1188        rx
1189    }
1190
1191    pub fn add_path_prefix_to_scan(&self, path_prefix: Arc<Path>) {
1192        self.path_prefixes_to_scan_tx.try_send(path_prefix).ok();
1193    }
1194
1195    fn refresh_entry(
1196        &self,
1197        path: Arc<Path>,
1198        old_path: Option<Arc<Path>>,
1199        cx: &mut ModelContext<Worktree>,
1200    ) -> Task<Result<Entry>> {
1201        let paths = if let Some(old_path) = old_path.as_ref() {
1202            vec![old_path.clone(), path.clone()]
1203        } else {
1204            vec![path.clone()]
1205        };
1206        let mut refresh = self.refresh_entries_for_paths(paths);
1207        cx.spawn_weak(move |this, mut cx| async move {
1208            refresh.recv().await;
1209            this.upgrade(&cx)
1210                .ok_or_else(|| anyhow!("worktree was dropped"))?
1211                .update(&mut cx, |this, _| {
1212                    this.entry_for_path(path)
1213                        .cloned()
1214                        .ok_or_else(|| anyhow!("failed to read path after update"))
1215                })
1216        })
1217    }
1218
1219    pub fn observe_updates<F, Fut>(
1220        &mut self,
1221        project_id: u64,
1222        cx: &mut ModelContext<Worktree>,
1223        callback: F,
1224    ) -> oneshot::Receiver<()>
1225    where
1226        F: 'static + Send + Fn(proto::UpdateWorktree) -> Fut,
1227        Fut: Send + Future<Output = bool>,
1228    {
1229        #[cfg(any(test, feature = "test-support"))]
1230        const MAX_CHUNK_SIZE: usize = 2;
1231        #[cfg(not(any(test, feature = "test-support")))]
1232        const MAX_CHUNK_SIZE: usize = 256;
1233
1234        let (share_tx, share_rx) = oneshot::channel();
1235
1236        if let Some(share) = self.share.as_mut() {
1237            share_tx.send(()).ok();
1238            *share.resume_updates.borrow_mut() = ();
1239            return share_rx;
1240        }
1241
1242        let (resume_updates_tx, mut resume_updates_rx) = watch::channel::<()>();
1243        let (snapshots_tx, mut snapshots_rx) =
1244            mpsc::unbounded::<(LocalSnapshot, UpdatedEntriesSet, UpdatedGitRepositoriesSet)>();
1245        snapshots_tx
1246            .unbounded_send((self.snapshot(), Arc::from([]), Arc::from([])))
1247            .ok();
1248
1249        let worktree_id = cx.model_id() as u64;
1250        let _maintain_remote_snapshot = cx.background().spawn(async move {
1251            let mut is_first = true;
1252            while let Some((snapshot, entry_changes, repo_changes)) = snapshots_rx.next().await {
1253                let update;
1254                if is_first {
1255                    update = snapshot.build_initial_update(project_id, worktree_id);
1256                    is_first = false;
1257                } else {
1258                    update =
1259                        snapshot.build_update(project_id, worktree_id, entry_changes, repo_changes);
1260                }
1261
1262                for update in proto::split_worktree_update(update, MAX_CHUNK_SIZE) {
1263                    let _ = resume_updates_rx.try_recv();
1264                    loop {
1265                        let result = callback(update.clone());
1266                        if result.await {
1267                            break;
1268                        } else {
1269                            log::info!("waiting to resume updates");
1270                            if resume_updates_rx.next().await.is_none() {
1271                                return Some(());
1272                            }
1273                        }
1274                    }
1275                }
1276            }
1277            share_tx.send(()).ok();
1278            Some(())
1279        });
1280
1281        self.share = Some(ShareState {
1282            project_id,
1283            snapshots_tx,
1284            resume_updates: resume_updates_tx,
1285            _maintain_remote_snapshot,
1286        });
1287        share_rx
1288    }
1289
1290    pub fn share(&mut self, project_id: u64, cx: &mut ModelContext<Worktree>) -> Task<Result<()>> {
1291        let client = self.client.clone();
1292
1293        for (path, summaries) in &self.diagnostic_summaries {
1294            for (&server_id, summary) in summaries {
1295                if let Err(e) = self.client.send(proto::UpdateDiagnosticSummary {
1296                    project_id,
1297                    worktree_id: cx.model_id() as u64,
1298                    summary: Some(summary.to_proto(server_id, &path)),
1299                }) {
1300                    return Task::ready(Err(e));
1301                }
1302            }
1303        }
1304
1305        let rx = self.observe_updates(project_id, cx, move |update| {
1306            client.request(update).map(|result| result.is_ok())
1307        });
1308        cx.foreground()
1309            .spawn(async move { rx.await.map_err(|_| anyhow!("share ended")) })
1310    }
1311
1312    pub fn unshare(&mut self) {
1313        self.share.take();
1314    }
1315
1316    pub fn is_shared(&self) -> bool {
1317        self.share.is_some()
1318    }
1319}
1320
1321impl RemoteWorktree {
1322    fn snapshot(&self) -> Snapshot {
1323        self.snapshot.clone()
1324    }
1325
1326    pub fn disconnected_from_host(&mut self) {
1327        self.updates_tx.take();
1328        self.snapshot_subscriptions.clear();
1329        self.disconnected = true;
1330    }
1331
1332    pub fn save_buffer(
1333        &self,
1334        buffer_handle: ModelHandle<Buffer>,
1335        cx: &mut ModelContext<Worktree>,
1336    ) -> Task<Result<()>> {
1337        let buffer = buffer_handle.read(cx);
1338        let buffer_id = buffer.remote_id();
1339        let version = buffer.version();
1340        let rpc = self.client.clone();
1341        let project_id = self.project_id;
1342        cx.as_mut().spawn(|mut cx| async move {
1343            let response = rpc
1344                .request(proto::SaveBuffer {
1345                    project_id,
1346                    buffer_id,
1347                    version: serialize_version(&version),
1348                })
1349                .await?;
1350            let version = deserialize_version(&response.version);
1351            let fingerprint = deserialize_fingerprint(&response.fingerprint)?;
1352            let mtime = response
1353                .mtime
1354                .ok_or_else(|| anyhow!("missing mtime"))?
1355                .into();
1356
1357            buffer_handle.update(&mut cx, |buffer, cx| {
1358                buffer.did_save(version.clone(), fingerprint, mtime, cx);
1359            });
1360
1361            Ok(())
1362        })
1363    }
1364
1365    pub fn update_from_remote(&mut self, update: proto::UpdateWorktree) {
1366        if let Some(updates_tx) = &self.updates_tx {
1367            updates_tx
1368                .unbounded_send(update)
1369                .expect("consumer runs to completion");
1370        }
1371    }
1372
1373    fn observed_snapshot(&self, scan_id: usize) -> bool {
1374        self.completed_scan_id >= scan_id
1375    }
1376
1377    pub(crate) fn wait_for_snapshot(&mut self, scan_id: usize) -> impl Future<Output = Result<()>> {
1378        let (tx, rx) = oneshot::channel();
1379        if self.observed_snapshot(scan_id) {
1380            let _ = tx.send(());
1381        } else if self.disconnected {
1382            drop(tx);
1383        } else {
1384            match self
1385                .snapshot_subscriptions
1386                .binary_search_by_key(&scan_id, |probe| probe.0)
1387            {
1388                Ok(ix) | Err(ix) => self.snapshot_subscriptions.insert(ix, (scan_id, tx)),
1389            }
1390        }
1391
1392        async move {
1393            rx.await?;
1394            Ok(())
1395        }
1396    }
1397
1398    pub fn update_diagnostic_summary(
1399        &mut self,
1400        path: Arc<Path>,
1401        summary: &proto::DiagnosticSummary,
1402    ) {
1403        let server_id = LanguageServerId(summary.language_server_id as usize);
1404        let summary = DiagnosticSummary {
1405            error_count: summary.error_count as usize,
1406            warning_count: summary.warning_count as usize,
1407        };
1408
1409        if summary.is_empty() {
1410            if let Some(summaries) = self.diagnostic_summaries.get_mut(&path) {
1411                summaries.remove(&server_id);
1412                if summaries.is_empty() {
1413                    self.diagnostic_summaries.remove(&path);
1414                }
1415            }
1416        } else {
1417            self.diagnostic_summaries
1418                .entry(path)
1419                .or_default()
1420                .insert(server_id, summary);
1421        }
1422    }
1423
1424    pub fn insert_entry(
1425        &mut self,
1426        entry: proto::Entry,
1427        scan_id: usize,
1428        cx: &mut ModelContext<Worktree>,
1429    ) -> Task<Result<Entry>> {
1430        let wait_for_snapshot = self.wait_for_snapshot(scan_id);
1431        cx.spawn(|this, mut cx| async move {
1432            wait_for_snapshot.await?;
1433            this.update(&mut cx, |worktree, _| {
1434                let worktree = worktree.as_remote_mut().unwrap();
1435                let mut snapshot = worktree.background_snapshot.lock();
1436                let entry = snapshot.insert_entry(entry);
1437                worktree.snapshot = snapshot.clone();
1438                entry
1439            })
1440        })
1441    }
1442
1443    pub(crate) fn delete_entry(
1444        &mut self,
1445        id: ProjectEntryId,
1446        scan_id: usize,
1447        cx: &mut ModelContext<Worktree>,
1448    ) -> Task<Result<()>> {
1449        let wait_for_snapshot = self.wait_for_snapshot(scan_id);
1450        cx.spawn(|this, mut cx| async move {
1451            wait_for_snapshot.await?;
1452            this.update(&mut cx, |worktree, _| {
1453                let worktree = worktree.as_remote_mut().unwrap();
1454                let mut snapshot = worktree.background_snapshot.lock();
1455                snapshot.delete_entry(id);
1456                worktree.snapshot = snapshot.clone();
1457            });
1458            Ok(())
1459        })
1460    }
1461}
1462
1463impl Snapshot {
1464    pub fn id(&self) -> WorktreeId {
1465        self.id
1466    }
1467
1468    pub fn abs_path(&self) -> &Arc<Path> {
1469        &self.abs_path
1470    }
1471
1472    pub fn absolutize(&self, path: &Path) -> PathBuf {
1473        if path.file_name().is_some() {
1474            self.abs_path.join(path)
1475        } else {
1476            self.abs_path.to_path_buf()
1477        }
1478    }
1479
1480    pub fn contains_entry(&self, entry_id: ProjectEntryId) -> bool {
1481        self.entries_by_id.get(&entry_id, &()).is_some()
1482    }
1483
1484    pub(crate) fn insert_entry(&mut self, entry: proto::Entry) -> Result<Entry> {
1485        let entry = Entry::try_from((&self.root_char_bag, entry))?;
1486        let old_entry = self.entries_by_id.insert_or_replace(
1487            PathEntry {
1488                id: entry.id,
1489                path: entry.path.clone(),
1490                is_ignored: entry.is_ignored,
1491                scan_id: 0,
1492            },
1493            &(),
1494        );
1495        if let Some(old_entry) = old_entry {
1496            self.entries_by_path.remove(&PathKey(old_entry.path), &());
1497        }
1498        self.entries_by_path.insert_or_replace(entry.clone(), &());
1499        Ok(entry)
1500    }
1501
1502    fn delete_entry(&mut self, entry_id: ProjectEntryId) -> Option<Arc<Path>> {
1503        let removed_entry = self.entries_by_id.remove(&entry_id, &())?;
1504        self.entries_by_path = {
1505            let mut cursor = self.entries_by_path.cursor::<TraversalProgress>();
1506            let mut new_entries_by_path =
1507                cursor.slice(&TraversalTarget::Path(&removed_entry.path), Bias::Left, &());
1508            while let Some(entry) = cursor.item() {
1509                if entry.path.starts_with(&removed_entry.path) {
1510                    self.entries_by_id.remove(&entry.id, &());
1511                    cursor.next(&());
1512                } else {
1513                    break;
1514                }
1515            }
1516            new_entries_by_path.append(cursor.suffix(&()), &());
1517            new_entries_by_path
1518        };
1519
1520        Some(removed_entry.path)
1521    }
1522
1523    #[cfg(any(test, feature = "test-support"))]
1524    pub fn status_for_file(&self, path: impl Into<PathBuf>) -> Option<GitFileStatus> {
1525        let path = path.into();
1526        self.entries_by_path
1527            .get(&PathKey(Arc::from(path)), &())
1528            .and_then(|entry| entry.git_status)
1529    }
1530
1531    pub(crate) fn apply_remote_update(&mut self, mut update: proto::UpdateWorktree) -> Result<()> {
1532        let mut entries_by_path_edits = Vec::new();
1533        let mut entries_by_id_edits = Vec::new();
1534
1535        for entry_id in update.removed_entries {
1536            let entry_id = ProjectEntryId::from_proto(entry_id);
1537            entries_by_id_edits.push(Edit::Remove(entry_id));
1538            if let Some(entry) = self.entry_for_id(entry_id) {
1539                entries_by_path_edits.push(Edit::Remove(PathKey(entry.path.clone())));
1540            }
1541        }
1542
1543        for entry in update.updated_entries {
1544            let entry = Entry::try_from((&self.root_char_bag, entry))?;
1545            if let Some(PathEntry { path, .. }) = self.entries_by_id.get(&entry.id, &()) {
1546                entries_by_path_edits.push(Edit::Remove(PathKey(path.clone())));
1547            }
1548            if let Some(old_entry) = self.entries_by_path.get(&PathKey(entry.path.clone()), &()) {
1549                if old_entry.id != entry.id {
1550                    entries_by_id_edits.push(Edit::Remove(old_entry.id));
1551                }
1552            }
1553            entries_by_id_edits.push(Edit::Insert(PathEntry {
1554                id: entry.id,
1555                path: entry.path.clone(),
1556                is_ignored: entry.is_ignored,
1557                scan_id: 0,
1558            }));
1559            entries_by_path_edits.push(Edit::Insert(entry));
1560        }
1561
1562        self.entries_by_path.edit(entries_by_path_edits, &());
1563        self.entries_by_id.edit(entries_by_id_edits, &());
1564
1565        update.removed_repositories.sort_unstable();
1566        self.repository_entries.retain(|_, entry| {
1567            if let Ok(_) = update
1568                .removed_repositories
1569                .binary_search(&entry.work_directory.to_proto())
1570            {
1571                false
1572            } else {
1573                true
1574            }
1575        });
1576
1577        for repository in update.updated_repositories {
1578            let work_directory_entry: WorkDirectoryEntry =
1579                ProjectEntryId::from_proto(repository.work_directory_id).into();
1580
1581            if let Some(entry) = self.entry_for_id(*work_directory_entry) {
1582                let work_directory = RepositoryWorkDirectory(entry.path.clone());
1583                if self.repository_entries.get(&work_directory).is_some() {
1584                    self.repository_entries.update(&work_directory, |repo| {
1585                        repo.branch = repository.branch.map(Into::into);
1586                    });
1587                } else {
1588                    self.repository_entries.insert(
1589                        work_directory,
1590                        RepositoryEntry {
1591                            work_directory: work_directory_entry,
1592                            branch: repository.branch.map(Into::into),
1593                        },
1594                    )
1595                }
1596            } else {
1597                log::error!("no work directory entry for repository {:?}", repository)
1598            }
1599        }
1600
1601        self.scan_id = update.scan_id as usize;
1602        if update.is_last_update {
1603            self.completed_scan_id = update.scan_id as usize;
1604        }
1605
1606        Ok(())
1607    }
1608
1609    pub fn file_count(&self) -> usize {
1610        self.entries_by_path.summary().file_count
1611    }
1612
1613    pub fn visible_file_count(&self) -> usize {
1614        self.entries_by_path.summary().non_ignored_file_count
1615    }
1616
1617    fn traverse_from_offset(
1618        &self,
1619        include_dirs: bool,
1620        include_ignored: bool,
1621        start_offset: usize,
1622    ) -> Traversal {
1623        let mut cursor = self.entries_by_path.cursor();
1624        cursor.seek(
1625            &TraversalTarget::Count {
1626                count: start_offset,
1627                include_dirs,
1628                include_ignored,
1629            },
1630            Bias::Right,
1631            &(),
1632        );
1633        Traversal {
1634            cursor,
1635            include_dirs,
1636            include_ignored,
1637        }
1638    }
1639
1640    fn traverse_from_path(
1641        &self,
1642        include_dirs: bool,
1643        include_ignored: bool,
1644        path: &Path,
1645    ) -> Traversal {
1646        let mut cursor = self.entries_by_path.cursor();
1647        cursor.seek(&TraversalTarget::Path(path), Bias::Left, &());
1648        Traversal {
1649            cursor,
1650            include_dirs,
1651            include_ignored,
1652        }
1653    }
1654
1655    pub fn files(&self, include_ignored: bool, start: usize) -> Traversal {
1656        self.traverse_from_offset(false, include_ignored, start)
1657    }
1658
1659    pub fn entries(&self, include_ignored: bool) -> Traversal {
1660        self.traverse_from_offset(true, include_ignored, 0)
1661    }
1662
1663    pub fn repositories(&self) -> impl Iterator<Item = (&Arc<Path>, &RepositoryEntry)> {
1664        self.repository_entries
1665            .iter()
1666            .map(|(path, entry)| (&path.0, entry))
1667    }
1668
1669    /// Get the repository whose work directory contains the given path.
1670    pub fn repository_for_work_directory(&self, path: &Path) -> Option<RepositoryEntry> {
1671        self.repository_entries
1672            .get(&RepositoryWorkDirectory(path.into()))
1673            .cloned()
1674    }
1675
1676    /// Get the repository whose work directory contains the given path.
1677    pub fn repository_for_path(&self, path: &Path) -> Option<RepositoryEntry> {
1678        self.repository_and_work_directory_for_path(path)
1679            .map(|e| e.1)
1680    }
1681
1682    pub fn repository_and_work_directory_for_path(
1683        &self,
1684        path: &Path,
1685    ) -> Option<(RepositoryWorkDirectory, RepositoryEntry)> {
1686        self.repository_entries
1687            .iter()
1688            .filter(|(workdir_path, _)| path.starts_with(workdir_path))
1689            .last()
1690            .map(|(path, repo)| (path.clone(), repo.clone()))
1691    }
1692
1693    /// Given an ordered iterator of entries, returns an iterator of those entries,
1694    /// along with their containing git repository.
1695    pub fn entries_with_repositories<'a>(
1696        &'a self,
1697        entries: impl 'a + Iterator<Item = &'a Entry>,
1698    ) -> impl 'a + Iterator<Item = (&'a Entry, Option<&'a RepositoryEntry>)> {
1699        let mut containing_repos = Vec::<(&Arc<Path>, &RepositoryEntry)>::new();
1700        let mut repositories = self.repositories().peekable();
1701        entries.map(move |entry| {
1702            while let Some((repo_path, _)) = containing_repos.last() {
1703                if !entry.path.starts_with(repo_path) {
1704                    containing_repos.pop();
1705                } else {
1706                    break;
1707                }
1708            }
1709            while let Some((repo_path, _)) = repositories.peek() {
1710                if entry.path.starts_with(repo_path) {
1711                    containing_repos.push(repositories.next().unwrap());
1712                } else {
1713                    break;
1714                }
1715            }
1716            let repo = containing_repos.last().map(|(_, repo)| *repo);
1717            (entry, repo)
1718        })
1719    }
1720
1721    /// Update the `git_status` of the given entries such that files'
1722    /// statuses bubble up to their ancestor directories.
1723    pub fn propagate_git_statuses(&self, result: &mut [Entry]) {
1724        let mut cursor = self
1725            .entries_by_path
1726            .cursor::<(TraversalProgress, GitStatuses)>();
1727        let mut entry_stack = Vec::<(usize, GitStatuses)>::new();
1728
1729        let mut result_ix = 0;
1730        loop {
1731            let next_entry = result.get(result_ix);
1732            let containing_entry = entry_stack.last().map(|(ix, _)| &result[*ix]);
1733
1734            let entry_to_finish = match (containing_entry, next_entry) {
1735                (Some(_), None) => entry_stack.pop(),
1736                (Some(containing_entry), Some(next_path)) => {
1737                    if !next_path.path.starts_with(&containing_entry.path) {
1738                        entry_stack.pop()
1739                    } else {
1740                        None
1741                    }
1742                }
1743                (None, Some(_)) => None,
1744                (None, None) => break,
1745            };
1746
1747            if let Some((entry_ix, prev_statuses)) = entry_to_finish {
1748                cursor.seek_forward(
1749                    &TraversalTarget::PathSuccessor(&result[entry_ix].path),
1750                    Bias::Left,
1751                    &(),
1752                );
1753
1754                let statuses = cursor.start().1 - prev_statuses;
1755
1756                result[entry_ix].git_status = if statuses.conflict > 0 {
1757                    Some(GitFileStatus::Conflict)
1758                } else if statuses.modified > 0 {
1759                    Some(GitFileStatus::Modified)
1760                } else if statuses.added > 0 {
1761                    Some(GitFileStatus::Added)
1762                } else {
1763                    None
1764                };
1765            } else {
1766                if result[result_ix].is_dir() {
1767                    cursor.seek_forward(
1768                        &TraversalTarget::Path(&result[result_ix].path),
1769                        Bias::Left,
1770                        &(),
1771                    );
1772                    entry_stack.push((result_ix, cursor.start().1));
1773                }
1774                result_ix += 1;
1775            }
1776        }
1777    }
1778
1779    pub fn paths(&self) -> impl Iterator<Item = &Arc<Path>> {
1780        let empty_path = Path::new("");
1781        self.entries_by_path
1782            .cursor::<()>()
1783            .filter(move |entry| entry.path.as_ref() != empty_path)
1784            .map(|entry| &entry.path)
1785    }
1786
1787    fn child_entries<'a>(&'a self, parent_path: &'a Path) -> ChildEntriesIter<'a> {
1788        let mut cursor = self.entries_by_path.cursor();
1789        cursor.seek(&TraversalTarget::Path(parent_path), Bias::Right, &());
1790        let traversal = Traversal {
1791            cursor,
1792            include_dirs: true,
1793            include_ignored: true,
1794        };
1795        ChildEntriesIter {
1796            traversal,
1797            parent_path,
1798        }
1799    }
1800
1801    pub fn descendent_entries<'a>(
1802        &'a self,
1803        include_dirs: bool,
1804        include_ignored: bool,
1805        parent_path: &'a Path,
1806    ) -> DescendentEntriesIter<'a> {
1807        let mut cursor = self.entries_by_path.cursor();
1808        cursor.seek(&TraversalTarget::Path(parent_path), Bias::Left, &());
1809        let mut traversal = Traversal {
1810            cursor,
1811            include_dirs,
1812            include_ignored,
1813        };
1814
1815        if traversal.end_offset() == traversal.start_offset() {
1816            traversal.advance();
1817        }
1818
1819        DescendentEntriesIter {
1820            traversal,
1821            parent_path,
1822        }
1823    }
1824
1825    pub fn root_entry(&self) -> Option<&Entry> {
1826        self.entry_for_path("")
1827    }
1828
1829    pub fn root_name(&self) -> &str {
1830        &self.root_name
1831    }
1832
1833    pub fn root_git_entry(&self) -> Option<RepositoryEntry> {
1834        self.repository_entries
1835            .get(&RepositoryWorkDirectory(Path::new("").into()))
1836            .map(|entry| entry.to_owned())
1837    }
1838
1839    pub fn git_entries(&self) -> impl Iterator<Item = &RepositoryEntry> {
1840        self.repository_entries.values()
1841    }
1842
1843    pub fn scan_id(&self) -> usize {
1844        self.scan_id
1845    }
1846
1847    pub fn entry_for_path(&self, path: impl AsRef<Path>) -> Option<&Entry> {
1848        let path = path.as_ref();
1849        self.traverse_from_path(true, true, path)
1850            .entry()
1851            .and_then(|entry| {
1852                if entry.path.as_ref() == path {
1853                    Some(entry)
1854                } else {
1855                    None
1856                }
1857            })
1858    }
1859
1860    pub fn entry_for_id(&self, id: ProjectEntryId) -> Option<&Entry> {
1861        let entry = self.entries_by_id.get(&id, &())?;
1862        self.entry_for_path(&entry.path)
1863    }
1864
1865    pub fn inode_for_path(&self, path: impl AsRef<Path>) -> Option<u64> {
1866        self.entry_for_path(path.as_ref()).map(|e| e.inode)
1867    }
1868}
1869
1870impl LocalSnapshot {
1871    pub(crate) fn get_local_repo(&self, repo: &RepositoryEntry) -> Option<&LocalRepositoryEntry> {
1872        self.git_repositories.get(&repo.work_directory.0)
1873    }
1874
1875    pub(crate) fn local_repo_for_path(
1876        &self,
1877        path: &Path,
1878    ) -> Option<(RepositoryWorkDirectory, &LocalRepositoryEntry)> {
1879        let (path, repo) = self.repository_and_work_directory_for_path(path)?;
1880        Some((path, self.git_repositories.get(&repo.work_directory_id())?))
1881    }
1882
1883    fn build_update(
1884        &self,
1885        project_id: u64,
1886        worktree_id: u64,
1887        entry_changes: UpdatedEntriesSet,
1888        repo_changes: UpdatedGitRepositoriesSet,
1889    ) -> proto::UpdateWorktree {
1890        let mut updated_entries = Vec::new();
1891        let mut removed_entries = Vec::new();
1892        let mut updated_repositories = Vec::new();
1893        let mut removed_repositories = Vec::new();
1894
1895        for (_, entry_id, path_change) in entry_changes.iter() {
1896            if let PathChange::Removed = path_change {
1897                removed_entries.push(entry_id.0 as u64);
1898            } else if let Some(entry) = self.entry_for_id(*entry_id) {
1899                updated_entries.push(proto::Entry::from(entry));
1900            }
1901        }
1902
1903        for (work_dir_path, change) in repo_changes.iter() {
1904            let new_repo = self
1905                .repository_entries
1906                .get(&RepositoryWorkDirectory(work_dir_path.clone()));
1907            match (&change.old_repository, new_repo) {
1908                (Some(old_repo), Some(new_repo)) => {
1909                    updated_repositories.push(new_repo.build_update(old_repo));
1910                }
1911                (None, Some(new_repo)) => {
1912                    updated_repositories.push(proto::RepositoryEntry::from(new_repo));
1913                }
1914                (Some(old_repo), None) => {
1915                    removed_repositories.push(old_repo.work_directory.0.to_proto());
1916                }
1917                _ => {}
1918            }
1919        }
1920
1921        removed_entries.sort_unstable();
1922        updated_entries.sort_unstable_by_key(|e| e.id);
1923        removed_repositories.sort_unstable();
1924        updated_repositories.sort_unstable_by_key(|e| e.work_directory_id);
1925
1926        // TODO - optimize, knowing that removed_entries are sorted.
1927        removed_entries.retain(|id| updated_entries.binary_search_by_key(id, |e| e.id).is_err());
1928
1929        proto::UpdateWorktree {
1930            project_id,
1931            worktree_id,
1932            abs_path: self.abs_path().to_string_lossy().into(),
1933            root_name: self.root_name().to_string(),
1934            updated_entries,
1935            removed_entries,
1936            scan_id: self.scan_id as u64,
1937            is_last_update: self.completed_scan_id == self.scan_id,
1938            updated_repositories,
1939            removed_repositories,
1940        }
1941    }
1942
1943    fn build_initial_update(&self, project_id: u64, worktree_id: u64) -> proto::UpdateWorktree {
1944        let mut updated_entries = self
1945            .entries_by_path
1946            .iter()
1947            .map(proto::Entry::from)
1948            .collect::<Vec<_>>();
1949        updated_entries.sort_unstable_by_key(|e| e.id);
1950
1951        let mut updated_repositories = self
1952            .repository_entries
1953            .values()
1954            .map(proto::RepositoryEntry::from)
1955            .collect::<Vec<_>>();
1956        updated_repositories.sort_unstable_by_key(|e| e.work_directory_id);
1957
1958        proto::UpdateWorktree {
1959            project_id,
1960            worktree_id,
1961            abs_path: self.abs_path().to_string_lossy().into(),
1962            root_name: self.root_name().to_string(),
1963            updated_entries,
1964            removed_entries: Vec::new(),
1965            scan_id: self.scan_id as u64,
1966            is_last_update: self.completed_scan_id == self.scan_id,
1967            updated_repositories,
1968            removed_repositories: Vec::new(),
1969        }
1970    }
1971
1972    fn insert_entry(&mut self, mut entry: Entry, fs: &dyn Fs) -> Entry {
1973        if entry.is_file() && entry.path.file_name() == Some(&GITIGNORE) {
1974            let abs_path = self.abs_path.join(&entry.path);
1975            match smol::block_on(build_gitignore(&abs_path, fs)) {
1976                Ok(ignore) => {
1977                    self.ignores_by_parent_abs_path
1978                        .insert(abs_path.parent().unwrap().into(), (Arc::new(ignore), true));
1979                }
1980                Err(error) => {
1981                    log::error!(
1982                        "error loading .gitignore file {:?} - {:?}",
1983                        &entry.path,
1984                        error
1985                    );
1986                }
1987            }
1988        }
1989
1990        if entry.kind == EntryKind::PendingDir {
1991            if let Some(existing_entry) =
1992                self.entries_by_path.get(&PathKey(entry.path.clone()), &())
1993            {
1994                entry.kind = existing_entry.kind;
1995            }
1996        }
1997
1998        let scan_id = self.scan_id;
1999        let removed = self.entries_by_path.insert_or_replace(entry.clone(), &());
2000        if let Some(removed) = removed {
2001            if removed.id != entry.id {
2002                self.entries_by_id.remove(&removed.id, &());
2003            }
2004        }
2005        self.entries_by_id.insert_or_replace(
2006            PathEntry {
2007                id: entry.id,
2008                path: entry.path.clone(),
2009                is_ignored: entry.is_ignored,
2010                scan_id,
2011            },
2012            &(),
2013        );
2014
2015        entry
2016    }
2017
2018    fn ancestor_inodes_for_path(&self, path: &Path) -> TreeSet<u64> {
2019        let mut inodes = TreeSet::default();
2020        for ancestor in path.ancestors().skip(1) {
2021            if let Some(entry) = self.entry_for_path(ancestor) {
2022                inodes.insert(entry.inode);
2023            }
2024        }
2025        inodes
2026    }
2027
2028    fn ignore_stack_for_abs_path(&self, abs_path: &Path, is_dir: bool) -> Arc<IgnoreStack> {
2029        let mut new_ignores = Vec::new();
2030        for (index, ancestor) in abs_path.ancestors().enumerate() {
2031            if index > 0 {
2032                if let Some((ignore, _)) = self.ignores_by_parent_abs_path.get(ancestor) {
2033                    new_ignores.push((ancestor, Some(ignore.clone())));
2034                } else {
2035                    new_ignores.push((ancestor, None));
2036                }
2037            }
2038            if ancestor.join(&*DOT_GIT).is_dir() {
2039                break;
2040            }
2041        }
2042
2043        let mut ignore_stack = IgnoreStack::none();
2044        for (parent_abs_path, ignore) in new_ignores.into_iter().rev() {
2045            if ignore_stack.is_abs_path_ignored(parent_abs_path, true) {
2046                ignore_stack = IgnoreStack::all();
2047                break;
2048            } else if let Some(ignore) = ignore {
2049                ignore_stack = ignore_stack.append(parent_abs_path.into(), ignore);
2050            }
2051        }
2052
2053        if ignore_stack.is_abs_path_ignored(abs_path, is_dir) {
2054            ignore_stack = IgnoreStack::all();
2055        }
2056        ignore_stack
2057    }
2058
2059    #[cfg(test)]
2060    pub(crate) fn expanded_entries(&self) -> impl Iterator<Item = &Entry> {
2061        self.entries_by_path
2062            .cursor::<()>()
2063            .filter(|entry| entry.kind == EntryKind::Dir && (entry.is_external || entry.is_ignored))
2064    }
2065
2066    #[cfg(test)]
2067    pub fn check_invariants(&self, git_state: bool) {
2068        use pretty_assertions::assert_eq;
2069
2070        assert_eq!(
2071            self.entries_by_path
2072                .cursor::<()>()
2073                .map(|e| (&e.path, e.id))
2074                .collect::<Vec<_>>(),
2075            self.entries_by_id
2076                .cursor::<()>()
2077                .map(|e| (&e.path, e.id))
2078                .collect::<collections::BTreeSet<_>>()
2079                .into_iter()
2080                .collect::<Vec<_>>(),
2081            "entries_by_path and entries_by_id are inconsistent"
2082        );
2083
2084        let mut files = self.files(true, 0);
2085        let mut visible_files = self.files(false, 0);
2086        for entry in self.entries_by_path.cursor::<()>() {
2087            if entry.is_file() {
2088                assert_eq!(files.next().unwrap().inode, entry.inode);
2089                if !entry.is_ignored && !entry.is_external {
2090                    assert_eq!(visible_files.next().unwrap().inode, entry.inode);
2091                }
2092            }
2093        }
2094
2095        assert!(files.next().is_none());
2096        assert!(visible_files.next().is_none());
2097
2098        let mut bfs_paths = Vec::new();
2099        let mut stack = self
2100            .root_entry()
2101            .map(|e| e.path.as_ref())
2102            .into_iter()
2103            .collect::<Vec<_>>();
2104        while let Some(path) = stack.pop() {
2105            bfs_paths.push(path);
2106            let ix = stack.len();
2107            for child_entry in self.child_entries(path) {
2108                stack.insert(ix, &child_entry.path);
2109            }
2110        }
2111
2112        let dfs_paths_via_iter = self
2113            .entries_by_path
2114            .cursor::<()>()
2115            .map(|e| e.path.as_ref())
2116            .collect::<Vec<_>>();
2117        assert_eq!(bfs_paths, dfs_paths_via_iter);
2118
2119        let dfs_paths_via_traversal = self
2120            .entries(true)
2121            .map(|e| e.path.as_ref())
2122            .collect::<Vec<_>>();
2123        assert_eq!(dfs_paths_via_traversal, dfs_paths_via_iter);
2124
2125        if git_state {
2126            for ignore_parent_abs_path in self.ignores_by_parent_abs_path.keys() {
2127                let ignore_parent_path =
2128                    ignore_parent_abs_path.strip_prefix(&self.abs_path).unwrap();
2129                assert!(self.entry_for_path(&ignore_parent_path).is_some());
2130                assert!(self
2131                    .entry_for_path(ignore_parent_path.join(&*GITIGNORE))
2132                    .is_some());
2133            }
2134        }
2135    }
2136
2137    #[cfg(test)]
2138    pub fn entries_without_ids(&self, include_ignored: bool) -> Vec<(&Path, u64, bool)> {
2139        let mut paths = Vec::new();
2140        for entry in self.entries_by_path.cursor::<()>() {
2141            if include_ignored || !entry.is_ignored {
2142                paths.push((entry.path.as_ref(), entry.inode, entry.is_ignored));
2143            }
2144        }
2145        paths.sort_by(|a, b| a.0.cmp(b.0));
2146        paths
2147    }
2148}
2149
2150impl BackgroundScannerState {
2151    fn should_scan_directory(&self, entry: &Entry) -> bool {
2152        (!entry.is_external && !entry.is_ignored)
2153            || entry.path.file_name() == Some(&*DOT_GIT)
2154            || self.scanned_dirs.contains(&entry.id) // If we've ever scanned it, keep scanning
2155            || self
2156                .paths_to_scan
2157                .iter()
2158                .any(|p| p.starts_with(&entry.path))
2159            || self
2160                .path_prefixes_to_scan
2161                .iter()
2162                .any(|p| entry.path.starts_with(p))
2163    }
2164
2165    fn enqueue_scan_dir(&self, abs_path: Arc<Path>, entry: &Entry, scan_job_tx: &Sender<ScanJob>) {
2166        let path = entry.path.clone();
2167        let ignore_stack = self.snapshot.ignore_stack_for_abs_path(&abs_path, true);
2168        let mut ancestor_inodes = self.snapshot.ancestor_inodes_for_path(&path);
2169        let mut containing_repository = None;
2170        if !ignore_stack.is_all() {
2171            if let Some((workdir_path, repo)) = self.snapshot.local_repo_for_path(&path) {
2172                if let Ok(repo_path) = path.strip_prefix(&workdir_path.0) {
2173                    containing_repository = Some((
2174                        workdir_path,
2175                        repo.repo_ptr.clone(),
2176                        repo.repo_ptr.lock().staged_statuses(repo_path),
2177                    ));
2178                }
2179            }
2180        }
2181        if !ancestor_inodes.contains(&entry.inode) {
2182            ancestor_inodes.insert(entry.inode);
2183            scan_job_tx
2184                .try_send(ScanJob {
2185                    abs_path,
2186                    path,
2187                    ignore_stack,
2188                    scan_queue: scan_job_tx.clone(),
2189                    ancestor_inodes,
2190                    is_external: entry.is_external,
2191                    containing_repository,
2192                })
2193                .unwrap();
2194        }
2195    }
2196
2197    fn reuse_entry_id(&mut self, entry: &mut Entry) {
2198        if let Some(removed_entry_id) = self.removed_entry_ids.remove(&entry.inode) {
2199            entry.id = removed_entry_id;
2200        } else if let Some(existing_entry) = self.snapshot.entry_for_path(&entry.path) {
2201            entry.id = existing_entry.id;
2202        }
2203    }
2204
2205    fn insert_entry(&mut self, mut entry: Entry, fs: &dyn Fs) -> Entry {
2206        self.reuse_entry_id(&mut entry);
2207        let entry = self.snapshot.insert_entry(entry, fs);
2208        if entry.path.file_name() == Some(&DOT_GIT) {
2209            self.build_git_repository(entry.path.clone(), fs);
2210        }
2211
2212        #[cfg(test)]
2213        self.snapshot.check_invariants(false);
2214
2215        entry
2216    }
2217
2218    fn populate_dir(
2219        &mut self,
2220        parent_path: &Arc<Path>,
2221        entries: impl IntoIterator<Item = Entry>,
2222        ignore: Option<Arc<Gitignore>>,
2223    ) {
2224        let mut parent_entry = if let Some(parent_entry) = self
2225            .snapshot
2226            .entries_by_path
2227            .get(&PathKey(parent_path.clone()), &())
2228        {
2229            parent_entry.clone()
2230        } else {
2231            log::warn!(
2232                "populating a directory {:?} that has been removed",
2233                parent_path
2234            );
2235            return;
2236        };
2237
2238        match parent_entry.kind {
2239            EntryKind::PendingDir | EntryKind::UnloadedDir => parent_entry.kind = EntryKind::Dir,
2240            EntryKind::Dir => {}
2241            _ => return,
2242        }
2243
2244        if let Some(ignore) = ignore {
2245            let abs_parent_path = self.snapshot.abs_path.join(&parent_path).into();
2246            self.snapshot
2247                .ignores_by_parent_abs_path
2248                .insert(abs_parent_path, (ignore, false));
2249        }
2250
2251        let parent_entry_id = parent_entry.id;
2252        self.scanned_dirs.insert(parent_entry_id);
2253        let mut entries_by_path_edits = vec![Edit::Insert(parent_entry)];
2254        let mut entries_by_id_edits = Vec::new();
2255
2256        for entry in entries {
2257            entries_by_id_edits.push(Edit::Insert(PathEntry {
2258                id: entry.id,
2259                path: entry.path.clone(),
2260                is_ignored: entry.is_ignored,
2261                scan_id: self.snapshot.scan_id,
2262            }));
2263            entries_by_path_edits.push(Edit::Insert(entry));
2264        }
2265
2266        self.snapshot
2267            .entries_by_path
2268            .edit(entries_by_path_edits, &());
2269        self.snapshot.entries_by_id.edit(entries_by_id_edits, &());
2270
2271        if let Err(ix) = self.changed_paths.binary_search(parent_path) {
2272            self.changed_paths.insert(ix, parent_path.clone());
2273        }
2274
2275        #[cfg(test)]
2276        self.snapshot.check_invariants(false);
2277    }
2278
2279    fn remove_path(&mut self, path: &Path) {
2280        let mut new_entries;
2281        let removed_entries;
2282        {
2283            let mut cursor = self.snapshot.entries_by_path.cursor::<TraversalProgress>();
2284            new_entries = cursor.slice(&TraversalTarget::Path(path), Bias::Left, &());
2285            removed_entries = cursor.slice(&TraversalTarget::PathSuccessor(path), Bias::Left, &());
2286            new_entries.append(cursor.suffix(&()), &());
2287        }
2288        self.snapshot.entries_by_path = new_entries;
2289
2290        let mut entries_by_id_edits = Vec::new();
2291        for entry in removed_entries.cursor::<()>() {
2292            let removed_entry_id = self
2293                .removed_entry_ids
2294                .entry(entry.inode)
2295                .or_insert(entry.id);
2296            *removed_entry_id = cmp::max(*removed_entry_id, entry.id);
2297            entries_by_id_edits.push(Edit::Remove(entry.id));
2298        }
2299        self.snapshot.entries_by_id.edit(entries_by_id_edits, &());
2300
2301        if path.file_name() == Some(&GITIGNORE) {
2302            let abs_parent_path = self.snapshot.abs_path.join(path.parent().unwrap());
2303            if let Some((_, needs_update)) = self
2304                .snapshot
2305                .ignores_by_parent_abs_path
2306                .get_mut(abs_parent_path.as_path())
2307            {
2308                *needs_update = true;
2309            }
2310        }
2311
2312        #[cfg(test)]
2313        self.snapshot.check_invariants(false);
2314    }
2315
2316    fn reload_repositories(&mut self, changed_paths: &[Arc<Path>], fs: &dyn Fs) {
2317        let scan_id = self.snapshot.scan_id;
2318
2319        // Find each of the .git directories that contain any of the given paths.
2320        let mut prev_dot_git_dir = None;
2321        for changed_path in changed_paths {
2322            let Some(dot_git_dir) = changed_path
2323                .ancestors()
2324                .find(|ancestor| ancestor.file_name() == Some(&*DOT_GIT))
2325            else {
2326                continue;
2327            };
2328
2329            // Avoid processing the same repository multiple times, if multiple paths
2330            // within it have changed.
2331            if prev_dot_git_dir == Some(dot_git_dir) {
2332                continue;
2333            }
2334            prev_dot_git_dir = Some(dot_git_dir);
2335
2336            // If there is already a repository for this .git directory, reload
2337            // the status for all of its files.
2338            let repository = self
2339                .snapshot
2340                .git_repositories
2341                .iter()
2342                .find_map(|(entry_id, repo)| {
2343                    (repo.git_dir_path.as_ref() == dot_git_dir).then(|| (*entry_id, repo.clone()))
2344                });
2345            match repository {
2346                None => {
2347                    self.build_git_repository(dot_git_dir.into(), fs);
2348                }
2349                Some((entry_id, repository)) => {
2350                    if repository.git_dir_scan_id == scan_id {
2351                        continue;
2352                    }
2353                    let Some(work_dir) = self
2354                        .snapshot
2355                        .entry_for_id(entry_id)
2356                        .map(|entry| RepositoryWorkDirectory(entry.path.clone()))
2357                    else {
2358                        continue;
2359                    };
2360
2361                    log::info!("reload git repository {:?}", dot_git_dir);
2362                    let repository = repository.repo_ptr.lock();
2363                    let branch = repository.branch_name();
2364                    repository.reload_index();
2365
2366                    self.snapshot
2367                        .git_repositories
2368                        .update(&entry_id, |entry| entry.git_dir_scan_id = scan_id);
2369                    self.snapshot
2370                        .snapshot
2371                        .repository_entries
2372                        .update(&work_dir, |entry| entry.branch = branch.map(Into::into));
2373
2374                    self.update_git_statuses(&work_dir, &*repository);
2375                }
2376            }
2377        }
2378
2379        // Remove any git repositories whose .git entry no longer exists.
2380        let snapshot = &mut self.snapshot;
2381        let mut repositories = mem::take(&mut snapshot.git_repositories);
2382        let mut repository_entries = mem::take(&mut snapshot.repository_entries);
2383        repositories.retain(|work_directory_id, _| {
2384            snapshot
2385                .entry_for_id(*work_directory_id)
2386                .map_or(false, |entry| {
2387                    snapshot.entry_for_path(entry.path.join(*DOT_GIT)).is_some()
2388                })
2389        });
2390        repository_entries.retain(|_, entry| repositories.get(&entry.work_directory.0).is_some());
2391        snapshot.git_repositories = repositories;
2392        snapshot.repository_entries = repository_entries;
2393    }
2394
2395    fn build_git_repository(
2396        &mut self,
2397        dot_git_path: Arc<Path>,
2398        fs: &dyn Fs,
2399    ) -> Option<(
2400        RepositoryWorkDirectory,
2401        Arc<Mutex<dyn GitRepository>>,
2402        TreeMap<RepoPath, GitFileStatus>,
2403    )> {
2404        log::info!("build git repository {:?}", dot_git_path);
2405
2406        let work_dir_path: Arc<Path> = dot_git_path.parent().unwrap().into();
2407
2408        // Guard against repositories inside the repository metadata
2409        if work_dir_path.iter().any(|component| component == *DOT_GIT) {
2410            return None;
2411        };
2412
2413        let work_dir_id = self
2414            .snapshot
2415            .entry_for_path(work_dir_path.clone())
2416            .map(|entry| entry.id)?;
2417
2418        if self.snapshot.git_repositories.get(&work_dir_id).is_some() {
2419            return None;
2420        }
2421
2422        let abs_path = self.snapshot.abs_path.join(&dot_git_path);
2423        let repository = fs.open_repo(abs_path.as_path())?;
2424        let work_directory = RepositoryWorkDirectory(work_dir_path.clone());
2425
2426        let repo_lock = repository.lock();
2427        self.snapshot.repository_entries.insert(
2428            work_directory.clone(),
2429            RepositoryEntry {
2430                work_directory: work_dir_id.into(),
2431                branch: repo_lock.branch_name().map(Into::into),
2432            },
2433        );
2434
2435        let staged_statuses = self.update_git_statuses(&work_directory, &*repo_lock);
2436        drop(repo_lock);
2437
2438        self.snapshot.git_repositories.insert(
2439            work_dir_id,
2440            LocalRepositoryEntry {
2441                git_dir_scan_id: 0,
2442                repo_ptr: repository.clone(),
2443                git_dir_path: dot_git_path.clone(),
2444            },
2445        );
2446
2447        Some((work_directory, repository, staged_statuses))
2448    }
2449
2450    fn update_git_statuses(
2451        &mut self,
2452        work_directory: &RepositoryWorkDirectory,
2453        repo: &dyn GitRepository,
2454    ) -> TreeMap<RepoPath, GitFileStatus> {
2455        let staged_statuses = repo.staged_statuses(Path::new(""));
2456
2457        let mut changes = vec![];
2458        let mut edits = vec![];
2459
2460        for mut entry in self
2461            .snapshot
2462            .descendent_entries(false, false, &work_directory.0)
2463            .cloned()
2464        {
2465            let Ok(repo_path) = entry.path.strip_prefix(&work_directory.0) else {
2466                continue;
2467            };
2468            let repo_path = RepoPath(repo_path.to_path_buf());
2469            let git_file_status = combine_git_statuses(
2470                staged_statuses.get(&repo_path).copied(),
2471                repo.unstaged_status(&repo_path, entry.mtime),
2472            );
2473            if entry.git_status != git_file_status {
2474                entry.git_status = git_file_status;
2475                changes.push(entry.path.clone());
2476                edits.push(Edit::Insert(entry));
2477            }
2478        }
2479
2480        self.snapshot.entries_by_path.edit(edits, &());
2481        util::extend_sorted(&mut self.changed_paths, changes, usize::MAX, Ord::cmp);
2482        staged_statuses
2483    }
2484}
2485
2486async fn build_gitignore(abs_path: &Path, fs: &dyn Fs) -> Result<Gitignore> {
2487    let contents = fs.load(abs_path).await?;
2488    let parent = abs_path.parent().unwrap_or_else(|| Path::new("/"));
2489    let mut builder = GitignoreBuilder::new(parent);
2490    for line in contents.lines() {
2491        builder.add_line(Some(abs_path.into()), line)?;
2492    }
2493    Ok(builder.build()?)
2494}
2495
2496impl WorktreeId {
2497    pub fn from_usize(handle_id: usize) -> Self {
2498        Self(handle_id)
2499    }
2500
2501    pub(crate) fn from_proto(id: u64) -> Self {
2502        Self(id as usize)
2503    }
2504
2505    pub fn to_proto(&self) -> u64 {
2506        self.0 as u64
2507    }
2508
2509    pub fn to_usize(&self) -> usize {
2510        self.0
2511    }
2512}
2513
2514impl fmt::Display for WorktreeId {
2515    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2516        self.0.fmt(f)
2517    }
2518}
2519
2520impl Deref for Worktree {
2521    type Target = Snapshot;
2522
2523    fn deref(&self) -> &Self::Target {
2524        match self {
2525            Worktree::Local(worktree) => &worktree.snapshot,
2526            Worktree::Remote(worktree) => &worktree.snapshot,
2527        }
2528    }
2529}
2530
2531impl Deref for LocalWorktree {
2532    type Target = LocalSnapshot;
2533
2534    fn deref(&self) -> &Self::Target {
2535        &self.snapshot
2536    }
2537}
2538
2539impl Deref for RemoteWorktree {
2540    type Target = Snapshot;
2541
2542    fn deref(&self) -> &Self::Target {
2543        &self.snapshot
2544    }
2545}
2546
2547impl fmt::Debug for LocalWorktree {
2548    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2549        self.snapshot.fmt(f)
2550    }
2551}
2552
2553impl fmt::Debug for Snapshot {
2554    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2555        struct EntriesById<'a>(&'a SumTree<PathEntry>);
2556        struct EntriesByPath<'a>(&'a SumTree<Entry>);
2557
2558        impl<'a> fmt::Debug for EntriesByPath<'a> {
2559            fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2560                f.debug_map()
2561                    .entries(self.0.iter().map(|entry| (&entry.path, entry.id)))
2562                    .finish()
2563            }
2564        }
2565
2566        impl<'a> fmt::Debug for EntriesById<'a> {
2567            fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2568                f.debug_list().entries(self.0.iter()).finish()
2569            }
2570        }
2571
2572        f.debug_struct("Snapshot")
2573            .field("id", &self.id)
2574            .field("root_name", &self.root_name)
2575            .field("entries_by_path", &EntriesByPath(&self.entries_by_path))
2576            .field("entries_by_id", &EntriesById(&self.entries_by_id))
2577            .finish()
2578    }
2579}
2580
2581#[derive(Clone, PartialEq)]
2582pub struct File {
2583    pub worktree: ModelHandle<Worktree>,
2584    pub path: Arc<Path>,
2585    pub mtime: SystemTime,
2586    pub(crate) entry_id: ProjectEntryId,
2587    pub(crate) is_local: bool,
2588    pub(crate) is_deleted: bool,
2589}
2590
2591impl language::File for File {
2592    fn as_local(&self) -> Option<&dyn language::LocalFile> {
2593        if self.is_local {
2594            Some(self)
2595        } else {
2596            None
2597        }
2598    }
2599
2600    fn mtime(&self) -> SystemTime {
2601        self.mtime
2602    }
2603
2604    fn path(&self) -> &Arc<Path> {
2605        &self.path
2606    }
2607
2608    fn full_path(&self, cx: &AppContext) -> PathBuf {
2609        let mut full_path = PathBuf::new();
2610        let worktree = self.worktree.read(cx);
2611
2612        if worktree.is_visible() {
2613            full_path.push(worktree.root_name());
2614        } else {
2615            let path = worktree.abs_path();
2616
2617            if worktree.is_local() && path.starts_with(HOME.as_path()) {
2618                full_path.push("~");
2619                full_path.push(path.strip_prefix(HOME.as_path()).unwrap());
2620            } else {
2621                full_path.push(path)
2622            }
2623        }
2624
2625        if self.path.components().next().is_some() {
2626            full_path.push(&self.path);
2627        }
2628
2629        full_path
2630    }
2631
2632    /// Returns the last component of this handle's absolute path. If this handle refers to the root
2633    /// of its worktree, then this method will return the name of the worktree itself.
2634    fn file_name<'a>(&'a self, cx: &'a AppContext) -> &'a OsStr {
2635        self.path
2636            .file_name()
2637            .unwrap_or_else(|| OsStr::new(&self.worktree.read(cx).root_name))
2638    }
2639
2640    fn worktree_id(&self) -> usize {
2641        self.worktree.id()
2642    }
2643
2644    fn is_deleted(&self) -> bool {
2645        self.is_deleted
2646    }
2647
2648    fn as_any(&self) -> &dyn Any {
2649        self
2650    }
2651
2652    fn to_proto(&self) -> rpc::proto::File {
2653        rpc::proto::File {
2654            worktree_id: self.worktree.id() as u64,
2655            entry_id: self.entry_id.to_proto(),
2656            path: self.path.to_string_lossy().into(),
2657            mtime: Some(self.mtime.into()),
2658            is_deleted: self.is_deleted,
2659        }
2660    }
2661}
2662
2663impl language::LocalFile for File {
2664    fn abs_path(&self, cx: &AppContext) -> PathBuf {
2665        self.worktree
2666            .read(cx)
2667            .as_local()
2668            .unwrap()
2669            .abs_path
2670            .join(&self.path)
2671    }
2672
2673    fn load(&self, cx: &AppContext) -> Task<Result<String>> {
2674        let worktree = self.worktree.read(cx).as_local().unwrap();
2675        let abs_path = worktree.absolutize(&self.path);
2676        let fs = worktree.fs.clone();
2677        cx.background()
2678            .spawn(async move { fs.load(&abs_path).await })
2679    }
2680
2681    fn buffer_reloaded(
2682        &self,
2683        buffer_id: u64,
2684        version: &clock::Global,
2685        fingerprint: RopeFingerprint,
2686        line_ending: LineEnding,
2687        mtime: SystemTime,
2688        cx: &mut AppContext,
2689    ) {
2690        let worktree = self.worktree.read(cx).as_local().unwrap();
2691        if let Some(project_id) = worktree.share.as_ref().map(|share| share.project_id) {
2692            worktree
2693                .client
2694                .send(proto::BufferReloaded {
2695                    project_id,
2696                    buffer_id,
2697                    version: serialize_version(version),
2698                    mtime: Some(mtime.into()),
2699                    fingerprint: serialize_fingerprint(fingerprint),
2700                    line_ending: serialize_line_ending(line_ending) as i32,
2701                })
2702                .log_err();
2703        }
2704    }
2705}
2706
2707impl File {
2708    pub fn for_entry(entry: Entry, worktree: ModelHandle<Worktree>) -> Arc<Self> {
2709        Arc::new(Self {
2710            worktree,
2711            path: entry.path.clone(),
2712            mtime: entry.mtime,
2713            entry_id: entry.id,
2714            is_local: true,
2715            is_deleted: false,
2716        })
2717    }
2718
2719    pub fn from_proto(
2720        proto: rpc::proto::File,
2721        worktree: ModelHandle<Worktree>,
2722        cx: &AppContext,
2723    ) -> Result<Self> {
2724        let worktree_id = worktree
2725            .read(cx)
2726            .as_remote()
2727            .ok_or_else(|| anyhow!("not remote"))?
2728            .id();
2729
2730        if worktree_id.to_proto() != proto.worktree_id {
2731            return Err(anyhow!("worktree id does not match file"));
2732        }
2733
2734        Ok(Self {
2735            worktree,
2736            path: Path::new(&proto.path).into(),
2737            mtime: proto.mtime.ok_or_else(|| anyhow!("no timestamp"))?.into(),
2738            entry_id: ProjectEntryId::from_proto(proto.entry_id),
2739            is_local: false,
2740            is_deleted: proto.is_deleted,
2741        })
2742    }
2743
2744    pub fn from_dyn(file: Option<&Arc<dyn language::File>>) -> Option<&Self> {
2745        file.and_then(|f| f.as_any().downcast_ref())
2746    }
2747
2748    pub fn worktree_id(&self, cx: &AppContext) -> WorktreeId {
2749        self.worktree.read(cx).id()
2750    }
2751
2752    pub fn project_entry_id(&self, _: &AppContext) -> Option<ProjectEntryId> {
2753        if self.is_deleted {
2754            None
2755        } else {
2756            Some(self.entry_id)
2757        }
2758    }
2759}
2760
2761#[derive(Clone, Debug, PartialEq, Eq)]
2762pub struct Entry {
2763    pub id: ProjectEntryId,
2764    pub kind: EntryKind,
2765    pub path: Arc<Path>,
2766    pub inode: u64,
2767    pub mtime: SystemTime,
2768    pub is_symlink: bool,
2769
2770    /// Whether this entry is ignored by Git.
2771    ///
2772    /// We only scan ignored entries once the directory is expanded and
2773    /// exclude them from searches.
2774    pub is_ignored: bool,
2775
2776    /// Whether this entry's canonical path is outside of the worktree.
2777    /// This means the entry is only accessible from the worktree root via a
2778    /// symlink.
2779    ///
2780    /// We only scan entries outside of the worktree once the symlinked
2781    /// directory is expanded. External entries are treated like gitignored
2782    /// entries in that they are not included in searches.
2783    pub is_external: bool,
2784    pub git_status: Option<GitFileStatus>,
2785}
2786
2787#[derive(Clone, Copy, Debug, PartialEq, Eq)]
2788pub enum EntryKind {
2789    UnloadedDir,
2790    PendingDir,
2791    Dir,
2792    File(CharBag),
2793}
2794
2795#[derive(Clone, Copy, Debug, PartialEq)]
2796pub enum PathChange {
2797    /// A filesystem entry was was created.
2798    Added,
2799    /// A filesystem entry was removed.
2800    Removed,
2801    /// A filesystem entry was updated.
2802    Updated,
2803    /// A filesystem entry was either updated or added. We don't know
2804    /// whether or not it already existed, because the path had not
2805    /// been loaded before the event.
2806    AddedOrUpdated,
2807    /// A filesystem entry was found during the initial scan of the worktree.
2808    Loaded,
2809}
2810
2811pub struct GitRepositoryChange {
2812    /// The previous state of the repository, if it already existed.
2813    pub old_repository: Option<RepositoryEntry>,
2814}
2815
2816pub type UpdatedEntriesSet = Arc<[(Arc<Path>, ProjectEntryId, PathChange)]>;
2817pub type UpdatedGitRepositoriesSet = Arc<[(Arc<Path>, GitRepositoryChange)]>;
2818
2819impl Entry {
2820    fn new(
2821        path: Arc<Path>,
2822        metadata: &fs::Metadata,
2823        next_entry_id: &AtomicUsize,
2824        root_char_bag: CharBag,
2825    ) -> Self {
2826        Self {
2827            id: ProjectEntryId::new(next_entry_id),
2828            kind: if metadata.is_dir {
2829                EntryKind::PendingDir
2830            } else {
2831                EntryKind::File(char_bag_for_path(root_char_bag, &path))
2832            },
2833            path,
2834            inode: metadata.inode,
2835            mtime: metadata.mtime,
2836            is_symlink: metadata.is_symlink,
2837            is_ignored: false,
2838            is_external: false,
2839            git_status: None,
2840        }
2841    }
2842
2843    pub fn is_dir(&self) -> bool {
2844        self.kind.is_dir()
2845    }
2846
2847    pub fn is_file(&self) -> bool {
2848        self.kind.is_file()
2849    }
2850
2851    pub fn git_status(&self) -> Option<GitFileStatus> {
2852        self.git_status
2853    }
2854}
2855
2856impl EntryKind {
2857    pub fn is_dir(&self) -> bool {
2858        matches!(
2859            self,
2860            EntryKind::Dir | EntryKind::PendingDir | EntryKind::UnloadedDir
2861        )
2862    }
2863
2864    pub fn is_unloaded(&self) -> bool {
2865        matches!(self, EntryKind::UnloadedDir)
2866    }
2867
2868    pub fn is_file(&self) -> bool {
2869        matches!(self, EntryKind::File(_))
2870    }
2871}
2872
2873impl sum_tree::Item for Entry {
2874    type Summary = EntrySummary;
2875
2876    fn summary(&self) -> Self::Summary {
2877        let non_ignored_count = if self.is_ignored || self.is_external {
2878            0
2879        } else {
2880            1
2881        };
2882        let file_count;
2883        let non_ignored_file_count;
2884        if self.is_file() {
2885            file_count = 1;
2886            non_ignored_file_count = non_ignored_count;
2887        } else {
2888            file_count = 0;
2889            non_ignored_file_count = 0;
2890        }
2891
2892        let mut statuses = GitStatuses::default();
2893        match self.git_status {
2894            Some(status) => match status {
2895                GitFileStatus::Added => statuses.added = 1,
2896                GitFileStatus::Modified => statuses.modified = 1,
2897                GitFileStatus::Conflict => statuses.conflict = 1,
2898            },
2899            None => {}
2900        }
2901
2902        EntrySummary {
2903            max_path: self.path.clone(),
2904            count: 1,
2905            non_ignored_count,
2906            file_count,
2907            non_ignored_file_count,
2908            statuses,
2909        }
2910    }
2911}
2912
2913impl sum_tree::KeyedItem for Entry {
2914    type Key = PathKey;
2915
2916    fn key(&self) -> Self::Key {
2917        PathKey(self.path.clone())
2918    }
2919}
2920
2921#[derive(Clone, Debug)]
2922pub struct EntrySummary {
2923    max_path: Arc<Path>,
2924    count: usize,
2925    non_ignored_count: usize,
2926    file_count: usize,
2927    non_ignored_file_count: usize,
2928    statuses: GitStatuses,
2929}
2930
2931impl Default for EntrySummary {
2932    fn default() -> Self {
2933        Self {
2934            max_path: Arc::from(Path::new("")),
2935            count: 0,
2936            non_ignored_count: 0,
2937            file_count: 0,
2938            non_ignored_file_count: 0,
2939            statuses: Default::default(),
2940        }
2941    }
2942}
2943
2944impl sum_tree::Summary for EntrySummary {
2945    type Context = ();
2946
2947    fn add_summary(&mut self, rhs: &Self, _: &()) {
2948        self.max_path = rhs.max_path.clone();
2949        self.count += rhs.count;
2950        self.non_ignored_count += rhs.non_ignored_count;
2951        self.file_count += rhs.file_count;
2952        self.non_ignored_file_count += rhs.non_ignored_file_count;
2953        self.statuses += rhs.statuses;
2954    }
2955}
2956
2957#[derive(Clone, Debug)]
2958struct PathEntry {
2959    id: ProjectEntryId,
2960    path: Arc<Path>,
2961    is_ignored: bool,
2962    scan_id: usize,
2963}
2964
2965impl sum_tree::Item for PathEntry {
2966    type Summary = PathEntrySummary;
2967
2968    fn summary(&self) -> Self::Summary {
2969        PathEntrySummary { max_id: self.id }
2970    }
2971}
2972
2973impl sum_tree::KeyedItem for PathEntry {
2974    type Key = ProjectEntryId;
2975
2976    fn key(&self) -> Self::Key {
2977        self.id
2978    }
2979}
2980
2981#[derive(Clone, Debug, Default)]
2982struct PathEntrySummary {
2983    max_id: ProjectEntryId,
2984}
2985
2986impl sum_tree::Summary for PathEntrySummary {
2987    type Context = ();
2988
2989    fn add_summary(&mut self, summary: &Self, _: &Self::Context) {
2990        self.max_id = summary.max_id;
2991    }
2992}
2993
2994impl<'a> sum_tree::Dimension<'a, PathEntrySummary> for ProjectEntryId {
2995    fn add_summary(&mut self, summary: &'a PathEntrySummary, _: &()) {
2996        *self = summary.max_id;
2997    }
2998}
2999
3000#[derive(Clone, Debug, Eq, PartialEq, Ord, PartialOrd)]
3001pub struct PathKey(Arc<Path>);
3002
3003impl Default for PathKey {
3004    fn default() -> Self {
3005        Self(Path::new("").into())
3006    }
3007}
3008
3009impl<'a> sum_tree::Dimension<'a, EntrySummary> for PathKey {
3010    fn add_summary(&mut self, summary: &'a EntrySummary, _: &()) {
3011        self.0 = summary.max_path.clone();
3012    }
3013}
3014
3015struct BackgroundScanner {
3016    state: Mutex<BackgroundScannerState>,
3017    fs: Arc<dyn Fs>,
3018    status_updates_tx: UnboundedSender<ScanState>,
3019    executor: Arc<executor::Background>,
3020    scan_requests_rx: channel::Receiver<ScanRequest>,
3021    path_prefixes_to_scan_rx: channel::Receiver<Arc<Path>>,
3022    next_entry_id: Arc<AtomicUsize>,
3023    phase: BackgroundScannerPhase,
3024}
3025
3026#[derive(PartialEq)]
3027enum BackgroundScannerPhase {
3028    InitialScan,
3029    EventsReceivedDuringInitialScan,
3030    Events,
3031}
3032
3033impl BackgroundScanner {
3034    fn new(
3035        snapshot: LocalSnapshot,
3036        next_entry_id: Arc<AtomicUsize>,
3037        fs: Arc<dyn Fs>,
3038        status_updates_tx: UnboundedSender<ScanState>,
3039        executor: Arc<executor::Background>,
3040        scan_requests_rx: channel::Receiver<ScanRequest>,
3041        path_prefixes_to_scan_rx: channel::Receiver<Arc<Path>>,
3042    ) -> Self {
3043        Self {
3044            fs,
3045            status_updates_tx,
3046            executor,
3047            scan_requests_rx,
3048            path_prefixes_to_scan_rx,
3049            next_entry_id,
3050            state: Mutex::new(BackgroundScannerState {
3051                prev_snapshot: snapshot.snapshot.clone(),
3052                snapshot,
3053                scanned_dirs: Default::default(),
3054                path_prefixes_to_scan: Default::default(),
3055                paths_to_scan: Default::default(),
3056                removed_entry_ids: Default::default(),
3057                changed_paths: Default::default(),
3058            }),
3059            phase: BackgroundScannerPhase::InitialScan,
3060        }
3061    }
3062
3063    async fn run(
3064        &mut self,
3065        mut fs_events_rx: Pin<Box<dyn Send + Stream<Item = Vec<fsevent::Event>>>>,
3066    ) {
3067        use futures::FutureExt as _;
3068
3069        // Populate ignores above the root.
3070        let root_abs_path = self.state.lock().snapshot.abs_path.clone();
3071        for (index, ancestor) in root_abs_path.ancestors().enumerate() {
3072            if index != 0 {
3073                if let Ok(ignore) =
3074                    build_gitignore(&ancestor.join(&*GITIGNORE), self.fs.as_ref()).await
3075                {
3076                    self.state
3077                        .lock()
3078                        .snapshot
3079                        .ignores_by_parent_abs_path
3080                        .insert(ancestor.into(), (ignore.into(), false));
3081                }
3082            }
3083            if ancestor.join(&*DOT_GIT).is_dir() {
3084                // Reached root of git repository.
3085                break;
3086            }
3087        }
3088
3089        let (scan_job_tx, scan_job_rx) = channel::unbounded();
3090        {
3091            let mut state = self.state.lock();
3092            state.snapshot.scan_id += 1;
3093            if let Some(mut root_entry) = state.snapshot.root_entry().cloned() {
3094                let ignore_stack = state
3095                    .snapshot
3096                    .ignore_stack_for_abs_path(&root_abs_path, true);
3097                if ignore_stack.is_all() {
3098                    root_entry.is_ignored = true;
3099                    state.insert_entry(root_entry.clone(), self.fs.as_ref());
3100                }
3101                state.enqueue_scan_dir(root_abs_path, &root_entry, &scan_job_tx);
3102            }
3103        };
3104
3105        // Perform an initial scan of the directory.
3106        drop(scan_job_tx);
3107        self.scan_dirs(true, scan_job_rx).await;
3108        {
3109            let mut state = self.state.lock();
3110            state.snapshot.completed_scan_id = state.snapshot.scan_id;
3111        }
3112
3113        self.send_status_update(false, None);
3114
3115        // Process any any FS events that occurred while performing the initial scan.
3116        // For these events, update events cannot be as precise, because we didn't
3117        // have the previous state loaded yet.
3118        self.phase = BackgroundScannerPhase::EventsReceivedDuringInitialScan;
3119        if let Poll::Ready(Some(events)) = futures::poll!(fs_events_rx.next()) {
3120            let mut paths = events.into_iter().map(|e| e.path).collect::<Vec<_>>();
3121            while let Poll::Ready(Some(more_events)) = futures::poll!(fs_events_rx.next()) {
3122                paths.extend(more_events.into_iter().map(|e| e.path));
3123            }
3124            self.process_events(paths).await;
3125        }
3126
3127        // Continue processing events until the worktree is dropped.
3128        self.phase = BackgroundScannerPhase::Events;
3129        loop {
3130            select_biased! {
3131                // Process any path refresh requests from the worktree. Prioritize
3132                // these before handling changes reported by the filesystem.
3133                request = self.scan_requests_rx.recv().fuse() => {
3134                    let Ok(request) = request else { break };
3135                    if !self.process_scan_request(request, false).await {
3136                        return;
3137                    }
3138                }
3139
3140                path_prefix = self.path_prefixes_to_scan_rx.recv().fuse() => {
3141                    let Ok(path_prefix) = path_prefix else { break };
3142                    log::trace!("adding path prefix {:?}", path_prefix);
3143
3144                    let did_scan = self.forcibly_load_paths(&[path_prefix.clone()]).await;
3145                    if did_scan {
3146                        let abs_path =
3147                        {
3148                            let mut state = self.state.lock();
3149                            state.path_prefixes_to_scan.insert(path_prefix.clone());
3150                            state.snapshot.abs_path.join(&path_prefix)
3151                        };
3152
3153                        if let Some(abs_path) = self.fs.canonicalize(&abs_path).await.log_err() {
3154                            self.process_events(vec![abs_path]).await;
3155                        }
3156                    }
3157                }
3158
3159                events = fs_events_rx.next().fuse() => {
3160                    let Some(events) = events else { break };
3161                    let mut paths = events.into_iter().map(|e| e.path).collect::<Vec<_>>();
3162                    while let Poll::Ready(Some(more_events)) = futures::poll!(fs_events_rx.next()) {
3163                        paths.extend(more_events.into_iter().map(|e| e.path));
3164                    }
3165                    self.process_events(paths.clone()).await;
3166                }
3167            }
3168        }
3169    }
3170
3171    async fn process_scan_request(&self, mut request: ScanRequest, scanning: bool) -> bool {
3172        log::debug!("rescanning paths {:?}", request.relative_paths);
3173
3174        request.relative_paths.sort_unstable();
3175        self.forcibly_load_paths(&request.relative_paths).await;
3176
3177        let root_path = self.state.lock().snapshot.abs_path.clone();
3178        let root_canonical_path = match self.fs.canonicalize(&root_path).await {
3179            Ok(path) => path,
3180            Err(err) => {
3181                log::error!("failed to canonicalize root path: {}", err);
3182                return false;
3183            }
3184        };
3185        let abs_paths = request
3186            .relative_paths
3187            .iter()
3188            .map(|path| {
3189                if path.file_name().is_some() {
3190                    root_canonical_path.join(path)
3191                } else {
3192                    root_canonical_path.clone()
3193                }
3194            })
3195            .collect::<Vec<_>>();
3196
3197        self.reload_entries_for_paths(
3198            root_path,
3199            root_canonical_path,
3200            &request.relative_paths,
3201            abs_paths,
3202            None,
3203        )
3204        .await;
3205        self.send_status_update(scanning, Some(request.done))
3206    }
3207
3208    async fn process_events(&mut self, mut abs_paths: Vec<PathBuf>) {
3209        let root_path = self.state.lock().snapshot.abs_path.clone();
3210        let root_canonical_path = match self.fs.canonicalize(&root_path).await {
3211            Ok(path) => path,
3212            Err(err) => {
3213                log::error!("failed to canonicalize root path: {}", err);
3214                return;
3215            }
3216        };
3217
3218        let mut relative_paths = Vec::with_capacity(abs_paths.len());
3219        abs_paths.sort_unstable();
3220        abs_paths.dedup_by(|a, b| a.starts_with(&b));
3221        abs_paths.retain(|abs_path| {
3222            let snapshot = &self.state.lock().snapshot;
3223            {
3224                let relative_path: Arc<Path> =
3225                    if let Ok(path) = abs_path.strip_prefix(&root_canonical_path) {
3226                        path.into()
3227                    } else {
3228                        log::error!(
3229                        "ignoring event {abs_path:?} outside of root path {root_canonical_path:?}",
3230                    );
3231                        return false;
3232                    };
3233
3234                let parent_dir_is_loaded = relative_path.parent().map_or(true, |parent| {
3235                    snapshot
3236                        .entry_for_path(parent)
3237                        .map_or(false, |entry| entry.kind == EntryKind::Dir)
3238                });
3239                if !parent_dir_is_loaded {
3240                    log::debug!("ignoring event {relative_path:?} within unloaded directory");
3241                    return false;
3242                }
3243
3244                relative_paths.push(relative_path);
3245                true
3246            }
3247        });
3248
3249        if relative_paths.is_empty() {
3250            return;
3251        }
3252
3253        log::debug!("received fs events {:?}", relative_paths);
3254
3255        let (scan_job_tx, scan_job_rx) = channel::unbounded();
3256        self.reload_entries_for_paths(
3257            root_path,
3258            root_canonical_path,
3259            &relative_paths,
3260            abs_paths,
3261            Some(scan_job_tx.clone()),
3262        )
3263        .await;
3264        drop(scan_job_tx);
3265        self.scan_dirs(false, scan_job_rx).await;
3266
3267        let (scan_job_tx, scan_job_rx) = channel::unbounded();
3268        self.update_ignore_statuses(scan_job_tx).await;
3269        self.scan_dirs(false, scan_job_rx).await;
3270
3271        {
3272            let mut state = self.state.lock();
3273            state.reload_repositories(&relative_paths, self.fs.as_ref());
3274            state.snapshot.completed_scan_id = state.snapshot.scan_id;
3275            for (_, entry_id) in mem::take(&mut state.removed_entry_ids) {
3276                state.scanned_dirs.remove(&entry_id);
3277            }
3278        }
3279
3280        self.send_status_update(false, None);
3281    }
3282
3283    async fn forcibly_load_paths(&self, paths: &[Arc<Path>]) -> bool {
3284        let (scan_job_tx, mut scan_job_rx) = channel::unbounded();
3285        {
3286            let mut state = self.state.lock();
3287            let root_path = state.snapshot.abs_path.clone();
3288            for path in paths {
3289                for ancestor in path.ancestors() {
3290                    if let Some(entry) = state.snapshot.entry_for_path(ancestor) {
3291                        if entry.kind == EntryKind::UnloadedDir {
3292                            let abs_path = root_path.join(ancestor);
3293                            state.enqueue_scan_dir(abs_path.into(), entry, &scan_job_tx);
3294                            state.paths_to_scan.insert(path.clone());
3295                            break;
3296                        }
3297                    }
3298                }
3299            }
3300            drop(scan_job_tx);
3301        }
3302        while let Some(job) = scan_job_rx.next().await {
3303            self.scan_dir(&job).await.log_err();
3304        }
3305
3306        mem::take(&mut self.state.lock().paths_to_scan).len() > 0
3307    }
3308
3309    async fn scan_dirs(
3310        &self,
3311        enable_progress_updates: bool,
3312        scan_jobs_rx: channel::Receiver<ScanJob>,
3313    ) {
3314        use futures::FutureExt as _;
3315
3316        if self
3317            .status_updates_tx
3318            .unbounded_send(ScanState::Started)
3319            .is_err()
3320        {
3321            return;
3322        }
3323
3324        let progress_update_count = AtomicUsize::new(0);
3325        self.executor
3326            .scoped(|scope| {
3327                for _ in 0..self.executor.num_cpus() {
3328                    scope.spawn(async {
3329                        let mut last_progress_update_count = 0;
3330                        let progress_update_timer = self.progress_timer(enable_progress_updates).fuse();
3331                        futures::pin_mut!(progress_update_timer);
3332
3333                        loop {
3334                            select_biased! {
3335                                // Process any path refresh requests before moving on to process
3336                                // the scan queue, so that user operations are prioritized.
3337                                request = self.scan_requests_rx.recv().fuse() => {
3338                                    let Ok(request) = request else { break };
3339                                    if !self.process_scan_request(request, true).await {
3340                                        return;
3341                                    }
3342                                }
3343
3344                                // Send periodic progress updates to the worktree. Use an atomic counter
3345                                // to ensure that only one of the workers sends a progress update after
3346                                // the update interval elapses.
3347                                _ = progress_update_timer => {
3348                                    match progress_update_count.compare_exchange(
3349                                        last_progress_update_count,
3350                                        last_progress_update_count + 1,
3351                                        SeqCst,
3352                                        SeqCst
3353                                    ) {
3354                                        Ok(_) => {
3355                                            last_progress_update_count += 1;
3356                                            self.send_status_update(true, None);
3357                                        }
3358                                        Err(count) => {
3359                                            last_progress_update_count = count;
3360                                        }
3361                                    }
3362                                    progress_update_timer.set(self.progress_timer(enable_progress_updates).fuse());
3363                                }
3364
3365                                // Recursively load directories from the file system.
3366                                job = scan_jobs_rx.recv().fuse() => {
3367                                    let Ok(job) = job else { break };
3368                                    if let Err(err) = self.scan_dir(&job).await {
3369                                        if job.path.as_ref() != Path::new("") {
3370                                            log::error!("error scanning directory {:?}: {}", job.abs_path, err);
3371                                        }
3372                                    }
3373                                }
3374                            }
3375                        }
3376                    })
3377                }
3378            })
3379            .await;
3380    }
3381
3382    fn send_status_update(&self, scanning: bool, barrier: Option<barrier::Sender>) -> bool {
3383        let mut state = self.state.lock();
3384        if state.changed_paths.is_empty() && scanning {
3385            return true;
3386        }
3387
3388        let new_snapshot = state.snapshot.clone();
3389        let old_snapshot = mem::replace(&mut state.prev_snapshot, new_snapshot.snapshot.clone());
3390        let changes = self.build_change_set(&old_snapshot, &new_snapshot, &state.changed_paths);
3391        state.changed_paths.clear();
3392
3393        self.status_updates_tx
3394            .unbounded_send(ScanState::Updated {
3395                snapshot: new_snapshot,
3396                changes,
3397                scanning,
3398                barrier,
3399            })
3400            .is_ok()
3401    }
3402
3403    async fn scan_dir(&self, job: &ScanJob) -> Result<()> {
3404        log::debug!("scan directory {:?}", job.path);
3405
3406        let mut ignore_stack = job.ignore_stack.clone();
3407        let mut new_ignore = None;
3408        let (root_abs_path, root_char_bag, next_entry_id) = {
3409            let snapshot = &self.state.lock().snapshot;
3410            (
3411                snapshot.abs_path().clone(),
3412                snapshot.root_char_bag,
3413                self.next_entry_id.clone(),
3414            )
3415        };
3416
3417        let mut dotgit_path = None;
3418        let mut root_canonical_path = None;
3419        let mut new_entries: Vec<Entry> = Vec::new();
3420        let mut new_jobs: Vec<Option<ScanJob>> = Vec::new();
3421        let mut child_paths = self.fs.read_dir(&job.abs_path).await?;
3422        while let Some(child_abs_path) = child_paths.next().await {
3423            let child_abs_path: Arc<Path> = match child_abs_path {
3424                Ok(child_abs_path) => child_abs_path.into(),
3425                Err(error) => {
3426                    log::error!("error processing entry {:?}", error);
3427                    continue;
3428                }
3429            };
3430
3431            let child_name = child_abs_path.file_name().unwrap();
3432            let child_path: Arc<Path> = job.path.join(child_name).into();
3433            let child_metadata = match self.fs.metadata(&child_abs_path).await {
3434                Ok(Some(metadata)) => metadata,
3435                Ok(None) => continue,
3436                Err(err) => {
3437                    log::error!("error processing {:?}: {:?}", child_abs_path, err);
3438                    continue;
3439                }
3440            };
3441
3442            // If we find a .gitignore, add it to the stack of ignores used to determine which paths are ignored
3443            if child_name == *GITIGNORE {
3444                match build_gitignore(&child_abs_path, self.fs.as_ref()).await {
3445                    Ok(ignore) => {
3446                        let ignore = Arc::new(ignore);
3447                        ignore_stack = ignore_stack.append(job.abs_path.clone(), ignore.clone());
3448                        new_ignore = Some(ignore);
3449                    }
3450                    Err(error) => {
3451                        log::error!(
3452                            "error loading .gitignore file {:?} - {:?}",
3453                            child_name,
3454                            error
3455                        );
3456                    }
3457                }
3458
3459                // Update ignore status of any child entries we've already processed to reflect the
3460                // ignore file in the current directory. Because `.gitignore` starts with a `.`,
3461                // there should rarely be too numerous. Update the ignore stack associated with any
3462                // new jobs as well.
3463                let mut new_jobs = new_jobs.iter_mut();
3464                for entry in &mut new_entries {
3465                    let entry_abs_path = root_abs_path.join(&entry.path);
3466                    entry.is_ignored =
3467                        ignore_stack.is_abs_path_ignored(&entry_abs_path, entry.is_dir());
3468
3469                    if entry.is_dir() {
3470                        if let Some(job) = new_jobs.next().expect("missing scan job for entry") {
3471                            job.ignore_stack = if entry.is_ignored {
3472                                IgnoreStack::all()
3473                            } else {
3474                                ignore_stack.clone()
3475                            };
3476                        }
3477                    }
3478                }
3479            }
3480            // If we find a .git, we'll need to load the repository.
3481            else if child_name == *DOT_GIT {
3482                dotgit_path = Some(child_path.clone());
3483            }
3484
3485            let mut child_entry = Entry::new(
3486                child_path.clone(),
3487                &child_metadata,
3488                &next_entry_id,
3489                root_char_bag,
3490            );
3491
3492            if job.is_external {
3493                child_entry.is_external = true;
3494            } else if child_metadata.is_symlink {
3495                let canonical_path = match self.fs.canonicalize(&child_abs_path).await {
3496                    Ok(path) => path,
3497                    Err(err) => {
3498                        log::error!(
3499                            "error reading target of symlink {:?}: {:?}",
3500                            child_abs_path,
3501                            err
3502                        );
3503                        continue;
3504                    }
3505                };
3506
3507                // lazily canonicalize the root path in order to determine if
3508                // symlinks point outside of the worktree.
3509                let root_canonical_path = match &root_canonical_path {
3510                    Some(path) => path,
3511                    None => match self.fs.canonicalize(&root_abs_path).await {
3512                        Ok(path) => root_canonical_path.insert(path),
3513                        Err(err) => {
3514                            log::error!("error canonicalizing root {:?}: {:?}", root_abs_path, err);
3515                            continue;
3516                        }
3517                    },
3518                };
3519
3520                if !canonical_path.starts_with(root_canonical_path) {
3521                    child_entry.is_external = true;
3522                }
3523            }
3524
3525            if child_entry.is_dir() {
3526                child_entry.is_ignored = ignore_stack.is_abs_path_ignored(&child_abs_path, true);
3527
3528                // Avoid recursing until crash in the case of a recursive symlink
3529                if !job.ancestor_inodes.contains(&child_entry.inode) {
3530                    let mut ancestor_inodes = job.ancestor_inodes.clone();
3531                    ancestor_inodes.insert(child_entry.inode);
3532
3533                    new_jobs.push(Some(ScanJob {
3534                        abs_path: child_abs_path,
3535                        path: child_path,
3536                        is_external: child_entry.is_external,
3537                        ignore_stack: if child_entry.is_ignored {
3538                            IgnoreStack::all()
3539                        } else {
3540                            ignore_stack.clone()
3541                        },
3542                        ancestor_inodes,
3543                        scan_queue: job.scan_queue.clone(),
3544                        containing_repository: job.containing_repository.clone(),
3545                    }));
3546                } else {
3547                    new_jobs.push(None);
3548                }
3549            } else {
3550                child_entry.is_ignored = ignore_stack.is_abs_path_ignored(&child_abs_path, false);
3551                if !child_entry.is_ignored {
3552                    if let Some((repository_dir, repository, staged_statuses)) =
3553                        &job.containing_repository
3554                    {
3555                        if let Ok(repo_path) = child_entry.path.strip_prefix(&repository_dir.0) {
3556                            let repo_path = RepoPath(repo_path.into());
3557                            child_entry.git_status = combine_git_statuses(
3558                                staged_statuses.get(&repo_path).copied(),
3559                                repository
3560                                    .lock()
3561                                    .unstaged_status(&repo_path, child_entry.mtime),
3562                            );
3563                        }
3564                    }
3565                }
3566            }
3567
3568            new_entries.push(child_entry);
3569        }
3570
3571        let mut state = self.state.lock();
3572
3573        // Identify any subdirectories that should not be scanned.
3574        let mut job_ix = 0;
3575        for entry in &mut new_entries {
3576            state.reuse_entry_id(entry);
3577            if entry.is_dir() {
3578                if state.should_scan_directory(&entry) {
3579                    job_ix += 1;
3580                } else {
3581                    log::debug!("defer scanning directory {:?}", entry.path);
3582                    entry.kind = EntryKind::UnloadedDir;
3583                    new_jobs.remove(job_ix);
3584                }
3585            }
3586        }
3587
3588        state.populate_dir(&job.path, new_entries, new_ignore);
3589
3590        let repository =
3591            dotgit_path.and_then(|path| state.build_git_repository(path, self.fs.as_ref()));
3592
3593        for new_job in new_jobs {
3594            if let Some(mut new_job) = new_job {
3595                if let Some(containing_repository) = &repository {
3596                    new_job.containing_repository = Some(containing_repository.clone());
3597                }
3598
3599                job.scan_queue
3600                    .try_send(new_job)
3601                    .expect("channel is unbounded");
3602            }
3603        }
3604
3605        Ok(())
3606    }
3607
3608    async fn reload_entries_for_paths(
3609        &self,
3610        root_abs_path: Arc<Path>,
3611        root_canonical_path: PathBuf,
3612        relative_paths: &[Arc<Path>],
3613        abs_paths: Vec<PathBuf>,
3614        scan_queue_tx: Option<Sender<ScanJob>>,
3615    ) {
3616        let metadata = futures::future::join_all(
3617            abs_paths
3618                .iter()
3619                .map(|abs_path| async move {
3620                    let metadata = self.fs.metadata(&abs_path).await?;
3621                    if let Some(metadata) = metadata {
3622                        let canonical_path = self.fs.canonicalize(&abs_path).await?;
3623                        anyhow::Ok(Some((metadata, canonical_path)))
3624                    } else {
3625                        Ok(None)
3626                    }
3627                })
3628                .collect::<Vec<_>>(),
3629        )
3630        .await;
3631
3632        let mut state = self.state.lock();
3633        let snapshot = &mut state.snapshot;
3634        let is_idle = snapshot.completed_scan_id == snapshot.scan_id;
3635        let doing_recursive_update = scan_queue_tx.is_some();
3636        snapshot.scan_id += 1;
3637        if is_idle && !doing_recursive_update {
3638            snapshot.completed_scan_id = snapshot.scan_id;
3639        }
3640
3641        // Remove any entries for paths that no longer exist or are being recursively
3642        // refreshed. Do this before adding any new entries, so that renames can be
3643        // detected regardless of the order of the paths.
3644        for (path, metadata) in relative_paths.iter().zip(metadata.iter()) {
3645            if matches!(metadata, Ok(None)) || doing_recursive_update {
3646                log::trace!("remove path {:?}", path);
3647                state.remove_path(path);
3648            }
3649        }
3650
3651        for (path, metadata) in relative_paths.iter().zip(metadata.iter()) {
3652            let abs_path: Arc<Path> = root_abs_path.join(&path).into();
3653            match metadata {
3654                Ok(Some((metadata, canonical_path))) => {
3655                    let ignore_stack = state
3656                        .snapshot
3657                        .ignore_stack_for_abs_path(&abs_path, metadata.is_dir);
3658
3659                    let mut fs_entry = Entry::new(
3660                        path.clone(),
3661                        metadata,
3662                        self.next_entry_id.as_ref(),
3663                        state.snapshot.root_char_bag,
3664                    );
3665                    fs_entry.is_ignored = ignore_stack.is_all();
3666                    fs_entry.is_external = !canonical_path.starts_with(&root_canonical_path);
3667
3668                    if !fs_entry.is_ignored {
3669                        if !fs_entry.is_dir() {
3670                            if let Some((work_dir, repo)) =
3671                                state.snapshot.local_repo_for_path(&path)
3672                            {
3673                                if let Ok(repo_path) = path.strip_prefix(work_dir.0) {
3674                                    let repo_path = RepoPath(repo_path.into());
3675                                    let repo = repo.repo_ptr.lock();
3676                                    fs_entry.git_status = repo.status(&repo_path, fs_entry.mtime);
3677                                }
3678                            }
3679                        }
3680                    }
3681
3682                    if let (Some(scan_queue_tx), true) = (&scan_queue_tx, fs_entry.is_dir()) {
3683                        if state.should_scan_directory(&fs_entry) {
3684                            state.enqueue_scan_dir(abs_path, &fs_entry, scan_queue_tx);
3685                        } else {
3686                            fs_entry.kind = EntryKind::UnloadedDir;
3687                        }
3688                    }
3689
3690                    state.insert_entry(fs_entry, self.fs.as_ref());
3691                }
3692                Ok(None) => {
3693                    self.remove_repo_path(&path, &mut state.snapshot);
3694                }
3695                Err(err) => {
3696                    // TODO - create a special 'error' entry in the entries tree to mark this
3697                    log::error!("error reading file on event {:?}", err);
3698                }
3699            }
3700        }
3701
3702        util::extend_sorted(
3703            &mut state.changed_paths,
3704            relative_paths.iter().cloned(),
3705            usize::MAX,
3706            Ord::cmp,
3707        );
3708    }
3709
3710    fn remove_repo_path(&self, path: &Path, snapshot: &mut LocalSnapshot) -> Option<()> {
3711        if !path
3712            .components()
3713            .any(|component| component.as_os_str() == *DOT_GIT)
3714        {
3715            if let Some(repository) = snapshot.repository_for_work_directory(path) {
3716                let entry = repository.work_directory.0;
3717                snapshot.git_repositories.remove(&entry);
3718                snapshot
3719                    .snapshot
3720                    .repository_entries
3721                    .remove(&RepositoryWorkDirectory(path.into()));
3722                return Some(());
3723            }
3724        }
3725
3726        // TODO statuses
3727        // Track when a .git is removed and iterate over the file system there
3728
3729        Some(())
3730    }
3731
3732    async fn update_ignore_statuses(&self, scan_job_tx: Sender<ScanJob>) {
3733        use futures::FutureExt as _;
3734
3735        let mut snapshot = self.state.lock().snapshot.clone();
3736        let mut ignores_to_update = Vec::new();
3737        let mut ignores_to_delete = Vec::new();
3738        let abs_path = snapshot.abs_path.clone();
3739        for (parent_abs_path, (_, needs_update)) in &mut snapshot.ignores_by_parent_abs_path {
3740            if let Ok(parent_path) = parent_abs_path.strip_prefix(&abs_path) {
3741                if *needs_update {
3742                    *needs_update = false;
3743                    if snapshot.snapshot.entry_for_path(parent_path).is_some() {
3744                        ignores_to_update.push(parent_abs_path.clone());
3745                    }
3746                }
3747
3748                let ignore_path = parent_path.join(&*GITIGNORE);
3749                if snapshot.snapshot.entry_for_path(ignore_path).is_none() {
3750                    ignores_to_delete.push(parent_abs_path.clone());
3751                }
3752            }
3753        }
3754
3755        for parent_abs_path in ignores_to_delete {
3756            snapshot.ignores_by_parent_abs_path.remove(&parent_abs_path);
3757            self.state
3758                .lock()
3759                .snapshot
3760                .ignores_by_parent_abs_path
3761                .remove(&parent_abs_path);
3762        }
3763
3764        let (ignore_queue_tx, ignore_queue_rx) = channel::unbounded();
3765        ignores_to_update.sort_unstable();
3766        let mut ignores_to_update = ignores_to_update.into_iter().peekable();
3767        while let Some(parent_abs_path) = ignores_to_update.next() {
3768            while ignores_to_update
3769                .peek()
3770                .map_or(false, |p| p.starts_with(&parent_abs_path))
3771            {
3772                ignores_to_update.next().unwrap();
3773            }
3774
3775            let ignore_stack = snapshot.ignore_stack_for_abs_path(&parent_abs_path, true);
3776            smol::block_on(ignore_queue_tx.send(UpdateIgnoreStatusJob {
3777                abs_path: parent_abs_path,
3778                ignore_stack,
3779                ignore_queue: ignore_queue_tx.clone(),
3780                scan_queue: scan_job_tx.clone(),
3781            }))
3782            .unwrap();
3783        }
3784        drop(ignore_queue_tx);
3785
3786        self.executor
3787            .scoped(|scope| {
3788                for _ in 0..self.executor.num_cpus() {
3789                    scope.spawn(async {
3790                        loop {
3791                            select_biased! {
3792                                // Process any path refresh requests before moving on to process
3793                                // the queue of ignore statuses.
3794                                request = self.scan_requests_rx.recv().fuse() => {
3795                                    let Ok(request) = request else { break };
3796                                    if !self.process_scan_request(request, true).await {
3797                                        return;
3798                                    }
3799                                }
3800
3801                                // Recursively process directories whose ignores have changed.
3802                                job = ignore_queue_rx.recv().fuse() => {
3803                                    let Ok(job) = job else { break };
3804                                    self.update_ignore_status(job, &snapshot).await;
3805                                }
3806                            }
3807                        }
3808                    });
3809                }
3810            })
3811            .await;
3812    }
3813
3814    async fn update_ignore_status(&self, job: UpdateIgnoreStatusJob, snapshot: &LocalSnapshot) {
3815        log::trace!("update ignore status {:?}", job.abs_path);
3816
3817        let mut ignore_stack = job.ignore_stack;
3818        if let Some((ignore, _)) = snapshot.ignores_by_parent_abs_path.get(&job.abs_path) {
3819            ignore_stack = ignore_stack.append(job.abs_path.clone(), ignore.clone());
3820        }
3821
3822        let mut entries_by_id_edits = Vec::new();
3823        let mut entries_by_path_edits = Vec::new();
3824        let path = job.abs_path.strip_prefix(&snapshot.abs_path).unwrap();
3825        for mut entry in snapshot.child_entries(path).cloned() {
3826            let was_ignored = entry.is_ignored;
3827            let abs_path: Arc<Path> = snapshot.abs_path().join(&entry.path).into();
3828            entry.is_ignored = ignore_stack.is_abs_path_ignored(&abs_path, entry.is_dir());
3829            if entry.is_dir() {
3830                let child_ignore_stack = if entry.is_ignored {
3831                    IgnoreStack::all()
3832                } else {
3833                    ignore_stack.clone()
3834                };
3835
3836                // Scan any directories that were previously ignored and weren't
3837                // previously scanned.
3838                if was_ignored && !entry.is_ignored && entry.kind.is_unloaded() {
3839                    let state = self.state.lock();
3840                    if state.should_scan_directory(&entry) {
3841                        state.enqueue_scan_dir(abs_path.clone(), &entry, &job.scan_queue);
3842                    }
3843                }
3844
3845                job.ignore_queue
3846                    .send(UpdateIgnoreStatusJob {
3847                        abs_path: abs_path.clone(),
3848                        ignore_stack: child_ignore_stack,
3849                        ignore_queue: job.ignore_queue.clone(),
3850                        scan_queue: job.scan_queue.clone(),
3851                    })
3852                    .await
3853                    .unwrap();
3854            }
3855
3856            if entry.is_ignored != was_ignored {
3857                let mut path_entry = snapshot.entries_by_id.get(&entry.id, &()).unwrap().clone();
3858                path_entry.scan_id = snapshot.scan_id;
3859                path_entry.is_ignored = entry.is_ignored;
3860                entries_by_id_edits.push(Edit::Insert(path_entry));
3861                entries_by_path_edits.push(Edit::Insert(entry));
3862            }
3863        }
3864
3865        let state = &mut self.state.lock();
3866        for edit in &entries_by_path_edits {
3867            if let Edit::Insert(entry) = edit {
3868                if let Err(ix) = state.changed_paths.binary_search(&entry.path) {
3869                    state.changed_paths.insert(ix, entry.path.clone());
3870                }
3871            }
3872        }
3873
3874        state
3875            .snapshot
3876            .entries_by_path
3877            .edit(entries_by_path_edits, &());
3878        state.snapshot.entries_by_id.edit(entries_by_id_edits, &());
3879    }
3880
3881    fn build_change_set(
3882        &self,
3883        old_snapshot: &Snapshot,
3884        new_snapshot: &Snapshot,
3885        event_paths: &[Arc<Path>],
3886    ) -> UpdatedEntriesSet {
3887        use BackgroundScannerPhase::*;
3888        use PathChange::{Added, AddedOrUpdated, Loaded, Removed, Updated};
3889
3890        // Identify which paths have changed. Use the known set of changed
3891        // parent paths to optimize the search.
3892        let mut changes = Vec::new();
3893        let mut old_paths = old_snapshot.entries_by_path.cursor::<PathKey>();
3894        let mut new_paths = new_snapshot.entries_by_path.cursor::<PathKey>();
3895        let mut last_newly_loaded_dir_path = None;
3896        old_paths.next(&());
3897        new_paths.next(&());
3898        for path in event_paths {
3899            let path = PathKey(path.clone());
3900            if old_paths.item().map_or(false, |e| e.path < path.0) {
3901                old_paths.seek_forward(&path, Bias::Left, &());
3902            }
3903            if new_paths.item().map_or(false, |e| e.path < path.0) {
3904                new_paths.seek_forward(&path, Bias::Left, &());
3905            }
3906            loop {
3907                match (old_paths.item(), new_paths.item()) {
3908                    (Some(old_entry), Some(new_entry)) => {
3909                        if old_entry.path > path.0
3910                            && new_entry.path > path.0
3911                            && !old_entry.path.starts_with(&path.0)
3912                            && !new_entry.path.starts_with(&path.0)
3913                        {
3914                            break;
3915                        }
3916
3917                        match Ord::cmp(&old_entry.path, &new_entry.path) {
3918                            Ordering::Less => {
3919                                changes.push((old_entry.path.clone(), old_entry.id, Removed));
3920                                old_paths.next(&());
3921                            }
3922                            Ordering::Equal => {
3923                                if self.phase == EventsReceivedDuringInitialScan {
3924                                    if old_entry.id != new_entry.id {
3925                                        changes.push((
3926                                            old_entry.path.clone(),
3927                                            old_entry.id,
3928                                            Removed,
3929                                        ));
3930                                    }
3931                                    // If the worktree was not fully initialized when this event was generated,
3932                                    // we can't know whether this entry was added during the scan or whether
3933                                    // it was merely updated.
3934                                    changes.push((
3935                                        new_entry.path.clone(),
3936                                        new_entry.id,
3937                                        AddedOrUpdated,
3938                                    ));
3939                                } else if old_entry.id != new_entry.id {
3940                                    changes.push((old_entry.path.clone(), old_entry.id, Removed));
3941                                    changes.push((new_entry.path.clone(), new_entry.id, Added));
3942                                } else if old_entry != new_entry {
3943                                    if old_entry.kind.is_unloaded() {
3944                                        last_newly_loaded_dir_path = Some(&new_entry.path);
3945                                        changes.push((
3946                                            new_entry.path.clone(),
3947                                            new_entry.id,
3948                                            Loaded,
3949                                        ));
3950                                    } else {
3951                                        changes.push((
3952                                            new_entry.path.clone(),
3953                                            new_entry.id,
3954                                            Updated,
3955                                        ));
3956                                    }
3957                                }
3958                                old_paths.next(&());
3959                                new_paths.next(&());
3960                            }
3961                            Ordering::Greater => {
3962                                let is_newly_loaded = self.phase == InitialScan
3963                                    || last_newly_loaded_dir_path
3964                                        .as_ref()
3965                                        .map_or(false, |dir| new_entry.path.starts_with(&dir));
3966                                changes.push((
3967                                    new_entry.path.clone(),
3968                                    new_entry.id,
3969                                    if is_newly_loaded { Loaded } else { Added },
3970                                ));
3971                                new_paths.next(&());
3972                            }
3973                        }
3974                    }
3975                    (Some(old_entry), None) => {
3976                        changes.push((old_entry.path.clone(), old_entry.id, Removed));
3977                        old_paths.next(&());
3978                    }
3979                    (None, Some(new_entry)) => {
3980                        let is_newly_loaded = self.phase == InitialScan
3981                            || last_newly_loaded_dir_path
3982                                .as_ref()
3983                                .map_or(false, |dir| new_entry.path.starts_with(&dir));
3984                        changes.push((
3985                            new_entry.path.clone(),
3986                            new_entry.id,
3987                            if is_newly_loaded { Loaded } else { Added },
3988                        ));
3989                        new_paths.next(&());
3990                    }
3991                    (None, None) => break,
3992                }
3993            }
3994        }
3995
3996        changes.into()
3997    }
3998
3999    async fn progress_timer(&self, running: bool) {
4000        if !running {
4001            return futures::future::pending().await;
4002        }
4003
4004        #[cfg(any(test, feature = "test-support"))]
4005        if self.fs.is_fake() {
4006            return self.executor.simulate_random_delay().await;
4007        }
4008
4009        smol::Timer::after(Duration::from_millis(100)).await;
4010    }
4011}
4012
4013fn char_bag_for_path(root_char_bag: CharBag, path: &Path) -> CharBag {
4014    let mut result = root_char_bag;
4015    result.extend(
4016        path.to_string_lossy()
4017            .chars()
4018            .map(|c| c.to_ascii_lowercase()),
4019    );
4020    result
4021}
4022
4023struct ScanJob {
4024    abs_path: Arc<Path>,
4025    path: Arc<Path>,
4026    ignore_stack: Arc<IgnoreStack>,
4027    scan_queue: Sender<ScanJob>,
4028    ancestor_inodes: TreeSet<u64>,
4029    is_external: bool,
4030    containing_repository: Option<(
4031        RepositoryWorkDirectory,
4032        Arc<Mutex<dyn GitRepository>>,
4033        TreeMap<RepoPath, GitFileStatus>,
4034    )>,
4035}
4036
4037struct UpdateIgnoreStatusJob {
4038    abs_path: Arc<Path>,
4039    ignore_stack: Arc<IgnoreStack>,
4040    ignore_queue: Sender<UpdateIgnoreStatusJob>,
4041    scan_queue: Sender<ScanJob>,
4042}
4043
4044pub trait WorktreeModelHandle {
4045    #[cfg(any(test, feature = "test-support"))]
4046    fn flush_fs_events<'a>(
4047        &self,
4048        cx: &'a gpui::TestAppContext,
4049    ) -> futures::future::LocalBoxFuture<'a, ()>;
4050}
4051
4052impl WorktreeModelHandle for ModelHandle<Worktree> {
4053    // When the worktree's FS event stream sometimes delivers "redundant" events for FS changes that
4054    // occurred before the worktree was constructed. These events can cause the worktree to perform
4055    // extra directory scans, and emit extra scan-state notifications.
4056    //
4057    // This function mutates the worktree's directory and waits for those mutations to be picked up,
4058    // to ensure that all redundant FS events have already been processed.
4059    #[cfg(any(test, feature = "test-support"))]
4060    fn flush_fs_events<'a>(
4061        &self,
4062        cx: &'a gpui::TestAppContext,
4063    ) -> futures::future::LocalBoxFuture<'a, ()> {
4064        let filename = "fs-event-sentinel";
4065        let tree = self.clone();
4066        let (fs, root_path) = self.read_with(cx, |tree, _| {
4067            let tree = tree.as_local().unwrap();
4068            (tree.fs.clone(), tree.abs_path().clone())
4069        });
4070
4071        async move {
4072            fs.create_file(&root_path.join(filename), Default::default())
4073                .await
4074                .unwrap();
4075            tree.condition(cx, |tree, _| tree.entry_for_path(filename).is_some())
4076                .await;
4077
4078            fs.remove_file(&root_path.join(filename), Default::default())
4079                .await
4080                .unwrap();
4081            tree.condition(cx, |tree, _| tree.entry_for_path(filename).is_none())
4082                .await;
4083
4084            cx.read(|cx| tree.read(cx).as_local().unwrap().scan_complete())
4085                .await;
4086        }
4087        .boxed_local()
4088    }
4089}
4090
4091#[derive(Clone, Debug)]
4092struct TraversalProgress<'a> {
4093    max_path: &'a Path,
4094    count: usize,
4095    non_ignored_count: usize,
4096    file_count: usize,
4097    non_ignored_file_count: usize,
4098}
4099
4100impl<'a> TraversalProgress<'a> {
4101    fn count(&self, include_dirs: bool, include_ignored: bool) -> usize {
4102        match (include_ignored, include_dirs) {
4103            (true, true) => self.count,
4104            (true, false) => self.file_count,
4105            (false, true) => self.non_ignored_count,
4106            (false, false) => self.non_ignored_file_count,
4107        }
4108    }
4109}
4110
4111impl<'a> sum_tree::Dimension<'a, EntrySummary> for TraversalProgress<'a> {
4112    fn add_summary(&mut self, summary: &'a EntrySummary, _: &()) {
4113        self.max_path = summary.max_path.as_ref();
4114        self.count += summary.count;
4115        self.non_ignored_count += summary.non_ignored_count;
4116        self.file_count += summary.file_count;
4117        self.non_ignored_file_count += summary.non_ignored_file_count;
4118    }
4119}
4120
4121impl<'a> Default for TraversalProgress<'a> {
4122    fn default() -> Self {
4123        Self {
4124            max_path: Path::new(""),
4125            count: 0,
4126            non_ignored_count: 0,
4127            file_count: 0,
4128            non_ignored_file_count: 0,
4129        }
4130    }
4131}
4132
4133#[derive(Clone, Debug, Default, Copy)]
4134struct GitStatuses {
4135    added: usize,
4136    modified: usize,
4137    conflict: usize,
4138}
4139
4140impl AddAssign for GitStatuses {
4141    fn add_assign(&mut self, rhs: Self) {
4142        self.added += rhs.added;
4143        self.modified += rhs.modified;
4144        self.conflict += rhs.conflict;
4145    }
4146}
4147
4148impl Sub for GitStatuses {
4149    type Output = GitStatuses;
4150
4151    fn sub(self, rhs: Self) -> Self::Output {
4152        GitStatuses {
4153            added: self.added - rhs.added,
4154            modified: self.modified - rhs.modified,
4155            conflict: self.conflict - rhs.conflict,
4156        }
4157    }
4158}
4159
4160impl<'a> sum_tree::Dimension<'a, EntrySummary> for GitStatuses {
4161    fn add_summary(&mut self, summary: &'a EntrySummary, _: &()) {
4162        *self += summary.statuses
4163    }
4164}
4165
4166pub struct Traversal<'a> {
4167    cursor: sum_tree::Cursor<'a, Entry, TraversalProgress<'a>>,
4168    include_ignored: bool,
4169    include_dirs: bool,
4170}
4171
4172impl<'a> Traversal<'a> {
4173    pub fn advance(&mut self) -> bool {
4174        self.cursor.seek_forward(
4175            &TraversalTarget::Count {
4176                count: self.end_offset() + 1,
4177                include_dirs: self.include_dirs,
4178                include_ignored: self.include_ignored,
4179            },
4180            Bias::Left,
4181            &(),
4182        )
4183    }
4184
4185    pub fn advance_to_sibling(&mut self) -> bool {
4186        while let Some(entry) = self.cursor.item() {
4187            self.cursor.seek_forward(
4188                &TraversalTarget::PathSuccessor(&entry.path),
4189                Bias::Left,
4190                &(),
4191            );
4192            if let Some(entry) = self.cursor.item() {
4193                if (self.include_dirs || !entry.is_dir())
4194                    && (self.include_ignored || !entry.is_ignored)
4195                {
4196                    return true;
4197                }
4198            }
4199        }
4200        false
4201    }
4202
4203    pub fn entry(&self) -> Option<&'a Entry> {
4204        self.cursor.item()
4205    }
4206
4207    pub fn start_offset(&self) -> usize {
4208        self.cursor
4209            .start()
4210            .count(self.include_dirs, self.include_ignored)
4211    }
4212
4213    pub fn end_offset(&self) -> usize {
4214        self.cursor
4215            .end(&())
4216            .count(self.include_dirs, self.include_ignored)
4217    }
4218}
4219
4220impl<'a> Iterator for Traversal<'a> {
4221    type Item = &'a Entry;
4222
4223    fn next(&mut self) -> Option<Self::Item> {
4224        if let Some(item) = self.entry() {
4225            self.advance();
4226            Some(item)
4227        } else {
4228            None
4229        }
4230    }
4231}
4232
4233#[derive(Debug)]
4234enum TraversalTarget<'a> {
4235    Path(&'a Path),
4236    PathSuccessor(&'a Path),
4237    Count {
4238        count: usize,
4239        include_ignored: bool,
4240        include_dirs: bool,
4241    },
4242}
4243
4244impl<'a, 'b> SeekTarget<'a, EntrySummary, TraversalProgress<'a>> for TraversalTarget<'b> {
4245    fn cmp(&self, cursor_location: &TraversalProgress<'a>, _: &()) -> Ordering {
4246        match self {
4247            TraversalTarget::Path(path) => path.cmp(&cursor_location.max_path),
4248            TraversalTarget::PathSuccessor(path) => {
4249                if !cursor_location.max_path.starts_with(path) {
4250                    Ordering::Equal
4251                } else {
4252                    Ordering::Greater
4253                }
4254            }
4255            TraversalTarget::Count {
4256                count,
4257                include_dirs,
4258                include_ignored,
4259            } => Ord::cmp(
4260                count,
4261                &cursor_location.count(*include_dirs, *include_ignored),
4262            ),
4263        }
4264    }
4265}
4266
4267impl<'a, 'b> SeekTarget<'a, EntrySummary, (TraversalProgress<'a>, GitStatuses)>
4268    for TraversalTarget<'b>
4269{
4270    fn cmp(&self, cursor_location: &(TraversalProgress<'a>, GitStatuses), _: &()) -> Ordering {
4271        self.cmp(&cursor_location.0, &())
4272    }
4273}
4274
4275struct ChildEntriesIter<'a> {
4276    parent_path: &'a Path,
4277    traversal: Traversal<'a>,
4278}
4279
4280impl<'a> Iterator for ChildEntriesIter<'a> {
4281    type Item = &'a Entry;
4282
4283    fn next(&mut self) -> Option<Self::Item> {
4284        if let Some(item) = self.traversal.entry() {
4285            if item.path.starts_with(&self.parent_path) {
4286                self.traversal.advance_to_sibling();
4287                return Some(item);
4288            }
4289        }
4290        None
4291    }
4292}
4293
4294pub struct DescendentEntriesIter<'a> {
4295    parent_path: &'a Path,
4296    traversal: Traversal<'a>,
4297}
4298
4299impl<'a> Iterator for DescendentEntriesIter<'a> {
4300    type Item = &'a Entry;
4301
4302    fn next(&mut self) -> Option<Self::Item> {
4303        if let Some(item) = self.traversal.entry() {
4304            if item.path.starts_with(&self.parent_path) {
4305                self.traversal.advance();
4306                return Some(item);
4307            }
4308        }
4309        None
4310    }
4311}
4312
4313impl<'a> From<&'a Entry> for proto::Entry {
4314    fn from(entry: &'a Entry) -> Self {
4315        Self {
4316            id: entry.id.to_proto(),
4317            is_dir: entry.is_dir(),
4318            path: entry.path.to_string_lossy().into(),
4319            inode: entry.inode,
4320            mtime: Some(entry.mtime.into()),
4321            is_symlink: entry.is_symlink,
4322            is_ignored: entry.is_ignored,
4323            is_external: entry.is_external,
4324            git_status: entry.git_status.map(git_status_to_proto),
4325        }
4326    }
4327}
4328
4329impl<'a> TryFrom<(&'a CharBag, proto::Entry)> for Entry {
4330    type Error = anyhow::Error;
4331
4332    fn try_from((root_char_bag, entry): (&'a CharBag, proto::Entry)) -> Result<Self> {
4333        if let Some(mtime) = entry.mtime {
4334            let kind = if entry.is_dir {
4335                EntryKind::Dir
4336            } else {
4337                let mut char_bag = *root_char_bag;
4338                char_bag.extend(entry.path.chars().map(|c| c.to_ascii_lowercase()));
4339                EntryKind::File(char_bag)
4340            };
4341            let path: Arc<Path> = PathBuf::from(entry.path).into();
4342            Ok(Entry {
4343                id: ProjectEntryId::from_proto(entry.id),
4344                kind,
4345                path,
4346                inode: entry.inode,
4347                mtime: mtime.into(),
4348                is_symlink: entry.is_symlink,
4349                is_ignored: entry.is_ignored,
4350                is_external: entry.is_external,
4351                git_status: git_status_from_proto(entry.git_status),
4352            })
4353        } else {
4354            Err(anyhow!(
4355                "missing mtime in remote worktree entry {:?}",
4356                entry.path
4357            ))
4358        }
4359    }
4360}
4361
4362fn combine_git_statuses(
4363    staged: Option<GitFileStatus>,
4364    unstaged: Option<GitFileStatus>,
4365) -> Option<GitFileStatus> {
4366    if let Some(staged) = staged {
4367        if let Some(unstaged) = unstaged {
4368            if unstaged != staged {
4369                Some(GitFileStatus::Modified)
4370            } else {
4371                Some(staged)
4372            }
4373        } else {
4374            Some(staged)
4375        }
4376    } else {
4377        unstaged
4378    }
4379}
4380
4381fn git_status_from_proto(git_status: Option<i32>) -> Option<GitFileStatus> {
4382    git_status.and_then(|status| {
4383        proto::GitStatus::from_i32(status).map(|status| match status {
4384            proto::GitStatus::Added => GitFileStatus::Added,
4385            proto::GitStatus::Modified => GitFileStatus::Modified,
4386            proto::GitStatus::Conflict => GitFileStatus::Conflict,
4387        })
4388    })
4389}
4390
4391fn git_status_to_proto(status: GitFileStatus) -> i32 {
4392    match status {
4393        GitFileStatus::Added => proto::GitStatus::Added as i32,
4394        GitFileStatus::Modified => proto::GitStatus::Modified as i32,
4395        GitFileStatus::Conflict => proto::GitStatus::Conflict as i32,
4396    }
4397}