1mod ignore;
2mod lsp_command;
3pub mod search;
4pub mod worktree;
5
6#[cfg(test)]
7mod project_tests;
8
9use anyhow::{anyhow, Context, Result};
10use client::{proto, Client, PeerId, TypedEnvelope, UserStore};
11use clock::ReplicaId;
12use collections::{hash_map, BTreeMap, HashMap, HashSet};
13use futures::{future::Shared, AsyncWriteExt, Future, FutureExt, StreamExt, TryFutureExt};
14
15use gpui::{
16 AnyModelHandle, AppContext, AsyncAppContext, Entity, ModelContext, ModelHandle,
17 MutableAppContext, Task, UpgradeModelHandle, WeakModelHandle,
18};
19use language::{
20 point_to_lsp,
21 proto::{
22 deserialize_anchor, deserialize_line_ending, deserialize_version, serialize_anchor,
23 serialize_version,
24 },
25 range_from_lsp, range_to_lsp, Anchor, Bias, Buffer, CachedLspAdapter, CharKind, CodeAction,
26 CodeLabel, Completion, Diagnostic, DiagnosticEntry, DiagnosticSet, Event as BufferEvent,
27 File as _, Language, LanguageRegistry, LanguageServerName, LocalFile, OffsetRangeExt,
28 Operation, Patch, PointUtf16, TextBufferSnapshot, ToOffset, ToPointUtf16, Transaction,
29};
30use lsp::{
31 DiagnosticSeverity, DiagnosticTag, DocumentHighlightKind, LanguageServer, LanguageString,
32 MarkedString,
33};
34use lsp_command::*;
35use parking_lot::Mutex;
36use postage::watch;
37use rand::prelude::*;
38use search::SearchQuery;
39use serde::Serialize;
40use settings::{FormatOnSave, Formatter, Settings};
41use sha2::{Digest, Sha256};
42use similar::{ChangeTag, TextDiff};
43use std::{
44 cell::RefCell,
45 cmp::{self, Ordering},
46 convert::TryInto,
47 ffi::OsString,
48 hash::Hash,
49 mem,
50 num::NonZeroU32,
51 ops::Range,
52 os::unix::{ffi::OsStrExt, prelude::OsStringExt},
53 path::{Component, Path, PathBuf},
54 rc::Rc,
55 str,
56 sync::{
57 atomic::{AtomicUsize, Ordering::SeqCst},
58 Arc,
59 },
60 time::Instant,
61};
62use thiserror::Error;
63use util::{defer, post_inc, ResultExt, TryFutureExt as _};
64
65pub use db::Db;
66pub use fs::*;
67pub use worktree::*;
68
69pub trait Item: Entity {
70 fn entry_id(&self, cx: &AppContext) -> Option<ProjectEntryId>;
71}
72
73pub struct ProjectStore {
74 projects: Vec<WeakModelHandle<Project>>,
75}
76
77// Language server state is stored across 3 collections:
78// language_servers =>
79// a mapping from unique server id to LanguageServerState which can either be a task for a
80// server in the process of starting, or a running server with adapter and language server arcs
81// language_server_ids => a mapping from worktreeId and server name to the unique server id
82// language_server_statuses => a mapping from unique server id to the current server status
83//
84// Multiple worktrees can map to the same language server for example when you jump to the definition
85// of a file in the standard library. So language_server_ids is used to look up which server is active
86// for a given worktree and language server name
87//
88// When starting a language server, first the id map is checked to make sure a server isn't already available
89// for that worktree. If there is one, it finishes early. Otherwise, a new id is allocated and and
90// the Starting variant of LanguageServerState is stored in the language_servers map.
91pub struct Project {
92 worktrees: Vec<WorktreeHandle>,
93 active_entry: Option<ProjectEntryId>,
94 languages: Arc<LanguageRegistry>,
95 language_servers: HashMap<usize, LanguageServerState>,
96 language_server_ids: HashMap<(WorktreeId, LanguageServerName), usize>,
97 language_server_statuses: BTreeMap<usize, LanguageServerStatus>,
98 language_server_settings: Arc<Mutex<serde_json::Value>>,
99 last_workspace_edits_by_language_server: HashMap<usize, ProjectTransaction>,
100 next_language_server_id: usize,
101 client: Arc<client::Client>,
102 next_entry_id: Arc<AtomicUsize>,
103 next_diagnostic_group_id: usize,
104 user_store: ModelHandle<UserStore>,
105 project_store: ModelHandle<ProjectStore>,
106 fs: Arc<dyn Fs>,
107 client_state: Option<ProjectClientState>,
108 collaborators: HashMap<PeerId, Collaborator>,
109 client_subscriptions: Vec<client::Subscription>,
110 _subscriptions: Vec<gpui::Subscription>,
111 opened_buffer: (watch::Sender<()>, watch::Receiver<()>),
112 shared_buffers: HashMap<PeerId, HashSet<u64>>,
113 #[allow(clippy::type_complexity)]
114 loading_buffers: HashMap<
115 ProjectPath,
116 postage::watch::Receiver<Option<Result<ModelHandle<Buffer>, Arc<anyhow::Error>>>>,
117 >,
118 #[allow(clippy::type_complexity)]
119 loading_local_worktrees:
120 HashMap<Arc<Path>, Shared<Task<Result<ModelHandle<Worktree>, Arc<anyhow::Error>>>>>,
121 opened_buffers: HashMap<u64, OpenBuffer>,
122 incomplete_buffers: HashMap<u64, ModelHandle<Buffer>>,
123 buffer_snapshots: HashMap<u64, Vec<(i32, TextBufferSnapshot)>>,
124 buffers_being_formatted: HashSet<usize>,
125 nonce: u128,
126 _maintain_buffer_languages: Task<()>,
127}
128
129#[derive(Error, Debug)]
130pub enum JoinProjectError {
131 #[error("host declined join request")]
132 HostDeclined,
133 #[error("host closed the project")]
134 HostClosedProject,
135 #[error("host went offline")]
136 HostWentOffline,
137 #[error("{0}")]
138 Other(#[from] anyhow::Error),
139}
140
141enum OpenBuffer {
142 Strong(ModelHandle<Buffer>),
143 Weak(WeakModelHandle<Buffer>),
144 Operations(Vec<Operation>),
145}
146
147enum WorktreeHandle {
148 Strong(ModelHandle<Worktree>),
149 Weak(WeakModelHandle<Worktree>),
150}
151
152enum ProjectClientState {
153 Local {
154 remote_id: u64,
155 _detect_unshare: Task<Option<()>>,
156 },
157 Remote {
158 sharing_has_stopped: bool,
159 remote_id: u64,
160 replica_id: ReplicaId,
161 _detect_unshare: Task<Option<()>>,
162 },
163}
164
165#[derive(Clone, Debug)]
166pub struct Collaborator {
167 pub peer_id: PeerId,
168 pub replica_id: ReplicaId,
169}
170
171#[derive(Clone, Debug, PartialEq, Eq)]
172pub enum Event {
173 ActiveEntryChanged(Option<ProjectEntryId>),
174 WorktreeAdded,
175 WorktreeRemoved(WorktreeId),
176 DiskBasedDiagnosticsStarted {
177 language_server_id: usize,
178 },
179 DiskBasedDiagnosticsFinished {
180 language_server_id: usize,
181 },
182 DiagnosticsUpdated {
183 path: ProjectPath,
184 language_server_id: usize,
185 },
186 RemoteIdChanged(Option<u64>),
187 DisconnectedFromHost,
188 CollaboratorLeft(PeerId),
189}
190
191pub enum LanguageServerState {
192 Starting(Task<Option<Arc<LanguageServer>>>),
193 Running {
194 language: Arc<Language>,
195 adapter: Arc<CachedLspAdapter>,
196 server: Arc<LanguageServer>,
197 },
198}
199
200#[derive(Serialize)]
201pub struct LanguageServerStatus {
202 pub name: String,
203 pub pending_work: BTreeMap<String, LanguageServerProgress>,
204 pub has_pending_diagnostic_updates: bool,
205 progress_tokens: HashSet<String>,
206}
207
208#[derive(Clone, Debug, Serialize)]
209pub struct LanguageServerProgress {
210 pub message: Option<String>,
211 pub percentage: Option<usize>,
212 #[serde(skip_serializing)]
213 pub last_update_at: Instant,
214}
215
216#[derive(Clone, Debug, Eq, PartialEq, Hash, PartialOrd, Ord)]
217pub struct ProjectPath {
218 pub worktree_id: WorktreeId,
219 pub path: Arc<Path>,
220}
221
222#[derive(Copy, Clone, Debug, Default, PartialEq, Serialize)]
223pub struct DiagnosticSummary {
224 pub language_server_id: usize,
225 pub error_count: usize,
226 pub warning_count: usize,
227}
228
229#[derive(Debug, Clone)]
230pub struct Location {
231 pub buffer: ModelHandle<Buffer>,
232 pub range: Range<language::Anchor>,
233}
234
235#[derive(Debug, Clone)]
236pub struct LocationLink {
237 pub origin: Option<Location>,
238 pub target: Location,
239}
240
241#[derive(Debug)]
242pub struct DocumentHighlight {
243 pub range: Range<language::Anchor>,
244 pub kind: DocumentHighlightKind,
245}
246
247#[derive(Clone, Debug)]
248pub struct Symbol {
249 pub language_server_name: LanguageServerName,
250 pub source_worktree_id: WorktreeId,
251 pub path: ProjectPath,
252 pub label: CodeLabel,
253 pub name: String,
254 pub kind: lsp::SymbolKind,
255 pub range: Range<PointUtf16>,
256 pub signature: [u8; 32],
257}
258
259#[derive(Clone, Debug, PartialEq)]
260pub struct HoverBlock {
261 pub text: String,
262 pub language: Option<String>,
263}
264
265impl HoverBlock {
266 fn try_new(marked_string: MarkedString) -> Option<Self> {
267 let result = match marked_string {
268 MarkedString::LanguageString(LanguageString { language, value }) => HoverBlock {
269 text: value,
270 language: Some(language),
271 },
272 MarkedString::String(text) => HoverBlock {
273 text,
274 language: None,
275 },
276 };
277 if result.text.is_empty() {
278 None
279 } else {
280 Some(result)
281 }
282 }
283}
284
285#[derive(Debug)]
286pub struct Hover {
287 pub contents: Vec<HoverBlock>,
288 pub range: Option<Range<language::Anchor>>,
289}
290
291#[derive(Default)]
292pub struct ProjectTransaction(pub HashMap<ModelHandle<Buffer>, language::Transaction>);
293
294impl DiagnosticSummary {
295 fn new<'a, T: 'a>(
296 language_server_id: usize,
297 diagnostics: impl IntoIterator<Item = &'a DiagnosticEntry<T>>,
298 ) -> Self {
299 let mut this = Self {
300 language_server_id,
301 error_count: 0,
302 warning_count: 0,
303 };
304
305 for entry in diagnostics {
306 if entry.diagnostic.is_primary {
307 match entry.diagnostic.severity {
308 DiagnosticSeverity::ERROR => this.error_count += 1,
309 DiagnosticSeverity::WARNING => this.warning_count += 1,
310 _ => {}
311 }
312 }
313 }
314
315 this
316 }
317
318 pub fn is_empty(&self) -> bool {
319 self.error_count == 0 && self.warning_count == 0
320 }
321
322 pub fn to_proto(&self, path: &Path) -> proto::DiagnosticSummary {
323 proto::DiagnosticSummary {
324 path: path.to_string_lossy().to_string(),
325 language_server_id: self.language_server_id as u64,
326 error_count: self.error_count as u32,
327 warning_count: self.warning_count as u32,
328 }
329 }
330}
331
332#[derive(Clone, Copy, Debug, Default, Hash, PartialEq, Eq, PartialOrd, Ord)]
333pub struct ProjectEntryId(usize);
334
335impl ProjectEntryId {
336 pub const MAX: Self = Self(usize::MAX);
337
338 pub fn new(counter: &AtomicUsize) -> Self {
339 Self(counter.fetch_add(1, SeqCst))
340 }
341
342 pub fn from_proto(id: u64) -> Self {
343 Self(id as usize)
344 }
345
346 pub fn to_proto(&self) -> u64 {
347 self.0 as u64
348 }
349
350 pub fn to_usize(&self) -> usize {
351 self.0
352 }
353}
354
355#[derive(Debug, Clone, Copy, PartialEq, Eq)]
356pub enum FormatTrigger {
357 Save,
358 Manual,
359}
360
361impl FormatTrigger {
362 fn from_proto(value: i32) -> FormatTrigger {
363 match value {
364 0 => FormatTrigger::Save,
365 1 => FormatTrigger::Manual,
366 _ => FormatTrigger::Save,
367 }
368 }
369}
370
371impl Project {
372 pub fn init(client: &Arc<Client>) {
373 client.add_model_message_handler(Self::handle_add_collaborator);
374 client.add_model_message_handler(Self::handle_buffer_reloaded);
375 client.add_model_message_handler(Self::handle_buffer_saved);
376 client.add_model_message_handler(Self::handle_start_language_server);
377 client.add_model_message_handler(Self::handle_update_language_server);
378 client.add_model_message_handler(Self::handle_remove_collaborator);
379 client.add_model_message_handler(Self::handle_update_project);
380 client.add_model_message_handler(Self::handle_unshare_project);
381 client.add_model_message_handler(Self::handle_create_buffer_for_peer);
382 client.add_model_message_handler(Self::handle_update_buffer_file);
383 client.add_model_message_handler(Self::handle_update_buffer);
384 client.add_model_message_handler(Self::handle_update_diagnostic_summary);
385 client.add_model_message_handler(Self::handle_update_worktree);
386 client.add_model_request_handler(Self::handle_create_project_entry);
387 client.add_model_request_handler(Self::handle_rename_project_entry);
388 client.add_model_request_handler(Self::handle_copy_project_entry);
389 client.add_model_request_handler(Self::handle_delete_project_entry);
390 client.add_model_request_handler(Self::handle_apply_additional_edits_for_completion);
391 client.add_model_request_handler(Self::handle_apply_code_action);
392 client.add_model_request_handler(Self::handle_reload_buffers);
393 client.add_model_request_handler(Self::handle_format_buffers);
394 client.add_model_request_handler(Self::handle_get_code_actions);
395 client.add_model_request_handler(Self::handle_get_completions);
396 client.add_model_request_handler(Self::handle_lsp_command::<GetHover>);
397 client.add_model_request_handler(Self::handle_lsp_command::<GetDefinition>);
398 client.add_model_request_handler(Self::handle_lsp_command::<GetTypeDefinition>);
399 client.add_model_request_handler(Self::handle_lsp_command::<GetDocumentHighlights>);
400 client.add_model_request_handler(Self::handle_lsp_command::<GetReferences>);
401 client.add_model_request_handler(Self::handle_lsp_command::<PrepareRename>);
402 client.add_model_request_handler(Self::handle_lsp_command::<PerformRename>);
403 client.add_model_request_handler(Self::handle_search_project);
404 client.add_model_request_handler(Self::handle_get_project_symbols);
405 client.add_model_request_handler(Self::handle_open_buffer_for_symbol);
406 client.add_model_request_handler(Self::handle_open_buffer_by_id);
407 client.add_model_request_handler(Self::handle_open_buffer_by_path);
408 client.add_model_request_handler(Self::handle_save_buffer);
409 client.add_model_message_handler(Self::handle_update_diff_base);
410 }
411
412 pub fn local(
413 client: Arc<Client>,
414 user_store: ModelHandle<UserStore>,
415 project_store: ModelHandle<ProjectStore>,
416 languages: Arc<LanguageRegistry>,
417 fs: Arc<dyn Fs>,
418 cx: &mut MutableAppContext,
419 ) -> ModelHandle<Self> {
420 cx.add_model(|cx: &mut ModelContext<Self>| {
421 let handle = cx.weak_handle();
422 project_store.update(cx, |store, cx| store.add_project(handle, cx));
423
424 Self {
425 worktrees: Default::default(),
426 collaborators: Default::default(),
427 opened_buffers: Default::default(),
428 shared_buffers: Default::default(),
429 incomplete_buffers: Default::default(),
430 loading_buffers: Default::default(),
431 loading_local_worktrees: Default::default(),
432 buffer_snapshots: Default::default(),
433 client_state: None,
434 opened_buffer: watch::channel(),
435 client_subscriptions: Vec::new(),
436 _subscriptions: vec![cx.observe_global::<Settings, _>(Self::on_settings_changed)],
437 _maintain_buffer_languages: Self::maintain_buffer_languages(&languages, cx),
438 active_entry: None,
439 languages,
440 client,
441 user_store,
442 project_store,
443 fs,
444 next_entry_id: Default::default(),
445 next_diagnostic_group_id: Default::default(),
446 language_servers: Default::default(),
447 language_server_ids: Default::default(),
448 language_server_statuses: Default::default(),
449 last_workspace_edits_by_language_server: Default::default(),
450 language_server_settings: Default::default(),
451 buffers_being_formatted: Default::default(),
452 next_language_server_id: 0,
453 nonce: StdRng::from_entropy().gen(),
454 }
455 })
456 }
457
458 pub async fn remote(
459 remote_id: u64,
460 client: Arc<Client>,
461 user_store: ModelHandle<UserStore>,
462 project_store: ModelHandle<ProjectStore>,
463 languages: Arc<LanguageRegistry>,
464 fs: Arc<dyn Fs>,
465 mut cx: AsyncAppContext,
466 ) -> Result<ModelHandle<Self>, JoinProjectError> {
467 client.authenticate_and_connect(true, &cx).await?;
468
469 let response = client
470 .request(proto::JoinProject {
471 project_id: remote_id,
472 })
473 .await?;
474
475 let replica_id = response.replica_id as ReplicaId;
476
477 let mut worktrees = Vec::new();
478 for worktree in response.worktrees {
479 let worktree = cx
480 .update(|cx| Worktree::remote(remote_id, replica_id, worktree, client.clone(), cx));
481 worktrees.push(worktree);
482 }
483
484 let this = cx.add_model(|cx: &mut ModelContext<Self>| {
485 let handle = cx.weak_handle();
486 project_store.update(cx, |store, cx| store.add_project(handle, cx));
487
488 let mut this = Self {
489 worktrees: Vec::new(),
490 loading_buffers: Default::default(),
491 opened_buffer: watch::channel(),
492 shared_buffers: Default::default(),
493 incomplete_buffers: Default::default(),
494 loading_local_worktrees: Default::default(),
495 active_entry: None,
496 collaborators: Default::default(),
497 _maintain_buffer_languages: Self::maintain_buffer_languages(&languages, cx),
498 languages,
499 user_store: user_store.clone(),
500 project_store,
501 fs,
502 next_entry_id: Default::default(),
503 next_diagnostic_group_id: Default::default(),
504 client_subscriptions: vec![client.add_model_for_remote_entity(remote_id, cx)],
505 _subscriptions: Default::default(),
506 client: client.clone(),
507 client_state: Some(ProjectClientState::Remote {
508 sharing_has_stopped: false,
509 remote_id,
510 replica_id,
511 _detect_unshare: cx.spawn_weak(move |this, mut cx| {
512 async move {
513 let mut status = client.status();
514 let is_connected =
515 status.next().await.map_or(false, |s| s.is_connected());
516 // Even if we're initially connected, any future change of the status means we momentarily disconnected.
517 if !is_connected || status.next().await.is_some() {
518 if let Some(this) = this.upgrade(&cx) {
519 this.update(&mut cx, |this, cx| this.disconnected_from_host(cx))
520 }
521 }
522 Ok(())
523 }
524 .log_err()
525 }),
526 }),
527 language_servers: Default::default(),
528 language_server_ids: Default::default(),
529 language_server_settings: Default::default(),
530 language_server_statuses: response
531 .language_servers
532 .into_iter()
533 .map(|server| {
534 (
535 server.id as usize,
536 LanguageServerStatus {
537 name: server.name,
538 pending_work: Default::default(),
539 has_pending_diagnostic_updates: false,
540 progress_tokens: Default::default(),
541 },
542 )
543 })
544 .collect(),
545 last_workspace_edits_by_language_server: Default::default(),
546 next_language_server_id: 0,
547 opened_buffers: Default::default(),
548 buffers_being_formatted: Default::default(),
549 buffer_snapshots: Default::default(),
550 nonce: StdRng::from_entropy().gen(),
551 };
552 for worktree in worktrees {
553 this.add_worktree(&worktree, cx);
554 }
555 this
556 });
557
558 let user_ids = response
559 .collaborators
560 .iter()
561 .map(|peer| peer.user_id)
562 .collect();
563 user_store
564 .update(&mut cx, |user_store, cx| user_store.get_users(user_ids, cx))
565 .await?;
566 let mut collaborators = HashMap::default();
567 for message in response.collaborators {
568 let collaborator = Collaborator::from_proto(message);
569 collaborators.insert(collaborator.peer_id, collaborator);
570 }
571
572 this.update(&mut cx, |this, _| {
573 this.collaborators = collaborators;
574 });
575
576 Ok(this)
577 }
578
579 #[cfg(any(test, feature = "test-support"))]
580 pub async fn test(
581 fs: Arc<dyn Fs>,
582 root_paths: impl IntoIterator<Item = &Path>,
583 cx: &mut gpui::TestAppContext,
584 ) -> ModelHandle<Project> {
585 if !cx.read(|cx| cx.has_global::<Settings>()) {
586 cx.update(|cx| {
587 cx.set_global(Settings::test(cx));
588 cx.set_global(HomeDir(Path::new("/tmp/").to_path_buf()))
589 });
590 }
591
592 let languages = Arc::new(LanguageRegistry::test());
593 let http_client = client::test::FakeHttpClient::with_404_response();
594 let client = cx.update(|cx| client::Client::new(http_client.clone(), cx));
595 let user_store = cx.add_model(|cx| UserStore::new(client.clone(), http_client, cx));
596 let project_store = cx.add_model(|_| ProjectStore::new());
597 let project =
598 cx.update(|cx| Project::local(client, user_store, project_store, languages, fs, cx));
599 for path in root_paths {
600 let (tree, _) = project
601 .update(cx, |project, cx| {
602 project.find_or_create_local_worktree(path, true, cx)
603 })
604 .await
605 .unwrap();
606 tree.read_with(cx, |tree, _| tree.as_local().unwrap().scan_complete())
607 .await;
608 }
609 project
610 }
611
612 fn on_settings_changed(&mut self, cx: &mut ModelContext<Self>) {
613 let settings = cx.global::<Settings>();
614
615 let mut language_servers_to_start = Vec::new();
616 for buffer in self.opened_buffers.values() {
617 if let Some(buffer) = buffer.upgrade(cx) {
618 let buffer = buffer.read(cx);
619 if let Some((file, language)) = File::from_dyn(buffer.file()).zip(buffer.language())
620 {
621 if settings.enable_language_server(Some(&language.name())) {
622 let worktree = file.worktree.read(cx);
623 language_servers_to_start.push((
624 worktree.id(),
625 worktree.as_local().unwrap().abs_path().clone(),
626 language.clone(),
627 ));
628 }
629 }
630 }
631 }
632
633 let mut language_servers_to_stop = Vec::new();
634 for language in self.languages.to_vec() {
635 if let Some(lsp_adapter) = language.lsp_adapter() {
636 if !settings.enable_language_server(Some(&language.name())) {
637 let lsp_name = &lsp_adapter.name;
638 for (worktree_id, started_lsp_name) in self.language_server_ids.keys() {
639 if lsp_name == started_lsp_name {
640 language_servers_to_stop.push((*worktree_id, started_lsp_name.clone()));
641 }
642 }
643 }
644 }
645 }
646
647 // Stop all newly-disabled language servers.
648 for (worktree_id, adapter_name) in language_servers_to_stop {
649 self.stop_language_server(worktree_id, adapter_name, cx)
650 .detach();
651 }
652
653 // Start all the newly-enabled language servers.
654 for (worktree_id, worktree_path, language) in language_servers_to_start {
655 self.start_language_server(worktree_id, worktree_path, language, cx);
656 }
657
658 cx.notify();
659 }
660
661 pub fn buffer_for_id(&self, remote_id: u64, cx: &AppContext) -> Option<ModelHandle<Buffer>> {
662 self.opened_buffers
663 .get(&remote_id)
664 .and_then(|buffer| buffer.upgrade(cx))
665 }
666
667 pub fn languages(&self) -> &Arc<LanguageRegistry> {
668 &self.languages
669 }
670
671 pub fn client(&self) -> Arc<Client> {
672 self.client.clone()
673 }
674
675 pub fn user_store(&self) -> ModelHandle<UserStore> {
676 self.user_store.clone()
677 }
678
679 pub fn project_store(&self) -> ModelHandle<ProjectStore> {
680 self.project_store.clone()
681 }
682
683 #[cfg(any(test, feature = "test-support"))]
684 pub fn check_invariants(&self, cx: &AppContext) {
685 if self.is_local() {
686 let mut worktree_root_paths = HashMap::default();
687 for worktree in self.worktrees(cx) {
688 let worktree = worktree.read(cx);
689 let abs_path = worktree.as_local().unwrap().abs_path().clone();
690 let prev_worktree_id = worktree_root_paths.insert(abs_path.clone(), worktree.id());
691 assert_eq!(
692 prev_worktree_id,
693 None,
694 "abs path {:?} for worktree {:?} is not unique ({:?} was already registered with the same path)",
695 abs_path,
696 worktree.id(),
697 prev_worktree_id
698 )
699 }
700 } else {
701 let replica_id = self.replica_id();
702 for buffer in self.opened_buffers.values() {
703 if let Some(buffer) = buffer.upgrade(cx) {
704 let buffer = buffer.read(cx);
705 assert_eq!(
706 buffer.deferred_ops_len(),
707 0,
708 "replica {}, buffer {} has deferred operations",
709 replica_id,
710 buffer.remote_id()
711 );
712 }
713 }
714 }
715 }
716
717 #[cfg(any(test, feature = "test-support"))]
718 pub fn has_open_buffer(&self, path: impl Into<ProjectPath>, cx: &AppContext) -> bool {
719 let path = path.into();
720 if let Some(worktree) = self.worktree_for_id(path.worktree_id, cx) {
721 self.opened_buffers.iter().any(|(_, buffer)| {
722 if let Some(buffer) = buffer.upgrade(cx) {
723 if let Some(file) = File::from_dyn(buffer.read(cx).file()) {
724 if file.worktree == worktree && file.path() == &path.path {
725 return true;
726 }
727 }
728 }
729 false
730 })
731 } else {
732 false
733 }
734 }
735
736 pub fn fs(&self) -> &Arc<dyn Fs> {
737 &self.fs
738 }
739
740 pub fn remote_id(&self) -> Option<u64> {
741 match self.client_state.as_ref()? {
742 ProjectClientState::Local { remote_id, .. }
743 | ProjectClientState::Remote { remote_id, .. } => Some(*remote_id),
744 }
745 }
746
747 pub fn replica_id(&self) -> ReplicaId {
748 match &self.client_state {
749 Some(ProjectClientState::Remote { replica_id, .. }) => *replica_id,
750 _ => 0,
751 }
752 }
753
754 fn metadata_changed(&mut self, cx: &mut ModelContext<Self>) {
755 if let Some(ProjectClientState::Local { remote_id, .. }) = &self.client_state {
756 let project_id = *remote_id;
757 // Broadcast worktrees only if the project is online.
758 let worktrees = self
759 .worktrees
760 .iter()
761 .filter_map(|worktree| {
762 worktree
763 .upgrade(cx)
764 .map(|worktree| worktree.read(cx).as_local().unwrap().metadata_proto())
765 })
766 .collect();
767 self.client
768 .send(proto::UpdateProject {
769 project_id,
770 worktrees,
771 })
772 .log_err();
773
774 let worktrees = self.visible_worktrees(cx).collect::<Vec<_>>();
775 let scans_complete = futures::future::join_all(
776 worktrees
777 .iter()
778 .filter_map(|worktree| Some(worktree.read(cx).as_local()?.scan_complete())),
779 );
780
781 let worktrees = worktrees.into_iter().map(|handle| handle.downgrade());
782
783 cx.spawn_weak(move |_, cx| async move {
784 scans_complete.await;
785 cx.read(|cx| {
786 for worktree in worktrees {
787 if let Some(worktree) = worktree
788 .upgrade(cx)
789 .and_then(|worktree| worktree.read(cx).as_local())
790 {
791 worktree.send_extension_counts(project_id);
792 }
793 }
794 })
795 })
796 .detach();
797 }
798
799 self.project_store.update(cx, |_, cx| cx.notify());
800 cx.notify();
801 }
802
803 pub fn collaborators(&self) -> &HashMap<PeerId, Collaborator> {
804 &self.collaborators
805 }
806
807 pub fn worktrees<'a>(
808 &'a self,
809 cx: &'a AppContext,
810 ) -> impl 'a + DoubleEndedIterator<Item = ModelHandle<Worktree>> {
811 self.worktrees
812 .iter()
813 .filter_map(move |worktree| worktree.upgrade(cx))
814 }
815
816 pub fn visible_worktrees<'a>(
817 &'a self,
818 cx: &'a AppContext,
819 ) -> impl 'a + DoubleEndedIterator<Item = ModelHandle<Worktree>> {
820 self.worktrees.iter().filter_map(|worktree| {
821 worktree.upgrade(cx).and_then(|worktree| {
822 if worktree.read(cx).is_visible() {
823 Some(worktree)
824 } else {
825 None
826 }
827 })
828 })
829 }
830
831 pub fn worktree_root_names<'a>(&'a self, cx: &'a AppContext) -> impl Iterator<Item = &'a str> {
832 self.visible_worktrees(cx)
833 .map(|tree| tree.read(cx).root_name())
834 }
835
836 pub fn worktree_for_id(
837 &self,
838 id: WorktreeId,
839 cx: &AppContext,
840 ) -> Option<ModelHandle<Worktree>> {
841 self.worktrees(cx)
842 .find(|worktree| worktree.read(cx).id() == id)
843 }
844
845 pub fn worktree_for_entry(
846 &self,
847 entry_id: ProjectEntryId,
848 cx: &AppContext,
849 ) -> Option<ModelHandle<Worktree>> {
850 self.worktrees(cx)
851 .find(|worktree| worktree.read(cx).contains_entry(entry_id))
852 }
853
854 pub fn worktree_id_for_entry(
855 &self,
856 entry_id: ProjectEntryId,
857 cx: &AppContext,
858 ) -> Option<WorktreeId> {
859 self.worktree_for_entry(entry_id, cx)
860 .map(|worktree| worktree.read(cx).id())
861 }
862
863 pub fn contains_paths(&self, paths: &[PathBuf], cx: &AppContext) -> bool {
864 paths.iter().all(|path| self.contains_path(path, cx))
865 }
866
867 pub fn contains_path(&self, path: &Path, cx: &AppContext) -> bool {
868 for worktree in self.worktrees(cx) {
869 let worktree = worktree.read(cx).as_local();
870 if worktree.map_or(false, |w| w.contains_abs_path(path)) {
871 return true;
872 }
873 }
874 false
875 }
876
877 pub fn create_entry(
878 &mut self,
879 project_path: impl Into<ProjectPath>,
880 is_directory: bool,
881 cx: &mut ModelContext<Self>,
882 ) -> Option<Task<Result<Entry>>> {
883 let project_path = project_path.into();
884 let worktree = self.worktree_for_id(project_path.worktree_id, cx)?;
885 if self.is_local() {
886 Some(worktree.update(cx, |worktree, cx| {
887 worktree
888 .as_local_mut()
889 .unwrap()
890 .create_entry(project_path.path, is_directory, cx)
891 }))
892 } else {
893 let client = self.client.clone();
894 let project_id = self.remote_id().unwrap();
895 Some(cx.spawn_weak(|_, mut cx| async move {
896 let response = client
897 .request(proto::CreateProjectEntry {
898 worktree_id: project_path.worktree_id.to_proto(),
899 project_id,
900 path: project_path.path.as_os_str().as_bytes().to_vec(),
901 is_directory,
902 })
903 .await?;
904 let entry = response
905 .entry
906 .ok_or_else(|| anyhow!("missing entry in response"))?;
907 worktree
908 .update(&mut cx, |worktree, cx| {
909 worktree.as_remote_mut().unwrap().insert_entry(
910 entry,
911 response.worktree_scan_id as usize,
912 cx,
913 )
914 })
915 .await
916 }))
917 }
918 }
919
920 pub fn copy_entry(
921 &mut self,
922 entry_id: ProjectEntryId,
923 new_path: impl Into<Arc<Path>>,
924 cx: &mut ModelContext<Self>,
925 ) -> Option<Task<Result<Entry>>> {
926 let worktree = self.worktree_for_entry(entry_id, cx)?;
927 let new_path = new_path.into();
928 if self.is_local() {
929 worktree.update(cx, |worktree, cx| {
930 worktree
931 .as_local_mut()
932 .unwrap()
933 .copy_entry(entry_id, new_path, cx)
934 })
935 } else {
936 let client = self.client.clone();
937 let project_id = self.remote_id().unwrap();
938
939 Some(cx.spawn_weak(|_, mut cx| async move {
940 let response = client
941 .request(proto::CopyProjectEntry {
942 project_id,
943 entry_id: entry_id.to_proto(),
944 new_path: new_path.as_os_str().as_bytes().to_vec(),
945 })
946 .await?;
947 let entry = response
948 .entry
949 .ok_or_else(|| anyhow!("missing entry in response"))?;
950 worktree
951 .update(&mut cx, |worktree, cx| {
952 worktree.as_remote_mut().unwrap().insert_entry(
953 entry,
954 response.worktree_scan_id as usize,
955 cx,
956 )
957 })
958 .await
959 }))
960 }
961 }
962
963 pub fn rename_entry(
964 &mut self,
965 entry_id: ProjectEntryId,
966 new_path: impl Into<Arc<Path>>,
967 cx: &mut ModelContext<Self>,
968 ) -> Option<Task<Result<Entry>>> {
969 let worktree = self.worktree_for_entry(entry_id, cx)?;
970 let new_path = new_path.into();
971 if self.is_local() {
972 worktree.update(cx, |worktree, cx| {
973 worktree
974 .as_local_mut()
975 .unwrap()
976 .rename_entry(entry_id, new_path, cx)
977 })
978 } else {
979 let client = self.client.clone();
980 let project_id = self.remote_id().unwrap();
981
982 Some(cx.spawn_weak(|_, mut cx| async move {
983 let response = client
984 .request(proto::RenameProjectEntry {
985 project_id,
986 entry_id: entry_id.to_proto(),
987 new_path: new_path.as_os_str().as_bytes().to_vec(),
988 })
989 .await?;
990 let entry = response
991 .entry
992 .ok_or_else(|| anyhow!("missing entry in response"))?;
993 worktree
994 .update(&mut cx, |worktree, cx| {
995 worktree.as_remote_mut().unwrap().insert_entry(
996 entry,
997 response.worktree_scan_id as usize,
998 cx,
999 )
1000 })
1001 .await
1002 }))
1003 }
1004 }
1005
1006 pub fn delete_entry(
1007 &mut self,
1008 entry_id: ProjectEntryId,
1009 cx: &mut ModelContext<Self>,
1010 ) -> Option<Task<Result<()>>> {
1011 let worktree = self.worktree_for_entry(entry_id, cx)?;
1012 if self.is_local() {
1013 worktree.update(cx, |worktree, cx| {
1014 worktree.as_local_mut().unwrap().delete_entry(entry_id, cx)
1015 })
1016 } else {
1017 let client = self.client.clone();
1018 let project_id = self.remote_id().unwrap();
1019 Some(cx.spawn_weak(|_, mut cx| async move {
1020 let response = client
1021 .request(proto::DeleteProjectEntry {
1022 project_id,
1023 entry_id: entry_id.to_proto(),
1024 })
1025 .await?;
1026 worktree
1027 .update(&mut cx, move |worktree, cx| {
1028 worktree.as_remote_mut().unwrap().delete_entry(
1029 entry_id,
1030 response.worktree_scan_id as usize,
1031 cx,
1032 )
1033 })
1034 .await
1035 }))
1036 }
1037 }
1038
1039 pub fn shared(&mut self, project_id: u64, cx: &mut ModelContext<Self>) -> Task<Result<()>> {
1040 if self.client_state.is_some() {
1041 return Task::ready(Err(anyhow!("project was already shared")));
1042 }
1043
1044 let mut worktree_share_tasks = Vec::new();
1045
1046 for open_buffer in self.opened_buffers.values_mut() {
1047 match open_buffer {
1048 OpenBuffer::Strong(_) => {}
1049 OpenBuffer::Weak(buffer) => {
1050 if let Some(buffer) = buffer.upgrade(cx) {
1051 *open_buffer = OpenBuffer::Strong(buffer);
1052 }
1053 }
1054 OpenBuffer::Operations(_) => unreachable!(),
1055 }
1056 }
1057
1058 for worktree_handle in self.worktrees.iter_mut() {
1059 match worktree_handle {
1060 WorktreeHandle::Strong(_) => {}
1061 WorktreeHandle::Weak(worktree) => {
1062 if let Some(worktree) = worktree.upgrade(cx) {
1063 *worktree_handle = WorktreeHandle::Strong(worktree);
1064 }
1065 }
1066 }
1067 }
1068
1069 for (server_id, status) in &self.language_server_statuses {
1070 self.client
1071 .send(proto::StartLanguageServer {
1072 project_id,
1073 server: Some(proto::LanguageServer {
1074 id: *server_id as u64,
1075 name: status.name.clone(),
1076 }),
1077 })
1078 .log_err();
1079 }
1080
1081 for worktree in self.worktrees(cx).collect::<Vec<_>>() {
1082 worktree.update(cx, |worktree, cx| {
1083 let worktree = worktree.as_local_mut().unwrap();
1084 worktree_share_tasks.push(worktree.share(project_id, cx));
1085 });
1086 }
1087
1088 self.client_subscriptions
1089 .push(self.client.add_model_for_remote_entity(project_id, cx));
1090 self.metadata_changed(cx);
1091 cx.emit(Event::RemoteIdChanged(Some(project_id)));
1092 cx.notify();
1093
1094 let mut status = self.client.status();
1095 self.client_state = Some(ProjectClientState::Local {
1096 remote_id: project_id,
1097 _detect_unshare: cx.spawn_weak(move |this, mut cx| {
1098 async move {
1099 let is_connected = status.next().await.map_or(false, |s| s.is_connected());
1100 // Even if we're initially connected, any future change of the status means we momentarily disconnected.
1101 if !is_connected || status.next().await.is_some() {
1102 if let Some(this) = this.upgrade(&cx) {
1103 let _ = this.update(&mut cx, |this, cx| this.unshare(cx));
1104 }
1105 }
1106 Ok(())
1107 }
1108 .log_err()
1109 }),
1110 });
1111
1112 cx.foreground().spawn(async move {
1113 futures::future::try_join_all(worktree_share_tasks).await?;
1114 Ok(())
1115 })
1116 }
1117
1118 pub fn unshare(&mut self, cx: &mut ModelContext<Self>) -> Result<()> {
1119 if self.is_remote() {
1120 return Err(anyhow!("attempted to unshare a remote project"));
1121 }
1122
1123 if let Some(ProjectClientState::Local { remote_id, .. }) = self.client_state.take() {
1124 self.collaborators.clear();
1125 self.shared_buffers.clear();
1126 self.client_subscriptions.clear();
1127
1128 for worktree_handle in self.worktrees.iter_mut() {
1129 if let WorktreeHandle::Strong(worktree) = worktree_handle {
1130 let is_visible = worktree.update(cx, |worktree, _| {
1131 worktree.as_local_mut().unwrap().unshare();
1132 worktree.is_visible()
1133 });
1134 if !is_visible {
1135 *worktree_handle = WorktreeHandle::Weak(worktree.downgrade());
1136 }
1137 }
1138 }
1139
1140 for open_buffer in self.opened_buffers.values_mut() {
1141 if let OpenBuffer::Strong(buffer) = open_buffer {
1142 *open_buffer = OpenBuffer::Weak(buffer.downgrade());
1143 }
1144 }
1145
1146 self.metadata_changed(cx);
1147 cx.notify();
1148 self.client.send(proto::UnshareProject {
1149 project_id: remote_id,
1150 })?;
1151
1152 Ok(())
1153 } else {
1154 Err(anyhow!("attempted to unshare an unshared project"))
1155 }
1156 }
1157
1158 fn disconnected_from_host(&mut self, cx: &mut ModelContext<Self>) {
1159 if let Some(ProjectClientState::Remote {
1160 sharing_has_stopped,
1161 ..
1162 }) = &mut self.client_state
1163 {
1164 *sharing_has_stopped = true;
1165 self.collaborators.clear();
1166 for worktree in &self.worktrees {
1167 if let Some(worktree) = worktree.upgrade(cx) {
1168 worktree.update(cx, |worktree, _| {
1169 if let Some(worktree) = worktree.as_remote_mut() {
1170 worktree.disconnected_from_host();
1171 }
1172 });
1173 }
1174 }
1175 cx.emit(Event::DisconnectedFromHost);
1176 cx.notify();
1177
1178 // Wake up all futures currently waiting on a buffer to get opened,
1179 // to give them a chance to fail now that we've disconnected.
1180 *self.opened_buffer.0.borrow_mut() = ();
1181 }
1182 }
1183
1184 pub fn is_read_only(&self) -> bool {
1185 match &self.client_state {
1186 Some(ProjectClientState::Remote {
1187 sharing_has_stopped,
1188 ..
1189 }) => *sharing_has_stopped,
1190 _ => false,
1191 }
1192 }
1193
1194 pub fn is_local(&self) -> bool {
1195 match &self.client_state {
1196 Some(ProjectClientState::Remote { .. }) => false,
1197 _ => true,
1198 }
1199 }
1200
1201 pub fn is_remote(&self) -> bool {
1202 !self.is_local()
1203 }
1204
1205 pub fn create_buffer(
1206 &mut self,
1207 text: &str,
1208 language: Option<Arc<Language>>,
1209 cx: &mut ModelContext<Self>,
1210 ) -> Result<ModelHandle<Buffer>> {
1211 if self.is_remote() {
1212 return Err(anyhow!("creating buffers as a guest is not supported yet"));
1213 }
1214
1215 let buffer = cx.add_model(|cx| {
1216 Buffer::new(self.replica_id(), text, cx)
1217 .with_language(language.unwrap_or_else(|| language::PLAIN_TEXT.clone()), cx)
1218 });
1219 self.register_buffer(&buffer, cx)?;
1220 Ok(buffer)
1221 }
1222
1223 pub fn open_path(
1224 &mut self,
1225 path: impl Into<ProjectPath>,
1226 cx: &mut ModelContext<Self>,
1227 ) -> Task<Result<(ProjectEntryId, AnyModelHandle)>> {
1228 let task = self.open_buffer(path, cx);
1229 cx.spawn_weak(|_, cx| async move {
1230 let buffer = task.await?;
1231 let project_entry_id = buffer
1232 .read_with(&cx, |buffer, cx| {
1233 File::from_dyn(buffer.file()).and_then(|file| file.project_entry_id(cx))
1234 })
1235 .ok_or_else(|| anyhow!("no project entry"))?;
1236 Ok((project_entry_id, buffer.into()))
1237 })
1238 }
1239
1240 pub fn open_local_buffer(
1241 &mut self,
1242 abs_path: impl AsRef<Path>,
1243 cx: &mut ModelContext<Self>,
1244 ) -> Task<Result<ModelHandle<Buffer>>> {
1245 if let Some((worktree, relative_path)) = self.find_local_worktree(abs_path.as_ref(), cx) {
1246 self.open_buffer((worktree.read(cx).id(), relative_path), cx)
1247 } else {
1248 Task::ready(Err(anyhow!("no such path")))
1249 }
1250 }
1251
1252 pub fn open_buffer(
1253 &mut self,
1254 path: impl Into<ProjectPath>,
1255 cx: &mut ModelContext<Self>,
1256 ) -> Task<Result<ModelHandle<Buffer>>> {
1257 let project_path = path.into();
1258 let worktree = if let Some(worktree) = self.worktree_for_id(project_path.worktree_id, cx) {
1259 worktree
1260 } else {
1261 return Task::ready(Err(anyhow!("no such worktree")));
1262 };
1263
1264 // If there is already a buffer for the given path, then return it.
1265 let existing_buffer = self.get_open_buffer(&project_path, cx);
1266 if let Some(existing_buffer) = existing_buffer {
1267 return Task::ready(Ok(existing_buffer));
1268 }
1269
1270 let mut loading_watch = match self.loading_buffers.entry(project_path.clone()) {
1271 // If the given path is already being loaded, then wait for that existing
1272 // task to complete and return the same buffer.
1273 hash_map::Entry::Occupied(e) => e.get().clone(),
1274
1275 // Otherwise, record the fact that this path is now being loaded.
1276 hash_map::Entry::Vacant(entry) => {
1277 let (mut tx, rx) = postage::watch::channel();
1278 entry.insert(rx.clone());
1279
1280 let load_buffer = if worktree.read(cx).is_local() {
1281 self.open_local_buffer_internal(&project_path.path, &worktree, cx)
1282 } else {
1283 self.open_remote_buffer_internal(&project_path.path, &worktree, cx)
1284 };
1285
1286 cx.spawn(move |this, mut cx| async move {
1287 let load_result = load_buffer.await;
1288 *tx.borrow_mut() = Some(this.update(&mut cx, |this, _| {
1289 // Record the fact that the buffer is no longer loading.
1290 this.loading_buffers.remove(&project_path);
1291 let buffer = load_result.map_err(Arc::new)?;
1292 Ok(buffer)
1293 }));
1294 })
1295 .detach();
1296 rx
1297 }
1298 };
1299
1300 cx.foreground().spawn(async move {
1301 loop {
1302 if let Some(result) = loading_watch.borrow().as_ref() {
1303 match result {
1304 Ok(buffer) => return Ok(buffer.clone()),
1305 Err(error) => return Err(anyhow!("{}", error)),
1306 }
1307 }
1308 loading_watch.next().await;
1309 }
1310 })
1311 }
1312
1313 fn open_local_buffer_internal(
1314 &mut self,
1315 path: &Arc<Path>,
1316 worktree: &ModelHandle<Worktree>,
1317 cx: &mut ModelContext<Self>,
1318 ) -> Task<Result<ModelHandle<Buffer>>> {
1319 let load_buffer = worktree.update(cx, |worktree, cx| {
1320 let worktree = worktree.as_local_mut().unwrap();
1321 worktree.load_buffer(path, cx)
1322 });
1323 cx.spawn(|this, mut cx| async move {
1324 let buffer = load_buffer.await?;
1325 this.update(&mut cx, |this, cx| this.register_buffer(&buffer, cx))?;
1326 Ok(buffer)
1327 })
1328 }
1329
1330 fn open_remote_buffer_internal(
1331 &mut self,
1332 path: &Arc<Path>,
1333 worktree: &ModelHandle<Worktree>,
1334 cx: &mut ModelContext<Self>,
1335 ) -> Task<Result<ModelHandle<Buffer>>> {
1336 let rpc = self.client.clone();
1337 let project_id = self.remote_id().unwrap();
1338 let remote_worktree_id = worktree.read(cx).id();
1339 let path = path.clone();
1340 let path_string = path.to_string_lossy().to_string();
1341 cx.spawn(|this, mut cx| async move {
1342 let response = rpc
1343 .request(proto::OpenBufferByPath {
1344 project_id,
1345 worktree_id: remote_worktree_id.to_proto(),
1346 path: path_string,
1347 })
1348 .await?;
1349 this.update(&mut cx, |this, cx| {
1350 this.wait_for_buffer(response.buffer_id, cx)
1351 })
1352 .await
1353 })
1354 }
1355
1356 /// LanguageServerName is owned, because it is inserted into a map
1357 fn open_local_buffer_via_lsp(
1358 &mut self,
1359 abs_path: lsp::Url,
1360 language_server_id: usize,
1361 language_server_name: LanguageServerName,
1362 cx: &mut ModelContext<Self>,
1363 ) -> Task<Result<ModelHandle<Buffer>>> {
1364 cx.spawn(|this, mut cx| async move {
1365 let abs_path = abs_path
1366 .to_file_path()
1367 .map_err(|_| anyhow!("can't convert URI to path"))?;
1368 let (worktree, relative_path) = if let Some(result) =
1369 this.read_with(&cx, |this, cx| this.find_local_worktree(&abs_path, cx))
1370 {
1371 result
1372 } else {
1373 let worktree = this
1374 .update(&mut cx, |this, cx| {
1375 this.create_local_worktree(&abs_path, false, cx)
1376 })
1377 .await?;
1378 this.update(&mut cx, |this, cx| {
1379 this.language_server_ids.insert(
1380 (worktree.read(cx).id(), language_server_name),
1381 language_server_id,
1382 );
1383 });
1384 (worktree, PathBuf::new())
1385 };
1386
1387 let project_path = ProjectPath {
1388 worktree_id: worktree.read_with(&cx, |worktree, _| worktree.id()),
1389 path: relative_path.into(),
1390 };
1391 this.update(&mut cx, |this, cx| this.open_buffer(project_path, cx))
1392 .await
1393 })
1394 }
1395
1396 pub fn open_buffer_by_id(
1397 &mut self,
1398 id: u64,
1399 cx: &mut ModelContext<Self>,
1400 ) -> Task<Result<ModelHandle<Buffer>>> {
1401 if let Some(buffer) = self.buffer_for_id(id, cx) {
1402 Task::ready(Ok(buffer))
1403 } else if self.is_local() {
1404 Task::ready(Err(anyhow!("buffer {} does not exist", id)))
1405 } else if let Some(project_id) = self.remote_id() {
1406 let request = self
1407 .client
1408 .request(proto::OpenBufferById { project_id, id });
1409 cx.spawn(|this, mut cx| async move {
1410 let buffer_id = request.await?.buffer_id;
1411 this.update(&mut cx, |this, cx| this.wait_for_buffer(buffer_id, cx))
1412 .await
1413 })
1414 } else {
1415 Task::ready(Err(anyhow!("cannot open buffer while disconnected")))
1416 }
1417 }
1418
1419 pub fn save_buffer_as(
1420 &mut self,
1421 buffer: ModelHandle<Buffer>,
1422 abs_path: PathBuf,
1423 cx: &mut ModelContext<Project>,
1424 ) -> Task<Result<()>> {
1425 let worktree_task = self.find_or_create_local_worktree(&abs_path, true, cx);
1426 let old_path =
1427 File::from_dyn(buffer.read(cx).file()).and_then(|f| Some(f.as_local()?.abs_path(cx)));
1428 cx.spawn(|this, mut cx| async move {
1429 if let Some(old_path) = old_path {
1430 this.update(&mut cx, |this, cx| {
1431 this.unregister_buffer_from_language_server(&buffer, old_path, cx);
1432 });
1433 }
1434 let (worktree, path) = worktree_task.await?;
1435 worktree
1436 .update(&mut cx, |worktree, cx| {
1437 worktree
1438 .as_local_mut()
1439 .unwrap()
1440 .save_buffer_as(buffer.clone(), path, cx)
1441 })
1442 .await?;
1443 this.update(&mut cx, |this, cx| {
1444 this.assign_language_to_buffer(&buffer, cx);
1445 this.register_buffer_with_language_server(&buffer, cx);
1446 });
1447 Ok(())
1448 })
1449 }
1450
1451 pub fn get_open_buffer(
1452 &mut self,
1453 path: &ProjectPath,
1454 cx: &mut ModelContext<Self>,
1455 ) -> Option<ModelHandle<Buffer>> {
1456 let worktree = self.worktree_for_id(path.worktree_id, cx)?;
1457 self.opened_buffers.values().find_map(|buffer| {
1458 let buffer = buffer.upgrade(cx)?;
1459 let file = File::from_dyn(buffer.read(cx).file())?;
1460 if file.worktree == worktree && file.path() == &path.path {
1461 Some(buffer)
1462 } else {
1463 None
1464 }
1465 })
1466 }
1467
1468 fn register_buffer(
1469 &mut self,
1470 buffer: &ModelHandle<Buffer>,
1471 cx: &mut ModelContext<Self>,
1472 ) -> Result<()> {
1473 let remote_id = buffer.read(cx).remote_id();
1474 let open_buffer = if self.is_remote() || self.is_shared() {
1475 OpenBuffer::Strong(buffer.clone())
1476 } else {
1477 OpenBuffer::Weak(buffer.downgrade())
1478 };
1479
1480 match self.opened_buffers.insert(remote_id, open_buffer) {
1481 None => {}
1482 Some(OpenBuffer::Operations(operations)) => {
1483 buffer.update(cx, |buffer, cx| buffer.apply_ops(operations, cx))?
1484 }
1485 Some(OpenBuffer::Weak(existing_handle)) => {
1486 if existing_handle.upgrade(cx).is_some() {
1487 Err(anyhow!(
1488 "already registered buffer with remote id {}",
1489 remote_id
1490 ))?
1491 }
1492 }
1493 Some(OpenBuffer::Strong(_)) => Err(anyhow!(
1494 "already registered buffer with remote id {}",
1495 remote_id
1496 ))?,
1497 }
1498 cx.subscribe(buffer, |this, buffer, event, cx| {
1499 this.on_buffer_event(buffer, event, cx);
1500 })
1501 .detach();
1502
1503 self.assign_language_to_buffer(buffer, cx);
1504 self.register_buffer_with_language_server(buffer, cx);
1505 cx.observe_release(buffer, |this, buffer, cx| {
1506 if let Some(file) = File::from_dyn(buffer.file()) {
1507 if file.is_local() {
1508 let uri = lsp::Url::from_file_path(file.abs_path(cx)).unwrap();
1509 if let Some((_, server)) = this.language_server_for_buffer(buffer, cx) {
1510 server
1511 .notify::<lsp::notification::DidCloseTextDocument>(
1512 lsp::DidCloseTextDocumentParams {
1513 text_document: lsp::TextDocumentIdentifier::new(uri),
1514 },
1515 )
1516 .log_err();
1517 }
1518 }
1519 }
1520 })
1521 .detach();
1522
1523 *self.opened_buffer.0.borrow_mut() = ();
1524 Ok(())
1525 }
1526
1527 fn register_buffer_with_language_server(
1528 &mut self,
1529 buffer_handle: &ModelHandle<Buffer>,
1530 cx: &mut ModelContext<Self>,
1531 ) {
1532 let buffer = buffer_handle.read(cx);
1533 let buffer_id = buffer.remote_id();
1534 if let Some(file) = File::from_dyn(buffer.file()) {
1535 if file.is_local() {
1536 let uri = lsp::Url::from_file_path(file.abs_path(cx)).unwrap();
1537 let initial_snapshot = buffer.text_snapshot();
1538
1539 let mut language_server = None;
1540 let mut language_id = None;
1541 if let Some(language) = buffer.language() {
1542 let worktree_id = file.worktree_id(cx);
1543 if let Some(adapter) = language.lsp_adapter() {
1544 language_id = adapter.language_ids.get(language.name().as_ref()).cloned();
1545 language_server = self
1546 .language_server_ids
1547 .get(&(worktree_id, adapter.name.clone()))
1548 .and_then(|id| self.language_servers.get(id))
1549 .and_then(|server_state| {
1550 if let LanguageServerState::Running { server, .. } = server_state {
1551 Some(server.clone())
1552 } else {
1553 None
1554 }
1555 });
1556 }
1557 }
1558
1559 if let Some(local_worktree) = file.worktree.read(cx).as_local() {
1560 if let Some(diagnostics) = local_worktree.diagnostics_for_path(file.path()) {
1561 self.update_buffer_diagnostics(buffer_handle, diagnostics, None, cx)
1562 .log_err();
1563 }
1564 }
1565
1566 if let Some(server) = language_server {
1567 server
1568 .notify::<lsp::notification::DidOpenTextDocument>(
1569 lsp::DidOpenTextDocumentParams {
1570 text_document: lsp::TextDocumentItem::new(
1571 uri,
1572 language_id.unwrap_or_default(),
1573 0,
1574 initial_snapshot.text(),
1575 ),
1576 },
1577 )
1578 .log_err();
1579 buffer_handle.update(cx, |buffer, cx| {
1580 buffer.set_completion_triggers(
1581 server
1582 .capabilities()
1583 .completion_provider
1584 .as_ref()
1585 .and_then(|provider| provider.trigger_characters.clone())
1586 .unwrap_or_default(),
1587 cx,
1588 )
1589 });
1590 self.buffer_snapshots
1591 .insert(buffer_id, vec![(0, initial_snapshot)]);
1592 }
1593 }
1594 }
1595 }
1596
1597 fn unregister_buffer_from_language_server(
1598 &mut self,
1599 buffer: &ModelHandle<Buffer>,
1600 old_path: PathBuf,
1601 cx: &mut ModelContext<Self>,
1602 ) {
1603 buffer.update(cx, |buffer, cx| {
1604 buffer.update_diagnostics(Default::default(), cx);
1605 self.buffer_snapshots.remove(&buffer.remote_id());
1606 if let Some((_, language_server)) = self.language_server_for_buffer(buffer, cx) {
1607 language_server
1608 .notify::<lsp::notification::DidCloseTextDocument>(
1609 lsp::DidCloseTextDocumentParams {
1610 text_document: lsp::TextDocumentIdentifier::new(
1611 lsp::Url::from_file_path(old_path).unwrap(),
1612 ),
1613 },
1614 )
1615 .log_err();
1616 }
1617 });
1618 }
1619
1620 fn on_buffer_event(
1621 &mut self,
1622 buffer: ModelHandle<Buffer>,
1623 event: &BufferEvent,
1624 cx: &mut ModelContext<Self>,
1625 ) -> Option<()> {
1626 match event {
1627 BufferEvent::Operation(operation) => {
1628 if let Some(project_id) = self.remote_id() {
1629 let request = self.client.request(proto::UpdateBuffer {
1630 project_id,
1631 buffer_id: buffer.read(cx).remote_id(),
1632 operations: vec![language::proto::serialize_operation(operation)],
1633 });
1634 cx.background().spawn(request).detach_and_log_err(cx);
1635 } else if let Some(project_id) = self.remote_id() {
1636 let _ = self
1637 .client
1638 .send(proto::RegisterProjectActivity { project_id });
1639 }
1640 }
1641 BufferEvent::Edited { .. } => {
1642 let language_server = self
1643 .language_server_for_buffer(buffer.read(cx), cx)
1644 .map(|(_, server)| server.clone())?;
1645 let buffer = buffer.read(cx);
1646 let file = File::from_dyn(buffer.file())?;
1647 let abs_path = file.as_local()?.abs_path(cx);
1648 let uri = lsp::Url::from_file_path(abs_path).unwrap();
1649 let buffer_snapshots = self.buffer_snapshots.get_mut(&buffer.remote_id())?;
1650 let (version, prev_snapshot) = buffer_snapshots.last()?;
1651 let next_snapshot = buffer.text_snapshot();
1652 let next_version = version + 1;
1653
1654 let content_changes = buffer
1655 .edits_since::<(PointUtf16, usize)>(prev_snapshot.version())
1656 .map(|edit| {
1657 let edit_start = edit.new.start.0;
1658 let edit_end = edit_start + (edit.old.end.0 - edit.old.start.0);
1659 let new_text = next_snapshot
1660 .text_for_range(edit.new.start.1..edit.new.end.1)
1661 .collect();
1662 lsp::TextDocumentContentChangeEvent {
1663 range: Some(lsp::Range::new(
1664 point_to_lsp(edit_start),
1665 point_to_lsp(edit_end),
1666 )),
1667 range_length: None,
1668 text: new_text,
1669 }
1670 })
1671 .collect();
1672
1673 buffer_snapshots.push((next_version, next_snapshot));
1674
1675 language_server
1676 .notify::<lsp::notification::DidChangeTextDocument>(
1677 lsp::DidChangeTextDocumentParams {
1678 text_document: lsp::VersionedTextDocumentIdentifier::new(
1679 uri,
1680 next_version,
1681 ),
1682 content_changes,
1683 },
1684 )
1685 .log_err();
1686 }
1687 BufferEvent::Saved => {
1688 let file = File::from_dyn(buffer.read(cx).file())?;
1689 let worktree_id = file.worktree_id(cx);
1690 let abs_path = file.as_local()?.abs_path(cx);
1691 let text_document = lsp::TextDocumentIdentifier {
1692 uri: lsp::Url::from_file_path(abs_path).unwrap(),
1693 };
1694
1695 for (_, _, server) in self.language_servers_for_worktree(worktree_id) {
1696 server
1697 .notify::<lsp::notification::DidSaveTextDocument>(
1698 lsp::DidSaveTextDocumentParams {
1699 text_document: text_document.clone(),
1700 text: None,
1701 },
1702 )
1703 .log_err();
1704 }
1705
1706 // After saving a buffer, simulate disk-based diagnostics being finished for languages
1707 // that don't support a disk-based progress token.
1708 let (lsp_adapter, language_server) =
1709 self.language_server_for_buffer(buffer.read(cx), cx)?;
1710 if lsp_adapter.disk_based_diagnostics_progress_token.is_none() {
1711 let server_id = language_server.server_id();
1712 self.disk_based_diagnostics_finished(server_id, cx);
1713 self.broadcast_language_server_update(
1714 server_id,
1715 proto::update_language_server::Variant::DiskBasedDiagnosticsUpdated(
1716 proto::LspDiskBasedDiagnosticsUpdated {},
1717 ),
1718 );
1719 }
1720 }
1721 _ => {}
1722 }
1723
1724 None
1725 }
1726
1727 fn language_servers_for_worktree(
1728 &self,
1729 worktree_id: WorktreeId,
1730 ) -> impl Iterator<Item = (&Arc<CachedLspAdapter>, &Arc<Language>, &Arc<LanguageServer>)> {
1731 self.language_server_ids
1732 .iter()
1733 .filter_map(move |((language_server_worktree_id, _), id)| {
1734 if *language_server_worktree_id == worktree_id {
1735 if let Some(LanguageServerState::Running {
1736 adapter,
1737 language,
1738 server,
1739 }) = self.language_servers.get(id)
1740 {
1741 return Some((adapter, language, server));
1742 }
1743 }
1744 None
1745 })
1746 }
1747
1748 fn maintain_buffer_languages(
1749 languages: &LanguageRegistry,
1750 cx: &mut ModelContext<Project>,
1751 ) -> Task<()> {
1752 let mut subscription = languages.subscribe();
1753 cx.spawn_weak(|project, mut cx| async move {
1754 while let Some(()) = subscription.next().await {
1755 if let Some(project) = project.upgrade(&cx) {
1756 project.update(&mut cx, |project, cx| {
1757 let mut buffers_without_language = Vec::new();
1758 for buffer in project.opened_buffers.values() {
1759 if let Some(buffer) = buffer.upgrade(cx) {
1760 if buffer.read(cx).language().is_none() {
1761 buffers_without_language.push(buffer);
1762 }
1763 }
1764 }
1765
1766 for buffer in buffers_without_language {
1767 project.assign_language_to_buffer(&buffer, cx);
1768 project.register_buffer_with_language_server(&buffer, cx);
1769 }
1770 });
1771 }
1772 }
1773 })
1774 }
1775
1776 fn assign_language_to_buffer(
1777 &mut self,
1778 buffer: &ModelHandle<Buffer>,
1779 cx: &mut ModelContext<Self>,
1780 ) -> Option<()> {
1781 // If the buffer has a language, set it and start the language server if we haven't already.
1782 let full_path = buffer.read(cx).file()?.full_path(cx);
1783 let new_language = self.languages.select_language(&full_path)?;
1784 buffer.update(cx, |buffer, cx| {
1785 if buffer.language().map_or(true, |old_language| {
1786 !Arc::ptr_eq(old_language, &new_language)
1787 }) {
1788 buffer.set_language_registry(self.languages.clone());
1789 buffer.set_language(Some(new_language.clone()), cx);
1790 }
1791 });
1792
1793 let file = File::from_dyn(buffer.read(cx).file())?;
1794 let worktree = file.worktree.read(cx).as_local()?;
1795 let worktree_id = worktree.id();
1796 let worktree_abs_path = worktree.abs_path().clone();
1797 self.start_language_server(worktree_id, worktree_abs_path, new_language, cx);
1798
1799 None
1800 }
1801
1802 fn merge_json_value_into(source: serde_json::Value, target: &mut serde_json::Value) {
1803 use serde_json::Value;
1804
1805 match (source, target) {
1806 (Value::Object(source), Value::Object(target)) => {
1807 for (key, value) in source {
1808 if let Some(target) = target.get_mut(&key) {
1809 Self::merge_json_value_into(value, target);
1810 } else {
1811 target.insert(key.clone(), value);
1812 }
1813 }
1814 }
1815
1816 (source, target) => *target = source,
1817 }
1818 }
1819
1820 fn start_language_server(
1821 &mut self,
1822 worktree_id: WorktreeId,
1823 worktree_path: Arc<Path>,
1824 language: Arc<Language>,
1825 cx: &mut ModelContext<Self>,
1826 ) {
1827 if !cx
1828 .global::<Settings>()
1829 .enable_language_server(Some(&language.name()))
1830 {
1831 return;
1832 }
1833
1834 let adapter = if let Some(adapter) = language.lsp_adapter() {
1835 adapter
1836 } else {
1837 return;
1838 };
1839 let key = (worktree_id, adapter.name.clone());
1840
1841 let mut initialization_options = adapter.initialization_options.clone();
1842
1843 let lsp = &cx.global::<Settings>().lsp.get(&adapter.name.0);
1844 let override_options = lsp.map(|s| s.initialization_options.clone()).flatten();
1845 match (&mut initialization_options, override_options) {
1846 (Some(initialization_options), Some(override_options)) => {
1847 Self::merge_json_value_into(override_options, initialization_options);
1848 }
1849
1850 (None, override_options) => initialization_options = override_options,
1851
1852 _ => {}
1853 }
1854
1855 self.language_server_ids
1856 .entry(key.clone())
1857 .or_insert_with(|| {
1858 let server_id = post_inc(&mut self.next_language_server_id);
1859 let language_server = self.languages.start_language_server(
1860 server_id,
1861 language.clone(),
1862 worktree_path,
1863 self.client.http_client(),
1864 cx,
1865 );
1866 self.language_servers.insert(
1867 server_id,
1868 LanguageServerState::Starting(cx.spawn_weak(|this, mut cx| async move {
1869 let language_server = language_server?.await.log_err()?;
1870 let language_server = language_server
1871 .initialize(initialization_options)
1872 .await
1873 .log_err()?;
1874 let this = this.upgrade(&cx)?;
1875
1876 language_server
1877 .on_notification::<lsp::notification::PublishDiagnostics, _>({
1878 let this = this.downgrade();
1879 let adapter = adapter.clone();
1880 move |mut params, cx| {
1881 let this = this;
1882 let adapter = adapter.clone();
1883 cx.spawn(|mut cx| async move {
1884 adapter.process_diagnostics(&mut params).await;
1885 if let Some(this) = this.upgrade(&cx) {
1886 this.update(&mut cx, |this, cx| {
1887 this.update_diagnostics(
1888 server_id,
1889 params,
1890 &adapter.disk_based_diagnostic_sources,
1891 cx,
1892 )
1893 .log_err();
1894 });
1895 }
1896 })
1897 .detach();
1898 }
1899 })
1900 .detach();
1901
1902 language_server
1903 .on_request::<lsp::request::WorkspaceConfiguration, _, _>({
1904 let settings = this.read_with(&cx, |this, _| {
1905 this.language_server_settings.clone()
1906 });
1907 move |params, _| {
1908 let settings = settings.lock().clone();
1909 async move {
1910 Ok(params
1911 .items
1912 .into_iter()
1913 .map(|item| {
1914 if let Some(section) = &item.section {
1915 settings
1916 .get(section)
1917 .cloned()
1918 .unwrap_or(serde_json::Value::Null)
1919 } else {
1920 settings.clone()
1921 }
1922 })
1923 .collect())
1924 }
1925 }
1926 })
1927 .detach();
1928
1929 // Even though we don't have handling for these requests, respond to them to
1930 // avoid stalling any language server like `gopls` which waits for a response
1931 // to these requests when initializing.
1932 language_server
1933 .on_request::<lsp::request::WorkDoneProgressCreate, _, _>({
1934 let this = this.downgrade();
1935 move |params, mut cx| async move {
1936 if let Some(this) = this.upgrade(&cx) {
1937 this.update(&mut cx, |this, _| {
1938 if let Some(status) =
1939 this.language_server_statuses.get_mut(&server_id)
1940 {
1941 if let lsp::NumberOrString::String(token) =
1942 params.token
1943 {
1944 status.progress_tokens.insert(token);
1945 }
1946 }
1947 });
1948 }
1949 Ok(())
1950 }
1951 })
1952 .detach();
1953 language_server
1954 .on_request::<lsp::request::RegisterCapability, _, _>(|_, _| async {
1955 Ok(())
1956 })
1957 .detach();
1958
1959 language_server
1960 .on_request::<lsp::request::ApplyWorkspaceEdit, _, _>({
1961 let this = this.downgrade();
1962 let adapter = adapter.clone();
1963 let language_server = language_server.clone();
1964 move |params, cx| {
1965 Self::on_lsp_workspace_edit(
1966 this,
1967 params,
1968 server_id,
1969 adapter.clone(),
1970 language_server.clone(),
1971 cx,
1972 )
1973 }
1974 })
1975 .detach();
1976
1977 let disk_based_diagnostics_progress_token =
1978 adapter.disk_based_diagnostics_progress_token.clone();
1979
1980 language_server
1981 .on_notification::<lsp::notification::Progress, _>({
1982 let this = this.downgrade();
1983 move |params, mut cx| {
1984 if let Some(this) = this.upgrade(&cx) {
1985 this.update(&mut cx, |this, cx| {
1986 this.on_lsp_progress(
1987 params,
1988 server_id,
1989 disk_based_diagnostics_progress_token.clone(),
1990 cx,
1991 );
1992 });
1993 }
1994 }
1995 })
1996 .detach();
1997
1998 this.update(&mut cx, |this, cx| {
1999 // If the language server for this key doesn't match the server id, don't store the
2000 // server. Which will cause it to be dropped, killing the process
2001 if this
2002 .language_server_ids
2003 .get(&key)
2004 .map(|id| id != &server_id)
2005 .unwrap_or(false)
2006 {
2007 return None;
2008 }
2009
2010 // Update language_servers collection with Running variant of LanguageServerState
2011 // indicating that the server is up and running and ready
2012 this.language_servers.insert(
2013 server_id,
2014 LanguageServerState::Running {
2015 adapter: adapter.clone(),
2016 language,
2017 server: language_server.clone(),
2018 },
2019 );
2020 this.language_server_statuses.insert(
2021 server_id,
2022 LanguageServerStatus {
2023 name: language_server.name().to_string(),
2024 pending_work: Default::default(),
2025 has_pending_diagnostic_updates: false,
2026 progress_tokens: Default::default(),
2027 },
2028 );
2029 language_server
2030 .notify::<lsp::notification::DidChangeConfiguration>(
2031 lsp::DidChangeConfigurationParams {
2032 settings: this.language_server_settings.lock().clone(),
2033 },
2034 )
2035 .ok();
2036
2037 if let Some(project_id) = this.remote_id() {
2038 this.client
2039 .send(proto::StartLanguageServer {
2040 project_id,
2041 server: Some(proto::LanguageServer {
2042 id: server_id as u64,
2043 name: language_server.name().to_string(),
2044 }),
2045 })
2046 .log_err();
2047 }
2048
2049 // Tell the language server about every open buffer in the worktree that matches the language.
2050 for buffer in this.opened_buffers.values() {
2051 if let Some(buffer_handle) = buffer.upgrade(cx) {
2052 let buffer = buffer_handle.read(cx);
2053 let file = if let Some(file) = File::from_dyn(buffer.file()) {
2054 file
2055 } else {
2056 continue;
2057 };
2058 let language = if let Some(language) = buffer.language() {
2059 language
2060 } else {
2061 continue;
2062 };
2063 if file.worktree.read(cx).id() != key.0
2064 || language.lsp_adapter().map(|a| a.name.clone())
2065 != Some(key.1.clone())
2066 {
2067 continue;
2068 }
2069
2070 let file = file.as_local()?;
2071 let versions = this
2072 .buffer_snapshots
2073 .entry(buffer.remote_id())
2074 .or_insert_with(|| vec![(0, buffer.text_snapshot())]);
2075 let (version, initial_snapshot) = versions.last().unwrap();
2076 let uri = lsp::Url::from_file_path(file.abs_path(cx)).unwrap();
2077 language_server
2078 .notify::<lsp::notification::DidOpenTextDocument>(
2079 lsp::DidOpenTextDocumentParams {
2080 text_document: lsp::TextDocumentItem::new(
2081 uri,
2082 adapter
2083 .language_ids
2084 .get(language.name().as_ref())
2085 .cloned()
2086 .unwrap_or_default(),
2087 *version,
2088 initial_snapshot.text(),
2089 ),
2090 },
2091 )
2092 .log_err()?;
2093 buffer_handle.update(cx, |buffer, cx| {
2094 buffer.set_completion_triggers(
2095 language_server
2096 .capabilities()
2097 .completion_provider
2098 .as_ref()
2099 .and_then(|provider| {
2100 provider.trigger_characters.clone()
2101 })
2102 .unwrap_or_default(),
2103 cx,
2104 )
2105 });
2106 }
2107 }
2108
2109 cx.notify();
2110 Some(language_server)
2111 })
2112 })),
2113 );
2114
2115 server_id
2116 });
2117 }
2118
2119 // Returns a list of all of the worktrees which no longer have a language server and the root path
2120 // for the stopped server
2121 fn stop_language_server(
2122 &mut self,
2123 worktree_id: WorktreeId,
2124 adapter_name: LanguageServerName,
2125 cx: &mut ModelContext<Self>,
2126 ) -> Task<(Option<PathBuf>, Vec<WorktreeId>)> {
2127 let key = (worktree_id, adapter_name);
2128 if let Some(server_id) = self.language_server_ids.remove(&key) {
2129 // Remove other entries for this language server as well
2130 let mut orphaned_worktrees = vec![worktree_id];
2131 let other_keys = self.language_server_ids.keys().cloned().collect::<Vec<_>>();
2132 for other_key in other_keys {
2133 if self.language_server_ids.get(&other_key) == Some(&server_id) {
2134 self.language_server_ids.remove(&other_key);
2135 orphaned_worktrees.push(other_key.0);
2136 }
2137 }
2138
2139 self.language_server_statuses.remove(&server_id);
2140 cx.notify();
2141
2142 let server_state = self.language_servers.remove(&server_id);
2143 cx.spawn_weak(|this, mut cx| async move {
2144 let mut root_path = None;
2145
2146 let server = match server_state {
2147 Some(LanguageServerState::Starting(started_language_server)) => {
2148 started_language_server.await
2149 }
2150 Some(LanguageServerState::Running { server, .. }) => Some(server),
2151 None => None,
2152 };
2153
2154 if let Some(server) = server {
2155 root_path = Some(server.root_path().clone());
2156 if let Some(shutdown) = server.shutdown() {
2157 shutdown.await;
2158 }
2159 }
2160
2161 if let Some(this) = this.upgrade(&cx) {
2162 this.update(&mut cx, |this, cx| {
2163 this.language_server_statuses.remove(&server_id);
2164 cx.notify();
2165 });
2166 }
2167
2168 (root_path, orphaned_worktrees)
2169 })
2170 } else {
2171 Task::ready((None, Vec::new()))
2172 }
2173 }
2174
2175 pub fn restart_language_servers_for_buffers(
2176 &mut self,
2177 buffers: impl IntoIterator<Item = ModelHandle<Buffer>>,
2178 cx: &mut ModelContext<Self>,
2179 ) -> Option<()> {
2180 let language_server_lookup_info: HashSet<(WorktreeId, Arc<Path>, PathBuf)> = buffers
2181 .into_iter()
2182 .filter_map(|buffer| {
2183 let file = File::from_dyn(buffer.read(cx).file())?;
2184 let worktree = file.worktree.read(cx).as_local()?;
2185 let worktree_id = worktree.id();
2186 let worktree_abs_path = worktree.abs_path().clone();
2187 let full_path = file.full_path(cx);
2188 Some((worktree_id, worktree_abs_path, full_path))
2189 })
2190 .collect();
2191 for (worktree_id, worktree_abs_path, full_path) in language_server_lookup_info {
2192 let language = self.languages.select_language(&full_path)?;
2193 self.restart_language_server(worktree_id, worktree_abs_path, language, cx);
2194 }
2195
2196 None
2197 }
2198
2199 fn restart_language_server(
2200 &mut self,
2201 worktree_id: WorktreeId,
2202 fallback_path: Arc<Path>,
2203 language: Arc<Language>,
2204 cx: &mut ModelContext<Self>,
2205 ) {
2206 let adapter = if let Some(adapter) = language.lsp_adapter() {
2207 adapter
2208 } else {
2209 return;
2210 };
2211
2212 let server_name = adapter.name.clone();
2213 let stop = self.stop_language_server(worktree_id, server_name.clone(), cx);
2214 cx.spawn_weak(|this, mut cx| async move {
2215 let (original_root_path, orphaned_worktrees) = stop.await;
2216 if let Some(this) = this.upgrade(&cx) {
2217 this.update(&mut cx, |this, cx| {
2218 // Attempt to restart using original server path. Fallback to passed in
2219 // path if we could not retrieve the root path
2220 let root_path = original_root_path
2221 .map(|path_buf| Arc::from(path_buf.as_path()))
2222 .unwrap_or(fallback_path);
2223
2224 this.start_language_server(worktree_id, root_path, language, cx);
2225
2226 // Lookup new server id and set it for each of the orphaned worktrees
2227 if let Some(new_server_id) = this
2228 .language_server_ids
2229 .get(&(worktree_id, server_name.clone()))
2230 .cloned()
2231 {
2232 for orphaned_worktree in orphaned_worktrees {
2233 this.language_server_ids
2234 .insert((orphaned_worktree, server_name.clone()), new_server_id);
2235 }
2236 }
2237 });
2238 }
2239 })
2240 .detach();
2241 }
2242
2243 fn on_lsp_progress(
2244 &mut self,
2245 progress: lsp::ProgressParams,
2246 server_id: usize,
2247 disk_based_diagnostics_progress_token: Option<String>,
2248 cx: &mut ModelContext<Self>,
2249 ) {
2250 let token = match progress.token {
2251 lsp::NumberOrString::String(token) => token,
2252 lsp::NumberOrString::Number(token) => {
2253 log::info!("skipping numeric progress token {}", token);
2254 return;
2255 }
2256 };
2257 let lsp::ProgressParamsValue::WorkDone(progress) = progress.value;
2258 let language_server_status =
2259 if let Some(status) = self.language_server_statuses.get_mut(&server_id) {
2260 status
2261 } else {
2262 return;
2263 };
2264
2265 if !language_server_status.progress_tokens.contains(&token) {
2266 return;
2267 }
2268
2269 let is_disk_based_diagnostics_progress = disk_based_diagnostics_progress_token
2270 .as_ref()
2271 .map_or(false, |disk_based_token| {
2272 token.starts_with(disk_based_token)
2273 });
2274
2275 match progress {
2276 lsp::WorkDoneProgress::Begin(report) => {
2277 if is_disk_based_diagnostics_progress {
2278 language_server_status.has_pending_diagnostic_updates = true;
2279 self.disk_based_diagnostics_started(server_id, cx);
2280 self.broadcast_language_server_update(
2281 server_id,
2282 proto::update_language_server::Variant::DiskBasedDiagnosticsUpdating(
2283 proto::LspDiskBasedDiagnosticsUpdating {},
2284 ),
2285 );
2286 } else {
2287 self.on_lsp_work_start(
2288 server_id,
2289 token.clone(),
2290 LanguageServerProgress {
2291 message: report.message.clone(),
2292 percentage: report.percentage.map(|p| p as usize),
2293 last_update_at: Instant::now(),
2294 },
2295 cx,
2296 );
2297 self.broadcast_language_server_update(
2298 server_id,
2299 proto::update_language_server::Variant::WorkStart(proto::LspWorkStart {
2300 token,
2301 message: report.message,
2302 percentage: report.percentage.map(|p| p as u32),
2303 }),
2304 );
2305 }
2306 }
2307 lsp::WorkDoneProgress::Report(report) => {
2308 if !is_disk_based_diagnostics_progress {
2309 self.on_lsp_work_progress(
2310 server_id,
2311 token.clone(),
2312 LanguageServerProgress {
2313 message: report.message.clone(),
2314 percentage: report.percentage.map(|p| p as usize),
2315 last_update_at: Instant::now(),
2316 },
2317 cx,
2318 );
2319 self.broadcast_language_server_update(
2320 server_id,
2321 proto::update_language_server::Variant::WorkProgress(
2322 proto::LspWorkProgress {
2323 token,
2324 message: report.message,
2325 percentage: report.percentage.map(|p| p as u32),
2326 },
2327 ),
2328 );
2329 }
2330 }
2331 lsp::WorkDoneProgress::End(_) => {
2332 language_server_status.progress_tokens.remove(&token);
2333
2334 if is_disk_based_diagnostics_progress {
2335 language_server_status.has_pending_diagnostic_updates = false;
2336 self.disk_based_diagnostics_finished(server_id, cx);
2337 self.broadcast_language_server_update(
2338 server_id,
2339 proto::update_language_server::Variant::DiskBasedDiagnosticsUpdated(
2340 proto::LspDiskBasedDiagnosticsUpdated {},
2341 ),
2342 );
2343 } else {
2344 self.on_lsp_work_end(server_id, token.clone(), cx);
2345 self.broadcast_language_server_update(
2346 server_id,
2347 proto::update_language_server::Variant::WorkEnd(proto::LspWorkEnd {
2348 token,
2349 }),
2350 );
2351 }
2352 }
2353 }
2354 }
2355
2356 fn on_lsp_work_start(
2357 &mut self,
2358 language_server_id: usize,
2359 token: String,
2360 progress: LanguageServerProgress,
2361 cx: &mut ModelContext<Self>,
2362 ) {
2363 if let Some(status) = self.language_server_statuses.get_mut(&language_server_id) {
2364 status.pending_work.insert(token, progress);
2365 cx.notify();
2366 }
2367 }
2368
2369 fn on_lsp_work_progress(
2370 &mut self,
2371 language_server_id: usize,
2372 token: String,
2373 progress: LanguageServerProgress,
2374 cx: &mut ModelContext<Self>,
2375 ) {
2376 if let Some(status) = self.language_server_statuses.get_mut(&language_server_id) {
2377 let entry = status
2378 .pending_work
2379 .entry(token)
2380 .or_insert(LanguageServerProgress {
2381 message: Default::default(),
2382 percentage: Default::default(),
2383 last_update_at: progress.last_update_at,
2384 });
2385 if progress.message.is_some() {
2386 entry.message = progress.message;
2387 }
2388 if progress.percentage.is_some() {
2389 entry.percentage = progress.percentage;
2390 }
2391 entry.last_update_at = progress.last_update_at;
2392 cx.notify();
2393 }
2394 }
2395
2396 fn on_lsp_work_end(
2397 &mut self,
2398 language_server_id: usize,
2399 token: String,
2400 cx: &mut ModelContext<Self>,
2401 ) {
2402 if let Some(status) = self.language_server_statuses.get_mut(&language_server_id) {
2403 status.pending_work.remove(&token);
2404 cx.notify();
2405 }
2406 }
2407
2408 async fn on_lsp_workspace_edit(
2409 this: WeakModelHandle<Self>,
2410 params: lsp::ApplyWorkspaceEditParams,
2411 server_id: usize,
2412 adapter: Arc<CachedLspAdapter>,
2413 language_server: Arc<LanguageServer>,
2414 mut cx: AsyncAppContext,
2415 ) -> Result<lsp::ApplyWorkspaceEditResponse> {
2416 let this = this
2417 .upgrade(&cx)
2418 .ok_or_else(|| anyhow!("project project closed"))?;
2419 let transaction = Self::deserialize_workspace_edit(
2420 this.clone(),
2421 params.edit,
2422 true,
2423 adapter.clone(),
2424 language_server.clone(),
2425 &mut cx,
2426 )
2427 .await
2428 .log_err();
2429 this.update(&mut cx, |this, _| {
2430 if let Some(transaction) = transaction {
2431 this.last_workspace_edits_by_language_server
2432 .insert(server_id, transaction);
2433 }
2434 });
2435 Ok(lsp::ApplyWorkspaceEditResponse {
2436 applied: true,
2437 failed_change: None,
2438 failure_reason: None,
2439 })
2440 }
2441
2442 fn broadcast_language_server_update(
2443 &self,
2444 language_server_id: usize,
2445 event: proto::update_language_server::Variant,
2446 ) {
2447 if let Some(project_id) = self.remote_id() {
2448 self.client
2449 .send(proto::UpdateLanguageServer {
2450 project_id,
2451 language_server_id: language_server_id as u64,
2452 variant: Some(event),
2453 })
2454 .log_err();
2455 }
2456 }
2457
2458 pub fn set_language_server_settings(&mut self, settings: serde_json::Value) {
2459 for server_state in self.language_servers.values() {
2460 if let LanguageServerState::Running { server, .. } = server_state {
2461 server
2462 .notify::<lsp::notification::DidChangeConfiguration>(
2463 lsp::DidChangeConfigurationParams {
2464 settings: settings.clone(),
2465 },
2466 )
2467 .ok();
2468 }
2469 }
2470 *self.language_server_settings.lock() = settings;
2471 }
2472
2473 pub fn language_server_statuses(
2474 &self,
2475 ) -> impl DoubleEndedIterator<Item = &LanguageServerStatus> {
2476 self.language_server_statuses.values()
2477 }
2478
2479 pub fn update_diagnostics(
2480 &mut self,
2481 language_server_id: usize,
2482 params: lsp::PublishDiagnosticsParams,
2483 disk_based_sources: &[String],
2484 cx: &mut ModelContext<Self>,
2485 ) -> Result<()> {
2486 let abs_path = params
2487 .uri
2488 .to_file_path()
2489 .map_err(|_| anyhow!("URI is not a file"))?;
2490 let mut diagnostics = Vec::default();
2491 let mut primary_diagnostic_group_ids = HashMap::default();
2492 let mut sources_by_group_id = HashMap::default();
2493 let mut supporting_diagnostics = HashMap::default();
2494 for diagnostic in ¶ms.diagnostics {
2495 let source = diagnostic.source.as_ref();
2496 let code = diagnostic.code.as_ref().map(|code| match code {
2497 lsp::NumberOrString::Number(code) => code.to_string(),
2498 lsp::NumberOrString::String(code) => code.clone(),
2499 });
2500 let range = range_from_lsp(diagnostic.range);
2501 let is_supporting = diagnostic
2502 .related_information
2503 .as_ref()
2504 .map_or(false, |infos| {
2505 infos.iter().any(|info| {
2506 primary_diagnostic_group_ids.contains_key(&(
2507 source,
2508 code.clone(),
2509 range_from_lsp(info.location.range),
2510 ))
2511 })
2512 });
2513
2514 let is_unnecessary = diagnostic.tags.as_ref().map_or(false, |tags| {
2515 tags.iter().any(|tag| *tag == DiagnosticTag::UNNECESSARY)
2516 });
2517
2518 if is_supporting {
2519 supporting_diagnostics.insert(
2520 (source, code.clone(), range),
2521 (diagnostic.severity, is_unnecessary),
2522 );
2523 } else {
2524 let group_id = post_inc(&mut self.next_diagnostic_group_id);
2525 let is_disk_based =
2526 source.map_or(false, |source| disk_based_sources.contains(source));
2527
2528 sources_by_group_id.insert(group_id, source);
2529 primary_diagnostic_group_ids
2530 .insert((source, code.clone(), range.clone()), group_id);
2531
2532 diagnostics.push(DiagnosticEntry {
2533 range,
2534 diagnostic: Diagnostic {
2535 code: code.clone(),
2536 severity: diagnostic.severity.unwrap_or(DiagnosticSeverity::ERROR),
2537 message: diagnostic.message.clone(),
2538 group_id,
2539 is_primary: true,
2540 is_valid: true,
2541 is_disk_based,
2542 is_unnecessary,
2543 },
2544 });
2545 if let Some(infos) = &diagnostic.related_information {
2546 for info in infos {
2547 if info.location.uri == params.uri && !info.message.is_empty() {
2548 let range = range_from_lsp(info.location.range);
2549 diagnostics.push(DiagnosticEntry {
2550 range,
2551 diagnostic: Diagnostic {
2552 code: code.clone(),
2553 severity: DiagnosticSeverity::INFORMATION,
2554 message: info.message.clone(),
2555 group_id,
2556 is_primary: false,
2557 is_valid: true,
2558 is_disk_based,
2559 is_unnecessary: false,
2560 },
2561 });
2562 }
2563 }
2564 }
2565 }
2566 }
2567
2568 for entry in &mut diagnostics {
2569 let diagnostic = &mut entry.diagnostic;
2570 if !diagnostic.is_primary {
2571 let source = *sources_by_group_id.get(&diagnostic.group_id).unwrap();
2572 if let Some(&(severity, is_unnecessary)) = supporting_diagnostics.get(&(
2573 source,
2574 diagnostic.code.clone(),
2575 entry.range.clone(),
2576 )) {
2577 if let Some(severity) = severity {
2578 diagnostic.severity = severity;
2579 }
2580 diagnostic.is_unnecessary = is_unnecessary;
2581 }
2582 }
2583 }
2584
2585 self.update_diagnostic_entries(
2586 language_server_id,
2587 abs_path,
2588 params.version,
2589 diagnostics,
2590 cx,
2591 )?;
2592 Ok(())
2593 }
2594
2595 pub fn update_diagnostic_entries(
2596 &mut self,
2597 language_server_id: usize,
2598 abs_path: PathBuf,
2599 version: Option<i32>,
2600 diagnostics: Vec<DiagnosticEntry<PointUtf16>>,
2601 cx: &mut ModelContext<Project>,
2602 ) -> Result<(), anyhow::Error> {
2603 let (worktree, relative_path) = self
2604 .find_local_worktree(&abs_path, cx)
2605 .ok_or_else(|| anyhow!("no worktree found for diagnostics"))?;
2606
2607 let project_path = ProjectPath {
2608 worktree_id: worktree.read(cx).id(),
2609 path: relative_path.into(),
2610 };
2611 if let Some(buffer) = self.get_open_buffer(&project_path, cx) {
2612 self.update_buffer_diagnostics(&buffer, diagnostics.clone(), version, cx)?;
2613 }
2614
2615 let updated = worktree.update(cx, |worktree, cx| {
2616 worktree
2617 .as_local_mut()
2618 .ok_or_else(|| anyhow!("not a local worktree"))?
2619 .update_diagnostics(
2620 language_server_id,
2621 project_path.path.clone(),
2622 diagnostics,
2623 cx,
2624 )
2625 })?;
2626 if updated {
2627 cx.emit(Event::DiagnosticsUpdated {
2628 language_server_id,
2629 path: project_path,
2630 });
2631 }
2632 Ok(())
2633 }
2634
2635 fn update_buffer_diagnostics(
2636 &mut self,
2637 buffer: &ModelHandle<Buffer>,
2638 mut diagnostics: Vec<DiagnosticEntry<PointUtf16>>,
2639 version: Option<i32>,
2640 cx: &mut ModelContext<Self>,
2641 ) -> Result<()> {
2642 fn compare_diagnostics(a: &Diagnostic, b: &Diagnostic) -> Ordering {
2643 Ordering::Equal
2644 .then_with(|| b.is_primary.cmp(&a.is_primary))
2645 .then_with(|| a.is_disk_based.cmp(&b.is_disk_based))
2646 .then_with(|| a.severity.cmp(&b.severity))
2647 .then_with(|| a.message.cmp(&b.message))
2648 }
2649
2650 let snapshot = self.buffer_snapshot_for_lsp_version(buffer, version, cx)?;
2651
2652 diagnostics.sort_unstable_by(|a, b| {
2653 Ordering::Equal
2654 .then_with(|| a.range.start.cmp(&b.range.start))
2655 .then_with(|| b.range.end.cmp(&a.range.end))
2656 .then_with(|| compare_diagnostics(&a.diagnostic, &b.diagnostic))
2657 });
2658
2659 let mut sanitized_diagnostics = Vec::new();
2660 let edits_since_save = Patch::new(
2661 snapshot
2662 .edits_since::<PointUtf16>(buffer.read(cx).saved_version())
2663 .collect(),
2664 );
2665 for entry in diagnostics {
2666 let start;
2667 let end;
2668 if entry.diagnostic.is_disk_based {
2669 // Some diagnostics are based on files on disk instead of buffers'
2670 // current contents. Adjust these diagnostics' ranges to reflect
2671 // any unsaved edits.
2672 start = edits_since_save.old_to_new(entry.range.start);
2673 end = edits_since_save.old_to_new(entry.range.end);
2674 } else {
2675 start = entry.range.start;
2676 end = entry.range.end;
2677 }
2678
2679 let mut range = snapshot.clip_point_utf16(start, Bias::Left)
2680 ..snapshot.clip_point_utf16(end, Bias::Right);
2681
2682 // Expand empty ranges by one character
2683 if range.start == range.end {
2684 range.end.column += 1;
2685 range.end = snapshot.clip_point_utf16(range.end, Bias::Right);
2686 if range.start == range.end && range.end.column > 0 {
2687 range.start.column -= 1;
2688 range.start = snapshot.clip_point_utf16(range.start, Bias::Left);
2689 }
2690 }
2691
2692 sanitized_diagnostics.push(DiagnosticEntry {
2693 range,
2694 diagnostic: entry.diagnostic,
2695 });
2696 }
2697 drop(edits_since_save);
2698
2699 let set = DiagnosticSet::new(sanitized_diagnostics, &snapshot);
2700 buffer.update(cx, |buffer, cx| buffer.update_diagnostics(set, cx));
2701 Ok(())
2702 }
2703
2704 pub fn reload_buffers(
2705 &self,
2706 buffers: HashSet<ModelHandle<Buffer>>,
2707 push_to_history: bool,
2708 cx: &mut ModelContext<Self>,
2709 ) -> Task<Result<ProjectTransaction>> {
2710 let mut local_buffers = Vec::new();
2711 let mut remote_buffers = None;
2712 for buffer_handle in buffers {
2713 let buffer = buffer_handle.read(cx);
2714 if buffer.is_dirty() {
2715 if let Some(file) = File::from_dyn(buffer.file()) {
2716 if file.is_local() {
2717 local_buffers.push(buffer_handle);
2718 } else {
2719 remote_buffers.get_or_insert(Vec::new()).push(buffer_handle);
2720 }
2721 }
2722 }
2723 }
2724
2725 let remote_buffers = self.remote_id().zip(remote_buffers);
2726 let client = self.client.clone();
2727
2728 cx.spawn(|this, mut cx| async move {
2729 let mut project_transaction = ProjectTransaction::default();
2730
2731 if let Some((project_id, remote_buffers)) = remote_buffers {
2732 let response = client
2733 .request(proto::ReloadBuffers {
2734 project_id,
2735 buffer_ids: remote_buffers
2736 .iter()
2737 .map(|buffer| buffer.read_with(&cx, |buffer, _| buffer.remote_id()))
2738 .collect(),
2739 })
2740 .await?
2741 .transaction
2742 .ok_or_else(|| anyhow!("missing transaction"))?;
2743 project_transaction = this
2744 .update(&mut cx, |this, cx| {
2745 this.deserialize_project_transaction(response, push_to_history, cx)
2746 })
2747 .await?;
2748 }
2749
2750 for buffer in local_buffers {
2751 let transaction = buffer
2752 .update(&mut cx, |buffer, cx| buffer.reload(cx))
2753 .await?;
2754 buffer.update(&mut cx, |buffer, cx| {
2755 if let Some(transaction) = transaction {
2756 if !push_to_history {
2757 buffer.forget_transaction(transaction.id);
2758 }
2759 project_transaction.0.insert(cx.handle(), transaction);
2760 }
2761 });
2762 }
2763
2764 Ok(project_transaction)
2765 })
2766 }
2767
2768 pub fn format(
2769 &self,
2770 buffers: HashSet<ModelHandle<Buffer>>,
2771 push_to_history: bool,
2772 trigger: FormatTrigger,
2773 cx: &mut ModelContext<Project>,
2774 ) -> Task<Result<ProjectTransaction>> {
2775 let mut local_buffers = Vec::new();
2776 let mut remote_buffers = None;
2777 for buffer_handle in buffers {
2778 let buffer = buffer_handle.read(cx);
2779 if let Some(file) = File::from_dyn(buffer.file()) {
2780 if let Some(buffer_abs_path) = file.as_local().map(|f| f.abs_path(cx)) {
2781 if let Some((_, server)) = self.language_server_for_buffer(buffer, cx) {
2782 local_buffers.push((buffer_handle, buffer_abs_path, server.clone()));
2783 }
2784 } else {
2785 remote_buffers.get_or_insert(Vec::new()).push(buffer_handle);
2786 }
2787 } else {
2788 return Task::ready(Ok(Default::default()));
2789 }
2790 }
2791
2792 let remote_buffers = self.remote_id().zip(remote_buffers);
2793 let client = self.client.clone();
2794
2795 cx.spawn(|this, mut cx| async move {
2796 let mut project_transaction = ProjectTransaction::default();
2797
2798 if let Some((project_id, remote_buffers)) = remote_buffers {
2799 let response = client
2800 .request(proto::FormatBuffers {
2801 project_id,
2802 trigger: trigger as i32,
2803 buffer_ids: remote_buffers
2804 .iter()
2805 .map(|buffer| buffer.read_with(&cx, |buffer, _| buffer.remote_id()))
2806 .collect(),
2807 })
2808 .await?
2809 .transaction
2810 .ok_or_else(|| anyhow!("missing transaction"))?;
2811 project_transaction = this
2812 .update(&mut cx, |this, cx| {
2813 this.deserialize_project_transaction(response, push_to_history, cx)
2814 })
2815 .await?;
2816 }
2817
2818 // Do not allow multiple concurrent formatting requests for the
2819 // same buffer.
2820 this.update(&mut cx, |this, _| {
2821 local_buffers
2822 .retain(|(buffer, _, _)| this.buffers_being_formatted.insert(buffer.id()));
2823 });
2824 let _cleanup = defer({
2825 let this = this.clone();
2826 let mut cx = cx.clone();
2827 let local_buffers = &local_buffers;
2828 move || {
2829 this.update(&mut cx, |this, _| {
2830 for (buffer, _, _) in local_buffers {
2831 this.buffers_being_formatted.remove(&buffer.id());
2832 }
2833 });
2834 }
2835 });
2836
2837 for (buffer, buffer_abs_path, language_server) in &local_buffers {
2838 let (format_on_save, formatter, tab_size) = buffer.read_with(&cx, |buffer, cx| {
2839 let settings = cx.global::<Settings>();
2840 let language_name = buffer.language().map(|language| language.name());
2841 (
2842 settings.format_on_save(language_name.as_deref()),
2843 settings.formatter(language_name.as_deref()),
2844 settings.tab_size(language_name.as_deref()),
2845 )
2846 });
2847
2848 let transaction = match (formatter, format_on_save) {
2849 (_, FormatOnSave::Off) if trigger == FormatTrigger::Save => continue,
2850
2851 (Formatter::LanguageServer, FormatOnSave::On | FormatOnSave::Off)
2852 | (_, FormatOnSave::LanguageServer) => Self::format_via_lsp(
2853 &this,
2854 &buffer,
2855 &buffer_abs_path,
2856 &language_server,
2857 tab_size,
2858 &mut cx,
2859 )
2860 .await
2861 .context("failed to format via language server")?,
2862
2863 (
2864 Formatter::External { command, arguments },
2865 FormatOnSave::On | FormatOnSave::Off,
2866 )
2867 | (_, FormatOnSave::External { command, arguments }) => {
2868 Self::format_via_external_command(
2869 &buffer,
2870 &buffer_abs_path,
2871 &command,
2872 &arguments,
2873 &mut cx,
2874 )
2875 .await
2876 .context(format!(
2877 "failed to format via external command {:?}",
2878 command
2879 ))?
2880 }
2881 };
2882
2883 if let Some(transaction) = transaction {
2884 if !push_to_history {
2885 buffer.update(&mut cx, |buffer, _| {
2886 buffer.forget_transaction(transaction.id)
2887 });
2888 }
2889 project_transaction.0.insert(buffer.clone(), transaction);
2890 }
2891 }
2892
2893 Ok(project_transaction)
2894 })
2895 }
2896
2897 async fn format_via_lsp(
2898 this: &ModelHandle<Self>,
2899 buffer: &ModelHandle<Buffer>,
2900 abs_path: &Path,
2901 language_server: &Arc<LanguageServer>,
2902 tab_size: NonZeroU32,
2903 cx: &mut AsyncAppContext,
2904 ) -> Result<Option<Transaction>> {
2905 let text_document =
2906 lsp::TextDocumentIdentifier::new(lsp::Url::from_file_path(abs_path).unwrap());
2907 let capabilities = &language_server.capabilities();
2908 let lsp_edits = if capabilities
2909 .document_formatting_provider
2910 .as_ref()
2911 .map_or(false, |provider| *provider != lsp::OneOf::Left(false))
2912 {
2913 language_server
2914 .request::<lsp::request::Formatting>(lsp::DocumentFormattingParams {
2915 text_document,
2916 options: lsp::FormattingOptions {
2917 tab_size: tab_size.into(),
2918 insert_spaces: true,
2919 insert_final_newline: Some(true),
2920 ..Default::default()
2921 },
2922 work_done_progress_params: Default::default(),
2923 })
2924 .await?
2925 } else if capabilities
2926 .document_range_formatting_provider
2927 .as_ref()
2928 .map_or(false, |provider| *provider != lsp::OneOf::Left(false))
2929 {
2930 let buffer_start = lsp::Position::new(0, 0);
2931 let buffer_end =
2932 buffer.read_with(cx, |buffer, _| point_to_lsp(buffer.max_point_utf16()));
2933 language_server
2934 .request::<lsp::request::RangeFormatting>(lsp::DocumentRangeFormattingParams {
2935 text_document,
2936 range: lsp::Range::new(buffer_start, buffer_end),
2937 options: lsp::FormattingOptions {
2938 tab_size: tab_size.into(),
2939 insert_spaces: true,
2940 insert_final_newline: Some(true),
2941 ..Default::default()
2942 },
2943 work_done_progress_params: Default::default(),
2944 })
2945 .await?
2946 } else {
2947 None
2948 };
2949
2950 if let Some(lsp_edits) = lsp_edits {
2951 let edits = this
2952 .update(cx, |this, cx| {
2953 this.edits_from_lsp(buffer, lsp_edits, None, cx)
2954 })
2955 .await?;
2956 buffer.update(cx, |buffer, cx| {
2957 buffer.finalize_last_transaction();
2958 buffer.start_transaction();
2959 for (range, text) in edits {
2960 buffer.edit([(range, text)], None, cx);
2961 }
2962 if buffer.end_transaction(cx).is_some() {
2963 let transaction = buffer.finalize_last_transaction().unwrap().clone();
2964 Ok(Some(transaction))
2965 } else {
2966 Ok(None)
2967 }
2968 })
2969 } else {
2970 Ok(None)
2971 }
2972 }
2973
2974 async fn format_via_external_command(
2975 buffer: &ModelHandle<Buffer>,
2976 buffer_abs_path: &Path,
2977 command: &str,
2978 arguments: &[String],
2979 cx: &mut AsyncAppContext,
2980 ) -> Result<Option<Transaction>> {
2981 let working_dir_path = buffer.read_with(cx, |buffer, cx| {
2982 let file = File::from_dyn(buffer.file())?;
2983 let worktree = file.worktree.read(cx).as_local()?;
2984 let mut worktree_path = worktree.abs_path().to_path_buf();
2985 if worktree.root_entry()?.is_file() {
2986 worktree_path.pop();
2987 }
2988 Some(worktree_path)
2989 });
2990
2991 if let Some(working_dir_path) = working_dir_path {
2992 let mut child =
2993 smol::process::Command::new(command)
2994 .args(arguments.iter().map(|arg| {
2995 arg.replace("{buffer_path}", &buffer_abs_path.to_string_lossy())
2996 }))
2997 .current_dir(&working_dir_path)
2998 .stdin(smol::process::Stdio::piped())
2999 .stdout(smol::process::Stdio::piped())
3000 .stderr(smol::process::Stdio::piped())
3001 .spawn()?;
3002 let stdin = child
3003 .stdin
3004 .as_mut()
3005 .ok_or_else(|| anyhow!("failed to acquire stdin"))?;
3006 let text = buffer.read_with(cx, |buffer, _| buffer.as_rope().clone());
3007 for chunk in text.chunks() {
3008 stdin.write_all(chunk.as_bytes()).await?;
3009 }
3010 stdin.flush().await?;
3011
3012 let output = child.output().await?;
3013 if !output.status.success() {
3014 return Err(anyhow!(
3015 "command failed with exit code {:?}:\nstdout: {}\nstderr: {}",
3016 output.status.code(),
3017 String::from_utf8_lossy(&output.stdout),
3018 String::from_utf8_lossy(&output.stderr),
3019 ));
3020 }
3021
3022 let stdout = String::from_utf8(output.stdout)?;
3023 let diff = buffer
3024 .read_with(cx, |buffer, cx| buffer.diff(stdout, cx))
3025 .await;
3026 Ok(buffer.update(cx, |buffer, cx| buffer.apply_diff(diff, cx).cloned()))
3027 } else {
3028 Ok(None)
3029 }
3030 }
3031
3032 pub fn definition<T: ToPointUtf16>(
3033 &self,
3034 buffer: &ModelHandle<Buffer>,
3035 position: T,
3036 cx: &mut ModelContext<Self>,
3037 ) -> Task<Result<Vec<LocationLink>>> {
3038 let position = position.to_point_utf16(buffer.read(cx));
3039 self.request_lsp(buffer.clone(), GetDefinition { position }, cx)
3040 }
3041
3042 pub fn type_definition<T: ToPointUtf16>(
3043 &self,
3044 buffer: &ModelHandle<Buffer>,
3045 position: T,
3046 cx: &mut ModelContext<Self>,
3047 ) -> Task<Result<Vec<LocationLink>>> {
3048 let position = position.to_point_utf16(buffer.read(cx));
3049 self.request_lsp(buffer.clone(), GetTypeDefinition { position }, cx)
3050 }
3051
3052 pub fn references<T: ToPointUtf16>(
3053 &self,
3054 buffer: &ModelHandle<Buffer>,
3055 position: T,
3056 cx: &mut ModelContext<Self>,
3057 ) -> Task<Result<Vec<Location>>> {
3058 let position = position.to_point_utf16(buffer.read(cx));
3059 self.request_lsp(buffer.clone(), GetReferences { position }, cx)
3060 }
3061
3062 pub fn document_highlights<T: ToPointUtf16>(
3063 &self,
3064 buffer: &ModelHandle<Buffer>,
3065 position: T,
3066 cx: &mut ModelContext<Self>,
3067 ) -> Task<Result<Vec<DocumentHighlight>>> {
3068 let position = position.to_point_utf16(buffer.read(cx));
3069 self.request_lsp(buffer.clone(), GetDocumentHighlights { position }, cx)
3070 }
3071
3072 pub fn symbols(&self, query: &str, cx: &mut ModelContext<Self>) -> Task<Result<Vec<Symbol>>> {
3073 if self.is_local() {
3074 let mut requests = Vec::new();
3075 for ((worktree_id, _), server_id) in self.language_server_ids.iter() {
3076 let worktree_id = *worktree_id;
3077 if let Some(worktree) = self
3078 .worktree_for_id(worktree_id, cx)
3079 .and_then(|worktree| worktree.read(cx).as_local())
3080 {
3081 if let Some(LanguageServerState::Running {
3082 adapter,
3083 language,
3084 server,
3085 }) = self.language_servers.get(server_id)
3086 {
3087 let adapter = adapter.clone();
3088 let language = language.clone();
3089 let worktree_abs_path = worktree.abs_path().clone();
3090 requests.push(
3091 server
3092 .request::<lsp::request::WorkspaceSymbol>(
3093 lsp::WorkspaceSymbolParams {
3094 query: query.to_string(),
3095 ..Default::default()
3096 },
3097 )
3098 .log_err()
3099 .map(move |response| {
3100 (
3101 adapter,
3102 language,
3103 worktree_id,
3104 worktree_abs_path,
3105 response.unwrap_or_default(),
3106 )
3107 }),
3108 );
3109 }
3110 }
3111 }
3112
3113 cx.spawn_weak(|this, cx| async move {
3114 let responses = futures::future::join_all(requests).await;
3115 let this = if let Some(this) = this.upgrade(&cx) {
3116 this
3117 } else {
3118 return Ok(Default::default());
3119 };
3120 let symbols = this.read_with(&cx, |this, cx| {
3121 let mut symbols = Vec::new();
3122 for (
3123 adapter,
3124 adapter_language,
3125 source_worktree_id,
3126 worktree_abs_path,
3127 response,
3128 ) in responses
3129 {
3130 symbols.extend(response.into_iter().flatten().filter_map(|lsp_symbol| {
3131 let abs_path = lsp_symbol.location.uri.to_file_path().ok()?;
3132 let mut worktree_id = source_worktree_id;
3133 let path;
3134 if let Some((worktree, rel_path)) =
3135 this.find_local_worktree(&abs_path, cx)
3136 {
3137 worktree_id = worktree.read(cx).id();
3138 path = rel_path;
3139 } else {
3140 path = relativize_path(&worktree_abs_path, &abs_path);
3141 }
3142
3143 let project_path = ProjectPath {
3144 worktree_id,
3145 path: path.into(),
3146 };
3147 let signature = this.symbol_signature(&project_path);
3148 let language = this
3149 .languages
3150 .select_language(&project_path.path)
3151 .unwrap_or(adapter_language.clone());
3152 let language_server_name = adapter.name.clone();
3153 Some(async move {
3154 let label = language
3155 .label_for_symbol(&lsp_symbol.name, lsp_symbol.kind)
3156 .await;
3157
3158 Symbol {
3159 language_server_name,
3160 source_worktree_id,
3161 path: project_path,
3162 label: label.unwrap_or_else(|| {
3163 CodeLabel::plain(lsp_symbol.name.clone(), None)
3164 }),
3165 kind: lsp_symbol.kind,
3166 name: lsp_symbol.name,
3167 range: range_from_lsp(lsp_symbol.location.range),
3168 signature,
3169 }
3170 })
3171 }));
3172 }
3173 symbols
3174 });
3175 Ok(futures::future::join_all(symbols).await)
3176 })
3177 } else if let Some(project_id) = self.remote_id() {
3178 let request = self.client.request(proto::GetProjectSymbols {
3179 project_id,
3180 query: query.to_string(),
3181 });
3182 cx.spawn_weak(|this, cx| async move {
3183 let response = request.await?;
3184 let mut symbols = Vec::new();
3185 if let Some(this) = this.upgrade(&cx) {
3186 let new_symbols = this.read_with(&cx, |this, _| {
3187 response
3188 .symbols
3189 .into_iter()
3190 .map(|symbol| this.deserialize_symbol(symbol))
3191 .collect::<Vec<_>>()
3192 });
3193 symbols = futures::future::join_all(new_symbols)
3194 .await
3195 .into_iter()
3196 .filter_map(|symbol| symbol.log_err())
3197 .collect::<Vec<_>>();
3198 }
3199 Ok(symbols)
3200 })
3201 } else {
3202 Task::ready(Ok(Default::default()))
3203 }
3204 }
3205
3206 pub fn open_buffer_for_symbol(
3207 &mut self,
3208 symbol: &Symbol,
3209 cx: &mut ModelContext<Self>,
3210 ) -> Task<Result<ModelHandle<Buffer>>> {
3211 if self.is_local() {
3212 let language_server_id = if let Some(id) = self.language_server_ids.get(&(
3213 symbol.source_worktree_id,
3214 symbol.language_server_name.clone(),
3215 )) {
3216 *id
3217 } else {
3218 return Task::ready(Err(anyhow!(
3219 "language server for worktree and language not found"
3220 )));
3221 };
3222
3223 let worktree_abs_path = if let Some(worktree_abs_path) = self
3224 .worktree_for_id(symbol.path.worktree_id, cx)
3225 .and_then(|worktree| worktree.read(cx).as_local())
3226 .map(|local_worktree| local_worktree.abs_path())
3227 {
3228 worktree_abs_path
3229 } else {
3230 return Task::ready(Err(anyhow!("worktree not found for symbol")));
3231 };
3232 let symbol_abs_path = worktree_abs_path.join(&symbol.path.path);
3233 let symbol_uri = if let Ok(uri) = lsp::Url::from_file_path(symbol_abs_path) {
3234 uri
3235 } else {
3236 return Task::ready(Err(anyhow!("invalid symbol path")));
3237 };
3238
3239 self.open_local_buffer_via_lsp(
3240 symbol_uri,
3241 language_server_id,
3242 symbol.language_server_name.clone(),
3243 cx,
3244 )
3245 } else if let Some(project_id) = self.remote_id() {
3246 let request = self.client.request(proto::OpenBufferForSymbol {
3247 project_id,
3248 symbol: Some(serialize_symbol(symbol)),
3249 });
3250 cx.spawn(|this, mut cx| async move {
3251 let response = request.await?;
3252 this.update(&mut cx, |this, cx| {
3253 this.wait_for_buffer(response.buffer_id, cx)
3254 })
3255 .await
3256 })
3257 } else {
3258 Task::ready(Err(anyhow!("project does not have a remote id")))
3259 }
3260 }
3261
3262 pub fn hover<T: ToPointUtf16>(
3263 &self,
3264 buffer: &ModelHandle<Buffer>,
3265 position: T,
3266 cx: &mut ModelContext<Self>,
3267 ) -> Task<Result<Option<Hover>>> {
3268 let position = position.to_point_utf16(buffer.read(cx));
3269 self.request_lsp(buffer.clone(), GetHover { position }, cx)
3270 }
3271
3272 pub fn completions<T: ToPointUtf16>(
3273 &self,
3274 source_buffer_handle: &ModelHandle<Buffer>,
3275 position: T,
3276 cx: &mut ModelContext<Self>,
3277 ) -> Task<Result<Vec<Completion>>> {
3278 let source_buffer_handle = source_buffer_handle.clone();
3279 let source_buffer = source_buffer_handle.read(cx);
3280 let buffer_id = source_buffer.remote_id();
3281 let language = source_buffer.language().cloned();
3282 let worktree;
3283 let buffer_abs_path;
3284 if let Some(file) = File::from_dyn(source_buffer.file()) {
3285 worktree = file.worktree.clone();
3286 buffer_abs_path = file.as_local().map(|f| f.abs_path(cx));
3287 } else {
3288 return Task::ready(Ok(Default::default()));
3289 };
3290
3291 let position = position.to_point_utf16(source_buffer);
3292 let anchor = source_buffer.anchor_after(position);
3293
3294 if worktree.read(cx).as_local().is_some() {
3295 let buffer_abs_path = buffer_abs_path.unwrap();
3296 let lang_server =
3297 if let Some((_, server)) = self.language_server_for_buffer(source_buffer, cx) {
3298 server.clone()
3299 } else {
3300 return Task::ready(Ok(Default::default()));
3301 };
3302
3303 cx.spawn(|_, cx| async move {
3304 let completions = lang_server
3305 .request::<lsp::request::Completion>(lsp::CompletionParams {
3306 text_document_position: lsp::TextDocumentPositionParams::new(
3307 lsp::TextDocumentIdentifier::new(
3308 lsp::Url::from_file_path(buffer_abs_path).unwrap(),
3309 ),
3310 point_to_lsp(position),
3311 ),
3312 context: Default::default(),
3313 work_done_progress_params: Default::default(),
3314 partial_result_params: Default::default(),
3315 })
3316 .await
3317 .context("lsp completion request failed")?;
3318
3319 let completions = if let Some(completions) = completions {
3320 match completions {
3321 lsp::CompletionResponse::Array(completions) => completions,
3322 lsp::CompletionResponse::List(list) => list.items,
3323 }
3324 } else {
3325 Default::default()
3326 };
3327
3328 let completions = source_buffer_handle.read_with(&cx, |this, _| {
3329 let snapshot = this.snapshot();
3330 let clipped_position = this.clip_point_utf16(position, Bias::Left);
3331 let mut range_for_token = None;
3332 completions
3333 .into_iter()
3334 .filter_map(move |mut lsp_completion| {
3335 // For now, we can only handle additional edits if they are returned
3336 // when resolving the completion, not if they are present initially.
3337 if lsp_completion
3338 .additional_text_edits
3339 .as_ref()
3340 .map_or(false, |edits| !edits.is_empty())
3341 {
3342 return None;
3343 }
3344
3345 let (old_range, mut new_text) = match lsp_completion.text_edit.as_ref()
3346 {
3347 // If the language server provides a range to overwrite, then
3348 // check that the range is valid.
3349 Some(lsp::CompletionTextEdit::Edit(edit)) => {
3350 let range = range_from_lsp(edit.range);
3351 let start = snapshot.clip_point_utf16(range.start, Bias::Left);
3352 let end = snapshot.clip_point_utf16(range.end, Bias::Left);
3353 if start != range.start || end != range.end {
3354 log::info!("completion out of expected range");
3355 return None;
3356 }
3357 (
3358 snapshot.anchor_before(start)..snapshot.anchor_after(end),
3359 edit.new_text.clone(),
3360 )
3361 }
3362 // If the language server does not provide a range, then infer
3363 // the range based on the syntax tree.
3364 None => {
3365 if position != clipped_position {
3366 log::info!("completion out of expected range");
3367 return None;
3368 }
3369 let Range { start, end } = range_for_token
3370 .get_or_insert_with(|| {
3371 let offset = position.to_offset(&snapshot);
3372 let (range, kind) = snapshot.surrounding_word(offset);
3373 if kind == Some(CharKind::Word) {
3374 range
3375 } else {
3376 offset..offset
3377 }
3378 })
3379 .clone();
3380 let text = lsp_completion
3381 .insert_text
3382 .as_ref()
3383 .unwrap_or(&lsp_completion.label)
3384 .clone();
3385 (
3386 snapshot.anchor_before(start)..snapshot.anchor_after(end),
3387 text,
3388 )
3389 }
3390 Some(lsp::CompletionTextEdit::InsertAndReplace(_)) => {
3391 log::info!("unsupported insert/replace completion");
3392 return None;
3393 }
3394 };
3395
3396 LineEnding::normalize(&mut new_text);
3397 let language = language.clone();
3398 Some(async move {
3399 let mut label = None;
3400 if let Some(language) = language {
3401 language.process_completion(&mut lsp_completion).await;
3402 label = language.label_for_completion(&lsp_completion).await;
3403 }
3404 Completion {
3405 old_range,
3406 new_text,
3407 label: label.unwrap_or_else(|| {
3408 CodeLabel::plain(
3409 lsp_completion.label.clone(),
3410 lsp_completion.filter_text.as_deref(),
3411 )
3412 }),
3413 lsp_completion,
3414 }
3415 })
3416 })
3417 });
3418
3419 Ok(futures::future::join_all(completions).await)
3420 })
3421 } else if let Some(project_id) = self.remote_id() {
3422 let rpc = self.client.clone();
3423 let message = proto::GetCompletions {
3424 project_id,
3425 buffer_id,
3426 position: Some(language::proto::serialize_anchor(&anchor)),
3427 version: serialize_version(&source_buffer.version()),
3428 };
3429 cx.spawn_weak(|_, mut cx| async move {
3430 let response = rpc.request(message).await?;
3431
3432 source_buffer_handle
3433 .update(&mut cx, |buffer, _| {
3434 buffer.wait_for_version(deserialize_version(response.version))
3435 })
3436 .await;
3437
3438 let completions = response.completions.into_iter().map(|completion| {
3439 language::proto::deserialize_completion(completion, language.clone())
3440 });
3441 futures::future::try_join_all(completions).await
3442 })
3443 } else {
3444 Task::ready(Ok(Default::default()))
3445 }
3446 }
3447
3448 pub fn apply_additional_edits_for_completion(
3449 &self,
3450 buffer_handle: ModelHandle<Buffer>,
3451 completion: Completion,
3452 push_to_history: bool,
3453 cx: &mut ModelContext<Self>,
3454 ) -> Task<Result<Option<Transaction>>> {
3455 let buffer = buffer_handle.read(cx);
3456 let buffer_id = buffer.remote_id();
3457
3458 if self.is_local() {
3459 let lang_server = match self.language_server_for_buffer(buffer, cx) {
3460 Some((_, server)) => server.clone(),
3461 _ => return Task::ready(Ok(Default::default())),
3462 };
3463
3464 cx.spawn(|this, mut cx| async move {
3465 let resolved_completion = lang_server
3466 .request::<lsp::request::ResolveCompletionItem>(completion.lsp_completion)
3467 .await?;
3468
3469 if let Some(edits) = resolved_completion.additional_text_edits {
3470 let edits = this
3471 .update(&mut cx, |this, cx| {
3472 this.edits_from_lsp(&buffer_handle, edits, None, cx)
3473 })
3474 .await?;
3475
3476 buffer_handle.update(&mut cx, |buffer, cx| {
3477 buffer.finalize_last_transaction();
3478 buffer.start_transaction();
3479
3480 for (range, text) in edits {
3481 let primary = &completion.old_range;
3482 let start_within = primary.start.cmp(&range.start, buffer).is_le()
3483 && primary.end.cmp(&range.start, buffer).is_ge();
3484 let end_within = range.start.cmp(&primary.end, buffer).is_le()
3485 && range.end.cmp(&primary.end, buffer).is_ge();
3486
3487 //Skip addtional edits which overlap with the primary completion edit
3488 //https://github.com/zed-industries/zed/pull/1871
3489 if !start_within && !end_within {
3490 buffer.edit([(range, text)], None, cx);
3491 }
3492 }
3493
3494 let transaction = if buffer.end_transaction(cx).is_some() {
3495 let transaction = buffer.finalize_last_transaction().unwrap().clone();
3496 if !push_to_history {
3497 buffer.forget_transaction(transaction.id);
3498 }
3499 Some(transaction)
3500 } else {
3501 None
3502 };
3503 Ok(transaction)
3504 })
3505 } else {
3506 Ok(None)
3507 }
3508 })
3509 } else if let Some(project_id) = self.remote_id() {
3510 let client = self.client.clone();
3511 cx.spawn(|_, mut cx| async move {
3512 let response = client
3513 .request(proto::ApplyCompletionAdditionalEdits {
3514 project_id,
3515 buffer_id,
3516 completion: Some(language::proto::serialize_completion(&completion)),
3517 })
3518 .await?;
3519
3520 if let Some(transaction) = response.transaction {
3521 let transaction = language::proto::deserialize_transaction(transaction)?;
3522 buffer_handle
3523 .update(&mut cx, |buffer, _| {
3524 buffer.wait_for_edits(transaction.edit_ids.iter().copied())
3525 })
3526 .await;
3527 if push_to_history {
3528 buffer_handle.update(&mut cx, |buffer, _| {
3529 buffer.push_transaction(transaction.clone(), Instant::now());
3530 });
3531 }
3532 Ok(Some(transaction))
3533 } else {
3534 Ok(None)
3535 }
3536 })
3537 } else {
3538 Task::ready(Err(anyhow!("project does not have a remote id")))
3539 }
3540 }
3541
3542 pub fn code_actions<T: Clone + ToOffset>(
3543 &self,
3544 buffer_handle: &ModelHandle<Buffer>,
3545 range: Range<T>,
3546 cx: &mut ModelContext<Self>,
3547 ) -> Task<Result<Vec<CodeAction>>> {
3548 let buffer_handle = buffer_handle.clone();
3549 let buffer = buffer_handle.read(cx);
3550 let snapshot = buffer.snapshot();
3551 let relevant_diagnostics = snapshot
3552 .diagnostics_in_range::<usize, usize>(range.to_offset(&snapshot), false)
3553 .map(|entry| entry.to_lsp_diagnostic_stub())
3554 .collect();
3555 let buffer_id = buffer.remote_id();
3556 let worktree;
3557 let buffer_abs_path;
3558 if let Some(file) = File::from_dyn(buffer.file()) {
3559 worktree = file.worktree.clone();
3560 buffer_abs_path = file.as_local().map(|f| f.abs_path(cx));
3561 } else {
3562 return Task::ready(Ok(Default::default()));
3563 };
3564 let range = buffer.anchor_before(range.start)..buffer.anchor_before(range.end);
3565
3566 if worktree.read(cx).as_local().is_some() {
3567 let buffer_abs_path = buffer_abs_path.unwrap();
3568 let lang_server = if let Some((_, server)) = self.language_server_for_buffer(buffer, cx)
3569 {
3570 server.clone()
3571 } else {
3572 return Task::ready(Ok(Default::default()));
3573 };
3574
3575 let lsp_range = range_to_lsp(range.to_point_utf16(buffer));
3576 cx.foreground().spawn(async move {
3577 if lang_server.capabilities().code_action_provider.is_none() {
3578 return Ok(Default::default());
3579 }
3580
3581 Ok(lang_server
3582 .request::<lsp::request::CodeActionRequest>(lsp::CodeActionParams {
3583 text_document: lsp::TextDocumentIdentifier::new(
3584 lsp::Url::from_file_path(buffer_abs_path).unwrap(),
3585 ),
3586 range: lsp_range,
3587 work_done_progress_params: Default::default(),
3588 partial_result_params: Default::default(),
3589 context: lsp::CodeActionContext {
3590 diagnostics: relevant_diagnostics,
3591 only: Some(vec![
3592 lsp::CodeActionKind::EMPTY,
3593 lsp::CodeActionKind::QUICKFIX,
3594 lsp::CodeActionKind::REFACTOR,
3595 lsp::CodeActionKind::REFACTOR_EXTRACT,
3596 lsp::CodeActionKind::SOURCE,
3597 ]),
3598 },
3599 })
3600 .await?
3601 .unwrap_or_default()
3602 .into_iter()
3603 .filter_map(|entry| {
3604 if let lsp::CodeActionOrCommand::CodeAction(lsp_action) = entry {
3605 Some(CodeAction {
3606 range: range.clone(),
3607 lsp_action,
3608 })
3609 } else {
3610 None
3611 }
3612 })
3613 .collect())
3614 })
3615 } else if let Some(project_id) = self.remote_id() {
3616 let rpc = self.client.clone();
3617 let version = buffer.version();
3618 cx.spawn_weak(|_, mut cx| async move {
3619 let response = rpc
3620 .request(proto::GetCodeActions {
3621 project_id,
3622 buffer_id,
3623 start: Some(language::proto::serialize_anchor(&range.start)),
3624 end: Some(language::proto::serialize_anchor(&range.end)),
3625 version: serialize_version(&version),
3626 })
3627 .await?;
3628
3629 buffer_handle
3630 .update(&mut cx, |buffer, _| {
3631 buffer.wait_for_version(deserialize_version(response.version))
3632 })
3633 .await;
3634
3635 response
3636 .actions
3637 .into_iter()
3638 .map(language::proto::deserialize_code_action)
3639 .collect()
3640 })
3641 } else {
3642 Task::ready(Ok(Default::default()))
3643 }
3644 }
3645
3646 pub fn apply_code_action(
3647 &self,
3648 buffer_handle: ModelHandle<Buffer>,
3649 mut action: CodeAction,
3650 push_to_history: bool,
3651 cx: &mut ModelContext<Self>,
3652 ) -> Task<Result<ProjectTransaction>> {
3653 if self.is_local() {
3654 let buffer = buffer_handle.read(cx);
3655 let (lsp_adapter, lang_server) =
3656 if let Some((adapter, server)) = self.language_server_for_buffer(buffer, cx) {
3657 (adapter.clone(), server.clone())
3658 } else {
3659 return Task::ready(Ok(Default::default()));
3660 };
3661 let range = action.range.to_point_utf16(buffer);
3662
3663 cx.spawn(|this, mut cx| async move {
3664 if let Some(lsp_range) = action
3665 .lsp_action
3666 .data
3667 .as_mut()
3668 .and_then(|d| d.get_mut("codeActionParams"))
3669 .and_then(|d| d.get_mut("range"))
3670 {
3671 *lsp_range = serde_json::to_value(&range_to_lsp(range)).unwrap();
3672 action.lsp_action = lang_server
3673 .request::<lsp::request::CodeActionResolveRequest>(action.lsp_action)
3674 .await?;
3675 } else {
3676 let actions = this
3677 .update(&mut cx, |this, cx| {
3678 this.code_actions(&buffer_handle, action.range, cx)
3679 })
3680 .await?;
3681 action.lsp_action = actions
3682 .into_iter()
3683 .find(|a| a.lsp_action.title == action.lsp_action.title)
3684 .ok_or_else(|| anyhow!("code action is outdated"))?
3685 .lsp_action;
3686 }
3687
3688 if let Some(edit) = action.lsp_action.edit {
3689 if edit.changes.is_some() || edit.document_changes.is_some() {
3690 return Self::deserialize_workspace_edit(
3691 this,
3692 edit,
3693 push_to_history,
3694 lsp_adapter.clone(),
3695 lang_server.clone(),
3696 &mut cx,
3697 )
3698 .await;
3699 }
3700 }
3701
3702 if let Some(command) = action.lsp_action.command {
3703 this.update(&mut cx, |this, _| {
3704 this.last_workspace_edits_by_language_server
3705 .remove(&lang_server.server_id());
3706 });
3707 lang_server
3708 .request::<lsp::request::ExecuteCommand>(lsp::ExecuteCommandParams {
3709 command: command.command,
3710 arguments: command.arguments.unwrap_or_default(),
3711 ..Default::default()
3712 })
3713 .await?;
3714 return Ok(this.update(&mut cx, |this, _| {
3715 this.last_workspace_edits_by_language_server
3716 .remove(&lang_server.server_id())
3717 .unwrap_or_default()
3718 }));
3719 }
3720
3721 Ok(ProjectTransaction::default())
3722 })
3723 } else if let Some(project_id) = self.remote_id() {
3724 let client = self.client.clone();
3725 let request = proto::ApplyCodeAction {
3726 project_id,
3727 buffer_id: buffer_handle.read(cx).remote_id(),
3728 action: Some(language::proto::serialize_code_action(&action)),
3729 };
3730 cx.spawn(|this, mut cx| async move {
3731 let response = client
3732 .request(request)
3733 .await?
3734 .transaction
3735 .ok_or_else(|| anyhow!("missing transaction"))?;
3736 this.update(&mut cx, |this, cx| {
3737 this.deserialize_project_transaction(response, push_to_history, cx)
3738 })
3739 .await
3740 })
3741 } else {
3742 Task::ready(Err(anyhow!("project does not have a remote id")))
3743 }
3744 }
3745
3746 async fn deserialize_workspace_edit(
3747 this: ModelHandle<Self>,
3748 edit: lsp::WorkspaceEdit,
3749 push_to_history: bool,
3750 lsp_adapter: Arc<CachedLspAdapter>,
3751 language_server: Arc<LanguageServer>,
3752 cx: &mut AsyncAppContext,
3753 ) -> Result<ProjectTransaction> {
3754 let fs = this.read_with(cx, |this, _| this.fs.clone());
3755 let mut operations = Vec::new();
3756 if let Some(document_changes) = edit.document_changes {
3757 match document_changes {
3758 lsp::DocumentChanges::Edits(edits) => {
3759 operations.extend(edits.into_iter().map(lsp::DocumentChangeOperation::Edit))
3760 }
3761 lsp::DocumentChanges::Operations(ops) => operations = ops,
3762 }
3763 } else if let Some(changes) = edit.changes {
3764 operations.extend(changes.into_iter().map(|(uri, edits)| {
3765 lsp::DocumentChangeOperation::Edit(lsp::TextDocumentEdit {
3766 text_document: lsp::OptionalVersionedTextDocumentIdentifier {
3767 uri,
3768 version: None,
3769 },
3770 edits: edits.into_iter().map(lsp::OneOf::Left).collect(),
3771 })
3772 }));
3773 }
3774
3775 let mut project_transaction = ProjectTransaction::default();
3776 for operation in operations {
3777 match operation {
3778 lsp::DocumentChangeOperation::Op(lsp::ResourceOp::Create(op)) => {
3779 let abs_path = op
3780 .uri
3781 .to_file_path()
3782 .map_err(|_| anyhow!("can't convert URI to path"))?;
3783
3784 if let Some(parent_path) = abs_path.parent() {
3785 fs.create_dir(parent_path).await?;
3786 }
3787 if abs_path.ends_with("/") {
3788 fs.create_dir(&abs_path).await?;
3789 } else {
3790 fs.create_file(&abs_path, op.options.map(Into::into).unwrap_or_default())
3791 .await?;
3792 }
3793 }
3794 lsp::DocumentChangeOperation::Op(lsp::ResourceOp::Rename(op)) => {
3795 let source_abs_path = op
3796 .old_uri
3797 .to_file_path()
3798 .map_err(|_| anyhow!("can't convert URI to path"))?;
3799 let target_abs_path = op
3800 .new_uri
3801 .to_file_path()
3802 .map_err(|_| anyhow!("can't convert URI to path"))?;
3803 fs.rename(
3804 &source_abs_path,
3805 &target_abs_path,
3806 op.options.map(Into::into).unwrap_or_default(),
3807 )
3808 .await?;
3809 }
3810 lsp::DocumentChangeOperation::Op(lsp::ResourceOp::Delete(op)) => {
3811 let abs_path = op
3812 .uri
3813 .to_file_path()
3814 .map_err(|_| anyhow!("can't convert URI to path"))?;
3815 let options = op.options.map(Into::into).unwrap_or_default();
3816 if abs_path.ends_with("/") {
3817 fs.remove_dir(&abs_path, options).await?;
3818 } else {
3819 fs.remove_file(&abs_path, options).await?;
3820 }
3821 }
3822 lsp::DocumentChangeOperation::Edit(op) => {
3823 let buffer_to_edit = this
3824 .update(cx, |this, cx| {
3825 this.open_local_buffer_via_lsp(
3826 op.text_document.uri,
3827 language_server.server_id(),
3828 lsp_adapter.name.clone(),
3829 cx,
3830 )
3831 })
3832 .await?;
3833
3834 let edits = this
3835 .update(cx, |this, cx| {
3836 let edits = op.edits.into_iter().map(|edit| match edit {
3837 lsp::OneOf::Left(edit) => edit,
3838 lsp::OneOf::Right(edit) => edit.text_edit,
3839 });
3840 this.edits_from_lsp(
3841 &buffer_to_edit,
3842 edits,
3843 op.text_document.version,
3844 cx,
3845 )
3846 })
3847 .await?;
3848
3849 let transaction = buffer_to_edit.update(cx, |buffer, cx| {
3850 buffer.finalize_last_transaction();
3851 buffer.start_transaction();
3852 for (range, text) in edits {
3853 buffer.edit([(range, text)], None, cx);
3854 }
3855 let transaction = if buffer.end_transaction(cx).is_some() {
3856 let transaction = buffer.finalize_last_transaction().unwrap().clone();
3857 if !push_to_history {
3858 buffer.forget_transaction(transaction.id);
3859 }
3860 Some(transaction)
3861 } else {
3862 None
3863 };
3864
3865 transaction
3866 });
3867 if let Some(transaction) = transaction {
3868 project_transaction.0.insert(buffer_to_edit, transaction);
3869 }
3870 }
3871 }
3872 }
3873
3874 Ok(project_transaction)
3875 }
3876
3877 pub fn prepare_rename<T: ToPointUtf16>(
3878 &self,
3879 buffer: ModelHandle<Buffer>,
3880 position: T,
3881 cx: &mut ModelContext<Self>,
3882 ) -> Task<Result<Option<Range<Anchor>>>> {
3883 let position = position.to_point_utf16(buffer.read(cx));
3884 self.request_lsp(buffer, PrepareRename { position }, cx)
3885 }
3886
3887 pub fn perform_rename<T: ToPointUtf16>(
3888 &self,
3889 buffer: ModelHandle<Buffer>,
3890 position: T,
3891 new_name: String,
3892 push_to_history: bool,
3893 cx: &mut ModelContext<Self>,
3894 ) -> Task<Result<ProjectTransaction>> {
3895 let position = position.to_point_utf16(buffer.read(cx));
3896 self.request_lsp(
3897 buffer,
3898 PerformRename {
3899 position,
3900 new_name,
3901 push_to_history,
3902 },
3903 cx,
3904 )
3905 }
3906
3907 #[allow(clippy::type_complexity)]
3908 pub fn search(
3909 &self,
3910 query: SearchQuery,
3911 cx: &mut ModelContext<Self>,
3912 ) -> Task<Result<HashMap<ModelHandle<Buffer>, Vec<Range<Anchor>>>>> {
3913 if self.is_local() {
3914 let snapshots = self
3915 .visible_worktrees(cx)
3916 .filter_map(|tree| {
3917 let tree = tree.read(cx).as_local()?;
3918 Some(tree.snapshot())
3919 })
3920 .collect::<Vec<_>>();
3921
3922 let background = cx.background().clone();
3923 let path_count: usize = snapshots.iter().map(|s| s.visible_file_count()).sum();
3924 if path_count == 0 {
3925 return Task::ready(Ok(Default::default()));
3926 }
3927 let workers = background.num_cpus().min(path_count);
3928 let (matching_paths_tx, mut matching_paths_rx) = smol::channel::bounded(1024);
3929 cx.background()
3930 .spawn({
3931 let fs = self.fs.clone();
3932 let background = cx.background().clone();
3933 let query = query.clone();
3934 async move {
3935 let fs = &fs;
3936 let query = &query;
3937 let matching_paths_tx = &matching_paths_tx;
3938 let paths_per_worker = (path_count + workers - 1) / workers;
3939 let snapshots = &snapshots;
3940 background
3941 .scoped(|scope| {
3942 for worker_ix in 0..workers {
3943 let worker_start_ix = worker_ix * paths_per_worker;
3944 let worker_end_ix = worker_start_ix + paths_per_worker;
3945 scope.spawn(async move {
3946 let mut snapshot_start_ix = 0;
3947 let mut abs_path = PathBuf::new();
3948 for snapshot in snapshots {
3949 let snapshot_end_ix =
3950 snapshot_start_ix + snapshot.visible_file_count();
3951 if worker_end_ix <= snapshot_start_ix {
3952 break;
3953 } else if worker_start_ix > snapshot_end_ix {
3954 snapshot_start_ix = snapshot_end_ix;
3955 continue;
3956 } else {
3957 let start_in_snapshot = worker_start_ix
3958 .saturating_sub(snapshot_start_ix);
3959 let end_in_snapshot =
3960 cmp::min(worker_end_ix, snapshot_end_ix)
3961 - snapshot_start_ix;
3962
3963 for entry in snapshot
3964 .files(false, start_in_snapshot)
3965 .take(end_in_snapshot - start_in_snapshot)
3966 {
3967 if matching_paths_tx.is_closed() {
3968 break;
3969 }
3970
3971 abs_path.clear();
3972 abs_path.push(&snapshot.abs_path());
3973 abs_path.push(&entry.path);
3974 let matches = if let Some(file) =
3975 fs.open_sync(&abs_path).await.log_err()
3976 {
3977 query.detect(file).unwrap_or(false)
3978 } else {
3979 false
3980 };
3981
3982 if matches {
3983 let project_path =
3984 (snapshot.id(), entry.path.clone());
3985 if matching_paths_tx
3986 .send(project_path)
3987 .await
3988 .is_err()
3989 {
3990 break;
3991 }
3992 }
3993 }
3994
3995 snapshot_start_ix = snapshot_end_ix;
3996 }
3997 }
3998 });
3999 }
4000 })
4001 .await;
4002 }
4003 })
4004 .detach();
4005
4006 let (buffers_tx, buffers_rx) = smol::channel::bounded(1024);
4007 let open_buffers = self
4008 .opened_buffers
4009 .values()
4010 .filter_map(|b| b.upgrade(cx))
4011 .collect::<HashSet<_>>();
4012 cx.spawn(|this, cx| async move {
4013 for buffer in &open_buffers {
4014 let snapshot = buffer.read_with(&cx, |buffer, _| buffer.snapshot());
4015 buffers_tx.send((buffer.clone(), snapshot)).await?;
4016 }
4017
4018 let open_buffers = Rc::new(RefCell::new(open_buffers));
4019 while let Some(project_path) = matching_paths_rx.next().await {
4020 if buffers_tx.is_closed() {
4021 break;
4022 }
4023
4024 let this = this.clone();
4025 let open_buffers = open_buffers.clone();
4026 let buffers_tx = buffers_tx.clone();
4027 cx.spawn(|mut cx| async move {
4028 if let Some(buffer) = this
4029 .update(&mut cx, |this, cx| this.open_buffer(project_path, cx))
4030 .await
4031 .log_err()
4032 {
4033 if open_buffers.borrow_mut().insert(buffer.clone()) {
4034 let snapshot = buffer.read_with(&cx, |buffer, _| buffer.snapshot());
4035 buffers_tx.send((buffer, snapshot)).await?;
4036 }
4037 }
4038
4039 Ok::<_, anyhow::Error>(())
4040 })
4041 .detach();
4042 }
4043
4044 Ok::<_, anyhow::Error>(())
4045 })
4046 .detach_and_log_err(cx);
4047
4048 let background = cx.background().clone();
4049 cx.background().spawn(async move {
4050 let query = &query;
4051 let mut matched_buffers = Vec::new();
4052 for _ in 0..workers {
4053 matched_buffers.push(HashMap::default());
4054 }
4055 background
4056 .scoped(|scope| {
4057 for worker_matched_buffers in matched_buffers.iter_mut() {
4058 let mut buffers_rx = buffers_rx.clone();
4059 scope.spawn(async move {
4060 while let Some((buffer, snapshot)) = buffers_rx.next().await {
4061 let buffer_matches = query
4062 .search(snapshot.as_rope())
4063 .await
4064 .iter()
4065 .map(|range| {
4066 snapshot.anchor_before(range.start)
4067 ..snapshot.anchor_after(range.end)
4068 })
4069 .collect::<Vec<_>>();
4070 if !buffer_matches.is_empty() {
4071 worker_matched_buffers
4072 .insert(buffer.clone(), buffer_matches);
4073 }
4074 }
4075 });
4076 }
4077 })
4078 .await;
4079 Ok(matched_buffers.into_iter().flatten().collect())
4080 })
4081 } else if let Some(project_id) = self.remote_id() {
4082 let request = self.client.request(query.to_proto(project_id));
4083 cx.spawn(|this, mut cx| async move {
4084 let response = request.await?;
4085 let mut result = HashMap::default();
4086 for location in response.locations {
4087 let target_buffer = this
4088 .update(&mut cx, |this, cx| {
4089 this.wait_for_buffer(location.buffer_id, cx)
4090 })
4091 .await?;
4092 let start = location
4093 .start
4094 .and_then(deserialize_anchor)
4095 .ok_or_else(|| anyhow!("missing target start"))?;
4096 let end = location
4097 .end
4098 .and_then(deserialize_anchor)
4099 .ok_or_else(|| anyhow!("missing target end"))?;
4100 result
4101 .entry(target_buffer)
4102 .or_insert(Vec::new())
4103 .push(start..end)
4104 }
4105 Ok(result)
4106 })
4107 } else {
4108 Task::ready(Ok(Default::default()))
4109 }
4110 }
4111
4112 fn request_lsp<R: LspCommand>(
4113 &self,
4114 buffer_handle: ModelHandle<Buffer>,
4115 request: R,
4116 cx: &mut ModelContext<Self>,
4117 ) -> Task<Result<R::Response>>
4118 where
4119 <R::LspRequest as lsp::request::Request>::Result: Send,
4120 {
4121 let buffer = buffer_handle.read(cx);
4122 if self.is_local() {
4123 let file = File::from_dyn(buffer.file()).and_then(File::as_local);
4124 if let Some((file, language_server)) = file.zip(
4125 self.language_server_for_buffer(buffer, cx)
4126 .map(|(_, server)| server.clone()),
4127 ) {
4128 let lsp_params = request.to_lsp(&file.abs_path(cx), cx);
4129 return cx.spawn(|this, cx| async move {
4130 if !request.check_capabilities(language_server.capabilities()) {
4131 return Ok(Default::default());
4132 }
4133
4134 let response = language_server
4135 .request::<R::LspRequest>(lsp_params)
4136 .await
4137 .context("lsp request failed")?;
4138 request
4139 .response_from_lsp(response, this, buffer_handle, cx)
4140 .await
4141 });
4142 }
4143 } else if let Some(project_id) = self.remote_id() {
4144 let rpc = self.client.clone();
4145 let message = request.to_proto(project_id, buffer);
4146 return cx.spawn(|this, cx| async move {
4147 let response = rpc.request(message).await?;
4148 request
4149 .response_from_proto(response, this, buffer_handle, cx)
4150 .await
4151 });
4152 }
4153 Task::ready(Ok(Default::default()))
4154 }
4155
4156 pub fn find_or_create_local_worktree(
4157 &mut self,
4158 abs_path: impl AsRef<Path>,
4159 visible: bool,
4160 cx: &mut ModelContext<Self>,
4161 ) -> Task<Result<(ModelHandle<Worktree>, PathBuf)>> {
4162 let abs_path = abs_path.as_ref();
4163 if let Some((tree, relative_path)) = self.find_local_worktree(abs_path, cx) {
4164 Task::ready(Ok((tree, relative_path)))
4165 } else {
4166 let worktree = self.create_local_worktree(abs_path, visible, cx);
4167 cx.foreground()
4168 .spawn(async move { Ok((worktree.await?, PathBuf::new())) })
4169 }
4170 }
4171
4172 pub fn find_local_worktree(
4173 &self,
4174 abs_path: &Path,
4175 cx: &AppContext,
4176 ) -> Option<(ModelHandle<Worktree>, PathBuf)> {
4177 for tree in &self.worktrees {
4178 if let Some(tree) = tree.upgrade(cx) {
4179 if let Some(relative_path) = tree
4180 .read(cx)
4181 .as_local()
4182 .and_then(|t| abs_path.strip_prefix(t.abs_path()).ok())
4183 {
4184 return Some((tree.clone(), relative_path.into()));
4185 }
4186 }
4187 }
4188 None
4189 }
4190
4191 pub fn is_shared(&self) -> bool {
4192 match &self.client_state {
4193 Some(ProjectClientState::Local { .. }) => true,
4194 _ => false,
4195 }
4196 }
4197
4198 fn create_local_worktree(
4199 &mut self,
4200 abs_path: impl AsRef<Path>,
4201 visible: bool,
4202 cx: &mut ModelContext<Self>,
4203 ) -> Task<Result<ModelHandle<Worktree>>> {
4204 let fs = self.fs.clone();
4205 let client = self.client.clone();
4206 let next_entry_id = self.next_entry_id.clone();
4207 let path: Arc<Path> = abs_path.as_ref().into();
4208 let task = self
4209 .loading_local_worktrees
4210 .entry(path.clone())
4211 .or_insert_with(|| {
4212 cx.spawn(|project, mut cx| {
4213 async move {
4214 let worktree = Worktree::local(
4215 client.clone(),
4216 path.clone(),
4217 visible,
4218 fs,
4219 next_entry_id,
4220 &mut cx,
4221 )
4222 .await;
4223 project.update(&mut cx, |project, _| {
4224 project.loading_local_worktrees.remove(&path);
4225 });
4226 let worktree = worktree?;
4227
4228 let project_id = project.update(&mut cx, |project, cx| {
4229 project.add_worktree(&worktree, cx);
4230 project.remote_id()
4231 });
4232
4233 if let Some(project_id) = project_id {
4234 worktree
4235 .update(&mut cx, |worktree, cx| {
4236 worktree.as_local_mut().unwrap().share(project_id, cx)
4237 })
4238 .await
4239 .log_err();
4240 }
4241
4242 Ok(worktree)
4243 }
4244 .map_err(Arc::new)
4245 })
4246 .shared()
4247 })
4248 .clone();
4249 cx.foreground().spawn(async move {
4250 match task.await {
4251 Ok(worktree) => Ok(worktree),
4252 Err(err) => Err(anyhow!("{}", err)),
4253 }
4254 })
4255 }
4256
4257 pub fn remove_worktree(&mut self, id_to_remove: WorktreeId, cx: &mut ModelContext<Self>) {
4258 self.worktrees.retain(|worktree| {
4259 if let Some(worktree) = worktree.upgrade(cx) {
4260 let id = worktree.read(cx).id();
4261 if id == id_to_remove {
4262 cx.emit(Event::WorktreeRemoved(id));
4263 false
4264 } else {
4265 true
4266 }
4267 } else {
4268 false
4269 }
4270 });
4271 self.metadata_changed(cx);
4272 cx.notify();
4273 }
4274
4275 fn add_worktree(&mut self, worktree: &ModelHandle<Worktree>, cx: &mut ModelContext<Self>) {
4276 cx.observe(worktree, |_, _, cx| cx.notify()).detach();
4277 if worktree.read(cx).is_local() {
4278 cx.subscribe(worktree, |this, worktree, event, cx| match event {
4279 worktree::Event::UpdatedEntries => this.update_local_worktree_buffers(worktree, cx),
4280 worktree::Event::UpdatedGitRepositories(updated_repos) => {
4281 this.update_local_worktree_buffers_git_repos(worktree, updated_repos, cx)
4282 }
4283 })
4284 .detach();
4285 }
4286
4287 let push_strong_handle = {
4288 let worktree = worktree.read(cx);
4289 self.is_shared() || worktree.is_visible() || worktree.is_remote()
4290 };
4291 if push_strong_handle {
4292 self.worktrees
4293 .push(WorktreeHandle::Strong(worktree.clone()));
4294 } else {
4295 self.worktrees
4296 .push(WorktreeHandle::Weak(worktree.downgrade()));
4297 }
4298
4299 self.metadata_changed(cx);
4300 cx.observe_release(worktree, |this, worktree, cx| {
4301 this.remove_worktree(worktree.id(), cx);
4302 cx.notify();
4303 })
4304 .detach();
4305
4306 cx.emit(Event::WorktreeAdded);
4307 cx.notify();
4308 }
4309
4310 fn update_local_worktree_buffers(
4311 &mut self,
4312 worktree_handle: ModelHandle<Worktree>,
4313 cx: &mut ModelContext<Self>,
4314 ) {
4315 let snapshot = worktree_handle.read(cx).snapshot();
4316 let mut buffers_to_delete = Vec::new();
4317 let mut renamed_buffers = Vec::new();
4318 for (buffer_id, buffer) in &self.opened_buffers {
4319 if let Some(buffer) = buffer.upgrade(cx) {
4320 buffer.update(cx, |buffer, cx| {
4321 if let Some(old_file) = File::from_dyn(buffer.file()) {
4322 if old_file.worktree != worktree_handle {
4323 return;
4324 }
4325
4326 let new_file = if let Some(entry) = snapshot.entry_for_id(old_file.entry_id)
4327 {
4328 File {
4329 is_local: true,
4330 entry_id: entry.id,
4331 mtime: entry.mtime,
4332 path: entry.path.clone(),
4333 worktree: worktree_handle.clone(),
4334 is_deleted: false,
4335 }
4336 } else if let Some(entry) =
4337 snapshot.entry_for_path(old_file.path().as_ref())
4338 {
4339 File {
4340 is_local: true,
4341 entry_id: entry.id,
4342 mtime: entry.mtime,
4343 path: entry.path.clone(),
4344 worktree: worktree_handle.clone(),
4345 is_deleted: false,
4346 }
4347 } else {
4348 File {
4349 is_local: true,
4350 entry_id: old_file.entry_id,
4351 path: old_file.path().clone(),
4352 mtime: old_file.mtime(),
4353 worktree: worktree_handle.clone(),
4354 is_deleted: true,
4355 }
4356 };
4357
4358 let old_path = old_file.abs_path(cx);
4359 if new_file.abs_path(cx) != old_path {
4360 renamed_buffers.push((cx.handle(), old_path));
4361 }
4362
4363 if let Some(project_id) = self.remote_id() {
4364 self.client
4365 .send(proto::UpdateBufferFile {
4366 project_id,
4367 buffer_id: *buffer_id as u64,
4368 file: Some(new_file.to_proto()),
4369 })
4370 .log_err();
4371 }
4372 buffer.file_updated(Arc::new(new_file), cx).detach();
4373 }
4374 });
4375 } else {
4376 buffers_to_delete.push(*buffer_id);
4377 }
4378 }
4379
4380 for buffer_id in buffers_to_delete {
4381 self.opened_buffers.remove(&buffer_id);
4382 }
4383
4384 for (buffer, old_path) in renamed_buffers {
4385 self.unregister_buffer_from_language_server(&buffer, old_path, cx);
4386 self.assign_language_to_buffer(&buffer, cx);
4387 self.register_buffer_with_language_server(&buffer, cx);
4388 }
4389 }
4390
4391 fn update_local_worktree_buffers_git_repos(
4392 &mut self,
4393 worktree: ModelHandle<Worktree>,
4394 repos: &[GitRepositoryEntry],
4395 cx: &mut ModelContext<Self>,
4396 ) {
4397 for (_, buffer) in &self.opened_buffers {
4398 if let Some(buffer) = buffer.upgrade(cx) {
4399 let file = match File::from_dyn(buffer.read(cx).file()) {
4400 Some(file) => file,
4401 None => continue,
4402 };
4403 if file.worktree != worktree {
4404 continue;
4405 }
4406
4407 let path = file.path().clone();
4408
4409 let repo = match repos.iter().find(|repo| repo.manages(&path)) {
4410 Some(repo) => repo.clone(),
4411 None => return,
4412 };
4413
4414 let relative_repo = match path.strip_prefix(repo.content_path) {
4415 Ok(relative_repo) => relative_repo.to_owned(),
4416 Err(_) => return,
4417 };
4418
4419 let remote_id = self.remote_id();
4420 let client = self.client.clone();
4421
4422 cx.spawn(|_, mut cx| async move {
4423 let diff_base = cx
4424 .background()
4425 .spawn(async move { repo.repo.lock().load_index_text(&relative_repo) })
4426 .await;
4427
4428 let buffer_id = buffer.update(&mut cx, |buffer, cx| {
4429 buffer.set_diff_base(diff_base.clone(), cx);
4430 buffer.remote_id()
4431 });
4432
4433 if let Some(project_id) = remote_id {
4434 client
4435 .send(proto::UpdateDiffBase {
4436 project_id,
4437 buffer_id: buffer_id as u64,
4438 diff_base,
4439 })
4440 .log_err();
4441 }
4442 })
4443 .detach();
4444 }
4445 }
4446 }
4447
4448 pub fn set_active_path(&mut self, entry: Option<ProjectPath>, cx: &mut ModelContext<Self>) {
4449 let new_active_entry = entry.and_then(|project_path| {
4450 let worktree = self.worktree_for_id(project_path.worktree_id, cx)?;
4451 let entry = worktree.read(cx).entry_for_path(project_path.path)?;
4452 Some(entry.id)
4453 });
4454 if new_active_entry != self.active_entry {
4455 self.active_entry = new_active_entry;
4456 cx.emit(Event::ActiveEntryChanged(new_active_entry));
4457 }
4458 }
4459
4460 pub fn language_servers_running_disk_based_diagnostics(
4461 &self,
4462 ) -> impl Iterator<Item = usize> + '_ {
4463 self.language_server_statuses
4464 .iter()
4465 .filter_map(|(id, status)| {
4466 if status.has_pending_diagnostic_updates {
4467 Some(*id)
4468 } else {
4469 None
4470 }
4471 })
4472 }
4473
4474 pub fn diagnostic_summary(&self, cx: &AppContext) -> DiagnosticSummary {
4475 let mut summary = DiagnosticSummary::default();
4476 for (_, path_summary) in self.diagnostic_summaries(cx) {
4477 summary.error_count += path_summary.error_count;
4478 summary.warning_count += path_summary.warning_count;
4479 }
4480 summary
4481 }
4482
4483 pub fn diagnostic_summaries<'a>(
4484 &'a self,
4485 cx: &'a AppContext,
4486 ) -> impl Iterator<Item = (ProjectPath, DiagnosticSummary)> + 'a {
4487 self.visible_worktrees(cx).flat_map(move |worktree| {
4488 let worktree = worktree.read(cx);
4489 let worktree_id = worktree.id();
4490 worktree
4491 .diagnostic_summaries()
4492 .map(move |(path, summary)| (ProjectPath { worktree_id, path }, summary))
4493 })
4494 }
4495
4496 pub fn disk_based_diagnostics_started(
4497 &mut self,
4498 language_server_id: usize,
4499 cx: &mut ModelContext<Self>,
4500 ) {
4501 cx.emit(Event::DiskBasedDiagnosticsStarted { language_server_id });
4502 }
4503
4504 pub fn disk_based_diagnostics_finished(
4505 &mut self,
4506 language_server_id: usize,
4507 cx: &mut ModelContext<Self>,
4508 ) {
4509 cx.emit(Event::DiskBasedDiagnosticsFinished { language_server_id });
4510 }
4511
4512 pub fn active_entry(&self) -> Option<ProjectEntryId> {
4513 self.active_entry
4514 }
4515
4516 pub fn entry_for_path(&self, path: &ProjectPath, cx: &AppContext) -> Option<Entry> {
4517 self.worktree_for_id(path.worktree_id, cx)?
4518 .read(cx)
4519 .entry_for_path(&path.path)
4520 .cloned()
4521 }
4522
4523 pub fn path_for_entry(&self, entry_id: ProjectEntryId, cx: &AppContext) -> Option<ProjectPath> {
4524 let worktree = self.worktree_for_entry(entry_id, cx)?;
4525 let worktree = worktree.read(cx);
4526 let worktree_id = worktree.id();
4527 let path = worktree.entry_for_id(entry_id)?.path.clone();
4528 Some(ProjectPath { worktree_id, path })
4529 }
4530
4531 // RPC message handlers
4532
4533 async fn handle_unshare_project(
4534 this: ModelHandle<Self>,
4535 _: TypedEnvelope<proto::UnshareProject>,
4536 _: Arc<Client>,
4537 mut cx: AsyncAppContext,
4538 ) -> Result<()> {
4539 this.update(&mut cx, |this, cx| {
4540 if this.is_local() {
4541 this.unshare(cx)?;
4542 } else {
4543 this.disconnected_from_host(cx);
4544 }
4545 Ok(())
4546 })
4547 }
4548
4549 async fn handle_add_collaborator(
4550 this: ModelHandle<Self>,
4551 mut envelope: TypedEnvelope<proto::AddProjectCollaborator>,
4552 _: Arc<Client>,
4553 mut cx: AsyncAppContext,
4554 ) -> Result<()> {
4555 let collaborator = envelope
4556 .payload
4557 .collaborator
4558 .take()
4559 .ok_or_else(|| anyhow!("empty collaborator"))?;
4560
4561 let collaborator = Collaborator::from_proto(collaborator);
4562 this.update(&mut cx, |this, cx| {
4563 this.collaborators
4564 .insert(collaborator.peer_id, collaborator);
4565 cx.notify();
4566 });
4567
4568 Ok(())
4569 }
4570
4571 async fn handle_remove_collaborator(
4572 this: ModelHandle<Self>,
4573 envelope: TypedEnvelope<proto::RemoveProjectCollaborator>,
4574 _: Arc<Client>,
4575 mut cx: AsyncAppContext,
4576 ) -> Result<()> {
4577 this.update(&mut cx, |this, cx| {
4578 let peer_id = PeerId(envelope.payload.peer_id);
4579 let replica_id = this
4580 .collaborators
4581 .remove(&peer_id)
4582 .ok_or_else(|| anyhow!("unknown peer {:?}", peer_id))?
4583 .replica_id;
4584 for buffer in this.opened_buffers.values() {
4585 if let Some(buffer) = buffer.upgrade(cx) {
4586 buffer.update(cx, |buffer, cx| buffer.remove_peer(replica_id, cx));
4587 }
4588 }
4589 this.shared_buffers.remove(&peer_id);
4590
4591 cx.emit(Event::CollaboratorLeft(peer_id));
4592 cx.notify();
4593 Ok(())
4594 })
4595 }
4596
4597 async fn handle_update_project(
4598 this: ModelHandle<Self>,
4599 envelope: TypedEnvelope<proto::UpdateProject>,
4600 client: Arc<Client>,
4601 mut cx: AsyncAppContext,
4602 ) -> Result<()> {
4603 this.update(&mut cx, |this, cx| {
4604 let replica_id = this.replica_id();
4605 let remote_id = this.remote_id().ok_or_else(|| anyhow!("invalid project"))?;
4606
4607 let mut old_worktrees_by_id = this
4608 .worktrees
4609 .drain(..)
4610 .filter_map(|worktree| {
4611 let worktree = worktree.upgrade(cx)?;
4612 Some((worktree.read(cx).id(), worktree))
4613 })
4614 .collect::<HashMap<_, _>>();
4615
4616 for worktree in envelope.payload.worktrees {
4617 if let Some(old_worktree) =
4618 old_worktrees_by_id.remove(&WorktreeId::from_proto(worktree.id))
4619 {
4620 this.worktrees.push(WorktreeHandle::Strong(old_worktree));
4621 } else {
4622 let worktree =
4623 Worktree::remote(remote_id, replica_id, worktree, client.clone(), cx);
4624 this.add_worktree(&worktree, cx);
4625 }
4626 }
4627
4628 this.metadata_changed(cx);
4629 for (id, _) in old_worktrees_by_id {
4630 cx.emit(Event::WorktreeRemoved(id));
4631 }
4632
4633 Ok(())
4634 })
4635 }
4636
4637 async fn handle_update_worktree(
4638 this: ModelHandle<Self>,
4639 envelope: TypedEnvelope<proto::UpdateWorktree>,
4640 _: Arc<Client>,
4641 mut cx: AsyncAppContext,
4642 ) -> Result<()> {
4643 this.update(&mut cx, |this, cx| {
4644 let worktree_id = WorktreeId::from_proto(envelope.payload.worktree_id);
4645 if let Some(worktree) = this.worktree_for_id(worktree_id, cx) {
4646 worktree.update(cx, |worktree, _| {
4647 let worktree = worktree.as_remote_mut().unwrap();
4648 worktree.update_from_remote(envelope.payload);
4649 });
4650 }
4651 Ok(())
4652 })
4653 }
4654
4655 async fn handle_create_project_entry(
4656 this: ModelHandle<Self>,
4657 envelope: TypedEnvelope<proto::CreateProjectEntry>,
4658 _: Arc<Client>,
4659 mut cx: AsyncAppContext,
4660 ) -> Result<proto::ProjectEntryResponse> {
4661 let worktree = this.update(&mut cx, |this, cx| {
4662 let worktree_id = WorktreeId::from_proto(envelope.payload.worktree_id);
4663 this.worktree_for_id(worktree_id, cx)
4664 .ok_or_else(|| anyhow!("worktree not found"))
4665 })?;
4666 let worktree_scan_id = worktree.read_with(&cx, |worktree, _| worktree.scan_id());
4667 let entry = worktree
4668 .update(&mut cx, |worktree, cx| {
4669 let worktree = worktree.as_local_mut().unwrap();
4670 let path = PathBuf::from(OsString::from_vec(envelope.payload.path));
4671 worktree.create_entry(path, envelope.payload.is_directory, cx)
4672 })
4673 .await?;
4674 Ok(proto::ProjectEntryResponse {
4675 entry: Some((&entry).into()),
4676 worktree_scan_id: worktree_scan_id as u64,
4677 })
4678 }
4679
4680 async fn handle_rename_project_entry(
4681 this: ModelHandle<Self>,
4682 envelope: TypedEnvelope<proto::RenameProjectEntry>,
4683 _: Arc<Client>,
4684 mut cx: AsyncAppContext,
4685 ) -> Result<proto::ProjectEntryResponse> {
4686 let entry_id = ProjectEntryId::from_proto(envelope.payload.entry_id);
4687 let worktree = this.read_with(&cx, |this, cx| {
4688 this.worktree_for_entry(entry_id, cx)
4689 .ok_or_else(|| anyhow!("worktree not found"))
4690 })?;
4691 let worktree_scan_id = worktree.read_with(&cx, |worktree, _| worktree.scan_id());
4692 let entry = worktree
4693 .update(&mut cx, |worktree, cx| {
4694 let new_path = PathBuf::from(OsString::from_vec(envelope.payload.new_path));
4695 worktree
4696 .as_local_mut()
4697 .unwrap()
4698 .rename_entry(entry_id, new_path, cx)
4699 .ok_or_else(|| anyhow!("invalid entry"))
4700 })?
4701 .await?;
4702 Ok(proto::ProjectEntryResponse {
4703 entry: Some((&entry).into()),
4704 worktree_scan_id: worktree_scan_id as u64,
4705 })
4706 }
4707
4708 async fn handle_copy_project_entry(
4709 this: ModelHandle<Self>,
4710 envelope: TypedEnvelope<proto::CopyProjectEntry>,
4711 _: Arc<Client>,
4712 mut cx: AsyncAppContext,
4713 ) -> Result<proto::ProjectEntryResponse> {
4714 let entry_id = ProjectEntryId::from_proto(envelope.payload.entry_id);
4715 let worktree = this.read_with(&cx, |this, cx| {
4716 this.worktree_for_entry(entry_id, cx)
4717 .ok_or_else(|| anyhow!("worktree not found"))
4718 })?;
4719 let worktree_scan_id = worktree.read_with(&cx, |worktree, _| worktree.scan_id());
4720 let entry = worktree
4721 .update(&mut cx, |worktree, cx| {
4722 let new_path = PathBuf::from(OsString::from_vec(envelope.payload.new_path));
4723 worktree
4724 .as_local_mut()
4725 .unwrap()
4726 .copy_entry(entry_id, new_path, cx)
4727 .ok_or_else(|| anyhow!("invalid entry"))
4728 })?
4729 .await?;
4730 Ok(proto::ProjectEntryResponse {
4731 entry: Some((&entry).into()),
4732 worktree_scan_id: worktree_scan_id as u64,
4733 })
4734 }
4735
4736 async fn handle_delete_project_entry(
4737 this: ModelHandle<Self>,
4738 envelope: TypedEnvelope<proto::DeleteProjectEntry>,
4739 _: Arc<Client>,
4740 mut cx: AsyncAppContext,
4741 ) -> Result<proto::ProjectEntryResponse> {
4742 let entry_id = ProjectEntryId::from_proto(envelope.payload.entry_id);
4743 let worktree = this.read_with(&cx, |this, cx| {
4744 this.worktree_for_entry(entry_id, cx)
4745 .ok_or_else(|| anyhow!("worktree not found"))
4746 })?;
4747 let worktree_scan_id = worktree.read_with(&cx, |worktree, _| worktree.scan_id());
4748 worktree
4749 .update(&mut cx, |worktree, cx| {
4750 worktree
4751 .as_local_mut()
4752 .unwrap()
4753 .delete_entry(entry_id, cx)
4754 .ok_or_else(|| anyhow!("invalid entry"))
4755 })?
4756 .await?;
4757 Ok(proto::ProjectEntryResponse {
4758 entry: None,
4759 worktree_scan_id: worktree_scan_id as u64,
4760 })
4761 }
4762
4763 async fn handle_update_diagnostic_summary(
4764 this: ModelHandle<Self>,
4765 envelope: TypedEnvelope<proto::UpdateDiagnosticSummary>,
4766 _: Arc<Client>,
4767 mut cx: AsyncAppContext,
4768 ) -> Result<()> {
4769 this.update(&mut cx, |this, cx| {
4770 let worktree_id = WorktreeId::from_proto(envelope.payload.worktree_id);
4771 if let Some(worktree) = this.worktree_for_id(worktree_id, cx) {
4772 if let Some(summary) = envelope.payload.summary {
4773 let project_path = ProjectPath {
4774 worktree_id,
4775 path: Path::new(&summary.path).into(),
4776 };
4777 worktree.update(cx, |worktree, _| {
4778 worktree
4779 .as_remote_mut()
4780 .unwrap()
4781 .update_diagnostic_summary(project_path.path.clone(), &summary);
4782 });
4783 cx.emit(Event::DiagnosticsUpdated {
4784 language_server_id: summary.language_server_id as usize,
4785 path: project_path,
4786 });
4787 }
4788 }
4789 Ok(())
4790 })
4791 }
4792
4793 async fn handle_start_language_server(
4794 this: ModelHandle<Self>,
4795 envelope: TypedEnvelope<proto::StartLanguageServer>,
4796 _: Arc<Client>,
4797 mut cx: AsyncAppContext,
4798 ) -> Result<()> {
4799 let server = envelope
4800 .payload
4801 .server
4802 .ok_or_else(|| anyhow!("invalid server"))?;
4803 this.update(&mut cx, |this, cx| {
4804 this.language_server_statuses.insert(
4805 server.id as usize,
4806 LanguageServerStatus {
4807 name: server.name,
4808 pending_work: Default::default(),
4809 has_pending_diagnostic_updates: false,
4810 progress_tokens: Default::default(),
4811 },
4812 );
4813 cx.notify();
4814 });
4815 Ok(())
4816 }
4817
4818 async fn handle_update_language_server(
4819 this: ModelHandle<Self>,
4820 envelope: TypedEnvelope<proto::UpdateLanguageServer>,
4821 _: Arc<Client>,
4822 mut cx: AsyncAppContext,
4823 ) -> Result<()> {
4824 let language_server_id = envelope.payload.language_server_id as usize;
4825 match envelope
4826 .payload
4827 .variant
4828 .ok_or_else(|| anyhow!("invalid variant"))?
4829 {
4830 proto::update_language_server::Variant::WorkStart(payload) => {
4831 this.update(&mut cx, |this, cx| {
4832 this.on_lsp_work_start(
4833 language_server_id,
4834 payload.token,
4835 LanguageServerProgress {
4836 message: payload.message,
4837 percentage: payload.percentage.map(|p| p as usize),
4838 last_update_at: Instant::now(),
4839 },
4840 cx,
4841 );
4842 })
4843 }
4844 proto::update_language_server::Variant::WorkProgress(payload) => {
4845 this.update(&mut cx, |this, cx| {
4846 this.on_lsp_work_progress(
4847 language_server_id,
4848 payload.token,
4849 LanguageServerProgress {
4850 message: payload.message,
4851 percentage: payload.percentage.map(|p| p as usize),
4852 last_update_at: Instant::now(),
4853 },
4854 cx,
4855 );
4856 })
4857 }
4858 proto::update_language_server::Variant::WorkEnd(payload) => {
4859 this.update(&mut cx, |this, cx| {
4860 this.on_lsp_work_end(language_server_id, payload.token, cx);
4861 })
4862 }
4863 proto::update_language_server::Variant::DiskBasedDiagnosticsUpdating(_) => {
4864 this.update(&mut cx, |this, cx| {
4865 this.disk_based_diagnostics_started(language_server_id, cx);
4866 })
4867 }
4868 proto::update_language_server::Variant::DiskBasedDiagnosticsUpdated(_) => {
4869 this.update(&mut cx, |this, cx| {
4870 this.disk_based_diagnostics_finished(language_server_id, cx)
4871 });
4872 }
4873 }
4874
4875 Ok(())
4876 }
4877
4878 async fn handle_update_buffer(
4879 this: ModelHandle<Self>,
4880 envelope: TypedEnvelope<proto::UpdateBuffer>,
4881 _: Arc<Client>,
4882 mut cx: AsyncAppContext,
4883 ) -> Result<()> {
4884 this.update(&mut cx, |this, cx| {
4885 let payload = envelope.payload.clone();
4886 let buffer_id = payload.buffer_id;
4887 let ops = payload
4888 .operations
4889 .into_iter()
4890 .map(language::proto::deserialize_operation)
4891 .collect::<Result<Vec<_>, _>>()?;
4892 let is_remote = this.is_remote();
4893 match this.opened_buffers.entry(buffer_id) {
4894 hash_map::Entry::Occupied(mut e) => match e.get_mut() {
4895 OpenBuffer::Strong(buffer) => {
4896 buffer.update(cx, |buffer, cx| buffer.apply_ops(ops, cx))?;
4897 }
4898 OpenBuffer::Operations(operations) => operations.extend_from_slice(&ops),
4899 OpenBuffer::Weak(_) => {}
4900 },
4901 hash_map::Entry::Vacant(e) => {
4902 assert!(
4903 is_remote,
4904 "received buffer update from {:?}",
4905 envelope.original_sender_id
4906 );
4907 e.insert(OpenBuffer::Operations(ops));
4908 }
4909 }
4910 Ok(())
4911 })
4912 }
4913
4914 async fn handle_create_buffer_for_peer(
4915 this: ModelHandle<Self>,
4916 envelope: TypedEnvelope<proto::CreateBufferForPeer>,
4917 _: Arc<Client>,
4918 mut cx: AsyncAppContext,
4919 ) -> Result<()> {
4920 this.update(&mut cx, |this, cx| {
4921 match envelope
4922 .payload
4923 .variant
4924 .ok_or_else(|| anyhow!("missing variant"))?
4925 {
4926 proto::create_buffer_for_peer::Variant::State(mut state) => {
4927 let mut buffer_file = None;
4928 if let Some(file) = state.file.take() {
4929 let worktree_id = WorktreeId::from_proto(file.worktree_id);
4930 let worktree = this.worktree_for_id(worktree_id, cx).ok_or_else(|| {
4931 anyhow!("no worktree found for id {}", file.worktree_id)
4932 })?;
4933 buffer_file = Some(Arc::new(File::from_proto(file, worktree.clone(), cx)?)
4934 as Arc<dyn language::File>);
4935 }
4936
4937 let buffer_id = state.id;
4938 let buffer = cx.add_model(|_| {
4939 Buffer::from_proto(this.replica_id(), state, buffer_file).unwrap()
4940 });
4941 this.incomplete_buffers.insert(buffer_id, buffer);
4942 }
4943 proto::create_buffer_for_peer::Variant::Chunk(chunk) => {
4944 let buffer = this
4945 .incomplete_buffers
4946 .get(&chunk.buffer_id)
4947 .ok_or_else(|| {
4948 anyhow!(
4949 "received chunk for buffer {} without initial state",
4950 chunk.buffer_id
4951 )
4952 })?
4953 .clone();
4954 let operations = chunk
4955 .operations
4956 .into_iter()
4957 .map(language::proto::deserialize_operation)
4958 .collect::<Result<Vec<_>>>()?;
4959 buffer.update(cx, |buffer, cx| buffer.apply_ops(operations, cx))?;
4960
4961 if chunk.is_last {
4962 this.incomplete_buffers.remove(&chunk.buffer_id);
4963 this.register_buffer(&buffer, cx)?;
4964 }
4965 }
4966 }
4967
4968 Ok(())
4969 })
4970 }
4971
4972 async fn handle_update_diff_base(
4973 this: ModelHandle<Self>,
4974 envelope: TypedEnvelope<proto::UpdateDiffBase>,
4975 _: Arc<Client>,
4976 mut cx: AsyncAppContext,
4977 ) -> Result<()> {
4978 this.update(&mut cx, |this, cx| {
4979 let buffer_id = envelope.payload.buffer_id;
4980 let diff_base = envelope.payload.diff_base;
4981 let buffer = this
4982 .opened_buffers
4983 .get_mut(&buffer_id)
4984 .and_then(|b| b.upgrade(cx))
4985 .ok_or_else(|| anyhow!("No such buffer {}", buffer_id))?;
4986
4987 buffer.update(cx, |buffer, cx| buffer.set_diff_base(diff_base, cx));
4988
4989 Ok(())
4990 })
4991 }
4992
4993 async fn handle_update_buffer_file(
4994 this: ModelHandle<Self>,
4995 envelope: TypedEnvelope<proto::UpdateBufferFile>,
4996 _: Arc<Client>,
4997 mut cx: AsyncAppContext,
4998 ) -> Result<()> {
4999 this.update(&mut cx, |this, cx| {
5000 let payload = envelope.payload.clone();
5001 let buffer_id = payload.buffer_id;
5002 let file = payload.file.ok_or_else(|| anyhow!("invalid file"))?;
5003 let worktree = this
5004 .worktree_for_id(WorktreeId::from_proto(file.worktree_id), cx)
5005 .ok_or_else(|| anyhow!("no such worktree"))?;
5006 let file = File::from_proto(file, worktree, cx)?;
5007 let buffer = this
5008 .opened_buffers
5009 .get_mut(&buffer_id)
5010 .and_then(|b| b.upgrade(cx))
5011 .ok_or_else(|| anyhow!("no such buffer"))?;
5012 buffer.update(cx, |buffer, cx| {
5013 buffer.file_updated(Arc::new(file), cx).detach();
5014 });
5015 this.assign_language_to_buffer(&buffer, cx);
5016 Ok(())
5017 })
5018 }
5019
5020 async fn handle_save_buffer(
5021 this: ModelHandle<Self>,
5022 envelope: TypedEnvelope<proto::SaveBuffer>,
5023 _: Arc<Client>,
5024 mut cx: AsyncAppContext,
5025 ) -> Result<proto::BufferSaved> {
5026 let buffer_id = envelope.payload.buffer_id;
5027 let requested_version = deserialize_version(envelope.payload.version);
5028
5029 let (project_id, buffer) = this.update(&mut cx, |this, cx| {
5030 let project_id = this.remote_id().ok_or_else(|| anyhow!("not connected"))?;
5031 let buffer = this
5032 .opened_buffers
5033 .get(&buffer_id)
5034 .and_then(|buffer| buffer.upgrade(cx))
5035 .ok_or_else(|| anyhow!("unknown buffer id {}", buffer_id))?;
5036 Ok::<_, anyhow::Error>((project_id, buffer))
5037 })?;
5038 buffer
5039 .update(&mut cx, |buffer, _| {
5040 buffer.wait_for_version(requested_version)
5041 })
5042 .await;
5043
5044 let (saved_version, fingerprint, mtime) =
5045 buffer.update(&mut cx, |buffer, cx| buffer.save(cx)).await?;
5046 Ok(proto::BufferSaved {
5047 project_id,
5048 buffer_id,
5049 version: serialize_version(&saved_version),
5050 mtime: Some(mtime.into()),
5051 fingerprint,
5052 })
5053 }
5054
5055 async fn handle_reload_buffers(
5056 this: ModelHandle<Self>,
5057 envelope: TypedEnvelope<proto::ReloadBuffers>,
5058 _: Arc<Client>,
5059 mut cx: AsyncAppContext,
5060 ) -> Result<proto::ReloadBuffersResponse> {
5061 let sender_id = envelope.original_sender_id()?;
5062 let reload = this.update(&mut cx, |this, cx| {
5063 let mut buffers = HashSet::default();
5064 for buffer_id in &envelope.payload.buffer_ids {
5065 buffers.insert(
5066 this.opened_buffers
5067 .get(buffer_id)
5068 .and_then(|buffer| buffer.upgrade(cx))
5069 .ok_or_else(|| anyhow!("unknown buffer id {}", buffer_id))?,
5070 );
5071 }
5072 Ok::<_, anyhow::Error>(this.reload_buffers(buffers, false, cx))
5073 })?;
5074
5075 let project_transaction = reload.await?;
5076 let project_transaction = this.update(&mut cx, |this, cx| {
5077 this.serialize_project_transaction_for_peer(project_transaction, sender_id, cx)
5078 });
5079 Ok(proto::ReloadBuffersResponse {
5080 transaction: Some(project_transaction),
5081 })
5082 }
5083
5084 async fn handle_format_buffers(
5085 this: ModelHandle<Self>,
5086 envelope: TypedEnvelope<proto::FormatBuffers>,
5087 _: Arc<Client>,
5088 mut cx: AsyncAppContext,
5089 ) -> Result<proto::FormatBuffersResponse> {
5090 let sender_id = envelope.original_sender_id()?;
5091 let format = this.update(&mut cx, |this, cx| {
5092 let mut buffers = HashSet::default();
5093 for buffer_id in &envelope.payload.buffer_ids {
5094 buffers.insert(
5095 this.opened_buffers
5096 .get(buffer_id)
5097 .and_then(|buffer| buffer.upgrade(cx))
5098 .ok_or_else(|| anyhow!("unknown buffer id {}", buffer_id))?,
5099 );
5100 }
5101 let trigger = FormatTrigger::from_proto(envelope.payload.trigger);
5102 Ok::<_, anyhow::Error>(this.format(buffers, false, trigger, cx))
5103 })?;
5104
5105 let project_transaction = format.await?;
5106 let project_transaction = this.update(&mut cx, |this, cx| {
5107 this.serialize_project_transaction_for_peer(project_transaction, sender_id, cx)
5108 });
5109 Ok(proto::FormatBuffersResponse {
5110 transaction: Some(project_transaction),
5111 })
5112 }
5113
5114 async fn handle_get_completions(
5115 this: ModelHandle<Self>,
5116 envelope: TypedEnvelope<proto::GetCompletions>,
5117 _: Arc<Client>,
5118 mut cx: AsyncAppContext,
5119 ) -> Result<proto::GetCompletionsResponse> {
5120 let position = envelope
5121 .payload
5122 .position
5123 .and_then(language::proto::deserialize_anchor)
5124 .ok_or_else(|| anyhow!("invalid position"))?;
5125 let version = deserialize_version(envelope.payload.version);
5126 let buffer = this.read_with(&cx, |this, cx| {
5127 this.opened_buffers
5128 .get(&envelope.payload.buffer_id)
5129 .and_then(|buffer| buffer.upgrade(cx))
5130 .ok_or_else(|| anyhow!("unknown buffer id {}", envelope.payload.buffer_id))
5131 })?;
5132 buffer
5133 .update(&mut cx, |buffer, _| buffer.wait_for_version(version))
5134 .await;
5135 let version = buffer.read_with(&cx, |buffer, _| buffer.version());
5136 let completions = this
5137 .update(&mut cx, |this, cx| this.completions(&buffer, position, cx))
5138 .await?;
5139
5140 Ok(proto::GetCompletionsResponse {
5141 completions: completions
5142 .iter()
5143 .map(language::proto::serialize_completion)
5144 .collect(),
5145 version: serialize_version(&version),
5146 })
5147 }
5148
5149 async fn handle_apply_additional_edits_for_completion(
5150 this: ModelHandle<Self>,
5151 envelope: TypedEnvelope<proto::ApplyCompletionAdditionalEdits>,
5152 _: Arc<Client>,
5153 mut cx: AsyncAppContext,
5154 ) -> Result<proto::ApplyCompletionAdditionalEditsResponse> {
5155 let (buffer, completion) = this.update(&mut cx, |this, cx| {
5156 let buffer = this
5157 .opened_buffers
5158 .get(&envelope.payload.buffer_id)
5159 .and_then(|buffer| buffer.upgrade(cx))
5160 .ok_or_else(|| anyhow!("unknown buffer id {}", envelope.payload.buffer_id))?;
5161 let language = buffer.read(cx).language();
5162 let completion = language::proto::deserialize_completion(
5163 envelope
5164 .payload
5165 .completion
5166 .ok_or_else(|| anyhow!("invalid completion"))?,
5167 language.cloned(),
5168 );
5169 Ok::<_, anyhow::Error>((buffer, completion))
5170 })?;
5171
5172 let completion = completion.await?;
5173
5174 let apply_additional_edits = this.update(&mut cx, |this, cx| {
5175 this.apply_additional_edits_for_completion(buffer, completion, false, cx)
5176 });
5177
5178 Ok(proto::ApplyCompletionAdditionalEditsResponse {
5179 transaction: apply_additional_edits
5180 .await?
5181 .as_ref()
5182 .map(language::proto::serialize_transaction),
5183 })
5184 }
5185
5186 async fn handle_get_code_actions(
5187 this: ModelHandle<Self>,
5188 envelope: TypedEnvelope<proto::GetCodeActions>,
5189 _: Arc<Client>,
5190 mut cx: AsyncAppContext,
5191 ) -> Result<proto::GetCodeActionsResponse> {
5192 let start = envelope
5193 .payload
5194 .start
5195 .and_then(language::proto::deserialize_anchor)
5196 .ok_or_else(|| anyhow!("invalid start"))?;
5197 let end = envelope
5198 .payload
5199 .end
5200 .and_then(language::proto::deserialize_anchor)
5201 .ok_or_else(|| anyhow!("invalid end"))?;
5202 let buffer = this.update(&mut cx, |this, cx| {
5203 this.opened_buffers
5204 .get(&envelope.payload.buffer_id)
5205 .and_then(|buffer| buffer.upgrade(cx))
5206 .ok_or_else(|| anyhow!("unknown buffer id {}", envelope.payload.buffer_id))
5207 })?;
5208 buffer
5209 .update(&mut cx, |buffer, _| {
5210 buffer.wait_for_version(deserialize_version(envelope.payload.version))
5211 })
5212 .await;
5213
5214 let version = buffer.read_with(&cx, |buffer, _| buffer.version());
5215 let code_actions = this.update(&mut cx, |this, cx| {
5216 Ok::<_, anyhow::Error>(this.code_actions(&buffer, start..end, cx))
5217 })?;
5218
5219 Ok(proto::GetCodeActionsResponse {
5220 actions: code_actions
5221 .await?
5222 .iter()
5223 .map(language::proto::serialize_code_action)
5224 .collect(),
5225 version: serialize_version(&version),
5226 })
5227 }
5228
5229 async fn handle_apply_code_action(
5230 this: ModelHandle<Self>,
5231 envelope: TypedEnvelope<proto::ApplyCodeAction>,
5232 _: Arc<Client>,
5233 mut cx: AsyncAppContext,
5234 ) -> Result<proto::ApplyCodeActionResponse> {
5235 let sender_id = envelope.original_sender_id()?;
5236 let action = language::proto::deserialize_code_action(
5237 envelope
5238 .payload
5239 .action
5240 .ok_or_else(|| anyhow!("invalid action"))?,
5241 )?;
5242 let apply_code_action = this.update(&mut cx, |this, cx| {
5243 let buffer = this
5244 .opened_buffers
5245 .get(&envelope.payload.buffer_id)
5246 .and_then(|buffer| buffer.upgrade(cx))
5247 .ok_or_else(|| anyhow!("unknown buffer id {}", envelope.payload.buffer_id))?;
5248 Ok::<_, anyhow::Error>(this.apply_code_action(buffer, action, false, cx))
5249 })?;
5250
5251 let project_transaction = apply_code_action.await?;
5252 let project_transaction = this.update(&mut cx, |this, cx| {
5253 this.serialize_project_transaction_for_peer(project_transaction, sender_id, cx)
5254 });
5255 Ok(proto::ApplyCodeActionResponse {
5256 transaction: Some(project_transaction),
5257 })
5258 }
5259
5260 async fn handle_lsp_command<T: LspCommand>(
5261 this: ModelHandle<Self>,
5262 envelope: TypedEnvelope<T::ProtoRequest>,
5263 _: Arc<Client>,
5264 mut cx: AsyncAppContext,
5265 ) -> Result<<T::ProtoRequest as proto::RequestMessage>::Response>
5266 where
5267 <T::LspRequest as lsp::request::Request>::Result: Send,
5268 {
5269 let sender_id = envelope.original_sender_id()?;
5270 let buffer_id = T::buffer_id_from_proto(&envelope.payload);
5271 let buffer_handle = this.read_with(&cx, |this, _| {
5272 this.opened_buffers
5273 .get(&buffer_id)
5274 .and_then(|buffer| buffer.upgrade(&cx))
5275 .ok_or_else(|| anyhow!("unknown buffer id {}", buffer_id))
5276 })?;
5277 let request = T::from_proto(
5278 envelope.payload,
5279 this.clone(),
5280 buffer_handle.clone(),
5281 cx.clone(),
5282 )
5283 .await?;
5284 let buffer_version = buffer_handle.read_with(&cx, |buffer, _| buffer.version());
5285 let response = this
5286 .update(&mut cx, |this, cx| {
5287 this.request_lsp(buffer_handle, request, cx)
5288 })
5289 .await?;
5290 this.update(&mut cx, |this, cx| {
5291 Ok(T::response_to_proto(
5292 response,
5293 this,
5294 sender_id,
5295 &buffer_version,
5296 cx,
5297 ))
5298 })
5299 }
5300
5301 async fn handle_get_project_symbols(
5302 this: ModelHandle<Self>,
5303 envelope: TypedEnvelope<proto::GetProjectSymbols>,
5304 _: Arc<Client>,
5305 mut cx: AsyncAppContext,
5306 ) -> Result<proto::GetProjectSymbolsResponse> {
5307 let symbols = this
5308 .update(&mut cx, |this, cx| {
5309 this.symbols(&envelope.payload.query, cx)
5310 })
5311 .await?;
5312
5313 Ok(proto::GetProjectSymbolsResponse {
5314 symbols: symbols.iter().map(serialize_symbol).collect(),
5315 })
5316 }
5317
5318 async fn handle_search_project(
5319 this: ModelHandle<Self>,
5320 envelope: TypedEnvelope<proto::SearchProject>,
5321 _: Arc<Client>,
5322 mut cx: AsyncAppContext,
5323 ) -> Result<proto::SearchProjectResponse> {
5324 let peer_id = envelope.original_sender_id()?;
5325 let query = SearchQuery::from_proto(envelope.payload)?;
5326 let result = this
5327 .update(&mut cx, |this, cx| this.search(query, cx))
5328 .await?;
5329
5330 this.update(&mut cx, |this, cx| {
5331 let mut locations = Vec::new();
5332 for (buffer, ranges) in result {
5333 for range in ranges {
5334 let start = serialize_anchor(&range.start);
5335 let end = serialize_anchor(&range.end);
5336 let buffer_id = this.create_buffer_for_peer(&buffer, peer_id, cx);
5337 locations.push(proto::Location {
5338 buffer_id,
5339 start: Some(start),
5340 end: Some(end),
5341 });
5342 }
5343 }
5344 Ok(proto::SearchProjectResponse { locations })
5345 })
5346 }
5347
5348 async fn handle_open_buffer_for_symbol(
5349 this: ModelHandle<Self>,
5350 envelope: TypedEnvelope<proto::OpenBufferForSymbol>,
5351 _: Arc<Client>,
5352 mut cx: AsyncAppContext,
5353 ) -> Result<proto::OpenBufferForSymbolResponse> {
5354 let peer_id = envelope.original_sender_id()?;
5355 let symbol = envelope
5356 .payload
5357 .symbol
5358 .ok_or_else(|| anyhow!("invalid symbol"))?;
5359 let symbol = this
5360 .read_with(&cx, |this, _| this.deserialize_symbol(symbol))
5361 .await?;
5362 let symbol = this.read_with(&cx, |this, _| {
5363 let signature = this.symbol_signature(&symbol.path);
5364 if signature == symbol.signature {
5365 Ok(symbol)
5366 } else {
5367 Err(anyhow!("invalid symbol signature"))
5368 }
5369 })?;
5370 let buffer = this
5371 .update(&mut cx, |this, cx| this.open_buffer_for_symbol(&symbol, cx))
5372 .await?;
5373
5374 Ok(proto::OpenBufferForSymbolResponse {
5375 buffer_id: this.update(&mut cx, |this, cx| {
5376 this.create_buffer_for_peer(&buffer, peer_id, cx)
5377 }),
5378 })
5379 }
5380
5381 fn symbol_signature(&self, project_path: &ProjectPath) -> [u8; 32] {
5382 let mut hasher = Sha256::new();
5383 hasher.update(project_path.worktree_id.to_proto().to_be_bytes());
5384 hasher.update(project_path.path.to_string_lossy().as_bytes());
5385 hasher.update(self.nonce.to_be_bytes());
5386 hasher.finalize().as_slice().try_into().unwrap()
5387 }
5388
5389 async fn handle_open_buffer_by_id(
5390 this: ModelHandle<Self>,
5391 envelope: TypedEnvelope<proto::OpenBufferById>,
5392 _: Arc<Client>,
5393 mut cx: AsyncAppContext,
5394 ) -> Result<proto::OpenBufferResponse> {
5395 let peer_id = envelope.original_sender_id()?;
5396 let buffer = this
5397 .update(&mut cx, |this, cx| {
5398 this.open_buffer_by_id(envelope.payload.id, cx)
5399 })
5400 .await?;
5401 this.update(&mut cx, |this, cx| {
5402 Ok(proto::OpenBufferResponse {
5403 buffer_id: this.create_buffer_for_peer(&buffer, peer_id, cx),
5404 })
5405 })
5406 }
5407
5408 async fn handle_open_buffer_by_path(
5409 this: ModelHandle<Self>,
5410 envelope: TypedEnvelope<proto::OpenBufferByPath>,
5411 _: Arc<Client>,
5412 mut cx: AsyncAppContext,
5413 ) -> Result<proto::OpenBufferResponse> {
5414 let peer_id = envelope.original_sender_id()?;
5415 let worktree_id = WorktreeId::from_proto(envelope.payload.worktree_id);
5416 let open_buffer = this.update(&mut cx, |this, cx| {
5417 this.open_buffer(
5418 ProjectPath {
5419 worktree_id,
5420 path: PathBuf::from(envelope.payload.path).into(),
5421 },
5422 cx,
5423 )
5424 });
5425
5426 let buffer = open_buffer.await?;
5427 this.update(&mut cx, |this, cx| {
5428 Ok(proto::OpenBufferResponse {
5429 buffer_id: this.create_buffer_for_peer(&buffer, peer_id, cx),
5430 })
5431 })
5432 }
5433
5434 fn serialize_project_transaction_for_peer(
5435 &mut self,
5436 project_transaction: ProjectTransaction,
5437 peer_id: PeerId,
5438 cx: &AppContext,
5439 ) -> proto::ProjectTransaction {
5440 let mut serialized_transaction = proto::ProjectTransaction {
5441 buffer_ids: Default::default(),
5442 transactions: Default::default(),
5443 };
5444 for (buffer, transaction) in project_transaction.0 {
5445 serialized_transaction
5446 .buffer_ids
5447 .push(self.create_buffer_for_peer(&buffer, peer_id, cx));
5448 serialized_transaction
5449 .transactions
5450 .push(language::proto::serialize_transaction(&transaction));
5451 }
5452 serialized_transaction
5453 }
5454
5455 fn deserialize_project_transaction(
5456 &mut self,
5457 message: proto::ProjectTransaction,
5458 push_to_history: bool,
5459 cx: &mut ModelContext<Self>,
5460 ) -> Task<Result<ProjectTransaction>> {
5461 cx.spawn(|this, mut cx| async move {
5462 let mut project_transaction = ProjectTransaction::default();
5463 for (buffer_id, transaction) in message.buffer_ids.into_iter().zip(message.transactions)
5464 {
5465 let buffer = this
5466 .update(&mut cx, |this, cx| this.wait_for_buffer(buffer_id, cx))
5467 .await?;
5468 let transaction = language::proto::deserialize_transaction(transaction)?;
5469 project_transaction.0.insert(buffer, transaction);
5470 }
5471
5472 for (buffer, transaction) in &project_transaction.0 {
5473 buffer
5474 .update(&mut cx, |buffer, _| {
5475 buffer.wait_for_edits(transaction.edit_ids.iter().copied())
5476 })
5477 .await;
5478
5479 if push_to_history {
5480 buffer.update(&mut cx, |buffer, _| {
5481 buffer.push_transaction(transaction.clone(), Instant::now());
5482 });
5483 }
5484 }
5485
5486 Ok(project_transaction)
5487 })
5488 }
5489
5490 fn create_buffer_for_peer(
5491 &mut self,
5492 buffer: &ModelHandle<Buffer>,
5493 peer_id: PeerId,
5494 cx: &AppContext,
5495 ) -> u64 {
5496 let buffer_id = buffer.read(cx).remote_id();
5497 if let Some(project_id) = self.remote_id() {
5498 let shared_buffers = self.shared_buffers.entry(peer_id).or_default();
5499 if shared_buffers.insert(buffer_id) {
5500 let buffer = buffer.read(cx);
5501 let state = buffer.to_proto();
5502 let operations = buffer.serialize_ops(cx);
5503 let client = self.client.clone();
5504 cx.background()
5505 .spawn(
5506 async move {
5507 let mut operations = operations.await;
5508
5509 client.send(proto::CreateBufferForPeer {
5510 project_id,
5511 peer_id: peer_id.0,
5512 variant: Some(proto::create_buffer_for_peer::Variant::State(state)),
5513 })?;
5514
5515 loop {
5516 #[cfg(any(test, feature = "test-support"))]
5517 const CHUNK_SIZE: usize = 5;
5518
5519 #[cfg(not(any(test, feature = "test-support")))]
5520 const CHUNK_SIZE: usize = 100;
5521
5522 let chunk = operations
5523 .drain(..cmp::min(CHUNK_SIZE, operations.len()))
5524 .collect();
5525 let is_last = operations.is_empty();
5526 client.send(proto::CreateBufferForPeer {
5527 project_id,
5528 peer_id: peer_id.0,
5529 variant: Some(proto::create_buffer_for_peer::Variant::Chunk(
5530 proto::BufferChunk {
5531 buffer_id,
5532 operations: chunk,
5533 is_last,
5534 },
5535 )),
5536 })?;
5537
5538 if is_last {
5539 break;
5540 }
5541 }
5542
5543 Ok(())
5544 }
5545 .log_err(),
5546 )
5547 .detach();
5548 }
5549 }
5550
5551 buffer_id
5552 }
5553
5554 fn wait_for_buffer(
5555 &self,
5556 id: u64,
5557 cx: &mut ModelContext<Self>,
5558 ) -> Task<Result<ModelHandle<Buffer>>> {
5559 let mut opened_buffer_rx = self.opened_buffer.1.clone();
5560 cx.spawn(|this, mut cx| async move {
5561 let buffer = loop {
5562 let buffer = this.read_with(&cx, |this, cx| {
5563 this.opened_buffers
5564 .get(&id)
5565 .and_then(|buffer| buffer.upgrade(cx))
5566 });
5567 if let Some(buffer) = buffer {
5568 break buffer;
5569 } else if this.read_with(&cx, |this, _| this.is_read_only()) {
5570 return Err(anyhow!("disconnected before buffer {} could be opened", id));
5571 }
5572
5573 opened_buffer_rx
5574 .next()
5575 .await
5576 .ok_or_else(|| anyhow!("project dropped while waiting for buffer"))?;
5577 };
5578 buffer.update(&mut cx, |buffer, cx| buffer.git_diff_recalc(cx));
5579 Ok(buffer)
5580 })
5581 }
5582
5583 fn deserialize_symbol(
5584 &self,
5585 serialized_symbol: proto::Symbol,
5586 ) -> impl Future<Output = Result<Symbol>> {
5587 let languages = self.languages.clone();
5588 async move {
5589 let source_worktree_id = WorktreeId::from_proto(serialized_symbol.source_worktree_id);
5590 let worktree_id = WorktreeId::from_proto(serialized_symbol.worktree_id);
5591 let start = serialized_symbol
5592 .start
5593 .ok_or_else(|| anyhow!("invalid start"))?;
5594 let end = serialized_symbol
5595 .end
5596 .ok_or_else(|| anyhow!("invalid end"))?;
5597 let kind = unsafe { mem::transmute(serialized_symbol.kind) };
5598 let path = ProjectPath {
5599 worktree_id,
5600 path: PathBuf::from(serialized_symbol.path).into(),
5601 };
5602 let language = languages.select_language(&path.path);
5603 Ok(Symbol {
5604 language_server_name: LanguageServerName(
5605 serialized_symbol.language_server_name.into(),
5606 ),
5607 source_worktree_id,
5608 path,
5609 label: {
5610 match language {
5611 Some(language) => {
5612 language
5613 .label_for_symbol(&serialized_symbol.name, kind)
5614 .await
5615 }
5616 None => None,
5617 }
5618 .unwrap_or_else(|| CodeLabel::plain(serialized_symbol.name.clone(), None))
5619 },
5620
5621 name: serialized_symbol.name,
5622 range: PointUtf16::new(start.row, start.column)
5623 ..PointUtf16::new(end.row, end.column),
5624 kind,
5625 signature: serialized_symbol
5626 .signature
5627 .try_into()
5628 .map_err(|_| anyhow!("invalid signature"))?,
5629 })
5630 }
5631 }
5632
5633 async fn handle_buffer_saved(
5634 this: ModelHandle<Self>,
5635 envelope: TypedEnvelope<proto::BufferSaved>,
5636 _: Arc<Client>,
5637 mut cx: AsyncAppContext,
5638 ) -> Result<()> {
5639 let version = deserialize_version(envelope.payload.version);
5640 let mtime = envelope
5641 .payload
5642 .mtime
5643 .ok_or_else(|| anyhow!("missing mtime"))?
5644 .into();
5645
5646 this.update(&mut cx, |this, cx| {
5647 let buffer = this
5648 .opened_buffers
5649 .get(&envelope.payload.buffer_id)
5650 .and_then(|buffer| buffer.upgrade(cx));
5651 if let Some(buffer) = buffer {
5652 buffer.update(cx, |buffer, cx| {
5653 buffer.did_save(version, envelope.payload.fingerprint, mtime, None, cx);
5654 });
5655 }
5656 Ok(())
5657 })
5658 }
5659
5660 async fn handle_buffer_reloaded(
5661 this: ModelHandle<Self>,
5662 envelope: TypedEnvelope<proto::BufferReloaded>,
5663 _: Arc<Client>,
5664 mut cx: AsyncAppContext,
5665 ) -> Result<()> {
5666 let payload = envelope.payload;
5667 let version = deserialize_version(payload.version);
5668 let line_ending = deserialize_line_ending(
5669 proto::LineEnding::from_i32(payload.line_ending)
5670 .ok_or_else(|| anyhow!("missing line ending"))?,
5671 );
5672 let mtime = payload
5673 .mtime
5674 .ok_or_else(|| anyhow!("missing mtime"))?
5675 .into();
5676 this.update(&mut cx, |this, cx| {
5677 let buffer = this
5678 .opened_buffers
5679 .get(&payload.buffer_id)
5680 .and_then(|buffer| buffer.upgrade(cx));
5681 if let Some(buffer) = buffer {
5682 buffer.update(cx, |buffer, cx| {
5683 buffer.did_reload(version, payload.fingerprint, line_ending, mtime, cx);
5684 });
5685 }
5686 Ok(())
5687 })
5688 }
5689
5690 #[allow(clippy::type_complexity)]
5691 fn edits_from_lsp(
5692 &mut self,
5693 buffer: &ModelHandle<Buffer>,
5694 lsp_edits: impl 'static + Send + IntoIterator<Item = lsp::TextEdit>,
5695 version: Option<i32>,
5696 cx: &mut ModelContext<Self>,
5697 ) -> Task<Result<Vec<(Range<Anchor>, String)>>> {
5698 let snapshot = self.buffer_snapshot_for_lsp_version(buffer, version, cx);
5699 cx.background().spawn(async move {
5700 let snapshot = snapshot?;
5701 let mut lsp_edits = lsp_edits
5702 .into_iter()
5703 .map(|edit| (range_from_lsp(edit.range), edit.new_text))
5704 .collect::<Vec<_>>();
5705 lsp_edits.sort_by_key(|(range, _)| range.start);
5706
5707 let mut lsp_edits = lsp_edits.into_iter().peekable();
5708 let mut edits = Vec::new();
5709 while let Some((mut range, mut new_text)) = lsp_edits.next() {
5710 // Clip invalid ranges provided by the language server.
5711 range.start = snapshot.clip_point_utf16(range.start, Bias::Left);
5712 range.end = snapshot.clip_point_utf16(range.end, Bias::Left);
5713
5714 // Combine any LSP edits that are adjacent.
5715 //
5716 // Also, combine LSP edits that are separated from each other by only
5717 // a newline. This is important because for some code actions,
5718 // Rust-analyzer rewrites the entire buffer via a series of edits that
5719 // are separated by unchanged newline characters.
5720 //
5721 // In order for the diffing logic below to work properly, any edits that
5722 // cancel each other out must be combined into one.
5723 while let Some((next_range, next_text)) = lsp_edits.peek() {
5724 if next_range.start > range.end {
5725 if next_range.start.row > range.end.row + 1
5726 || next_range.start.column > 0
5727 || snapshot.clip_point_utf16(
5728 PointUtf16::new(range.end.row, u32::MAX),
5729 Bias::Left,
5730 ) > range.end
5731 {
5732 break;
5733 }
5734 new_text.push('\n');
5735 }
5736 range.end = next_range.end;
5737 new_text.push_str(next_text);
5738 lsp_edits.next();
5739 }
5740
5741 // For multiline edits, perform a diff of the old and new text so that
5742 // we can identify the changes more precisely, preserving the locations
5743 // of any anchors positioned in the unchanged regions.
5744 if range.end.row > range.start.row {
5745 let mut offset = range.start.to_offset(&snapshot);
5746 let old_text = snapshot.text_for_range(range).collect::<String>();
5747
5748 let diff = TextDiff::from_lines(old_text.as_str(), &new_text);
5749 let mut moved_since_edit = true;
5750 for change in diff.iter_all_changes() {
5751 let tag = change.tag();
5752 let value = change.value();
5753 match tag {
5754 ChangeTag::Equal => {
5755 offset += value.len();
5756 moved_since_edit = true;
5757 }
5758 ChangeTag::Delete => {
5759 let start = snapshot.anchor_after(offset);
5760 let end = snapshot.anchor_before(offset + value.len());
5761 if moved_since_edit {
5762 edits.push((start..end, String::new()));
5763 } else {
5764 edits.last_mut().unwrap().0.end = end;
5765 }
5766 offset += value.len();
5767 moved_since_edit = false;
5768 }
5769 ChangeTag::Insert => {
5770 if moved_since_edit {
5771 let anchor = snapshot.anchor_after(offset);
5772 edits.push((anchor..anchor, value.to_string()));
5773 } else {
5774 edits.last_mut().unwrap().1.push_str(value);
5775 }
5776 moved_since_edit = false;
5777 }
5778 }
5779 }
5780 } else if range.end == range.start {
5781 let anchor = snapshot.anchor_after(range.start);
5782 edits.push((anchor..anchor, new_text));
5783 } else {
5784 let edit_start = snapshot.anchor_after(range.start);
5785 let edit_end = snapshot.anchor_before(range.end);
5786 edits.push((edit_start..edit_end, new_text));
5787 }
5788 }
5789
5790 Ok(edits)
5791 })
5792 }
5793
5794 fn buffer_snapshot_for_lsp_version(
5795 &mut self,
5796 buffer: &ModelHandle<Buffer>,
5797 version: Option<i32>,
5798 cx: &AppContext,
5799 ) -> Result<TextBufferSnapshot> {
5800 const OLD_VERSIONS_TO_RETAIN: i32 = 10;
5801
5802 if let Some(version) = version {
5803 let buffer_id = buffer.read(cx).remote_id();
5804 let snapshots = self
5805 .buffer_snapshots
5806 .get_mut(&buffer_id)
5807 .ok_or_else(|| anyhow!("no snapshot found for buffer {}", buffer_id))?;
5808 let mut found_snapshot = None;
5809 snapshots.retain(|(snapshot_version, snapshot)| {
5810 if snapshot_version + OLD_VERSIONS_TO_RETAIN < version {
5811 false
5812 } else {
5813 if *snapshot_version == version {
5814 found_snapshot = Some(snapshot.clone());
5815 }
5816 true
5817 }
5818 });
5819
5820 found_snapshot.ok_or_else(|| {
5821 anyhow!(
5822 "snapshot not found for buffer {} at version {}",
5823 buffer_id,
5824 version
5825 )
5826 })
5827 } else {
5828 Ok((buffer.read(cx)).text_snapshot())
5829 }
5830 }
5831
5832 fn language_server_for_buffer(
5833 &self,
5834 buffer: &Buffer,
5835 cx: &AppContext,
5836 ) -> Option<(&Arc<CachedLspAdapter>, &Arc<LanguageServer>)> {
5837 if let Some((file, language)) = File::from_dyn(buffer.file()).zip(buffer.language()) {
5838 let name = language.lsp_adapter()?.name.clone();
5839 let worktree_id = file.worktree_id(cx);
5840 let key = (worktree_id, name);
5841
5842 if let Some(server_id) = self.language_server_ids.get(&key) {
5843 if let Some(LanguageServerState::Running {
5844 adapter, server, ..
5845 }) = self.language_servers.get(server_id)
5846 {
5847 return Some((adapter, server));
5848 }
5849 }
5850 }
5851
5852 None
5853 }
5854}
5855
5856impl ProjectStore {
5857 pub fn new() -> Self {
5858 Self {
5859 projects: Default::default(),
5860 }
5861 }
5862
5863 pub fn projects<'a>(
5864 &'a self,
5865 cx: &'a AppContext,
5866 ) -> impl 'a + Iterator<Item = ModelHandle<Project>> {
5867 self.projects
5868 .iter()
5869 .filter_map(|project| project.upgrade(cx))
5870 }
5871
5872 fn add_project(&mut self, project: WeakModelHandle<Project>, cx: &mut ModelContext<Self>) {
5873 if let Err(ix) = self
5874 .projects
5875 .binary_search_by_key(&project.id(), WeakModelHandle::id)
5876 {
5877 self.projects.insert(ix, project);
5878 }
5879 cx.notify();
5880 }
5881
5882 fn prune_projects(&mut self, cx: &mut ModelContext<Self>) {
5883 let mut did_change = false;
5884 self.projects.retain(|project| {
5885 if project.is_upgradable(cx) {
5886 true
5887 } else {
5888 did_change = true;
5889 false
5890 }
5891 });
5892 if did_change {
5893 cx.notify();
5894 }
5895 }
5896}
5897
5898impl WorktreeHandle {
5899 pub fn upgrade(&self, cx: &AppContext) -> Option<ModelHandle<Worktree>> {
5900 match self {
5901 WorktreeHandle::Strong(handle) => Some(handle.clone()),
5902 WorktreeHandle::Weak(handle) => handle.upgrade(cx),
5903 }
5904 }
5905}
5906
5907impl OpenBuffer {
5908 pub fn upgrade(&self, cx: &impl UpgradeModelHandle) -> Option<ModelHandle<Buffer>> {
5909 match self {
5910 OpenBuffer::Strong(handle) => Some(handle.clone()),
5911 OpenBuffer::Weak(handle) => handle.upgrade(cx),
5912 OpenBuffer::Operations(_) => None,
5913 }
5914 }
5915}
5916
5917pub struct PathMatchCandidateSet {
5918 pub snapshot: Snapshot,
5919 pub include_ignored: bool,
5920 pub include_root_name: bool,
5921}
5922
5923impl<'a> fuzzy::PathMatchCandidateSet<'a> for PathMatchCandidateSet {
5924 type Candidates = PathMatchCandidateSetIter<'a>;
5925
5926 fn id(&self) -> usize {
5927 self.snapshot.id().to_usize()
5928 }
5929
5930 fn len(&self) -> usize {
5931 if self.include_ignored {
5932 self.snapshot.file_count()
5933 } else {
5934 self.snapshot.visible_file_count()
5935 }
5936 }
5937
5938 fn prefix(&self) -> Arc<str> {
5939 if self.snapshot.root_entry().map_or(false, |e| e.is_file()) {
5940 self.snapshot.root_name().into()
5941 } else if self.include_root_name {
5942 format!("{}/", self.snapshot.root_name()).into()
5943 } else {
5944 "".into()
5945 }
5946 }
5947
5948 fn candidates(&'a self, start: usize) -> Self::Candidates {
5949 PathMatchCandidateSetIter {
5950 traversal: self.snapshot.files(self.include_ignored, start),
5951 }
5952 }
5953}
5954
5955pub struct PathMatchCandidateSetIter<'a> {
5956 traversal: Traversal<'a>,
5957}
5958
5959impl<'a> Iterator for PathMatchCandidateSetIter<'a> {
5960 type Item = fuzzy::PathMatchCandidate<'a>;
5961
5962 fn next(&mut self) -> Option<Self::Item> {
5963 self.traversal.next().map(|entry| {
5964 if let EntryKind::File(char_bag) = entry.kind {
5965 fuzzy::PathMatchCandidate {
5966 path: &entry.path,
5967 char_bag,
5968 }
5969 } else {
5970 unreachable!()
5971 }
5972 })
5973 }
5974}
5975
5976impl Entity for ProjectStore {
5977 type Event = ();
5978}
5979
5980impl Entity for Project {
5981 type Event = Event;
5982
5983 fn release(&mut self, cx: &mut gpui::MutableAppContext) {
5984 self.project_store.update(cx, ProjectStore::prune_projects);
5985
5986 match &self.client_state {
5987 Some(ProjectClientState::Local { remote_id, .. }) => {
5988 self.client
5989 .send(proto::UnshareProject {
5990 project_id: *remote_id,
5991 })
5992 .log_err();
5993 }
5994 Some(ProjectClientState::Remote { remote_id, .. }) => {
5995 self.client
5996 .send(proto::LeaveProject {
5997 project_id: *remote_id,
5998 })
5999 .log_err();
6000 }
6001 _ => {}
6002 }
6003 }
6004
6005 fn app_will_quit(
6006 &mut self,
6007 _: &mut MutableAppContext,
6008 ) -> Option<std::pin::Pin<Box<dyn 'static + Future<Output = ()>>>> {
6009 let shutdown_futures = self
6010 .language_servers
6011 .drain()
6012 .map(|(_, server_state)| async {
6013 match server_state {
6014 LanguageServerState::Running { server, .. } => server.shutdown()?.await,
6015 LanguageServerState::Starting(starting_server) => {
6016 starting_server.await?.shutdown()?.await
6017 }
6018 }
6019 })
6020 .collect::<Vec<_>>();
6021
6022 Some(
6023 async move {
6024 futures::future::join_all(shutdown_futures).await;
6025 }
6026 .boxed(),
6027 )
6028 }
6029}
6030
6031impl Collaborator {
6032 fn from_proto(message: proto::Collaborator) -> Self {
6033 Self {
6034 peer_id: PeerId(message.peer_id),
6035 replica_id: message.replica_id as ReplicaId,
6036 }
6037 }
6038}
6039
6040impl<P: AsRef<Path>> From<(WorktreeId, P)> for ProjectPath {
6041 fn from((worktree_id, path): (WorktreeId, P)) -> Self {
6042 Self {
6043 worktree_id,
6044 path: path.as_ref().into(),
6045 }
6046 }
6047}
6048
6049fn serialize_symbol(symbol: &Symbol) -> proto::Symbol {
6050 proto::Symbol {
6051 language_server_name: symbol.language_server_name.0.to_string(),
6052 source_worktree_id: symbol.source_worktree_id.to_proto(),
6053 worktree_id: symbol.path.worktree_id.to_proto(),
6054 path: symbol.path.path.to_string_lossy().to_string(),
6055 name: symbol.name.clone(),
6056 kind: unsafe { mem::transmute(symbol.kind) },
6057 start: Some(proto::Point {
6058 row: symbol.range.start.row,
6059 column: symbol.range.start.column,
6060 }),
6061 end: Some(proto::Point {
6062 row: symbol.range.end.row,
6063 column: symbol.range.end.column,
6064 }),
6065 signature: symbol.signature.to_vec(),
6066 }
6067}
6068
6069fn relativize_path(base: &Path, path: &Path) -> PathBuf {
6070 let mut path_components = path.components();
6071 let mut base_components = base.components();
6072 let mut components: Vec<Component> = Vec::new();
6073 loop {
6074 match (path_components.next(), base_components.next()) {
6075 (None, None) => break,
6076 (Some(a), None) => {
6077 components.push(a);
6078 components.extend(path_components.by_ref());
6079 break;
6080 }
6081 (None, _) => components.push(Component::ParentDir),
6082 (Some(a), Some(b)) if components.is_empty() && a == b => (),
6083 (Some(a), Some(b)) if b == Component::CurDir => components.push(a),
6084 (Some(a), Some(_)) => {
6085 components.push(Component::ParentDir);
6086 for _ in base_components {
6087 components.push(Component::ParentDir);
6088 }
6089 components.push(a);
6090 components.extend(path_components.by_ref());
6091 break;
6092 }
6093 }
6094 }
6095 components.iter().map(|c| c.as_os_str()).collect()
6096}
6097
6098impl Item for Buffer {
6099 fn entry_id(&self, cx: &AppContext) -> Option<ProjectEntryId> {
6100 File::from_dyn(self.file()).and_then(|file| file.project_entry_id(cx))
6101 }
6102}