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, paths::PathStyle, 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_file = worktree.update(cx, |worktree, cx| worktree.load_file(path.as_ref(), cx));
621 cx.spawn(async move |this, cx| {
622 let path = path.clone();
623 let single_file_path = cx.update(|cx| {
624 if worktree.read(cx).is_single_file() {
625 Some(worktree.read(cx).abs_path())
626 } else {
627 None
628 }
629 })?;
630 let path_string = single_file_path
631 .as_ref()
632 .map(|path| path.to_string_lossy())
633 .unwrap_or_else(|| path.display(PathStyle::local()));
634 let buffer = match load_file
635 .await
636 .with_context(|| format!("Opening path \"{path_string}\""))
637 {
638 Ok(loaded) => {
639 let reservation = cx.reserve_entity::<Buffer>()?;
640 let buffer_id = BufferId::from(reservation.entity_id().as_non_zero_u64());
641 let text_buffer = cx
642 .background_spawn(async move {
643 text::Buffer::new(ReplicaId::LOCAL, buffer_id, loaded.text)
644 })
645 .await;
646 cx.insert_entity(reservation, |_| {
647 Buffer::build(text_buffer, Some(loaded.file), Capability::ReadWrite)
648 })?
649 }
650 Err(error) if is_not_found_error(&error) => cx.new(|cx| {
651 let buffer_id = BufferId::from(cx.entity_id().as_non_zero_u64());
652 let text_buffer = text::Buffer::new(ReplicaId::LOCAL, buffer_id, "");
653 Buffer::build(
654 text_buffer,
655 Some(Arc::new(File {
656 worktree,
657 path,
658 disk_state: DiskState::New,
659 entry_id: None,
660 is_local: true,
661 is_private: false,
662 })),
663 Capability::ReadWrite,
664 )
665 })?,
666 Err(e) => return Err(e),
667 };
668 this.update(cx, |this, cx| {
669 this.add_buffer(buffer.clone(), cx)?;
670 let buffer_id = buffer.read(cx).remote_id();
671 if let Some(file) = File::from_dyn(buffer.read(cx).file()) {
672 this.path_to_buffer_id.insert(
673 ProjectPath {
674 worktree_id: file.worktree_id(cx),
675 path: file.path.clone(),
676 },
677 buffer_id,
678 );
679 let this = this.as_local_mut().unwrap();
680 if let Some(entry_id) = file.entry_id {
681 this.local_buffer_ids_by_entry_id
682 .insert(entry_id, buffer_id);
683 }
684 }
685
686 anyhow::Ok(())
687 })??;
688
689 Ok(buffer)
690 })
691 }
692
693 fn create_buffer(
694 &self,
695 project_searchable: bool,
696 cx: &mut Context<BufferStore>,
697 ) -> Task<Result<Entity<Buffer>>> {
698 cx.spawn(async move |buffer_store, cx| {
699 let buffer =
700 cx.new(|cx| Buffer::local("", cx).with_language(language::PLAIN_TEXT.clone(), cx))?;
701 buffer_store.update(cx, |buffer_store, cx| {
702 buffer_store.add_buffer(buffer.clone(), cx).log_err();
703 if !project_searchable {
704 buffer_store
705 .non_searchable_buffers
706 .insert(buffer.read(cx).remote_id());
707 }
708 })?;
709 Ok(buffer)
710 })
711 }
712
713 fn reload_buffers(
714 &self,
715 buffers: HashSet<Entity<Buffer>>,
716 push_to_history: bool,
717 cx: &mut Context<BufferStore>,
718 ) -> Task<Result<ProjectTransaction>> {
719 cx.spawn(async move |_, cx| {
720 let mut project_transaction = ProjectTransaction::default();
721 for buffer in buffers {
722 let transaction = buffer.update(cx, |buffer, cx| buffer.reload(cx))?.await?;
723 buffer.update(cx, |buffer, cx| {
724 if let Some(transaction) = transaction {
725 if !push_to_history {
726 buffer.forget_transaction(transaction.id);
727 }
728 project_transaction.0.insert(cx.entity(), transaction);
729 }
730 })?;
731 }
732
733 Ok(project_transaction)
734 })
735 }
736}
737
738impl BufferStore {
739 pub fn init(client: &AnyProtoClient) {
740 client.add_entity_message_handler(Self::handle_buffer_reloaded);
741 client.add_entity_message_handler(Self::handle_buffer_saved);
742 client.add_entity_message_handler(Self::handle_update_buffer_file);
743 client.add_entity_request_handler(Self::handle_save_buffer);
744 client.add_entity_request_handler(Self::handle_reload_buffers);
745 }
746
747 /// Creates a buffer store, optionally retaining its buffers.
748 pub fn local(worktree_store: Entity<WorktreeStore>, cx: &mut Context<Self>) -> Self {
749 Self {
750 state: BufferStoreState::Local(LocalBufferStore {
751 local_buffer_ids_by_entry_id: Default::default(),
752 worktree_store: worktree_store.clone(),
753 _subscription: cx.subscribe(&worktree_store, |this, _, event, cx| {
754 if let WorktreeStoreEvent::WorktreeAdded(worktree) = event {
755 let this = this.as_local_mut().unwrap();
756 this.subscribe_to_worktree(worktree, cx);
757 }
758 }),
759 }),
760 downstream_client: None,
761 opened_buffers: Default::default(),
762 path_to_buffer_id: Default::default(),
763 shared_buffers: Default::default(),
764 loading_buffers: Default::default(),
765 non_searchable_buffers: Default::default(),
766 worktree_store,
767 }
768 }
769
770 pub fn remote(
771 worktree_store: Entity<WorktreeStore>,
772 upstream_client: AnyProtoClient,
773 remote_id: u64,
774 _cx: &mut Context<Self>,
775 ) -> Self {
776 Self {
777 state: BufferStoreState::Remote(RemoteBufferStore {
778 shared_with_me: Default::default(),
779 loading_remote_buffers_by_id: Default::default(),
780 remote_buffer_listeners: Default::default(),
781 project_id: remote_id,
782 upstream_client,
783 worktree_store: worktree_store.clone(),
784 }),
785 downstream_client: None,
786 opened_buffers: Default::default(),
787 path_to_buffer_id: Default::default(),
788 loading_buffers: Default::default(),
789 shared_buffers: Default::default(),
790 non_searchable_buffers: Default::default(),
791 worktree_store,
792 }
793 }
794
795 fn as_local_mut(&mut self) -> Option<&mut LocalBufferStore> {
796 match &mut self.state {
797 BufferStoreState::Local(state) => Some(state),
798 _ => None,
799 }
800 }
801
802 fn as_remote_mut(&mut self) -> Option<&mut RemoteBufferStore> {
803 match &mut self.state {
804 BufferStoreState::Remote(state) => Some(state),
805 _ => None,
806 }
807 }
808
809 fn as_remote(&self) -> Option<&RemoteBufferStore> {
810 match &self.state {
811 BufferStoreState::Remote(state) => Some(state),
812 _ => None,
813 }
814 }
815
816 pub fn open_buffer(
817 &mut self,
818 project_path: ProjectPath,
819 cx: &mut Context<Self>,
820 ) -> Task<Result<Entity<Buffer>>> {
821 if let Some(buffer) = self.get_by_path(&project_path) {
822 cx.emit(BufferStoreEvent::BufferOpened {
823 buffer: buffer.clone(),
824 project_path,
825 });
826
827 return Task::ready(Ok(buffer));
828 }
829
830 let task = match self.loading_buffers.entry(project_path.clone()) {
831 hash_map::Entry::Occupied(e) => e.get().clone(),
832 hash_map::Entry::Vacant(entry) => {
833 let path = project_path.path.clone();
834 let Some(worktree) = self
835 .worktree_store
836 .read(cx)
837 .worktree_for_id(project_path.worktree_id, cx)
838 else {
839 return Task::ready(Err(anyhow!("no such worktree")));
840 };
841 let load_buffer = match &self.state {
842 BufferStoreState::Local(this) => this.open_buffer(path, worktree, cx),
843 BufferStoreState::Remote(this) => this.open_buffer(path, worktree, cx),
844 };
845
846 entry
847 .insert(
848 // todo(lw): hot foreground spawn
849 cx.spawn(async move |this, cx| {
850 let load_result = load_buffer.await;
851 this.update(cx, |this, cx| {
852 // Record the fact that the buffer is no longer loading.
853 this.loading_buffers.remove(&project_path);
854
855 let buffer = load_result.map_err(Arc::new)?;
856 cx.emit(BufferStoreEvent::BufferOpened {
857 buffer: buffer.clone(),
858 project_path,
859 });
860
861 Ok(buffer)
862 })?
863 })
864 .shared(),
865 )
866 .clone()
867 }
868 };
869
870 cx.background_spawn(async move {
871 task.await.map_err(|e| {
872 if e.error_code() != ErrorCode::Internal {
873 anyhow!(e.error_code())
874 } else {
875 anyhow!("{e}")
876 }
877 })
878 })
879 }
880
881 pub fn create_buffer(
882 &mut self,
883 project_searchable: bool,
884 cx: &mut Context<Self>,
885 ) -> Task<Result<Entity<Buffer>>> {
886 match &self.state {
887 BufferStoreState::Local(this) => this.create_buffer(project_searchable, cx),
888 BufferStoreState::Remote(this) => this.create_buffer(project_searchable, cx),
889 }
890 }
891
892 pub fn save_buffer(
893 &mut self,
894 buffer: Entity<Buffer>,
895 cx: &mut Context<Self>,
896 ) -> Task<Result<()>> {
897 match &mut self.state {
898 BufferStoreState::Local(this) => this.save_buffer(buffer, cx),
899 BufferStoreState::Remote(this) => this.save_remote_buffer(buffer, None, cx),
900 }
901 }
902
903 pub fn save_buffer_as(
904 &mut self,
905 buffer: Entity<Buffer>,
906 path: ProjectPath,
907 cx: &mut Context<Self>,
908 ) -> Task<Result<()>> {
909 let old_file = buffer.read(cx).file().cloned();
910 let task = match &self.state {
911 BufferStoreState::Local(this) => this.save_buffer_as(buffer.clone(), path, cx),
912 BufferStoreState::Remote(this) => {
913 this.save_remote_buffer(buffer.clone(), Some(path.to_proto()), cx)
914 }
915 };
916 cx.spawn(async move |this, cx| {
917 task.await?;
918 this.update(cx, |this, cx| {
919 old_file.clone().and_then(|file| {
920 this.path_to_buffer_id.remove(&ProjectPath {
921 worktree_id: file.worktree_id(cx),
922 path: file.path().clone(),
923 })
924 });
925
926 cx.emit(BufferStoreEvent::BufferChangedFilePath { buffer, old_file });
927 })
928 })
929 }
930
931 fn add_buffer(&mut self, buffer_entity: Entity<Buffer>, cx: &mut Context<Self>) -> Result<()> {
932 let buffer = buffer_entity.read(cx);
933 let remote_id = buffer.remote_id();
934 let path = File::from_dyn(buffer.file()).map(|file| ProjectPath {
935 path: file.path.clone(),
936 worktree_id: file.worktree_id(cx),
937 });
938 let is_remote = buffer.replica_id().is_remote();
939 let open_buffer = OpenBuffer::Complete {
940 buffer: buffer_entity.downgrade(),
941 };
942
943 let handle = cx.entity().downgrade();
944 buffer_entity.update(cx, move |_, cx| {
945 cx.on_release(move |buffer, cx| {
946 handle
947 .update(cx, |_, cx| {
948 cx.emit(BufferStoreEvent::BufferDropped(buffer.remote_id()))
949 })
950 .ok();
951 })
952 .detach()
953 });
954 let _expect_path_to_exist;
955 match self.opened_buffers.entry(remote_id) {
956 hash_map::Entry::Vacant(entry) => {
957 entry.insert(open_buffer);
958 _expect_path_to_exist = false;
959 }
960 hash_map::Entry::Occupied(mut entry) => {
961 if let OpenBuffer::Operations(operations) = entry.get_mut() {
962 buffer_entity.update(cx, |b, cx| b.apply_ops(operations.drain(..), cx));
963 } else if entry.get().upgrade().is_some() {
964 if is_remote {
965 return Ok(());
966 } else {
967 debug_panic!("buffer {remote_id} was already registered");
968 anyhow::bail!("buffer {remote_id} was already registered");
969 }
970 }
971 entry.insert(open_buffer);
972 _expect_path_to_exist = true;
973 }
974 }
975
976 if let Some(path) = path {
977 self.path_to_buffer_id.insert(path, remote_id);
978 }
979
980 cx.subscribe(&buffer_entity, Self::on_buffer_event).detach();
981 cx.emit(BufferStoreEvent::BufferAdded(buffer_entity));
982 Ok(())
983 }
984
985 pub fn buffers(&self) -> impl '_ + Iterator<Item = Entity<Buffer>> {
986 self.opened_buffers
987 .values()
988 .filter_map(|buffer| buffer.upgrade())
989 }
990
991 pub(crate) fn is_searchable(&self, id: &BufferId) -> bool {
992 !self.non_searchable_buffers.contains(&id)
993 }
994
995 pub fn loading_buffers(
996 &self,
997 ) -> impl Iterator<Item = (&ProjectPath, impl Future<Output = Result<Entity<Buffer>>>)> {
998 self.loading_buffers.iter().map(|(path, task)| {
999 let task = task.clone();
1000 (path, async move {
1001 task.await.map_err(|e| {
1002 if e.error_code() != ErrorCode::Internal {
1003 anyhow!(e.error_code())
1004 } else {
1005 anyhow!("{e}")
1006 }
1007 })
1008 })
1009 })
1010 }
1011
1012 pub fn buffer_id_for_project_path(&self, project_path: &ProjectPath) -> Option<&BufferId> {
1013 self.path_to_buffer_id.get(project_path)
1014 }
1015
1016 pub fn get_by_path(&self, path: &ProjectPath) -> Option<Entity<Buffer>> {
1017 self.path_to_buffer_id
1018 .get(path)
1019 .and_then(|buffer_id| self.get(*buffer_id))
1020 }
1021
1022 pub fn get(&self, buffer_id: BufferId) -> Option<Entity<Buffer>> {
1023 self.opened_buffers.get(&buffer_id)?.upgrade()
1024 }
1025
1026 pub fn get_existing(&self, buffer_id: BufferId) -> Result<Entity<Buffer>> {
1027 self.get(buffer_id)
1028 .with_context(|| format!("unknown buffer id {buffer_id}"))
1029 }
1030
1031 pub fn get_possibly_incomplete(&self, buffer_id: BufferId) -> Option<Entity<Buffer>> {
1032 self.get(buffer_id).or_else(|| {
1033 self.as_remote()
1034 .and_then(|remote| remote.loading_remote_buffers_by_id.get(&buffer_id).cloned())
1035 })
1036 }
1037
1038 pub fn buffer_version_info(&self, cx: &App) -> (Vec<proto::BufferVersion>, Vec<BufferId>) {
1039 let buffers = self
1040 .buffers()
1041 .map(|buffer| {
1042 let buffer = buffer.read(cx);
1043 proto::BufferVersion {
1044 id: buffer.remote_id().into(),
1045 version: language::proto::serialize_version(&buffer.version),
1046 }
1047 })
1048 .collect();
1049 let incomplete_buffer_ids = self
1050 .as_remote()
1051 .map(|remote| remote.incomplete_buffer_ids())
1052 .unwrap_or_default();
1053 (buffers, incomplete_buffer_ids)
1054 }
1055
1056 pub fn disconnected_from_host(&mut self, cx: &mut App) {
1057 for open_buffer in self.opened_buffers.values_mut() {
1058 if let Some(buffer) = open_buffer.upgrade() {
1059 buffer.update(cx, |buffer, _| buffer.give_up_waiting());
1060 }
1061 }
1062
1063 for buffer in self.buffers() {
1064 buffer.update(cx, |buffer, cx| {
1065 buffer.set_capability(Capability::ReadOnly, cx)
1066 });
1067 }
1068
1069 if let Some(remote) = self.as_remote_mut() {
1070 // Wake up all futures currently waiting on a buffer to get opened,
1071 // to give them a chance to fail now that we've disconnected.
1072 remote.remote_buffer_listeners.clear()
1073 }
1074 }
1075
1076 pub fn shared(&mut self, remote_id: u64, downstream_client: AnyProtoClient, _cx: &mut App) {
1077 self.downstream_client = Some((downstream_client, remote_id));
1078 }
1079
1080 pub fn unshared(&mut self, _cx: &mut Context<Self>) {
1081 self.downstream_client.take();
1082 self.forget_shared_buffers();
1083 }
1084
1085 pub fn discard_incomplete(&mut self) {
1086 self.opened_buffers
1087 .retain(|_, buffer| !matches!(buffer, OpenBuffer::Operations(_)));
1088 }
1089
1090 fn buffer_changed_file(&mut self, buffer: Entity<Buffer>, cx: &mut App) -> Option<()> {
1091 let file = File::from_dyn(buffer.read(cx).file())?;
1092
1093 let remote_id = buffer.read(cx).remote_id();
1094 if let Some(entry_id) = file.entry_id {
1095 if let Some(local) = self.as_local_mut() {
1096 match local.local_buffer_ids_by_entry_id.get(&entry_id) {
1097 Some(_) => {
1098 return None;
1099 }
1100 None => {
1101 local
1102 .local_buffer_ids_by_entry_id
1103 .insert(entry_id, remote_id);
1104 }
1105 }
1106 }
1107 self.path_to_buffer_id.insert(
1108 ProjectPath {
1109 worktree_id: file.worktree_id(cx),
1110 path: file.path.clone(),
1111 },
1112 remote_id,
1113 );
1114 };
1115
1116 Some(())
1117 }
1118
1119 fn on_buffer_event(
1120 &mut self,
1121 buffer: Entity<Buffer>,
1122 event: &BufferEvent,
1123 cx: &mut Context<Self>,
1124 ) {
1125 match event {
1126 BufferEvent::FileHandleChanged => {
1127 self.buffer_changed_file(buffer, cx);
1128 }
1129 BufferEvent::Reloaded => {
1130 let Some((downstream_client, project_id)) = self.downstream_client.as_ref() else {
1131 return;
1132 };
1133 let buffer = buffer.read(cx);
1134 downstream_client
1135 .send(proto::BufferReloaded {
1136 project_id: *project_id,
1137 buffer_id: buffer.remote_id().to_proto(),
1138 version: serialize_version(&buffer.version()),
1139 mtime: buffer.saved_mtime().map(|t| t.into()),
1140 line_ending: serialize_line_ending(buffer.line_ending()) as i32,
1141 })
1142 .log_err();
1143 }
1144 BufferEvent::LanguageChanged(_) => {}
1145 _ => {}
1146 }
1147 }
1148
1149 pub async fn handle_update_buffer(
1150 this: Entity<Self>,
1151 envelope: TypedEnvelope<proto::UpdateBuffer>,
1152 mut cx: AsyncApp,
1153 ) -> Result<proto::Ack> {
1154 let payload = envelope.payload;
1155 let buffer_id = BufferId::new(payload.buffer_id)?;
1156 let ops = payload
1157 .operations
1158 .into_iter()
1159 .map(language::proto::deserialize_operation)
1160 .collect::<Result<Vec<_>, _>>()?;
1161 this.update(&mut cx, |this, cx| {
1162 match this.opened_buffers.entry(buffer_id) {
1163 hash_map::Entry::Occupied(mut e) => match e.get_mut() {
1164 OpenBuffer::Operations(operations) => operations.extend_from_slice(&ops),
1165 OpenBuffer::Complete { buffer, .. } => {
1166 if let Some(buffer) = buffer.upgrade() {
1167 buffer.update(cx, |buffer, cx| buffer.apply_ops(ops, cx));
1168 }
1169 }
1170 },
1171 hash_map::Entry::Vacant(e) => {
1172 e.insert(OpenBuffer::Operations(ops));
1173 }
1174 }
1175 Ok(proto::Ack {})
1176 })?
1177 }
1178
1179 pub fn register_shared_lsp_handle(
1180 &mut self,
1181 peer_id: proto::PeerId,
1182 buffer_id: BufferId,
1183 handle: OpenLspBufferHandle,
1184 ) {
1185 if let Some(shared_buffers) = self.shared_buffers.get_mut(&peer_id)
1186 && let Some(buffer) = shared_buffers.get_mut(&buffer_id)
1187 {
1188 buffer.lsp_handle = Some(handle);
1189 return;
1190 }
1191 debug_panic!("tried to register shared lsp handle, but buffer was not shared")
1192 }
1193
1194 pub fn handle_synchronize_buffers(
1195 &mut self,
1196 envelope: TypedEnvelope<proto::SynchronizeBuffers>,
1197 cx: &mut Context<Self>,
1198 client: Arc<Client>,
1199 ) -> Result<proto::SynchronizeBuffersResponse> {
1200 let project_id = envelope.payload.project_id;
1201 let mut response = proto::SynchronizeBuffersResponse {
1202 buffers: Default::default(),
1203 };
1204 let Some(guest_id) = envelope.original_sender_id else {
1205 anyhow::bail!("missing original_sender_id on SynchronizeBuffers request");
1206 };
1207
1208 self.shared_buffers.entry(guest_id).or_default().clear();
1209 for buffer in envelope.payload.buffers {
1210 let buffer_id = BufferId::new(buffer.id)?;
1211 let remote_version = language::proto::deserialize_version(&buffer.version);
1212 if let Some(buffer) = self.get(buffer_id) {
1213 self.shared_buffers
1214 .entry(guest_id)
1215 .or_default()
1216 .entry(buffer_id)
1217 .or_insert_with(|| SharedBuffer {
1218 buffer: buffer.clone(),
1219 lsp_handle: None,
1220 });
1221
1222 let buffer = buffer.read(cx);
1223 response.buffers.push(proto::BufferVersion {
1224 id: buffer_id.into(),
1225 version: language::proto::serialize_version(&buffer.version),
1226 });
1227
1228 let operations = buffer.serialize_ops(Some(remote_version), cx);
1229 let client = client.clone();
1230 if let Some(file) = buffer.file() {
1231 client
1232 .send(proto::UpdateBufferFile {
1233 project_id,
1234 buffer_id: buffer_id.into(),
1235 file: Some(file.to_proto(cx)),
1236 })
1237 .log_err();
1238 }
1239
1240 // TODO(max): do something
1241 // client
1242 // .send(proto::UpdateStagedText {
1243 // project_id,
1244 // buffer_id: buffer_id.into(),
1245 // diff_base: buffer.diff_base().map(ToString::to_string),
1246 // })
1247 // .log_err();
1248
1249 client
1250 .send(proto::BufferReloaded {
1251 project_id,
1252 buffer_id: buffer_id.into(),
1253 version: language::proto::serialize_version(buffer.saved_version()),
1254 mtime: buffer.saved_mtime().map(|time| time.into()),
1255 line_ending: language::proto::serialize_line_ending(buffer.line_ending())
1256 as i32,
1257 })
1258 .log_err();
1259
1260 cx.background_spawn(
1261 async move {
1262 let operations = operations.await;
1263 for chunk in split_operations(operations) {
1264 client
1265 .request(proto::UpdateBuffer {
1266 project_id,
1267 buffer_id: buffer_id.into(),
1268 operations: chunk,
1269 })
1270 .await?;
1271 }
1272 anyhow::Ok(())
1273 }
1274 .log_err(),
1275 )
1276 .detach();
1277 }
1278 }
1279 Ok(response)
1280 }
1281
1282 pub fn handle_create_buffer_for_peer(
1283 &mut self,
1284 envelope: TypedEnvelope<proto::CreateBufferForPeer>,
1285 replica_id: ReplicaId,
1286 capability: Capability,
1287 cx: &mut Context<Self>,
1288 ) -> Result<()> {
1289 let remote = self
1290 .as_remote_mut()
1291 .context("buffer store is not a remote")?;
1292
1293 if let Some(buffer) =
1294 remote.handle_create_buffer_for_peer(envelope, replica_id, capability, cx)?
1295 {
1296 self.add_buffer(buffer, cx)?;
1297 }
1298
1299 Ok(())
1300 }
1301
1302 pub async fn handle_update_buffer_file(
1303 this: Entity<Self>,
1304 envelope: TypedEnvelope<proto::UpdateBufferFile>,
1305 mut cx: AsyncApp,
1306 ) -> Result<()> {
1307 let buffer_id = envelope.payload.buffer_id;
1308 let buffer_id = BufferId::new(buffer_id)?;
1309
1310 this.update(&mut cx, |this, cx| {
1311 let payload = envelope.payload.clone();
1312 if let Some(buffer) = this.get_possibly_incomplete(buffer_id) {
1313 let file = payload.file.context("invalid file")?;
1314 let worktree = this
1315 .worktree_store
1316 .read(cx)
1317 .worktree_for_id(WorktreeId::from_proto(file.worktree_id), cx)
1318 .context("no such worktree")?;
1319 let file = File::from_proto(file, worktree, cx)?;
1320 let old_file = buffer.update(cx, |buffer, cx| {
1321 let old_file = buffer.file().cloned();
1322 let new_path = file.path.clone();
1323
1324 buffer.file_updated(Arc::new(file), cx);
1325 if old_file.as_ref().is_none_or(|old| *old.path() != new_path) {
1326 Some(old_file)
1327 } else {
1328 None
1329 }
1330 });
1331 if let Some(old_file) = old_file {
1332 cx.emit(BufferStoreEvent::BufferChangedFilePath { buffer, old_file });
1333 }
1334 }
1335 if let Some((downstream_client, project_id)) = this.downstream_client.as_ref() {
1336 downstream_client
1337 .send(proto::UpdateBufferFile {
1338 project_id: *project_id,
1339 buffer_id: buffer_id.into(),
1340 file: envelope.payload.file,
1341 })
1342 .log_err();
1343 }
1344 Ok(())
1345 })?
1346 }
1347
1348 pub async fn handle_save_buffer(
1349 this: Entity<Self>,
1350 envelope: TypedEnvelope<proto::SaveBuffer>,
1351 mut cx: AsyncApp,
1352 ) -> Result<proto::BufferSaved> {
1353 let buffer_id = BufferId::new(envelope.payload.buffer_id)?;
1354 let (buffer, project_id) = this.read_with(&cx, |this, _| {
1355 anyhow::Ok((
1356 this.get_existing(buffer_id)?,
1357 this.downstream_client
1358 .as_ref()
1359 .map(|(_, project_id)| *project_id)
1360 .context("project is not shared")?,
1361 ))
1362 })??;
1363 buffer
1364 .update(&mut cx, |buffer, _| {
1365 buffer.wait_for_version(deserialize_version(&envelope.payload.version))
1366 })?
1367 .await?;
1368 let buffer_id = buffer.read_with(&cx, |buffer, _| buffer.remote_id())?;
1369
1370 if let Some(new_path) = envelope.payload.new_path
1371 && let Some(new_path) = ProjectPath::from_proto(new_path)
1372 {
1373 this.update(&mut cx, |this, cx| {
1374 this.save_buffer_as(buffer.clone(), new_path, cx)
1375 })?
1376 .await?;
1377 } else {
1378 this.update(&mut cx, |this, cx| this.save_buffer(buffer.clone(), cx))?
1379 .await?;
1380 }
1381
1382 buffer.read_with(&cx, |buffer, _| proto::BufferSaved {
1383 project_id,
1384 buffer_id: buffer_id.into(),
1385 version: serialize_version(buffer.saved_version()),
1386 mtime: buffer.saved_mtime().map(|time| time.into()),
1387 })
1388 }
1389
1390 pub async fn handle_close_buffer(
1391 this: Entity<Self>,
1392 envelope: TypedEnvelope<proto::CloseBuffer>,
1393 mut cx: AsyncApp,
1394 ) -> Result<()> {
1395 let peer_id = envelope.sender_id;
1396 let buffer_id = BufferId::new(envelope.payload.buffer_id)?;
1397 this.update(&mut cx, |this, cx| {
1398 if let Some(shared) = this.shared_buffers.get_mut(&peer_id)
1399 && shared.remove(&buffer_id).is_some()
1400 {
1401 cx.emit(BufferStoreEvent::SharedBufferClosed(peer_id, buffer_id));
1402 if shared.is_empty() {
1403 this.shared_buffers.remove(&peer_id);
1404 }
1405 return;
1406 }
1407 debug_panic!(
1408 "peer_id {} closed buffer_id {} which was either not open or already closed",
1409 peer_id,
1410 buffer_id
1411 )
1412 })
1413 }
1414
1415 pub async fn handle_buffer_saved(
1416 this: Entity<Self>,
1417 envelope: TypedEnvelope<proto::BufferSaved>,
1418 mut cx: AsyncApp,
1419 ) -> Result<()> {
1420 let buffer_id = BufferId::new(envelope.payload.buffer_id)?;
1421 let version = deserialize_version(&envelope.payload.version);
1422 let mtime = envelope.payload.mtime.clone().map(|time| time.into());
1423 this.update(&mut cx, move |this, cx| {
1424 if let Some(buffer) = this.get_possibly_incomplete(buffer_id) {
1425 buffer.update(cx, |buffer, cx| {
1426 buffer.did_save(version, mtime, cx);
1427 });
1428 }
1429
1430 if let Some((downstream_client, project_id)) = this.downstream_client.as_ref() {
1431 downstream_client
1432 .send(proto::BufferSaved {
1433 project_id: *project_id,
1434 buffer_id: buffer_id.into(),
1435 mtime: envelope.payload.mtime,
1436 version: envelope.payload.version,
1437 })
1438 .log_err();
1439 }
1440 })
1441 }
1442
1443 pub async fn handle_buffer_reloaded(
1444 this: Entity<Self>,
1445 envelope: TypedEnvelope<proto::BufferReloaded>,
1446 mut cx: AsyncApp,
1447 ) -> Result<()> {
1448 let buffer_id = BufferId::new(envelope.payload.buffer_id)?;
1449 let version = deserialize_version(&envelope.payload.version);
1450 let mtime = envelope.payload.mtime.clone().map(|time| time.into());
1451 let line_ending = deserialize_line_ending(
1452 proto::LineEnding::from_i32(envelope.payload.line_ending)
1453 .context("missing line ending")?,
1454 );
1455 this.update(&mut cx, |this, cx| {
1456 if let Some(buffer) = this.get_possibly_incomplete(buffer_id) {
1457 buffer.update(cx, |buffer, cx| {
1458 buffer.did_reload(version, line_ending, mtime, cx);
1459 });
1460 }
1461
1462 if let Some((downstream_client, project_id)) = this.downstream_client.as_ref() {
1463 downstream_client
1464 .send(proto::BufferReloaded {
1465 project_id: *project_id,
1466 buffer_id: buffer_id.into(),
1467 mtime: envelope.payload.mtime,
1468 version: envelope.payload.version,
1469 line_ending: envelope.payload.line_ending,
1470 })
1471 .log_err();
1472 }
1473 })
1474 }
1475
1476 pub fn reload_buffers(
1477 &self,
1478 buffers: HashSet<Entity<Buffer>>,
1479 push_to_history: bool,
1480 cx: &mut Context<Self>,
1481 ) -> Task<Result<ProjectTransaction>> {
1482 if buffers.is_empty() {
1483 return Task::ready(Ok(ProjectTransaction::default()));
1484 }
1485 match &self.state {
1486 BufferStoreState::Local(this) => this.reload_buffers(buffers, push_to_history, cx),
1487 BufferStoreState::Remote(this) => this.reload_buffers(buffers, push_to_history, cx),
1488 }
1489 }
1490
1491 async fn handle_reload_buffers(
1492 this: Entity<Self>,
1493 envelope: TypedEnvelope<proto::ReloadBuffers>,
1494 mut cx: AsyncApp,
1495 ) -> Result<proto::ReloadBuffersResponse> {
1496 let sender_id = envelope.original_sender_id().unwrap_or_default();
1497 let reload = this.update(&mut cx, |this, cx| {
1498 let mut buffers = HashSet::default();
1499 for buffer_id in &envelope.payload.buffer_ids {
1500 let buffer_id = BufferId::new(*buffer_id)?;
1501 buffers.insert(this.get_existing(buffer_id)?);
1502 }
1503 anyhow::Ok(this.reload_buffers(buffers, false, cx))
1504 })??;
1505
1506 let project_transaction = reload.await?;
1507 let project_transaction = this.update(&mut cx, |this, cx| {
1508 this.serialize_project_transaction_for_peer(project_transaction, sender_id, cx)
1509 })?;
1510 Ok(proto::ReloadBuffersResponse {
1511 transaction: Some(project_transaction),
1512 })
1513 }
1514
1515 pub fn create_buffer_for_peer(
1516 &mut self,
1517 buffer: &Entity<Buffer>,
1518 peer_id: proto::PeerId,
1519 cx: &mut Context<Self>,
1520 ) -> Task<Result<()>> {
1521 let buffer_id = buffer.read(cx).remote_id();
1522 let shared_buffers = self.shared_buffers.entry(peer_id).or_default();
1523 if shared_buffers.contains_key(&buffer_id) {
1524 return Task::ready(Ok(()));
1525 }
1526 shared_buffers.insert(
1527 buffer_id,
1528 SharedBuffer {
1529 buffer: buffer.clone(),
1530 lsp_handle: None,
1531 },
1532 );
1533
1534 let Some((client, project_id)) = self.downstream_client.clone() else {
1535 return Task::ready(Ok(()));
1536 };
1537
1538 cx.spawn(async move |this, cx| {
1539 let Some(buffer) = this.read_with(cx, |this, _| this.get(buffer_id))? else {
1540 return anyhow::Ok(());
1541 };
1542
1543 let operations = buffer.update(cx, |b, cx| b.serialize_ops(None, cx))?;
1544 let operations = operations.await;
1545 let state = buffer.update(cx, |buffer, cx| buffer.to_proto(cx))?;
1546
1547 let initial_state = proto::CreateBufferForPeer {
1548 project_id,
1549 peer_id: Some(peer_id),
1550 variant: Some(proto::create_buffer_for_peer::Variant::State(state)),
1551 };
1552
1553 if client.send(initial_state).log_err().is_some() {
1554 let client = client.clone();
1555 cx.background_spawn(async move {
1556 let mut chunks = split_operations(operations).peekable();
1557 while let Some(chunk) = chunks.next() {
1558 let is_last = chunks.peek().is_none();
1559 client.send(proto::CreateBufferForPeer {
1560 project_id,
1561 peer_id: Some(peer_id),
1562 variant: Some(proto::create_buffer_for_peer::Variant::Chunk(
1563 proto::BufferChunk {
1564 buffer_id: buffer_id.into(),
1565 operations: chunk,
1566 is_last,
1567 },
1568 )),
1569 })?;
1570 }
1571 anyhow::Ok(())
1572 })
1573 .await
1574 .log_err();
1575 }
1576 Ok(())
1577 })
1578 }
1579
1580 pub fn forget_shared_buffers(&mut self) {
1581 self.shared_buffers.clear();
1582 }
1583
1584 pub fn forget_shared_buffers_for(&mut self, peer_id: &proto::PeerId) {
1585 self.shared_buffers.remove(peer_id);
1586 }
1587
1588 pub fn update_peer_id(&mut self, old_peer_id: &proto::PeerId, new_peer_id: proto::PeerId) {
1589 if let Some(buffers) = self.shared_buffers.remove(old_peer_id) {
1590 self.shared_buffers.insert(new_peer_id, buffers);
1591 }
1592 }
1593
1594 pub fn has_shared_buffers(&self) -> bool {
1595 !self.shared_buffers.is_empty()
1596 }
1597
1598 pub fn create_local_buffer(
1599 &mut self,
1600 text: &str,
1601 language: Option<Arc<Language>>,
1602 project_searchable: bool,
1603 cx: &mut Context<Self>,
1604 ) -> Entity<Buffer> {
1605 let buffer = cx.new(|cx| {
1606 Buffer::local(text, cx)
1607 .with_language(language.unwrap_or_else(|| language::PLAIN_TEXT.clone()), cx)
1608 });
1609
1610 self.add_buffer(buffer.clone(), cx).log_err();
1611 let buffer_id = buffer.read(cx).remote_id();
1612 if !project_searchable {
1613 self.non_searchable_buffers.insert(buffer_id);
1614 }
1615
1616 if let Some(file) = File::from_dyn(buffer.read(cx).file()) {
1617 self.path_to_buffer_id.insert(
1618 ProjectPath {
1619 worktree_id: file.worktree_id(cx),
1620 path: file.path.clone(),
1621 },
1622 buffer_id,
1623 );
1624 let this = self
1625 .as_local_mut()
1626 .expect("local-only method called in a non-local context");
1627 if let Some(entry_id) = file.entry_id {
1628 this.local_buffer_ids_by_entry_id
1629 .insert(entry_id, buffer_id);
1630 }
1631 }
1632 buffer
1633 }
1634
1635 pub fn deserialize_project_transaction(
1636 &mut self,
1637 message: proto::ProjectTransaction,
1638 push_to_history: bool,
1639 cx: &mut Context<Self>,
1640 ) -> Task<Result<ProjectTransaction>> {
1641 if let Some(this) = self.as_remote_mut() {
1642 this.deserialize_project_transaction(message, push_to_history, cx)
1643 } else {
1644 debug_panic!("not a remote buffer store");
1645 Task::ready(Err(anyhow!("not a remote buffer store")))
1646 }
1647 }
1648
1649 pub fn wait_for_remote_buffer(
1650 &mut self,
1651 id: BufferId,
1652 cx: &mut Context<BufferStore>,
1653 ) -> Task<Result<Entity<Buffer>>> {
1654 if let Some(this) = self.as_remote_mut() {
1655 this.wait_for_remote_buffer(id, cx)
1656 } else {
1657 debug_panic!("not a remote buffer store");
1658 Task::ready(Err(anyhow!("not a remote buffer store")))
1659 }
1660 }
1661
1662 pub fn serialize_project_transaction_for_peer(
1663 &mut self,
1664 project_transaction: ProjectTransaction,
1665 peer_id: proto::PeerId,
1666 cx: &mut Context<Self>,
1667 ) -> proto::ProjectTransaction {
1668 let mut serialized_transaction = proto::ProjectTransaction {
1669 buffer_ids: Default::default(),
1670 transactions: Default::default(),
1671 };
1672 for (buffer, transaction) in project_transaction.0 {
1673 self.create_buffer_for_peer(&buffer, peer_id, cx)
1674 .detach_and_log_err(cx);
1675 serialized_transaction
1676 .buffer_ids
1677 .push(buffer.read(cx).remote_id().into());
1678 serialized_transaction
1679 .transactions
1680 .push(language::proto::serialize_transaction(&transaction));
1681 }
1682 serialized_transaction
1683 }
1684}
1685
1686impl OpenBuffer {
1687 fn upgrade(&self) -> Option<Entity<Buffer>> {
1688 match self {
1689 OpenBuffer::Complete { buffer, .. } => buffer.upgrade(),
1690 OpenBuffer::Operations(_) => None,
1691 }
1692 }
1693}
1694
1695fn is_not_found_error(error: &anyhow::Error) -> bool {
1696 error
1697 .root_cause()
1698 .downcast_ref::<io::Error>()
1699 .is_some_and(|err| err.kind() == io::ErrorKind::NotFound)
1700}