buffer_store.rs

   1use crate::{
   2    ProjectPath,
   3    lsp_store::OpenLspBufferHandle,
   4    worktree_store::{WorktreeStore, WorktreeStoreEvent},
   5};
   6use anyhow::{Context as _, Result, anyhow};
   7use client::Client;
   8use collections::{HashMap, HashSet, hash_map};
   9use futures::{Future, FutureExt as _, channel::oneshot, future::Shared};
  10use gpui::{
  11    App, AppContext as _, AsyncApp, Context, Entity, EventEmitter, Subscription, Task, WeakEntity,
  12};
  13use language::{
  14    Buffer, BufferEvent, Capability, DiskState, File as _, Language, Operation,
  15    proto::{
  16        deserialize_line_ending, deserialize_version, serialize_line_ending, serialize_version,
  17        split_operations,
  18    },
  19};
  20use rpc::{
  21    AnyProtoClient, ErrorCode, ErrorExt as _, TypedEnvelope,
  22    proto::{self},
  23};
  24
  25use std::{io, sync::Arc, time::Instant};
  26use text::{BufferId, ReplicaId};
  27use util::{ResultExt as _, TryFutureExt, debug_panic, maybe, rel_path::RelPath};
  28use worktree::{File, PathChange, ProjectEntryId, Worktree, WorktreeId};
  29
  30/// A set of open buffers.
  31pub struct BufferStore {
  32    state: BufferStoreState,
  33    #[allow(clippy::type_complexity)]
  34    loading_buffers: HashMap<ProjectPath, Shared<Task<Result<Entity<Buffer>, Arc<anyhow::Error>>>>>,
  35    worktree_store: Entity<WorktreeStore>,
  36    opened_buffers: HashMap<BufferId, OpenBuffer>,
  37    path_to_buffer_id: HashMap<ProjectPath, BufferId>,
  38    downstream_client: Option<(AnyProtoClient, u64)>,
  39    shared_buffers: HashMap<proto::PeerId, HashMap<BufferId, SharedBuffer>>,
  40    non_searchable_buffers: HashSet<BufferId>,
  41}
  42
  43#[derive(Hash, Eq, PartialEq, Clone)]
  44struct SharedBuffer {
  45    buffer: Entity<Buffer>,
  46    lsp_handle: Option<OpenLspBufferHandle>,
  47}
  48
  49enum BufferStoreState {
  50    Local(LocalBufferStore),
  51    Remote(RemoteBufferStore),
  52}
  53
  54struct RemoteBufferStore {
  55    shared_with_me: HashSet<Entity<Buffer>>,
  56    upstream_client: AnyProtoClient,
  57    project_id: u64,
  58    loading_remote_buffers_by_id: HashMap<BufferId, Entity<Buffer>>,
  59    remote_buffer_listeners:
  60        HashMap<BufferId, Vec<oneshot::Sender<anyhow::Result<Entity<Buffer>>>>>,
  61    worktree_store: Entity<WorktreeStore>,
  62}
  63
  64struct LocalBufferStore {
  65    local_buffer_ids_by_entry_id: HashMap<ProjectEntryId, BufferId>,
  66    worktree_store: Entity<WorktreeStore>,
  67    _subscription: Subscription,
  68}
  69
  70enum OpenBuffer {
  71    Complete { buffer: WeakEntity<Buffer> },
  72    Operations(Vec<Operation>),
  73}
  74
  75pub enum BufferStoreEvent {
  76    BufferAdded(Entity<Buffer>),
  77    BufferOpened {
  78        buffer: Entity<Buffer>,
  79        project_path: ProjectPath,
  80    },
  81    SharedBufferClosed(proto::PeerId, BufferId),
  82    BufferDropped(BufferId),
  83    BufferChangedFilePath {
  84        buffer: Entity<Buffer>,
  85        old_file: Option<Arc<dyn language::File>>,
  86    },
  87}
  88
  89#[derive(Default, Debug, Clone)]
  90pub struct ProjectTransaction(pub HashMap<Entity<Buffer>, language::Transaction>);
  91
  92impl PartialEq for ProjectTransaction {
  93    fn eq(&self, other: &Self) -> bool {
  94        self.0.len() == other.0.len()
  95            && self.0.iter().all(|(buffer, transaction)| {
  96                other.0.get(buffer).is_some_and(|t| t.id == transaction.id)
  97            })
  98    }
  99}
 100
 101impl EventEmitter<BufferStoreEvent> for BufferStore {}
 102
 103impl RemoteBufferStore {
 104    pub fn wait_for_remote_buffer(
 105        &mut self,
 106        id: BufferId,
 107        cx: &mut Context<BufferStore>,
 108    ) -> Task<Result<Entity<Buffer>>> {
 109        let (tx, rx) = oneshot::channel();
 110        self.remote_buffer_listeners.entry(id).or_default().push(tx);
 111
 112        cx.spawn(async move |this, cx| {
 113            if let Some(buffer) = this
 114                .read_with(cx, |buffer_store, _| buffer_store.get(id))
 115                .ok()
 116                .flatten()
 117            {
 118                return Ok(buffer);
 119            }
 120
 121            cx.background_spawn(async move { rx.await? }).await
 122        })
 123    }
 124
 125    fn save_remote_buffer(
 126        &self,
 127        buffer_handle: Entity<Buffer>,
 128        new_path: Option<proto::ProjectPath>,
 129        cx: &Context<BufferStore>,
 130    ) -> Task<Result<()>> {
 131        let buffer = buffer_handle.read(cx);
 132        let buffer_id = buffer.remote_id().into();
 133        let version = buffer.version();
 134        let rpc = self.upstream_client.clone();
 135        let project_id = self.project_id;
 136        cx.spawn(async move |_, cx| {
 137            let response = rpc
 138                .request(proto::SaveBuffer {
 139                    project_id,
 140                    buffer_id,
 141                    new_path,
 142                    version: serialize_version(&version),
 143                })
 144                .await?;
 145            let version = deserialize_version(&response.version);
 146            let mtime = response.mtime.map(|mtime| mtime.into());
 147
 148            buffer_handle.update(cx, |buffer, cx| {
 149                buffer.did_save(version.clone(), mtime, cx);
 150            })?;
 151
 152            Ok(())
 153        })
 154    }
 155
 156    pub fn handle_create_buffer_for_peer(
 157        &mut self,
 158        envelope: TypedEnvelope<proto::CreateBufferForPeer>,
 159        replica_id: ReplicaId,
 160        capability: Capability,
 161        cx: &mut Context<BufferStore>,
 162    ) -> Result<Option<Entity<Buffer>>> {
 163        match envelope.payload.variant.context("missing variant")? {
 164            proto::create_buffer_for_peer::Variant::State(mut state) => {
 165                let buffer_id = BufferId::new(state.id)?;
 166
 167                let buffer_result = maybe!({
 168                    let mut buffer_file = None;
 169                    if let Some(file) = state.file.take() {
 170                        let worktree_id = worktree::WorktreeId::from_proto(file.worktree_id);
 171                        let worktree = self
 172                            .worktree_store
 173                            .read(cx)
 174                            .worktree_for_id(worktree_id, cx)
 175                            .with_context(|| {
 176                                format!("no worktree found for id {}", file.worktree_id)
 177                            })?;
 178                        buffer_file = Some(Arc::new(File::from_proto(file, worktree, cx)?)
 179                            as Arc<dyn language::File>);
 180                    }
 181                    Buffer::from_proto(replica_id, capability, state, buffer_file)
 182                });
 183
 184                match buffer_result {
 185                    Ok(buffer) => {
 186                        let buffer = cx.new(|_| buffer);
 187                        self.loading_remote_buffers_by_id.insert(buffer_id, buffer);
 188                    }
 189                    Err(error) => {
 190                        if let Some(listeners) = self.remote_buffer_listeners.remove(&buffer_id) {
 191                            for listener in listeners {
 192                                listener.send(Err(anyhow!(error.cloned()))).ok();
 193                            }
 194                        }
 195                    }
 196                }
 197            }
 198            proto::create_buffer_for_peer::Variant::Chunk(chunk) => {
 199                let buffer_id = BufferId::new(chunk.buffer_id)?;
 200                let buffer = self
 201                    .loading_remote_buffers_by_id
 202                    .get(&buffer_id)
 203                    .cloned()
 204                    .with_context(|| {
 205                        format!(
 206                            "received chunk for buffer {} without initial state",
 207                            chunk.buffer_id
 208                        )
 209                    })?;
 210
 211                let result = maybe!({
 212                    let operations = chunk
 213                        .operations
 214                        .into_iter()
 215                        .map(language::proto::deserialize_operation)
 216                        .collect::<Result<Vec<_>>>()?;
 217                    buffer.update(cx, |buffer, cx| buffer.apply_ops(operations, cx));
 218                    anyhow::Ok(())
 219                });
 220
 221                if let Err(error) = result {
 222                    self.loading_remote_buffers_by_id.remove(&buffer_id);
 223                    if let Some(listeners) = self.remote_buffer_listeners.remove(&buffer_id) {
 224                        for listener in listeners {
 225                            listener.send(Err(error.cloned())).ok();
 226                        }
 227                    }
 228                } else if chunk.is_last {
 229                    self.loading_remote_buffers_by_id.remove(&buffer_id);
 230                    if self.upstream_client.is_via_collab() {
 231                        // retain buffers sent by peers to avoid races.
 232                        self.shared_with_me.insert(buffer.clone());
 233                    }
 234
 235                    if let Some(senders) = self.remote_buffer_listeners.remove(&buffer_id) {
 236                        for sender in senders {
 237                            sender.send(Ok(buffer.clone())).ok();
 238                        }
 239                    }
 240                    return Ok(Some(buffer));
 241                }
 242            }
 243        }
 244        Ok(None)
 245    }
 246
 247    pub fn incomplete_buffer_ids(&self) -> Vec<BufferId> {
 248        self.loading_remote_buffers_by_id
 249            .keys()
 250            .copied()
 251            .collect::<Vec<_>>()
 252    }
 253
 254    pub fn deserialize_project_transaction(
 255        &self,
 256        message: proto::ProjectTransaction,
 257        push_to_history: bool,
 258        cx: &mut Context<BufferStore>,
 259    ) -> Task<Result<ProjectTransaction>> {
 260        cx.spawn(async move |this, cx| {
 261            let mut project_transaction = ProjectTransaction::default();
 262            for (buffer_id, transaction) in message.buffer_ids.into_iter().zip(message.transactions)
 263            {
 264                let buffer_id = BufferId::new(buffer_id)?;
 265                let buffer = this
 266                    .update(cx, |this, cx| this.wait_for_remote_buffer(buffer_id, cx))?
 267                    .await?;
 268                let transaction = language::proto::deserialize_transaction(transaction)?;
 269                project_transaction.0.insert(buffer, transaction);
 270            }
 271
 272            for (buffer, transaction) in &project_transaction.0 {
 273                buffer
 274                    .update(cx, |buffer, _| {
 275                        buffer.wait_for_edits(transaction.edit_ids.iter().copied())
 276                    })?
 277                    .await?;
 278
 279                if push_to_history {
 280                    buffer.update(cx, |buffer, _| {
 281                        buffer.push_transaction(transaction.clone(), Instant::now());
 282                        buffer.finalize_last_transaction();
 283                    })?;
 284                }
 285            }
 286
 287            Ok(project_transaction)
 288        })
 289    }
 290
 291    fn open_buffer(
 292        &self,
 293        path: Arc<RelPath>,
 294        worktree: Entity<Worktree>,
 295        cx: &mut Context<BufferStore>,
 296    ) -> Task<Result<Entity<Buffer>>> {
 297        let worktree_id = worktree.read(cx).id().to_proto();
 298        let project_id = self.project_id;
 299        let client = self.upstream_client.clone();
 300        cx.spawn(async move |this, cx| {
 301            let response = client
 302                .request(proto::OpenBufferByPath {
 303                    project_id,
 304                    worktree_id,
 305                    path: path.to_proto(),
 306                })
 307                .await?;
 308            let buffer_id = BufferId::new(response.buffer_id)?;
 309
 310            let buffer = this
 311                .update(cx, {
 312                    |this, cx| this.wait_for_remote_buffer(buffer_id, cx)
 313                })?
 314                .await?;
 315
 316            Ok(buffer)
 317        })
 318    }
 319
 320    fn create_buffer(
 321        &self,
 322        project_searchable: bool,
 323        cx: &mut Context<BufferStore>,
 324    ) -> Task<Result<Entity<Buffer>>> {
 325        let create = self.upstream_client.request(proto::OpenNewBuffer {
 326            project_id: self.project_id,
 327        });
 328        cx.spawn(async move |this, cx| {
 329            let response = create.await?;
 330            let buffer_id = BufferId::new(response.buffer_id)?;
 331
 332            this.update(cx, |this, cx| {
 333                if !project_searchable {
 334                    this.non_searchable_buffers.insert(buffer_id);
 335                }
 336                this.wait_for_remote_buffer(buffer_id, cx)
 337            })?
 338            .await
 339        })
 340    }
 341
 342    fn reload_buffers(
 343        &self,
 344        buffers: HashSet<Entity<Buffer>>,
 345        push_to_history: bool,
 346        cx: &mut Context<BufferStore>,
 347    ) -> Task<Result<ProjectTransaction>> {
 348        let request = self.upstream_client.request(proto::ReloadBuffers {
 349            project_id: self.project_id,
 350            buffer_ids: buffers
 351                .iter()
 352                .map(|buffer| buffer.read(cx).remote_id().to_proto())
 353                .collect(),
 354        });
 355
 356        cx.spawn(async move |this, cx| {
 357            let response = request.await?.transaction.context("missing transaction")?;
 358            this.update(cx, |this, cx| {
 359                this.deserialize_project_transaction(response, push_to_history, cx)
 360            })?
 361            .await
 362        })
 363    }
 364}
 365
 366impl LocalBufferStore {
 367    fn save_local_buffer(
 368        &self,
 369        buffer_handle: Entity<Buffer>,
 370        worktree: Entity<Worktree>,
 371        path: Arc<RelPath>,
 372        mut has_changed_file: bool,
 373        cx: &mut Context<BufferStore>,
 374    ) -> Task<Result<()>> {
 375        let buffer = buffer_handle.read(cx);
 376
 377        let text = buffer.as_rope().clone();
 378        let line_ending = buffer.line_ending();
 379        let version = buffer.version();
 380        let buffer_id = buffer.remote_id();
 381        let file = buffer.file().cloned();
 382        if file
 383            .as_ref()
 384            .is_some_and(|file| file.disk_state() == DiskState::New)
 385        {
 386            has_changed_file = true;
 387        }
 388
 389        let save = worktree.update(cx, |worktree, cx| {
 390            worktree.write_file(path, text, line_ending, cx)
 391        });
 392
 393        cx.spawn(async move |this, cx| {
 394            let new_file = save.await?;
 395            let mtime = new_file.disk_state().mtime();
 396            this.update(cx, |this, cx| {
 397                if let Some((downstream_client, project_id)) = this.downstream_client.clone() {
 398                    if has_changed_file {
 399                        downstream_client
 400                            .send(proto::UpdateBufferFile {
 401                                project_id,
 402                                buffer_id: buffer_id.to_proto(),
 403                                file: Some(language::File::to_proto(&*new_file, cx)),
 404                            })
 405                            .log_err();
 406                    }
 407                    downstream_client
 408                        .send(proto::BufferSaved {
 409                            project_id,
 410                            buffer_id: buffer_id.to_proto(),
 411                            version: serialize_version(&version),
 412                            mtime: mtime.map(|time| time.into()),
 413                        })
 414                        .log_err();
 415                }
 416            })?;
 417            buffer_handle.update(cx, |buffer, cx| {
 418                if has_changed_file {
 419                    buffer.file_updated(new_file, cx);
 420                }
 421                buffer.did_save(version.clone(), mtime, cx);
 422            })
 423        })
 424    }
 425
 426    fn subscribe_to_worktree(
 427        &mut self,
 428        worktree: &Entity<Worktree>,
 429        cx: &mut Context<BufferStore>,
 430    ) {
 431        cx.subscribe(worktree, |this, worktree, event, cx| {
 432            if worktree.read(cx).is_local()
 433                && let worktree::Event::UpdatedEntries(changes) = event
 434            {
 435                Self::local_worktree_entries_changed(this, &worktree, changes, cx);
 436            }
 437        })
 438        .detach();
 439    }
 440
 441    fn local_worktree_entries_changed(
 442        this: &mut BufferStore,
 443        worktree_handle: &Entity<Worktree>,
 444        changes: &[(Arc<RelPath>, ProjectEntryId, PathChange)],
 445        cx: &mut Context<BufferStore>,
 446    ) {
 447        let snapshot = worktree_handle.read(cx).snapshot();
 448        for (path, entry_id, _) in changes {
 449            Self::local_worktree_entry_changed(
 450                this,
 451                *entry_id,
 452                path,
 453                worktree_handle,
 454                &snapshot,
 455                cx,
 456            );
 457        }
 458    }
 459
 460    fn local_worktree_entry_changed(
 461        this: &mut BufferStore,
 462        entry_id: ProjectEntryId,
 463        path: &Arc<RelPath>,
 464        worktree: &Entity<worktree::Worktree>,
 465        snapshot: &worktree::Snapshot,
 466        cx: &mut Context<BufferStore>,
 467    ) -> Option<()> {
 468        let project_path = ProjectPath {
 469            worktree_id: snapshot.id(),
 470            path: path.clone(),
 471        };
 472
 473        let buffer_id = this
 474            .as_local_mut()
 475            .and_then(|local| local.local_buffer_ids_by_entry_id.get(&entry_id))
 476            .copied()
 477            .or_else(|| this.path_to_buffer_id.get(&project_path).copied())?;
 478
 479        let buffer = if let Some(buffer) = this.get(buffer_id) {
 480            Some(buffer)
 481        } else {
 482            this.opened_buffers.remove(&buffer_id);
 483            this.non_searchable_buffers.remove(&buffer_id);
 484            None
 485        };
 486
 487        let buffer = if let Some(buffer) = buffer {
 488            buffer
 489        } else {
 490            this.path_to_buffer_id.remove(&project_path);
 491            let this = this.as_local_mut()?;
 492            this.local_buffer_ids_by_entry_id.remove(&entry_id);
 493            return None;
 494        };
 495
 496        let events = buffer.update(cx, |buffer, cx| {
 497            let file = buffer.file()?;
 498            let old_file = File::from_dyn(Some(file))?;
 499            if old_file.worktree != *worktree {
 500                return None;
 501            }
 502
 503            let snapshot_entry = old_file
 504                .entry_id
 505                .and_then(|entry_id| snapshot.entry_for_id(entry_id))
 506                .or_else(|| snapshot.entry_for_path(old_file.path.as_ref()));
 507
 508            let new_file = if let Some(entry) = snapshot_entry {
 509                File {
 510                    disk_state: match entry.mtime {
 511                        Some(mtime) => DiskState::Present { mtime },
 512                        None => old_file.disk_state,
 513                    },
 514                    is_local: true,
 515                    entry_id: Some(entry.id),
 516                    path: entry.path.clone(),
 517                    worktree: worktree.clone(),
 518                    is_private: entry.is_private,
 519                }
 520            } else {
 521                File {
 522                    disk_state: DiskState::Deleted,
 523                    is_local: true,
 524                    entry_id: old_file.entry_id,
 525                    path: old_file.path.clone(),
 526                    worktree: worktree.clone(),
 527                    is_private: old_file.is_private,
 528                }
 529            };
 530
 531            if new_file == *old_file {
 532                return None;
 533            }
 534
 535            let mut events = Vec::new();
 536            if new_file.path != old_file.path {
 537                this.path_to_buffer_id.remove(&ProjectPath {
 538                    path: old_file.path.clone(),
 539                    worktree_id: old_file.worktree_id(cx),
 540                });
 541                this.path_to_buffer_id.insert(
 542                    ProjectPath {
 543                        worktree_id: new_file.worktree_id(cx),
 544                        path: new_file.path.clone(),
 545                    },
 546                    buffer_id,
 547                );
 548                events.push(BufferStoreEvent::BufferChangedFilePath {
 549                    buffer: cx.entity(),
 550                    old_file: buffer.file().cloned(),
 551                });
 552            }
 553            let local = this.as_local_mut()?;
 554            if new_file.entry_id != old_file.entry_id {
 555                if let Some(entry_id) = old_file.entry_id {
 556                    local.local_buffer_ids_by_entry_id.remove(&entry_id);
 557                }
 558                if let Some(entry_id) = new_file.entry_id {
 559                    local
 560                        .local_buffer_ids_by_entry_id
 561                        .insert(entry_id, buffer_id);
 562                }
 563            }
 564
 565            if let Some((client, project_id)) = &this.downstream_client {
 566                client
 567                    .send(proto::UpdateBufferFile {
 568                        project_id: *project_id,
 569                        buffer_id: buffer_id.to_proto(),
 570                        file: Some(new_file.to_proto(cx)),
 571                    })
 572                    .ok();
 573            }
 574
 575            buffer.file_updated(Arc::new(new_file), cx);
 576            Some(events)
 577        })?;
 578
 579        for event in events {
 580            cx.emit(event);
 581        }
 582
 583        None
 584    }
 585
 586    fn save_buffer(
 587        &self,
 588        buffer: Entity<Buffer>,
 589        cx: &mut Context<BufferStore>,
 590    ) -> Task<Result<()>> {
 591        let Some(file) = File::from_dyn(buffer.read(cx).file()) else {
 592            return Task::ready(Err(anyhow!("buffer doesn't have a file")));
 593        };
 594        let worktree = file.worktree.clone();
 595        self.save_local_buffer(buffer, worktree, file.path.clone(), false, cx)
 596    }
 597
 598    fn save_buffer_as(
 599        &self,
 600        buffer: Entity<Buffer>,
 601        path: ProjectPath,
 602        cx: &mut Context<BufferStore>,
 603    ) -> Task<Result<()>> {
 604        let Some(worktree) = self
 605            .worktree_store
 606            .read(cx)
 607            .worktree_for_id(path.worktree_id, cx)
 608        else {
 609            return Task::ready(Err(anyhow!("no such worktree")));
 610        };
 611        self.save_local_buffer(buffer, worktree, path.path, true, cx)
 612    }
 613
 614    fn open_buffer(
 615        &self,
 616        path: Arc<RelPath>,
 617        worktree: Entity<Worktree>,
 618        cx: &mut Context<BufferStore>,
 619    ) -> Task<Result<Entity<Buffer>>> {
 620        let load_buffer = worktree.update(cx, |worktree, cx| {
 621            let load_file = worktree.load_file(path.as_ref(), cx);
 622            let reservation = cx.reserve_entity();
 623            let buffer_id = BufferId::from(reservation.entity_id().as_non_zero_u64());
 624            cx.spawn(async move |_, cx| {
 625                let loaded = load_file.await?;
 626                let text_buffer = cx
 627                    .background_spawn(async move {
 628                        text::Buffer::new(ReplicaId::LOCAL, buffer_id, loaded.text)
 629                    })
 630                    .await;
 631                cx.insert_entity(reservation, |_| {
 632                    Buffer::build(text_buffer, Some(loaded.file), Capability::ReadWrite)
 633                })
 634            })
 635        });
 636
 637        cx.spawn(async move |this, cx| {
 638            let buffer = match load_buffer.await {
 639                Ok(buffer) => Ok(buffer),
 640                Err(error) if is_not_found_error(&error) => cx.new(|cx| {
 641                    let buffer_id = BufferId::from(cx.entity_id().as_non_zero_u64());
 642                    let text_buffer = text::Buffer::new(ReplicaId::LOCAL, buffer_id, "");
 643                    Buffer::build(
 644                        text_buffer,
 645                        Some(Arc::new(File {
 646                            worktree,
 647                            path,
 648                            disk_state: DiskState::New,
 649                            entry_id: None,
 650                            is_local: true,
 651                            is_private: false,
 652                        })),
 653                        Capability::ReadWrite,
 654                    )
 655                }),
 656                Err(e) => Err(e),
 657            }?;
 658            this.update(cx, |this, cx| {
 659                this.add_buffer(buffer.clone(), cx)?;
 660                let buffer_id = buffer.read(cx).remote_id();
 661                if let Some(file) = File::from_dyn(buffer.read(cx).file()) {
 662                    this.path_to_buffer_id.insert(
 663                        ProjectPath {
 664                            worktree_id: file.worktree_id(cx),
 665                            path: file.path.clone(),
 666                        },
 667                        buffer_id,
 668                    );
 669                    let this = this.as_local_mut().unwrap();
 670                    if let Some(entry_id) = file.entry_id {
 671                        this.local_buffer_ids_by_entry_id
 672                            .insert(entry_id, buffer_id);
 673                    }
 674                }
 675
 676                anyhow::Ok(())
 677            })??;
 678
 679            Ok(buffer)
 680        })
 681    }
 682
 683    fn create_buffer(
 684        &self,
 685        project_searchable: bool,
 686        cx: &mut Context<BufferStore>,
 687    ) -> Task<Result<Entity<Buffer>>> {
 688        cx.spawn(async move |buffer_store, cx| {
 689            let buffer =
 690                cx.new(|cx| Buffer::local("", cx).with_language(language::PLAIN_TEXT.clone(), cx))?;
 691            buffer_store.update(cx, |buffer_store, cx| {
 692                buffer_store.add_buffer(buffer.clone(), cx).log_err();
 693                if !project_searchable {
 694                    buffer_store
 695                        .non_searchable_buffers
 696                        .insert(buffer.read(cx).remote_id());
 697                }
 698            })?;
 699            Ok(buffer)
 700        })
 701    }
 702
 703    fn reload_buffers(
 704        &self,
 705        buffers: HashSet<Entity<Buffer>>,
 706        push_to_history: bool,
 707        cx: &mut Context<BufferStore>,
 708    ) -> Task<Result<ProjectTransaction>> {
 709        cx.spawn(async move |_, cx| {
 710            let mut project_transaction = ProjectTransaction::default();
 711            for buffer in buffers {
 712                let transaction = buffer.update(cx, |buffer, cx| buffer.reload(cx))?.await?;
 713                buffer.update(cx, |buffer, cx| {
 714                    if let Some(transaction) = transaction {
 715                        if !push_to_history {
 716                            buffer.forget_transaction(transaction.id);
 717                        }
 718                        project_transaction.0.insert(cx.entity(), transaction);
 719                    }
 720                })?;
 721            }
 722
 723            Ok(project_transaction)
 724        })
 725    }
 726}
 727
 728impl BufferStore {
 729    pub fn init(client: &AnyProtoClient) {
 730        client.add_entity_message_handler(Self::handle_buffer_reloaded);
 731        client.add_entity_message_handler(Self::handle_buffer_saved);
 732        client.add_entity_message_handler(Self::handle_update_buffer_file);
 733        client.add_entity_request_handler(Self::handle_save_buffer);
 734        client.add_entity_request_handler(Self::handle_reload_buffers);
 735    }
 736
 737    /// Creates a buffer store, optionally retaining its buffers.
 738    pub fn local(worktree_store: Entity<WorktreeStore>, cx: &mut Context<Self>) -> Self {
 739        Self {
 740            state: BufferStoreState::Local(LocalBufferStore {
 741                local_buffer_ids_by_entry_id: Default::default(),
 742                worktree_store: worktree_store.clone(),
 743                _subscription: cx.subscribe(&worktree_store, |this, _, event, cx| {
 744                    if let WorktreeStoreEvent::WorktreeAdded(worktree) = event {
 745                        let this = this.as_local_mut().unwrap();
 746                        this.subscribe_to_worktree(worktree, cx);
 747                    }
 748                }),
 749            }),
 750            downstream_client: None,
 751            opened_buffers: Default::default(),
 752            path_to_buffer_id: Default::default(),
 753            shared_buffers: Default::default(),
 754            loading_buffers: Default::default(),
 755            non_searchable_buffers: Default::default(),
 756            worktree_store,
 757        }
 758    }
 759
 760    pub fn remote(
 761        worktree_store: Entity<WorktreeStore>,
 762        upstream_client: AnyProtoClient,
 763        remote_id: u64,
 764        _cx: &mut Context<Self>,
 765    ) -> Self {
 766        Self {
 767            state: BufferStoreState::Remote(RemoteBufferStore {
 768                shared_with_me: Default::default(),
 769                loading_remote_buffers_by_id: Default::default(),
 770                remote_buffer_listeners: Default::default(),
 771                project_id: remote_id,
 772                upstream_client,
 773                worktree_store: worktree_store.clone(),
 774            }),
 775            downstream_client: None,
 776            opened_buffers: Default::default(),
 777            path_to_buffer_id: Default::default(),
 778            loading_buffers: Default::default(),
 779            shared_buffers: Default::default(),
 780            non_searchable_buffers: Default::default(),
 781            worktree_store,
 782        }
 783    }
 784
 785    fn as_local_mut(&mut self) -> Option<&mut LocalBufferStore> {
 786        match &mut self.state {
 787            BufferStoreState::Local(state) => Some(state),
 788            _ => None,
 789        }
 790    }
 791
 792    fn as_remote_mut(&mut self) -> Option<&mut RemoteBufferStore> {
 793        match &mut self.state {
 794            BufferStoreState::Remote(state) => Some(state),
 795            _ => None,
 796        }
 797    }
 798
 799    fn as_remote(&self) -> Option<&RemoteBufferStore> {
 800        match &self.state {
 801            BufferStoreState::Remote(state) => Some(state),
 802            _ => None,
 803        }
 804    }
 805
 806    pub fn open_buffer(
 807        &mut self,
 808        project_path: ProjectPath,
 809        cx: &mut Context<Self>,
 810    ) -> Task<Result<Entity<Buffer>>> {
 811        if let Some(buffer) = self.get_by_path(&project_path) {
 812            cx.emit(BufferStoreEvent::BufferOpened {
 813                buffer: buffer.clone(),
 814                project_path,
 815            });
 816
 817            return Task::ready(Ok(buffer));
 818        }
 819
 820        let task = match self.loading_buffers.entry(project_path.clone()) {
 821            hash_map::Entry::Occupied(e) => e.get().clone(),
 822            hash_map::Entry::Vacant(entry) => {
 823                let path = project_path.path.clone();
 824                let Some(worktree) = self
 825                    .worktree_store
 826                    .read(cx)
 827                    .worktree_for_id(project_path.worktree_id, cx)
 828                else {
 829                    return Task::ready(Err(anyhow!("no such worktree")));
 830                };
 831                let load_buffer = match &self.state {
 832                    BufferStoreState::Local(this) => this.open_buffer(path, worktree, cx),
 833                    BufferStoreState::Remote(this) => this.open_buffer(path, worktree, cx),
 834                };
 835
 836                entry
 837                    .insert(
 838                        cx.spawn(async move |this, cx| {
 839                            let load_result = load_buffer.await;
 840                            this.update(cx, |this, cx| {
 841                                // Record the fact that the buffer is no longer loading.
 842                                this.loading_buffers.remove(&project_path);
 843
 844                                let buffer = load_result.map_err(Arc::new)?;
 845                                cx.emit(BufferStoreEvent::BufferOpened {
 846                                    buffer: buffer.clone(),
 847                                    project_path,
 848                                });
 849
 850                                Ok(buffer)
 851                            })?
 852                        })
 853                        .shared(),
 854                    )
 855                    .clone()
 856            }
 857        };
 858
 859        cx.background_spawn(async move {
 860            task.await.map_err(|e| {
 861                if e.error_code() != ErrorCode::Internal {
 862                    anyhow!(e.error_code())
 863                } else {
 864                    anyhow!("{e}")
 865                }
 866            })
 867        })
 868    }
 869
 870    pub fn create_buffer(
 871        &mut self,
 872        project_searchable: bool,
 873        cx: &mut Context<Self>,
 874    ) -> Task<Result<Entity<Buffer>>> {
 875        match &self.state {
 876            BufferStoreState::Local(this) => this.create_buffer(project_searchable, cx),
 877            BufferStoreState::Remote(this) => this.create_buffer(project_searchable, cx),
 878        }
 879    }
 880
 881    pub fn save_buffer(
 882        &mut self,
 883        buffer: Entity<Buffer>,
 884        cx: &mut Context<Self>,
 885    ) -> Task<Result<()>> {
 886        match &mut self.state {
 887            BufferStoreState::Local(this) => this.save_buffer(buffer, cx),
 888            BufferStoreState::Remote(this) => this.save_remote_buffer(buffer, None, cx),
 889        }
 890    }
 891
 892    pub fn save_buffer_as(
 893        &mut self,
 894        buffer: Entity<Buffer>,
 895        path: ProjectPath,
 896        cx: &mut Context<Self>,
 897    ) -> Task<Result<()>> {
 898        let old_file = buffer.read(cx).file().cloned();
 899        let task = match &self.state {
 900            BufferStoreState::Local(this) => this.save_buffer_as(buffer.clone(), path, cx),
 901            BufferStoreState::Remote(this) => {
 902                this.save_remote_buffer(buffer.clone(), Some(path.to_proto()), cx)
 903            }
 904        };
 905        cx.spawn(async move |this, cx| {
 906            task.await?;
 907            this.update(cx, |_, cx| {
 908                cx.emit(BufferStoreEvent::BufferChangedFilePath { buffer, old_file });
 909            })
 910        })
 911    }
 912
 913    fn add_buffer(&mut self, buffer_entity: Entity<Buffer>, cx: &mut Context<Self>) -> Result<()> {
 914        let buffer = buffer_entity.read(cx);
 915        let remote_id = buffer.remote_id();
 916        let path = File::from_dyn(buffer.file()).map(|file| ProjectPath {
 917            path: file.path.clone(),
 918            worktree_id: file.worktree_id(cx),
 919        });
 920        let is_remote = buffer.replica_id().is_remote();
 921        let open_buffer = OpenBuffer::Complete {
 922            buffer: buffer_entity.downgrade(),
 923        };
 924
 925        let handle = cx.entity().downgrade();
 926        buffer_entity.update(cx, move |_, cx| {
 927            cx.on_release(move |buffer, cx| {
 928                handle
 929                    .update(cx, |_, cx| {
 930                        cx.emit(BufferStoreEvent::BufferDropped(buffer.remote_id()))
 931                    })
 932                    .ok();
 933            })
 934            .detach()
 935        });
 936        let _expect_path_to_exist;
 937        match self.opened_buffers.entry(remote_id) {
 938            hash_map::Entry::Vacant(entry) => {
 939                entry.insert(open_buffer);
 940                _expect_path_to_exist = false;
 941            }
 942            hash_map::Entry::Occupied(mut entry) => {
 943                if let OpenBuffer::Operations(operations) = entry.get_mut() {
 944                    buffer_entity.update(cx, |b, cx| b.apply_ops(operations.drain(..), cx));
 945                } else if entry.get().upgrade().is_some() {
 946                    if is_remote {
 947                        return Ok(());
 948                    } else {
 949                        debug_panic!("buffer {remote_id} was already registered");
 950                        anyhow::bail!("buffer {remote_id} was already registered");
 951                    }
 952                }
 953                entry.insert(open_buffer);
 954                _expect_path_to_exist = true;
 955            }
 956        }
 957
 958        if let Some(path) = path {
 959            self.path_to_buffer_id.insert(path, remote_id);
 960        }
 961
 962        cx.subscribe(&buffer_entity, Self::on_buffer_event).detach();
 963        cx.emit(BufferStoreEvent::BufferAdded(buffer_entity));
 964        Ok(())
 965    }
 966
 967    pub fn buffers(&self) -> impl '_ + Iterator<Item = Entity<Buffer>> {
 968        self.opened_buffers
 969            .values()
 970            .filter_map(|buffer| buffer.upgrade())
 971    }
 972
 973    pub(crate) fn is_searchable(&self, id: &BufferId) -> bool {
 974        !self.non_searchable_buffers.contains(&id)
 975    }
 976
 977    pub fn loading_buffers(
 978        &self,
 979    ) -> impl Iterator<Item = (&ProjectPath, impl Future<Output = Result<Entity<Buffer>>>)> {
 980        self.loading_buffers.iter().map(|(path, task)| {
 981            let task = task.clone();
 982            (path, async move {
 983                task.await.map_err(|e| {
 984                    if e.error_code() != ErrorCode::Internal {
 985                        anyhow!(e.error_code())
 986                    } else {
 987                        anyhow!("{e}")
 988                    }
 989                })
 990            })
 991        })
 992    }
 993
 994    pub fn buffer_id_for_project_path(&self, project_path: &ProjectPath) -> Option<&BufferId> {
 995        self.path_to_buffer_id.get(project_path)
 996    }
 997
 998    pub fn get_by_path(&self, path: &ProjectPath) -> Option<Entity<Buffer>> {
 999        self.path_to_buffer_id
1000            .get(path)
1001            .and_then(|buffer_id| self.get(*buffer_id))
1002    }
1003
1004    pub fn get(&self, buffer_id: BufferId) -> Option<Entity<Buffer>> {
1005        self.opened_buffers.get(&buffer_id)?.upgrade()
1006    }
1007
1008    pub fn get_existing(&self, buffer_id: BufferId) -> Result<Entity<Buffer>> {
1009        self.get(buffer_id)
1010            .with_context(|| format!("unknown buffer id {buffer_id}"))
1011    }
1012
1013    pub fn get_possibly_incomplete(&self, buffer_id: BufferId) -> Option<Entity<Buffer>> {
1014        self.get(buffer_id).or_else(|| {
1015            self.as_remote()
1016                .and_then(|remote| remote.loading_remote_buffers_by_id.get(&buffer_id).cloned())
1017        })
1018    }
1019
1020    pub fn buffer_version_info(&self, cx: &App) -> (Vec<proto::BufferVersion>, Vec<BufferId>) {
1021        let buffers = self
1022            .buffers()
1023            .map(|buffer| {
1024                let buffer = buffer.read(cx);
1025                proto::BufferVersion {
1026                    id: buffer.remote_id().into(),
1027                    version: language::proto::serialize_version(&buffer.version),
1028                }
1029            })
1030            .collect();
1031        let incomplete_buffer_ids = self
1032            .as_remote()
1033            .map(|remote| remote.incomplete_buffer_ids())
1034            .unwrap_or_default();
1035        (buffers, incomplete_buffer_ids)
1036    }
1037
1038    pub fn disconnected_from_host(&mut self, cx: &mut App) {
1039        for open_buffer in self.opened_buffers.values_mut() {
1040            if let Some(buffer) = open_buffer.upgrade() {
1041                buffer.update(cx, |buffer, _| buffer.give_up_waiting());
1042            }
1043        }
1044
1045        for buffer in self.buffers() {
1046            buffer.update(cx, |buffer, cx| {
1047                buffer.set_capability(Capability::ReadOnly, cx)
1048            });
1049        }
1050
1051        if let Some(remote) = self.as_remote_mut() {
1052            // Wake up all futures currently waiting on a buffer to get opened,
1053            // to give them a chance to fail now that we've disconnected.
1054            remote.remote_buffer_listeners.clear()
1055        }
1056    }
1057
1058    pub fn shared(&mut self, remote_id: u64, downstream_client: AnyProtoClient, _cx: &mut App) {
1059        self.downstream_client = Some((downstream_client, remote_id));
1060    }
1061
1062    pub fn unshared(&mut self, _cx: &mut Context<Self>) {
1063        self.downstream_client.take();
1064        self.forget_shared_buffers();
1065    }
1066
1067    pub fn discard_incomplete(&mut self) {
1068        self.opened_buffers
1069            .retain(|_, buffer| !matches!(buffer, OpenBuffer::Operations(_)));
1070    }
1071
1072    fn buffer_changed_file(&mut self, buffer: Entity<Buffer>, cx: &mut App) -> Option<()> {
1073        let file = File::from_dyn(buffer.read(cx).file())?;
1074
1075        let remote_id = buffer.read(cx).remote_id();
1076        if let Some(entry_id) = file.entry_id {
1077            if let Some(local) = self.as_local_mut() {
1078                match local.local_buffer_ids_by_entry_id.get(&entry_id) {
1079                    Some(_) => {
1080                        return None;
1081                    }
1082                    None => {
1083                        local
1084                            .local_buffer_ids_by_entry_id
1085                            .insert(entry_id, remote_id);
1086                    }
1087                }
1088            }
1089            self.path_to_buffer_id.insert(
1090                ProjectPath {
1091                    worktree_id: file.worktree_id(cx),
1092                    path: file.path.clone(),
1093                },
1094                remote_id,
1095            );
1096        };
1097
1098        Some(())
1099    }
1100
1101    fn on_buffer_event(
1102        &mut self,
1103        buffer: Entity<Buffer>,
1104        event: &BufferEvent,
1105        cx: &mut Context<Self>,
1106    ) {
1107        match event {
1108            BufferEvent::FileHandleChanged => {
1109                self.buffer_changed_file(buffer, cx);
1110            }
1111            BufferEvent::Reloaded => {
1112                let Some((downstream_client, project_id)) = self.downstream_client.as_ref() else {
1113                    return;
1114                };
1115                let buffer = buffer.read(cx);
1116                downstream_client
1117                    .send(proto::BufferReloaded {
1118                        project_id: *project_id,
1119                        buffer_id: buffer.remote_id().to_proto(),
1120                        version: serialize_version(&buffer.version()),
1121                        mtime: buffer.saved_mtime().map(|t| t.into()),
1122                        line_ending: serialize_line_ending(buffer.line_ending()) as i32,
1123                    })
1124                    .log_err();
1125            }
1126            BufferEvent::LanguageChanged => {}
1127            _ => {}
1128        }
1129    }
1130
1131    pub async fn handle_update_buffer(
1132        this: Entity<Self>,
1133        envelope: TypedEnvelope<proto::UpdateBuffer>,
1134        mut cx: AsyncApp,
1135    ) -> Result<proto::Ack> {
1136        let payload = envelope.payload;
1137        let buffer_id = BufferId::new(payload.buffer_id)?;
1138        let ops = payload
1139            .operations
1140            .into_iter()
1141            .map(language::proto::deserialize_operation)
1142            .collect::<Result<Vec<_>, _>>()?;
1143        this.update(&mut cx, |this, cx| {
1144            match this.opened_buffers.entry(buffer_id) {
1145                hash_map::Entry::Occupied(mut e) => match e.get_mut() {
1146                    OpenBuffer::Operations(operations) => operations.extend_from_slice(&ops),
1147                    OpenBuffer::Complete { buffer, .. } => {
1148                        if let Some(buffer) = buffer.upgrade() {
1149                            buffer.update(cx, |buffer, cx| buffer.apply_ops(ops, cx));
1150                        }
1151                    }
1152                },
1153                hash_map::Entry::Vacant(e) => {
1154                    e.insert(OpenBuffer::Operations(ops));
1155                }
1156            }
1157            Ok(proto::Ack {})
1158        })?
1159    }
1160
1161    pub fn register_shared_lsp_handle(
1162        &mut self,
1163        peer_id: proto::PeerId,
1164        buffer_id: BufferId,
1165        handle: OpenLspBufferHandle,
1166    ) {
1167        if let Some(shared_buffers) = self.shared_buffers.get_mut(&peer_id)
1168            && let Some(buffer) = shared_buffers.get_mut(&buffer_id)
1169        {
1170            buffer.lsp_handle = Some(handle);
1171            return;
1172        }
1173        debug_panic!("tried to register shared lsp handle, but buffer was not shared")
1174    }
1175
1176    pub fn handle_synchronize_buffers(
1177        &mut self,
1178        envelope: TypedEnvelope<proto::SynchronizeBuffers>,
1179        cx: &mut Context<Self>,
1180        client: Arc<Client>,
1181    ) -> Result<proto::SynchronizeBuffersResponse> {
1182        let project_id = envelope.payload.project_id;
1183        let mut response = proto::SynchronizeBuffersResponse {
1184            buffers: Default::default(),
1185        };
1186        let Some(guest_id) = envelope.original_sender_id else {
1187            anyhow::bail!("missing original_sender_id on SynchronizeBuffers request");
1188        };
1189
1190        self.shared_buffers.entry(guest_id).or_default().clear();
1191        for buffer in envelope.payload.buffers {
1192            let buffer_id = BufferId::new(buffer.id)?;
1193            let remote_version = language::proto::deserialize_version(&buffer.version);
1194            if let Some(buffer) = self.get(buffer_id) {
1195                self.shared_buffers
1196                    .entry(guest_id)
1197                    .or_default()
1198                    .entry(buffer_id)
1199                    .or_insert_with(|| SharedBuffer {
1200                        buffer: buffer.clone(),
1201                        lsp_handle: None,
1202                    });
1203
1204                let buffer = buffer.read(cx);
1205                response.buffers.push(proto::BufferVersion {
1206                    id: buffer_id.into(),
1207                    version: language::proto::serialize_version(&buffer.version),
1208                });
1209
1210                let operations = buffer.serialize_ops(Some(remote_version), cx);
1211                let client = client.clone();
1212                if let Some(file) = buffer.file() {
1213                    client
1214                        .send(proto::UpdateBufferFile {
1215                            project_id,
1216                            buffer_id: buffer_id.into(),
1217                            file: Some(file.to_proto(cx)),
1218                        })
1219                        .log_err();
1220                }
1221
1222                // TODO(max): do something
1223                // client
1224                //     .send(proto::UpdateStagedText {
1225                //         project_id,
1226                //         buffer_id: buffer_id.into(),
1227                //         diff_base: buffer.diff_base().map(ToString::to_string),
1228                //     })
1229                //     .log_err();
1230
1231                client
1232                    .send(proto::BufferReloaded {
1233                        project_id,
1234                        buffer_id: buffer_id.into(),
1235                        version: language::proto::serialize_version(buffer.saved_version()),
1236                        mtime: buffer.saved_mtime().map(|time| time.into()),
1237                        line_ending: language::proto::serialize_line_ending(buffer.line_ending())
1238                            as i32,
1239                    })
1240                    .log_err();
1241
1242                cx.background_spawn(
1243                    async move {
1244                        let operations = operations.await;
1245                        for chunk in split_operations(operations) {
1246                            client
1247                                .request(proto::UpdateBuffer {
1248                                    project_id,
1249                                    buffer_id: buffer_id.into(),
1250                                    operations: chunk,
1251                                })
1252                                .await?;
1253                        }
1254                        anyhow::Ok(())
1255                    }
1256                    .log_err(),
1257                )
1258                .detach();
1259            }
1260        }
1261        Ok(response)
1262    }
1263
1264    pub fn handle_create_buffer_for_peer(
1265        &mut self,
1266        envelope: TypedEnvelope<proto::CreateBufferForPeer>,
1267        replica_id: ReplicaId,
1268        capability: Capability,
1269        cx: &mut Context<Self>,
1270    ) -> Result<()> {
1271        let remote = self
1272            .as_remote_mut()
1273            .context("buffer store is not a remote")?;
1274
1275        if let Some(buffer) =
1276            remote.handle_create_buffer_for_peer(envelope, replica_id, capability, cx)?
1277        {
1278            self.add_buffer(buffer, cx)?;
1279        }
1280
1281        Ok(())
1282    }
1283
1284    pub async fn handle_update_buffer_file(
1285        this: Entity<Self>,
1286        envelope: TypedEnvelope<proto::UpdateBufferFile>,
1287        mut cx: AsyncApp,
1288    ) -> Result<()> {
1289        let buffer_id = envelope.payload.buffer_id;
1290        let buffer_id = BufferId::new(buffer_id)?;
1291
1292        this.update(&mut cx, |this, cx| {
1293            let payload = envelope.payload.clone();
1294            if let Some(buffer) = this.get_possibly_incomplete(buffer_id) {
1295                let file = payload.file.context("invalid file")?;
1296                let worktree = this
1297                    .worktree_store
1298                    .read(cx)
1299                    .worktree_for_id(WorktreeId::from_proto(file.worktree_id), cx)
1300                    .context("no such worktree")?;
1301                let file = File::from_proto(file, worktree, cx)?;
1302                let old_file = buffer.update(cx, |buffer, cx| {
1303                    let old_file = buffer.file().cloned();
1304                    let new_path = file.path.clone();
1305
1306                    buffer.file_updated(Arc::new(file), cx);
1307                    if old_file.as_ref().is_none_or(|old| *old.path() != new_path) {
1308                        Some(old_file)
1309                    } else {
1310                        None
1311                    }
1312                });
1313                if let Some(old_file) = old_file {
1314                    cx.emit(BufferStoreEvent::BufferChangedFilePath { buffer, old_file });
1315                }
1316            }
1317            if let Some((downstream_client, project_id)) = this.downstream_client.as_ref() {
1318                downstream_client
1319                    .send(proto::UpdateBufferFile {
1320                        project_id: *project_id,
1321                        buffer_id: buffer_id.into(),
1322                        file: envelope.payload.file,
1323                    })
1324                    .log_err();
1325            }
1326            Ok(())
1327        })?
1328    }
1329
1330    pub async fn handle_save_buffer(
1331        this: Entity<Self>,
1332        envelope: TypedEnvelope<proto::SaveBuffer>,
1333        mut cx: AsyncApp,
1334    ) -> Result<proto::BufferSaved> {
1335        let buffer_id = BufferId::new(envelope.payload.buffer_id)?;
1336        let (buffer, project_id) = this.read_with(&cx, |this, _| {
1337            anyhow::Ok((
1338                this.get_existing(buffer_id)?,
1339                this.downstream_client
1340                    .as_ref()
1341                    .map(|(_, project_id)| *project_id)
1342                    .context("project is not shared")?,
1343            ))
1344        })??;
1345        buffer
1346            .update(&mut cx, |buffer, _| {
1347                buffer.wait_for_version(deserialize_version(&envelope.payload.version))
1348            })?
1349            .await?;
1350        let buffer_id = buffer.read_with(&cx, |buffer, _| buffer.remote_id())?;
1351
1352        if let Some(new_path) = envelope.payload.new_path
1353            && let Some(new_path) = ProjectPath::from_proto(new_path)
1354        {
1355            this.update(&mut cx, |this, cx| {
1356                this.save_buffer_as(buffer.clone(), new_path, cx)
1357            })?
1358            .await?;
1359        } else {
1360            this.update(&mut cx, |this, cx| this.save_buffer(buffer.clone(), cx))?
1361                .await?;
1362        }
1363
1364        buffer.read_with(&cx, |buffer, _| proto::BufferSaved {
1365            project_id,
1366            buffer_id: buffer_id.into(),
1367            version: serialize_version(buffer.saved_version()),
1368            mtime: buffer.saved_mtime().map(|time| time.into()),
1369        })
1370    }
1371
1372    pub async fn handle_close_buffer(
1373        this: Entity<Self>,
1374        envelope: TypedEnvelope<proto::CloseBuffer>,
1375        mut cx: AsyncApp,
1376    ) -> Result<()> {
1377        let peer_id = envelope.sender_id;
1378        let buffer_id = BufferId::new(envelope.payload.buffer_id)?;
1379        this.update(&mut cx, |this, cx| {
1380            if let Some(shared) = this.shared_buffers.get_mut(&peer_id)
1381                && shared.remove(&buffer_id).is_some()
1382            {
1383                cx.emit(BufferStoreEvent::SharedBufferClosed(peer_id, buffer_id));
1384                if shared.is_empty() {
1385                    this.shared_buffers.remove(&peer_id);
1386                }
1387                return;
1388            }
1389            debug_panic!(
1390                "peer_id {} closed buffer_id {} which was either not open or already closed",
1391                peer_id,
1392                buffer_id
1393            )
1394        })
1395    }
1396
1397    pub async fn handle_buffer_saved(
1398        this: Entity<Self>,
1399        envelope: TypedEnvelope<proto::BufferSaved>,
1400        mut cx: AsyncApp,
1401    ) -> Result<()> {
1402        let buffer_id = BufferId::new(envelope.payload.buffer_id)?;
1403        let version = deserialize_version(&envelope.payload.version);
1404        let mtime = envelope.payload.mtime.clone().map(|time| time.into());
1405        this.update(&mut cx, move |this, cx| {
1406            if let Some(buffer) = this.get_possibly_incomplete(buffer_id) {
1407                buffer.update(cx, |buffer, cx| {
1408                    buffer.did_save(version, mtime, cx);
1409                });
1410            }
1411
1412            if let Some((downstream_client, project_id)) = this.downstream_client.as_ref() {
1413                downstream_client
1414                    .send(proto::BufferSaved {
1415                        project_id: *project_id,
1416                        buffer_id: buffer_id.into(),
1417                        mtime: envelope.payload.mtime,
1418                        version: envelope.payload.version,
1419                    })
1420                    .log_err();
1421            }
1422        })
1423    }
1424
1425    pub async fn handle_buffer_reloaded(
1426        this: Entity<Self>,
1427        envelope: TypedEnvelope<proto::BufferReloaded>,
1428        mut cx: AsyncApp,
1429    ) -> Result<()> {
1430        let buffer_id = BufferId::new(envelope.payload.buffer_id)?;
1431        let version = deserialize_version(&envelope.payload.version);
1432        let mtime = envelope.payload.mtime.clone().map(|time| time.into());
1433        let line_ending = deserialize_line_ending(
1434            proto::LineEnding::from_i32(envelope.payload.line_ending)
1435                .context("missing line ending")?,
1436        );
1437        this.update(&mut cx, |this, cx| {
1438            if let Some(buffer) = this.get_possibly_incomplete(buffer_id) {
1439                buffer.update(cx, |buffer, cx| {
1440                    buffer.did_reload(version, line_ending, mtime, cx);
1441                });
1442            }
1443
1444            if let Some((downstream_client, project_id)) = this.downstream_client.as_ref() {
1445                downstream_client
1446                    .send(proto::BufferReloaded {
1447                        project_id: *project_id,
1448                        buffer_id: buffer_id.into(),
1449                        mtime: envelope.payload.mtime,
1450                        version: envelope.payload.version,
1451                        line_ending: envelope.payload.line_ending,
1452                    })
1453                    .log_err();
1454            }
1455        })
1456    }
1457
1458    pub fn reload_buffers(
1459        &self,
1460        buffers: HashSet<Entity<Buffer>>,
1461        push_to_history: bool,
1462        cx: &mut Context<Self>,
1463    ) -> Task<Result<ProjectTransaction>> {
1464        if buffers.is_empty() {
1465            return Task::ready(Ok(ProjectTransaction::default()));
1466        }
1467        match &self.state {
1468            BufferStoreState::Local(this) => this.reload_buffers(buffers, push_to_history, cx),
1469            BufferStoreState::Remote(this) => this.reload_buffers(buffers, push_to_history, cx),
1470        }
1471    }
1472
1473    async fn handle_reload_buffers(
1474        this: Entity<Self>,
1475        envelope: TypedEnvelope<proto::ReloadBuffers>,
1476        mut cx: AsyncApp,
1477    ) -> Result<proto::ReloadBuffersResponse> {
1478        let sender_id = envelope.original_sender_id().unwrap_or_default();
1479        let reload = this.update(&mut cx, |this, cx| {
1480            let mut buffers = HashSet::default();
1481            for buffer_id in &envelope.payload.buffer_ids {
1482                let buffer_id = BufferId::new(*buffer_id)?;
1483                buffers.insert(this.get_existing(buffer_id)?);
1484            }
1485            anyhow::Ok(this.reload_buffers(buffers, false, cx))
1486        })??;
1487
1488        let project_transaction = reload.await?;
1489        let project_transaction = this.update(&mut cx, |this, cx| {
1490            this.serialize_project_transaction_for_peer(project_transaction, sender_id, cx)
1491        })?;
1492        Ok(proto::ReloadBuffersResponse {
1493            transaction: Some(project_transaction),
1494        })
1495    }
1496
1497    pub fn create_buffer_for_peer(
1498        &mut self,
1499        buffer: &Entity<Buffer>,
1500        peer_id: proto::PeerId,
1501        cx: &mut Context<Self>,
1502    ) -> Task<Result<()>> {
1503        let buffer_id = buffer.read(cx).remote_id();
1504        let shared_buffers = self.shared_buffers.entry(peer_id).or_default();
1505        if shared_buffers.contains_key(&buffer_id) {
1506            return Task::ready(Ok(()));
1507        }
1508        shared_buffers.insert(
1509            buffer_id,
1510            SharedBuffer {
1511                buffer: buffer.clone(),
1512                lsp_handle: None,
1513            },
1514        );
1515
1516        let Some((client, project_id)) = self.downstream_client.clone() else {
1517            return Task::ready(Ok(()));
1518        };
1519
1520        cx.spawn(async move |this, cx| {
1521            let Some(buffer) = this.read_with(cx, |this, _| this.get(buffer_id))? else {
1522                return anyhow::Ok(());
1523            };
1524
1525            let operations = buffer.update(cx, |b, cx| b.serialize_ops(None, cx))?;
1526            let operations = operations.await;
1527            let state = buffer.update(cx, |buffer, cx| buffer.to_proto(cx))?;
1528
1529            let initial_state = proto::CreateBufferForPeer {
1530                project_id,
1531                peer_id: Some(peer_id),
1532                variant: Some(proto::create_buffer_for_peer::Variant::State(state)),
1533            };
1534
1535            if client.send(initial_state).log_err().is_some() {
1536                let client = client.clone();
1537                cx.background_spawn(async move {
1538                    let mut chunks = split_operations(operations).peekable();
1539                    while let Some(chunk) = chunks.next() {
1540                        let is_last = chunks.peek().is_none();
1541                        client.send(proto::CreateBufferForPeer {
1542                            project_id,
1543                            peer_id: Some(peer_id),
1544                            variant: Some(proto::create_buffer_for_peer::Variant::Chunk(
1545                                proto::BufferChunk {
1546                                    buffer_id: buffer_id.into(),
1547                                    operations: chunk,
1548                                    is_last,
1549                                },
1550                            )),
1551                        })?;
1552                    }
1553                    anyhow::Ok(())
1554                })
1555                .await
1556                .log_err();
1557            }
1558            Ok(())
1559        })
1560    }
1561
1562    pub fn forget_shared_buffers(&mut self) {
1563        self.shared_buffers.clear();
1564    }
1565
1566    pub fn forget_shared_buffers_for(&mut self, peer_id: &proto::PeerId) {
1567        self.shared_buffers.remove(peer_id);
1568    }
1569
1570    pub fn update_peer_id(&mut self, old_peer_id: &proto::PeerId, new_peer_id: proto::PeerId) {
1571        if let Some(buffers) = self.shared_buffers.remove(old_peer_id) {
1572            self.shared_buffers.insert(new_peer_id, buffers);
1573        }
1574    }
1575
1576    pub fn has_shared_buffers(&self) -> bool {
1577        !self.shared_buffers.is_empty()
1578    }
1579
1580    pub fn create_local_buffer(
1581        &mut self,
1582        text: &str,
1583        language: Option<Arc<Language>>,
1584        project_searchable: bool,
1585        cx: &mut Context<Self>,
1586    ) -> Entity<Buffer> {
1587        let buffer = cx.new(|cx| {
1588            Buffer::local(text, cx)
1589                .with_language(language.unwrap_or_else(|| language::PLAIN_TEXT.clone()), cx)
1590        });
1591
1592        self.add_buffer(buffer.clone(), cx).log_err();
1593        let buffer_id = buffer.read(cx).remote_id();
1594        if !project_searchable {
1595            self.non_searchable_buffers.insert(buffer_id);
1596        }
1597
1598        if let Some(file) = File::from_dyn(buffer.read(cx).file()) {
1599            self.path_to_buffer_id.insert(
1600                ProjectPath {
1601                    worktree_id: file.worktree_id(cx),
1602                    path: file.path.clone(),
1603                },
1604                buffer_id,
1605            );
1606            let this = self
1607                .as_local_mut()
1608                .expect("local-only method called in a non-local context");
1609            if let Some(entry_id) = file.entry_id {
1610                this.local_buffer_ids_by_entry_id
1611                    .insert(entry_id, buffer_id);
1612            }
1613        }
1614        buffer
1615    }
1616
1617    pub fn deserialize_project_transaction(
1618        &mut self,
1619        message: proto::ProjectTransaction,
1620        push_to_history: bool,
1621        cx: &mut Context<Self>,
1622    ) -> Task<Result<ProjectTransaction>> {
1623        if let Some(this) = self.as_remote_mut() {
1624            this.deserialize_project_transaction(message, push_to_history, cx)
1625        } else {
1626            debug_panic!("not a remote buffer store");
1627            Task::ready(Err(anyhow!("not a remote buffer store")))
1628        }
1629    }
1630
1631    pub fn wait_for_remote_buffer(
1632        &mut self,
1633        id: BufferId,
1634        cx: &mut Context<BufferStore>,
1635    ) -> Task<Result<Entity<Buffer>>> {
1636        if let Some(this) = self.as_remote_mut() {
1637            this.wait_for_remote_buffer(id, cx)
1638        } else {
1639            debug_panic!("not a remote buffer store");
1640            Task::ready(Err(anyhow!("not a remote buffer store")))
1641        }
1642    }
1643
1644    pub fn serialize_project_transaction_for_peer(
1645        &mut self,
1646        project_transaction: ProjectTransaction,
1647        peer_id: proto::PeerId,
1648        cx: &mut Context<Self>,
1649    ) -> proto::ProjectTransaction {
1650        let mut serialized_transaction = proto::ProjectTransaction {
1651            buffer_ids: Default::default(),
1652            transactions: Default::default(),
1653        };
1654        for (buffer, transaction) in project_transaction.0 {
1655            self.create_buffer_for_peer(&buffer, peer_id, cx)
1656                .detach_and_log_err(cx);
1657            serialized_transaction
1658                .buffer_ids
1659                .push(buffer.read(cx).remote_id().into());
1660            serialized_transaction
1661                .transactions
1662                .push(language::proto::serialize_transaction(&transaction));
1663        }
1664        serialized_transaction
1665    }
1666}
1667
1668impl OpenBuffer {
1669    fn upgrade(&self) -> Option<Entity<Buffer>> {
1670        match self {
1671            OpenBuffer::Complete { buffer, .. } => buffer.upgrade(),
1672            OpenBuffer::Operations(_) => None,
1673        }
1674    }
1675}
1676
1677fn is_not_found_error(error: &anyhow::Error) -> bool {
1678    error
1679        .root_cause()
1680        .downcast_ref::<io::Error>()
1681        .is_some_and(|err| err.kind() == io::ErrorKind::NotFound)
1682}