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 Unclipped,
30};
31use lsp::{
32 DiagnosticSeverity, DiagnosticTag, DocumentHighlightKind, LanguageServer, LanguageString,
33 MarkedString,
34};
35use lsp_command::*;
36use parking_lot::Mutex;
37use postage::watch;
38use rand::prelude::*;
39use search::SearchQuery;
40use serde::Serialize;
41use settings::{FormatOnSave, Formatter, Settings};
42use sha2::{Digest, Sha256};
43use similar::{ChangeTag, TextDiff};
44use std::{
45 cell::RefCell,
46 cmp::{self, Ordering},
47 convert::TryInto,
48 ffi::OsString,
49 hash::Hash,
50 mem,
51 num::NonZeroU32,
52 ops::Range,
53 os::unix::{ffi::OsStrExt, prelude::OsStringExt},
54 path::{Component, Path, PathBuf},
55 rc::Rc,
56 str,
57 sync::{
58 atomic::{AtomicUsize, Ordering::SeqCst},
59 Arc,
60 },
61 time::Instant,
62};
63use thiserror::Error;
64use util::{defer, post_inc, ResultExt, TryFutureExt as _};
65
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<Unclipped<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<Unclipped<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<Unclipped<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::<Unclipped<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 codepoint
2683 if range.start == range.end {
2684 // This will be go to the next boundary when being clipped
2685 range.end.column += 1;
2686 range.end = snapshot.clip_point_utf16(Unclipped(range.end), Bias::Right);
2687 if range.start == range.end && range.end.column > 0 {
2688 range.start.column -= 1;
2689 range.end = snapshot.clip_point_utf16(Unclipped(range.end), Bias::Left);
2690 }
2691 }
2692
2693 sanitized_diagnostics.push(DiagnosticEntry {
2694 range,
2695 diagnostic: entry.diagnostic,
2696 });
2697 }
2698 drop(edits_since_save);
2699
2700 let set = DiagnosticSet::new(sanitized_diagnostics, &snapshot);
2701 buffer.update(cx, |buffer, cx| buffer.update_diagnostics(set, cx));
2702 Ok(())
2703 }
2704
2705 pub fn reload_buffers(
2706 &self,
2707 buffers: HashSet<ModelHandle<Buffer>>,
2708 push_to_history: bool,
2709 cx: &mut ModelContext<Self>,
2710 ) -> Task<Result<ProjectTransaction>> {
2711 let mut local_buffers = Vec::new();
2712 let mut remote_buffers = None;
2713 for buffer_handle in buffers {
2714 let buffer = buffer_handle.read(cx);
2715 if buffer.is_dirty() {
2716 if let Some(file) = File::from_dyn(buffer.file()) {
2717 if file.is_local() {
2718 local_buffers.push(buffer_handle);
2719 } else {
2720 remote_buffers.get_or_insert(Vec::new()).push(buffer_handle);
2721 }
2722 }
2723 }
2724 }
2725
2726 let remote_buffers = self.remote_id().zip(remote_buffers);
2727 let client = self.client.clone();
2728
2729 cx.spawn(|this, mut cx| async move {
2730 let mut project_transaction = ProjectTransaction::default();
2731
2732 if let Some((project_id, remote_buffers)) = remote_buffers {
2733 let response = client
2734 .request(proto::ReloadBuffers {
2735 project_id,
2736 buffer_ids: remote_buffers
2737 .iter()
2738 .map(|buffer| buffer.read_with(&cx, |buffer, _| buffer.remote_id()))
2739 .collect(),
2740 })
2741 .await?
2742 .transaction
2743 .ok_or_else(|| anyhow!("missing transaction"))?;
2744 project_transaction = this
2745 .update(&mut cx, |this, cx| {
2746 this.deserialize_project_transaction(response, push_to_history, cx)
2747 })
2748 .await?;
2749 }
2750
2751 for buffer in local_buffers {
2752 let transaction = buffer
2753 .update(&mut cx, |buffer, cx| buffer.reload(cx))
2754 .await?;
2755 buffer.update(&mut cx, |buffer, cx| {
2756 if let Some(transaction) = transaction {
2757 if !push_to_history {
2758 buffer.forget_transaction(transaction.id);
2759 }
2760 project_transaction.0.insert(cx.handle(), transaction);
2761 }
2762 });
2763 }
2764
2765 Ok(project_transaction)
2766 })
2767 }
2768
2769 pub fn format(
2770 &self,
2771 buffers: HashSet<ModelHandle<Buffer>>,
2772 push_to_history: bool,
2773 trigger: FormatTrigger,
2774 cx: &mut ModelContext<Project>,
2775 ) -> Task<Result<ProjectTransaction>> {
2776 let mut local_buffers = Vec::new();
2777 let mut remote_buffers = None;
2778 for buffer_handle in buffers {
2779 let buffer = buffer_handle.read(cx);
2780 if let Some(file) = File::from_dyn(buffer.file()) {
2781 if let Some(buffer_abs_path) = file.as_local().map(|f| f.abs_path(cx)) {
2782 if let Some((_, server)) = self.language_server_for_buffer(buffer, cx) {
2783 local_buffers.push((buffer_handle, buffer_abs_path, server.clone()));
2784 }
2785 } else {
2786 remote_buffers.get_or_insert(Vec::new()).push(buffer_handle);
2787 }
2788 } else {
2789 return Task::ready(Ok(Default::default()));
2790 }
2791 }
2792
2793 let remote_buffers = self.remote_id().zip(remote_buffers);
2794 let client = self.client.clone();
2795
2796 cx.spawn(|this, mut cx| async move {
2797 let mut project_transaction = ProjectTransaction::default();
2798
2799 if let Some((project_id, remote_buffers)) = remote_buffers {
2800 let response = client
2801 .request(proto::FormatBuffers {
2802 project_id,
2803 trigger: trigger as i32,
2804 buffer_ids: remote_buffers
2805 .iter()
2806 .map(|buffer| buffer.read_with(&cx, |buffer, _| buffer.remote_id()))
2807 .collect(),
2808 })
2809 .await?
2810 .transaction
2811 .ok_or_else(|| anyhow!("missing transaction"))?;
2812 project_transaction = this
2813 .update(&mut cx, |this, cx| {
2814 this.deserialize_project_transaction(response, push_to_history, cx)
2815 })
2816 .await?;
2817 }
2818
2819 // Do not allow multiple concurrent formatting requests for the
2820 // same buffer.
2821 this.update(&mut cx, |this, _| {
2822 local_buffers
2823 .retain(|(buffer, _, _)| this.buffers_being_formatted.insert(buffer.id()));
2824 });
2825 let _cleanup = defer({
2826 let this = this.clone();
2827 let mut cx = cx.clone();
2828 let local_buffers = &local_buffers;
2829 move || {
2830 this.update(&mut cx, |this, _| {
2831 for (buffer, _, _) in local_buffers {
2832 this.buffers_being_formatted.remove(&buffer.id());
2833 }
2834 });
2835 }
2836 });
2837
2838 for (buffer, buffer_abs_path, language_server) in &local_buffers {
2839 let (format_on_save, formatter, tab_size) = buffer.read_with(&cx, |buffer, cx| {
2840 let settings = cx.global::<Settings>();
2841 let language_name = buffer.language().map(|language| language.name());
2842 (
2843 settings.format_on_save(language_name.as_deref()),
2844 settings.formatter(language_name.as_deref()),
2845 settings.tab_size(language_name.as_deref()),
2846 )
2847 });
2848
2849 let transaction = match (formatter, format_on_save) {
2850 (_, FormatOnSave::Off) if trigger == FormatTrigger::Save => continue,
2851
2852 (Formatter::LanguageServer, FormatOnSave::On | FormatOnSave::Off)
2853 | (_, FormatOnSave::LanguageServer) => Self::format_via_lsp(
2854 &this,
2855 &buffer,
2856 &buffer_abs_path,
2857 &language_server,
2858 tab_size,
2859 &mut cx,
2860 )
2861 .await
2862 .context("failed to format via language server")?,
2863
2864 (
2865 Formatter::External { command, arguments },
2866 FormatOnSave::On | FormatOnSave::Off,
2867 )
2868 | (_, FormatOnSave::External { command, arguments }) => {
2869 Self::format_via_external_command(
2870 &buffer,
2871 &buffer_abs_path,
2872 &command,
2873 &arguments,
2874 &mut cx,
2875 )
2876 .await
2877 .context(format!(
2878 "failed to format via external command {:?}",
2879 command
2880 ))?
2881 }
2882 };
2883
2884 if let Some(transaction) = transaction {
2885 if !push_to_history {
2886 buffer.update(&mut cx, |buffer, _| {
2887 buffer.forget_transaction(transaction.id)
2888 });
2889 }
2890 project_transaction.0.insert(buffer.clone(), transaction);
2891 }
2892 }
2893
2894 Ok(project_transaction)
2895 })
2896 }
2897
2898 async fn format_via_lsp(
2899 this: &ModelHandle<Self>,
2900 buffer: &ModelHandle<Buffer>,
2901 abs_path: &Path,
2902 language_server: &Arc<LanguageServer>,
2903 tab_size: NonZeroU32,
2904 cx: &mut AsyncAppContext,
2905 ) -> Result<Option<Transaction>> {
2906 let text_document =
2907 lsp::TextDocumentIdentifier::new(lsp::Url::from_file_path(abs_path).unwrap());
2908 let capabilities = &language_server.capabilities();
2909 let lsp_edits = if capabilities
2910 .document_formatting_provider
2911 .as_ref()
2912 .map_or(false, |provider| *provider != lsp::OneOf::Left(false))
2913 {
2914 language_server
2915 .request::<lsp::request::Formatting>(lsp::DocumentFormattingParams {
2916 text_document,
2917 options: lsp::FormattingOptions {
2918 tab_size: tab_size.into(),
2919 insert_spaces: true,
2920 insert_final_newline: Some(true),
2921 ..Default::default()
2922 },
2923 work_done_progress_params: Default::default(),
2924 })
2925 .await?
2926 } else if capabilities
2927 .document_range_formatting_provider
2928 .as_ref()
2929 .map_or(false, |provider| *provider != lsp::OneOf::Left(false))
2930 {
2931 let buffer_start = lsp::Position::new(0, 0);
2932 let buffer_end =
2933 buffer.read_with(cx, |buffer, _| point_to_lsp(buffer.max_point_utf16()));
2934 language_server
2935 .request::<lsp::request::RangeFormatting>(lsp::DocumentRangeFormattingParams {
2936 text_document,
2937 range: lsp::Range::new(buffer_start, buffer_end),
2938 options: lsp::FormattingOptions {
2939 tab_size: tab_size.into(),
2940 insert_spaces: true,
2941 insert_final_newline: Some(true),
2942 ..Default::default()
2943 },
2944 work_done_progress_params: Default::default(),
2945 })
2946 .await?
2947 } else {
2948 None
2949 };
2950
2951 if let Some(lsp_edits) = lsp_edits {
2952 let edits = this
2953 .update(cx, |this, cx| {
2954 this.edits_from_lsp(buffer, lsp_edits, None, cx)
2955 })
2956 .await?;
2957 buffer.update(cx, |buffer, cx| {
2958 buffer.finalize_last_transaction();
2959 buffer.start_transaction();
2960 for (range, text) in edits {
2961 buffer.edit([(range, text)], None, cx);
2962 }
2963 if buffer.end_transaction(cx).is_some() {
2964 let transaction = buffer.finalize_last_transaction().unwrap().clone();
2965 Ok(Some(transaction))
2966 } else {
2967 Ok(None)
2968 }
2969 })
2970 } else {
2971 Ok(None)
2972 }
2973 }
2974
2975 async fn format_via_external_command(
2976 buffer: &ModelHandle<Buffer>,
2977 buffer_abs_path: &Path,
2978 command: &str,
2979 arguments: &[String],
2980 cx: &mut AsyncAppContext,
2981 ) -> Result<Option<Transaction>> {
2982 let working_dir_path = buffer.read_with(cx, |buffer, cx| {
2983 let file = File::from_dyn(buffer.file())?;
2984 let worktree = file.worktree.read(cx).as_local()?;
2985 let mut worktree_path = worktree.abs_path().to_path_buf();
2986 if worktree.root_entry()?.is_file() {
2987 worktree_path.pop();
2988 }
2989 Some(worktree_path)
2990 });
2991
2992 if let Some(working_dir_path) = working_dir_path {
2993 let mut child =
2994 smol::process::Command::new(command)
2995 .args(arguments.iter().map(|arg| {
2996 arg.replace("{buffer_path}", &buffer_abs_path.to_string_lossy())
2997 }))
2998 .current_dir(&working_dir_path)
2999 .stdin(smol::process::Stdio::piped())
3000 .stdout(smol::process::Stdio::piped())
3001 .stderr(smol::process::Stdio::piped())
3002 .spawn()?;
3003 let stdin = child
3004 .stdin
3005 .as_mut()
3006 .ok_or_else(|| anyhow!("failed to acquire stdin"))?;
3007 let text = buffer.read_with(cx, |buffer, _| buffer.as_rope().clone());
3008 for chunk in text.chunks() {
3009 stdin.write_all(chunk.as_bytes()).await?;
3010 }
3011 stdin.flush().await?;
3012
3013 let output = child.output().await?;
3014 if !output.status.success() {
3015 return Err(anyhow!(
3016 "command failed with exit code {:?}:\nstdout: {}\nstderr: {}",
3017 output.status.code(),
3018 String::from_utf8_lossy(&output.stdout),
3019 String::from_utf8_lossy(&output.stderr),
3020 ));
3021 }
3022
3023 let stdout = String::from_utf8(output.stdout)?;
3024 let diff = buffer
3025 .read_with(cx, |buffer, cx| buffer.diff(stdout, cx))
3026 .await;
3027 Ok(buffer.update(cx, |buffer, cx| buffer.apply_diff(diff, cx).cloned()))
3028 } else {
3029 Ok(None)
3030 }
3031 }
3032
3033 pub fn definition<T: ToPointUtf16>(
3034 &self,
3035 buffer: &ModelHandle<Buffer>,
3036 position: T,
3037 cx: &mut ModelContext<Self>,
3038 ) -> Task<Result<Vec<LocationLink>>> {
3039 let position = position.to_point_utf16(buffer.read(cx));
3040 self.request_lsp(buffer.clone(), GetDefinition { position }, cx)
3041 }
3042
3043 pub fn type_definition<T: ToPointUtf16>(
3044 &self,
3045 buffer: &ModelHandle<Buffer>,
3046 position: T,
3047 cx: &mut ModelContext<Self>,
3048 ) -> Task<Result<Vec<LocationLink>>> {
3049 let position = position.to_point_utf16(buffer.read(cx));
3050 self.request_lsp(buffer.clone(), GetTypeDefinition { position }, cx)
3051 }
3052
3053 pub fn references<T: ToPointUtf16>(
3054 &self,
3055 buffer: &ModelHandle<Buffer>,
3056 position: T,
3057 cx: &mut ModelContext<Self>,
3058 ) -> Task<Result<Vec<Location>>> {
3059 let position = position.to_point_utf16(buffer.read(cx));
3060 self.request_lsp(buffer.clone(), GetReferences { position }, cx)
3061 }
3062
3063 pub fn document_highlights<T: ToPointUtf16>(
3064 &self,
3065 buffer: &ModelHandle<Buffer>,
3066 position: T,
3067 cx: &mut ModelContext<Self>,
3068 ) -> Task<Result<Vec<DocumentHighlight>>> {
3069 let position = position.to_point_utf16(buffer.read(cx));
3070 self.request_lsp(buffer.clone(), GetDocumentHighlights { position }, cx)
3071 }
3072
3073 pub fn symbols(&self, query: &str, cx: &mut ModelContext<Self>) -> Task<Result<Vec<Symbol>>> {
3074 if self.is_local() {
3075 let mut requests = Vec::new();
3076 for ((worktree_id, _), server_id) in self.language_server_ids.iter() {
3077 let worktree_id = *worktree_id;
3078 if let Some(worktree) = self
3079 .worktree_for_id(worktree_id, cx)
3080 .and_then(|worktree| worktree.read(cx).as_local())
3081 {
3082 if let Some(LanguageServerState::Running {
3083 adapter,
3084 language,
3085 server,
3086 }) = self.language_servers.get(server_id)
3087 {
3088 let adapter = adapter.clone();
3089 let language = language.clone();
3090 let worktree_abs_path = worktree.abs_path().clone();
3091 requests.push(
3092 server
3093 .request::<lsp::request::WorkspaceSymbol>(
3094 lsp::WorkspaceSymbolParams {
3095 query: query.to_string(),
3096 ..Default::default()
3097 },
3098 )
3099 .log_err()
3100 .map(move |response| {
3101 (
3102 adapter,
3103 language,
3104 worktree_id,
3105 worktree_abs_path,
3106 response.unwrap_or_default(),
3107 )
3108 }),
3109 );
3110 }
3111 }
3112 }
3113
3114 cx.spawn_weak(|this, cx| async move {
3115 let responses = futures::future::join_all(requests).await;
3116 let this = if let Some(this) = this.upgrade(&cx) {
3117 this
3118 } else {
3119 return Ok(Default::default());
3120 };
3121 let symbols = this.read_with(&cx, |this, cx| {
3122 let mut symbols = Vec::new();
3123 for (
3124 adapter,
3125 adapter_language,
3126 source_worktree_id,
3127 worktree_abs_path,
3128 response,
3129 ) in responses
3130 {
3131 symbols.extend(response.into_iter().flatten().filter_map(|lsp_symbol| {
3132 let abs_path = lsp_symbol.location.uri.to_file_path().ok()?;
3133 let mut worktree_id = source_worktree_id;
3134 let path;
3135 if let Some((worktree, rel_path)) =
3136 this.find_local_worktree(&abs_path, cx)
3137 {
3138 worktree_id = worktree.read(cx).id();
3139 path = rel_path;
3140 } else {
3141 path = relativize_path(&worktree_abs_path, &abs_path);
3142 }
3143
3144 let project_path = ProjectPath {
3145 worktree_id,
3146 path: path.into(),
3147 };
3148 let signature = this.symbol_signature(&project_path);
3149 let language = this
3150 .languages
3151 .select_language(&project_path.path)
3152 .unwrap_or(adapter_language.clone());
3153 let language_server_name = adapter.name.clone();
3154 Some(async move {
3155 let label = language
3156 .label_for_symbol(&lsp_symbol.name, lsp_symbol.kind)
3157 .await;
3158
3159 Symbol {
3160 language_server_name,
3161 source_worktree_id,
3162 path: project_path,
3163 label: label.unwrap_or_else(|| {
3164 CodeLabel::plain(lsp_symbol.name.clone(), None)
3165 }),
3166 kind: lsp_symbol.kind,
3167 name: lsp_symbol.name,
3168 range: range_from_lsp(lsp_symbol.location.range),
3169 signature,
3170 }
3171 })
3172 }));
3173 }
3174 symbols
3175 });
3176 Ok(futures::future::join_all(symbols).await)
3177 })
3178 } else if let Some(project_id) = self.remote_id() {
3179 let request = self.client.request(proto::GetProjectSymbols {
3180 project_id,
3181 query: query.to_string(),
3182 });
3183 cx.spawn_weak(|this, cx| async move {
3184 let response = request.await?;
3185 let mut symbols = Vec::new();
3186 if let Some(this) = this.upgrade(&cx) {
3187 let new_symbols = this.read_with(&cx, |this, _| {
3188 response
3189 .symbols
3190 .into_iter()
3191 .map(|symbol| this.deserialize_symbol(symbol))
3192 .collect::<Vec<_>>()
3193 });
3194 symbols = futures::future::join_all(new_symbols)
3195 .await
3196 .into_iter()
3197 .filter_map(|symbol| symbol.log_err())
3198 .collect::<Vec<_>>();
3199 }
3200 Ok(symbols)
3201 })
3202 } else {
3203 Task::ready(Ok(Default::default()))
3204 }
3205 }
3206
3207 pub fn open_buffer_for_symbol(
3208 &mut self,
3209 symbol: &Symbol,
3210 cx: &mut ModelContext<Self>,
3211 ) -> Task<Result<ModelHandle<Buffer>>> {
3212 if self.is_local() {
3213 let language_server_id = if let Some(id) = self.language_server_ids.get(&(
3214 symbol.source_worktree_id,
3215 symbol.language_server_name.clone(),
3216 )) {
3217 *id
3218 } else {
3219 return Task::ready(Err(anyhow!(
3220 "language server for worktree and language not found"
3221 )));
3222 };
3223
3224 let worktree_abs_path = if let Some(worktree_abs_path) = self
3225 .worktree_for_id(symbol.path.worktree_id, cx)
3226 .and_then(|worktree| worktree.read(cx).as_local())
3227 .map(|local_worktree| local_worktree.abs_path())
3228 {
3229 worktree_abs_path
3230 } else {
3231 return Task::ready(Err(anyhow!("worktree not found for symbol")));
3232 };
3233 let symbol_abs_path = worktree_abs_path.join(&symbol.path.path);
3234 let symbol_uri = if let Ok(uri) = lsp::Url::from_file_path(symbol_abs_path) {
3235 uri
3236 } else {
3237 return Task::ready(Err(anyhow!("invalid symbol path")));
3238 };
3239
3240 self.open_local_buffer_via_lsp(
3241 symbol_uri,
3242 language_server_id,
3243 symbol.language_server_name.clone(),
3244 cx,
3245 )
3246 } else if let Some(project_id) = self.remote_id() {
3247 let request = self.client.request(proto::OpenBufferForSymbol {
3248 project_id,
3249 symbol: Some(serialize_symbol(symbol)),
3250 });
3251 cx.spawn(|this, mut cx| async move {
3252 let response = request.await?;
3253 this.update(&mut cx, |this, cx| {
3254 this.wait_for_buffer(response.buffer_id, cx)
3255 })
3256 .await
3257 })
3258 } else {
3259 Task::ready(Err(anyhow!("project does not have a remote id")))
3260 }
3261 }
3262
3263 pub fn hover<T: ToPointUtf16>(
3264 &self,
3265 buffer: &ModelHandle<Buffer>,
3266 position: T,
3267 cx: &mut ModelContext<Self>,
3268 ) -> Task<Result<Option<Hover>>> {
3269 let position = position.to_point_utf16(buffer.read(cx));
3270 self.request_lsp(buffer.clone(), GetHover { position }, cx)
3271 }
3272
3273 pub fn completions<T: ToPointUtf16>(
3274 &self,
3275 source_buffer_handle: &ModelHandle<Buffer>,
3276 position: T,
3277 cx: &mut ModelContext<Self>,
3278 ) -> Task<Result<Vec<Completion>>> {
3279 let source_buffer_handle = source_buffer_handle.clone();
3280 let source_buffer = source_buffer_handle.read(cx);
3281 let buffer_id = source_buffer.remote_id();
3282 let language = source_buffer.language().cloned();
3283 let worktree;
3284 let buffer_abs_path;
3285 if let Some(file) = File::from_dyn(source_buffer.file()) {
3286 worktree = file.worktree.clone();
3287 buffer_abs_path = file.as_local().map(|f| f.abs_path(cx));
3288 } else {
3289 return Task::ready(Ok(Default::default()));
3290 };
3291
3292 let position = Unclipped(position.to_point_utf16(source_buffer));
3293 let anchor = source_buffer.anchor_after(position);
3294
3295 if worktree.read(cx).as_local().is_some() {
3296 let buffer_abs_path = buffer_abs_path.unwrap();
3297 let lang_server =
3298 if let Some((_, server)) = self.language_server_for_buffer(source_buffer, cx) {
3299 server.clone()
3300 } else {
3301 return Task::ready(Ok(Default::default()));
3302 };
3303
3304 cx.spawn(|_, cx| async move {
3305 let completions = lang_server
3306 .request::<lsp::request::Completion>(lsp::CompletionParams {
3307 text_document_position: lsp::TextDocumentPositionParams::new(
3308 lsp::TextDocumentIdentifier::new(
3309 lsp::Url::from_file_path(buffer_abs_path).unwrap(),
3310 ),
3311 point_to_lsp(position.0),
3312 ),
3313 context: Default::default(),
3314 work_done_progress_params: Default::default(),
3315 partial_result_params: Default::default(),
3316 })
3317 .await
3318 .context("lsp completion request failed")?;
3319
3320 let completions = if let Some(completions) = completions {
3321 match completions {
3322 lsp::CompletionResponse::Array(completions) => completions,
3323 lsp::CompletionResponse::List(list) => list.items,
3324 }
3325 } else {
3326 Default::default()
3327 };
3328
3329 let completions = source_buffer_handle.read_with(&cx, |this, _| {
3330 let snapshot = this.snapshot();
3331 let clipped_position = this.clip_point_utf16(position, Bias::Left);
3332 let mut range_for_token = None;
3333 completions
3334 .into_iter()
3335 .filter_map(move |mut lsp_completion| {
3336 // For now, we can only handle additional edits if they are returned
3337 // when resolving the completion, not if they are present initially.
3338 if lsp_completion
3339 .additional_text_edits
3340 .as_ref()
3341 .map_or(false, |edits| !edits.is_empty())
3342 {
3343 return None;
3344 }
3345
3346 let (old_range, mut new_text) = match lsp_completion.text_edit.as_ref()
3347 {
3348 // If the language server provides a range to overwrite, then
3349 // check that the range is valid.
3350 Some(lsp::CompletionTextEdit::Edit(edit)) => {
3351 let range = range_from_lsp(edit.range);
3352 let start = snapshot.clip_point_utf16(range.start, Bias::Left);
3353 let end = snapshot.clip_point_utf16(range.end, Bias::Left);
3354 if start != range.start.0 || end != range.end.0 {
3355 log::info!("completion out of expected range");
3356 return None;
3357 }
3358 (
3359 snapshot.anchor_before(start)..snapshot.anchor_after(end),
3360 edit.new_text.clone(),
3361 )
3362 }
3363 // If the language server does not provide a range, then infer
3364 // the range based on the syntax tree.
3365 None => {
3366 if position.0 != clipped_position {
3367 log::info!("completion out of expected range");
3368 return None;
3369 }
3370 let Range { start, end } = range_for_token
3371 .get_or_insert_with(|| {
3372 let offset = position.to_offset(&snapshot);
3373 let (range, kind) = snapshot.surrounding_word(offset);
3374 if kind == Some(CharKind::Word) {
3375 range
3376 } else {
3377 offset..offset
3378 }
3379 })
3380 .clone();
3381 let text = lsp_completion
3382 .insert_text
3383 .as_ref()
3384 .unwrap_or(&lsp_completion.label)
3385 .clone();
3386 (
3387 snapshot.anchor_before(start)..snapshot.anchor_after(end),
3388 text,
3389 )
3390 }
3391 Some(lsp::CompletionTextEdit::InsertAndReplace(_)) => {
3392 log::info!("unsupported insert/replace completion");
3393 return None;
3394 }
3395 };
3396
3397 LineEnding::normalize(&mut new_text);
3398 let language = language.clone();
3399 Some(async move {
3400 let mut label = None;
3401 if let Some(language) = language {
3402 language.process_completion(&mut lsp_completion).await;
3403 label = language.label_for_completion(&lsp_completion).await;
3404 }
3405 Completion {
3406 old_range,
3407 new_text,
3408 label: label.unwrap_or_else(|| {
3409 CodeLabel::plain(
3410 lsp_completion.label.clone(),
3411 lsp_completion.filter_text.as_deref(),
3412 )
3413 }),
3414 lsp_completion,
3415 }
3416 })
3417 })
3418 });
3419
3420 Ok(futures::future::join_all(completions).await)
3421 })
3422 } else if let Some(project_id) = self.remote_id() {
3423 let rpc = self.client.clone();
3424 let message = proto::GetCompletions {
3425 project_id,
3426 buffer_id,
3427 position: Some(language::proto::serialize_anchor(&anchor)),
3428 version: serialize_version(&source_buffer.version()),
3429 };
3430 cx.spawn_weak(|_, mut cx| async move {
3431 let response = rpc.request(message).await?;
3432
3433 source_buffer_handle
3434 .update(&mut cx, |buffer, _| {
3435 buffer.wait_for_version(deserialize_version(response.version))
3436 })
3437 .await;
3438
3439 let completions = response.completions.into_iter().map(|completion| {
3440 language::proto::deserialize_completion(completion, language.clone())
3441 });
3442 futures::future::try_join_all(completions).await
3443 })
3444 } else {
3445 Task::ready(Ok(Default::default()))
3446 }
3447 }
3448
3449 pub fn apply_additional_edits_for_completion(
3450 &self,
3451 buffer_handle: ModelHandle<Buffer>,
3452 completion: Completion,
3453 push_to_history: bool,
3454 cx: &mut ModelContext<Self>,
3455 ) -> Task<Result<Option<Transaction>>> {
3456 let buffer = buffer_handle.read(cx);
3457 let buffer_id = buffer.remote_id();
3458
3459 if self.is_local() {
3460 let lang_server = match self.language_server_for_buffer(buffer, cx) {
3461 Some((_, server)) => server.clone(),
3462 _ => return Task::ready(Ok(Default::default())),
3463 };
3464
3465 cx.spawn(|this, mut cx| async move {
3466 let resolved_completion = lang_server
3467 .request::<lsp::request::ResolveCompletionItem>(completion.lsp_completion)
3468 .await?;
3469
3470 if let Some(edits) = resolved_completion.additional_text_edits {
3471 let edits = this
3472 .update(&mut cx, |this, cx| {
3473 this.edits_from_lsp(&buffer_handle, edits, None, cx)
3474 })
3475 .await?;
3476
3477 buffer_handle.update(&mut cx, |buffer, cx| {
3478 buffer.finalize_last_transaction();
3479 buffer.start_transaction();
3480
3481 for (range, text) in edits {
3482 let primary = &completion.old_range;
3483 let start_within = primary.start.cmp(&range.start, buffer).is_le()
3484 && primary.end.cmp(&range.start, buffer).is_ge();
3485 let end_within = range.start.cmp(&primary.end, buffer).is_le()
3486 && range.end.cmp(&primary.end, buffer).is_ge();
3487
3488 //Skip addtional edits which overlap with the primary completion edit
3489 //https://github.com/zed-industries/zed/pull/1871
3490 if !start_within && !end_within {
3491 buffer.edit([(range, text)], None, cx);
3492 }
3493 }
3494
3495 let transaction = if buffer.end_transaction(cx).is_some() {
3496 let transaction = buffer.finalize_last_transaction().unwrap().clone();
3497 if !push_to_history {
3498 buffer.forget_transaction(transaction.id);
3499 }
3500 Some(transaction)
3501 } else {
3502 None
3503 };
3504 Ok(transaction)
3505 })
3506 } else {
3507 Ok(None)
3508 }
3509 })
3510 } else if let Some(project_id) = self.remote_id() {
3511 let client = self.client.clone();
3512 cx.spawn(|_, mut cx| async move {
3513 let response = client
3514 .request(proto::ApplyCompletionAdditionalEdits {
3515 project_id,
3516 buffer_id,
3517 completion: Some(language::proto::serialize_completion(&completion)),
3518 })
3519 .await?;
3520
3521 if let Some(transaction) = response.transaction {
3522 let transaction = language::proto::deserialize_transaction(transaction)?;
3523 buffer_handle
3524 .update(&mut cx, |buffer, _| {
3525 buffer.wait_for_edits(transaction.edit_ids.iter().copied())
3526 })
3527 .await;
3528 if push_to_history {
3529 buffer_handle.update(&mut cx, |buffer, _| {
3530 buffer.push_transaction(transaction.clone(), Instant::now());
3531 });
3532 }
3533 Ok(Some(transaction))
3534 } else {
3535 Ok(None)
3536 }
3537 })
3538 } else {
3539 Task::ready(Err(anyhow!("project does not have a remote id")))
3540 }
3541 }
3542
3543 pub fn code_actions<T: Clone + ToOffset>(
3544 &self,
3545 buffer_handle: &ModelHandle<Buffer>,
3546 range: Range<T>,
3547 cx: &mut ModelContext<Self>,
3548 ) -> Task<Result<Vec<CodeAction>>> {
3549 let buffer_handle = buffer_handle.clone();
3550 let buffer = buffer_handle.read(cx);
3551 let snapshot = buffer.snapshot();
3552 let relevant_diagnostics = snapshot
3553 .diagnostics_in_range::<usize, usize>(range.to_offset(&snapshot), false)
3554 .map(|entry| entry.to_lsp_diagnostic_stub())
3555 .collect();
3556 let buffer_id = buffer.remote_id();
3557 let worktree;
3558 let buffer_abs_path;
3559 if let Some(file) = File::from_dyn(buffer.file()) {
3560 worktree = file.worktree.clone();
3561 buffer_abs_path = file.as_local().map(|f| f.abs_path(cx));
3562 } else {
3563 return Task::ready(Ok(Default::default()));
3564 };
3565 let range = buffer.anchor_before(range.start)..buffer.anchor_before(range.end);
3566
3567 if worktree.read(cx).as_local().is_some() {
3568 let buffer_abs_path = buffer_abs_path.unwrap();
3569 let lang_server = if let Some((_, server)) = self.language_server_for_buffer(buffer, cx)
3570 {
3571 server.clone()
3572 } else {
3573 return Task::ready(Ok(Default::default()));
3574 };
3575
3576 let lsp_range = range_to_lsp(range.to_point_utf16(buffer));
3577 cx.foreground().spawn(async move {
3578 if lang_server.capabilities().code_action_provider.is_none() {
3579 return Ok(Default::default());
3580 }
3581
3582 Ok(lang_server
3583 .request::<lsp::request::CodeActionRequest>(lsp::CodeActionParams {
3584 text_document: lsp::TextDocumentIdentifier::new(
3585 lsp::Url::from_file_path(buffer_abs_path).unwrap(),
3586 ),
3587 range: lsp_range,
3588 work_done_progress_params: Default::default(),
3589 partial_result_params: Default::default(),
3590 context: lsp::CodeActionContext {
3591 diagnostics: relevant_diagnostics,
3592 only: Some(vec![
3593 lsp::CodeActionKind::EMPTY,
3594 lsp::CodeActionKind::QUICKFIX,
3595 lsp::CodeActionKind::REFACTOR,
3596 lsp::CodeActionKind::REFACTOR_EXTRACT,
3597 lsp::CodeActionKind::SOURCE,
3598 ]),
3599 },
3600 })
3601 .await?
3602 .unwrap_or_default()
3603 .into_iter()
3604 .filter_map(|entry| {
3605 if let lsp::CodeActionOrCommand::CodeAction(lsp_action) = entry {
3606 Some(CodeAction {
3607 range: range.clone(),
3608 lsp_action,
3609 })
3610 } else {
3611 None
3612 }
3613 })
3614 .collect())
3615 })
3616 } else if let Some(project_id) = self.remote_id() {
3617 let rpc = self.client.clone();
3618 let version = buffer.version();
3619 cx.spawn_weak(|_, mut cx| async move {
3620 let response = rpc
3621 .request(proto::GetCodeActions {
3622 project_id,
3623 buffer_id,
3624 start: Some(language::proto::serialize_anchor(&range.start)),
3625 end: Some(language::proto::serialize_anchor(&range.end)),
3626 version: serialize_version(&version),
3627 })
3628 .await?;
3629
3630 buffer_handle
3631 .update(&mut cx, |buffer, _| {
3632 buffer.wait_for_version(deserialize_version(response.version))
3633 })
3634 .await;
3635
3636 response
3637 .actions
3638 .into_iter()
3639 .map(language::proto::deserialize_code_action)
3640 .collect()
3641 })
3642 } else {
3643 Task::ready(Ok(Default::default()))
3644 }
3645 }
3646
3647 pub fn apply_code_action(
3648 &self,
3649 buffer_handle: ModelHandle<Buffer>,
3650 mut action: CodeAction,
3651 push_to_history: bool,
3652 cx: &mut ModelContext<Self>,
3653 ) -> Task<Result<ProjectTransaction>> {
3654 if self.is_local() {
3655 let buffer = buffer_handle.read(cx);
3656 let (lsp_adapter, lang_server) =
3657 if let Some((adapter, server)) = self.language_server_for_buffer(buffer, cx) {
3658 (adapter.clone(), server.clone())
3659 } else {
3660 return Task::ready(Ok(Default::default()));
3661 };
3662 let range = action.range.to_point_utf16(buffer);
3663
3664 cx.spawn(|this, mut cx| async move {
3665 if let Some(lsp_range) = action
3666 .lsp_action
3667 .data
3668 .as_mut()
3669 .and_then(|d| d.get_mut("codeActionParams"))
3670 .and_then(|d| d.get_mut("range"))
3671 {
3672 *lsp_range = serde_json::to_value(&range_to_lsp(range)).unwrap();
3673 action.lsp_action = lang_server
3674 .request::<lsp::request::CodeActionResolveRequest>(action.lsp_action)
3675 .await?;
3676 } else {
3677 let actions = this
3678 .update(&mut cx, |this, cx| {
3679 this.code_actions(&buffer_handle, action.range, cx)
3680 })
3681 .await?;
3682 action.lsp_action = actions
3683 .into_iter()
3684 .find(|a| a.lsp_action.title == action.lsp_action.title)
3685 .ok_or_else(|| anyhow!("code action is outdated"))?
3686 .lsp_action;
3687 }
3688
3689 if let Some(edit) = action.lsp_action.edit {
3690 if edit.changes.is_some() || edit.document_changes.is_some() {
3691 return Self::deserialize_workspace_edit(
3692 this,
3693 edit,
3694 push_to_history,
3695 lsp_adapter.clone(),
3696 lang_server.clone(),
3697 &mut cx,
3698 )
3699 .await;
3700 }
3701 }
3702
3703 if let Some(command) = action.lsp_action.command {
3704 this.update(&mut cx, |this, _| {
3705 this.last_workspace_edits_by_language_server
3706 .remove(&lang_server.server_id());
3707 });
3708 lang_server
3709 .request::<lsp::request::ExecuteCommand>(lsp::ExecuteCommandParams {
3710 command: command.command,
3711 arguments: command.arguments.unwrap_or_default(),
3712 ..Default::default()
3713 })
3714 .await?;
3715 return Ok(this.update(&mut cx, |this, _| {
3716 this.last_workspace_edits_by_language_server
3717 .remove(&lang_server.server_id())
3718 .unwrap_or_default()
3719 }));
3720 }
3721
3722 Ok(ProjectTransaction::default())
3723 })
3724 } else if let Some(project_id) = self.remote_id() {
3725 let client = self.client.clone();
3726 let request = proto::ApplyCodeAction {
3727 project_id,
3728 buffer_id: buffer_handle.read(cx).remote_id(),
3729 action: Some(language::proto::serialize_code_action(&action)),
3730 };
3731 cx.spawn(|this, mut cx| async move {
3732 let response = client
3733 .request(request)
3734 .await?
3735 .transaction
3736 .ok_or_else(|| anyhow!("missing transaction"))?;
3737 this.update(&mut cx, |this, cx| {
3738 this.deserialize_project_transaction(response, push_to_history, cx)
3739 })
3740 .await
3741 })
3742 } else {
3743 Task::ready(Err(anyhow!("project does not have a remote id")))
3744 }
3745 }
3746
3747 async fn deserialize_workspace_edit(
3748 this: ModelHandle<Self>,
3749 edit: lsp::WorkspaceEdit,
3750 push_to_history: bool,
3751 lsp_adapter: Arc<CachedLspAdapter>,
3752 language_server: Arc<LanguageServer>,
3753 cx: &mut AsyncAppContext,
3754 ) -> Result<ProjectTransaction> {
3755 let fs = this.read_with(cx, |this, _| this.fs.clone());
3756 let mut operations = Vec::new();
3757 if let Some(document_changes) = edit.document_changes {
3758 match document_changes {
3759 lsp::DocumentChanges::Edits(edits) => {
3760 operations.extend(edits.into_iter().map(lsp::DocumentChangeOperation::Edit))
3761 }
3762 lsp::DocumentChanges::Operations(ops) => operations = ops,
3763 }
3764 } else if let Some(changes) = edit.changes {
3765 operations.extend(changes.into_iter().map(|(uri, edits)| {
3766 lsp::DocumentChangeOperation::Edit(lsp::TextDocumentEdit {
3767 text_document: lsp::OptionalVersionedTextDocumentIdentifier {
3768 uri,
3769 version: None,
3770 },
3771 edits: edits.into_iter().map(lsp::OneOf::Left).collect(),
3772 })
3773 }));
3774 }
3775
3776 let mut project_transaction = ProjectTransaction::default();
3777 for operation in operations {
3778 match operation {
3779 lsp::DocumentChangeOperation::Op(lsp::ResourceOp::Create(op)) => {
3780 let abs_path = op
3781 .uri
3782 .to_file_path()
3783 .map_err(|_| anyhow!("can't convert URI to path"))?;
3784
3785 if let Some(parent_path) = abs_path.parent() {
3786 fs.create_dir(parent_path).await?;
3787 }
3788 if abs_path.ends_with("/") {
3789 fs.create_dir(&abs_path).await?;
3790 } else {
3791 fs.create_file(&abs_path, op.options.map(Into::into).unwrap_or_default())
3792 .await?;
3793 }
3794 }
3795 lsp::DocumentChangeOperation::Op(lsp::ResourceOp::Rename(op)) => {
3796 let source_abs_path = op
3797 .old_uri
3798 .to_file_path()
3799 .map_err(|_| anyhow!("can't convert URI to path"))?;
3800 let target_abs_path = op
3801 .new_uri
3802 .to_file_path()
3803 .map_err(|_| anyhow!("can't convert URI to path"))?;
3804 fs.rename(
3805 &source_abs_path,
3806 &target_abs_path,
3807 op.options.map(Into::into).unwrap_or_default(),
3808 )
3809 .await?;
3810 }
3811 lsp::DocumentChangeOperation::Op(lsp::ResourceOp::Delete(op)) => {
3812 let abs_path = op
3813 .uri
3814 .to_file_path()
3815 .map_err(|_| anyhow!("can't convert URI to path"))?;
3816 let options = op.options.map(Into::into).unwrap_or_default();
3817 if abs_path.ends_with("/") {
3818 fs.remove_dir(&abs_path, options).await?;
3819 } else {
3820 fs.remove_file(&abs_path, options).await?;
3821 }
3822 }
3823 lsp::DocumentChangeOperation::Edit(op) => {
3824 let buffer_to_edit = this
3825 .update(cx, |this, cx| {
3826 this.open_local_buffer_via_lsp(
3827 op.text_document.uri,
3828 language_server.server_id(),
3829 lsp_adapter.name.clone(),
3830 cx,
3831 )
3832 })
3833 .await?;
3834
3835 let edits = this
3836 .update(cx, |this, cx| {
3837 let edits = op.edits.into_iter().map(|edit| match edit {
3838 lsp::OneOf::Left(edit) => edit,
3839 lsp::OneOf::Right(edit) => edit.text_edit,
3840 });
3841 this.edits_from_lsp(
3842 &buffer_to_edit,
3843 edits,
3844 op.text_document.version,
3845 cx,
3846 )
3847 })
3848 .await?;
3849
3850 let transaction = buffer_to_edit.update(cx, |buffer, cx| {
3851 buffer.finalize_last_transaction();
3852 buffer.start_transaction();
3853 for (range, text) in edits {
3854 buffer.edit([(range, text)], None, cx);
3855 }
3856 let transaction = if buffer.end_transaction(cx).is_some() {
3857 let transaction = buffer.finalize_last_transaction().unwrap().clone();
3858 if !push_to_history {
3859 buffer.forget_transaction(transaction.id);
3860 }
3861 Some(transaction)
3862 } else {
3863 None
3864 };
3865
3866 transaction
3867 });
3868 if let Some(transaction) = transaction {
3869 project_transaction.0.insert(buffer_to_edit, transaction);
3870 }
3871 }
3872 }
3873 }
3874
3875 Ok(project_transaction)
3876 }
3877
3878 pub fn prepare_rename<T: ToPointUtf16>(
3879 &self,
3880 buffer: ModelHandle<Buffer>,
3881 position: T,
3882 cx: &mut ModelContext<Self>,
3883 ) -> Task<Result<Option<Range<Anchor>>>> {
3884 let position = position.to_point_utf16(buffer.read(cx));
3885 self.request_lsp(buffer, PrepareRename { position }, cx)
3886 }
3887
3888 pub fn perform_rename<T: ToPointUtf16>(
3889 &self,
3890 buffer: ModelHandle<Buffer>,
3891 position: T,
3892 new_name: String,
3893 push_to_history: bool,
3894 cx: &mut ModelContext<Self>,
3895 ) -> Task<Result<ProjectTransaction>> {
3896 let position = position.to_point_utf16(buffer.read(cx));
3897 self.request_lsp(
3898 buffer,
3899 PerformRename {
3900 position,
3901 new_name,
3902 push_to_history,
3903 },
3904 cx,
3905 )
3906 }
3907
3908 #[allow(clippy::type_complexity)]
3909 pub fn search(
3910 &self,
3911 query: SearchQuery,
3912 cx: &mut ModelContext<Self>,
3913 ) -> Task<Result<HashMap<ModelHandle<Buffer>, Vec<Range<Anchor>>>>> {
3914 if self.is_local() {
3915 let snapshots = self
3916 .visible_worktrees(cx)
3917 .filter_map(|tree| {
3918 let tree = tree.read(cx).as_local()?;
3919 Some(tree.snapshot())
3920 })
3921 .collect::<Vec<_>>();
3922
3923 let background = cx.background().clone();
3924 let path_count: usize = snapshots.iter().map(|s| s.visible_file_count()).sum();
3925 if path_count == 0 {
3926 return Task::ready(Ok(Default::default()));
3927 }
3928 let workers = background.num_cpus().min(path_count);
3929 let (matching_paths_tx, mut matching_paths_rx) = smol::channel::bounded(1024);
3930 cx.background()
3931 .spawn({
3932 let fs = self.fs.clone();
3933 let background = cx.background().clone();
3934 let query = query.clone();
3935 async move {
3936 let fs = &fs;
3937 let query = &query;
3938 let matching_paths_tx = &matching_paths_tx;
3939 let paths_per_worker = (path_count + workers - 1) / workers;
3940 let snapshots = &snapshots;
3941 background
3942 .scoped(|scope| {
3943 for worker_ix in 0..workers {
3944 let worker_start_ix = worker_ix * paths_per_worker;
3945 let worker_end_ix = worker_start_ix + paths_per_worker;
3946 scope.spawn(async move {
3947 let mut snapshot_start_ix = 0;
3948 let mut abs_path = PathBuf::new();
3949 for snapshot in snapshots {
3950 let snapshot_end_ix =
3951 snapshot_start_ix + snapshot.visible_file_count();
3952 if worker_end_ix <= snapshot_start_ix {
3953 break;
3954 } else if worker_start_ix > snapshot_end_ix {
3955 snapshot_start_ix = snapshot_end_ix;
3956 continue;
3957 } else {
3958 let start_in_snapshot = worker_start_ix
3959 .saturating_sub(snapshot_start_ix);
3960 let end_in_snapshot =
3961 cmp::min(worker_end_ix, snapshot_end_ix)
3962 - snapshot_start_ix;
3963
3964 for entry in snapshot
3965 .files(false, start_in_snapshot)
3966 .take(end_in_snapshot - start_in_snapshot)
3967 {
3968 if matching_paths_tx.is_closed() {
3969 break;
3970 }
3971
3972 abs_path.clear();
3973 abs_path.push(&snapshot.abs_path());
3974 abs_path.push(&entry.path);
3975 let matches = if let Some(file) =
3976 fs.open_sync(&abs_path).await.log_err()
3977 {
3978 query.detect(file).unwrap_or(false)
3979 } else {
3980 false
3981 };
3982
3983 if matches {
3984 let project_path =
3985 (snapshot.id(), entry.path.clone());
3986 if matching_paths_tx
3987 .send(project_path)
3988 .await
3989 .is_err()
3990 {
3991 break;
3992 }
3993 }
3994 }
3995
3996 snapshot_start_ix = snapshot_end_ix;
3997 }
3998 }
3999 });
4000 }
4001 })
4002 .await;
4003 }
4004 })
4005 .detach();
4006
4007 let (buffers_tx, buffers_rx) = smol::channel::bounded(1024);
4008 let open_buffers = self
4009 .opened_buffers
4010 .values()
4011 .filter_map(|b| b.upgrade(cx))
4012 .collect::<HashSet<_>>();
4013 cx.spawn(|this, cx| async move {
4014 for buffer in &open_buffers {
4015 let snapshot = buffer.read_with(&cx, |buffer, _| buffer.snapshot());
4016 buffers_tx.send((buffer.clone(), snapshot)).await?;
4017 }
4018
4019 let open_buffers = Rc::new(RefCell::new(open_buffers));
4020 while let Some(project_path) = matching_paths_rx.next().await {
4021 if buffers_tx.is_closed() {
4022 break;
4023 }
4024
4025 let this = this.clone();
4026 let open_buffers = open_buffers.clone();
4027 let buffers_tx = buffers_tx.clone();
4028 cx.spawn(|mut cx| async move {
4029 if let Some(buffer) = this
4030 .update(&mut cx, |this, cx| this.open_buffer(project_path, cx))
4031 .await
4032 .log_err()
4033 {
4034 if open_buffers.borrow_mut().insert(buffer.clone()) {
4035 let snapshot = buffer.read_with(&cx, |buffer, _| buffer.snapshot());
4036 buffers_tx.send((buffer, snapshot)).await?;
4037 }
4038 }
4039
4040 Ok::<_, anyhow::Error>(())
4041 })
4042 .detach();
4043 }
4044
4045 Ok::<_, anyhow::Error>(())
4046 })
4047 .detach_and_log_err(cx);
4048
4049 let background = cx.background().clone();
4050 cx.background().spawn(async move {
4051 let query = &query;
4052 let mut matched_buffers = Vec::new();
4053 for _ in 0..workers {
4054 matched_buffers.push(HashMap::default());
4055 }
4056 background
4057 .scoped(|scope| {
4058 for worker_matched_buffers in matched_buffers.iter_mut() {
4059 let mut buffers_rx = buffers_rx.clone();
4060 scope.spawn(async move {
4061 while let Some((buffer, snapshot)) = buffers_rx.next().await {
4062 let buffer_matches = query
4063 .search(snapshot.as_rope())
4064 .await
4065 .iter()
4066 .map(|range| {
4067 snapshot.anchor_before(range.start)
4068 ..snapshot.anchor_after(range.end)
4069 })
4070 .collect::<Vec<_>>();
4071 if !buffer_matches.is_empty() {
4072 worker_matched_buffers
4073 .insert(buffer.clone(), buffer_matches);
4074 }
4075 }
4076 });
4077 }
4078 })
4079 .await;
4080 Ok(matched_buffers.into_iter().flatten().collect())
4081 })
4082 } else if let Some(project_id) = self.remote_id() {
4083 let request = self.client.request(query.to_proto(project_id));
4084 cx.spawn(|this, mut cx| async move {
4085 let response = request.await?;
4086 let mut result = HashMap::default();
4087 for location in response.locations {
4088 let target_buffer = this
4089 .update(&mut cx, |this, cx| {
4090 this.wait_for_buffer(location.buffer_id, cx)
4091 })
4092 .await?;
4093 let start = location
4094 .start
4095 .and_then(deserialize_anchor)
4096 .ok_or_else(|| anyhow!("missing target start"))?;
4097 let end = location
4098 .end
4099 .and_then(deserialize_anchor)
4100 .ok_or_else(|| anyhow!("missing target end"))?;
4101 result
4102 .entry(target_buffer)
4103 .or_insert(Vec::new())
4104 .push(start..end)
4105 }
4106 Ok(result)
4107 })
4108 } else {
4109 Task::ready(Ok(Default::default()))
4110 }
4111 }
4112
4113 fn request_lsp<R: LspCommand>(
4114 &self,
4115 buffer_handle: ModelHandle<Buffer>,
4116 request: R,
4117 cx: &mut ModelContext<Self>,
4118 ) -> Task<Result<R::Response>>
4119 where
4120 <R::LspRequest as lsp::request::Request>::Result: Send,
4121 {
4122 let buffer = buffer_handle.read(cx);
4123 if self.is_local() {
4124 let file = File::from_dyn(buffer.file()).and_then(File::as_local);
4125 if let Some((file, language_server)) = file.zip(
4126 self.language_server_for_buffer(buffer, cx)
4127 .map(|(_, server)| server.clone()),
4128 ) {
4129 let lsp_params = request.to_lsp(&file.abs_path(cx), cx);
4130 return cx.spawn(|this, cx| async move {
4131 if !request.check_capabilities(language_server.capabilities()) {
4132 return Ok(Default::default());
4133 }
4134
4135 let response = language_server
4136 .request::<R::LspRequest>(lsp_params)
4137 .await
4138 .context("lsp request failed")?;
4139 request
4140 .response_from_lsp(response, this, buffer_handle, cx)
4141 .await
4142 });
4143 }
4144 } else if let Some(project_id) = self.remote_id() {
4145 let rpc = self.client.clone();
4146 let message = request.to_proto(project_id, buffer);
4147 return cx.spawn(|this, cx| async move {
4148 let response = rpc.request(message).await?;
4149 request
4150 .response_from_proto(response, this, buffer_handle, cx)
4151 .await
4152 });
4153 }
4154 Task::ready(Ok(Default::default()))
4155 }
4156
4157 pub fn find_or_create_local_worktree(
4158 &mut self,
4159 abs_path: impl AsRef<Path>,
4160 visible: bool,
4161 cx: &mut ModelContext<Self>,
4162 ) -> Task<Result<(ModelHandle<Worktree>, PathBuf)>> {
4163 let abs_path = abs_path.as_ref();
4164 if let Some((tree, relative_path)) = self.find_local_worktree(abs_path, cx) {
4165 Task::ready(Ok((tree, relative_path)))
4166 } else {
4167 let worktree = self.create_local_worktree(abs_path, visible, cx);
4168 cx.foreground()
4169 .spawn(async move { Ok((worktree.await?, PathBuf::new())) })
4170 }
4171 }
4172
4173 pub fn find_local_worktree(
4174 &self,
4175 abs_path: &Path,
4176 cx: &AppContext,
4177 ) -> Option<(ModelHandle<Worktree>, PathBuf)> {
4178 for tree in &self.worktrees {
4179 if let Some(tree) = tree.upgrade(cx) {
4180 if let Some(relative_path) = tree
4181 .read(cx)
4182 .as_local()
4183 .and_then(|t| abs_path.strip_prefix(t.abs_path()).ok())
4184 {
4185 return Some((tree.clone(), relative_path.into()));
4186 }
4187 }
4188 }
4189 None
4190 }
4191
4192 pub fn is_shared(&self) -> bool {
4193 match &self.client_state {
4194 Some(ProjectClientState::Local { .. }) => true,
4195 _ => false,
4196 }
4197 }
4198
4199 fn create_local_worktree(
4200 &mut self,
4201 abs_path: impl AsRef<Path>,
4202 visible: bool,
4203 cx: &mut ModelContext<Self>,
4204 ) -> Task<Result<ModelHandle<Worktree>>> {
4205 let fs = self.fs.clone();
4206 let client = self.client.clone();
4207 let next_entry_id = self.next_entry_id.clone();
4208 let path: Arc<Path> = abs_path.as_ref().into();
4209 let task = self
4210 .loading_local_worktrees
4211 .entry(path.clone())
4212 .or_insert_with(|| {
4213 cx.spawn(|project, mut cx| {
4214 async move {
4215 let worktree = Worktree::local(
4216 client.clone(),
4217 path.clone(),
4218 visible,
4219 fs,
4220 next_entry_id,
4221 &mut cx,
4222 )
4223 .await;
4224 project.update(&mut cx, |project, _| {
4225 project.loading_local_worktrees.remove(&path);
4226 });
4227 let worktree = worktree?;
4228
4229 let project_id = project.update(&mut cx, |project, cx| {
4230 project.add_worktree(&worktree, cx);
4231 project.remote_id()
4232 });
4233
4234 if let Some(project_id) = project_id {
4235 worktree
4236 .update(&mut cx, |worktree, cx| {
4237 worktree.as_local_mut().unwrap().share(project_id, cx)
4238 })
4239 .await
4240 .log_err();
4241 }
4242
4243 Ok(worktree)
4244 }
4245 .map_err(Arc::new)
4246 })
4247 .shared()
4248 })
4249 .clone();
4250 cx.foreground().spawn(async move {
4251 match task.await {
4252 Ok(worktree) => Ok(worktree),
4253 Err(err) => Err(anyhow!("{}", err)),
4254 }
4255 })
4256 }
4257
4258 pub fn remove_worktree(&mut self, id_to_remove: WorktreeId, cx: &mut ModelContext<Self>) {
4259 self.worktrees.retain(|worktree| {
4260 if let Some(worktree) = worktree.upgrade(cx) {
4261 let id = worktree.read(cx).id();
4262 if id == id_to_remove {
4263 cx.emit(Event::WorktreeRemoved(id));
4264 false
4265 } else {
4266 true
4267 }
4268 } else {
4269 false
4270 }
4271 });
4272 self.metadata_changed(cx);
4273 cx.notify();
4274 }
4275
4276 fn add_worktree(&mut self, worktree: &ModelHandle<Worktree>, cx: &mut ModelContext<Self>) {
4277 cx.observe(worktree, |_, _, cx| cx.notify()).detach();
4278 if worktree.read(cx).is_local() {
4279 cx.subscribe(worktree, |this, worktree, event, cx| match event {
4280 worktree::Event::UpdatedEntries => this.update_local_worktree_buffers(worktree, cx),
4281 worktree::Event::UpdatedGitRepositories(updated_repos) => {
4282 this.update_local_worktree_buffers_git_repos(worktree, updated_repos, cx)
4283 }
4284 })
4285 .detach();
4286 }
4287
4288 let push_strong_handle = {
4289 let worktree = worktree.read(cx);
4290 self.is_shared() || worktree.is_visible() || worktree.is_remote()
4291 };
4292 if push_strong_handle {
4293 self.worktrees
4294 .push(WorktreeHandle::Strong(worktree.clone()));
4295 } else {
4296 self.worktrees
4297 .push(WorktreeHandle::Weak(worktree.downgrade()));
4298 }
4299
4300 self.metadata_changed(cx);
4301 cx.observe_release(worktree, |this, worktree, cx| {
4302 this.remove_worktree(worktree.id(), cx);
4303 cx.notify();
4304 })
4305 .detach();
4306
4307 cx.emit(Event::WorktreeAdded);
4308 cx.notify();
4309 }
4310
4311 fn update_local_worktree_buffers(
4312 &mut self,
4313 worktree_handle: ModelHandle<Worktree>,
4314 cx: &mut ModelContext<Self>,
4315 ) {
4316 let snapshot = worktree_handle.read(cx).snapshot();
4317 let mut buffers_to_delete = Vec::new();
4318 let mut renamed_buffers = Vec::new();
4319 for (buffer_id, buffer) in &self.opened_buffers {
4320 if let Some(buffer) = buffer.upgrade(cx) {
4321 buffer.update(cx, |buffer, cx| {
4322 if let Some(old_file) = File::from_dyn(buffer.file()) {
4323 if old_file.worktree != worktree_handle {
4324 return;
4325 }
4326
4327 let new_file = if let Some(entry) = snapshot.entry_for_id(old_file.entry_id)
4328 {
4329 File {
4330 is_local: true,
4331 entry_id: entry.id,
4332 mtime: entry.mtime,
4333 path: entry.path.clone(),
4334 worktree: worktree_handle.clone(),
4335 is_deleted: false,
4336 }
4337 } else if let Some(entry) =
4338 snapshot.entry_for_path(old_file.path().as_ref())
4339 {
4340 File {
4341 is_local: true,
4342 entry_id: entry.id,
4343 mtime: entry.mtime,
4344 path: entry.path.clone(),
4345 worktree: worktree_handle.clone(),
4346 is_deleted: false,
4347 }
4348 } else {
4349 File {
4350 is_local: true,
4351 entry_id: old_file.entry_id,
4352 path: old_file.path().clone(),
4353 mtime: old_file.mtime(),
4354 worktree: worktree_handle.clone(),
4355 is_deleted: true,
4356 }
4357 };
4358
4359 let old_path = old_file.abs_path(cx);
4360 if new_file.abs_path(cx) != old_path {
4361 renamed_buffers.push((cx.handle(), old_path));
4362 }
4363
4364 if let Some(project_id) = self.remote_id() {
4365 self.client
4366 .send(proto::UpdateBufferFile {
4367 project_id,
4368 buffer_id: *buffer_id as u64,
4369 file: Some(new_file.to_proto()),
4370 })
4371 .log_err();
4372 }
4373 buffer.file_updated(Arc::new(new_file), cx).detach();
4374 }
4375 });
4376 } else {
4377 buffers_to_delete.push(*buffer_id);
4378 }
4379 }
4380
4381 for buffer_id in buffers_to_delete {
4382 self.opened_buffers.remove(&buffer_id);
4383 }
4384
4385 for (buffer, old_path) in renamed_buffers {
4386 self.unregister_buffer_from_language_server(&buffer, old_path, cx);
4387 self.assign_language_to_buffer(&buffer, cx);
4388 self.register_buffer_with_language_server(&buffer, cx);
4389 }
4390 }
4391
4392 fn update_local_worktree_buffers_git_repos(
4393 &mut self,
4394 worktree: ModelHandle<Worktree>,
4395 repos: &[GitRepositoryEntry],
4396 cx: &mut ModelContext<Self>,
4397 ) {
4398 for (_, buffer) in &self.opened_buffers {
4399 if let Some(buffer) = buffer.upgrade(cx) {
4400 let file = match File::from_dyn(buffer.read(cx).file()) {
4401 Some(file) => file,
4402 None => continue,
4403 };
4404 if file.worktree != worktree {
4405 continue;
4406 }
4407
4408 let path = file.path().clone();
4409
4410 let repo = match repos.iter().find(|repo| repo.manages(&path)) {
4411 Some(repo) => repo.clone(),
4412 None => return,
4413 };
4414
4415 let relative_repo = match path.strip_prefix(repo.content_path) {
4416 Ok(relative_repo) => relative_repo.to_owned(),
4417 Err(_) => return,
4418 };
4419
4420 let remote_id = self.remote_id();
4421 let client = self.client.clone();
4422
4423 cx.spawn(|_, mut cx| async move {
4424 let diff_base = cx
4425 .background()
4426 .spawn(async move { repo.repo.lock().load_index_text(&relative_repo) })
4427 .await;
4428
4429 let buffer_id = buffer.update(&mut cx, |buffer, cx| {
4430 buffer.set_diff_base(diff_base.clone(), cx);
4431 buffer.remote_id()
4432 });
4433
4434 if let Some(project_id) = remote_id {
4435 client
4436 .send(proto::UpdateDiffBase {
4437 project_id,
4438 buffer_id: buffer_id as u64,
4439 diff_base,
4440 })
4441 .log_err();
4442 }
4443 })
4444 .detach();
4445 }
4446 }
4447 }
4448
4449 pub fn set_active_path(&mut self, entry: Option<ProjectPath>, cx: &mut ModelContext<Self>) {
4450 let new_active_entry = entry.and_then(|project_path| {
4451 let worktree = self.worktree_for_id(project_path.worktree_id, cx)?;
4452 let entry = worktree.read(cx).entry_for_path(project_path.path)?;
4453 Some(entry.id)
4454 });
4455 if new_active_entry != self.active_entry {
4456 self.active_entry = new_active_entry;
4457 cx.emit(Event::ActiveEntryChanged(new_active_entry));
4458 }
4459 }
4460
4461 pub fn language_servers_running_disk_based_diagnostics(
4462 &self,
4463 ) -> impl Iterator<Item = usize> + '_ {
4464 self.language_server_statuses
4465 .iter()
4466 .filter_map(|(id, status)| {
4467 if status.has_pending_diagnostic_updates {
4468 Some(*id)
4469 } else {
4470 None
4471 }
4472 })
4473 }
4474
4475 pub fn diagnostic_summary(&self, cx: &AppContext) -> DiagnosticSummary {
4476 let mut summary = DiagnosticSummary::default();
4477 for (_, path_summary) in self.diagnostic_summaries(cx) {
4478 summary.error_count += path_summary.error_count;
4479 summary.warning_count += path_summary.warning_count;
4480 }
4481 summary
4482 }
4483
4484 pub fn diagnostic_summaries<'a>(
4485 &'a self,
4486 cx: &'a AppContext,
4487 ) -> impl Iterator<Item = (ProjectPath, DiagnosticSummary)> + 'a {
4488 self.visible_worktrees(cx).flat_map(move |worktree| {
4489 let worktree = worktree.read(cx);
4490 let worktree_id = worktree.id();
4491 worktree
4492 .diagnostic_summaries()
4493 .map(move |(path, summary)| (ProjectPath { worktree_id, path }, summary))
4494 })
4495 }
4496
4497 pub fn disk_based_diagnostics_started(
4498 &mut self,
4499 language_server_id: usize,
4500 cx: &mut ModelContext<Self>,
4501 ) {
4502 cx.emit(Event::DiskBasedDiagnosticsStarted { language_server_id });
4503 }
4504
4505 pub fn disk_based_diagnostics_finished(
4506 &mut self,
4507 language_server_id: usize,
4508 cx: &mut ModelContext<Self>,
4509 ) {
4510 cx.emit(Event::DiskBasedDiagnosticsFinished { language_server_id });
4511 }
4512
4513 pub fn active_entry(&self) -> Option<ProjectEntryId> {
4514 self.active_entry
4515 }
4516
4517 pub fn entry_for_path(&self, path: &ProjectPath, cx: &AppContext) -> Option<Entry> {
4518 self.worktree_for_id(path.worktree_id, cx)?
4519 .read(cx)
4520 .entry_for_path(&path.path)
4521 .cloned()
4522 }
4523
4524 pub fn path_for_entry(&self, entry_id: ProjectEntryId, cx: &AppContext) -> Option<ProjectPath> {
4525 let worktree = self.worktree_for_entry(entry_id, cx)?;
4526 let worktree = worktree.read(cx);
4527 let worktree_id = worktree.id();
4528 let path = worktree.entry_for_id(entry_id)?.path.clone();
4529 Some(ProjectPath { worktree_id, path })
4530 }
4531
4532 // RPC message handlers
4533
4534 async fn handle_unshare_project(
4535 this: ModelHandle<Self>,
4536 _: TypedEnvelope<proto::UnshareProject>,
4537 _: Arc<Client>,
4538 mut cx: AsyncAppContext,
4539 ) -> Result<()> {
4540 this.update(&mut cx, |this, cx| {
4541 if this.is_local() {
4542 this.unshare(cx)?;
4543 } else {
4544 this.disconnected_from_host(cx);
4545 }
4546 Ok(())
4547 })
4548 }
4549
4550 async fn handle_add_collaborator(
4551 this: ModelHandle<Self>,
4552 mut envelope: TypedEnvelope<proto::AddProjectCollaborator>,
4553 _: Arc<Client>,
4554 mut cx: AsyncAppContext,
4555 ) -> Result<()> {
4556 let collaborator = envelope
4557 .payload
4558 .collaborator
4559 .take()
4560 .ok_or_else(|| anyhow!("empty collaborator"))?;
4561
4562 let collaborator = Collaborator::from_proto(collaborator);
4563 this.update(&mut cx, |this, cx| {
4564 this.collaborators
4565 .insert(collaborator.peer_id, collaborator);
4566 cx.notify();
4567 });
4568
4569 Ok(())
4570 }
4571
4572 async fn handle_remove_collaborator(
4573 this: ModelHandle<Self>,
4574 envelope: TypedEnvelope<proto::RemoveProjectCollaborator>,
4575 _: Arc<Client>,
4576 mut cx: AsyncAppContext,
4577 ) -> Result<()> {
4578 this.update(&mut cx, |this, cx| {
4579 let peer_id = PeerId(envelope.payload.peer_id);
4580 let replica_id = this
4581 .collaborators
4582 .remove(&peer_id)
4583 .ok_or_else(|| anyhow!("unknown peer {:?}", peer_id))?
4584 .replica_id;
4585 for buffer in this.opened_buffers.values() {
4586 if let Some(buffer) = buffer.upgrade(cx) {
4587 buffer.update(cx, |buffer, cx| buffer.remove_peer(replica_id, cx));
4588 }
4589 }
4590 this.shared_buffers.remove(&peer_id);
4591
4592 cx.emit(Event::CollaboratorLeft(peer_id));
4593 cx.notify();
4594 Ok(())
4595 })
4596 }
4597
4598 async fn handle_update_project(
4599 this: ModelHandle<Self>,
4600 envelope: TypedEnvelope<proto::UpdateProject>,
4601 client: Arc<Client>,
4602 mut cx: AsyncAppContext,
4603 ) -> Result<()> {
4604 this.update(&mut cx, |this, cx| {
4605 let replica_id = this.replica_id();
4606 let remote_id = this.remote_id().ok_or_else(|| anyhow!("invalid project"))?;
4607
4608 let mut old_worktrees_by_id = this
4609 .worktrees
4610 .drain(..)
4611 .filter_map(|worktree| {
4612 let worktree = worktree.upgrade(cx)?;
4613 Some((worktree.read(cx).id(), worktree))
4614 })
4615 .collect::<HashMap<_, _>>();
4616
4617 for worktree in envelope.payload.worktrees {
4618 if let Some(old_worktree) =
4619 old_worktrees_by_id.remove(&WorktreeId::from_proto(worktree.id))
4620 {
4621 this.worktrees.push(WorktreeHandle::Strong(old_worktree));
4622 } else {
4623 let worktree =
4624 Worktree::remote(remote_id, replica_id, worktree, client.clone(), cx);
4625 this.add_worktree(&worktree, cx);
4626 }
4627 }
4628
4629 this.metadata_changed(cx);
4630 for (id, _) in old_worktrees_by_id {
4631 cx.emit(Event::WorktreeRemoved(id));
4632 }
4633
4634 Ok(())
4635 })
4636 }
4637
4638 async fn handle_update_worktree(
4639 this: ModelHandle<Self>,
4640 envelope: TypedEnvelope<proto::UpdateWorktree>,
4641 _: Arc<Client>,
4642 mut cx: AsyncAppContext,
4643 ) -> Result<()> {
4644 this.update(&mut cx, |this, cx| {
4645 let worktree_id = WorktreeId::from_proto(envelope.payload.worktree_id);
4646 if let Some(worktree) = this.worktree_for_id(worktree_id, cx) {
4647 worktree.update(cx, |worktree, _| {
4648 let worktree = worktree.as_remote_mut().unwrap();
4649 worktree.update_from_remote(envelope.payload);
4650 });
4651 }
4652 Ok(())
4653 })
4654 }
4655
4656 async fn handle_create_project_entry(
4657 this: ModelHandle<Self>,
4658 envelope: TypedEnvelope<proto::CreateProjectEntry>,
4659 _: Arc<Client>,
4660 mut cx: AsyncAppContext,
4661 ) -> Result<proto::ProjectEntryResponse> {
4662 let worktree = this.update(&mut cx, |this, cx| {
4663 let worktree_id = WorktreeId::from_proto(envelope.payload.worktree_id);
4664 this.worktree_for_id(worktree_id, cx)
4665 .ok_or_else(|| anyhow!("worktree not found"))
4666 })?;
4667 let worktree_scan_id = worktree.read_with(&cx, |worktree, _| worktree.scan_id());
4668 let entry = worktree
4669 .update(&mut cx, |worktree, cx| {
4670 let worktree = worktree.as_local_mut().unwrap();
4671 let path = PathBuf::from(OsString::from_vec(envelope.payload.path));
4672 worktree.create_entry(path, envelope.payload.is_directory, cx)
4673 })
4674 .await?;
4675 Ok(proto::ProjectEntryResponse {
4676 entry: Some((&entry).into()),
4677 worktree_scan_id: worktree_scan_id as u64,
4678 })
4679 }
4680
4681 async fn handle_rename_project_entry(
4682 this: ModelHandle<Self>,
4683 envelope: TypedEnvelope<proto::RenameProjectEntry>,
4684 _: Arc<Client>,
4685 mut cx: AsyncAppContext,
4686 ) -> Result<proto::ProjectEntryResponse> {
4687 let entry_id = ProjectEntryId::from_proto(envelope.payload.entry_id);
4688 let worktree = this.read_with(&cx, |this, cx| {
4689 this.worktree_for_entry(entry_id, cx)
4690 .ok_or_else(|| anyhow!("worktree not found"))
4691 })?;
4692 let worktree_scan_id = worktree.read_with(&cx, |worktree, _| worktree.scan_id());
4693 let entry = worktree
4694 .update(&mut cx, |worktree, cx| {
4695 let new_path = PathBuf::from(OsString::from_vec(envelope.payload.new_path));
4696 worktree
4697 .as_local_mut()
4698 .unwrap()
4699 .rename_entry(entry_id, new_path, cx)
4700 .ok_or_else(|| anyhow!("invalid entry"))
4701 })?
4702 .await?;
4703 Ok(proto::ProjectEntryResponse {
4704 entry: Some((&entry).into()),
4705 worktree_scan_id: worktree_scan_id as u64,
4706 })
4707 }
4708
4709 async fn handle_copy_project_entry(
4710 this: ModelHandle<Self>,
4711 envelope: TypedEnvelope<proto::CopyProjectEntry>,
4712 _: Arc<Client>,
4713 mut cx: AsyncAppContext,
4714 ) -> Result<proto::ProjectEntryResponse> {
4715 let entry_id = ProjectEntryId::from_proto(envelope.payload.entry_id);
4716 let worktree = this.read_with(&cx, |this, cx| {
4717 this.worktree_for_entry(entry_id, cx)
4718 .ok_or_else(|| anyhow!("worktree not found"))
4719 })?;
4720 let worktree_scan_id = worktree.read_with(&cx, |worktree, _| worktree.scan_id());
4721 let entry = worktree
4722 .update(&mut cx, |worktree, cx| {
4723 let new_path = PathBuf::from(OsString::from_vec(envelope.payload.new_path));
4724 worktree
4725 .as_local_mut()
4726 .unwrap()
4727 .copy_entry(entry_id, new_path, cx)
4728 .ok_or_else(|| anyhow!("invalid entry"))
4729 })?
4730 .await?;
4731 Ok(proto::ProjectEntryResponse {
4732 entry: Some((&entry).into()),
4733 worktree_scan_id: worktree_scan_id as u64,
4734 })
4735 }
4736
4737 async fn handle_delete_project_entry(
4738 this: ModelHandle<Self>,
4739 envelope: TypedEnvelope<proto::DeleteProjectEntry>,
4740 _: Arc<Client>,
4741 mut cx: AsyncAppContext,
4742 ) -> Result<proto::ProjectEntryResponse> {
4743 let entry_id = ProjectEntryId::from_proto(envelope.payload.entry_id);
4744 let worktree = this.read_with(&cx, |this, cx| {
4745 this.worktree_for_entry(entry_id, cx)
4746 .ok_or_else(|| anyhow!("worktree not found"))
4747 })?;
4748 let worktree_scan_id = worktree.read_with(&cx, |worktree, _| worktree.scan_id());
4749 worktree
4750 .update(&mut cx, |worktree, cx| {
4751 worktree
4752 .as_local_mut()
4753 .unwrap()
4754 .delete_entry(entry_id, cx)
4755 .ok_or_else(|| anyhow!("invalid entry"))
4756 })?
4757 .await?;
4758 Ok(proto::ProjectEntryResponse {
4759 entry: None,
4760 worktree_scan_id: worktree_scan_id as u64,
4761 })
4762 }
4763
4764 async fn handle_update_diagnostic_summary(
4765 this: ModelHandle<Self>,
4766 envelope: TypedEnvelope<proto::UpdateDiagnosticSummary>,
4767 _: Arc<Client>,
4768 mut cx: AsyncAppContext,
4769 ) -> Result<()> {
4770 this.update(&mut cx, |this, cx| {
4771 let worktree_id = WorktreeId::from_proto(envelope.payload.worktree_id);
4772 if let Some(worktree) = this.worktree_for_id(worktree_id, cx) {
4773 if let Some(summary) = envelope.payload.summary {
4774 let project_path = ProjectPath {
4775 worktree_id,
4776 path: Path::new(&summary.path).into(),
4777 };
4778 worktree.update(cx, |worktree, _| {
4779 worktree
4780 .as_remote_mut()
4781 .unwrap()
4782 .update_diagnostic_summary(project_path.path.clone(), &summary);
4783 });
4784 cx.emit(Event::DiagnosticsUpdated {
4785 language_server_id: summary.language_server_id as usize,
4786 path: project_path,
4787 });
4788 }
4789 }
4790 Ok(())
4791 })
4792 }
4793
4794 async fn handle_start_language_server(
4795 this: ModelHandle<Self>,
4796 envelope: TypedEnvelope<proto::StartLanguageServer>,
4797 _: Arc<Client>,
4798 mut cx: AsyncAppContext,
4799 ) -> Result<()> {
4800 let server = envelope
4801 .payload
4802 .server
4803 .ok_or_else(|| anyhow!("invalid server"))?;
4804 this.update(&mut cx, |this, cx| {
4805 this.language_server_statuses.insert(
4806 server.id as usize,
4807 LanguageServerStatus {
4808 name: server.name,
4809 pending_work: Default::default(),
4810 has_pending_diagnostic_updates: false,
4811 progress_tokens: Default::default(),
4812 },
4813 );
4814 cx.notify();
4815 });
4816 Ok(())
4817 }
4818
4819 async fn handle_update_language_server(
4820 this: ModelHandle<Self>,
4821 envelope: TypedEnvelope<proto::UpdateLanguageServer>,
4822 _: Arc<Client>,
4823 mut cx: AsyncAppContext,
4824 ) -> Result<()> {
4825 let language_server_id = envelope.payload.language_server_id as usize;
4826 match envelope
4827 .payload
4828 .variant
4829 .ok_or_else(|| anyhow!("invalid variant"))?
4830 {
4831 proto::update_language_server::Variant::WorkStart(payload) => {
4832 this.update(&mut cx, |this, cx| {
4833 this.on_lsp_work_start(
4834 language_server_id,
4835 payload.token,
4836 LanguageServerProgress {
4837 message: payload.message,
4838 percentage: payload.percentage.map(|p| p as usize),
4839 last_update_at: Instant::now(),
4840 },
4841 cx,
4842 );
4843 })
4844 }
4845 proto::update_language_server::Variant::WorkProgress(payload) => {
4846 this.update(&mut cx, |this, cx| {
4847 this.on_lsp_work_progress(
4848 language_server_id,
4849 payload.token,
4850 LanguageServerProgress {
4851 message: payload.message,
4852 percentage: payload.percentage.map(|p| p as usize),
4853 last_update_at: Instant::now(),
4854 },
4855 cx,
4856 );
4857 })
4858 }
4859 proto::update_language_server::Variant::WorkEnd(payload) => {
4860 this.update(&mut cx, |this, cx| {
4861 this.on_lsp_work_end(language_server_id, payload.token, cx);
4862 })
4863 }
4864 proto::update_language_server::Variant::DiskBasedDiagnosticsUpdating(_) => {
4865 this.update(&mut cx, |this, cx| {
4866 this.disk_based_diagnostics_started(language_server_id, cx);
4867 })
4868 }
4869 proto::update_language_server::Variant::DiskBasedDiagnosticsUpdated(_) => {
4870 this.update(&mut cx, |this, cx| {
4871 this.disk_based_diagnostics_finished(language_server_id, cx)
4872 });
4873 }
4874 }
4875
4876 Ok(())
4877 }
4878
4879 async fn handle_update_buffer(
4880 this: ModelHandle<Self>,
4881 envelope: TypedEnvelope<proto::UpdateBuffer>,
4882 _: Arc<Client>,
4883 mut cx: AsyncAppContext,
4884 ) -> Result<()> {
4885 this.update(&mut cx, |this, cx| {
4886 let payload = envelope.payload.clone();
4887 let buffer_id = payload.buffer_id;
4888 let ops = payload
4889 .operations
4890 .into_iter()
4891 .map(language::proto::deserialize_operation)
4892 .collect::<Result<Vec<_>, _>>()?;
4893 let is_remote = this.is_remote();
4894 match this.opened_buffers.entry(buffer_id) {
4895 hash_map::Entry::Occupied(mut e) => match e.get_mut() {
4896 OpenBuffer::Strong(buffer) => {
4897 buffer.update(cx, |buffer, cx| buffer.apply_ops(ops, cx))?;
4898 }
4899 OpenBuffer::Operations(operations) => operations.extend_from_slice(&ops),
4900 OpenBuffer::Weak(_) => {}
4901 },
4902 hash_map::Entry::Vacant(e) => {
4903 assert!(
4904 is_remote,
4905 "received buffer update from {:?}",
4906 envelope.original_sender_id
4907 );
4908 e.insert(OpenBuffer::Operations(ops));
4909 }
4910 }
4911 Ok(())
4912 })
4913 }
4914
4915 async fn handle_create_buffer_for_peer(
4916 this: ModelHandle<Self>,
4917 envelope: TypedEnvelope<proto::CreateBufferForPeer>,
4918 _: Arc<Client>,
4919 mut cx: AsyncAppContext,
4920 ) -> Result<()> {
4921 this.update(&mut cx, |this, cx| {
4922 match envelope
4923 .payload
4924 .variant
4925 .ok_or_else(|| anyhow!("missing variant"))?
4926 {
4927 proto::create_buffer_for_peer::Variant::State(mut state) => {
4928 let mut buffer_file = None;
4929 if let Some(file) = state.file.take() {
4930 let worktree_id = WorktreeId::from_proto(file.worktree_id);
4931 let worktree = this.worktree_for_id(worktree_id, cx).ok_or_else(|| {
4932 anyhow!("no worktree found for id {}", file.worktree_id)
4933 })?;
4934 buffer_file = Some(Arc::new(File::from_proto(file, worktree.clone(), cx)?)
4935 as Arc<dyn language::File>);
4936 }
4937
4938 let buffer_id = state.id;
4939 let buffer = cx.add_model(|_| {
4940 Buffer::from_proto(this.replica_id(), state, buffer_file).unwrap()
4941 });
4942 this.incomplete_buffers.insert(buffer_id, buffer);
4943 }
4944 proto::create_buffer_for_peer::Variant::Chunk(chunk) => {
4945 let buffer = this
4946 .incomplete_buffers
4947 .get(&chunk.buffer_id)
4948 .ok_or_else(|| {
4949 anyhow!(
4950 "received chunk for buffer {} without initial state",
4951 chunk.buffer_id
4952 )
4953 })?
4954 .clone();
4955 let operations = chunk
4956 .operations
4957 .into_iter()
4958 .map(language::proto::deserialize_operation)
4959 .collect::<Result<Vec<_>>>()?;
4960 buffer.update(cx, |buffer, cx| buffer.apply_ops(operations, cx))?;
4961
4962 if chunk.is_last {
4963 this.incomplete_buffers.remove(&chunk.buffer_id);
4964 this.register_buffer(&buffer, cx)?;
4965 }
4966 }
4967 }
4968
4969 Ok(())
4970 })
4971 }
4972
4973 async fn handle_update_diff_base(
4974 this: ModelHandle<Self>,
4975 envelope: TypedEnvelope<proto::UpdateDiffBase>,
4976 _: Arc<Client>,
4977 mut cx: AsyncAppContext,
4978 ) -> Result<()> {
4979 this.update(&mut cx, |this, cx| {
4980 let buffer_id = envelope.payload.buffer_id;
4981 let diff_base = envelope.payload.diff_base;
4982 let buffer = this
4983 .opened_buffers
4984 .get_mut(&buffer_id)
4985 .and_then(|b| b.upgrade(cx))
4986 .ok_or_else(|| anyhow!("No such buffer {}", buffer_id))?;
4987
4988 buffer.update(cx, |buffer, cx| buffer.set_diff_base(diff_base, cx));
4989
4990 Ok(())
4991 })
4992 }
4993
4994 async fn handle_update_buffer_file(
4995 this: ModelHandle<Self>,
4996 envelope: TypedEnvelope<proto::UpdateBufferFile>,
4997 _: Arc<Client>,
4998 mut cx: AsyncAppContext,
4999 ) -> Result<()> {
5000 this.update(&mut cx, |this, cx| {
5001 let payload = envelope.payload.clone();
5002 let buffer_id = payload.buffer_id;
5003 let file = payload.file.ok_or_else(|| anyhow!("invalid file"))?;
5004 let worktree = this
5005 .worktree_for_id(WorktreeId::from_proto(file.worktree_id), cx)
5006 .ok_or_else(|| anyhow!("no such worktree"))?;
5007 let file = File::from_proto(file, worktree, cx)?;
5008 let buffer = this
5009 .opened_buffers
5010 .get_mut(&buffer_id)
5011 .and_then(|b| b.upgrade(cx))
5012 .ok_or_else(|| anyhow!("no such buffer"))?;
5013 buffer.update(cx, |buffer, cx| {
5014 buffer.file_updated(Arc::new(file), cx).detach();
5015 });
5016 this.assign_language_to_buffer(&buffer, cx);
5017 Ok(())
5018 })
5019 }
5020
5021 async fn handle_save_buffer(
5022 this: ModelHandle<Self>,
5023 envelope: TypedEnvelope<proto::SaveBuffer>,
5024 _: Arc<Client>,
5025 mut cx: AsyncAppContext,
5026 ) -> Result<proto::BufferSaved> {
5027 let buffer_id = envelope.payload.buffer_id;
5028 let requested_version = deserialize_version(envelope.payload.version);
5029
5030 let (project_id, buffer) = this.update(&mut cx, |this, cx| {
5031 let project_id = this.remote_id().ok_or_else(|| anyhow!("not connected"))?;
5032 let buffer = this
5033 .opened_buffers
5034 .get(&buffer_id)
5035 .and_then(|buffer| buffer.upgrade(cx))
5036 .ok_or_else(|| anyhow!("unknown buffer id {}", buffer_id))?;
5037 Ok::<_, anyhow::Error>((project_id, buffer))
5038 })?;
5039 buffer
5040 .update(&mut cx, |buffer, _| {
5041 buffer.wait_for_version(requested_version)
5042 })
5043 .await;
5044
5045 let (saved_version, fingerprint, mtime) =
5046 buffer.update(&mut cx, |buffer, cx| buffer.save(cx)).await?;
5047 Ok(proto::BufferSaved {
5048 project_id,
5049 buffer_id,
5050 version: serialize_version(&saved_version),
5051 mtime: Some(mtime.into()),
5052 fingerprint,
5053 })
5054 }
5055
5056 async fn handle_reload_buffers(
5057 this: ModelHandle<Self>,
5058 envelope: TypedEnvelope<proto::ReloadBuffers>,
5059 _: Arc<Client>,
5060 mut cx: AsyncAppContext,
5061 ) -> Result<proto::ReloadBuffersResponse> {
5062 let sender_id = envelope.original_sender_id()?;
5063 let reload = this.update(&mut cx, |this, cx| {
5064 let mut buffers = HashSet::default();
5065 for buffer_id in &envelope.payload.buffer_ids {
5066 buffers.insert(
5067 this.opened_buffers
5068 .get(buffer_id)
5069 .and_then(|buffer| buffer.upgrade(cx))
5070 .ok_or_else(|| anyhow!("unknown buffer id {}", buffer_id))?,
5071 );
5072 }
5073 Ok::<_, anyhow::Error>(this.reload_buffers(buffers, false, cx))
5074 })?;
5075
5076 let project_transaction = reload.await?;
5077 let project_transaction = this.update(&mut cx, |this, cx| {
5078 this.serialize_project_transaction_for_peer(project_transaction, sender_id, cx)
5079 });
5080 Ok(proto::ReloadBuffersResponse {
5081 transaction: Some(project_transaction),
5082 })
5083 }
5084
5085 async fn handle_format_buffers(
5086 this: ModelHandle<Self>,
5087 envelope: TypedEnvelope<proto::FormatBuffers>,
5088 _: Arc<Client>,
5089 mut cx: AsyncAppContext,
5090 ) -> Result<proto::FormatBuffersResponse> {
5091 let sender_id = envelope.original_sender_id()?;
5092 let format = this.update(&mut cx, |this, cx| {
5093 let mut buffers = HashSet::default();
5094 for buffer_id in &envelope.payload.buffer_ids {
5095 buffers.insert(
5096 this.opened_buffers
5097 .get(buffer_id)
5098 .and_then(|buffer| buffer.upgrade(cx))
5099 .ok_or_else(|| anyhow!("unknown buffer id {}", buffer_id))?,
5100 );
5101 }
5102 let trigger = FormatTrigger::from_proto(envelope.payload.trigger);
5103 Ok::<_, anyhow::Error>(this.format(buffers, false, trigger, cx))
5104 })?;
5105
5106 let project_transaction = format.await?;
5107 let project_transaction = this.update(&mut cx, |this, cx| {
5108 this.serialize_project_transaction_for_peer(project_transaction, sender_id, cx)
5109 });
5110 Ok(proto::FormatBuffersResponse {
5111 transaction: Some(project_transaction),
5112 })
5113 }
5114
5115 async fn handle_get_completions(
5116 this: ModelHandle<Self>,
5117 envelope: TypedEnvelope<proto::GetCompletions>,
5118 _: Arc<Client>,
5119 mut cx: AsyncAppContext,
5120 ) -> Result<proto::GetCompletionsResponse> {
5121 let buffer = this.read_with(&cx, |this, cx| {
5122 this.opened_buffers
5123 .get(&envelope.payload.buffer_id)
5124 .and_then(|buffer| buffer.upgrade(cx))
5125 .ok_or_else(|| anyhow!("unknown buffer id {}", envelope.payload.buffer_id))
5126 })?;
5127
5128 let position = envelope
5129 .payload
5130 .position
5131 .and_then(language::proto::deserialize_anchor)
5132 .map(|p| {
5133 buffer.read_with(&cx, |buffer, _| {
5134 buffer.clip_point_utf16(Unclipped(p.to_point_utf16(buffer)), Bias::Left)
5135 })
5136 })
5137 .ok_or_else(|| anyhow!("invalid position"))?;
5138
5139 let version = deserialize_version(envelope.payload.version);
5140 buffer
5141 .update(&mut cx, |buffer, _| buffer.wait_for_version(version))
5142 .await;
5143 let version = buffer.read_with(&cx, |buffer, _| buffer.version());
5144
5145 let completions = this
5146 .update(&mut cx, |this, cx| this.completions(&buffer, position, cx))
5147 .await?;
5148
5149 Ok(proto::GetCompletionsResponse {
5150 completions: completions
5151 .iter()
5152 .map(language::proto::serialize_completion)
5153 .collect(),
5154 version: serialize_version(&version),
5155 })
5156 }
5157
5158 async fn handle_apply_additional_edits_for_completion(
5159 this: ModelHandle<Self>,
5160 envelope: TypedEnvelope<proto::ApplyCompletionAdditionalEdits>,
5161 _: Arc<Client>,
5162 mut cx: AsyncAppContext,
5163 ) -> Result<proto::ApplyCompletionAdditionalEditsResponse> {
5164 let (buffer, completion) = this.update(&mut cx, |this, cx| {
5165 let buffer = this
5166 .opened_buffers
5167 .get(&envelope.payload.buffer_id)
5168 .and_then(|buffer| buffer.upgrade(cx))
5169 .ok_or_else(|| anyhow!("unknown buffer id {}", envelope.payload.buffer_id))?;
5170 let language = buffer.read(cx).language();
5171 let completion = language::proto::deserialize_completion(
5172 envelope
5173 .payload
5174 .completion
5175 .ok_or_else(|| anyhow!("invalid completion"))?,
5176 language.cloned(),
5177 );
5178 Ok::<_, anyhow::Error>((buffer, completion))
5179 })?;
5180
5181 let completion = completion.await?;
5182
5183 let apply_additional_edits = this.update(&mut cx, |this, cx| {
5184 this.apply_additional_edits_for_completion(buffer, completion, false, cx)
5185 });
5186
5187 Ok(proto::ApplyCompletionAdditionalEditsResponse {
5188 transaction: apply_additional_edits
5189 .await?
5190 .as_ref()
5191 .map(language::proto::serialize_transaction),
5192 })
5193 }
5194
5195 async fn handle_get_code_actions(
5196 this: ModelHandle<Self>,
5197 envelope: TypedEnvelope<proto::GetCodeActions>,
5198 _: Arc<Client>,
5199 mut cx: AsyncAppContext,
5200 ) -> Result<proto::GetCodeActionsResponse> {
5201 let start = envelope
5202 .payload
5203 .start
5204 .and_then(language::proto::deserialize_anchor)
5205 .ok_or_else(|| anyhow!("invalid start"))?;
5206 let end = envelope
5207 .payload
5208 .end
5209 .and_then(language::proto::deserialize_anchor)
5210 .ok_or_else(|| anyhow!("invalid end"))?;
5211 let buffer = this.update(&mut cx, |this, cx| {
5212 this.opened_buffers
5213 .get(&envelope.payload.buffer_id)
5214 .and_then(|buffer| buffer.upgrade(cx))
5215 .ok_or_else(|| anyhow!("unknown buffer id {}", envelope.payload.buffer_id))
5216 })?;
5217 buffer
5218 .update(&mut cx, |buffer, _| {
5219 buffer.wait_for_version(deserialize_version(envelope.payload.version))
5220 })
5221 .await;
5222
5223 let version = buffer.read_with(&cx, |buffer, _| buffer.version());
5224 let code_actions = this.update(&mut cx, |this, cx| {
5225 Ok::<_, anyhow::Error>(this.code_actions(&buffer, start..end, cx))
5226 })?;
5227
5228 Ok(proto::GetCodeActionsResponse {
5229 actions: code_actions
5230 .await?
5231 .iter()
5232 .map(language::proto::serialize_code_action)
5233 .collect(),
5234 version: serialize_version(&version),
5235 })
5236 }
5237
5238 async fn handle_apply_code_action(
5239 this: ModelHandle<Self>,
5240 envelope: TypedEnvelope<proto::ApplyCodeAction>,
5241 _: Arc<Client>,
5242 mut cx: AsyncAppContext,
5243 ) -> Result<proto::ApplyCodeActionResponse> {
5244 let sender_id = envelope.original_sender_id()?;
5245 let action = language::proto::deserialize_code_action(
5246 envelope
5247 .payload
5248 .action
5249 .ok_or_else(|| anyhow!("invalid action"))?,
5250 )?;
5251 let apply_code_action = this.update(&mut cx, |this, cx| {
5252 let buffer = this
5253 .opened_buffers
5254 .get(&envelope.payload.buffer_id)
5255 .and_then(|buffer| buffer.upgrade(cx))
5256 .ok_or_else(|| anyhow!("unknown buffer id {}", envelope.payload.buffer_id))?;
5257 Ok::<_, anyhow::Error>(this.apply_code_action(buffer, action, false, cx))
5258 })?;
5259
5260 let project_transaction = apply_code_action.await?;
5261 let project_transaction = this.update(&mut cx, |this, cx| {
5262 this.serialize_project_transaction_for_peer(project_transaction, sender_id, cx)
5263 });
5264 Ok(proto::ApplyCodeActionResponse {
5265 transaction: Some(project_transaction),
5266 })
5267 }
5268
5269 async fn handle_lsp_command<T: LspCommand>(
5270 this: ModelHandle<Self>,
5271 envelope: TypedEnvelope<T::ProtoRequest>,
5272 _: Arc<Client>,
5273 mut cx: AsyncAppContext,
5274 ) -> Result<<T::ProtoRequest as proto::RequestMessage>::Response>
5275 where
5276 <T::LspRequest as lsp::request::Request>::Result: Send,
5277 {
5278 let sender_id = envelope.original_sender_id()?;
5279 let buffer_id = T::buffer_id_from_proto(&envelope.payload);
5280 let buffer_handle = this.read_with(&cx, |this, _| {
5281 this.opened_buffers
5282 .get(&buffer_id)
5283 .and_then(|buffer| buffer.upgrade(&cx))
5284 .ok_or_else(|| anyhow!("unknown buffer id {}", buffer_id))
5285 })?;
5286 let request = T::from_proto(
5287 envelope.payload,
5288 this.clone(),
5289 buffer_handle.clone(),
5290 cx.clone(),
5291 )
5292 .await?;
5293 let buffer_version = buffer_handle.read_with(&cx, |buffer, _| buffer.version());
5294 let response = this
5295 .update(&mut cx, |this, cx| {
5296 this.request_lsp(buffer_handle, request, cx)
5297 })
5298 .await?;
5299 this.update(&mut cx, |this, cx| {
5300 Ok(T::response_to_proto(
5301 response,
5302 this,
5303 sender_id,
5304 &buffer_version,
5305 cx,
5306 ))
5307 })
5308 }
5309
5310 async fn handle_get_project_symbols(
5311 this: ModelHandle<Self>,
5312 envelope: TypedEnvelope<proto::GetProjectSymbols>,
5313 _: Arc<Client>,
5314 mut cx: AsyncAppContext,
5315 ) -> Result<proto::GetProjectSymbolsResponse> {
5316 let symbols = this
5317 .update(&mut cx, |this, cx| {
5318 this.symbols(&envelope.payload.query, cx)
5319 })
5320 .await?;
5321
5322 Ok(proto::GetProjectSymbolsResponse {
5323 symbols: symbols.iter().map(serialize_symbol).collect(),
5324 })
5325 }
5326
5327 async fn handle_search_project(
5328 this: ModelHandle<Self>,
5329 envelope: TypedEnvelope<proto::SearchProject>,
5330 _: Arc<Client>,
5331 mut cx: AsyncAppContext,
5332 ) -> Result<proto::SearchProjectResponse> {
5333 let peer_id = envelope.original_sender_id()?;
5334 let query = SearchQuery::from_proto(envelope.payload)?;
5335 let result = this
5336 .update(&mut cx, |this, cx| this.search(query, cx))
5337 .await?;
5338
5339 this.update(&mut cx, |this, cx| {
5340 let mut locations = Vec::new();
5341 for (buffer, ranges) in result {
5342 for range in ranges {
5343 let start = serialize_anchor(&range.start);
5344 let end = serialize_anchor(&range.end);
5345 let buffer_id = this.create_buffer_for_peer(&buffer, peer_id, cx);
5346 locations.push(proto::Location {
5347 buffer_id,
5348 start: Some(start),
5349 end: Some(end),
5350 });
5351 }
5352 }
5353 Ok(proto::SearchProjectResponse { locations })
5354 })
5355 }
5356
5357 async fn handle_open_buffer_for_symbol(
5358 this: ModelHandle<Self>,
5359 envelope: TypedEnvelope<proto::OpenBufferForSymbol>,
5360 _: Arc<Client>,
5361 mut cx: AsyncAppContext,
5362 ) -> Result<proto::OpenBufferForSymbolResponse> {
5363 let peer_id = envelope.original_sender_id()?;
5364 let symbol = envelope
5365 .payload
5366 .symbol
5367 .ok_or_else(|| anyhow!("invalid symbol"))?;
5368 let symbol = this
5369 .read_with(&cx, |this, _| this.deserialize_symbol(symbol))
5370 .await?;
5371 let symbol = this.read_with(&cx, |this, _| {
5372 let signature = this.symbol_signature(&symbol.path);
5373 if signature == symbol.signature {
5374 Ok(symbol)
5375 } else {
5376 Err(anyhow!("invalid symbol signature"))
5377 }
5378 })?;
5379 let buffer = this
5380 .update(&mut cx, |this, cx| this.open_buffer_for_symbol(&symbol, cx))
5381 .await?;
5382
5383 Ok(proto::OpenBufferForSymbolResponse {
5384 buffer_id: this.update(&mut cx, |this, cx| {
5385 this.create_buffer_for_peer(&buffer, peer_id, cx)
5386 }),
5387 })
5388 }
5389
5390 fn symbol_signature(&self, project_path: &ProjectPath) -> [u8; 32] {
5391 let mut hasher = Sha256::new();
5392 hasher.update(project_path.worktree_id.to_proto().to_be_bytes());
5393 hasher.update(project_path.path.to_string_lossy().as_bytes());
5394 hasher.update(self.nonce.to_be_bytes());
5395 hasher.finalize().as_slice().try_into().unwrap()
5396 }
5397
5398 async fn handle_open_buffer_by_id(
5399 this: ModelHandle<Self>,
5400 envelope: TypedEnvelope<proto::OpenBufferById>,
5401 _: Arc<Client>,
5402 mut cx: AsyncAppContext,
5403 ) -> Result<proto::OpenBufferResponse> {
5404 let peer_id = envelope.original_sender_id()?;
5405 let buffer = this
5406 .update(&mut cx, |this, cx| {
5407 this.open_buffer_by_id(envelope.payload.id, cx)
5408 })
5409 .await?;
5410 this.update(&mut cx, |this, cx| {
5411 Ok(proto::OpenBufferResponse {
5412 buffer_id: this.create_buffer_for_peer(&buffer, peer_id, cx),
5413 })
5414 })
5415 }
5416
5417 async fn handle_open_buffer_by_path(
5418 this: ModelHandle<Self>,
5419 envelope: TypedEnvelope<proto::OpenBufferByPath>,
5420 _: Arc<Client>,
5421 mut cx: AsyncAppContext,
5422 ) -> Result<proto::OpenBufferResponse> {
5423 let peer_id = envelope.original_sender_id()?;
5424 let worktree_id = WorktreeId::from_proto(envelope.payload.worktree_id);
5425 let open_buffer = this.update(&mut cx, |this, cx| {
5426 this.open_buffer(
5427 ProjectPath {
5428 worktree_id,
5429 path: PathBuf::from(envelope.payload.path).into(),
5430 },
5431 cx,
5432 )
5433 });
5434
5435 let buffer = open_buffer.await?;
5436 this.update(&mut cx, |this, cx| {
5437 Ok(proto::OpenBufferResponse {
5438 buffer_id: this.create_buffer_for_peer(&buffer, peer_id, cx),
5439 })
5440 })
5441 }
5442
5443 fn serialize_project_transaction_for_peer(
5444 &mut self,
5445 project_transaction: ProjectTransaction,
5446 peer_id: PeerId,
5447 cx: &AppContext,
5448 ) -> proto::ProjectTransaction {
5449 let mut serialized_transaction = proto::ProjectTransaction {
5450 buffer_ids: Default::default(),
5451 transactions: Default::default(),
5452 };
5453 for (buffer, transaction) in project_transaction.0 {
5454 serialized_transaction
5455 .buffer_ids
5456 .push(self.create_buffer_for_peer(&buffer, peer_id, cx));
5457 serialized_transaction
5458 .transactions
5459 .push(language::proto::serialize_transaction(&transaction));
5460 }
5461 serialized_transaction
5462 }
5463
5464 fn deserialize_project_transaction(
5465 &mut self,
5466 message: proto::ProjectTransaction,
5467 push_to_history: bool,
5468 cx: &mut ModelContext<Self>,
5469 ) -> Task<Result<ProjectTransaction>> {
5470 cx.spawn(|this, mut cx| async move {
5471 let mut project_transaction = ProjectTransaction::default();
5472 for (buffer_id, transaction) in message.buffer_ids.into_iter().zip(message.transactions)
5473 {
5474 let buffer = this
5475 .update(&mut cx, |this, cx| this.wait_for_buffer(buffer_id, cx))
5476 .await?;
5477 let transaction = language::proto::deserialize_transaction(transaction)?;
5478 project_transaction.0.insert(buffer, transaction);
5479 }
5480
5481 for (buffer, transaction) in &project_transaction.0 {
5482 buffer
5483 .update(&mut cx, |buffer, _| {
5484 buffer.wait_for_edits(transaction.edit_ids.iter().copied())
5485 })
5486 .await;
5487
5488 if push_to_history {
5489 buffer.update(&mut cx, |buffer, _| {
5490 buffer.push_transaction(transaction.clone(), Instant::now());
5491 });
5492 }
5493 }
5494
5495 Ok(project_transaction)
5496 })
5497 }
5498
5499 fn create_buffer_for_peer(
5500 &mut self,
5501 buffer: &ModelHandle<Buffer>,
5502 peer_id: PeerId,
5503 cx: &AppContext,
5504 ) -> u64 {
5505 let buffer_id = buffer.read(cx).remote_id();
5506 if let Some(project_id) = self.remote_id() {
5507 let shared_buffers = self.shared_buffers.entry(peer_id).or_default();
5508 if shared_buffers.insert(buffer_id) {
5509 let buffer = buffer.read(cx);
5510 let state = buffer.to_proto();
5511 let operations = buffer.serialize_ops(cx);
5512 let client = self.client.clone();
5513 cx.background()
5514 .spawn(
5515 async move {
5516 let mut operations = operations.await;
5517
5518 client.send(proto::CreateBufferForPeer {
5519 project_id,
5520 peer_id: peer_id.0,
5521 variant: Some(proto::create_buffer_for_peer::Variant::State(state)),
5522 })?;
5523
5524 loop {
5525 #[cfg(any(test, feature = "test-support"))]
5526 const CHUNK_SIZE: usize = 5;
5527
5528 #[cfg(not(any(test, feature = "test-support")))]
5529 const CHUNK_SIZE: usize = 100;
5530
5531 let chunk = operations
5532 .drain(..cmp::min(CHUNK_SIZE, operations.len()))
5533 .collect();
5534 let is_last = operations.is_empty();
5535 client.send(proto::CreateBufferForPeer {
5536 project_id,
5537 peer_id: peer_id.0,
5538 variant: Some(proto::create_buffer_for_peer::Variant::Chunk(
5539 proto::BufferChunk {
5540 buffer_id,
5541 operations: chunk,
5542 is_last,
5543 },
5544 )),
5545 })?;
5546
5547 if is_last {
5548 break;
5549 }
5550 }
5551
5552 Ok(())
5553 }
5554 .log_err(),
5555 )
5556 .detach();
5557 }
5558 }
5559
5560 buffer_id
5561 }
5562
5563 fn wait_for_buffer(
5564 &self,
5565 id: u64,
5566 cx: &mut ModelContext<Self>,
5567 ) -> Task<Result<ModelHandle<Buffer>>> {
5568 let mut opened_buffer_rx = self.opened_buffer.1.clone();
5569 cx.spawn(|this, mut cx| async move {
5570 let buffer = loop {
5571 let buffer = this.read_with(&cx, |this, cx| {
5572 this.opened_buffers
5573 .get(&id)
5574 .and_then(|buffer| buffer.upgrade(cx))
5575 });
5576 if let Some(buffer) = buffer {
5577 break buffer;
5578 } else if this.read_with(&cx, |this, _| this.is_read_only()) {
5579 return Err(anyhow!("disconnected before buffer {} could be opened", id));
5580 }
5581
5582 opened_buffer_rx
5583 .next()
5584 .await
5585 .ok_or_else(|| anyhow!("project dropped while waiting for buffer"))?;
5586 };
5587 buffer.update(&mut cx, |buffer, cx| buffer.git_diff_recalc(cx));
5588 Ok(buffer)
5589 })
5590 }
5591
5592 fn deserialize_symbol(
5593 &self,
5594 serialized_symbol: proto::Symbol,
5595 ) -> impl Future<Output = Result<Symbol>> {
5596 let languages = self.languages.clone();
5597 async move {
5598 let source_worktree_id = WorktreeId::from_proto(serialized_symbol.source_worktree_id);
5599 let worktree_id = WorktreeId::from_proto(serialized_symbol.worktree_id);
5600 let start = serialized_symbol
5601 .start
5602 .ok_or_else(|| anyhow!("invalid start"))?;
5603 let end = serialized_symbol
5604 .end
5605 .ok_or_else(|| anyhow!("invalid end"))?;
5606 let kind = unsafe { mem::transmute(serialized_symbol.kind) };
5607 let path = ProjectPath {
5608 worktree_id,
5609 path: PathBuf::from(serialized_symbol.path).into(),
5610 };
5611 let language = languages.select_language(&path.path);
5612 Ok(Symbol {
5613 language_server_name: LanguageServerName(
5614 serialized_symbol.language_server_name.into(),
5615 ),
5616 source_worktree_id,
5617 path,
5618 label: {
5619 match language {
5620 Some(language) => {
5621 language
5622 .label_for_symbol(&serialized_symbol.name, kind)
5623 .await
5624 }
5625 None => None,
5626 }
5627 .unwrap_or_else(|| CodeLabel::plain(serialized_symbol.name.clone(), None))
5628 },
5629
5630 name: serialized_symbol.name,
5631 range: Unclipped(PointUtf16::new(start.row, start.column))
5632 ..Unclipped(PointUtf16::new(end.row, end.column)),
5633 kind,
5634 signature: serialized_symbol
5635 .signature
5636 .try_into()
5637 .map_err(|_| anyhow!("invalid signature"))?,
5638 })
5639 }
5640 }
5641
5642 async fn handle_buffer_saved(
5643 this: ModelHandle<Self>,
5644 envelope: TypedEnvelope<proto::BufferSaved>,
5645 _: Arc<Client>,
5646 mut cx: AsyncAppContext,
5647 ) -> Result<()> {
5648 let version = deserialize_version(envelope.payload.version);
5649 let mtime = envelope
5650 .payload
5651 .mtime
5652 .ok_or_else(|| anyhow!("missing mtime"))?
5653 .into();
5654
5655 this.update(&mut cx, |this, cx| {
5656 let buffer = this
5657 .opened_buffers
5658 .get(&envelope.payload.buffer_id)
5659 .and_then(|buffer| buffer.upgrade(cx));
5660 if let Some(buffer) = buffer {
5661 buffer.update(cx, |buffer, cx| {
5662 buffer.did_save(version, envelope.payload.fingerprint, mtime, None, cx);
5663 });
5664 }
5665 Ok(())
5666 })
5667 }
5668
5669 async fn handle_buffer_reloaded(
5670 this: ModelHandle<Self>,
5671 envelope: TypedEnvelope<proto::BufferReloaded>,
5672 _: Arc<Client>,
5673 mut cx: AsyncAppContext,
5674 ) -> Result<()> {
5675 let payload = envelope.payload;
5676 let version = deserialize_version(payload.version);
5677 let line_ending = deserialize_line_ending(
5678 proto::LineEnding::from_i32(payload.line_ending)
5679 .ok_or_else(|| anyhow!("missing line ending"))?,
5680 );
5681 let mtime = payload
5682 .mtime
5683 .ok_or_else(|| anyhow!("missing mtime"))?
5684 .into();
5685 this.update(&mut cx, |this, cx| {
5686 let buffer = this
5687 .opened_buffers
5688 .get(&payload.buffer_id)
5689 .and_then(|buffer| buffer.upgrade(cx));
5690 if let Some(buffer) = buffer {
5691 buffer.update(cx, |buffer, cx| {
5692 buffer.did_reload(version, payload.fingerprint, line_ending, mtime, cx);
5693 });
5694 }
5695 Ok(())
5696 })
5697 }
5698
5699 #[allow(clippy::type_complexity)]
5700 fn edits_from_lsp(
5701 &mut self,
5702 buffer: &ModelHandle<Buffer>,
5703 lsp_edits: impl 'static + Send + IntoIterator<Item = lsp::TextEdit>,
5704 version: Option<i32>,
5705 cx: &mut ModelContext<Self>,
5706 ) -> Task<Result<Vec<(Range<Anchor>, String)>>> {
5707 let snapshot = self.buffer_snapshot_for_lsp_version(buffer, version, cx);
5708 cx.background().spawn(async move {
5709 let snapshot = snapshot?;
5710 let mut lsp_edits = lsp_edits
5711 .into_iter()
5712 .map(|edit| (range_from_lsp(edit.range), edit.new_text))
5713 .collect::<Vec<_>>();
5714 lsp_edits.sort_by_key(|(range, _)| range.start);
5715
5716 let mut lsp_edits = lsp_edits.into_iter().peekable();
5717 let mut edits = Vec::new();
5718 while let Some((range, mut new_text)) = lsp_edits.next() {
5719 // Clip invalid ranges provided by the language server.
5720 let mut range = snapshot.clip_point_utf16(range.start, Bias::Left)
5721 ..snapshot.clip_point_utf16(range.end, Bias::Left);
5722
5723 // Combine any LSP edits that are adjacent.
5724 //
5725 // Also, combine LSP edits that are separated from each other by only
5726 // a newline. This is important because for some code actions,
5727 // Rust-analyzer rewrites the entire buffer via a series of edits that
5728 // are separated by unchanged newline characters.
5729 //
5730 // In order for the diffing logic below to work properly, any edits that
5731 // cancel each other out must be combined into one.
5732 while let Some((next_range, next_text)) = lsp_edits.peek() {
5733 if next_range.start.0 > range.end {
5734 if next_range.start.0.row > range.end.row + 1
5735 || next_range.start.0.column > 0
5736 || snapshot.clip_point_utf16(
5737 Unclipped(PointUtf16::new(range.end.row, u32::MAX)),
5738 Bias::Left,
5739 ) > range.end
5740 {
5741 break;
5742 }
5743 new_text.push('\n');
5744 }
5745 range.end = snapshot.clip_point_utf16(next_range.end, Bias::Left);
5746 new_text.push_str(next_text);
5747 lsp_edits.next();
5748 }
5749
5750 // For multiline edits, perform a diff of the old and new text so that
5751 // we can identify the changes more precisely, preserving the locations
5752 // of any anchors positioned in the unchanged regions.
5753 if range.end.row > range.start.row {
5754 let mut offset = range.start.to_offset(&snapshot);
5755 let old_text = snapshot.text_for_range(range).collect::<String>();
5756
5757 let diff = TextDiff::from_lines(old_text.as_str(), &new_text);
5758 let mut moved_since_edit = true;
5759 for change in diff.iter_all_changes() {
5760 let tag = change.tag();
5761 let value = change.value();
5762 match tag {
5763 ChangeTag::Equal => {
5764 offset += value.len();
5765 moved_since_edit = true;
5766 }
5767 ChangeTag::Delete => {
5768 let start = snapshot.anchor_after(offset);
5769 let end = snapshot.anchor_before(offset + value.len());
5770 if moved_since_edit {
5771 edits.push((start..end, String::new()));
5772 } else {
5773 edits.last_mut().unwrap().0.end = end;
5774 }
5775 offset += value.len();
5776 moved_since_edit = false;
5777 }
5778 ChangeTag::Insert => {
5779 if moved_since_edit {
5780 let anchor = snapshot.anchor_after(offset);
5781 edits.push((anchor..anchor, value.to_string()));
5782 } else {
5783 edits.last_mut().unwrap().1.push_str(value);
5784 }
5785 moved_since_edit = false;
5786 }
5787 }
5788 }
5789 } else if range.end == range.start {
5790 let anchor = snapshot.anchor_after(range.start);
5791 edits.push((anchor..anchor, new_text));
5792 } else {
5793 let edit_start = snapshot.anchor_after(range.start);
5794 let edit_end = snapshot.anchor_before(range.end);
5795 edits.push((edit_start..edit_end, new_text));
5796 }
5797 }
5798
5799 Ok(edits)
5800 })
5801 }
5802
5803 fn buffer_snapshot_for_lsp_version(
5804 &mut self,
5805 buffer: &ModelHandle<Buffer>,
5806 version: Option<i32>,
5807 cx: &AppContext,
5808 ) -> Result<TextBufferSnapshot> {
5809 const OLD_VERSIONS_TO_RETAIN: i32 = 10;
5810
5811 if let Some(version) = version {
5812 let buffer_id = buffer.read(cx).remote_id();
5813 let snapshots = self
5814 .buffer_snapshots
5815 .get_mut(&buffer_id)
5816 .ok_or_else(|| anyhow!("no snapshot found for buffer {}", buffer_id))?;
5817 let mut found_snapshot = None;
5818 snapshots.retain(|(snapshot_version, snapshot)| {
5819 if snapshot_version + OLD_VERSIONS_TO_RETAIN < version {
5820 false
5821 } else {
5822 if *snapshot_version == version {
5823 found_snapshot = Some(snapshot.clone());
5824 }
5825 true
5826 }
5827 });
5828
5829 found_snapshot.ok_or_else(|| {
5830 anyhow!(
5831 "snapshot not found for buffer {} at version {}",
5832 buffer_id,
5833 version
5834 )
5835 })
5836 } else {
5837 Ok((buffer.read(cx)).text_snapshot())
5838 }
5839 }
5840
5841 fn language_server_for_buffer(
5842 &self,
5843 buffer: &Buffer,
5844 cx: &AppContext,
5845 ) -> Option<(&Arc<CachedLspAdapter>, &Arc<LanguageServer>)> {
5846 if let Some((file, language)) = File::from_dyn(buffer.file()).zip(buffer.language()) {
5847 let name = language.lsp_adapter()?.name.clone();
5848 let worktree_id = file.worktree_id(cx);
5849 let key = (worktree_id, name);
5850
5851 if let Some(server_id) = self.language_server_ids.get(&key) {
5852 if let Some(LanguageServerState::Running {
5853 adapter, server, ..
5854 }) = self.language_servers.get(server_id)
5855 {
5856 return Some((adapter, server));
5857 }
5858 }
5859 }
5860
5861 None
5862 }
5863}
5864
5865impl ProjectStore {
5866 pub fn new() -> Self {
5867 Self {
5868 projects: Default::default(),
5869 }
5870 }
5871
5872 pub fn projects<'a>(
5873 &'a self,
5874 cx: &'a AppContext,
5875 ) -> impl 'a + Iterator<Item = ModelHandle<Project>> {
5876 self.projects
5877 .iter()
5878 .filter_map(|project| project.upgrade(cx))
5879 }
5880
5881 fn add_project(&mut self, project: WeakModelHandle<Project>, cx: &mut ModelContext<Self>) {
5882 if let Err(ix) = self
5883 .projects
5884 .binary_search_by_key(&project.id(), WeakModelHandle::id)
5885 {
5886 self.projects.insert(ix, project);
5887 }
5888 cx.notify();
5889 }
5890
5891 fn prune_projects(&mut self, cx: &mut ModelContext<Self>) {
5892 let mut did_change = false;
5893 self.projects.retain(|project| {
5894 if project.is_upgradable(cx) {
5895 true
5896 } else {
5897 did_change = true;
5898 false
5899 }
5900 });
5901 if did_change {
5902 cx.notify();
5903 }
5904 }
5905}
5906
5907impl WorktreeHandle {
5908 pub fn upgrade(&self, cx: &AppContext) -> Option<ModelHandle<Worktree>> {
5909 match self {
5910 WorktreeHandle::Strong(handle) => Some(handle.clone()),
5911 WorktreeHandle::Weak(handle) => handle.upgrade(cx),
5912 }
5913 }
5914}
5915
5916impl OpenBuffer {
5917 pub fn upgrade(&self, cx: &impl UpgradeModelHandle) -> Option<ModelHandle<Buffer>> {
5918 match self {
5919 OpenBuffer::Strong(handle) => Some(handle.clone()),
5920 OpenBuffer::Weak(handle) => handle.upgrade(cx),
5921 OpenBuffer::Operations(_) => None,
5922 }
5923 }
5924}
5925
5926pub struct PathMatchCandidateSet {
5927 pub snapshot: Snapshot,
5928 pub include_ignored: bool,
5929 pub include_root_name: bool,
5930}
5931
5932impl<'a> fuzzy::PathMatchCandidateSet<'a> for PathMatchCandidateSet {
5933 type Candidates = PathMatchCandidateSetIter<'a>;
5934
5935 fn id(&self) -> usize {
5936 self.snapshot.id().to_usize()
5937 }
5938
5939 fn len(&self) -> usize {
5940 if self.include_ignored {
5941 self.snapshot.file_count()
5942 } else {
5943 self.snapshot.visible_file_count()
5944 }
5945 }
5946
5947 fn prefix(&self) -> Arc<str> {
5948 if self.snapshot.root_entry().map_or(false, |e| e.is_file()) {
5949 self.snapshot.root_name().into()
5950 } else if self.include_root_name {
5951 format!("{}/", self.snapshot.root_name()).into()
5952 } else {
5953 "".into()
5954 }
5955 }
5956
5957 fn candidates(&'a self, start: usize) -> Self::Candidates {
5958 PathMatchCandidateSetIter {
5959 traversal: self.snapshot.files(self.include_ignored, start),
5960 }
5961 }
5962}
5963
5964pub struct PathMatchCandidateSetIter<'a> {
5965 traversal: Traversal<'a>,
5966}
5967
5968impl<'a> Iterator for PathMatchCandidateSetIter<'a> {
5969 type Item = fuzzy::PathMatchCandidate<'a>;
5970
5971 fn next(&mut self) -> Option<Self::Item> {
5972 self.traversal.next().map(|entry| {
5973 if let EntryKind::File(char_bag) = entry.kind {
5974 fuzzy::PathMatchCandidate {
5975 path: &entry.path,
5976 char_bag,
5977 }
5978 } else {
5979 unreachable!()
5980 }
5981 })
5982 }
5983}
5984
5985impl Entity for ProjectStore {
5986 type Event = ();
5987}
5988
5989impl Entity for Project {
5990 type Event = Event;
5991
5992 fn release(&mut self, cx: &mut gpui::MutableAppContext) {
5993 self.project_store.update(cx, ProjectStore::prune_projects);
5994
5995 match &self.client_state {
5996 Some(ProjectClientState::Local { remote_id, .. }) => {
5997 self.client
5998 .send(proto::UnshareProject {
5999 project_id: *remote_id,
6000 })
6001 .log_err();
6002 }
6003 Some(ProjectClientState::Remote { remote_id, .. }) => {
6004 self.client
6005 .send(proto::LeaveProject {
6006 project_id: *remote_id,
6007 })
6008 .log_err();
6009 }
6010 _ => {}
6011 }
6012 }
6013
6014 fn app_will_quit(
6015 &mut self,
6016 _: &mut MutableAppContext,
6017 ) -> Option<std::pin::Pin<Box<dyn 'static + Future<Output = ()>>>> {
6018 let shutdown_futures = self
6019 .language_servers
6020 .drain()
6021 .map(|(_, server_state)| async {
6022 match server_state {
6023 LanguageServerState::Running { server, .. } => server.shutdown()?.await,
6024 LanguageServerState::Starting(starting_server) => {
6025 starting_server.await?.shutdown()?.await
6026 }
6027 }
6028 })
6029 .collect::<Vec<_>>();
6030
6031 Some(
6032 async move {
6033 futures::future::join_all(shutdown_futures).await;
6034 }
6035 .boxed(),
6036 )
6037 }
6038}
6039
6040impl Collaborator {
6041 fn from_proto(message: proto::Collaborator) -> Self {
6042 Self {
6043 peer_id: PeerId(message.peer_id),
6044 replica_id: message.replica_id as ReplicaId,
6045 }
6046 }
6047}
6048
6049impl<P: AsRef<Path>> From<(WorktreeId, P)> for ProjectPath {
6050 fn from((worktree_id, path): (WorktreeId, P)) -> Self {
6051 Self {
6052 worktree_id,
6053 path: path.as_ref().into(),
6054 }
6055 }
6056}
6057
6058fn serialize_symbol(symbol: &Symbol) -> proto::Symbol {
6059 proto::Symbol {
6060 language_server_name: symbol.language_server_name.0.to_string(),
6061 source_worktree_id: symbol.source_worktree_id.to_proto(),
6062 worktree_id: symbol.path.worktree_id.to_proto(),
6063 path: symbol.path.path.to_string_lossy().to_string(),
6064 name: symbol.name.clone(),
6065 kind: unsafe { mem::transmute(symbol.kind) },
6066 start: Some(proto::PointUtf16 {
6067 row: symbol.range.start.0.row,
6068 column: symbol.range.start.0.column,
6069 }),
6070 end: Some(proto::PointUtf16 {
6071 row: symbol.range.end.0.row,
6072 column: symbol.range.end.0.column,
6073 }),
6074 signature: symbol.signature.to_vec(),
6075 }
6076}
6077
6078fn relativize_path(base: &Path, path: &Path) -> PathBuf {
6079 let mut path_components = path.components();
6080 let mut base_components = base.components();
6081 let mut components: Vec<Component> = Vec::new();
6082 loop {
6083 match (path_components.next(), base_components.next()) {
6084 (None, None) => break,
6085 (Some(a), None) => {
6086 components.push(a);
6087 components.extend(path_components.by_ref());
6088 break;
6089 }
6090 (None, _) => components.push(Component::ParentDir),
6091 (Some(a), Some(b)) if components.is_empty() && a == b => (),
6092 (Some(a), Some(b)) if b == Component::CurDir => components.push(a),
6093 (Some(a), Some(_)) => {
6094 components.push(Component::ParentDir);
6095 for _ in base_components {
6096 components.push(Component::ParentDir);
6097 }
6098 components.push(a);
6099 components.extend(path_components.by_ref());
6100 break;
6101 }
6102 }
6103 }
6104 components.iter().map(|c| c.as_os_str()).collect()
6105}
6106
6107impl Item for Buffer {
6108 fn entry_id(&self, cx: &AppContext) -> Option<ProjectEntryId> {
6109 File::from_dyn(self.file()).and_then(|file| file.project_entry_id(cx))
6110 }
6111}