1pub mod clangd_ext;
2pub mod json_language_server_ext;
3pub mod lsp_ext_command;
4pub mod rust_analyzer_ext;
5
6use crate::{
7 CodeAction, ColorPresentation, Completion, CompletionResponse, CompletionSource,
8 CoreCompletion, DocumentColor, Hover, InlayHint, LocationLink, LspAction, LspPullDiagnostics,
9 ProjectItem, ProjectPath, ProjectTransaction, PulledDiagnostics, ResolveState, Symbol,
10 ToolchainStore,
11 buffer_store::{BufferStore, BufferStoreEvent},
12 environment::ProjectEnvironment,
13 lsp_command::{self, *},
14 lsp_store,
15 manifest_tree::{
16 AdapterQuery, LanguageServerTree, LanguageServerTreeNode, LaunchDisposition,
17 ManifestQueryDelegate, ManifestTree,
18 },
19 prettier_store::{self, PrettierStore, PrettierStoreEvent},
20 project_settings::{LspSettings, ProjectSettings},
21 relativize_path, resolve_path,
22 toolchain_store::{EmptyToolchainStore, ToolchainStoreEvent},
23 worktree_store::{WorktreeStore, WorktreeStoreEvent},
24 yarn::YarnPathStore,
25};
26use anyhow::{Context as _, Result, anyhow};
27use async_trait::async_trait;
28use client::{TypedEnvelope, proto};
29use clock::Global;
30use collections::{BTreeMap, BTreeSet, HashMap, HashSet, btree_map};
31use futures::{
32 AsyncWriteExt, Future, FutureExt, StreamExt,
33 future::{Either, Shared, join_all, pending, select},
34 select, select_biased,
35 stream::FuturesUnordered,
36};
37use globset::{Glob, GlobBuilder, GlobMatcher, GlobSet, GlobSetBuilder};
38use gpui::{
39 App, AppContext, AsyncApp, Context, Entity, EventEmitter, PromptLevel, SharedString, Task,
40 WeakEntity,
41};
42use http_client::HttpClient;
43use itertools::Itertools as _;
44use language::{
45 Bias, BinaryStatus, Buffer, BufferSnapshot, CachedLspAdapter, CodeLabel, Diagnostic,
46 DiagnosticEntry, DiagnosticSet, DiagnosticSourceKind, Diff, File as _, Language, LanguageName,
47 LanguageRegistry, LanguageToolchainStore, LocalFile, LspAdapter, LspAdapterDelegate, Patch,
48 PointUtf16, TextBufferSnapshot, ToOffset, ToPointUtf16, Transaction, Unclipped,
49 WorkspaceFoldersContent,
50 language_settings::{
51 FormatOnSave, Formatter, LanguageSettings, SelectedFormatter, language_settings,
52 },
53 point_to_lsp,
54 proto::{
55 deserialize_anchor, deserialize_lsp_edit, deserialize_version, serialize_anchor,
56 serialize_lsp_edit, serialize_version,
57 },
58 range_from_lsp, range_to_lsp,
59};
60use lsp::{
61 AdapterServerCapabilities, CodeActionKind, CompletionContext, DiagnosticSeverity,
62 DiagnosticTag, DidChangeWatchedFilesRegistrationOptions, Edit, FileOperationFilter,
63 FileOperationPatternKind, FileOperationRegistrationOptions, FileRename, FileSystemWatcher,
64 LanguageServer, LanguageServerBinary, LanguageServerBinaryOptions, LanguageServerId,
65 LanguageServerName, LanguageServerSelector, LspRequestFuture, MessageActionItem, MessageType,
66 OneOf, RenameFilesParams, SymbolKind, TextEdit, WillRenameFiles, WorkDoneProgressCancelParams,
67 WorkspaceFolder, notification::DidRenameFiles,
68};
69use node_runtime::read_package_installed_version;
70use parking_lot::Mutex;
71use postage::{mpsc, sink::Sink, stream::Stream, watch};
72use rand::prelude::*;
73
74use rpc::{
75 AnyProtoClient,
76 proto::{FromProto, ToProto},
77};
78use serde::Serialize;
79use settings::{Settings, SettingsLocation, SettingsStore};
80use sha2::{Digest, Sha256};
81use smol::channel::Sender;
82use snippet::Snippet;
83use std::{
84 any::Any,
85 borrow::Cow,
86 cell::RefCell,
87 cmp::{Ordering, Reverse},
88 convert::TryInto,
89 ffi::OsStr,
90 future::ready,
91 iter, mem,
92 ops::{ControlFlow, Range},
93 path::{self, Path, PathBuf},
94 pin::pin,
95 rc::Rc,
96 sync::Arc,
97 time::{Duration, Instant},
98};
99use sum_tree::Dimensions;
100use text::{Anchor, BufferId, LineEnding, OffsetRangeExt};
101use url::Url;
102use util::{
103 ConnectionResult, ResultExt as _, debug_panic, defer, maybe, merge_json_value_into,
104 paths::{PathExt, SanitizedPath},
105 post_inc,
106};
107
108pub use fs::*;
109pub use language::Location;
110#[cfg(any(test, feature = "test-support"))]
111pub use prettier::FORMAT_SUFFIX as TEST_PRETTIER_FORMAT_SUFFIX;
112pub use worktree::{
113 Entry, EntryKind, FS_WATCH_LATENCY, File, LocalWorktree, PathChange, ProjectEntryId,
114 UpdatedEntriesSet, UpdatedGitRepositoriesSet, Worktree, WorktreeId, WorktreeSettings,
115};
116
117const SERVER_LAUNCHING_BEFORE_SHUTDOWN_TIMEOUT: Duration = Duration::from_secs(5);
118pub const SERVER_PROGRESS_THROTTLE_TIMEOUT: Duration = Duration::from_millis(100);
119
120#[derive(Debug, Clone, Copy, PartialEq, Eq)]
121pub enum FormatTrigger {
122 Save,
123 Manual,
124}
125
126pub enum LspFormatTarget {
127 Buffers,
128 Ranges(BTreeMap<BufferId, Vec<Range<Anchor>>>),
129}
130
131pub type OpenLspBufferHandle = Entity<Entity<Buffer>>;
132
133impl FormatTrigger {
134 fn from_proto(value: i32) -> FormatTrigger {
135 match value {
136 0 => FormatTrigger::Save,
137 1 => FormatTrigger::Manual,
138 _ => FormatTrigger::Save,
139 }
140 }
141}
142
143#[derive(Debug)]
144pub struct DocumentDiagnosticsUpdate<'a, D> {
145 pub diagnostics: D,
146 pub result_id: Option<String>,
147 pub server_id: LanguageServerId,
148 pub disk_based_sources: Cow<'a, [String]>,
149}
150
151pub struct DocumentDiagnostics {
152 diagnostics: Vec<DiagnosticEntry<Unclipped<PointUtf16>>>,
153 document_abs_path: PathBuf,
154 version: Option<i32>,
155}
156
157pub struct LocalLspStore {
158 weak: WeakEntity<LspStore>,
159 worktree_store: Entity<WorktreeStore>,
160 toolchain_store: Entity<ToolchainStore>,
161 http_client: Arc<dyn HttpClient>,
162 environment: Entity<ProjectEnvironment>,
163 fs: Arc<dyn Fs>,
164 languages: Arc<LanguageRegistry>,
165 language_server_ids: HashMap<(WorktreeId, LanguageServerName), BTreeSet<LanguageServerId>>,
166 yarn: Entity<YarnPathStore>,
167 pub language_servers: HashMap<LanguageServerId, LanguageServerState>,
168 buffers_being_formatted: HashSet<BufferId>,
169 last_workspace_edits_by_language_server: HashMap<LanguageServerId, ProjectTransaction>,
170 language_server_watched_paths: HashMap<LanguageServerId, LanguageServerWatchedPaths>,
171 language_server_paths_watched_for_rename:
172 HashMap<LanguageServerId, RenamePathsWatchedForServer>,
173 language_server_watcher_registrations:
174 HashMap<LanguageServerId, HashMap<String, Vec<FileSystemWatcher>>>,
175 supplementary_language_servers:
176 HashMap<LanguageServerId, (LanguageServerName, Arc<LanguageServer>)>,
177 prettier_store: Entity<PrettierStore>,
178 next_diagnostic_group_id: usize,
179 diagnostics: HashMap<
180 WorktreeId,
181 HashMap<
182 Arc<Path>,
183 Vec<(
184 LanguageServerId,
185 Vec<DiagnosticEntry<Unclipped<PointUtf16>>>,
186 )>,
187 >,
188 >,
189 buffer_snapshots: HashMap<BufferId, HashMap<LanguageServerId, Vec<LspBufferSnapshot>>>, // buffer_id -> server_id -> vec of snapshots
190 _subscription: gpui::Subscription,
191 lsp_tree: Entity<LanguageServerTree>,
192 registered_buffers: HashMap<BufferId, usize>,
193 buffers_opened_in_servers: HashMap<BufferId, HashSet<LanguageServerId>>,
194 buffer_pull_diagnostics_result_ids: HashMap<LanguageServerId, HashMap<PathBuf, Option<String>>>,
195}
196
197impl LocalLspStore {
198 /// Returns the running language server for the given ID. Note if the language server is starting, it will not be returned.
199 pub fn running_language_server_for_id(
200 &self,
201 id: LanguageServerId,
202 ) -> Option<&Arc<LanguageServer>> {
203 let language_server_state = self.language_servers.get(&id)?;
204
205 match language_server_state {
206 LanguageServerState::Running { server, .. } => Some(server),
207 LanguageServerState::Starting { .. } => None,
208 }
209 }
210
211 fn start_language_server(
212 &mut self,
213 worktree_handle: &Entity<Worktree>,
214 delegate: Arc<LocalLspAdapterDelegate>,
215 adapter: Arc<CachedLspAdapter>,
216 settings: Arc<LspSettings>,
217 cx: &mut App,
218 ) -> LanguageServerId {
219 let worktree = worktree_handle.read(cx);
220 let worktree_id = worktree.id();
221 let root_path = worktree.abs_path();
222 let key = (worktree_id, adapter.name.clone());
223
224 let override_options = settings.initialization_options.clone();
225
226 let stderr_capture = Arc::new(Mutex::new(Some(String::new())));
227
228 let server_id = self.languages.next_language_server_id();
229 log::info!(
230 "attempting to start language server {:?}, path: {root_path:?}, id: {server_id}",
231 adapter.name.0
232 );
233
234 let binary = self.get_language_server_binary(adapter.clone(), delegate.clone(), true, cx);
235 let pending_workspace_folders: Arc<Mutex<BTreeSet<Url>>> = Default::default();
236
237 let pending_server = cx.spawn({
238 let adapter = adapter.clone();
239 let server_name = adapter.name.clone();
240 let stderr_capture = stderr_capture.clone();
241 #[cfg(any(test, feature = "test-support"))]
242 let lsp_store = self.weak.clone();
243 let pending_workspace_folders = pending_workspace_folders.clone();
244 async move |cx| {
245 let binary = binary.await?;
246 #[cfg(any(test, feature = "test-support"))]
247 if let Some(server) = lsp_store
248 .update(&mut cx.clone(), |this, cx| {
249 this.languages.create_fake_language_server(
250 server_id,
251 &server_name,
252 binary.clone(),
253 &mut cx.to_async(),
254 )
255 })
256 .ok()
257 .flatten()
258 {
259 return Ok(server);
260 }
261
262 let code_action_kinds = adapter.code_action_kinds();
263 lsp::LanguageServer::new(
264 stderr_capture,
265 server_id,
266 server_name,
267 binary,
268 &root_path,
269 code_action_kinds,
270 Some(pending_workspace_folders).filter(|_| {
271 adapter.adapter.workspace_folders_content()
272 == WorkspaceFoldersContent::SubprojectRoots
273 }),
274 cx,
275 )
276 }
277 });
278
279 let startup = {
280 let server_name = adapter.name.0.clone();
281 let delegate = delegate as Arc<dyn LspAdapterDelegate>;
282 let key = key.clone();
283 let adapter = adapter.clone();
284 let lsp_store = self.weak.clone();
285 let pending_workspace_folders = pending_workspace_folders.clone();
286 let fs = self.fs.clone();
287 let pull_diagnostics = ProjectSettings::get_global(cx)
288 .diagnostics
289 .lsp_pull_diagnostics
290 .enabled;
291 cx.spawn(async move |cx| {
292 let result = async {
293 let toolchains =
294 lsp_store.update(cx, |lsp_store, cx| lsp_store.toolchain_store(cx))?;
295 let language_server = pending_server.await?;
296
297 let workspace_config = Self::workspace_configuration_for_adapter(
298 adapter.adapter.clone(),
299 fs.as_ref(),
300 &delegate,
301 toolchains.clone(),
302 cx,
303 )
304 .await?;
305
306 let mut initialization_options = Self::initialization_options_for_adapter(
307 adapter.adapter.clone(),
308 fs.as_ref(),
309 &delegate,
310 )
311 .await?;
312
313 match (&mut initialization_options, override_options) {
314 (Some(initialization_options), Some(override_options)) => {
315 merge_json_value_into(override_options, initialization_options);
316 }
317 (None, override_options) => initialization_options = override_options,
318 _ => {}
319 }
320
321 let initialization_params = cx.update(|cx| {
322 let mut params =
323 language_server.default_initialize_params(pull_diagnostics, cx);
324 params.initialization_options = initialization_options;
325 adapter.adapter.prepare_initialize_params(params, cx)
326 })??;
327
328 Self::setup_lsp_messages(
329 lsp_store.clone(),
330 fs,
331 &language_server,
332 delegate.clone(),
333 adapter.clone(),
334 );
335
336 let did_change_configuration_params =
337 Arc::new(lsp::DidChangeConfigurationParams {
338 settings: workspace_config,
339 });
340 let language_server = cx
341 .update(|cx| {
342 language_server.initialize(
343 initialization_params,
344 did_change_configuration_params.clone(),
345 cx,
346 )
347 })?
348 .await
349 .inspect_err(|_| {
350 if let Some(lsp_store) = lsp_store.upgrade() {
351 lsp_store
352 .update(cx, |lsp_store, cx| {
353 lsp_store.cleanup_lsp_data(server_id);
354 cx.emit(LspStoreEvent::LanguageServerRemoved(server_id))
355 })
356 .ok();
357 }
358 })?;
359
360 language_server
361 .notify::<lsp::notification::DidChangeConfiguration>(
362 &did_change_configuration_params,
363 )
364 .ok();
365
366 anyhow::Ok(language_server)
367 }
368 .await;
369
370 match result {
371 Ok(server) => {
372 lsp_store
373 .update(cx, |lsp_store, mut cx| {
374 lsp_store.insert_newly_running_language_server(
375 adapter,
376 server.clone(),
377 server_id,
378 key,
379 pending_workspace_folders,
380 &mut cx,
381 );
382 })
383 .ok();
384 stderr_capture.lock().take();
385 Some(server)
386 }
387
388 Err(err) => {
389 let log = stderr_capture.lock().take().unwrap_or_default();
390 delegate.update_status(
391 adapter.name(),
392 BinaryStatus::Failed {
393 error: format!("{err}\n-- stderr--\n{log}"),
394 },
395 );
396 let message =
397 format!("Failed to start language server {server_name:?}: {err:#?}");
398 log::error!("{message}");
399 log::error!("server stderr: {log}");
400 None
401 }
402 }
403 })
404 };
405 let state = LanguageServerState::Starting {
406 startup,
407 pending_workspace_folders,
408 };
409
410 self.languages
411 .update_lsp_binary_status(adapter.name(), BinaryStatus::Starting);
412
413 self.language_servers.insert(server_id, state);
414 self.language_server_ids
415 .entry(key)
416 .or_default()
417 .insert(server_id);
418 server_id
419 }
420
421 fn get_language_server_binary(
422 &self,
423 adapter: Arc<CachedLspAdapter>,
424 delegate: Arc<dyn LspAdapterDelegate>,
425 allow_binary_download: bool,
426 cx: &mut App,
427 ) -> Task<Result<LanguageServerBinary>> {
428 let settings = ProjectSettings::get(
429 Some(SettingsLocation {
430 worktree_id: delegate.worktree_id(),
431 path: Path::new(""),
432 }),
433 cx,
434 )
435 .lsp
436 .get(&adapter.name)
437 .and_then(|s| s.binary.clone());
438
439 if settings.as_ref().is_some_and(|b| b.path.is_some()) {
440 let settings = settings.unwrap();
441
442 return cx.background_spawn(async move {
443 let mut env = delegate.shell_env().await;
444 env.extend(settings.env.unwrap_or_default());
445
446 Ok(LanguageServerBinary {
447 path: PathBuf::from(&settings.path.unwrap()),
448 env: Some(env),
449 arguments: settings
450 .arguments
451 .unwrap_or_default()
452 .iter()
453 .map(Into::into)
454 .collect(),
455 })
456 });
457 }
458 let lsp_binary_options = LanguageServerBinaryOptions {
459 allow_path_lookup: !settings
460 .as_ref()
461 .and_then(|b| b.ignore_system_version)
462 .unwrap_or_default(),
463 allow_binary_download,
464 };
465 let toolchains = self.toolchain_store.read(cx).as_language_toolchain_store();
466 cx.spawn(async move |cx| {
467 let binary_result = adapter
468 .clone()
469 .get_language_server_command(delegate.clone(), toolchains, lsp_binary_options, cx)
470 .await;
471
472 delegate.update_status(adapter.name.clone(), BinaryStatus::None);
473
474 let mut binary = binary_result?;
475 let mut shell_env = delegate.shell_env().await;
476
477 shell_env.extend(binary.env.unwrap_or_default());
478
479 if let Some(settings) = settings {
480 if let Some(arguments) = settings.arguments {
481 binary.arguments = arguments.into_iter().map(Into::into).collect();
482 }
483 if let Some(env) = settings.env {
484 shell_env.extend(env);
485 }
486 }
487
488 binary.env = Some(shell_env);
489 Ok(binary)
490 })
491 }
492
493 fn setup_lsp_messages(
494 this: WeakEntity<LspStore>,
495 fs: Arc<dyn Fs>,
496 language_server: &LanguageServer,
497 delegate: Arc<dyn LspAdapterDelegate>,
498 adapter: Arc<CachedLspAdapter>,
499 ) {
500 let name = language_server.name();
501 let server_id = language_server.server_id();
502 language_server
503 .on_notification::<lsp::notification::PublishDiagnostics, _>({
504 let adapter = adapter.clone();
505 let this = this.clone();
506 move |mut params, cx| {
507 let adapter = adapter.clone();
508 if let Some(this) = this.upgrade() {
509 this.update(cx, |this, cx| {
510 {
511 let buffer = params
512 .uri
513 .to_file_path()
514 .map(|file_path| this.get_buffer(&file_path, cx))
515 .ok()
516 .flatten();
517 adapter.process_diagnostics(&mut params, server_id, buffer);
518 }
519
520 this.merge_lsp_diagnostics(
521 DiagnosticSourceKind::Pushed,
522 vec![DocumentDiagnosticsUpdate {
523 server_id,
524 diagnostics: params,
525 result_id: None,
526 disk_based_sources: Cow::Borrowed(
527 &adapter.disk_based_diagnostic_sources,
528 ),
529 }],
530 |_, diagnostic, cx| match diagnostic.source_kind {
531 DiagnosticSourceKind::Other | DiagnosticSourceKind::Pushed => {
532 adapter.retain_old_diagnostic(diagnostic, cx)
533 }
534 DiagnosticSourceKind::Pulled => true,
535 },
536 cx,
537 )
538 .log_err();
539 })
540 .ok();
541 }
542 }
543 })
544 .detach();
545 language_server
546 .on_request::<lsp::request::WorkspaceConfiguration, _, _>({
547 let adapter = adapter.adapter.clone();
548 let delegate = delegate.clone();
549 let this = this.clone();
550 let fs = fs.clone();
551 move |params, cx| {
552 let adapter = adapter.clone();
553 let delegate = delegate.clone();
554 let this = this.clone();
555 let fs = fs.clone();
556 let mut cx = cx.clone();
557 async move {
558 let toolchains =
559 this.update(&mut cx, |this, cx| this.toolchain_store(cx))?;
560
561 let workspace_config = Self::workspace_configuration_for_adapter(
562 adapter.clone(),
563 fs.as_ref(),
564 &delegate,
565 toolchains.clone(),
566 &mut cx,
567 )
568 .await?;
569
570 Ok(params
571 .items
572 .into_iter()
573 .map(|item| {
574 if let Some(section) = &item.section {
575 workspace_config
576 .get(section)
577 .cloned()
578 .unwrap_or(serde_json::Value::Null)
579 } else {
580 workspace_config.clone()
581 }
582 })
583 .collect())
584 }
585 }
586 })
587 .detach();
588
589 language_server
590 .on_request::<lsp::request::WorkspaceFoldersRequest, _, _>({
591 let this = this.clone();
592 move |_, cx| {
593 let this = this.clone();
594 let mut cx = cx.clone();
595 async move {
596 let Some(server) = this
597 .read_with(&mut cx, |this, _| this.language_server_for_id(server_id))?
598 else {
599 return Ok(None);
600 };
601 let root = server.workspace_folders();
602 Ok(Some(
603 root.into_iter()
604 .map(|uri| WorkspaceFolder {
605 uri,
606 name: Default::default(),
607 })
608 .collect(),
609 ))
610 }
611 }
612 })
613 .detach();
614 // Even though we don't have handling for these requests, respond to them to
615 // avoid stalling any language server like `gopls` which waits for a response
616 // to these requests when initializing.
617 language_server
618 .on_request::<lsp::request::WorkDoneProgressCreate, _, _>({
619 let this = this.clone();
620 move |params, cx| {
621 let this = this.clone();
622 let mut cx = cx.clone();
623 async move {
624 this.update(&mut cx, |this, _| {
625 if let Some(status) = this.language_server_statuses.get_mut(&server_id)
626 {
627 if let lsp::NumberOrString::String(token) = params.token {
628 status.progress_tokens.insert(token);
629 }
630 }
631 })?;
632
633 Ok(())
634 }
635 }
636 })
637 .detach();
638
639 language_server
640 .on_request::<lsp::request::RegisterCapability, _, _>({
641 let lsp_store = this.clone();
642 move |params, cx| {
643 let lsp_store = lsp_store.clone();
644 let mut cx = cx.clone();
645 async move {
646 lsp_store
647 .update(&mut cx, |lsp_store, cx| {
648 if lsp_store.as_local().is_some() {
649 match lsp_store
650 .register_server_capabilities(server_id, params, cx)
651 {
652 Ok(()) => {}
653 Err(e) => {
654 log::error!(
655 "Failed to register server capabilities: {e:#}"
656 );
657 }
658 };
659 }
660 })
661 .ok();
662 Ok(())
663 }
664 }
665 })
666 .detach();
667
668 language_server
669 .on_request::<lsp::request::UnregisterCapability, _, _>({
670 let lsp_store = this.clone();
671 move |params, cx| {
672 let lsp_store = lsp_store.clone();
673 let mut cx = cx.clone();
674 async move {
675 lsp_store
676 .update(&mut cx, |lsp_store, cx| {
677 if lsp_store.as_local().is_some() {
678 match lsp_store
679 .unregister_server_capabilities(server_id, params, cx)
680 {
681 Ok(()) => {}
682 Err(e) => {
683 log::error!(
684 "Failed to unregister server capabilities: {e:#}"
685 );
686 }
687 }
688 }
689 })
690 .ok();
691 Ok(())
692 }
693 }
694 })
695 .detach();
696
697 language_server
698 .on_request::<lsp::request::ApplyWorkspaceEdit, _, _>({
699 let adapter = adapter.clone();
700 let this = this.clone();
701 move |params, cx| {
702 let mut cx = cx.clone();
703 let this = this.clone();
704 let adapter = adapter.clone();
705 async move {
706 LocalLspStore::on_lsp_workspace_edit(
707 this.clone(),
708 params,
709 server_id,
710 adapter.clone(),
711 &mut cx,
712 )
713 .await
714 }
715 }
716 })
717 .detach();
718
719 language_server
720 .on_request::<lsp::request::InlayHintRefreshRequest, _, _>({
721 let this = this.clone();
722 move |(), cx| {
723 let this = this.clone();
724 let mut cx = cx.clone();
725 async move {
726 this.update(&mut cx, |this, cx| {
727 cx.emit(LspStoreEvent::RefreshInlayHints);
728 this.downstream_client.as_ref().map(|(client, project_id)| {
729 client.send(proto::RefreshInlayHints {
730 project_id: *project_id,
731 })
732 })
733 })?
734 .transpose()?;
735 Ok(())
736 }
737 }
738 })
739 .detach();
740
741 language_server
742 .on_request::<lsp::request::CodeLensRefresh, _, _>({
743 let this = this.clone();
744 move |(), cx| {
745 let this = this.clone();
746 let mut cx = cx.clone();
747 async move {
748 this.update(&mut cx, |this, cx| {
749 cx.emit(LspStoreEvent::RefreshCodeLens);
750 this.downstream_client.as_ref().map(|(client, project_id)| {
751 client.send(proto::RefreshCodeLens {
752 project_id: *project_id,
753 })
754 })
755 })?
756 .transpose()?;
757 Ok(())
758 }
759 }
760 })
761 .detach();
762
763 language_server
764 .on_request::<lsp::request::WorkspaceDiagnosticRefresh, _, _>({
765 let this = this.clone();
766 move |(), cx| {
767 let this = this.clone();
768 let mut cx = cx.clone();
769 async move {
770 this.update(&mut cx, |lsp_store, _| {
771 lsp_store.pull_workspace_diagnostics(server_id);
772 lsp_store
773 .downstream_client
774 .as_ref()
775 .map(|(client, project_id)| {
776 client.send(proto::PullWorkspaceDiagnostics {
777 project_id: *project_id,
778 server_id: server_id.to_proto(),
779 })
780 })
781 })?
782 .transpose()?;
783 Ok(())
784 }
785 }
786 })
787 .detach();
788
789 language_server
790 .on_request::<lsp::request::ShowMessageRequest, _, _>({
791 let this = this.clone();
792 let name = name.to_string();
793 move |params, cx| {
794 let this = this.clone();
795 let name = name.to_string();
796 let mut cx = cx.clone();
797 async move {
798 let actions = params.actions.unwrap_or_default();
799 let (tx, rx) = smol::channel::bounded(1);
800 let request = LanguageServerPromptRequest {
801 level: match params.typ {
802 lsp::MessageType::ERROR => PromptLevel::Critical,
803 lsp::MessageType::WARNING => PromptLevel::Warning,
804 _ => PromptLevel::Info,
805 },
806 message: params.message,
807 actions,
808 response_channel: tx,
809 lsp_name: name.clone(),
810 };
811
812 let did_update = this
813 .update(&mut cx, |_, cx| {
814 cx.emit(LspStoreEvent::LanguageServerPrompt(request));
815 })
816 .is_ok();
817 if did_update {
818 let response = rx.recv().await.ok();
819 Ok(response)
820 } else {
821 Ok(None)
822 }
823 }
824 }
825 })
826 .detach();
827 language_server
828 .on_notification::<lsp::notification::ShowMessage, _>({
829 let this = this.clone();
830 let name = name.to_string();
831 move |params, cx| {
832 let this = this.clone();
833 let name = name.to_string();
834 let mut cx = cx.clone();
835
836 let (tx, _) = smol::channel::bounded(1);
837 let request = LanguageServerPromptRequest {
838 level: match params.typ {
839 lsp::MessageType::ERROR => PromptLevel::Critical,
840 lsp::MessageType::WARNING => PromptLevel::Warning,
841 _ => PromptLevel::Info,
842 },
843 message: params.message,
844 actions: vec![],
845 response_channel: tx,
846 lsp_name: name.clone(),
847 };
848
849 let _ = this.update(&mut cx, |_, cx| {
850 cx.emit(LspStoreEvent::LanguageServerPrompt(request));
851 });
852 }
853 })
854 .detach();
855
856 let disk_based_diagnostics_progress_token =
857 adapter.disk_based_diagnostics_progress_token.clone();
858
859 language_server
860 .on_notification::<lsp::notification::Progress, _>({
861 let this = this.clone();
862 move |params, cx| {
863 if let Some(this) = this.upgrade() {
864 this.update(cx, |this, cx| {
865 this.on_lsp_progress(
866 params,
867 server_id,
868 disk_based_diagnostics_progress_token.clone(),
869 cx,
870 );
871 })
872 .ok();
873 }
874 }
875 })
876 .detach();
877
878 language_server
879 .on_notification::<lsp::notification::LogMessage, _>({
880 let this = this.clone();
881 move |params, cx| {
882 if let Some(this) = this.upgrade() {
883 this.update(cx, |_, cx| {
884 cx.emit(LspStoreEvent::LanguageServerLog(
885 server_id,
886 LanguageServerLogType::Log(params.typ),
887 params.message,
888 ));
889 })
890 .ok();
891 }
892 }
893 })
894 .detach();
895
896 language_server
897 .on_notification::<lsp::notification::LogTrace, _>({
898 let this = this.clone();
899 move |params, cx| {
900 let mut cx = cx.clone();
901 if let Some(this) = this.upgrade() {
902 this.update(&mut cx, |_, cx| {
903 cx.emit(LspStoreEvent::LanguageServerLog(
904 server_id,
905 LanguageServerLogType::Trace(params.verbose),
906 params.message,
907 ));
908 })
909 .ok();
910 }
911 }
912 })
913 .detach();
914
915 json_language_server_ext::register_requests(this.clone(), language_server);
916 rust_analyzer_ext::register_notifications(this.clone(), language_server);
917 clangd_ext::register_notifications(this, language_server, adapter);
918 }
919
920 fn shutdown_language_servers_on_quit(
921 &mut self,
922 _: &mut Context<LspStore>,
923 ) -> impl Future<Output = ()> + use<> {
924 let shutdown_futures = self
925 .language_servers
926 .drain()
927 .map(|(_, server_state)| Self::shutdown_server(server_state))
928 .collect::<Vec<_>>();
929
930 async move {
931 join_all(shutdown_futures).await;
932 }
933 }
934
935 async fn shutdown_server(server_state: LanguageServerState) -> anyhow::Result<()> {
936 match server_state {
937 LanguageServerState::Running { server, .. } => {
938 if let Some(shutdown) = server.shutdown() {
939 shutdown.await;
940 }
941 }
942 LanguageServerState::Starting { startup, .. } => {
943 if let Some(server) = startup.await {
944 if let Some(shutdown) = server.shutdown() {
945 shutdown.await;
946 }
947 }
948 }
949 }
950 Ok(())
951 }
952
953 fn language_servers_for_worktree(
954 &self,
955 worktree_id: WorktreeId,
956 ) -> impl Iterator<Item = &Arc<LanguageServer>> {
957 self.language_server_ids
958 .iter()
959 .flat_map(move |((language_server_path, _), ids)| {
960 ids.iter().filter_map(move |id| {
961 if *language_server_path != worktree_id {
962 return None;
963 }
964 if let Some(LanguageServerState::Running { server, .. }) =
965 self.language_servers.get(id)
966 {
967 return Some(server);
968 } else {
969 None
970 }
971 })
972 })
973 }
974
975 fn language_server_ids_for_project_path(
976 &self,
977 project_path: ProjectPath,
978 language: &Language,
979 cx: &mut App,
980 ) -> Vec<LanguageServerId> {
981 let Some(worktree) = self
982 .worktree_store
983 .read(cx)
984 .worktree_for_id(project_path.worktree_id, cx)
985 else {
986 return Vec::new();
987 };
988 let delegate = Arc::new(ManifestQueryDelegate::new(worktree.read(cx).snapshot()));
989 let root = self.lsp_tree.update(cx, |this, cx| {
990 this.get(
991 project_path,
992 AdapterQuery::Language(&language.name()),
993 delegate,
994 cx,
995 )
996 .filter_map(|node| node.server_id())
997 .collect::<Vec<_>>()
998 });
999
1000 root
1001 }
1002
1003 fn language_server_ids_for_buffer(
1004 &self,
1005 buffer: &Buffer,
1006 cx: &mut App,
1007 ) -> Vec<LanguageServerId> {
1008 if let Some((file, language)) = File::from_dyn(buffer.file()).zip(buffer.language()) {
1009 let worktree_id = file.worktree_id(cx);
1010
1011 let path: Arc<Path> = file
1012 .path()
1013 .parent()
1014 .map(Arc::from)
1015 .unwrap_or_else(|| file.path().clone());
1016 let worktree_path = ProjectPath { worktree_id, path };
1017 self.language_server_ids_for_project_path(worktree_path, language, cx)
1018 } else {
1019 Vec::new()
1020 }
1021 }
1022
1023 fn language_servers_for_buffer<'a>(
1024 &'a self,
1025 buffer: &'a Buffer,
1026 cx: &'a mut App,
1027 ) -> impl Iterator<Item = (&'a Arc<CachedLspAdapter>, &'a Arc<LanguageServer>)> {
1028 self.language_server_ids_for_buffer(buffer, cx)
1029 .into_iter()
1030 .filter_map(|server_id| match self.language_servers.get(&server_id)? {
1031 LanguageServerState::Running {
1032 adapter, server, ..
1033 } => Some((adapter, server)),
1034 _ => None,
1035 })
1036 }
1037
1038 async fn execute_code_action_kind_locally(
1039 lsp_store: WeakEntity<LspStore>,
1040 mut buffers: Vec<Entity<Buffer>>,
1041 kind: CodeActionKind,
1042 push_to_history: bool,
1043 cx: &mut AsyncApp,
1044 ) -> anyhow::Result<ProjectTransaction> {
1045 // Do not allow multiple concurrent code actions requests for the
1046 // same buffer.
1047 lsp_store.update(cx, |this, cx| {
1048 let this = this.as_local_mut().unwrap();
1049 buffers.retain(|buffer| {
1050 this.buffers_being_formatted
1051 .insert(buffer.read(cx).remote_id())
1052 });
1053 })?;
1054 let _cleanup = defer({
1055 let this = lsp_store.clone();
1056 let mut cx = cx.clone();
1057 let buffers = &buffers;
1058 move || {
1059 this.update(&mut cx, |this, cx| {
1060 let this = this.as_local_mut().unwrap();
1061 for buffer in buffers {
1062 this.buffers_being_formatted
1063 .remove(&buffer.read(cx).remote_id());
1064 }
1065 })
1066 .ok();
1067 }
1068 });
1069 let mut project_transaction = ProjectTransaction::default();
1070
1071 for buffer in &buffers {
1072 let adapters_and_servers = lsp_store.update(cx, |lsp_store, cx| {
1073 buffer.update(cx, |buffer, cx| {
1074 lsp_store
1075 .as_local()
1076 .unwrap()
1077 .language_servers_for_buffer(buffer, cx)
1078 .map(|(adapter, lsp)| (adapter.clone(), lsp.clone()))
1079 .collect::<Vec<_>>()
1080 })
1081 })?;
1082 for (lsp_adapter, language_server) in adapters_and_servers.iter() {
1083 let actions = Self::get_server_code_actions_from_action_kinds(
1084 &lsp_store,
1085 language_server.server_id(),
1086 vec![kind.clone()],
1087 buffer,
1088 cx,
1089 )
1090 .await?;
1091 Self::execute_code_actions_on_server(
1092 &lsp_store,
1093 language_server,
1094 lsp_adapter,
1095 actions,
1096 push_to_history,
1097 &mut project_transaction,
1098 cx,
1099 )
1100 .await?;
1101 }
1102 }
1103 Ok(project_transaction)
1104 }
1105
1106 async fn format_locally(
1107 lsp_store: WeakEntity<LspStore>,
1108 mut buffers: Vec<FormattableBuffer>,
1109 push_to_history: bool,
1110 trigger: FormatTrigger,
1111 logger: zlog::Logger,
1112 cx: &mut AsyncApp,
1113 ) -> anyhow::Result<ProjectTransaction> {
1114 // Do not allow multiple concurrent formatting requests for the
1115 // same buffer.
1116 lsp_store.update(cx, |this, cx| {
1117 let this = this.as_local_mut().unwrap();
1118 buffers.retain(|buffer| {
1119 this.buffers_being_formatted
1120 .insert(buffer.handle.read(cx).remote_id())
1121 });
1122 })?;
1123
1124 let _cleanup = defer({
1125 let this = lsp_store.clone();
1126 let mut cx = cx.clone();
1127 let buffers = &buffers;
1128 move || {
1129 this.update(&mut cx, |this, cx| {
1130 let this = this.as_local_mut().unwrap();
1131 for buffer in buffers {
1132 this.buffers_being_formatted
1133 .remove(&buffer.handle.read(cx).remote_id());
1134 }
1135 })
1136 .ok();
1137 }
1138 });
1139
1140 let mut project_transaction = ProjectTransaction::default();
1141
1142 for buffer in &buffers {
1143 zlog::debug!(
1144 logger =>
1145 "formatting buffer '{:?}'",
1146 buffer.abs_path.as_ref().unwrap_or(&PathBuf::from("unknown")).display()
1147 );
1148 // Create an empty transaction to hold all of the formatting edits.
1149 let formatting_transaction_id = buffer.handle.update(cx, |buffer, cx| {
1150 // ensure no transactions created while formatting are
1151 // grouped with the previous transaction in the history
1152 // based on the transaction group interval
1153 buffer.finalize_last_transaction();
1154 buffer
1155 .start_transaction()
1156 .context("transaction already open")?;
1157 buffer.end_transaction(cx);
1158 let transaction_id = buffer.push_empty_transaction(cx.background_executor().now());
1159 buffer.finalize_last_transaction();
1160 anyhow::Ok(transaction_id)
1161 })??;
1162
1163 let result = Self::format_buffer_locally(
1164 lsp_store.clone(),
1165 buffer,
1166 formatting_transaction_id,
1167 trigger,
1168 logger,
1169 cx,
1170 )
1171 .await;
1172
1173 buffer.handle.update(cx, |buffer, cx| {
1174 let Some(formatting_transaction) =
1175 buffer.get_transaction(formatting_transaction_id).cloned()
1176 else {
1177 zlog::warn!(logger => "no formatting transaction");
1178 return;
1179 };
1180 if formatting_transaction.edit_ids.is_empty() {
1181 zlog::debug!(logger => "no changes made while formatting");
1182 buffer.forget_transaction(formatting_transaction_id);
1183 return;
1184 }
1185 if !push_to_history {
1186 zlog::trace!(logger => "forgetting format transaction");
1187 buffer.forget_transaction(formatting_transaction.id);
1188 }
1189 project_transaction
1190 .0
1191 .insert(cx.entity(), formatting_transaction);
1192 })?;
1193
1194 result?;
1195 }
1196
1197 Ok(project_transaction)
1198 }
1199
1200 async fn format_buffer_locally(
1201 lsp_store: WeakEntity<LspStore>,
1202 buffer: &FormattableBuffer,
1203 formatting_transaction_id: clock::Lamport,
1204 trigger: FormatTrigger,
1205 logger: zlog::Logger,
1206 cx: &mut AsyncApp,
1207 ) -> Result<()> {
1208 let (adapters_and_servers, settings) = lsp_store.update(cx, |lsp_store, cx| {
1209 buffer.handle.update(cx, |buffer, cx| {
1210 let adapters_and_servers = lsp_store
1211 .as_local()
1212 .unwrap()
1213 .language_servers_for_buffer(buffer, cx)
1214 .map(|(adapter, lsp)| (adapter.clone(), lsp.clone()))
1215 .collect::<Vec<_>>();
1216 let settings =
1217 language_settings(buffer.language().map(|l| l.name()), buffer.file(), cx)
1218 .into_owned();
1219 (adapters_and_servers, settings)
1220 })
1221 })?;
1222
1223 /// Apply edits to the buffer that will become part of the formatting transaction.
1224 /// Fails if the buffer has been edited since the start of that transaction.
1225 fn extend_formatting_transaction(
1226 buffer: &FormattableBuffer,
1227 formatting_transaction_id: text::TransactionId,
1228 cx: &mut AsyncApp,
1229 operation: impl FnOnce(&mut Buffer, &mut Context<Buffer>),
1230 ) -> anyhow::Result<()> {
1231 buffer.handle.update(cx, |buffer, cx| {
1232 let last_transaction_id = buffer.peek_undo_stack().map(|t| t.transaction_id());
1233 if last_transaction_id != Some(formatting_transaction_id) {
1234 anyhow::bail!("Buffer edited while formatting. Aborting")
1235 }
1236 buffer.start_transaction();
1237 operation(buffer, cx);
1238 if let Some(transaction_id) = buffer.end_transaction(cx) {
1239 buffer.merge_transactions(transaction_id, formatting_transaction_id);
1240 }
1241 Ok(())
1242 })?
1243 }
1244
1245 // handle whitespace formatting
1246 if settings.remove_trailing_whitespace_on_save {
1247 zlog::trace!(logger => "removing trailing whitespace");
1248 let diff = buffer
1249 .handle
1250 .read_with(cx, |buffer, cx| buffer.remove_trailing_whitespace(cx))?
1251 .await;
1252 extend_formatting_transaction(buffer, formatting_transaction_id, cx, |buffer, cx| {
1253 buffer.apply_diff(diff, cx);
1254 })?;
1255 }
1256
1257 if settings.ensure_final_newline_on_save {
1258 zlog::trace!(logger => "ensuring final newline");
1259 extend_formatting_transaction(buffer, formatting_transaction_id, cx, |buffer, cx| {
1260 buffer.ensure_final_newline(cx);
1261 })?;
1262 }
1263
1264 // Formatter for `code_actions_on_format` that runs before
1265 // the rest of the formatters
1266 let mut code_actions_on_format_formatter = None;
1267 let should_run_code_actions_on_format = !matches!(
1268 (trigger, &settings.format_on_save),
1269 (FormatTrigger::Save, &FormatOnSave::Off)
1270 );
1271 if should_run_code_actions_on_format {
1272 let have_code_actions_to_run_on_format = settings
1273 .code_actions_on_format
1274 .values()
1275 .any(|enabled| *enabled);
1276 if have_code_actions_to_run_on_format {
1277 zlog::trace!(logger => "going to run code actions on format");
1278 code_actions_on_format_formatter = Some(Formatter::CodeActions(
1279 settings.code_actions_on_format.clone(),
1280 ));
1281 }
1282 }
1283
1284 let formatters = match (trigger, &settings.format_on_save) {
1285 (FormatTrigger::Save, FormatOnSave::Off) => &[],
1286 (FormatTrigger::Save, FormatOnSave::List(formatters)) => formatters.as_ref(),
1287 (FormatTrigger::Manual, _) | (FormatTrigger::Save, FormatOnSave::On) => {
1288 match &settings.formatter {
1289 SelectedFormatter::Auto => {
1290 if settings.prettier.allowed {
1291 zlog::trace!(logger => "Formatter set to auto: defaulting to prettier");
1292 std::slice::from_ref(&Formatter::Prettier)
1293 } else {
1294 zlog::trace!(logger => "Formatter set to auto: defaulting to primary language server");
1295 std::slice::from_ref(&Formatter::LanguageServer { name: None })
1296 }
1297 }
1298 SelectedFormatter::List(formatter_list) => formatter_list.as_ref(),
1299 }
1300 }
1301 };
1302
1303 let formatters = code_actions_on_format_formatter.iter().chain(formatters);
1304
1305 for formatter in formatters {
1306 match formatter {
1307 Formatter::Prettier => {
1308 let logger = zlog::scoped!(logger => "prettier");
1309 zlog::trace!(logger => "formatting");
1310 let _timer = zlog::time!(logger => "Formatting buffer via prettier");
1311
1312 let prettier = lsp_store.read_with(cx, |lsp_store, _cx| {
1313 lsp_store.prettier_store().unwrap().downgrade()
1314 })?;
1315 let diff = prettier_store::format_with_prettier(&prettier, &buffer.handle, cx)
1316 .await
1317 .transpose()?;
1318 let Some(diff) = diff else {
1319 zlog::trace!(logger => "No changes");
1320 continue;
1321 };
1322
1323 extend_formatting_transaction(
1324 buffer,
1325 formatting_transaction_id,
1326 cx,
1327 |buffer, cx| {
1328 buffer.apply_diff(diff, cx);
1329 },
1330 )?;
1331 }
1332 Formatter::External { command, arguments } => {
1333 let logger = zlog::scoped!(logger => "command");
1334 zlog::trace!(logger => "formatting");
1335 let _timer = zlog::time!(logger => "Formatting buffer via external command");
1336
1337 let diff = Self::format_via_external_command(
1338 buffer,
1339 command.as_ref(),
1340 arguments.as_deref(),
1341 cx,
1342 )
1343 .await
1344 .with_context(|| {
1345 format!("Failed to format buffer via external command: {}", command)
1346 })?;
1347 let Some(diff) = diff else {
1348 zlog::trace!(logger => "No changes");
1349 continue;
1350 };
1351
1352 extend_formatting_transaction(
1353 buffer,
1354 formatting_transaction_id,
1355 cx,
1356 |buffer, cx| {
1357 buffer.apply_diff(diff, cx);
1358 },
1359 )?;
1360 }
1361 Formatter::LanguageServer { name } => {
1362 let logger = zlog::scoped!(logger => "language-server");
1363 zlog::trace!(logger => "formatting");
1364 let _timer = zlog::time!(logger => "Formatting buffer using language server");
1365
1366 let Some(buffer_path_abs) = buffer.abs_path.as_ref() else {
1367 zlog::warn!(logger => "Cannot format buffer that is not backed by a file on disk using language servers. Skipping");
1368 continue;
1369 };
1370
1371 let language_server = if let Some(name) = name.as_deref() {
1372 adapters_and_servers.iter().find_map(|(adapter, server)| {
1373 if adapter.name.0.as_ref() == name {
1374 Some(server.clone())
1375 } else {
1376 None
1377 }
1378 })
1379 } else {
1380 adapters_and_servers.first().map(|e| e.1.clone())
1381 };
1382
1383 let Some(language_server) = language_server else {
1384 log::debug!(
1385 "No language server found to format buffer '{:?}'. Skipping",
1386 buffer_path_abs.as_path().to_string_lossy()
1387 );
1388 continue;
1389 };
1390
1391 zlog::trace!(
1392 logger =>
1393 "Formatting buffer '{:?}' using language server '{:?}'",
1394 buffer_path_abs.as_path().to_string_lossy(),
1395 language_server.name()
1396 );
1397
1398 let edits = if let Some(ranges) = buffer.ranges.as_ref() {
1399 zlog::trace!(logger => "formatting ranges");
1400 Self::format_ranges_via_lsp(
1401 &lsp_store,
1402 &buffer.handle,
1403 ranges,
1404 buffer_path_abs,
1405 &language_server,
1406 &settings,
1407 cx,
1408 )
1409 .await
1410 .context("Failed to format ranges via language server")?
1411 } else {
1412 zlog::trace!(logger => "formatting full");
1413 Self::format_via_lsp(
1414 &lsp_store,
1415 &buffer.handle,
1416 buffer_path_abs,
1417 &language_server,
1418 &settings,
1419 cx,
1420 )
1421 .await
1422 .context("failed to format via language server")?
1423 };
1424
1425 if edits.is_empty() {
1426 zlog::trace!(logger => "No changes");
1427 continue;
1428 }
1429 extend_formatting_transaction(
1430 buffer,
1431 formatting_transaction_id,
1432 cx,
1433 |buffer, cx| {
1434 buffer.edit(edits, None, cx);
1435 },
1436 )?;
1437 }
1438 Formatter::CodeActions(code_actions) => {
1439 let logger = zlog::scoped!(logger => "code-actions");
1440 zlog::trace!(logger => "formatting");
1441 let _timer = zlog::time!(logger => "Formatting buffer using code actions");
1442
1443 let Some(buffer_path_abs) = buffer.abs_path.as_ref() else {
1444 zlog::warn!(logger => "Cannot format buffer that is not backed by a file on disk using code actions. Skipping");
1445 continue;
1446 };
1447 let code_action_kinds = code_actions
1448 .iter()
1449 .filter_map(|(action_kind, enabled)| {
1450 enabled.then_some(action_kind.clone().into())
1451 })
1452 .collect::<Vec<_>>();
1453 if code_action_kinds.is_empty() {
1454 zlog::trace!(logger => "No code action kinds enabled, skipping");
1455 continue;
1456 }
1457 zlog::trace!(logger => "Attempting to resolve code actions {:?}", &code_action_kinds);
1458
1459 let mut actions_and_servers = Vec::new();
1460
1461 for (index, (_, language_server)) in adapters_and_servers.iter().enumerate() {
1462 let actions_result = Self::get_server_code_actions_from_action_kinds(
1463 &lsp_store,
1464 language_server.server_id(),
1465 code_action_kinds.clone(),
1466 &buffer.handle,
1467 cx,
1468 )
1469 .await
1470 .with_context(
1471 || format!("Failed to resolve code actions with kinds {:?} for language server {}",
1472 code_action_kinds.iter().map(|kind| kind.as_str()).join(", "),
1473 language_server.name())
1474 );
1475 let Ok(actions) = actions_result else {
1476 // note: it may be better to set result to the error and break formatters here
1477 // but for now we try to execute the actions that we can resolve and skip the rest
1478 zlog::error!(
1479 logger =>
1480 "Failed to resolve code actions with kinds {:?} with language server {}",
1481 code_action_kinds.iter().map(|kind| kind.as_str()).join(", "),
1482 language_server.name()
1483 );
1484 continue;
1485 };
1486 for action in actions {
1487 actions_and_servers.push((action, index));
1488 }
1489 }
1490
1491 if actions_and_servers.is_empty() {
1492 zlog::warn!(logger => "No code actions were resolved, continuing");
1493 continue;
1494 }
1495
1496 'actions: for (mut action, server_index) in actions_and_servers {
1497 let server = &adapters_and_servers[server_index].1;
1498
1499 let describe_code_action = |action: &CodeAction| {
1500 format!(
1501 "code action '{}' with title \"{}\" on server {}",
1502 action
1503 .lsp_action
1504 .action_kind()
1505 .unwrap_or("unknown".into())
1506 .as_str(),
1507 action.lsp_action.title(),
1508 server.name(),
1509 )
1510 };
1511
1512 zlog::trace!(logger => "Executing {}", describe_code_action(&action));
1513
1514 if let Err(err) = Self::try_resolve_code_action(server, &mut action).await {
1515 zlog::error!(
1516 logger =>
1517 "Failed to resolve {}. Error: {}",
1518 describe_code_action(&action),
1519 err
1520 );
1521 continue;
1522 }
1523
1524 if let Some(edit) = action.lsp_action.edit().cloned() {
1525 // NOTE: code below duplicated from `Self::deserialize_workspace_edit`
1526 // but filters out and logs warnings for code actions that cause unreasonably
1527 // difficult handling on our part, such as:
1528 // - applying edits that call commands
1529 // which can result in arbitrary workspace edits being sent from the server that
1530 // have no way of being tied back to the command that initiated them (i.e. we
1531 // can't know which edits are part of the format request, or if the server is done sending
1532 // actions in response to the command)
1533 // - actions that create/delete/modify/rename files other than the one we are formatting
1534 // as we then would need to handle such changes correctly in the local history as well
1535 // as the remote history through the ProjectTransaction
1536 // - actions with snippet edits, as these simply don't make sense in the context of a format request
1537 // Supporting these actions is not impossible, but not supported as of yet.
1538 if edit.changes.is_none() && edit.document_changes.is_none() {
1539 zlog::trace!(
1540 logger =>
1541 "No changes for code action. Skipping {}",
1542 describe_code_action(&action),
1543 );
1544 continue;
1545 }
1546
1547 let mut operations = Vec::new();
1548 if let Some(document_changes) = edit.document_changes {
1549 match document_changes {
1550 lsp::DocumentChanges::Edits(edits) => operations.extend(
1551 edits.into_iter().map(lsp::DocumentChangeOperation::Edit),
1552 ),
1553 lsp::DocumentChanges::Operations(ops) => operations = ops,
1554 }
1555 } else if let Some(changes) = edit.changes {
1556 operations.extend(changes.into_iter().map(|(uri, edits)| {
1557 lsp::DocumentChangeOperation::Edit(lsp::TextDocumentEdit {
1558 text_document:
1559 lsp::OptionalVersionedTextDocumentIdentifier {
1560 uri,
1561 version: None,
1562 },
1563 edits: edits.into_iter().map(Edit::Plain).collect(),
1564 })
1565 }));
1566 }
1567
1568 let mut edits = Vec::with_capacity(operations.len());
1569
1570 if operations.is_empty() {
1571 zlog::trace!(
1572 logger =>
1573 "No changes for code action. Skipping {}",
1574 describe_code_action(&action),
1575 );
1576 continue;
1577 }
1578 for operation in operations {
1579 let op = match operation {
1580 lsp::DocumentChangeOperation::Edit(op) => op,
1581 lsp::DocumentChangeOperation::Op(_) => {
1582 zlog::warn!(
1583 logger =>
1584 "Code actions which create, delete, or rename files are not supported on format. Skipping {}",
1585 describe_code_action(&action),
1586 );
1587 continue 'actions;
1588 }
1589 };
1590 let Ok(file_path) = op.text_document.uri.to_file_path() else {
1591 zlog::warn!(
1592 logger =>
1593 "Failed to convert URI '{:?}' to file path. Skipping {}",
1594 &op.text_document.uri,
1595 describe_code_action(&action),
1596 );
1597 continue 'actions;
1598 };
1599 if &file_path != buffer_path_abs {
1600 zlog::warn!(
1601 logger =>
1602 "File path '{:?}' does not match buffer path '{:?}'. Skipping {}",
1603 file_path,
1604 buffer_path_abs,
1605 describe_code_action(&action),
1606 );
1607 continue 'actions;
1608 }
1609
1610 let mut lsp_edits = Vec::new();
1611 for edit in op.edits {
1612 match edit {
1613 Edit::Plain(edit) => {
1614 if !lsp_edits.contains(&edit) {
1615 lsp_edits.push(edit);
1616 }
1617 }
1618 Edit::Annotated(edit) => {
1619 if !lsp_edits.contains(&edit.text_edit) {
1620 lsp_edits.push(edit.text_edit);
1621 }
1622 }
1623 Edit::Snippet(_) => {
1624 zlog::warn!(
1625 logger =>
1626 "Code actions which produce snippet edits are not supported during formatting. Skipping {}",
1627 describe_code_action(&action),
1628 );
1629 continue 'actions;
1630 }
1631 }
1632 }
1633 let edits_result = lsp_store
1634 .update(cx, |lsp_store, cx| {
1635 lsp_store.as_local_mut().unwrap().edits_from_lsp(
1636 &buffer.handle,
1637 lsp_edits,
1638 server.server_id(),
1639 op.text_document.version,
1640 cx,
1641 )
1642 })?
1643 .await;
1644 let Ok(resolved_edits) = edits_result else {
1645 zlog::warn!(
1646 logger =>
1647 "Failed to resolve edits from LSP for buffer {:?} while handling {}",
1648 buffer_path_abs.as_path(),
1649 describe_code_action(&action),
1650 );
1651 continue 'actions;
1652 };
1653 edits.extend(resolved_edits);
1654 }
1655
1656 if edits.is_empty() {
1657 zlog::warn!(logger => "No edits resolved from LSP");
1658 continue;
1659 }
1660
1661 extend_formatting_transaction(
1662 buffer,
1663 formatting_transaction_id,
1664 cx,
1665 |buffer, cx| {
1666 buffer.edit(edits, None, cx);
1667 },
1668 )?;
1669 }
1670
1671 if let Some(command) = action.lsp_action.command() {
1672 zlog::warn!(
1673 logger =>
1674 "Executing code action command '{}'. This may cause formatting to abort unnecessarily as well as splitting formatting into two entries in the undo history",
1675 &command.command,
1676 );
1677
1678 // bail early if command is invalid
1679 let server_capabilities = server.capabilities();
1680 let available_commands = server_capabilities
1681 .execute_command_provider
1682 .as_ref()
1683 .map(|options| options.commands.as_slice())
1684 .unwrap_or_default();
1685 if !available_commands.contains(&command.command) {
1686 zlog::warn!(
1687 logger =>
1688 "Cannot execute a command {} not listed in the language server capabilities of server {}",
1689 command.command,
1690 server.name(),
1691 );
1692 continue;
1693 }
1694
1695 // noop so we just ensure buffer hasn't been edited since resolving code actions
1696 extend_formatting_transaction(
1697 buffer,
1698 formatting_transaction_id,
1699 cx,
1700 |_, _| {},
1701 )?;
1702 zlog::info!(logger => "Executing command {}", &command.command);
1703
1704 lsp_store.update(cx, |this, _| {
1705 this.as_local_mut()
1706 .unwrap()
1707 .last_workspace_edits_by_language_server
1708 .remove(&server.server_id());
1709 })?;
1710
1711 let execute_command_result = server
1712 .request::<lsp::request::ExecuteCommand>(
1713 lsp::ExecuteCommandParams {
1714 command: command.command.clone(),
1715 arguments: command.arguments.clone().unwrap_or_default(),
1716 ..Default::default()
1717 },
1718 )
1719 .await
1720 .into_response();
1721
1722 if execute_command_result.is_err() {
1723 zlog::error!(
1724 logger =>
1725 "Failed to execute command '{}' as part of {}",
1726 &command.command,
1727 describe_code_action(&action),
1728 );
1729 continue 'actions;
1730 }
1731
1732 let mut project_transaction_command =
1733 lsp_store.update(cx, |this, _| {
1734 this.as_local_mut()
1735 .unwrap()
1736 .last_workspace_edits_by_language_server
1737 .remove(&server.server_id())
1738 .unwrap_or_default()
1739 })?;
1740
1741 if let Some(transaction) =
1742 project_transaction_command.0.remove(&buffer.handle)
1743 {
1744 zlog::trace!(
1745 logger =>
1746 "Successfully captured {} edits that resulted from command {}",
1747 transaction.edit_ids.len(),
1748 &command.command,
1749 );
1750 let transaction_id_project_transaction = transaction.id;
1751 buffer.handle.update(cx, |buffer, _| {
1752 // it may have been removed from history if push_to_history was
1753 // false in deserialize_workspace_edit. If so push it so we
1754 // can merge it with the format transaction
1755 // and pop the combined transaction off the history stack
1756 // later if push_to_history is false
1757 if buffer.get_transaction(transaction.id).is_none() {
1758 buffer.push_transaction(transaction, Instant::now());
1759 }
1760 buffer.merge_transactions(
1761 transaction_id_project_transaction,
1762 formatting_transaction_id,
1763 );
1764 })?;
1765 }
1766
1767 if !project_transaction_command.0.is_empty() {
1768 let extra_buffers = project_transaction_command
1769 .0
1770 .keys()
1771 .filter_map(|buffer_handle| {
1772 buffer_handle
1773 .read_with(cx, |b, cx| b.project_path(cx))
1774 .ok()
1775 .flatten()
1776 })
1777 .map(|p| p.path.to_sanitized_string())
1778 .join(", ");
1779 zlog::warn!(
1780 logger =>
1781 "Unexpected edits to buffers other than the buffer actively being formatted due to command {}. Impacted buffers: [{}].",
1782 &command.command,
1783 extra_buffers,
1784 );
1785 // NOTE: if this case is hit, the proper thing to do is to for each buffer, merge the extra transaction
1786 // into the existing transaction in project_transaction if there is one, and if there isn't one in project_transaction,
1787 // add it so it's included, and merge it into the format transaction when its created later
1788 }
1789 }
1790 }
1791 }
1792 }
1793 }
1794
1795 Ok(())
1796 }
1797
1798 pub async fn format_ranges_via_lsp(
1799 this: &WeakEntity<LspStore>,
1800 buffer_handle: &Entity<Buffer>,
1801 ranges: &[Range<Anchor>],
1802 abs_path: &Path,
1803 language_server: &Arc<LanguageServer>,
1804 settings: &LanguageSettings,
1805 cx: &mut AsyncApp,
1806 ) -> Result<Vec<(Range<Anchor>, Arc<str>)>> {
1807 let capabilities = &language_server.capabilities();
1808 let range_formatting_provider = capabilities.document_range_formatting_provider.as_ref();
1809 if range_formatting_provider.map_or(false, |provider| provider == &OneOf::Left(false)) {
1810 anyhow::bail!(
1811 "{} language server does not support range formatting",
1812 language_server.name()
1813 );
1814 }
1815
1816 let uri = file_path_to_lsp_url(abs_path)?;
1817 let text_document = lsp::TextDocumentIdentifier::new(uri);
1818
1819 let lsp_edits = {
1820 let mut lsp_ranges = Vec::new();
1821 this.update(cx, |_this, cx| {
1822 // TODO(#22930): In the case of formatting multibuffer selections, this buffer may
1823 // not have been sent to the language server. This seems like a fairly systemic
1824 // issue, though, the resolution probably is not specific to formatting.
1825 //
1826 // TODO: Instead of using current snapshot, should use the latest snapshot sent to
1827 // LSP.
1828 let snapshot = buffer_handle.read(cx).snapshot();
1829 for range in ranges {
1830 lsp_ranges.push(range_to_lsp(range.to_point_utf16(&snapshot))?);
1831 }
1832 anyhow::Ok(())
1833 })??;
1834
1835 let mut edits = None;
1836 for range in lsp_ranges {
1837 if let Some(mut edit) = language_server
1838 .request::<lsp::request::RangeFormatting>(lsp::DocumentRangeFormattingParams {
1839 text_document: text_document.clone(),
1840 range,
1841 options: lsp_command::lsp_formatting_options(settings),
1842 work_done_progress_params: Default::default(),
1843 })
1844 .await
1845 .into_response()?
1846 {
1847 edits.get_or_insert_with(Vec::new).append(&mut edit);
1848 }
1849 }
1850 edits
1851 };
1852
1853 if let Some(lsp_edits) = lsp_edits {
1854 this.update(cx, |this, cx| {
1855 this.as_local_mut().unwrap().edits_from_lsp(
1856 &buffer_handle,
1857 lsp_edits,
1858 language_server.server_id(),
1859 None,
1860 cx,
1861 )
1862 })?
1863 .await
1864 } else {
1865 Ok(Vec::with_capacity(0))
1866 }
1867 }
1868
1869 async fn format_via_lsp(
1870 this: &WeakEntity<LspStore>,
1871 buffer: &Entity<Buffer>,
1872 abs_path: &Path,
1873 language_server: &Arc<LanguageServer>,
1874 settings: &LanguageSettings,
1875 cx: &mut AsyncApp,
1876 ) -> Result<Vec<(Range<Anchor>, Arc<str>)>> {
1877 let logger = zlog::scoped!("lsp_format");
1878 zlog::info!(logger => "Formatting via LSP");
1879
1880 let uri = file_path_to_lsp_url(abs_path)?;
1881 let text_document = lsp::TextDocumentIdentifier::new(uri);
1882 let capabilities = &language_server.capabilities();
1883
1884 let formatting_provider = capabilities.document_formatting_provider.as_ref();
1885 let range_formatting_provider = capabilities.document_range_formatting_provider.as_ref();
1886
1887 let lsp_edits = if matches!(formatting_provider, Some(p) if *p != OneOf::Left(false)) {
1888 let _timer = zlog::time!(logger => "format-full");
1889 language_server
1890 .request::<lsp::request::Formatting>(lsp::DocumentFormattingParams {
1891 text_document,
1892 options: lsp_command::lsp_formatting_options(settings),
1893 work_done_progress_params: Default::default(),
1894 })
1895 .await
1896 .into_response()?
1897 } else if matches!(range_formatting_provider, Some(p) if *p != OneOf::Left(false)) {
1898 let _timer = zlog::time!(logger => "format-range");
1899 let buffer_start = lsp::Position::new(0, 0);
1900 let buffer_end = buffer.read_with(cx, |b, _| point_to_lsp(b.max_point_utf16()))?;
1901 language_server
1902 .request::<lsp::request::RangeFormatting>(lsp::DocumentRangeFormattingParams {
1903 text_document: text_document.clone(),
1904 range: lsp::Range::new(buffer_start, buffer_end),
1905 options: lsp_command::lsp_formatting_options(settings),
1906 work_done_progress_params: Default::default(),
1907 })
1908 .await
1909 .into_response()?
1910 } else {
1911 None
1912 };
1913
1914 if let Some(lsp_edits) = lsp_edits {
1915 this.update(cx, |this, cx| {
1916 this.as_local_mut().unwrap().edits_from_lsp(
1917 buffer,
1918 lsp_edits,
1919 language_server.server_id(),
1920 None,
1921 cx,
1922 )
1923 })?
1924 .await
1925 } else {
1926 Ok(Vec::with_capacity(0))
1927 }
1928 }
1929
1930 async fn format_via_external_command(
1931 buffer: &FormattableBuffer,
1932 command: &str,
1933 arguments: Option<&[String]>,
1934 cx: &mut AsyncApp,
1935 ) -> Result<Option<Diff>> {
1936 let working_dir_path = buffer.handle.update(cx, |buffer, cx| {
1937 let file = File::from_dyn(buffer.file())?;
1938 let worktree = file.worktree.read(cx);
1939 let mut worktree_path = worktree.abs_path().to_path_buf();
1940 if worktree.root_entry()?.is_file() {
1941 worktree_path.pop();
1942 }
1943 Some(worktree_path)
1944 })?;
1945
1946 let mut child = util::command::new_smol_command(command);
1947
1948 if let Some(buffer_env) = buffer.env.as_ref() {
1949 child.envs(buffer_env);
1950 }
1951
1952 if let Some(working_dir_path) = working_dir_path {
1953 child.current_dir(working_dir_path);
1954 }
1955
1956 if let Some(arguments) = arguments {
1957 child.args(arguments.iter().map(|arg| {
1958 if let Some(buffer_abs_path) = buffer.abs_path.as_ref() {
1959 arg.replace("{buffer_path}", &buffer_abs_path.to_string_lossy())
1960 } else {
1961 arg.replace("{buffer_path}", "Untitled")
1962 }
1963 }));
1964 }
1965
1966 let mut child = child
1967 .stdin(smol::process::Stdio::piped())
1968 .stdout(smol::process::Stdio::piped())
1969 .stderr(smol::process::Stdio::piped())
1970 .spawn()?;
1971
1972 let stdin = child.stdin.as_mut().context("failed to acquire stdin")?;
1973 let text = buffer
1974 .handle
1975 .read_with(cx, |buffer, _| buffer.as_rope().clone())?;
1976 for chunk in text.chunks() {
1977 stdin.write_all(chunk.as_bytes()).await?;
1978 }
1979 stdin.flush().await?;
1980
1981 let output = child.output().await?;
1982 anyhow::ensure!(
1983 output.status.success(),
1984 "command failed with exit code {:?}:\nstdout: {}\nstderr: {}",
1985 output.status.code(),
1986 String::from_utf8_lossy(&output.stdout),
1987 String::from_utf8_lossy(&output.stderr),
1988 );
1989
1990 let stdout = String::from_utf8(output.stdout)?;
1991 Ok(Some(
1992 buffer
1993 .handle
1994 .update(cx, |buffer, cx| buffer.diff(stdout, cx))?
1995 .await,
1996 ))
1997 }
1998
1999 async fn try_resolve_code_action(
2000 lang_server: &LanguageServer,
2001 action: &mut CodeAction,
2002 ) -> anyhow::Result<()> {
2003 match &mut action.lsp_action {
2004 LspAction::Action(lsp_action) => {
2005 if !action.resolved
2006 && GetCodeActions::can_resolve_actions(&lang_server.capabilities())
2007 && lsp_action.data.is_some()
2008 && (lsp_action.command.is_none() || lsp_action.edit.is_none())
2009 {
2010 *lsp_action = Box::new(
2011 lang_server
2012 .request::<lsp::request::CodeActionResolveRequest>(*lsp_action.clone())
2013 .await
2014 .into_response()?,
2015 );
2016 }
2017 }
2018 LspAction::CodeLens(lens) => {
2019 if !action.resolved && GetCodeLens::can_resolve_lens(&lang_server.capabilities()) {
2020 *lens = lang_server
2021 .request::<lsp::request::CodeLensResolve>(lens.clone())
2022 .await
2023 .into_response()?;
2024 }
2025 }
2026 LspAction::Command(_) => {}
2027 }
2028
2029 action.resolved = true;
2030 anyhow::Ok(())
2031 }
2032
2033 fn initialize_buffer(&mut self, buffer_handle: &Entity<Buffer>, cx: &mut Context<LspStore>) {
2034 let buffer = buffer_handle.read(cx);
2035
2036 let file = buffer.file().cloned();
2037 let Some(file) = File::from_dyn(file.as_ref()) else {
2038 return;
2039 };
2040 if !file.is_local() {
2041 return;
2042 }
2043
2044 let worktree_id = file.worktree_id(cx);
2045 let language = buffer.language().cloned();
2046
2047 if let Some(diagnostics) = self.diagnostics.get(&worktree_id) {
2048 for (server_id, diagnostics) in
2049 diagnostics.get(file.path()).cloned().unwrap_or_default()
2050 {
2051 self.update_buffer_diagnostics(
2052 buffer_handle,
2053 server_id,
2054 None,
2055 None,
2056 diagnostics,
2057 Vec::new(),
2058 cx,
2059 )
2060 .log_err();
2061 }
2062 }
2063 let Some(language) = language else {
2064 return;
2065 };
2066 for adapter in self.languages.lsp_adapters(&language.name()) {
2067 let servers = self
2068 .language_server_ids
2069 .get(&(worktree_id, adapter.name.clone()));
2070 if let Some(server_ids) = servers {
2071 for server_id in server_ids {
2072 let server = self
2073 .language_servers
2074 .get(server_id)
2075 .and_then(|server_state| {
2076 if let LanguageServerState::Running { server, .. } = server_state {
2077 Some(server.clone())
2078 } else {
2079 None
2080 }
2081 });
2082 let server = match server {
2083 Some(server) => server,
2084 None => continue,
2085 };
2086
2087 buffer_handle.update(cx, |buffer, cx| {
2088 buffer.set_completion_triggers(
2089 server.server_id(),
2090 server
2091 .capabilities()
2092 .completion_provider
2093 .as_ref()
2094 .and_then(|provider| {
2095 provider
2096 .trigger_characters
2097 .as_ref()
2098 .map(|characters| characters.iter().cloned().collect())
2099 })
2100 .unwrap_or_default(),
2101 cx,
2102 );
2103 });
2104 }
2105 }
2106 }
2107 }
2108
2109 pub(crate) fn reset_buffer(&mut self, buffer: &Entity<Buffer>, old_file: &File, cx: &mut App) {
2110 buffer.update(cx, |buffer, cx| {
2111 let Some(language) = buffer.language() else {
2112 return;
2113 };
2114 let path = ProjectPath {
2115 worktree_id: old_file.worktree_id(cx),
2116 path: old_file.path.clone(),
2117 };
2118 for server_id in self.language_server_ids_for_project_path(path, language, cx) {
2119 buffer.update_diagnostics(server_id, DiagnosticSet::new([], buffer), cx);
2120 buffer.set_completion_triggers(server_id, Default::default(), cx);
2121 }
2122 });
2123 }
2124
2125 fn update_buffer_diagnostics(
2126 &mut self,
2127 buffer: &Entity<Buffer>,
2128 server_id: LanguageServerId,
2129 result_id: Option<String>,
2130 version: Option<i32>,
2131 new_diagnostics: Vec<DiagnosticEntry<Unclipped<PointUtf16>>>,
2132 reused_diagnostics: Vec<DiagnosticEntry<Unclipped<PointUtf16>>>,
2133 cx: &mut Context<LspStore>,
2134 ) -> Result<()> {
2135 fn compare_diagnostics(a: &Diagnostic, b: &Diagnostic) -> Ordering {
2136 Ordering::Equal
2137 .then_with(|| b.is_primary.cmp(&a.is_primary))
2138 .then_with(|| a.is_disk_based.cmp(&b.is_disk_based))
2139 .then_with(|| a.severity.cmp(&b.severity))
2140 .then_with(|| a.message.cmp(&b.message))
2141 }
2142
2143 let mut diagnostics = Vec::with_capacity(new_diagnostics.len() + reused_diagnostics.len());
2144 diagnostics.extend(new_diagnostics.into_iter().map(|d| (true, d)));
2145 diagnostics.extend(reused_diagnostics.into_iter().map(|d| (false, d)));
2146
2147 diagnostics.sort_unstable_by(|(_, a), (_, b)| {
2148 Ordering::Equal
2149 .then_with(|| a.range.start.cmp(&b.range.start))
2150 .then_with(|| b.range.end.cmp(&a.range.end))
2151 .then_with(|| compare_diagnostics(&a.diagnostic, &b.diagnostic))
2152 });
2153
2154 let snapshot = self.buffer_snapshot_for_lsp_version(buffer, server_id, version, cx)?;
2155
2156 let edits_since_save = std::cell::LazyCell::new(|| {
2157 let saved_version = buffer.read(cx).saved_version();
2158 Patch::new(snapshot.edits_since::<PointUtf16>(saved_version).collect())
2159 });
2160
2161 let mut sanitized_diagnostics = Vec::with_capacity(diagnostics.len());
2162
2163 for (new_diagnostic, entry) in diagnostics {
2164 let start;
2165 let end;
2166 if new_diagnostic && entry.diagnostic.is_disk_based {
2167 // Some diagnostics are based on files on disk instead of buffers'
2168 // current contents. Adjust these diagnostics' ranges to reflect
2169 // any unsaved edits.
2170 // Do not alter the reused ones though, as their coordinates were stored as anchors
2171 // and were properly adjusted on reuse.
2172 start = Unclipped((*edits_since_save).old_to_new(entry.range.start.0));
2173 end = Unclipped((*edits_since_save).old_to_new(entry.range.end.0));
2174 } else {
2175 start = entry.range.start;
2176 end = entry.range.end;
2177 }
2178
2179 let mut range = snapshot.clip_point_utf16(start, Bias::Left)
2180 ..snapshot.clip_point_utf16(end, Bias::Right);
2181
2182 // Expand empty ranges by one codepoint
2183 if range.start == range.end {
2184 // This will be go to the next boundary when being clipped
2185 range.end.column += 1;
2186 range.end = snapshot.clip_point_utf16(Unclipped(range.end), Bias::Right);
2187 if range.start == range.end && range.end.column > 0 {
2188 range.start.column -= 1;
2189 range.start = snapshot.clip_point_utf16(Unclipped(range.start), Bias::Left);
2190 }
2191 }
2192
2193 sanitized_diagnostics.push(DiagnosticEntry {
2194 range,
2195 diagnostic: entry.diagnostic,
2196 });
2197 }
2198 drop(edits_since_save);
2199
2200 let set = DiagnosticSet::new(sanitized_diagnostics, &snapshot);
2201 buffer.update(cx, |buffer, cx| {
2202 if let Some(abs_path) = File::from_dyn(buffer.file()).map(|f| f.abs_path(cx)) {
2203 self.buffer_pull_diagnostics_result_ids
2204 .entry(server_id)
2205 .or_default()
2206 .insert(abs_path, result_id);
2207 }
2208
2209 buffer.update_diagnostics(server_id, set, cx)
2210 });
2211
2212 Ok(())
2213 }
2214
2215 fn register_buffer_with_language_servers(
2216 &mut self,
2217 buffer_handle: &Entity<Buffer>,
2218 only_register_servers: HashSet<LanguageServerSelector>,
2219 cx: &mut Context<LspStore>,
2220 ) {
2221 let buffer = buffer_handle.read(cx);
2222 let buffer_id = buffer.remote_id();
2223
2224 let Some(file) = File::from_dyn(buffer.file()) else {
2225 return;
2226 };
2227 if !file.is_local() {
2228 return;
2229 }
2230
2231 let abs_path = file.abs_path(cx);
2232 let Some(uri) = file_path_to_lsp_url(&abs_path).log_err() else {
2233 return;
2234 };
2235 let initial_snapshot = buffer.text_snapshot();
2236 let worktree_id = file.worktree_id(cx);
2237
2238 let Some(language) = buffer.language().cloned() else {
2239 return;
2240 };
2241 let path: Arc<Path> = file
2242 .path()
2243 .parent()
2244 .map(Arc::from)
2245 .unwrap_or_else(|| file.path().clone());
2246 let Some(worktree) = self
2247 .worktree_store
2248 .read(cx)
2249 .worktree_for_id(worktree_id, cx)
2250 else {
2251 return;
2252 };
2253 let language_name = language.name();
2254 let (reused, delegate, servers) = self
2255 .lsp_tree
2256 .update(cx, |lsp_tree, cx| {
2257 self.reuse_existing_language_server(lsp_tree, &worktree, &language_name, cx)
2258 })
2259 .map(|(delegate, servers)| (true, delegate, servers))
2260 .unwrap_or_else(|| {
2261 let lsp_delegate = LocalLspAdapterDelegate::from_local_lsp(self, &worktree, cx);
2262 let delegate = Arc::new(ManifestQueryDelegate::new(worktree.read(cx).snapshot()));
2263 let servers = self
2264 .lsp_tree
2265 .clone()
2266 .update(cx, |language_server_tree, cx| {
2267 language_server_tree
2268 .get(
2269 ProjectPath { worktree_id, path },
2270 AdapterQuery::Language(&language.name()),
2271 delegate.clone(),
2272 cx,
2273 )
2274 .collect::<Vec<_>>()
2275 });
2276 (false, lsp_delegate, servers)
2277 });
2278 let servers_and_adapters = servers
2279 .into_iter()
2280 .filter_map(|server_node| {
2281 if reused && server_node.server_id().is_none() {
2282 return None;
2283 }
2284 if !only_register_servers.is_empty() {
2285 if let Some(server_id) = server_node.server_id() {
2286 if !only_register_servers.contains(&LanguageServerSelector::Id(server_id)) {
2287 return None;
2288 }
2289 }
2290 if let Some(name) = server_node.name() {
2291 if !only_register_servers.contains(&LanguageServerSelector::Name(name)) {
2292 return None;
2293 }
2294 }
2295 }
2296
2297 let server_id = server_node.server_id_or_init(
2298 |LaunchDisposition {
2299 server_name,
2300 path,
2301 settings,
2302 }| {
2303 let server_id =
2304 {
2305 let uri = Url::from_file_path(
2306 worktree.read(cx).abs_path().join(&path.path),
2307 );
2308 let key = (worktree_id, server_name.clone());
2309 if !self.language_server_ids.contains_key(&key) {
2310 let language_name = language.name();
2311 let adapter = self.languages
2312 .lsp_adapters(&language_name)
2313 .into_iter()
2314 .find(|adapter| &adapter.name() == server_name)
2315 .expect("To find LSP adapter");
2316 self.start_language_server(
2317 &worktree,
2318 delegate.clone(),
2319 adapter,
2320 settings,
2321 cx,
2322 );
2323 }
2324 if let Some(server_ids) = self
2325 .language_server_ids
2326 .get(&key)
2327 {
2328 debug_assert_eq!(server_ids.len(), 1);
2329 let server_id = server_ids.iter().cloned().next().unwrap();
2330 if let Some(state) = self.language_servers.get(&server_id) {
2331 if let Ok(uri) = uri {
2332 state.add_workspace_folder(uri);
2333 };
2334 }
2335 server_id
2336 } else {
2337 unreachable!("Language server ID should be available, as it's registered on demand")
2338 }
2339
2340 };
2341 server_id
2342 },
2343 )?;
2344 let server_state = self.language_servers.get(&server_id)?;
2345 if let LanguageServerState::Running { server, adapter, .. } = server_state {
2346 Some((server.clone(), adapter.clone()))
2347 } else {
2348 None
2349 }
2350 })
2351 .collect::<Vec<_>>();
2352 for (server, adapter) in servers_and_adapters {
2353 buffer_handle.update(cx, |buffer, cx| {
2354 buffer.set_completion_triggers(
2355 server.server_id(),
2356 server
2357 .capabilities()
2358 .completion_provider
2359 .as_ref()
2360 .and_then(|provider| {
2361 provider
2362 .trigger_characters
2363 .as_ref()
2364 .map(|characters| characters.iter().cloned().collect())
2365 })
2366 .unwrap_or_default(),
2367 cx,
2368 );
2369 });
2370
2371 let snapshot = LspBufferSnapshot {
2372 version: 0,
2373 snapshot: initial_snapshot.clone(),
2374 };
2375
2376 let mut registered = false;
2377 self.buffer_snapshots
2378 .entry(buffer_id)
2379 .or_default()
2380 .entry(server.server_id())
2381 .or_insert_with(|| {
2382 registered = true;
2383 server.register_buffer(
2384 uri.clone(),
2385 adapter.language_id(&language.name()),
2386 0,
2387 initial_snapshot.text(),
2388 );
2389
2390 vec![snapshot]
2391 });
2392
2393 self.buffers_opened_in_servers
2394 .entry(buffer_id)
2395 .or_default()
2396 .insert(server.server_id());
2397 if registered {
2398 cx.emit(LspStoreEvent::LanguageServerUpdate {
2399 language_server_id: server.server_id(),
2400 name: None,
2401 message: proto::update_language_server::Variant::RegisteredForBuffer(
2402 proto::RegisteredForBuffer {
2403 buffer_abs_path: abs_path.to_string_lossy().to_string(),
2404 buffer_id: buffer_id.to_proto(),
2405 },
2406 ),
2407 });
2408 }
2409 }
2410 }
2411
2412 fn reuse_existing_language_server(
2413 &self,
2414 server_tree: &mut LanguageServerTree,
2415 worktree: &Entity<Worktree>,
2416 language_name: &LanguageName,
2417 cx: &mut App,
2418 ) -> Option<(Arc<LocalLspAdapterDelegate>, Vec<LanguageServerTreeNode>)> {
2419 if worktree.read(cx).is_visible() {
2420 return None;
2421 }
2422
2423 let worktree_store = self.worktree_store.read(cx);
2424 let servers = server_tree
2425 .instances
2426 .iter()
2427 .filter(|(worktree_id, _)| {
2428 worktree_store
2429 .worktree_for_id(**worktree_id, cx)
2430 .is_some_and(|worktree| worktree.read(cx).is_visible())
2431 })
2432 .flat_map(|(worktree_id, servers)| {
2433 servers
2434 .roots
2435 .iter()
2436 .flat_map(|(_, language_servers)| language_servers)
2437 .map(move |(_, (server_node, server_languages))| {
2438 (worktree_id, server_node, server_languages)
2439 })
2440 .filter(|(_, _, server_languages)| server_languages.contains(language_name))
2441 .map(|(worktree_id, server_node, _)| {
2442 (
2443 *worktree_id,
2444 LanguageServerTreeNode::from(Arc::downgrade(server_node)),
2445 )
2446 })
2447 })
2448 .fold(HashMap::default(), |mut acc, (worktree_id, server_node)| {
2449 acc.entry(worktree_id)
2450 .or_insert_with(Vec::new)
2451 .push(server_node);
2452 acc
2453 })
2454 .into_values()
2455 .max_by_key(|servers| servers.len())?;
2456
2457 for server_node in &servers {
2458 server_tree.register_reused(
2459 worktree.read(cx).id(),
2460 language_name.clone(),
2461 server_node.clone(),
2462 );
2463 }
2464
2465 let delegate = LocalLspAdapterDelegate::from_local_lsp(self, worktree, cx);
2466 Some((delegate, servers))
2467 }
2468
2469 pub(crate) fn unregister_old_buffer_from_language_servers(
2470 &mut self,
2471 buffer: &Entity<Buffer>,
2472 old_file: &File,
2473 cx: &mut App,
2474 ) {
2475 let old_path = match old_file.as_local() {
2476 Some(local) => local.abs_path(cx),
2477 None => return,
2478 };
2479
2480 let Ok(file_url) = lsp::Url::from_file_path(old_path.as_path()) else {
2481 debug_panic!(
2482 "`{}` is not parseable as an URI",
2483 old_path.to_string_lossy()
2484 );
2485 return;
2486 };
2487 self.unregister_buffer_from_language_servers(buffer, &file_url, cx);
2488 }
2489
2490 pub(crate) fn unregister_buffer_from_language_servers(
2491 &mut self,
2492 buffer: &Entity<Buffer>,
2493 file_url: &lsp::Url,
2494 cx: &mut App,
2495 ) {
2496 buffer.update(cx, |buffer, cx| {
2497 let _ = self.buffer_snapshots.remove(&buffer.remote_id());
2498
2499 for (_, language_server) in self.language_servers_for_buffer(buffer, cx) {
2500 language_server.unregister_buffer(file_url.clone());
2501 }
2502 });
2503 }
2504
2505 fn buffer_snapshot_for_lsp_version(
2506 &mut self,
2507 buffer: &Entity<Buffer>,
2508 server_id: LanguageServerId,
2509 version: Option<i32>,
2510 cx: &App,
2511 ) -> Result<TextBufferSnapshot> {
2512 const OLD_VERSIONS_TO_RETAIN: i32 = 10;
2513
2514 if let Some(version) = version {
2515 let buffer_id = buffer.read(cx).remote_id();
2516 let snapshots = if let Some(snapshots) = self
2517 .buffer_snapshots
2518 .get_mut(&buffer_id)
2519 .and_then(|m| m.get_mut(&server_id))
2520 {
2521 snapshots
2522 } else if version == 0 {
2523 // Some language servers report version 0 even if the buffer hasn't been opened yet.
2524 // We detect this case and treat it as if the version was `None`.
2525 return Ok(buffer.read(cx).text_snapshot());
2526 } else {
2527 anyhow::bail!("no snapshots found for buffer {buffer_id} and server {server_id}");
2528 };
2529
2530 let found_snapshot = snapshots
2531 .binary_search_by_key(&version, |e| e.version)
2532 .map(|ix| snapshots[ix].snapshot.clone())
2533 .map_err(|_| {
2534 anyhow!("snapshot not found for buffer {buffer_id} server {server_id} at version {version}")
2535 })?;
2536
2537 snapshots.retain(|snapshot| snapshot.version + OLD_VERSIONS_TO_RETAIN >= version);
2538 Ok(found_snapshot)
2539 } else {
2540 Ok((buffer.read(cx)).text_snapshot())
2541 }
2542 }
2543
2544 async fn get_server_code_actions_from_action_kinds(
2545 lsp_store: &WeakEntity<LspStore>,
2546 language_server_id: LanguageServerId,
2547 code_action_kinds: Vec<lsp::CodeActionKind>,
2548 buffer: &Entity<Buffer>,
2549 cx: &mut AsyncApp,
2550 ) -> Result<Vec<CodeAction>> {
2551 let actions = lsp_store
2552 .update(cx, move |this, cx| {
2553 let request = GetCodeActions {
2554 range: text::Anchor::MIN..text::Anchor::MAX,
2555 kinds: Some(code_action_kinds),
2556 };
2557 let server = LanguageServerToQuery::Other(language_server_id);
2558 this.request_lsp(buffer.clone(), server, request, cx)
2559 })?
2560 .await?;
2561 return Ok(actions);
2562 }
2563
2564 pub async fn execute_code_actions_on_server(
2565 lsp_store: &WeakEntity<LspStore>,
2566 language_server: &Arc<LanguageServer>,
2567 lsp_adapter: &Arc<CachedLspAdapter>,
2568 actions: Vec<CodeAction>,
2569 push_to_history: bool,
2570 project_transaction: &mut ProjectTransaction,
2571 cx: &mut AsyncApp,
2572 ) -> anyhow::Result<()> {
2573 for mut action in actions {
2574 Self::try_resolve_code_action(language_server, &mut action)
2575 .await
2576 .context("resolving a formatting code action")?;
2577
2578 if let Some(edit) = action.lsp_action.edit() {
2579 if edit.changes.is_none() && edit.document_changes.is_none() {
2580 continue;
2581 }
2582
2583 let new = Self::deserialize_workspace_edit(
2584 lsp_store.upgrade().context("project dropped")?,
2585 edit.clone(),
2586 push_to_history,
2587 lsp_adapter.clone(),
2588 language_server.clone(),
2589 cx,
2590 )
2591 .await?;
2592 project_transaction.0.extend(new.0);
2593 }
2594
2595 if let Some(command) = action.lsp_action.command() {
2596 let server_capabilities = language_server.capabilities();
2597 let available_commands = server_capabilities
2598 .execute_command_provider
2599 .as_ref()
2600 .map(|options| options.commands.as_slice())
2601 .unwrap_or_default();
2602 if available_commands.contains(&command.command) {
2603 lsp_store.update(cx, |lsp_store, _| {
2604 if let LspStoreMode::Local(mode) = &mut lsp_store.mode {
2605 mode.last_workspace_edits_by_language_server
2606 .remove(&language_server.server_id());
2607 }
2608 })?;
2609
2610 language_server
2611 .request::<lsp::request::ExecuteCommand>(lsp::ExecuteCommandParams {
2612 command: command.command.clone(),
2613 arguments: command.arguments.clone().unwrap_or_default(),
2614 ..Default::default()
2615 })
2616 .await
2617 .into_response()
2618 .context("execute command")?;
2619
2620 lsp_store.update(cx, |this, _| {
2621 if let LspStoreMode::Local(mode) = &mut this.mode {
2622 project_transaction.0.extend(
2623 mode.last_workspace_edits_by_language_server
2624 .remove(&language_server.server_id())
2625 .unwrap_or_default()
2626 .0,
2627 )
2628 }
2629 })?;
2630 } else {
2631 log::warn!(
2632 "Cannot execute a command {} not listed in the language server capabilities",
2633 command.command
2634 )
2635 }
2636 }
2637 }
2638 return Ok(());
2639 }
2640
2641 pub async fn deserialize_text_edits(
2642 this: Entity<LspStore>,
2643 buffer_to_edit: Entity<Buffer>,
2644 edits: Vec<lsp::TextEdit>,
2645 push_to_history: bool,
2646 _: Arc<CachedLspAdapter>,
2647 language_server: Arc<LanguageServer>,
2648 cx: &mut AsyncApp,
2649 ) -> Result<Option<Transaction>> {
2650 let edits = this
2651 .update(cx, |this, cx| {
2652 this.as_local_mut().unwrap().edits_from_lsp(
2653 &buffer_to_edit,
2654 edits,
2655 language_server.server_id(),
2656 None,
2657 cx,
2658 )
2659 })?
2660 .await?;
2661
2662 let transaction = buffer_to_edit.update(cx, |buffer, cx| {
2663 buffer.finalize_last_transaction();
2664 buffer.start_transaction();
2665 for (range, text) in edits {
2666 buffer.edit([(range, text)], None, cx);
2667 }
2668
2669 if buffer.end_transaction(cx).is_some() {
2670 let transaction = buffer.finalize_last_transaction().unwrap().clone();
2671 if !push_to_history {
2672 buffer.forget_transaction(transaction.id);
2673 }
2674 Some(transaction)
2675 } else {
2676 None
2677 }
2678 })?;
2679
2680 Ok(transaction)
2681 }
2682
2683 #[allow(clippy::type_complexity)]
2684 pub(crate) fn edits_from_lsp(
2685 &mut self,
2686 buffer: &Entity<Buffer>,
2687 lsp_edits: impl 'static + Send + IntoIterator<Item = lsp::TextEdit>,
2688 server_id: LanguageServerId,
2689 version: Option<i32>,
2690 cx: &mut Context<LspStore>,
2691 ) -> Task<Result<Vec<(Range<Anchor>, Arc<str>)>>> {
2692 let snapshot = self.buffer_snapshot_for_lsp_version(buffer, server_id, version, cx);
2693 cx.background_spawn(async move {
2694 let snapshot = snapshot?;
2695 let mut lsp_edits = lsp_edits
2696 .into_iter()
2697 .map(|edit| (range_from_lsp(edit.range), edit.new_text))
2698 .collect::<Vec<_>>();
2699
2700 lsp_edits.sort_by_key(|(range, _)| (range.start, range.end));
2701
2702 let mut lsp_edits = lsp_edits.into_iter().peekable();
2703 let mut edits = Vec::new();
2704 while let Some((range, mut new_text)) = lsp_edits.next() {
2705 // Clip invalid ranges provided by the language server.
2706 let mut range = snapshot.clip_point_utf16(range.start, Bias::Left)
2707 ..snapshot.clip_point_utf16(range.end, Bias::Left);
2708
2709 // Combine any LSP edits that are adjacent.
2710 //
2711 // Also, combine LSP edits that are separated from each other by only
2712 // a newline. This is important because for some code actions,
2713 // Rust-analyzer rewrites the entire buffer via a series of edits that
2714 // are separated by unchanged newline characters.
2715 //
2716 // In order for the diffing logic below to work properly, any edits that
2717 // cancel each other out must be combined into one.
2718 while let Some((next_range, next_text)) = lsp_edits.peek() {
2719 if next_range.start.0 > range.end {
2720 if next_range.start.0.row > range.end.row + 1
2721 || next_range.start.0.column > 0
2722 || snapshot.clip_point_utf16(
2723 Unclipped(PointUtf16::new(range.end.row, u32::MAX)),
2724 Bias::Left,
2725 ) > range.end
2726 {
2727 break;
2728 }
2729 new_text.push('\n');
2730 }
2731 range.end = snapshot.clip_point_utf16(next_range.end, Bias::Left);
2732 new_text.push_str(next_text);
2733 lsp_edits.next();
2734 }
2735
2736 // For multiline edits, perform a diff of the old and new text so that
2737 // we can identify the changes more precisely, preserving the locations
2738 // of any anchors positioned in the unchanged regions.
2739 if range.end.row > range.start.row {
2740 let offset = range.start.to_offset(&snapshot);
2741 let old_text = snapshot.text_for_range(range).collect::<String>();
2742 let range_edits = language::text_diff(old_text.as_str(), &new_text);
2743 edits.extend(range_edits.into_iter().map(|(range, replacement)| {
2744 (
2745 snapshot.anchor_after(offset + range.start)
2746 ..snapshot.anchor_before(offset + range.end),
2747 replacement,
2748 )
2749 }));
2750 } else if range.end == range.start {
2751 let anchor = snapshot.anchor_after(range.start);
2752 edits.push((anchor..anchor, new_text.into()));
2753 } else {
2754 let edit_start = snapshot.anchor_after(range.start);
2755 let edit_end = snapshot.anchor_before(range.end);
2756 edits.push((edit_start..edit_end, new_text.into()));
2757 }
2758 }
2759
2760 Ok(edits)
2761 })
2762 }
2763
2764 pub(crate) async fn deserialize_workspace_edit(
2765 this: Entity<LspStore>,
2766 edit: lsp::WorkspaceEdit,
2767 push_to_history: bool,
2768 lsp_adapter: Arc<CachedLspAdapter>,
2769 language_server: Arc<LanguageServer>,
2770 cx: &mut AsyncApp,
2771 ) -> Result<ProjectTransaction> {
2772 let fs = this.read_with(cx, |this, _| this.as_local().unwrap().fs.clone())?;
2773
2774 let mut operations = Vec::new();
2775 if let Some(document_changes) = edit.document_changes {
2776 match document_changes {
2777 lsp::DocumentChanges::Edits(edits) => {
2778 operations.extend(edits.into_iter().map(lsp::DocumentChangeOperation::Edit))
2779 }
2780 lsp::DocumentChanges::Operations(ops) => operations = ops,
2781 }
2782 } else if let Some(changes) = edit.changes {
2783 operations.extend(changes.into_iter().map(|(uri, edits)| {
2784 lsp::DocumentChangeOperation::Edit(lsp::TextDocumentEdit {
2785 text_document: lsp::OptionalVersionedTextDocumentIdentifier {
2786 uri,
2787 version: None,
2788 },
2789 edits: edits.into_iter().map(Edit::Plain).collect(),
2790 })
2791 }));
2792 }
2793
2794 let mut project_transaction = ProjectTransaction::default();
2795 for operation in operations {
2796 match operation {
2797 lsp::DocumentChangeOperation::Op(lsp::ResourceOp::Create(op)) => {
2798 let abs_path = op
2799 .uri
2800 .to_file_path()
2801 .map_err(|()| anyhow!("can't convert URI to path"))?;
2802
2803 if let Some(parent_path) = abs_path.parent() {
2804 fs.create_dir(parent_path).await?;
2805 }
2806 if abs_path.ends_with("/") {
2807 fs.create_dir(&abs_path).await?;
2808 } else {
2809 fs.create_file(
2810 &abs_path,
2811 op.options
2812 .map(|options| fs::CreateOptions {
2813 overwrite: options.overwrite.unwrap_or(false),
2814 ignore_if_exists: options.ignore_if_exists.unwrap_or(false),
2815 })
2816 .unwrap_or_default(),
2817 )
2818 .await?;
2819 }
2820 }
2821
2822 lsp::DocumentChangeOperation::Op(lsp::ResourceOp::Rename(op)) => {
2823 let source_abs_path = op
2824 .old_uri
2825 .to_file_path()
2826 .map_err(|()| anyhow!("can't convert URI to path"))?;
2827 let target_abs_path = op
2828 .new_uri
2829 .to_file_path()
2830 .map_err(|()| anyhow!("can't convert URI to path"))?;
2831 fs.rename(
2832 &source_abs_path,
2833 &target_abs_path,
2834 op.options
2835 .map(|options| fs::RenameOptions {
2836 overwrite: options.overwrite.unwrap_or(false),
2837 ignore_if_exists: options.ignore_if_exists.unwrap_or(false),
2838 })
2839 .unwrap_or_default(),
2840 )
2841 .await?;
2842 }
2843
2844 lsp::DocumentChangeOperation::Op(lsp::ResourceOp::Delete(op)) => {
2845 let abs_path = op
2846 .uri
2847 .to_file_path()
2848 .map_err(|()| anyhow!("can't convert URI to path"))?;
2849 let options = op
2850 .options
2851 .map(|options| fs::RemoveOptions {
2852 recursive: options.recursive.unwrap_or(false),
2853 ignore_if_not_exists: options.ignore_if_not_exists.unwrap_or(false),
2854 })
2855 .unwrap_or_default();
2856 if abs_path.ends_with("/") {
2857 fs.remove_dir(&abs_path, options).await?;
2858 } else {
2859 fs.remove_file(&abs_path, options).await?;
2860 }
2861 }
2862
2863 lsp::DocumentChangeOperation::Edit(op) => {
2864 let buffer_to_edit = this
2865 .update(cx, |this, cx| {
2866 this.open_local_buffer_via_lsp(
2867 op.text_document.uri.clone(),
2868 language_server.server_id(),
2869 lsp_adapter.name.clone(),
2870 cx,
2871 )
2872 })?
2873 .await?;
2874
2875 let edits = this
2876 .update(cx, |this, cx| {
2877 let path = buffer_to_edit.read(cx).project_path(cx);
2878 let active_entry = this.active_entry;
2879 let is_active_entry = path.clone().map_or(false, |project_path| {
2880 this.worktree_store
2881 .read(cx)
2882 .entry_for_path(&project_path, cx)
2883 .map_or(false, |entry| Some(entry.id) == active_entry)
2884 });
2885 let local = this.as_local_mut().unwrap();
2886
2887 let (mut edits, mut snippet_edits) = (vec![], vec![]);
2888 for edit in op.edits {
2889 match edit {
2890 Edit::Plain(edit) => {
2891 if !edits.contains(&edit) {
2892 edits.push(edit)
2893 }
2894 }
2895 Edit::Annotated(edit) => {
2896 if !edits.contains(&edit.text_edit) {
2897 edits.push(edit.text_edit)
2898 }
2899 }
2900 Edit::Snippet(edit) => {
2901 let Ok(snippet) = Snippet::parse(&edit.snippet.value)
2902 else {
2903 continue;
2904 };
2905
2906 if is_active_entry {
2907 snippet_edits.push((edit.range, snippet));
2908 } else {
2909 // Since this buffer is not focused, apply a normal edit.
2910 let new_edit = TextEdit {
2911 range: edit.range,
2912 new_text: snippet.text,
2913 };
2914 if !edits.contains(&new_edit) {
2915 edits.push(new_edit);
2916 }
2917 }
2918 }
2919 }
2920 }
2921 if !snippet_edits.is_empty() {
2922 let buffer_id = buffer_to_edit.read(cx).remote_id();
2923 let version = if let Some(buffer_version) = op.text_document.version
2924 {
2925 local
2926 .buffer_snapshot_for_lsp_version(
2927 &buffer_to_edit,
2928 language_server.server_id(),
2929 Some(buffer_version),
2930 cx,
2931 )
2932 .ok()
2933 .map(|snapshot| snapshot.version)
2934 } else {
2935 Some(buffer_to_edit.read(cx).saved_version().clone())
2936 };
2937
2938 let most_recent_edit = version.and_then(|version| {
2939 version.iter().max_by_key(|timestamp| timestamp.value)
2940 });
2941 // Check if the edit that triggered that edit has been made by this participant.
2942
2943 if let Some(most_recent_edit) = most_recent_edit {
2944 cx.emit(LspStoreEvent::SnippetEdit {
2945 buffer_id,
2946 edits: snippet_edits,
2947 most_recent_edit,
2948 });
2949 }
2950 }
2951
2952 local.edits_from_lsp(
2953 &buffer_to_edit,
2954 edits,
2955 language_server.server_id(),
2956 op.text_document.version,
2957 cx,
2958 )
2959 })?
2960 .await?;
2961
2962 let transaction = buffer_to_edit.update(cx, |buffer, cx| {
2963 buffer.finalize_last_transaction();
2964 buffer.start_transaction();
2965 for (range, text) in edits {
2966 buffer.edit([(range, text)], None, cx);
2967 }
2968
2969 let transaction = buffer.end_transaction(cx).and_then(|transaction_id| {
2970 if push_to_history {
2971 buffer.finalize_last_transaction();
2972 buffer.get_transaction(transaction_id).cloned()
2973 } else {
2974 buffer.forget_transaction(transaction_id)
2975 }
2976 });
2977
2978 transaction
2979 })?;
2980 if let Some(transaction) = transaction {
2981 project_transaction.0.insert(buffer_to_edit, transaction);
2982 }
2983 }
2984 }
2985 }
2986
2987 Ok(project_transaction)
2988 }
2989
2990 async fn on_lsp_workspace_edit(
2991 this: WeakEntity<LspStore>,
2992 params: lsp::ApplyWorkspaceEditParams,
2993 server_id: LanguageServerId,
2994 adapter: Arc<CachedLspAdapter>,
2995 cx: &mut AsyncApp,
2996 ) -> Result<lsp::ApplyWorkspaceEditResponse> {
2997 let this = this.upgrade().context("project project closed")?;
2998 let language_server = this
2999 .read_with(cx, |this, _| this.language_server_for_id(server_id))?
3000 .context("language server not found")?;
3001 let transaction = Self::deserialize_workspace_edit(
3002 this.clone(),
3003 params.edit,
3004 true,
3005 adapter.clone(),
3006 language_server.clone(),
3007 cx,
3008 )
3009 .await
3010 .log_err();
3011 this.update(cx, |this, _| {
3012 if let Some(transaction) = transaction {
3013 this.as_local_mut()
3014 .unwrap()
3015 .last_workspace_edits_by_language_server
3016 .insert(server_id, transaction);
3017 }
3018 })?;
3019 Ok(lsp::ApplyWorkspaceEditResponse {
3020 applied: true,
3021 failed_change: None,
3022 failure_reason: None,
3023 })
3024 }
3025
3026 fn remove_worktree(
3027 &mut self,
3028 id_to_remove: WorktreeId,
3029 cx: &mut Context<LspStore>,
3030 ) -> Vec<LanguageServerId> {
3031 self.diagnostics.remove(&id_to_remove);
3032 self.prettier_store.update(cx, |prettier_store, cx| {
3033 prettier_store.remove_worktree(id_to_remove, cx);
3034 });
3035
3036 let mut servers_to_remove = BTreeMap::default();
3037 let mut servers_to_preserve = HashSet::default();
3038 for ((path, server_name), ref server_ids) in &self.language_server_ids {
3039 if *path == id_to_remove {
3040 servers_to_remove.extend(server_ids.iter().map(|id| (*id, server_name.clone())));
3041 } else {
3042 servers_to_preserve.extend(server_ids.iter().cloned());
3043 }
3044 }
3045 servers_to_remove.retain(|server_id, _| !servers_to_preserve.contains(server_id));
3046
3047 for (server_id_to_remove, _) in &servers_to_remove {
3048 self.language_server_ids
3049 .values_mut()
3050 .for_each(|server_ids| {
3051 server_ids.remove(server_id_to_remove);
3052 });
3053 self.language_server_watched_paths
3054 .remove(server_id_to_remove);
3055 self.language_server_paths_watched_for_rename
3056 .remove(server_id_to_remove);
3057 self.last_workspace_edits_by_language_server
3058 .remove(server_id_to_remove);
3059 self.language_servers.remove(server_id_to_remove);
3060 self.buffer_pull_diagnostics_result_ids
3061 .remove(server_id_to_remove);
3062 for buffer_servers in self.buffers_opened_in_servers.values_mut() {
3063 buffer_servers.remove(server_id_to_remove);
3064 }
3065 cx.emit(LspStoreEvent::LanguageServerRemoved(*server_id_to_remove));
3066 }
3067 servers_to_remove.into_keys().collect()
3068 }
3069
3070 fn rebuild_watched_paths_inner<'a>(
3071 &'a self,
3072 language_server_id: LanguageServerId,
3073 watchers: impl Iterator<Item = &'a FileSystemWatcher>,
3074 cx: &mut Context<LspStore>,
3075 ) -> LanguageServerWatchedPathsBuilder {
3076 let worktrees = self
3077 .worktree_store
3078 .read(cx)
3079 .worktrees()
3080 .filter_map(|worktree| {
3081 self.language_servers_for_worktree(worktree.read(cx).id())
3082 .find(|server| server.server_id() == language_server_id)
3083 .map(|_| worktree)
3084 })
3085 .collect::<Vec<_>>();
3086
3087 let mut worktree_globs = HashMap::default();
3088 let mut abs_globs = HashMap::default();
3089 log::trace!(
3090 "Processing new watcher paths for language server with id {}",
3091 language_server_id
3092 );
3093
3094 for watcher in watchers {
3095 if let Some((worktree, literal_prefix, pattern)) =
3096 self.worktree_and_path_for_file_watcher(&worktrees, &watcher, cx)
3097 {
3098 worktree.update(cx, |worktree, _| {
3099 if let Some((tree, glob)) =
3100 worktree.as_local_mut().zip(Glob::new(&pattern).log_err())
3101 {
3102 tree.add_path_prefix_to_scan(literal_prefix.into());
3103 worktree_globs
3104 .entry(tree.id())
3105 .or_insert_with(GlobSetBuilder::new)
3106 .add(glob);
3107 }
3108 });
3109 } else {
3110 let (path, pattern) = match &watcher.glob_pattern {
3111 lsp::GlobPattern::String(s) => {
3112 let watcher_path = SanitizedPath::from(s);
3113 let path = glob_literal_prefix(watcher_path.as_path());
3114 let pattern = watcher_path
3115 .as_path()
3116 .strip_prefix(&path)
3117 .map(|p| p.to_string_lossy().to_string())
3118 .unwrap_or_else(|e| {
3119 debug_panic!(
3120 "Failed to strip prefix for string pattern: {}, with prefix: {}, with error: {}",
3121 s,
3122 path.display(),
3123 e
3124 );
3125 watcher_path.as_path().to_string_lossy().to_string()
3126 });
3127 (path, pattern)
3128 }
3129 lsp::GlobPattern::Relative(rp) => {
3130 let Ok(mut base_uri) = match &rp.base_uri {
3131 lsp::OneOf::Left(workspace_folder) => &workspace_folder.uri,
3132 lsp::OneOf::Right(base_uri) => base_uri,
3133 }
3134 .to_file_path() else {
3135 continue;
3136 };
3137
3138 let path = glob_literal_prefix(Path::new(&rp.pattern));
3139 let pattern = Path::new(&rp.pattern)
3140 .strip_prefix(&path)
3141 .map(|p| p.to_string_lossy().to_string())
3142 .unwrap_or_else(|e| {
3143 debug_panic!(
3144 "Failed to strip prefix for relative pattern: {}, with prefix: {}, with error: {}",
3145 rp.pattern,
3146 path.display(),
3147 e
3148 );
3149 rp.pattern.clone()
3150 });
3151 base_uri.push(path);
3152 (base_uri, pattern)
3153 }
3154 };
3155
3156 if let Some(glob) = Glob::new(&pattern).log_err() {
3157 if !path
3158 .components()
3159 .any(|c| matches!(c, path::Component::Normal(_)))
3160 {
3161 // For an unrooted glob like `**/Cargo.toml`, watch it within each worktree,
3162 // rather than adding a new watcher for `/`.
3163 for worktree in &worktrees {
3164 worktree_globs
3165 .entry(worktree.read(cx).id())
3166 .or_insert_with(GlobSetBuilder::new)
3167 .add(glob.clone());
3168 }
3169 } else {
3170 abs_globs
3171 .entry(path.into())
3172 .or_insert_with(GlobSetBuilder::new)
3173 .add(glob);
3174 }
3175 }
3176 }
3177 }
3178
3179 let mut watch_builder = LanguageServerWatchedPathsBuilder::default();
3180 for (worktree_id, builder) in worktree_globs {
3181 if let Ok(globset) = builder.build() {
3182 watch_builder.watch_worktree(worktree_id, globset);
3183 }
3184 }
3185 for (abs_path, builder) in abs_globs {
3186 if let Ok(globset) = builder.build() {
3187 watch_builder.watch_abs_path(abs_path, globset);
3188 }
3189 }
3190 watch_builder
3191 }
3192
3193 fn worktree_and_path_for_file_watcher(
3194 &self,
3195 worktrees: &[Entity<Worktree>],
3196 watcher: &FileSystemWatcher,
3197 cx: &App,
3198 ) -> Option<(Entity<Worktree>, PathBuf, String)> {
3199 worktrees.iter().find_map(|worktree| {
3200 let tree = worktree.read(cx);
3201 let worktree_root_path = tree.abs_path();
3202 match &watcher.glob_pattern {
3203 lsp::GlobPattern::String(s) => {
3204 let watcher_path = SanitizedPath::from(s);
3205 let relative = watcher_path
3206 .as_path()
3207 .strip_prefix(&worktree_root_path)
3208 .ok()?;
3209 let literal_prefix = glob_literal_prefix(relative);
3210 Some((
3211 worktree.clone(),
3212 literal_prefix,
3213 relative.to_string_lossy().to_string(),
3214 ))
3215 }
3216 lsp::GlobPattern::Relative(rp) => {
3217 let base_uri = match &rp.base_uri {
3218 lsp::OneOf::Left(workspace_folder) => &workspace_folder.uri,
3219 lsp::OneOf::Right(base_uri) => base_uri,
3220 }
3221 .to_file_path()
3222 .ok()?;
3223 let relative = base_uri.strip_prefix(&worktree_root_path).ok()?;
3224 let mut literal_prefix = relative.to_owned();
3225 literal_prefix.push(glob_literal_prefix(Path::new(&rp.pattern)));
3226 Some((worktree.clone(), literal_prefix, rp.pattern.clone()))
3227 }
3228 }
3229 })
3230 }
3231
3232 fn rebuild_watched_paths(
3233 &mut self,
3234 language_server_id: LanguageServerId,
3235 cx: &mut Context<LspStore>,
3236 ) {
3237 let Some(watchers) = self
3238 .language_server_watcher_registrations
3239 .get(&language_server_id)
3240 else {
3241 return;
3242 };
3243
3244 let watch_builder =
3245 self.rebuild_watched_paths_inner(language_server_id, watchers.values().flatten(), cx);
3246 let watcher = watch_builder.build(self.fs.clone(), language_server_id, cx);
3247 self.language_server_watched_paths
3248 .insert(language_server_id, watcher);
3249
3250 cx.notify();
3251 }
3252
3253 fn on_lsp_did_change_watched_files(
3254 &mut self,
3255 language_server_id: LanguageServerId,
3256 registration_id: &str,
3257 params: DidChangeWatchedFilesRegistrationOptions,
3258 cx: &mut Context<LspStore>,
3259 ) {
3260 let registrations = self
3261 .language_server_watcher_registrations
3262 .entry(language_server_id)
3263 .or_default();
3264
3265 registrations.insert(registration_id.to_string(), params.watchers);
3266
3267 self.rebuild_watched_paths(language_server_id, cx);
3268 }
3269
3270 fn on_lsp_unregister_did_change_watched_files(
3271 &mut self,
3272 language_server_id: LanguageServerId,
3273 registration_id: &str,
3274 cx: &mut Context<LspStore>,
3275 ) {
3276 let registrations = self
3277 .language_server_watcher_registrations
3278 .entry(language_server_id)
3279 .or_default();
3280
3281 if registrations.remove(registration_id).is_some() {
3282 log::info!(
3283 "language server {}: unregistered workspace/DidChangeWatchedFiles capability with id {}",
3284 language_server_id,
3285 registration_id
3286 );
3287 } else {
3288 log::warn!(
3289 "language server {}: failed to unregister workspace/DidChangeWatchedFiles capability with id {}. not registered.",
3290 language_server_id,
3291 registration_id
3292 );
3293 }
3294
3295 self.rebuild_watched_paths(language_server_id, cx);
3296 }
3297
3298 async fn initialization_options_for_adapter(
3299 adapter: Arc<dyn LspAdapter>,
3300 fs: &dyn Fs,
3301 delegate: &Arc<dyn LspAdapterDelegate>,
3302 ) -> Result<Option<serde_json::Value>> {
3303 let Some(mut initialization_config) =
3304 adapter.clone().initialization_options(fs, delegate).await?
3305 else {
3306 return Ok(None);
3307 };
3308
3309 for other_adapter in delegate.registered_lsp_adapters() {
3310 if other_adapter.name() == adapter.name() {
3311 continue;
3312 }
3313 if let Ok(Some(target_config)) = other_adapter
3314 .clone()
3315 .additional_initialization_options(adapter.name(), fs, delegate)
3316 .await
3317 {
3318 merge_json_value_into(target_config.clone(), &mut initialization_config);
3319 }
3320 }
3321
3322 Ok(Some(initialization_config))
3323 }
3324
3325 async fn workspace_configuration_for_adapter(
3326 adapter: Arc<dyn LspAdapter>,
3327 fs: &dyn Fs,
3328 delegate: &Arc<dyn LspAdapterDelegate>,
3329 toolchains: Arc<dyn LanguageToolchainStore>,
3330 cx: &mut AsyncApp,
3331 ) -> Result<serde_json::Value> {
3332 let mut workspace_config = adapter
3333 .clone()
3334 .workspace_configuration(fs, delegate, toolchains.clone(), cx)
3335 .await?;
3336
3337 for other_adapter in delegate.registered_lsp_adapters() {
3338 if other_adapter.name() == adapter.name() {
3339 continue;
3340 }
3341 if let Ok(Some(target_config)) = other_adapter
3342 .clone()
3343 .additional_workspace_configuration(
3344 adapter.name(),
3345 fs,
3346 delegate,
3347 toolchains.clone(),
3348 cx,
3349 )
3350 .await
3351 {
3352 merge_json_value_into(target_config.clone(), &mut workspace_config);
3353 }
3354 }
3355
3356 Ok(workspace_config)
3357 }
3358
3359 fn language_server_for_id(&self, id: LanguageServerId) -> Option<Arc<LanguageServer>> {
3360 if let Some(LanguageServerState::Running { server, .. }) = self.language_servers.get(&id) {
3361 Some(server.clone())
3362 } else if let Some((_, server)) = self.supplementary_language_servers.get(&id) {
3363 Some(Arc::clone(server))
3364 } else {
3365 None
3366 }
3367 }
3368}
3369
3370fn notify_server_capabilities_updated(server: &LanguageServer, cx: &mut Context<LspStore>) {
3371 if let Some(capabilities) = serde_json::to_string(&server.capabilities()).ok() {
3372 cx.emit(LspStoreEvent::LanguageServerUpdate {
3373 language_server_id: server.server_id(),
3374 name: Some(server.name()),
3375 message: proto::update_language_server::Variant::MetadataUpdated(
3376 proto::ServerMetadataUpdated {
3377 capabilities: Some(capabilities),
3378 },
3379 ),
3380 });
3381 }
3382}
3383
3384#[derive(Debug)]
3385pub struct FormattableBuffer {
3386 handle: Entity<Buffer>,
3387 abs_path: Option<PathBuf>,
3388 env: Option<HashMap<String, String>>,
3389 ranges: Option<Vec<Range<Anchor>>>,
3390}
3391
3392pub struct RemoteLspStore {
3393 upstream_client: Option<AnyProtoClient>,
3394 upstream_project_id: u64,
3395}
3396
3397pub(crate) enum LspStoreMode {
3398 Local(LocalLspStore), // ssh host and collab host
3399 Remote(RemoteLspStore), // collab guest
3400}
3401
3402impl LspStoreMode {
3403 fn is_local(&self) -> bool {
3404 matches!(self, LspStoreMode::Local(_))
3405 }
3406}
3407
3408pub struct LspStore {
3409 mode: LspStoreMode,
3410 last_formatting_failure: Option<String>,
3411 downstream_client: Option<(AnyProtoClient, u64)>,
3412 nonce: u128,
3413 buffer_store: Entity<BufferStore>,
3414 worktree_store: Entity<WorktreeStore>,
3415 toolchain_store: Option<Entity<ToolchainStore>>,
3416 pub languages: Arc<LanguageRegistry>,
3417 language_server_statuses: BTreeMap<LanguageServerId, LanguageServerStatus>,
3418 active_entry: Option<ProjectEntryId>,
3419 _maintain_workspace_config: (Task<Result<()>>, watch::Sender<()>),
3420 _maintain_buffer_languages: Task<()>,
3421 diagnostic_summaries:
3422 HashMap<WorktreeId, HashMap<Arc<Path>, HashMap<LanguageServerId, DiagnosticSummary>>>,
3423 pub(super) lsp_server_capabilities: HashMap<LanguageServerId, lsp::ServerCapabilities>,
3424 lsp_document_colors: HashMap<BufferId, DocumentColorData>,
3425 lsp_code_lens: HashMap<BufferId, CodeLensData>,
3426}
3427
3428#[derive(Debug, Default, Clone)]
3429pub struct DocumentColors {
3430 pub colors: HashSet<DocumentColor>,
3431 pub cache_version: Option<usize>,
3432}
3433
3434type DocumentColorTask = Shared<Task<std::result::Result<DocumentColors, Arc<anyhow::Error>>>>;
3435type CodeLensTask = Shared<Task<std::result::Result<Vec<CodeAction>, Arc<anyhow::Error>>>>;
3436
3437#[derive(Debug, Default)]
3438struct DocumentColorData {
3439 colors_for_version: Global,
3440 colors: HashMap<LanguageServerId, HashSet<DocumentColor>>,
3441 cache_version: usize,
3442 colors_update: Option<(Global, DocumentColorTask)>,
3443}
3444
3445#[derive(Debug, Default)]
3446struct CodeLensData {
3447 lens_for_version: Global,
3448 lens: HashMap<LanguageServerId, Vec<CodeAction>>,
3449 update: Option<(Global, CodeLensTask)>,
3450}
3451
3452#[derive(Debug, PartialEq, Eq, Clone, Copy)]
3453pub enum LspFetchStrategy {
3454 IgnoreCache,
3455 UseCache { known_cache_version: Option<usize> },
3456}
3457
3458#[derive(Debug)]
3459pub enum LspStoreEvent {
3460 LanguageServerAdded(LanguageServerId, LanguageServerName, Option<WorktreeId>),
3461 LanguageServerRemoved(LanguageServerId),
3462 LanguageServerUpdate {
3463 language_server_id: LanguageServerId,
3464 name: Option<LanguageServerName>,
3465 message: proto::update_language_server::Variant,
3466 },
3467 LanguageServerLog(LanguageServerId, LanguageServerLogType, String),
3468 LanguageServerPrompt(LanguageServerPromptRequest),
3469 LanguageDetected {
3470 buffer: Entity<Buffer>,
3471 new_language: Option<Arc<Language>>,
3472 },
3473 Notification(String),
3474 RefreshInlayHints,
3475 RefreshCodeLens,
3476 DiagnosticsUpdated {
3477 server_id: LanguageServerId,
3478 paths: Vec<ProjectPath>,
3479 },
3480 DiskBasedDiagnosticsStarted {
3481 language_server_id: LanguageServerId,
3482 },
3483 DiskBasedDiagnosticsFinished {
3484 language_server_id: LanguageServerId,
3485 },
3486 SnippetEdit {
3487 buffer_id: BufferId,
3488 edits: Vec<(lsp::Range, Snippet)>,
3489 most_recent_edit: clock::Lamport,
3490 },
3491}
3492
3493#[derive(Clone, Debug, Serialize)]
3494pub struct LanguageServerStatus {
3495 pub name: LanguageServerName,
3496 pub pending_work: BTreeMap<String, LanguageServerProgress>,
3497 pub has_pending_diagnostic_updates: bool,
3498 progress_tokens: HashSet<String>,
3499}
3500
3501#[derive(Clone, Debug)]
3502struct CoreSymbol {
3503 pub language_server_name: LanguageServerName,
3504 pub source_worktree_id: WorktreeId,
3505 pub source_language_server_id: LanguageServerId,
3506 pub path: ProjectPath,
3507 pub name: String,
3508 pub kind: lsp::SymbolKind,
3509 pub range: Range<Unclipped<PointUtf16>>,
3510 pub signature: [u8; 32],
3511}
3512
3513impl LspStore {
3514 pub fn init(client: &AnyProtoClient) {
3515 client.add_entity_request_handler(Self::handle_multi_lsp_query);
3516 client.add_entity_request_handler(Self::handle_restart_language_servers);
3517 client.add_entity_request_handler(Self::handle_stop_language_servers);
3518 client.add_entity_request_handler(Self::handle_cancel_language_server_work);
3519 client.add_entity_message_handler(Self::handle_start_language_server);
3520 client.add_entity_message_handler(Self::handle_update_language_server);
3521 client.add_entity_message_handler(Self::handle_language_server_log);
3522 client.add_entity_message_handler(Self::handle_update_diagnostic_summary);
3523 client.add_entity_request_handler(Self::handle_format_buffers);
3524 client.add_entity_request_handler(Self::handle_apply_code_action_kind);
3525 client.add_entity_request_handler(Self::handle_resolve_completion_documentation);
3526 client.add_entity_request_handler(Self::handle_apply_code_action);
3527 client.add_entity_request_handler(Self::handle_inlay_hints);
3528 client.add_entity_request_handler(Self::handle_get_project_symbols);
3529 client.add_entity_request_handler(Self::handle_resolve_inlay_hint);
3530 client.add_entity_request_handler(Self::handle_get_color_presentation);
3531 client.add_entity_request_handler(Self::handle_open_buffer_for_symbol);
3532 client.add_entity_request_handler(Self::handle_refresh_inlay_hints);
3533 client.add_entity_request_handler(Self::handle_refresh_code_lens);
3534 client.add_entity_request_handler(Self::handle_on_type_formatting);
3535 client.add_entity_request_handler(Self::handle_apply_additional_edits_for_completion);
3536 client.add_entity_request_handler(Self::handle_register_buffer_with_language_servers);
3537 client.add_entity_request_handler(Self::handle_rename_project_entry);
3538 client.add_entity_request_handler(Self::handle_pull_workspace_diagnostics);
3539 client.add_entity_request_handler(Self::handle_lsp_command::<GetCodeActions>);
3540 client.add_entity_request_handler(Self::handle_lsp_command::<GetCompletions>);
3541 client.add_entity_request_handler(Self::handle_lsp_command::<GetHover>);
3542 client.add_entity_request_handler(Self::handle_lsp_command::<GetDocumentHighlights>);
3543 client.add_entity_request_handler(Self::handle_lsp_command::<GetDocumentSymbols>);
3544 client.add_entity_request_handler(Self::handle_lsp_command::<PrepareRename>);
3545 client.add_entity_request_handler(Self::handle_lsp_command::<PerformRename>);
3546 client.add_entity_request_handler(Self::handle_lsp_command::<LinkedEditingRange>);
3547
3548 client.add_entity_request_handler(Self::handle_lsp_ext_cancel_flycheck);
3549 client.add_entity_request_handler(Self::handle_lsp_ext_run_flycheck);
3550 client.add_entity_request_handler(Self::handle_lsp_ext_clear_flycheck);
3551 client.add_entity_request_handler(Self::handle_lsp_command::<lsp_ext_command::ExpandMacro>);
3552 client.add_entity_request_handler(Self::handle_lsp_command::<lsp_ext_command::OpenDocs>);
3553 client.add_entity_request_handler(
3554 Self::handle_lsp_command::<lsp_ext_command::GoToParentModule>,
3555 );
3556 client.add_entity_request_handler(
3557 Self::handle_lsp_command::<lsp_ext_command::GetLspRunnables>,
3558 );
3559 client.add_entity_request_handler(
3560 Self::handle_lsp_command::<lsp_ext_command::SwitchSourceHeader>,
3561 );
3562 client.add_entity_request_handler(Self::handle_lsp_command::<GetDocumentDiagnostics>);
3563 }
3564
3565 pub fn as_remote(&self) -> Option<&RemoteLspStore> {
3566 match &self.mode {
3567 LspStoreMode::Remote(remote_lsp_store) => Some(remote_lsp_store),
3568 _ => None,
3569 }
3570 }
3571
3572 pub fn as_local(&self) -> Option<&LocalLspStore> {
3573 match &self.mode {
3574 LspStoreMode::Local(local_lsp_store) => Some(local_lsp_store),
3575 _ => None,
3576 }
3577 }
3578
3579 pub fn as_local_mut(&mut self) -> Option<&mut LocalLspStore> {
3580 match &mut self.mode {
3581 LspStoreMode::Local(local_lsp_store) => Some(local_lsp_store),
3582 _ => None,
3583 }
3584 }
3585
3586 pub fn upstream_client(&self) -> Option<(AnyProtoClient, u64)> {
3587 match &self.mode {
3588 LspStoreMode::Remote(RemoteLspStore {
3589 upstream_client: Some(upstream_client),
3590 upstream_project_id,
3591 ..
3592 }) => Some((upstream_client.clone(), *upstream_project_id)),
3593
3594 LspStoreMode::Remote(RemoteLspStore {
3595 upstream_client: None,
3596 ..
3597 }) => None,
3598 LspStoreMode::Local(_) => None,
3599 }
3600 }
3601
3602 pub fn new_local(
3603 buffer_store: Entity<BufferStore>,
3604 worktree_store: Entity<WorktreeStore>,
3605 prettier_store: Entity<PrettierStore>,
3606 toolchain_store: Entity<ToolchainStore>,
3607 environment: Entity<ProjectEnvironment>,
3608 manifest_tree: Entity<ManifestTree>,
3609 languages: Arc<LanguageRegistry>,
3610 http_client: Arc<dyn HttpClient>,
3611 fs: Arc<dyn Fs>,
3612 cx: &mut Context<Self>,
3613 ) -> Self {
3614 let yarn = YarnPathStore::new(fs.clone(), cx);
3615 cx.subscribe(&buffer_store, Self::on_buffer_store_event)
3616 .detach();
3617 cx.subscribe(&worktree_store, Self::on_worktree_store_event)
3618 .detach();
3619 cx.subscribe(&prettier_store, Self::on_prettier_store_event)
3620 .detach();
3621 cx.subscribe(&toolchain_store, Self::on_toolchain_store_event)
3622 .detach();
3623 if let Some(extension_events) = extension::ExtensionEvents::try_global(cx).as_ref() {
3624 cx.subscribe(
3625 extension_events,
3626 Self::reload_zed_json_schemas_on_extensions_changed,
3627 )
3628 .detach();
3629 } else {
3630 log::debug!("No extension events global found. Skipping JSON schema auto-reload setup");
3631 }
3632 cx.observe_global::<SettingsStore>(Self::on_settings_changed)
3633 .detach();
3634 subscribe_to_binary_statuses(&languages, cx).detach();
3635
3636 let _maintain_workspace_config = {
3637 let (sender, receiver) = watch::channel();
3638 (
3639 Self::maintain_workspace_config(fs.clone(), receiver, cx),
3640 sender,
3641 )
3642 };
3643
3644 Self {
3645 mode: LspStoreMode::Local(LocalLspStore {
3646 weak: cx.weak_entity(),
3647 worktree_store: worktree_store.clone(),
3648 toolchain_store: toolchain_store.clone(),
3649 supplementary_language_servers: Default::default(),
3650 languages: languages.clone(),
3651 language_server_ids: Default::default(),
3652 language_servers: Default::default(),
3653 last_workspace_edits_by_language_server: Default::default(),
3654 language_server_watched_paths: Default::default(),
3655 language_server_paths_watched_for_rename: Default::default(),
3656 language_server_watcher_registrations: Default::default(),
3657 buffers_being_formatted: Default::default(),
3658 buffer_snapshots: Default::default(),
3659 prettier_store,
3660 environment,
3661 http_client,
3662 fs,
3663 yarn,
3664 next_diagnostic_group_id: Default::default(),
3665 diagnostics: Default::default(),
3666 _subscription: cx.on_app_quit(|this, cx| {
3667 this.as_local_mut()
3668 .unwrap()
3669 .shutdown_language_servers_on_quit(cx)
3670 }),
3671 lsp_tree: LanguageServerTree::new(manifest_tree, languages.clone(), cx),
3672 registered_buffers: HashMap::default(),
3673 buffers_opened_in_servers: HashMap::default(),
3674 buffer_pull_diagnostics_result_ids: HashMap::default(),
3675 }),
3676 last_formatting_failure: None,
3677 downstream_client: None,
3678 buffer_store,
3679 worktree_store,
3680 toolchain_store: Some(toolchain_store),
3681 languages: languages.clone(),
3682 language_server_statuses: Default::default(),
3683 nonce: StdRng::from_entropy().r#gen(),
3684 diagnostic_summaries: HashMap::default(),
3685 lsp_server_capabilities: HashMap::default(),
3686 lsp_document_colors: HashMap::default(),
3687 lsp_code_lens: HashMap::default(),
3688 active_entry: None,
3689 _maintain_workspace_config,
3690 _maintain_buffer_languages: Self::maintain_buffer_languages(languages, cx),
3691 }
3692 }
3693
3694 fn send_lsp_proto_request<R: LspCommand>(
3695 &self,
3696 buffer: Entity<Buffer>,
3697 client: AnyProtoClient,
3698 upstream_project_id: u64,
3699 request: R,
3700 cx: &mut Context<LspStore>,
3701 ) -> Task<anyhow::Result<<R as LspCommand>::Response>> {
3702 if !self.is_capable_for_proto_request(&buffer, &request, cx) {
3703 return Task::ready(Ok(R::Response::default()));
3704 }
3705 let message = request.to_proto(upstream_project_id, buffer.read(cx));
3706 cx.spawn(async move |this, cx| {
3707 let response = client.request(message).await?;
3708 let this = this.upgrade().context("project dropped")?;
3709 request
3710 .response_from_proto(response, this, buffer, cx.clone())
3711 .await
3712 })
3713 }
3714
3715 pub(super) fn new_remote(
3716 buffer_store: Entity<BufferStore>,
3717 worktree_store: Entity<WorktreeStore>,
3718 toolchain_store: Option<Entity<ToolchainStore>>,
3719 languages: Arc<LanguageRegistry>,
3720 upstream_client: AnyProtoClient,
3721 project_id: u64,
3722 fs: Arc<dyn Fs>,
3723 cx: &mut Context<Self>,
3724 ) -> Self {
3725 cx.subscribe(&buffer_store, Self::on_buffer_store_event)
3726 .detach();
3727 cx.subscribe(&worktree_store, Self::on_worktree_store_event)
3728 .detach();
3729 subscribe_to_binary_statuses(&languages, cx).detach();
3730 let _maintain_workspace_config = {
3731 let (sender, receiver) = watch::channel();
3732 (Self::maintain_workspace_config(fs, receiver, cx), sender)
3733 };
3734 Self {
3735 mode: LspStoreMode::Remote(RemoteLspStore {
3736 upstream_client: Some(upstream_client),
3737 upstream_project_id: project_id,
3738 }),
3739 downstream_client: None,
3740 last_formatting_failure: None,
3741 buffer_store,
3742 worktree_store,
3743 languages: languages.clone(),
3744 language_server_statuses: Default::default(),
3745 nonce: StdRng::from_entropy().r#gen(),
3746 diagnostic_summaries: HashMap::default(),
3747 lsp_server_capabilities: HashMap::default(),
3748 lsp_document_colors: HashMap::default(),
3749 lsp_code_lens: HashMap::default(),
3750 active_entry: None,
3751 toolchain_store,
3752 _maintain_workspace_config,
3753 _maintain_buffer_languages: Self::maintain_buffer_languages(languages.clone(), cx),
3754 }
3755 }
3756
3757 fn on_buffer_store_event(
3758 &mut self,
3759 _: Entity<BufferStore>,
3760 event: &BufferStoreEvent,
3761 cx: &mut Context<Self>,
3762 ) {
3763 match event {
3764 BufferStoreEvent::BufferAdded(buffer) => {
3765 self.on_buffer_added(buffer, cx).log_err();
3766 }
3767 BufferStoreEvent::BufferChangedFilePath { buffer, old_file } => {
3768 let buffer_id = buffer.read(cx).remote_id();
3769 if let Some(local) = self.as_local_mut() {
3770 if let Some(old_file) = File::from_dyn(old_file.as_ref()) {
3771 local.reset_buffer(buffer, old_file, cx);
3772
3773 if local.registered_buffers.contains_key(&buffer_id) {
3774 local.unregister_old_buffer_from_language_servers(buffer, old_file, cx);
3775 }
3776 }
3777 }
3778
3779 self.detect_language_for_buffer(buffer, cx);
3780 if let Some(local) = self.as_local_mut() {
3781 local.initialize_buffer(buffer, cx);
3782 if local.registered_buffers.contains_key(&buffer_id) {
3783 local.register_buffer_with_language_servers(buffer, HashSet::default(), cx);
3784 }
3785 }
3786 }
3787 _ => {}
3788 }
3789 }
3790
3791 fn on_worktree_store_event(
3792 &mut self,
3793 _: Entity<WorktreeStore>,
3794 event: &WorktreeStoreEvent,
3795 cx: &mut Context<Self>,
3796 ) {
3797 match event {
3798 WorktreeStoreEvent::WorktreeAdded(worktree) => {
3799 if !worktree.read(cx).is_local() {
3800 return;
3801 }
3802 cx.subscribe(worktree, |this, worktree, event, cx| match event {
3803 worktree::Event::UpdatedEntries(changes) => {
3804 this.update_local_worktree_language_servers(&worktree, changes, cx);
3805 }
3806 worktree::Event::UpdatedGitRepositories(_)
3807 | worktree::Event::DeletedEntry(_) => {}
3808 })
3809 .detach()
3810 }
3811 WorktreeStoreEvent::WorktreeRemoved(_, id) => self.remove_worktree(*id, cx),
3812 WorktreeStoreEvent::WorktreeUpdateSent(worktree) => {
3813 worktree.update(cx, |worktree, _cx| self.send_diagnostic_summaries(worktree));
3814 }
3815 WorktreeStoreEvent::WorktreeReleased(..)
3816 | WorktreeStoreEvent::WorktreeOrderChanged
3817 | WorktreeStoreEvent::WorktreeUpdatedEntries(..)
3818 | WorktreeStoreEvent::WorktreeUpdatedGitRepositories(..)
3819 | WorktreeStoreEvent::WorktreeDeletedEntry(..) => {}
3820 }
3821 }
3822
3823 fn on_prettier_store_event(
3824 &mut self,
3825 _: Entity<PrettierStore>,
3826 event: &PrettierStoreEvent,
3827 cx: &mut Context<Self>,
3828 ) {
3829 match event {
3830 PrettierStoreEvent::LanguageServerRemoved(prettier_server_id) => {
3831 self.unregister_supplementary_language_server(*prettier_server_id, cx);
3832 }
3833 PrettierStoreEvent::LanguageServerAdded {
3834 new_server_id,
3835 name,
3836 prettier_server,
3837 } => {
3838 self.register_supplementary_language_server(
3839 *new_server_id,
3840 name.clone(),
3841 prettier_server.clone(),
3842 cx,
3843 );
3844 }
3845 }
3846 }
3847
3848 fn on_toolchain_store_event(
3849 &mut self,
3850 _: Entity<ToolchainStore>,
3851 event: &ToolchainStoreEvent,
3852 _: &mut Context<Self>,
3853 ) {
3854 match event {
3855 ToolchainStoreEvent::ToolchainActivated { .. } => {
3856 self.request_workspace_config_refresh()
3857 }
3858 }
3859 }
3860
3861 fn request_workspace_config_refresh(&mut self) {
3862 *self._maintain_workspace_config.1.borrow_mut() = ();
3863 }
3864
3865 pub fn prettier_store(&self) -> Option<Entity<PrettierStore>> {
3866 self.as_local().map(|local| local.prettier_store.clone())
3867 }
3868
3869 fn on_buffer_event(
3870 &mut self,
3871 buffer: Entity<Buffer>,
3872 event: &language::BufferEvent,
3873 cx: &mut Context<Self>,
3874 ) {
3875 match event {
3876 language::BufferEvent::Edited => {
3877 self.on_buffer_edited(buffer, cx);
3878 }
3879
3880 language::BufferEvent::Saved => {
3881 self.on_buffer_saved(buffer, cx);
3882 }
3883
3884 _ => {}
3885 }
3886 }
3887
3888 fn on_buffer_added(&mut self, buffer: &Entity<Buffer>, cx: &mut Context<Self>) -> Result<()> {
3889 buffer
3890 .read(cx)
3891 .set_language_registry(self.languages.clone());
3892
3893 cx.subscribe(buffer, |this, buffer, event, cx| {
3894 this.on_buffer_event(buffer, event, cx);
3895 })
3896 .detach();
3897
3898 self.detect_language_for_buffer(buffer, cx);
3899 if let Some(local) = self.as_local_mut() {
3900 local.initialize_buffer(buffer, cx);
3901 }
3902
3903 Ok(())
3904 }
3905
3906 pub fn reload_zed_json_schemas_on_extensions_changed(
3907 &mut self,
3908 _: Entity<extension::ExtensionEvents>,
3909 evt: &extension::Event,
3910 cx: &mut Context<Self>,
3911 ) {
3912 match evt {
3913 extension::Event::ExtensionInstalled(_)
3914 | extension::Event::ExtensionUninstalled(_)
3915 | extension::Event::ConfigureExtensionRequested(_) => return,
3916 extension::Event::ExtensionsInstalledChanged => {}
3917 }
3918 if self.as_local().is_none() {
3919 return;
3920 }
3921 cx.spawn(async move |this, cx| {
3922 let weak_ref = this.clone();
3923
3924 let servers = this
3925 .update(cx, |this, cx| {
3926 let local = this.as_local()?;
3927
3928 let mut servers = Vec::new();
3929 for ((worktree_id, _), server_ids) in &local.language_server_ids {
3930 for server_id in server_ids {
3931 let Some(states) = local.language_servers.get(server_id) else {
3932 continue;
3933 };
3934 let (json_adapter, json_server) = match states {
3935 LanguageServerState::Running {
3936 adapter, server, ..
3937 } if adapter.adapter.is_primary_zed_json_schema_adapter() => {
3938 (adapter.adapter.clone(), server.clone())
3939 }
3940 _ => continue,
3941 };
3942
3943 let Some(worktree) = this
3944 .worktree_store
3945 .read(cx)
3946 .worktree_for_id(*worktree_id, cx)
3947 else {
3948 continue;
3949 };
3950 let json_delegate: Arc<dyn LspAdapterDelegate> =
3951 LocalLspAdapterDelegate::new(
3952 local.languages.clone(),
3953 &local.environment,
3954 weak_ref.clone(),
3955 &worktree,
3956 local.http_client.clone(),
3957 local.fs.clone(),
3958 cx,
3959 );
3960
3961 servers.push((json_adapter, json_server, json_delegate));
3962 }
3963 }
3964 return Some(servers);
3965 })
3966 .ok()
3967 .flatten();
3968
3969 let Some(servers) = servers else {
3970 return;
3971 };
3972
3973 let Ok(Some((fs, toolchain_store))) = this.read_with(cx, |this, cx| {
3974 let local = this.as_local()?;
3975 let toolchain_store = this.toolchain_store(cx);
3976 return Some((local.fs.clone(), toolchain_store));
3977 }) else {
3978 return;
3979 };
3980 for (adapter, server, delegate) in servers {
3981 adapter.clear_zed_json_schema_cache().await;
3982
3983 let Some(json_workspace_config) = LocalLspStore::workspace_configuration_for_adapter(
3984 adapter,
3985 fs.as_ref(),
3986 &delegate,
3987 toolchain_store.clone(),
3988 cx,
3989 )
3990 .await
3991 .context("generate new workspace configuration for JSON language server while trying to refresh JSON Schemas")
3992 .ok()
3993 else {
3994 continue;
3995 };
3996 server
3997 .notify::<lsp::notification::DidChangeConfiguration>(
3998 &lsp::DidChangeConfigurationParams {
3999 settings: json_workspace_config,
4000 },
4001 )
4002 .ok();
4003 }
4004 })
4005 .detach();
4006 }
4007
4008 pub(crate) fn register_buffer_with_language_servers(
4009 &mut self,
4010 buffer: &Entity<Buffer>,
4011 only_register_servers: HashSet<LanguageServerSelector>,
4012 ignore_refcounts: bool,
4013 cx: &mut Context<Self>,
4014 ) -> OpenLspBufferHandle {
4015 let buffer_id = buffer.read(cx).remote_id();
4016 let handle = cx.new(|_| buffer.clone());
4017 if let Some(local) = self.as_local_mut() {
4018 let refcount = local.registered_buffers.entry(buffer_id).or_insert(0);
4019 if !ignore_refcounts {
4020 *refcount += 1;
4021 }
4022
4023 // We run early exits on non-existing buffers AFTER we mark the buffer as registered in order to handle buffer saving.
4024 // When a new unnamed buffer is created and saved, we will start loading it's language. Once the language is loaded, we go over all "language-less" buffers and try to fit that new language
4025 // with them. However, we do that only for the buffers that we think are open in at least one editor; thus, we need to keep tab of unnamed buffers as well, even though they're not actually registered with any language
4026 // servers in practice (we don't support non-file URI schemes in our LSP impl).
4027 let Some(file) = File::from_dyn(buffer.read(cx).file()) else {
4028 return handle;
4029 };
4030 if !file.is_local() {
4031 return handle;
4032 }
4033
4034 if ignore_refcounts || *refcount == 1 {
4035 local.register_buffer_with_language_servers(buffer, only_register_servers, cx);
4036 }
4037 if !ignore_refcounts {
4038 cx.observe_release(&handle, move |lsp_store, buffer, cx| {
4039 let refcount = {
4040 let local = lsp_store.as_local_mut().unwrap();
4041 let Some(refcount) = local.registered_buffers.get_mut(&buffer_id) else {
4042 debug_panic!("bad refcounting");
4043 return;
4044 };
4045
4046 *refcount -= 1;
4047 *refcount
4048 };
4049 if refcount == 0 {
4050 lsp_store.lsp_document_colors.remove(&buffer_id);
4051 lsp_store.lsp_code_lens.remove(&buffer_id);
4052 let local = lsp_store.as_local_mut().unwrap();
4053 local.registered_buffers.remove(&buffer_id);
4054 local.buffers_opened_in_servers.remove(&buffer_id);
4055 if let Some(file) = File::from_dyn(buffer.read(cx).file()).cloned() {
4056 local.unregister_old_buffer_from_language_servers(&buffer, &file, cx);
4057 }
4058 }
4059 })
4060 .detach();
4061 }
4062 } else if let Some((upstream_client, upstream_project_id)) = self.upstream_client() {
4063 let buffer_id = buffer.read(cx).remote_id().to_proto();
4064 cx.background_spawn(async move {
4065 upstream_client
4066 .request(proto::RegisterBufferWithLanguageServers {
4067 project_id: upstream_project_id,
4068 buffer_id,
4069 only_servers: only_register_servers
4070 .into_iter()
4071 .map(|selector| {
4072 let selector = match selector {
4073 LanguageServerSelector::Id(language_server_id) => {
4074 proto::language_server_selector::Selector::ServerId(
4075 language_server_id.to_proto(),
4076 )
4077 }
4078 LanguageServerSelector::Name(language_server_name) => {
4079 proto::language_server_selector::Selector::Name(
4080 language_server_name.to_string(),
4081 )
4082 }
4083 };
4084 proto::LanguageServerSelector {
4085 selector: Some(selector),
4086 }
4087 })
4088 .collect(),
4089 })
4090 .await
4091 })
4092 .detach();
4093 } else {
4094 panic!("oops!");
4095 }
4096 handle
4097 }
4098
4099 fn maintain_buffer_languages(
4100 languages: Arc<LanguageRegistry>,
4101 cx: &mut Context<Self>,
4102 ) -> Task<()> {
4103 let mut subscription = languages.subscribe();
4104 let mut prev_reload_count = languages.reload_count();
4105 cx.spawn(async move |this, cx| {
4106 while let Some(()) = subscription.next().await {
4107 if let Some(this) = this.upgrade() {
4108 // If the language registry has been reloaded, then remove and
4109 // re-assign the languages on all open buffers.
4110 let reload_count = languages.reload_count();
4111 if reload_count > prev_reload_count {
4112 prev_reload_count = reload_count;
4113 this.update(cx, |this, cx| {
4114 this.buffer_store.clone().update(cx, |buffer_store, cx| {
4115 for buffer in buffer_store.buffers() {
4116 if let Some(f) = File::from_dyn(buffer.read(cx).file()).cloned()
4117 {
4118 buffer
4119 .update(cx, |buffer, cx| buffer.set_language(None, cx));
4120 if let Some(local) = this.as_local_mut() {
4121 local.reset_buffer(&buffer, &f, cx);
4122
4123 if local
4124 .registered_buffers
4125 .contains_key(&buffer.read(cx).remote_id())
4126 {
4127 if let Some(file_url) =
4128 file_path_to_lsp_url(&f.abs_path(cx)).log_err()
4129 {
4130 local.unregister_buffer_from_language_servers(
4131 &buffer, &file_url, cx,
4132 );
4133 }
4134 }
4135 }
4136 }
4137 }
4138 });
4139 })
4140 .ok();
4141 }
4142
4143 this.update(cx, |this, cx| {
4144 let mut plain_text_buffers = Vec::new();
4145 let mut buffers_with_unknown_injections = Vec::new();
4146 for handle in this.buffer_store.read(cx).buffers() {
4147 let buffer = handle.read(cx);
4148 if buffer.language().is_none()
4149 || buffer.language() == Some(&*language::PLAIN_TEXT)
4150 {
4151 plain_text_buffers.push(handle);
4152 } else if buffer.contains_unknown_injections() {
4153 buffers_with_unknown_injections.push(handle);
4154 }
4155 }
4156
4157 // Deprioritize the invisible worktrees so main worktrees' language servers can be started first,
4158 // and reused later in the invisible worktrees.
4159 plain_text_buffers.sort_by_key(|buffer| {
4160 Reverse(
4161 File::from_dyn(buffer.read(cx).file())
4162 .map(|file| file.worktree.read(cx).is_visible()),
4163 )
4164 });
4165
4166 for buffer in plain_text_buffers {
4167 this.detect_language_for_buffer(&buffer, cx);
4168 if let Some(local) = this.as_local_mut() {
4169 local.initialize_buffer(&buffer, cx);
4170 if local
4171 .registered_buffers
4172 .contains_key(&buffer.read(cx).remote_id())
4173 {
4174 local.register_buffer_with_language_servers(
4175 &buffer,
4176 HashSet::default(),
4177 cx,
4178 );
4179 }
4180 }
4181 }
4182
4183 for buffer in buffers_with_unknown_injections {
4184 buffer.update(cx, |buffer, cx| buffer.reparse(cx));
4185 }
4186 })
4187 .ok();
4188 }
4189 }
4190 })
4191 }
4192
4193 fn detect_language_for_buffer(
4194 &mut self,
4195 buffer_handle: &Entity<Buffer>,
4196 cx: &mut Context<Self>,
4197 ) -> Option<language::AvailableLanguage> {
4198 // If the buffer has a language, set it and start the language server if we haven't already.
4199 let buffer = buffer_handle.read(cx);
4200 let file = buffer.file()?;
4201
4202 let content = buffer.as_rope();
4203 let available_language = self.languages.language_for_file(file, Some(content), cx);
4204 if let Some(available_language) = &available_language {
4205 if let Some(Ok(Ok(new_language))) = self
4206 .languages
4207 .load_language(available_language)
4208 .now_or_never()
4209 {
4210 self.set_language_for_buffer(buffer_handle, new_language, cx);
4211 }
4212 } else {
4213 cx.emit(LspStoreEvent::LanguageDetected {
4214 buffer: buffer_handle.clone(),
4215 new_language: None,
4216 });
4217 }
4218
4219 available_language
4220 }
4221
4222 pub(crate) fn set_language_for_buffer(
4223 &mut self,
4224 buffer_entity: &Entity<Buffer>,
4225 new_language: Arc<Language>,
4226 cx: &mut Context<Self>,
4227 ) {
4228 let buffer = buffer_entity.read(cx);
4229 let buffer_file = buffer.file().cloned();
4230 let buffer_id = buffer.remote_id();
4231 if let Some(local_store) = self.as_local_mut() {
4232 if local_store.registered_buffers.contains_key(&buffer_id) {
4233 if let Some(abs_path) =
4234 File::from_dyn(buffer_file.as_ref()).map(|file| file.abs_path(cx))
4235 {
4236 if let Some(file_url) = file_path_to_lsp_url(&abs_path).log_err() {
4237 local_store.unregister_buffer_from_language_servers(
4238 buffer_entity,
4239 &file_url,
4240 cx,
4241 );
4242 }
4243 }
4244 }
4245 }
4246 buffer_entity.update(cx, |buffer, cx| {
4247 if buffer.language().map_or(true, |old_language| {
4248 !Arc::ptr_eq(old_language, &new_language)
4249 }) {
4250 buffer.set_language(Some(new_language.clone()), cx);
4251 }
4252 });
4253
4254 let settings =
4255 language_settings(Some(new_language.name()), buffer_file.as_ref(), cx).into_owned();
4256 let buffer_file = File::from_dyn(buffer_file.as_ref());
4257
4258 let worktree_id = if let Some(file) = buffer_file {
4259 let worktree = file.worktree.clone();
4260
4261 if let Some(local) = self.as_local_mut() {
4262 if local.registered_buffers.contains_key(&buffer_id) {
4263 local.register_buffer_with_language_servers(
4264 buffer_entity,
4265 HashSet::default(),
4266 cx,
4267 );
4268 }
4269 }
4270 Some(worktree.read(cx).id())
4271 } else {
4272 None
4273 };
4274
4275 if settings.prettier.allowed {
4276 if let Some(prettier_plugins) = prettier_store::prettier_plugins_for_language(&settings)
4277 {
4278 let prettier_store = self.as_local().map(|s| s.prettier_store.clone());
4279 if let Some(prettier_store) = prettier_store {
4280 prettier_store.update(cx, |prettier_store, cx| {
4281 prettier_store.install_default_prettier(
4282 worktree_id,
4283 prettier_plugins.iter().map(|s| Arc::from(s.as_str())),
4284 cx,
4285 )
4286 })
4287 }
4288 }
4289 }
4290
4291 cx.emit(LspStoreEvent::LanguageDetected {
4292 buffer: buffer_entity.clone(),
4293 new_language: Some(new_language),
4294 })
4295 }
4296
4297 pub fn buffer_store(&self) -> Entity<BufferStore> {
4298 self.buffer_store.clone()
4299 }
4300
4301 pub fn set_active_entry(&mut self, active_entry: Option<ProjectEntryId>) {
4302 self.active_entry = active_entry;
4303 }
4304
4305 pub(crate) fn send_diagnostic_summaries(&self, worktree: &mut Worktree) {
4306 if let Some((client, downstream_project_id)) = self.downstream_client.clone() {
4307 if let Some(diangostic_summaries) = self.diagnostic_summaries.get(&worktree.id()) {
4308 let mut summaries =
4309 diangostic_summaries
4310 .into_iter()
4311 .flat_map(|(path, summaries)| {
4312 summaries
4313 .into_iter()
4314 .map(|(server_id, summary)| summary.to_proto(*server_id, path))
4315 });
4316 if let Some(summary) = summaries.next() {
4317 client
4318 .send(proto::UpdateDiagnosticSummary {
4319 project_id: downstream_project_id,
4320 worktree_id: worktree.id().to_proto(),
4321 summary: Some(summary),
4322 more_summaries: summaries.collect(),
4323 })
4324 .log_err();
4325 }
4326 }
4327 }
4328 }
4329
4330 // TODO: remove MultiLspQuery: instead, the proto handler should pick appropriate server(s)
4331 // Then, use `send_lsp_proto_request` or analogue for most of the LSP proto requests and inline this check inside
4332 fn is_capable_for_proto_request<R>(
4333 &self,
4334 buffer: &Entity<Buffer>,
4335 request: &R,
4336 cx: &Context<Self>,
4337 ) -> bool
4338 where
4339 R: LspCommand,
4340 {
4341 self.check_if_capable_for_proto_request(
4342 buffer,
4343 |capabilities| {
4344 request.check_capabilities(AdapterServerCapabilities {
4345 server_capabilities: capabilities.clone(),
4346 code_action_kinds: None,
4347 })
4348 },
4349 cx,
4350 )
4351 }
4352
4353 fn check_if_capable_for_proto_request<F>(
4354 &self,
4355 buffer: &Entity<Buffer>,
4356 check: F,
4357 cx: &Context<Self>,
4358 ) -> bool
4359 where
4360 F: Fn(&lsp::ServerCapabilities) -> bool,
4361 {
4362 let Some(language) = buffer.read(cx).language().cloned() else {
4363 return false;
4364 };
4365 let relevant_language_servers = self
4366 .languages
4367 .lsp_adapters(&language.name())
4368 .into_iter()
4369 .map(|lsp_adapter| lsp_adapter.name())
4370 .collect::<HashSet<_>>();
4371 self.language_server_statuses
4372 .iter()
4373 .filter_map(|(server_id, server_status)| {
4374 relevant_language_servers
4375 .contains(&server_status.name)
4376 .then_some(server_id)
4377 })
4378 .filter_map(|server_id| self.lsp_server_capabilities.get(&server_id))
4379 .any(check)
4380 }
4381
4382 pub fn request_lsp<R>(
4383 &mut self,
4384 buffer: Entity<Buffer>,
4385 server: LanguageServerToQuery,
4386 request: R,
4387 cx: &mut Context<Self>,
4388 ) -> Task<Result<R::Response>>
4389 where
4390 R: LspCommand,
4391 <R::LspRequest as lsp::request::Request>::Result: Send,
4392 <R::LspRequest as lsp::request::Request>::Params: Send,
4393 {
4394 if let Some((upstream_client, upstream_project_id)) = self.upstream_client() {
4395 return self.send_lsp_proto_request(
4396 buffer,
4397 upstream_client,
4398 upstream_project_id,
4399 request,
4400 cx,
4401 );
4402 }
4403
4404 let Some(language_server) = buffer.update(cx, |buffer, cx| match server {
4405 LanguageServerToQuery::FirstCapable => self.as_local().and_then(|local| {
4406 local
4407 .language_servers_for_buffer(buffer, cx)
4408 .find(|(_, server)| {
4409 request.check_capabilities(server.adapter_server_capabilities())
4410 })
4411 .map(|(_, server)| server.clone())
4412 }),
4413 LanguageServerToQuery::Other(id) => self
4414 .language_server_for_local_buffer(buffer, id, cx)
4415 .and_then(|(_, server)| {
4416 request
4417 .check_capabilities(server.adapter_server_capabilities())
4418 .then(|| Arc::clone(server))
4419 }),
4420 }) else {
4421 return Task::ready(Ok(Default::default()));
4422 };
4423
4424 let file = File::from_dyn(buffer.read(cx).file()).and_then(File::as_local);
4425
4426 let Some(file) = file else {
4427 return Task::ready(Ok(Default::default()));
4428 };
4429
4430 let lsp_params = match request.to_lsp_params_or_response(
4431 &file.abs_path(cx),
4432 buffer.read(cx),
4433 &language_server,
4434 cx,
4435 ) {
4436 Ok(LspParamsOrResponse::Params(lsp_params)) => lsp_params,
4437 Ok(LspParamsOrResponse::Response(response)) => return Task::ready(Ok(response)),
4438
4439 Err(err) => {
4440 let message = format!(
4441 "{} via {} failed: {}",
4442 request.display_name(),
4443 language_server.name(),
4444 err
4445 );
4446 log::warn!("{message}");
4447 return Task::ready(Err(anyhow!(message)));
4448 }
4449 };
4450
4451 let status = request.status();
4452 if !request.check_capabilities(language_server.adapter_server_capabilities()) {
4453 return Task::ready(Ok(Default::default()));
4454 }
4455 return cx.spawn(async move |this, cx| {
4456 let lsp_request = language_server.request::<R::LspRequest>(lsp_params);
4457
4458 let id = lsp_request.id();
4459 let _cleanup = if status.is_some() {
4460 cx.update(|cx| {
4461 this.update(cx, |this, cx| {
4462 this.on_lsp_work_start(
4463 language_server.server_id(),
4464 id.to_string(),
4465 LanguageServerProgress {
4466 is_disk_based_diagnostics_progress: false,
4467 is_cancellable: false,
4468 title: None,
4469 message: status.clone(),
4470 percentage: None,
4471 last_update_at: cx.background_executor().now(),
4472 },
4473 cx,
4474 );
4475 })
4476 })
4477 .log_err();
4478
4479 Some(defer(|| {
4480 cx.update(|cx| {
4481 this.update(cx, |this, cx| {
4482 this.on_lsp_work_end(language_server.server_id(), id.to_string(), cx);
4483 })
4484 })
4485 .log_err();
4486 }))
4487 } else {
4488 None
4489 };
4490
4491 let result = lsp_request.await.into_response();
4492
4493 let response = result.map_err(|err| {
4494 let message = format!(
4495 "{} via {} failed: {}",
4496 request.display_name(),
4497 language_server.name(),
4498 err
4499 );
4500 log::warn!("{message}");
4501 anyhow::anyhow!(message)
4502 })?;
4503
4504 let response = request
4505 .response_from_lsp(
4506 response,
4507 this.upgrade().context("no app context")?,
4508 buffer,
4509 language_server.server_id(),
4510 cx.clone(),
4511 )
4512 .await;
4513 response
4514 });
4515 }
4516
4517 fn on_settings_changed(&mut self, cx: &mut Context<Self>) {
4518 let mut language_formatters_to_check = Vec::new();
4519 for buffer in self.buffer_store.read(cx).buffers() {
4520 let buffer = buffer.read(cx);
4521 let buffer_file = File::from_dyn(buffer.file());
4522 let buffer_language = buffer.language();
4523 let settings = language_settings(buffer_language.map(|l| l.name()), buffer.file(), cx);
4524 if buffer_language.is_some() {
4525 language_formatters_to_check.push((
4526 buffer_file.map(|f| f.worktree_id(cx)),
4527 settings.into_owned(),
4528 ));
4529 }
4530 }
4531
4532 self.refresh_server_tree(cx);
4533
4534 if let Some(prettier_store) = self.as_local().map(|s| s.prettier_store.clone()) {
4535 prettier_store.update(cx, |prettier_store, cx| {
4536 prettier_store.on_settings_changed(language_formatters_to_check, cx)
4537 })
4538 }
4539
4540 cx.notify();
4541 }
4542
4543 fn refresh_server_tree(&mut self, cx: &mut Context<Self>) {
4544 let buffer_store = self.buffer_store.clone();
4545 if let Some(local) = self.as_local_mut() {
4546 let mut adapters = BTreeMap::default();
4547 let get_adapter = {
4548 let languages = local.languages.clone();
4549 let environment = local.environment.clone();
4550 let weak = local.weak.clone();
4551 let worktree_store = local.worktree_store.clone();
4552 let http_client = local.http_client.clone();
4553 let fs = local.fs.clone();
4554 move |worktree_id, cx: &mut App| {
4555 let worktree = worktree_store.read(cx).worktree_for_id(worktree_id, cx)?;
4556 Some(LocalLspAdapterDelegate::new(
4557 languages.clone(),
4558 &environment,
4559 weak.clone(),
4560 &worktree,
4561 http_client.clone(),
4562 fs.clone(),
4563 cx,
4564 ))
4565 }
4566 };
4567
4568 let mut messages_to_report = Vec::new();
4569 let to_stop = local.lsp_tree.clone().update(cx, |lsp_tree, cx| {
4570 let mut rebase = lsp_tree.rebase();
4571 for buffer_handle in buffer_store.read(cx).buffers().sorted_by_key(|buffer| {
4572 Reverse(
4573 File::from_dyn(buffer.read(cx).file())
4574 .map(|file| file.worktree.read(cx).is_visible()),
4575 )
4576 }) {
4577 let buffer = buffer_handle.read(cx);
4578 let buffer_id = buffer.remote_id();
4579 if !local.registered_buffers.contains_key(&buffer_id) {
4580 continue;
4581 }
4582 if let Some((file, language)) = File::from_dyn(buffer.file())
4583 .cloned()
4584 .zip(buffer.language().map(|l| l.name()))
4585 {
4586 let worktree_id = file.worktree_id(cx);
4587 let Some(worktree) = local
4588 .worktree_store
4589 .read(cx)
4590 .worktree_for_id(worktree_id, cx)
4591 else {
4592 continue;
4593 };
4594
4595 let Some((reused, delegate, nodes)) = local
4596 .reuse_existing_language_server(
4597 rebase.server_tree(),
4598 &worktree,
4599 &language,
4600 cx,
4601 )
4602 .map(|(delegate, servers)| (true, delegate, servers))
4603 .or_else(|| {
4604 let lsp_delegate = adapters
4605 .entry(worktree_id)
4606 .or_insert_with(|| get_adapter(worktree_id, cx))
4607 .clone()?;
4608 let delegate = Arc::new(ManifestQueryDelegate::new(
4609 worktree.read(cx).snapshot(),
4610 ));
4611 let path = file
4612 .path()
4613 .parent()
4614 .map(Arc::from)
4615 .unwrap_or_else(|| file.path().clone());
4616 let worktree_path = ProjectPath { worktree_id, path };
4617
4618 let nodes = rebase.get(
4619 worktree_path,
4620 AdapterQuery::Language(&language),
4621 delegate.clone(),
4622 cx,
4623 );
4624
4625 Some((false, lsp_delegate, nodes.collect()))
4626 })
4627 else {
4628 continue;
4629 };
4630
4631 let abs_path = file.abs_path(cx);
4632 for node in nodes {
4633 if !reused {
4634 let server_id = node.server_id_or_init(
4635 |LaunchDisposition {
4636 server_name,
4637
4638 path,
4639 settings,
4640 }|
4641 {
4642 let uri = Url::from_file_path(
4643 worktree.read(cx).abs_path().join(&path.path),
4644 );
4645 let key = (worktree_id, server_name.clone());
4646 local.language_server_ids.remove(&key);
4647
4648 let adapter = local
4649 .languages
4650 .lsp_adapters(&language)
4651 .into_iter()
4652 .find(|adapter| &adapter.name() == server_name)
4653 .expect("To find LSP adapter");
4654 let server_id = local.start_language_server(
4655 &worktree,
4656 delegate.clone(),
4657 adapter,
4658 settings,
4659 cx,
4660 );
4661 if let Some(state) =
4662 local.language_servers.get(&server_id)
4663 {
4664 if let Ok(uri) = uri {
4665 state.add_workspace_folder(uri);
4666 };
4667 }
4668 server_id
4669 }
4670 );
4671
4672 if let Some(language_server_id) = server_id {
4673 messages_to_report.push(LspStoreEvent::LanguageServerUpdate {
4674 language_server_id,
4675 name: node.name(),
4676 message:
4677 proto::update_language_server::Variant::RegisteredForBuffer(
4678 proto::RegisteredForBuffer {
4679 buffer_abs_path: abs_path.to_string_lossy().to_string(),
4680 buffer_id: buffer_id.to_proto(),
4681 },
4682 ),
4683 });
4684 }
4685 }
4686 }
4687 }
4688 }
4689 rebase.finish()
4690 });
4691 for message in messages_to_report {
4692 cx.emit(message);
4693 }
4694 for (id, _) in to_stop {
4695 self.stop_local_language_server(id, cx).detach();
4696 }
4697 }
4698 }
4699
4700 pub fn apply_code_action(
4701 &self,
4702 buffer_handle: Entity<Buffer>,
4703 mut action: CodeAction,
4704 push_to_history: bool,
4705 cx: &mut Context<Self>,
4706 ) -> Task<Result<ProjectTransaction>> {
4707 if let Some((upstream_client, project_id)) = self.upstream_client() {
4708 let request = proto::ApplyCodeAction {
4709 project_id,
4710 buffer_id: buffer_handle.read(cx).remote_id().into(),
4711 action: Some(Self::serialize_code_action(&action)),
4712 };
4713 let buffer_store = self.buffer_store();
4714 cx.spawn(async move |_, cx| {
4715 let response = upstream_client
4716 .request(request)
4717 .await?
4718 .transaction
4719 .context("missing transaction")?;
4720
4721 buffer_store
4722 .update(cx, |buffer_store, cx| {
4723 buffer_store.deserialize_project_transaction(response, push_to_history, cx)
4724 })?
4725 .await
4726 })
4727 } else if self.mode.is_local() {
4728 let Some((lsp_adapter, lang_server)) = buffer_handle.update(cx, |buffer, cx| {
4729 self.language_server_for_local_buffer(buffer, action.server_id, cx)
4730 .map(|(adapter, server)| (adapter.clone(), server.clone()))
4731 }) else {
4732 return Task::ready(Ok(ProjectTransaction::default()));
4733 };
4734 cx.spawn(async move |this, cx| {
4735 LocalLspStore::try_resolve_code_action(&lang_server, &mut action)
4736 .await
4737 .context("resolving a code action")?;
4738 if let Some(edit) = action.lsp_action.edit() {
4739 if edit.changes.is_some() || edit.document_changes.is_some() {
4740 return LocalLspStore::deserialize_workspace_edit(
4741 this.upgrade().context("no app present")?,
4742 edit.clone(),
4743 push_to_history,
4744 lsp_adapter.clone(),
4745 lang_server.clone(),
4746 cx,
4747 )
4748 .await;
4749 }
4750 }
4751
4752 if let Some(command) = action.lsp_action.command() {
4753 let server_capabilities = lang_server.capabilities();
4754 let available_commands = server_capabilities
4755 .execute_command_provider
4756 .as_ref()
4757 .map(|options| options.commands.as_slice())
4758 .unwrap_or_default();
4759 if available_commands.contains(&command.command) {
4760 this.update(cx, |this, _| {
4761 this.as_local_mut()
4762 .unwrap()
4763 .last_workspace_edits_by_language_server
4764 .remove(&lang_server.server_id());
4765 })?;
4766
4767 let _result = lang_server
4768 .request::<lsp::request::ExecuteCommand>(lsp::ExecuteCommandParams {
4769 command: command.command.clone(),
4770 arguments: command.arguments.clone().unwrap_or_default(),
4771 ..lsp::ExecuteCommandParams::default()
4772 })
4773 .await.into_response()
4774 .context("execute command")?;
4775
4776 return this.update(cx, |this, _| {
4777 this.as_local_mut()
4778 .unwrap()
4779 .last_workspace_edits_by_language_server
4780 .remove(&lang_server.server_id())
4781 .unwrap_or_default()
4782 });
4783 } else {
4784 log::warn!("Cannot execute a command {} not listed in the language server capabilities", command.command);
4785 }
4786 }
4787
4788 Ok(ProjectTransaction::default())
4789 })
4790 } else {
4791 Task::ready(Err(anyhow!("no upstream client and not local")))
4792 }
4793 }
4794
4795 pub fn apply_code_action_kind(
4796 &mut self,
4797 buffers: HashSet<Entity<Buffer>>,
4798 kind: CodeActionKind,
4799 push_to_history: bool,
4800 cx: &mut Context<Self>,
4801 ) -> Task<anyhow::Result<ProjectTransaction>> {
4802 if let Some(_) = self.as_local() {
4803 cx.spawn(async move |lsp_store, cx| {
4804 let buffers = buffers.into_iter().collect::<Vec<_>>();
4805 let result = LocalLspStore::execute_code_action_kind_locally(
4806 lsp_store.clone(),
4807 buffers,
4808 kind,
4809 push_to_history,
4810 cx,
4811 )
4812 .await;
4813 lsp_store.update(cx, |lsp_store, _| {
4814 lsp_store.update_last_formatting_failure(&result);
4815 })?;
4816 result
4817 })
4818 } else if let Some((client, project_id)) = self.upstream_client() {
4819 let buffer_store = self.buffer_store();
4820 cx.spawn(async move |lsp_store, cx| {
4821 let result = client
4822 .request(proto::ApplyCodeActionKind {
4823 project_id,
4824 kind: kind.as_str().to_owned(),
4825 buffer_ids: buffers
4826 .iter()
4827 .map(|buffer| {
4828 buffer.read_with(cx, |buffer, _| buffer.remote_id().into())
4829 })
4830 .collect::<Result<_>>()?,
4831 })
4832 .await
4833 .and_then(|result| result.transaction.context("missing transaction"));
4834 lsp_store.update(cx, |lsp_store, _| {
4835 lsp_store.update_last_formatting_failure(&result);
4836 })?;
4837
4838 let transaction_response = result?;
4839 buffer_store
4840 .update(cx, |buffer_store, cx| {
4841 buffer_store.deserialize_project_transaction(
4842 transaction_response,
4843 push_to_history,
4844 cx,
4845 )
4846 })?
4847 .await
4848 })
4849 } else {
4850 Task::ready(Ok(ProjectTransaction::default()))
4851 }
4852 }
4853
4854 pub fn resolve_inlay_hint(
4855 &self,
4856 mut hint: InlayHint,
4857 buffer: Entity<Buffer>,
4858 server_id: LanguageServerId,
4859 cx: &mut Context<Self>,
4860 ) -> Task<anyhow::Result<InlayHint>> {
4861 if let Some((upstream_client, project_id)) = self.upstream_client() {
4862 if !self.check_if_capable_for_proto_request(&buffer, InlayHints::can_resolve_inlays, cx)
4863 {
4864 hint.resolve_state = ResolveState::Resolved;
4865 return Task::ready(Ok(hint));
4866 }
4867 let request = proto::ResolveInlayHint {
4868 project_id,
4869 buffer_id: buffer.read(cx).remote_id().into(),
4870 language_server_id: server_id.0 as u64,
4871 hint: Some(InlayHints::project_to_proto_hint(hint.clone())),
4872 };
4873 cx.background_spawn(async move {
4874 let response = upstream_client
4875 .request(request)
4876 .await
4877 .context("inlay hints proto request")?;
4878 match response.hint {
4879 Some(resolved_hint) => InlayHints::proto_to_project_hint(resolved_hint)
4880 .context("inlay hints proto resolve response conversion"),
4881 None => Ok(hint),
4882 }
4883 })
4884 } else {
4885 let Some(lang_server) = buffer.update(cx, |buffer, cx| {
4886 self.language_server_for_local_buffer(buffer, server_id, cx)
4887 .map(|(_, server)| server.clone())
4888 }) else {
4889 return Task::ready(Ok(hint));
4890 };
4891 if !InlayHints::can_resolve_inlays(&lang_server.capabilities()) {
4892 return Task::ready(Ok(hint));
4893 }
4894 let buffer_snapshot = buffer.read(cx).snapshot();
4895 cx.spawn(async move |_, cx| {
4896 let resolve_task = lang_server.request::<lsp::request::InlayHintResolveRequest>(
4897 InlayHints::project_to_lsp_hint(hint, &buffer_snapshot),
4898 );
4899 let resolved_hint = resolve_task
4900 .await
4901 .into_response()
4902 .context("inlay hint resolve LSP request")?;
4903 let resolved_hint = InlayHints::lsp_to_project_hint(
4904 resolved_hint,
4905 &buffer,
4906 server_id,
4907 ResolveState::Resolved,
4908 false,
4909 cx,
4910 )
4911 .await?;
4912 Ok(resolved_hint)
4913 })
4914 }
4915 }
4916
4917 pub fn resolve_color_presentation(
4918 &mut self,
4919 mut color: DocumentColor,
4920 buffer: Entity<Buffer>,
4921 server_id: LanguageServerId,
4922 cx: &mut Context<Self>,
4923 ) -> Task<Result<DocumentColor>> {
4924 if color.resolved {
4925 return Task::ready(Ok(color));
4926 }
4927
4928 if let Some((upstream_client, project_id)) = self.upstream_client() {
4929 let start = color.lsp_range.start;
4930 let end = color.lsp_range.end;
4931 let request = proto::GetColorPresentation {
4932 project_id,
4933 server_id: server_id.to_proto(),
4934 buffer_id: buffer.read(cx).remote_id().into(),
4935 color: Some(proto::ColorInformation {
4936 red: color.color.red,
4937 green: color.color.green,
4938 blue: color.color.blue,
4939 alpha: color.color.alpha,
4940 lsp_range_start: Some(proto::PointUtf16 {
4941 row: start.line,
4942 column: start.character,
4943 }),
4944 lsp_range_end: Some(proto::PointUtf16 {
4945 row: end.line,
4946 column: end.character,
4947 }),
4948 }),
4949 };
4950 cx.background_spawn(async move {
4951 let response = upstream_client
4952 .request(request)
4953 .await
4954 .context("color presentation proto request")?;
4955 color.resolved = true;
4956 color.color_presentations = response
4957 .presentations
4958 .into_iter()
4959 .map(|presentation| ColorPresentation {
4960 label: SharedString::from(presentation.label),
4961 text_edit: presentation.text_edit.and_then(deserialize_lsp_edit),
4962 additional_text_edits: presentation
4963 .additional_text_edits
4964 .into_iter()
4965 .filter_map(deserialize_lsp_edit)
4966 .collect(),
4967 })
4968 .collect();
4969 Ok(color)
4970 })
4971 } else {
4972 let path = match buffer
4973 .update(cx, |buffer, cx| {
4974 Some(File::from_dyn(buffer.file())?.abs_path(cx))
4975 })
4976 .context("buffer with the missing path")
4977 {
4978 Ok(path) => path,
4979 Err(e) => return Task::ready(Err(e)),
4980 };
4981 let Some(lang_server) = buffer.update(cx, |buffer, cx| {
4982 self.language_server_for_local_buffer(buffer, server_id, cx)
4983 .map(|(_, server)| server.clone())
4984 }) else {
4985 return Task::ready(Ok(color));
4986 };
4987 cx.background_spawn(async move {
4988 let resolve_task = lang_server.request::<lsp::request::ColorPresentationRequest>(
4989 lsp::ColorPresentationParams {
4990 text_document: make_text_document_identifier(&path)?,
4991 color: color.color,
4992 range: color.lsp_range,
4993 work_done_progress_params: Default::default(),
4994 partial_result_params: Default::default(),
4995 },
4996 );
4997 color.color_presentations = resolve_task
4998 .await
4999 .into_response()
5000 .context("color presentation resolve LSP request")?
5001 .into_iter()
5002 .map(|presentation| ColorPresentation {
5003 label: SharedString::from(presentation.label),
5004 text_edit: presentation.text_edit,
5005 additional_text_edits: presentation
5006 .additional_text_edits
5007 .unwrap_or_default(),
5008 })
5009 .collect();
5010 color.resolved = true;
5011 Ok(color)
5012 })
5013 }
5014 }
5015
5016 pub(crate) fn linked_edits(
5017 &mut self,
5018 buffer: &Entity<Buffer>,
5019 position: Anchor,
5020 cx: &mut Context<Self>,
5021 ) -> Task<Result<Vec<Range<Anchor>>>> {
5022 let snapshot = buffer.read(cx).snapshot();
5023 let scope = snapshot.language_scope_at(position);
5024 let Some(server_id) = self
5025 .as_local()
5026 .and_then(|local| {
5027 buffer.update(cx, |buffer, cx| {
5028 local
5029 .language_servers_for_buffer(buffer, cx)
5030 .filter(|(_, server)| {
5031 LinkedEditingRange::check_server_capabilities(server.capabilities())
5032 })
5033 .filter(|(adapter, _)| {
5034 scope
5035 .as_ref()
5036 .map(|scope| scope.language_allowed(&adapter.name))
5037 .unwrap_or(true)
5038 })
5039 .map(|(_, server)| LanguageServerToQuery::Other(server.server_id()))
5040 .next()
5041 })
5042 })
5043 .or_else(|| {
5044 self.upstream_client()
5045 .is_some()
5046 .then_some(LanguageServerToQuery::FirstCapable)
5047 })
5048 .filter(|_| {
5049 maybe!({
5050 let language = buffer.read(cx).language_at(position)?;
5051 Some(
5052 language_settings(Some(language.name()), buffer.read(cx).file(), cx)
5053 .linked_edits,
5054 )
5055 }) == Some(true)
5056 })
5057 else {
5058 return Task::ready(Ok(Vec::new()));
5059 };
5060
5061 self.request_lsp(
5062 buffer.clone(),
5063 server_id,
5064 LinkedEditingRange { position },
5065 cx,
5066 )
5067 }
5068
5069 fn apply_on_type_formatting(
5070 &mut self,
5071 buffer: Entity<Buffer>,
5072 position: Anchor,
5073 trigger: String,
5074 cx: &mut Context<Self>,
5075 ) -> Task<Result<Option<Transaction>>> {
5076 if let Some((client, project_id)) = self.upstream_client() {
5077 if !self.check_if_capable_for_proto_request(
5078 &buffer,
5079 |capabilities| {
5080 OnTypeFormatting::supports_on_type_formatting(&trigger, capabilities)
5081 },
5082 cx,
5083 ) {
5084 return Task::ready(Ok(None));
5085 }
5086 let request = proto::OnTypeFormatting {
5087 project_id,
5088 buffer_id: buffer.read(cx).remote_id().into(),
5089 position: Some(serialize_anchor(&position)),
5090 trigger,
5091 version: serialize_version(&buffer.read(cx).version()),
5092 };
5093 cx.background_spawn(async move {
5094 client
5095 .request(request)
5096 .await?
5097 .transaction
5098 .map(language::proto::deserialize_transaction)
5099 .transpose()
5100 })
5101 } else if let Some(local) = self.as_local_mut() {
5102 let buffer_id = buffer.read(cx).remote_id();
5103 local.buffers_being_formatted.insert(buffer_id);
5104 cx.spawn(async move |this, cx| {
5105 let _cleanup = defer({
5106 let this = this.clone();
5107 let mut cx = cx.clone();
5108 move || {
5109 this.update(&mut cx, |this, _| {
5110 if let Some(local) = this.as_local_mut() {
5111 local.buffers_being_formatted.remove(&buffer_id);
5112 }
5113 })
5114 .ok();
5115 }
5116 });
5117
5118 buffer
5119 .update(cx, |buffer, _| {
5120 buffer.wait_for_edits(Some(position.timestamp))
5121 })?
5122 .await?;
5123 this.update(cx, |this, cx| {
5124 let position = position.to_point_utf16(buffer.read(cx));
5125 this.on_type_format(buffer, position, trigger, false, cx)
5126 })?
5127 .await
5128 })
5129 } else {
5130 Task::ready(Err(anyhow!("No upstream client or local language server")))
5131 }
5132 }
5133
5134 pub fn on_type_format<T: ToPointUtf16>(
5135 &mut self,
5136 buffer: Entity<Buffer>,
5137 position: T,
5138 trigger: String,
5139 push_to_history: bool,
5140 cx: &mut Context<Self>,
5141 ) -> Task<Result<Option<Transaction>>> {
5142 let position = position.to_point_utf16(buffer.read(cx));
5143 self.on_type_format_impl(buffer, position, trigger, push_to_history, cx)
5144 }
5145
5146 fn on_type_format_impl(
5147 &mut self,
5148 buffer: Entity<Buffer>,
5149 position: PointUtf16,
5150 trigger: String,
5151 push_to_history: bool,
5152 cx: &mut Context<Self>,
5153 ) -> Task<Result<Option<Transaction>>> {
5154 let options = buffer.update(cx, |buffer, cx| {
5155 lsp_command::lsp_formatting_options(
5156 language_settings(
5157 buffer.language_at(position).map(|l| l.name()),
5158 buffer.file(),
5159 cx,
5160 )
5161 .as_ref(),
5162 )
5163 });
5164
5165 cx.spawn(async move |this, cx| {
5166 if let Some(waiter) =
5167 buffer.update(cx, |buffer, _| buffer.wait_for_autoindent_applied())?
5168 {
5169 waiter.await?;
5170 }
5171 cx.update(|cx| {
5172 this.update(cx, |this, cx| {
5173 this.request_lsp(
5174 buffer.clone(),
5175 LanguageServerToQuery::FirstCapable,
5176 OnTypeFormatting {
5177 position,
5178 trigger,
5179 options,
5180 push_to_history,
5181 },
5182 cx,
5183 )
5184 })
5185 })??
5186 .await
5187 })
5188 }
5189
5190 pub fn definitions(
5191 &mut self,
5192 buffer_handle: &Entity<Buffer>,
5193 position: PointUtf16,
5194 cx: &mut Context<Self>,
5195 ) -> Task<Result<Vec<LocationLink>>> {
5196 if let Some((upstream_client, project_id)) = self.upstream_client() {
5197 let request = GetDefinitions { position };
5198 if !self.is_capable_for_proto_request(buffer_handle, &request, cx) {
5199 return Task::ready(Ok(Vec::new()));
5200 }
5201 let request_task = upstream_client.request(proto::MultiLspQuery {
5202 buffer_id: buffer_handle.read(cx).remote_id().into(),
5203 version: serialize_version(&buffer_handle.read(cx).version()),
5204 project_id,
5205 strategy: Some(proto::multi_lsp_query::Strategy::All(
5206 proto::AllLanguageServers {},
5207 )),
5208 request: Some(proto::multi_lsp_query::Request::GetDefinition(
5209 request.to_proto(project_id, buffer_handle.read(cx)),
5210 )),
5211 });
5212 let buffer = buffer_handle.clone();
5213 cx.spawn(async move |weak_project, cx| {
5214 let Some(project) = weak_project.upgrade() else {
5215 return Ok(Vec::new());
5216 };
5217 let responses = request_task.await?.responses;
5218 let actions = join_all(
5219 responses
5220 .into_iter()
5221 .filter_map(|lsp_response| match lsp_response.response? {
5222 proto::lsp_response::Response::GetDefinitionResponse(response) => {
5223 Some(response)
5224 }
5225 unexpected => {
5226 debug_panic!("Unexpected response: {unexpected:?}");
5227 None
5228 }
5229 })
5230 .map(|definitions_response| {
5231 GetDefinitions { position }.response_from_proto(
5232 definitions_response,
5233 project.clone(),
5234 buffer.clone(),
5235 cx.clone(),
5236 )
5237 }),
5238 )
5239 .await;
5240
5241 Ok(actions
5242 .into_iter()
5243 .collect::<Result<Vec<Vec<_>>>>()?
5244 .into_iter()
5245 .flatten()
5246 .dedup()
5247 .collect())
5248 })
5249 } else {
5250 let definitions_task = self.request_multiple_lsp_locally(
5251 buffer_handle,
5252 Some(position),
5253 GetDefinitions { position },
5254 cx,
5255 );
5256 cx.background_spawn(async move {
5257 Ok(definitions_task
5258 .await
5259 .into_iter()
5260 .flat_map(|(_, definitions)| definitions)
5261 .dedup()
5262 .collect())
5263 })
5264 }
5265 }
5266
5267 pub fn declarations(
5268 &mut self,
5269 buffer_handle: &Entity<Buffer>,
5270 position: PointUtf16,
5271 cx: &mut Context<Self>,
5272 ) -> Task<Result<Vec<LocationLink>>> {
5273 if let Some((upstream_client, project_id)) = self.upstream_client() {
5274 let request = GetDeclarations { position };
5275 if !self.is_capable_for_proto_request(buffer_handle, &request, cx) {
5276 return Task::ready(Ok(Vec::new()));
5277 }
5278 let request_task = upstream_client.request(proto::MultiLspQuery {
5279 buffer_id: buffer_handle.read(cx).remote_id().into(),
5280 version: serialize_version(&buffer_handle.read(cx).version()),
5281 project_id,
5282 strategy: Some(proto::multi_lsp_query::Strategy::All(
5283 proto::AllLanguageServers {},
5284 )),
5285 request: Some(proto::multi_lsp_query::Request::GetDeclaration(
5286 request.to_proto(project_id, buffer_handle.read(cx)),
5287 )),
5288 });
5289 let buffer = buffer_handle.clone();
5290 cx.spawn(async move |weak_project, cx| {
5291 let Some(project) = weak_project.upgrade() else {
5292 return Ok(Vec::new());
5293 };
5294 let responses = request_task.await?.responses;
5295 let actions = join_all(
5296 responses
5297 .into_iter()
5298 .filter_map(|lsp_response| match lsp_response.response? {
5299 proto::lsp_response::Response::GetDeclarationResponse(response) => {
5300 Some(response)
5301 }
5302 unexpected => {
5303 debug_panic!("Unexpected response: {unexpected:?}");
5304 None
5305 }
5306 })
5307 .map(|declarations_response| {
5308 GetDeclarations { position }.response_from_proto(
5309 declarations_response,
5310 project.clone(),
5311 buffer.clone(),
5312 cx.clone(),
5313 )
5314 }),
5315 )
5316 .await;
5317
5318 Ok(actions
5319 .into_iter()
5320 .collect::<Result<Vec<Vec<_>>>>()?
5321 .into_iter()
5322 .flatten()
5323 .dedup()
5324 .collect())
5325 })
5326 } else {
5327 let declarations_task = self.request_multiple_lsp_locally(
5328 buffer_handle,
5329 Some(position),
5330 GetDeclarations { position },
5331 cx,
5332 );
5333 cx.background_spawn(async move {
5334 Ok(declarations_task
5335 .await
5336 .into_iter()
5337 .flat_map(|(_, declarations)| declarations)
5338 .dedup()
5339 .collect())
5340 })
5341 }
5342 }
5343
5344 pub fn type_definitions(
5345 &mut self,
5346 buffer: &Entity<Buffer>,
5347 position: PointUtf16,
5348 cx: &mut Context<Self>,
5349 ) -> Task<Result<Vec<LocationLink>>> {
5350 if let Some((upstream_client, project_id)) = self.upstream_client() {
5351 let request = GetTypeDefinitions { position };
5352 if !self.is_capable_for_proto_request(&buffer, &request, cx) {
5353 return Task::ready(Ok(Vec::new()));
5354 }
5355 let request_task = upstream_client.request(proto::MultiLspQuery {
5356 buffer_id: buffer.read(cx).remote_id().into(),
5357 version: serialize_version(&buffer.read(cx).version()),
5358 project_id,
5359 strategy: Some(proto::multi_lsp_query::Strategy::All(
5360 proto::AllLanguageServers {},
5361 )),
5362 request: Some(proto::multi_lsp_query::Request::GetTypeDefinition(
5363 request.to_proto(project_id, buffer.read(cx)),
5364 )),
5365 });
5366 let buffer = buffer.clone();
5367 cx.spawn(async move |weak_project, cx| {
5368 let Some(project) = weak_project.upgrade() else {
5369 return Ok(Vec::new());
5370 };
5371 let responses = request_task.await?.responses;
5372 let actions = join_all(
5373 responses
5374 .into_iter()
5375 .filter_map(|lsp_response| match lsp_response.response? {
5376 proto::lsp_response::Response::GetTypeDefinitionResponse(response) => {
5377 Some(response)
5378 }
5379 unexpected => {
5380 debug_panic!("Unexpected response: {unexpected:?}");
5381 None
5382 }
5383 })
5384 .map(|type_definitions_response| {
5385 GetTypeDefinitions { position }.response_from_proto(
5386 type_definitions_response,
5387 project.clone(),
5388 buffer.clone(),
5389 cx.clone(),
5390 )
5391 }),
5392 )
5393 .await;
5394
5395 Ok(actions
5396 .into_iter()
5397 .collect::<Result<Vec<Vec<_>>>>()?
5398 .into_iter()
5399 .flatten()
5400 .dedup()
5401 .collect())
5402 })
5403 } else {
5404 let type_definitions_task = self.request_multiple_lsp_locally(
5405 buffer,
5406 Some(position),
5407 GetTypeDefinitions { position },
5408 cx,
5409 );
5410 cx.background_spawn(async move {
5411 Ok(type_definitions_task
5412 .await
5413 .into_iter()
5414 .flat_map(|(_, type_definitions)| type_definitions)
5415 .dedup()
5416 .collect())
5417 })
5418 }
5419 }
5420
5421 pub fn implementations(
5422 &mut self,
5423 buffer: &Entity<Buffer>,
5424 position: PointUtf16,
5425 cx: &mut Context<Self>,
5426 ) -> Task<Result<Vec<LocationLink>>> {
5427 if let Some((upstream_client, project_id)) = self.upstream_client() {
5428 let request = GetImplementations { position };
5429 if !self.is_capable_for_proto_request(buffer, &request, cx) {
5430 return Task::ready(Ok(Vec::new()));
5431 }
5432 let request_task = upstream_client.request(proto::MultiLspQuery {
5433 buffer_id: buffer.read(cx).remote_id().into(),
5434 version: serialize_version(&buffer.read(cx).version()),
5435 project_id,
5436 strategy: Some(proto::multi_lsp_query::Strategy::All(
5437 proto::AllLanguageServers {},
5438 )),
5439 request: Some(proto::multi_lsp_query::Request::GetImplementation(
5440 request.to_proto(project_id, buffer.read(cx)),
5441 )),
5442 });
5443 let buffer = buffer.clone();
5444 cx.spawn(async move |weak_project, cx| {
5445 let Some(project) = weak_project.upgrade() else {
5446 return Ok(Vec::new());
5447 };
5448 let responses = request_task.await?.responses;
5449 let actions = join_all(
5450 responses
5451 .into_iter()
5452 .filter_map(|lsp_response| match lsp_response.response? {
5453 proto::lsp_response::Response::GetImplementationResponse(response) => {
5454 Some(response)
5455 }
5456 unexpected => {
5457 debug_panic!("Unexpected response: {unexpected:?}");
5458 None
5459 }
5460 })
5461 .map(|implementations_response| {
5462 GetImplementations { position }.response_from_proto(
5463 implementations_response,
5464 project.clone(),
5465 buffer.clone(),
5466 cx.clone(),
5467 )
5468 }),
5469 )
5470 .await;
5471
5472 Ok(actions
5473 .into_iter()
5474 .collect::<Result<Vec<Vec<_>>>>()?
5475 .into_iter()
5476 .flatten()
5477 .dedup()
5478 .collect())
5479 })
5480 } else {
5481 let implementations_task = self.request_multiple_lsp_locally(
5482 buffer,
5483 Some(position),
5484 GetImplementations { position },
5485 cx,
5486 );
5487 cx.background_spawn(async move {
5488 Ok(implementations_task
5489 .await
5490 .into_iter()
5491 .flat_map(|(_, implementations)| implementations)
5492 .dedup()
5493 .collect())
5494 })
5495 }
5496 }
5497
5498 pub fn references(
5499 &mut self,
5500 buffer: &Entity<Buffer>,
5501 position: PointUtf16,
5502 cx: &mut Context<Self>,
5503 ) -> Task<Result<Vec<Location>>> {
5504 if let Some((upstream_client, project_id)) = self.upstream_client() {
5505 let request = GetReferences { position };
5506 if !self.is_capable_for_proto_request(&buffer, &request, cx) {
5507 return Task::ready(Ok(Vec::new()));
5508 }
5509 let request_task = upstream_client.request(proto::MultiLspQuery {
5510 buffer_id: buffer.read(cx).remote_id().into(),
5511 version: serialize_version(&buffer.read(cx).version()),
5512 project_id,
5513 strategy: Some(proto::multi_lsp_query::Strategy::All(
5514 proto::AllLanguageServers {},
5515 )),
5516 request: Some(proto::multi_lsp_query::Request::GetReferences(
5517 request.to_proto(project_id, buffer.read(cx)),
5518 )),
5519 });
5520 let buffer = buffer.clone();
5521 cx.spawn(async move |weak_project, cx| {
5522 let Some(project) = weak_project.upgrade() else {
5523 return Ok(Vec::new());
5524 };
5525 let responses = request_task.await?.responses;
5526 let actions = join_all(
5527 responses
5528 .into_iter()
5529 .filter_map(|lsp_response| match lsp_response.response? {
5530 proto::lsp_response::Response::GetReferencesResponse(response) => {
5531 Some(response)
5532 }
5533 unexpected => {
5534 debug_panic!("Unexpected response: {unexpected:?}");
5535 None
5536 }
5537 })
5538 .map(|references_response| {
5539 GetReferences { position }.response_from_proto(
5540 references_response,
5541 project.clone(),
5542 buffer.clone(),
5543 cx.clone(),
5544 )
5545 }),
5546 )
5547 .await;
5548
5549 Ok(actions
5550 .into_iter()
5551 .collect::<Result<Vec<Vec<_>>>>()?
5552 .into_iter()
5553 .flatten()
5554 .dedup()
5555 .collect())
5556 })
5557 } else {
5558 let references_task = self.request_multiple_lsp_locally(
5559 buffer,
5560 Some(position),
5561 GetReferences { position },
5562 cx,
5563 );
5564 cx.background_spawn(async move {
5565 Ok(references_task
5566 .await
5567 .into_iter()
5568 .flat_map(|(_, references)| references)
5569 .dedup()
5570 .collect())
5571 })
5572 }
5573 }
5574
5575 pub fn code_actions(
5576 &mut self,
5577 buffer: &Entity<Buffer>,
5578 range: Range<Anchor>,
5579 kinds: Option<Vec<CodeActionKind>>,
5580 cx: &mut Context<Self>,
5581 ) -> Task<Result<Vec<CodeAction>>> {
5582 if let Some((upstream_client, project_id)) = self.upstream_client() {
5583 let request = GetCodeActions {
5584 range: range.clone(),
5585 kinds: kinds.clone(),
5586 };
5587 if !self.is_capable_for_proto_request(buffer, &request, cx) {
5588 return Task::ready(Ok(Vec::new()));
5589 }
5590 let request_task = upstream_client.request(proto::MultiLspQuery {
5591 buffer_id: buffer.read(cx).remote_id().into(),
5592 version: serialize_version(&buffer.read(cx).version()),
5593 project_id,
5594 strategy: Some(proto::multi_lsp_query::Strategy::All(
5595 proto::AllLanguageServers {},
5596 )),
5597 request: Some(proto::multi_lsp_query::Request::GetCodeActions(
5598 request.to_proto(project_id, buffer.read(cx)),
5599 )),
5600 });
5601 let buffer = buffer.clone();
5602 cx.spawn(async move |weak_project, cx| {
5603 let Some(project) = weak_project.upgrade() else {
5604 return Ok(Vec::new());
5605 };
5606 let responses = request_task.await?.responses;
5607 let actions = join_all(
5608 responses
5609 .into_iter()
5610 .filter_map(|lsp_response| match lsp_response.response? {
5611 proto::lsp_response::Response::GetCodeActionsResponse(response) => {
5612 Some(response)
5613 }
5614 unexpected => {
5615 debug_panic!("Unexpected response: {unexpected:?}");
5616 None
5617 }
5618 })
5619 .map(|code_actions_response| {
5620 GetCodeActions {
5621 range: range.clone(),
5622 kinds: kinds.clone(),
5623 }
5624 .response_from_proto(
5625 code_actions_response,
5626 project.clone(),
5627 buffer.clone(),
5628 cx.clone(),
5629 )
5630 }),
5631 )
5632 .await;
5633
5634 Ok(actions
5635 .into_iter()
5636 .collect::<Result<Vec<Vec<_>>>>()?
5637 .into_iter()
5638 .flatten()
5639 .collect())
5640 })
5641 } else {
5642 let all_actions_task = self.request_multiple_lsp_locally(
5643 buffer,
5644 Some(range.start),
5645 GetCodeActions {
5646 range: range.clone(),
5647 kinds: kinds.clone(),
5648 },
5649 cx,
5650 );
5651 cx.background_spawn(async move {
5652 Ok(all_actions_task
5653 .await
5654 .into_iter()
5655 .flat_map(|(_, actions)| actions)
5656 .collect())
5657 })
5658 }
5659 }
5660
5661 pub fn code_lens_actions(
5662 &mut self,
5663 buffer: &Entity<Buffer>,
5664 cx: &mut Context<Self>,
5665 ) -> CodeLensTask {
5666 let version_queried_for = buffer.read(cx).version();
5667 let buffer_id = buffer.read(cx).remote_id();
5668
5669 if let Some(cached_data) = self.lsp_code_lens.get(&buffer_id) {
5670 if !version_queried_for.changed_since(&cached_data.lens_for_version) {
5671 let has_different_servers = self.as_local().is_some_and(|local| {
5672 local
5673 .buffers_opened_in_servers
5674 .get(&buffer_id)
5675 .cloned()
5676 .unwrap_or_default()
5677 != cached_data.lens.keys().copied().collect()
5678 });
5679 if !has_different_servers {
5680 return Task::ready(Ok(cached_data.lens.values().flatten().cloned().collect()))
5681 .shared();
5682 }
5683 }
5684 }
5685
5686 let lsp_data = self.lsp_code_lens.entry(buffer_id).or_default();
5687 if let Some((updating_for, running_update)) = &lsp_data.update {
5688 if !version_queried_for.changed_since(&updating_for) {
5689 return running_update.clone();
5690 }
5691 }
5692 let buffer = buffer.clone();
5693 let query_version_queried_for = version_queried_for.clone();
5694 let new_task = cx
5695 .spawn(async move |lsp_store, cx| {
5696 cx.background_executor()
5697 .timer(Duration::from_millis(30))
5698 .await;
5699 let fetched_lens = lsp_store
5700 .update(cx, |lsp_store, cx| lsp_store.fetch_code_lens(&buffer, cx))
5701 .map_err(Arc::new)?
5702 .await
5703 .context("fetching code lens")
5704 .map_err(Arc::new);
5705 let fetched_lens = match fetched_lens {
5706 Ok(fetched_lens) => fetched_lens,
5707 Err(e) => {
5708 lsp_store
5709 .update(cx, |lsp_store, _| {
5710 lsp_store.lsp_code_lens.entry(buffer_id).or_default().update = None;
5711 })
5712 .ok();
5713 return Err(e);
5714 }
5715 };
5716
5717 lsp_store
5718 .update(cx, |lsp_store, _| {
5719 let lsp_data = lsp_store.lsp_code_lens.entry(buffer_id).or_default();
5720 if lsp_data.lens_for_version == query_version_queried_for {
5721 lsp_data.lens.extend(fetched_lens.clone());
5722 } else if !lsp_data
5723 .lens_for_version
5724 .changed_since(&query_version_queried_for)
5725 {
5726 lsp_data.lens_for_version = query_version_queried_for;
5727 lsp_data.lens = fetched_lens.clone();
5728 }
5729 lsp_data.update = None;
5730 lsp_data.lens.values().flatten().cloned().collect()
5731 })
5732 .map_err(Arc::new)
5733 })
5734 .shared();
5735 lsp_data.update = Some((version_queried_for, new_task.clone()));
5736 new_task
5737 }
5738
5739 fn fetch_code_lens(
5740 &mut self,
5741 buffer: &Entity<Buffer>,
5742 cx: &mut Context<Self>,
5743 ) -> Task<Result<HashMap<LanguageServerId, Vec<CodeAction>>>> {
5744 if let Some((upstream_client, project_id)) = self.upstream_client() {
5745 let request = GetCodeLens;
5746 if !self.is_capable_for_proto_request(buffer, &request, cx) {
5747 return Task::ready(Ok(HashMap::default()));
5748 }
5749 let request_task = upstream_client.request(proto::MultiLspQuery {
5750 buffer_id: buffer.read(cx).remote_id().into(),
5751 version: serialize_version(&buffer.read(cx).version()),
5752 project_id,
5753 strategy: Some(proto::multi_lsp_query::Strategy::All(
5754 proto::AllLanguageServers {},
5755 )),
5756 request: Some(proto::multi_lsp_query::Request::GetCodeLens(
5757 request.to_proto(project_id, buffer.read(cx)),
5758 )),
5759 });
5760 let buffer = buffer.clone();
5761 cx.spawn(async move |weak_lsp_store, cx| {
5762 let Some(lsp_store) = weak_lsp_store.upgrade() else {
5763 return Ok(HashMap::default());
5764 };
5765 let responses = request_task.await?.responses;
5766 let code_lens_actions = join_all(
5767 responses
5768 .into_iter()
5769 .filter_map(|lsp_response| {
5770 let response = match lsp_response.response? {
5771 proto::lsp_response::Response::GetCodeLensResponse(response) => {
5772 Some(response)
5773 }
5774 unexpected => {
5775 debug_panic!("Unexpected response: {unexpected:?}");
5776 None
5777 }
5778 }?;
5779 let server_id = LanguageServerId::from_proto(lsp_response.server_id);
5780 Some((server_id, response))
5781 })
5782 .map(|(server_id, code_lens_response)| {
5783 let lsp_store = lsp_store.clone();
5784 let buffer = buffer.clone();
5785 let cx = cx.clone();
5786 async move {
5787 (
5788 server_id,
5789 GetCodeLens
5790 .response_from_proto(
5791 code_lens_response,
5792 lsp_store,
5793 buffer,
5794 cx,
5795 )
5796 .await,
5797 )
5798 }
5799 }),
5800 )
5801 .await;
5802
5803 let mut has_errors = false;
5804 let code_lens_actions = code_lens_actions
5805 .into_iter()
5806 .filter_map(|(server_id, code_lens)| match code_lens {
5807 Ok(code_lens) => Some((server_id, code_lens)),
5808 Err(e) => {
5809 has_errors = true;
5810 log::error!("{e:#}");
5811 None
5812 }
5813 })
5814 .collect::<HashMap<_, _>>();
5815 anyhow::ensure!(
5816 !has_errors || !code_lens_actions.is_empty(),
5817 "Failed to fetch code lens"
5818 );
5819 Ok(code_lens_actions)
5820 })
5821 } else {
5822 let code_lens_actions_task =
5823 self.request_multiple_lsp_locally(buffer, None::<usize>, GetCodeLens, cx);
5824 cx.background_spawn(
5825 async move { Ok(code_lens_actions_task.await.into_iter().collect()) },
5826 )
5827 }
5828 }
5829
5830 #[inline(never)]
5831 pub fn completions(
5832 &self,
5833 buffer: &Entity<Buffer>,
5834 position: PointUtf16,
5835 context: CompletionContext,
5836 cx: &mut Context<Self>,
5837 ) -> Task<Result<Vec<CompletionResponse>>> {
5838 let language_registry = self.languages.clone();
5839
5840 if let Some((upstream_client, project_id)) = self.upstream_client() {
5841 let request = GetCompletions { position, context };
5842 if !self.is_capable_for_proto_request(buffer, &request, cx) {
5843 return Task::ready(Ok(Vec::new()));
5844 }
5845 let task = self.send_lsp_proto_request(
5846 buffer.clone(),
5847 upstream_client,
5848 project_id,
5849 request,
5850 cx,
5851 );
5852 let language = buffer.read(cx).language().cloned();
5853
5854 // In the future, we should provide project guests with the names of LSP adapters,
5855 // so that they can use the correct LSP adapter when computing labels. For now,
5856 // guests just use the first LSP adapter associated with the buffer's language.
5857 let lsp_adapter = language.as_ref().and_then(|language| {
5858 language_registry
5859 .lsp_adapters(&language.name())
5860 .first()
5861 .cloned()
5862 });
5863
5864 cx.foreground_executor().spawn(async move {
5865 let completion_response = task.await?;
5866 let completions = populate_labels_for_completions(
5867 completion_response.completions,
5868 language,
5869 lsp_adapter,
5870 )
5871 .await;
5872 Ok(vec![CompletionResponse {
5873 completions,
5874 is_incomplete: completion_response.is_incomplete,
5875 }])
5876 })
5877 } else if let Some(local) = self.as_local() {
5878 let snapshot = buffer.read(cx).snapshot();
5879 let offset = position.to_offset(&snapshot);
5880 let scope = snapshot.language_scope_at(offset);
5881 let language = snapshot.language().cloned();
5882 let completion_settings = language_settings(
5883 language.as_ref().map(|language| language.name()),
5884 buffer.read(cx).file(),
5885 cx,
5886 )
5887 .completions;
5888 if !completion_settings.lsp {
5889 return Task::ready(Ok(Vec::new()));
5890 }
5891
5892 let server_ids: Vec<_> = buffer.update(cx, |buffer, cx| {
5893 local
5894 .language_servers_for_buffer(buffer, cx)
5895 .filter(|(_, server)| server.capabilities().completion_provider.is_some())
5896 .filter(|(adapter, _)| {
5897 scope
5898 .as_ref()
5899 .map(|scope| scope.language_allowed(&adapter.name))
5900 .unwrap_or(true)
5901 })
5902 .map(|(_, server)| server.server_id())
5903 .collect()
5904 });
5905
5906 let buffer = buffer.clone();
5907 let lsp_timeout = completion_settings.lsp_fetch_timeout_ms;
5908 let lsp_timeout = if lsp_timeout > 0 {
5909 Some(Duration::from_millis(lsp_timeout))
5910 } else {
5911 None
5912 };
5913 cx.spawn(async move |this, cx| {
5914 let mut tasks = Vec::with_capacity(server_ids.len());
5915 this.update(cx, |lsp_store, cx| {
5916 for server_id in server_ids {
5917 let lsp_adapter = lsp_store.language_server_adapter_for_id(server_id);
5918 let lsp_timeout = lsp_timeout
5919 .map(|lsp_timeout| cx.background_executor().timer(lsp_timeout));
5920 let mut timeout = cx.background_spawn(async move {
5921 match lsp_timeout {
5922 Some(lsp_timeout) => {
5923 lsp_timeout.await;
5924 true
5925 },
5926 None => false,
5927 }
5928 }).fuse();
5929 let mut lsp_request = lsp_store.request_lsp(
5930 buffer.clone(),
5931 LanguageServerToQuery::Other(server_id),
5932 GetCompletions {
5933 position,
5934 context: context.clone(),
5935 },
5936 cx,
5937 ).fuse();
5938 let new_task = cx.background_spawn(async move {
5939 select_biased! {
5940 response = lsp_request => anyhow::Ok(Some(response?)),
5941 timeout_happened = timeout => {
5942 if timeout_happened {
5943 log::warn!("Fetching completions from server {server_id} timed out, timeout ms: {}", completion_settings.lsp_fetch_timeout_ms);
5944 Ok(None)
5945 } else {
5946 let completions = lsp_request.await?;
5947 Ok(Some(completions))
5948 }
5949 },
5950 }
5951 });
5952 tasks.push((lsp_adapter, new_task));
5953 }
5954 })?;
5955
5956 let futures = tasks.into_iter().map(async |(lsp_adapter, task)| {
5957 let completion_response = task.await.ok()??;
5958 let completions = populate_labels_for_completions(
5959 completion_response.completions,
5960 language.clone(),
5961 lsp_adapter,
5962 )
5963 .await;
5964 Some(CompletionResponse {
5965 completions,
5966 is_incomplete: completion_response.is_incomplete,
5967 })
5968 });
5969
5970 let responses: Vec<Option<CompletionResponse>> = join_all(futures).await;
5971
5972 Ok(responses.into_iter().flatten().collect())
5973 })
5974 } else {
5975 Task::ready(Err(anyhow!("No upstream client or local language server")))
5976 }
5977 }
5978
5979 pub fn resolve_completions(
5980 &self,
5981 buffer: Entity<Buffer>,
5982 completion_indices: Vec<usize>,
5983 completions: Rc<RefCell<Box<[Completion]>>>,
5984 cx: &mut Context<Self>,
5985 ) -> Task<Result<bool>> {
5986 let client = self.upstream_client();
5987 let buffer_id = buffer.read(cx).remote_id();
5988 let buffer_snapshot = buffer.read(cx).snapshot();
5989
5990 if !self.check_if_capable_for_proto_request(
5991 &buffer,
5992 GetCompletions::can_resolve_completions,
5993 cx,
5994 ) {
5995 return Task::ready(Ok(false));
5996 }
5997 cx.spawn(async move |lsp_store, cx| {
5998 let mut did_resolve = false;
5999 if let Some((client, project_id)) = client {
6000 for completion_index in completion_indices {
6001 let server_id = {
6002 let completion = &completions.borrow()[completion_index];
6003 completion.source.server_id()
6004 };
6005 if let Some(server_id) = server_id {
6006 if Self::resolve_completion_remote(
6007 project_id,
6008 server_id,
6009 buffer_id,
6010 completions.clone(),
6011 completion_index,
6012 client.clone(),
6013 )
6014 .await
6015 .log_err()
6016 .is_some()
6017 {
6018 did_resolve = true;
6019 }
6020 } else {
6021 resolve_word_completion(
6022 &buffer_snapshot,
6023 &mut completions.borrow_mut()[completion_index],
6024 );
6025 }
6026 }
6027 } else {
6028 for completion_index in completion_indices {
6029 let server_id = {
6030 let completion = &completions.borrow()[completion_index];
6031 completion.source.server_id()
6032 };
6033 if let Some(server_id) = server_id {
6034 let server_and_adapter = lsp_store
6035 .read_with(cx, |lsp_store, _| {
6036 let server = lsp_store.language_server_for_id(server_id)?;
6037 let adapter =
6038 lsp_store.language_server_adapter_for_id(server.server_id())?;
6039 Some((server, adapter))
6040 })
6041 .ok()
6042 .flatten();
6043 let Some((server, adapter)) = server_and_adapter else {
6044 continue;
6045 };
6046
6047 let resolved = Self::resolve_completion_local(
6048 server,
6049 completions.clone(),
6050 completion_index,
6051 )
6052 .await
6053 .log_err()
6054 .is_some();
6055 if resolved {
6056 Self::regenerate_completion_labels(
6057 adapter,
6058 &buffer_snapshot,
6059 completions.clone(),
6060 completion_index,
6061 )
6062 .await
6063 .log_err();
6064 did_resolve = true;
6065 }
6066 } else {
6067 resolve_word_completion(
6068 &buffer_snapshot,
6069 &mut completions.borrow_mut()[completion_index],
6070 );
6071 }
6072 }
6073 }
6074
6075 Ok(did_resolve)
6076 })
6077 }
6078
6079 async fn resolve_completion_local(
6080 server: Arc<lsp::LanguageServer>,
6081 completions: Rc<RefCell<Box<[Completion]>>>,
6082 completion_index: usize,
6083 ) -> Result<()> {
6084 let server_id = server.server_id();
6085 if !GetCompletions::can_resolve_completions(&server.capabilities()) {
6086 return Ok(());
6087 }
6088
6089 let request = {
6090 let completion = &completions.borrow()[completion_index];
6091 match &completion.source {
6092 CompletionSource::Lsp {
6093 lsp_completion,
6094 resolved,
6095 server_id: completion_server_id,
6096 ..
6097 } => {
6098 if *resolved {
6099 return Ok(());
6100 }
6101 anyhow::ensure!(
6102 server_id == *completion_server_id,
6103 "server_id mismatch, querying completion resolve for {server_id} but completion server id is {completion_server_id}"
6104 );
6105 server.request::<lsp::request::ResolveCompletionItem>(*lsp_completion.clone())
6106 }
6107 CompletionSource::BufferWord { .. }
6108 | CompletionSource::Dap { .. }
6109 | CompletionSource::Custom => {
6110 return Ok(());
6111 }
6112 }
6113 };
6114 let resolved_completion = request
6115 .await
6116 .into_response()
6117 .context("resolve completion")?;
6118
6119 // We must not use any data such as sortText, filterText, insertText and textEdit to edit `Completion` since they are not suppose change during resolve.
6120 // Refer: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_completion
6121
6122 let mut completions = completions.borrow_mut();
6123 let completion = &mut completions[completion_index];
6124 if let CompletionSource::Lsp {
6125 lsp_completion,
6126 resolved,
6127 server_id: completion_server_id,
6128 ..
6129 } = &mut completion.source
6130 {
6131 if *resolved {
6132 return Ok(());
6133 }
6134 anyhow::ensure!(
6135 server_id == *completion_server_id,
6136 "server_id mismatch, applying completion resolve for {server_id} but completion server id is {completion_server_id}"
6137 );
6138 *lsp_completion = Box::new(resolved_completion);
6139 *resolved = true;
6140 }
6141 Ok(())
6142 }
6143
6144 async fn regenerate_completion_labels(
6145 adapter: Arc<CachedLspAdapter>,
6146 snapshot: &BufferSnapshot,
6147 completions: Rc<RefCell<Box<[Completion]>>>,
6148 completion_index: usize,
6149 ) -> Result<()> {
6150 let completion_item = completions.borrow()[completion_index]
6151 .source
6152 .lsp_completion(true)
6153 .map(Cow::into_owned);
6154 if let Some(lsp_documentation) = completion_item
6155 .as_ref()
6156 .and_then(|completion_item| completion_item.documentation.clone())
6157 {
6158 let mut completions = completions.borrow_mut();
6159 let completion = &mut completions[completion_index];
6160 completion.documentation = Some(lsp_documentation.into());
6161 } else {
6162 let mut completions = completions.borrow_mut();
6163 let completion = &mut completions[completion_index];
6164 completion.documentation = Some(CompletionDocumentation::Undocumented);
6165 }
6166
6167 let mut new_label = match completion_item {
6168 Some(completion_item) => {
6169 // NB: Zed does not have `details` inside the completion resolve capabilities, but certain language servers violate the spec and do not return `details` immediately, e.g. https://github.com/yioneko/vtsls/issues/213
6170 // So we have to update the label here anyway...
6171 let language = snapshot.language();
6172 match language {
6173 Some(language) => {
6174 adapter
6175 .labels_for_completions(
6176 std::slice::from_ref(&completion_item),
6177 language,
6178 )
6179 .await?
6180 }
6181 None => Vec::new(),
6182 }
6183 .pop()
6184 .flatten()
6185 .unwrap_or_else(|| {
6186 CodeLabel::fallback_for_completion(
6187 &completion_item,
6188 language.map(|language| language.as_ref()),
6189 )
6190 })
6191 }
6192 None => CodeLabel::plain(
6193 completions.borrow()[completion_index].new_text.clone(),
6194 None,
6195 ),
6196 };
6197 ensure_uniform_list_compatible_label(&mut new_label);
6198
6199 let mut completions = completions.borrow_mut();
6200 let completion = &mut completions[completion_index];
6201 if completion.label.filter_text() == new_label.filter_text() {
6202 completion.label = new_label;
6203 } else {
6204 log::error!(
6205 "Resolved completion changed display label from {} to {}. \
6206 Refusing to apply this because it changes the fuzzy match text from {} to {}",
6207 completion.label.text(),
6208 new_label.text(),
6209 completion.label.filter_text(),
6210 new_label.filter_text()
6211 );
6212 }
6213
6214 Ok(())
6215 }
6216
6217 async fn resolve_completion_remote(
6218 project_id: u64,
6219 server_id: LanguageServerId,
6220 buffer_id: BufferId,
6221 completions: Rc<RefCell<Box<[Completion]>>>,
6222 completion_index: usize,
6223 client: AnyProtoClient,
6224 ) -> Result<()> {
6225 let lsp_completion = {
6226 let completion = &completions.borrow()[completion_index];
6227 match &completion.source {
6228 CompletionSource::Lsp {
6229 lsp_completion,
6230 resolved,
6231 server_id: completion_server_id,
6232 ..
6233 } => {
6234 anyhow::ensure!(
6235 server_id == *completion_server_id,
6236 "remote server_id mismatch, querying completion resolve for {server_id} but completion server id is {completion_server_id}"
6237 );
6238 if *resolved {
6239 return Ok(());
6240 }
6241 serde_json::to_string(lsp_completion).unwrap().into_bytes()
6242 }
6243 CompletionSource::Custom
6244 | CompletionSource::Dap { .. }
6245 | CompletionSource::BufferWord { .. } => {
6246 return Ok(());
6247 }
6248 }
6249 };
6250 let request = proto::ResolveCompletionDocumentation {
6251 project_id,
6252 language_server_id: server_id.0 as u64,
6253 lsp_completion,
6254 buffer_id: buffer_id.into(),
6255 };
6256
6257 let response = client
6258 .request(request)
6259 .await
6260 .context("completion documentation resolve proto request")?;
6261 let resolved_lsp_completion = serde_json::from_slice(&response.lsp_completion)?;
6262
6263 let documentation = if response.documentation.is_empty() {
6264 CompletionDocumentation::Undocumented
6265 } else if response.documentation_is_markdown {
6266 CompletionDocumentation::MultiLineMarkdown(response.documentation.into())
6267 } else if response.documentation.lines().count() <= 1 {
6268 CompletionDocumentation::SingleLine(response.documentation.into())
6269 } else {
6270 CompletionDocumentation::MultiLinePlainText(response.documentation.into())
6271 };
6272
6273 let mut completions = completions.borrow_mut();
6274 let completion = &mut completions[completion_index];
6275 completion.documentation = Some(documentation);
6276 if let CompletionSource::Lsp {
6277 insert_range,
6278 lsp_completion,
6279 resolved,
6280 server_id: completion_server_id,
6281 lsp_defaults: _,
6282 } = &mut completion.source
6283 {
6284 let completion_insert_range = response
6285 .old_insert_start
6286 .and_then(deserialize_anchor)
6287 .zip(response.old_insert_end.and_then(deserialize_anchor));
6288 *insert_range = completion_insert_range.map(|(start, end)| start..end);
6289
6290 if *resolved {
6291 return Ok(());
6292 }
6293 anyhow::ensure!(
6294 server_id == *completion_server_id,
6295 "remote server_id mismatch, applying completion resolve for {server_id} but completion server id is {completion_server_id}"
6296 );
6297 *lsp_completion = Box::new(resolved_lsp_completion);
6298 *resolved = true;
6299 }
6300
6301 let replace_range = response
6302 .old_replace_start
6303 .and_then(deserialize_anchor)
6304 .zip(response.old_replace_end.and_then(deserialize_anchor));
6305 if let Some((old_replace_start, old_replace_end)) = replace_range {
6306 if !response.new_text.is_empty() {
6307 completion.new_text = response.new_text;
6308 completion.replace_range = old_replace_start..old_replace_end;
6309 }
6310 }
6311
6312 Ok(())
6313 }
6314
6315 pub fn apply_additional_edits_for_completion(
6316 &self,
6317 buffer_handle: Entity<Buffer>,
6318 completions: Rc<RefCell<Box<[Completion]>>>,
6319 completion_index: usize,
6320 push_to_history: bool,
6321 cx: &mut Context<Self>,
6322 ) -> Task<Result<Option<Transaction>>> {
6323 if let Some((client, project_id)) = self.upstream_client() {
6324 let buffer = buffer_handle.read(cx);
6325 let buffer_id = buffer.remote_id();
6326 cx.spawn(async move |_, cx| {
6327 let request = {
6328 let completion = completions.borrow()[completion_index].clone();
6329 proto::ApplyCompletionAdditionalEdits {
6330 project_id,
6331 buffer_id: buffer_id.into(),
6332 completion: Some(Self::serialize_completion(&CoreCompletion {
6333 replace_range: completion.replace_range,
6334 new_text: completion.new_text,
6335 source: completion.source,
6336 })),
6337 }
6338 };
6339
6340 if let Some(transaction) = client.request(request).await?.transaction {
6341 let transaction = language::proto::deserialize_transaction(transaction)?;
6342 buffer_handle
6343 .update(cx, |buffer, _| {
6344 buffer.wait_for_edits(transaction.edit_ids.iter().copied())
6345 })?
6346 .await?;
6347 if push_to_history {
6348 buffer_handle.update(cx, |buffer, _| {
6349 buffer.push_transaction(transaction.clone(), Instant::now());
6350 buffer.finalize_last_transaction();
6351 })?;
6352 }
6353 Ok(Some(transaction))
6354 } else {
6355 Ok(None)
6356 }
6357 })
6358 } else {
6359 let Some(server) = buffer_handle.update(cx, |buffer, cx| {
6360 let completion = &completions.borrow()[completion_index];
6361 let server_id = completion.source.server_id()?;
6362 Some(
6363 self.language_server_for_local_buffer(buffer, server_id, cx)?
6364 .1
6365 .clone(),
6366 )
6367 }) else {
6368 return Task::ready(Ok(None));
6369 };
6370
6371 cx.spawn(async move |this, cx| {
6372 Self::resolve_completion_local(
6373 server.clone(),
6374 completions.clone(),
6375 completion_index,
6376 )
6377 .await
6378 .context("resolving completion")?;
6379 let completion = completions.borrow()[completion_index].clone();
6380 let additional_text_edits = completion
6381 .source
6382 .lsp_completion(true)
6383 .as_ref()
6384 .and_then(|lsp_completion| lsp_completion.additional_text_edits.clone());
6385 if let Some(edits) = additional_text_edits {
6386 let edits = this
6387 .update(cx, |this, cx| {
6388 this.as_local_mut().unwrap().edits_from_lsp(
6389 &buffer_handle,
6390 edits,
6391 server.server_id(),
6392 None,
6393 cx,
6394 )
6395 })?
6396 .await?;
6397
6398 buffer_handle.update(cx, |buffer, cx| {
6399 buffer.finalize_last_transaction();
6400 buffer.start_transaction();
6401
6402 for (range, text) in edits {
6403 let primary = &completion.replace_range;
6404 let start_within = primary.start.cmp(&range.start, buffer).is_le()
6405 && primary.end.cmp(&range.start, buffer).is_ge();
6406 let end_within = range.start.cmp(&primary.end, buffer).is_le()
6407 && range.end.cmp(&primary.end, buffer).is_ge();
6408
6409 //Skip additional edits which overlap with the primary completion edit
6410 //https://github.com/zed-industries/zed/pull/1871
6411 if !start_within && !end_within {
6412 buffer.edit([(range, text)], None, cx);
6413 }
6414 }
6415
6416 let transaction = if buffer.end_transaction(cx).is_some() {
6417 let transaction = buffer.finalize_last_transaction().unwrap().clone();
6418 if !push_to_history {
6419 buffer.forget_transaction(transaction.id);
6420 }
6421 Some(transaction)
6422 } else {
6423 None
6424 };
6425 Ok(transaction)
6426 })?
6427 } else {
6428 Ok(None)
6429 }
6430 })
6431 }
6432 }
6433
6434 pub fn pull_diagnostics(
6435 &mut self,
6436 buffer: Entity<Buffer>,
6437 cx: &mut Context<Self>,
6438 ) -> Task<Result<Option<Vec<LspPullDiagnostics>>>> {
6439 let buffer_id = buffer.read(cx).remote_id();
6440
6441 if let Some((client, upstream_project_id)) = self.upstream_client() {
6442 if !self.is_capable_for_proto_request(
6443 &buffer,
6444 &GetDocumentDiagnostics {
6445 previous_result_id: None,
6446 },
6447 cx,
6448 ) {
6449 return Task::ready(Ok(None));
6450 }
6451 let request_task = client.request(proto::MultiLspQuery {
6452 buffer_id: buffer_id.to_proto(),
6453 version: serialize_version(&buffer.read(cx).version()),
6454 project_id: upstream_project_id,
6455 strategy: Some(proto::multi_lsp_query::Strategy::All(
6456 proto::AllLanguageServers {},
6457 )),
6458 request: Some(proto::multi_lsp_query::Request::GetDocumentDiagnostics(
6459 proto::GetDocumentDiagnostics {
6460 project_id: upstream_project_id,
6461 buffer_id: buffer_id.to_proto(),
6462 version: serialize_version(&buffer.read(cx).version()),
6463 },
6464 )),
6465 });
6466 cx.background_spawn(async move {
6467 let _proto_responses = request_task
6468 .await?
6469 .responses
6470 .into_iter()
6471 .filter_map(|lsp_response| match lsp_response.response? {
6472 proto::lsp_response::Response::GetDocumentDiagnosticsResponse(response) => {
6473 Some(response)
6474 }
6475 unexpected => {
6476 debug_panic!("Unexpected response: {unexpected:?}");
6477 None
6478 }
6479 })
6480 .collect::<Vec<_>>();
6481 // Proto requests cause the diagnostics to be pulled from language server(s) on the local side
6482 // and then, buffer state updated with the diagnostics received, which will be later propagated to the client.
6483 // Do not attempt to further process the dummy responses here.
6484 Ok(None)
6485 })
6486 } else {
6487 let server_ids = buffer.update(cx, |buffer, cx| {
6488 self.language_servers_for_local_buffer(buffer, cx)
6489 .map(|(_, server)| server.server_id())
6490 .collect::<Vec<_>>()
6491 });
6492 let pull_diagnostics = server_ids
6493 .into_iter()
6494 .map(|server_id| {
6495 let result_id = self.result_id(server_id, buffer_id, cx);
6496 self.request_lsp(
6497 buffer.clone(),
6498 LanguageServerToQuery::Other(server_id),
6499 GetDocumentDiagnostics {
6500 previous_result_id: result_id,
6501 },
6502 cx,
6503 )
6504 })
6505 .collect::<Vec<_>>();
6506
6507 cx.background_spawn(async move {
6508 let mut responses = Vec::new();
6509 for diagnostics in join_all(pull_diagnostics).await {
6510 responses.extend(diagnostics?);
6511 }
6512 Ok(Some(responses))
6513 })
6514 }
6515 }
6516
6517 pub fn inlay_hints(
6518 &mut self,
6519 buffer: Entity<Buffer>,
6520 range: Range<Anchor>,
6521 cx: &mut Context<Self>,
6522 ) -> Task<anyhow::Result<Vec<InlayHint>>> {
6523 let range_start = range.start;
6524 let range_end = range.end;
6525 let buffer_id = buffer.read(cx).remote_id().into();
6526 let request = InlayHints { range };
6527
6528 if let Some((client, project_id)) = self.upstream_client() {
6529 if !self.is_capable_for_proto_request(&buffer, &request, cx) {
6530 return Task::ready(Ok(Vec::new()));
6531 }
6532 let proto_request = proto::InlayHints {
6533 project_id,
6534 buffer_id,
6535 start: Some(serialize_anchor(&range_start)),
6536 end: Some(serialize_anchor(&range_end)),
6537 version: serialize_version(&buffer.read(cx).version()),
6538 };
6539 cx.spawn(async move |project, cx| {
6540 let response = client
6541 .request(proto_request)
6542 .await
6543 .context("inlay hints proto request")?;
6544 LspCommand::response_from_proto(
6545 request,
6546 response,
6547 project.upgrade().context("No project")?,
6548 buffer.clone(),
6549 cx.clone(),
6550 )
6551 .await
6552 .context("inlay hints proto response conversion")
6553 })
6554 } else {
6555 let lsp_request_task = self.request_lsp(
6556 buffer.clone(),
6557 LanguageServerToQuery::FirstCapable,
6558 request,
6559 cx,
6560 );
6561 cx.spawn(async move |_, cx| {
6562 buffer
6563 .update(cx, |buffer, _| {
6564 buffer.wait_for_edits(vec![range_start.timestamp, range_end.timestamp])
6565 })?
6566 .await
6567 .context("waiting for inlay hint request range edits")?;
6568 lsp_request_task.await.context("inlay hints LSP request")
6569 })
6570 }
6571 }
6572
6573 pub fn pull_diagnostics_for_buffer(
6574 &mut self,
6575 buffer: Entity<Buffer>,
6576 cx: &mut Context<Self>,
6577 ) -> Task<anyhow::Result<()>> {
6578 let diagnostics = self.pull_diagnostics(buffer, cx);
6579 cx.spawn(async move |lsp_store, cx| {
6580 let Some(diagnostics) = diagnostics.await.context("pulling diagnostics")? else {
6581 return Ok(());
6582 };
6583 lsp_store.update(cx, |lsp_store, cx| {
6584 if lsp_store.as_local().is_none() {
6585 return;
6586 }
6587
6588 let mut unchanged_buffers = HashSet::default();
6589 let mut changed_buffers = HashSet::default();
6590 let server_diagnostics_updates = diagnostics
6591 .into_iter()
6592 .filter_map(|diagnostics_set| match diagnostics_set {
6593 LspPullDiagnostics::Response {
6594 server_id,
6595 uri,
6596 diagnostics,
6597 } => Some((server_id, uri, diagnostics)),
6598 LspPullDiagnostics::Default => None,
6599 })
6600 .fold(
6601 HashMap::default(),
6602 |mut acc, (server_id, uri, diagnostics)| {
6603 let (result_id, diagnostics) = match diagnostics {
6604 PulledDiagnostics::Unchanged { result_id } => {
6605 unchanged_buffers.insert(uri.clone());
6606 (Some(result_id), Vec::new())
6607 }
6608 PulledDiagnostics::Changed {
6609 result_id,
6610 diagnostics,
6611 } => {
6612 changed_buffers.insert(uri.clone());
6613 (result_id, diagnostics)
6614 }
6615 };
6616 let disk_based_sources = Cow::Owned(
6617 lsp_store
6618 .language_server_adapter_for_id(server_id)
6619 .as_ref()
6620 .map(|adapter| adapter.disk_based_diagnostic_sources.as_slice())
6621 .unwrap_or(&[])
6622 .to_vec(),
6623 );
6624 acc.entry(server_id).or_insert_with(Vec::new).push(
6625 DocumentDiagnosticsUpdate {
6626 server_id,
6627 diagnostics: lsp::PublishDiagnosticsParams {
6628 uri,
6629 diagnostics,
6630 version: None,
6631 },
6632 result_id,
6633 disk_based_sources,
6634 },
6635 );
6636 acc
6637 },
6638 );
6639
6640 for diagnostic_updates in server_diagnostics_updates.into_values() {
6641 lsp_store
6642 .merge_lsp_diagnostics(
6643 DiagnosticSourceKind::Pulled,
6644 diagnostic_updates,
6645 |buffer, old_diagnostic, cx| {
6646 File::from_dyn(buffer.file())
6647 .and_then(|file| {
6648 let abs_path = file.as_local()?.abs_path(cx);
6649 lsp::Url::from_file_path(abs_path).ok()
6650 })
6651 .is_none_or(|buffer_uri| {
6652 unchanged_buffers.contains(&buffer_uri)
6653 || match old_diagnostic.source_kind {
6654 DiagnosticSourceKind::Pulled => {
6655 !changed_buffers.contains(&buffer_uri)
6656 }
6657 DiagnosticSourceKind::Other
6658 | DiagnosticSourceKind::Pushed => true,
6659 }
6660 })
6661 },
6662 cx,
6663 )
6664 .log_err();
6665 }
6666 })
6667 })
6668 }
6669
6670 pub fn document_colors(
6671 &mut self,
6672 fetch_strategy: LspFetchStrategy,
6673 buffer: Entity<Buffer>,
6674 cx: &mut Context<Self>,
6675 ) -> Option<DocumentColorTask> {
6676 let version_queried_for = buffer.read(cx).version();
6677 let buffer_id = buffer.read(cx).remote_id();
6678
6679 match fetch_strategy {
6680 LspFetchStrategy::IgnoreCache => {}
6681 LspFetchStrategy::UseCache {
6682 known_cache_version,
6683 } => {
6684 if let Some(cached_data) = self.lsp_document_colors.get(&buffer_id) {
6685 if !version_queried_for.changed_since(&cached_data.colors_for_version) {
6686 let has_different_servers = self.as_local().is_some_and(|local| {
6687 local
6688 .buffers_opened_in_servers
6689 .get(&buffer_id)
6690 .cloned()
6691 .unwrap_or_default()
6692 != cached_data.colors.keys().copied().collect()
6693 });
6694 if !has_different_servers {
6695 if Some(cached_data.cache_version) == known_cache_version {
6696 return None;
6697 } else {
6698 return Some(
6699 Task::ready(Ok(DocumentColors {
6700 colors: cached_data
6701 .colors
6702 .values()
6703 .flatten()
6704 .cloned()
6705 .collect(),
6706 cache_version: Some(cached_data.cache_version),
6707 }))
6708 .shared(),
6709 );
6710 }
6711 }
6712 }
6713 }
6714 }
6715 }
6716
6717 let lsp_data = self.lsp_document_colors.entry(buffer_id).or_default();
6718 if let Some((updating_for, running_update)) = &lsp_data.colors_update {
6719 if !version_queried_for.changed_since(&updating_for) {
6720 return Some(running_update.clone());
6721 }
6722 }
6723 let query_version_queried_for = version_queried_for.clone();
6724 let new_task = cx
6725 .spawn(async move |lsp_store, cx| {
6726 cx.background_executor()
6727 .timer(Duration::from_millis(30))
6728 .await;
6729 let fetched_colors = lsp_store
6730 .update(cx, |lsp_store, cx| {
6731 lsp_store.fetch_document_colors_for_buffer(&buffer, cx)
6732 })?
6733 .await
6734 .context("fetching document colors")
6735 .map_err(Arc::new);
6736 let fetched_colors = match fetched_colors {
6737 Ok(fetched_colors) => {
6738 if fetch_strategy != LspFetchStrategy::IgnoreCache
6739 && Some(true)
6740 == buffer
6741 .update(cx, |buffer, _| {
6742 buffer.version() != query_version_queried_for
6743 })
6744 .ok()
6745 {
6746 return Ok(DocumentColors::default());
6747 }
6748 fetched_colors
6749 }
6750 Err(e) => {
6751 lsp_store
6752 .update(cx, |lsp_store, _| {
6753 lsp_store
6754 .lsp_document_colors
6755 .entry(buffer_id)
6756 .or_default()
6757 .colors_update = None;
6758 })
6759 .ok();
6760 return Err(e);
6761 }
6762 };
6763
6764 lsp_store
6765 .update(cx, |lsp_store, _| {
6766 let lsp_data = lsp_store.lsp_document_colors.entry(buffer_id).or_default();
6767
6768 if lsp_data.colors_for_version == query_version_queried_for {
6769 lsp_data.colors.extend(fetched_colors.clone());
6770 lsp_data.cache_version += 1;
6771 } else if !lsp_data
6772 .colors_for_version
6773 .changed_since(&query_version_queried_for)
6774 {
6775 lsp_data.colors_for_version = query_version_queried_for;
6776 lsp_data.colors = fetched_colors.clone();
6777 lsp_data.cache_version += 1;
6778 }
6779 lsp_data.colors_update = None;
6780 let colors = lsp_data
6781 .colors
6782 .values()
6783 .flatten()
6784 .cloned()
6785 .collect::<HashSet<_>>();
6786 DocumentColors {
6787 colors,
6788 cache_version: Some(lsp_data.cache_version),
6789 }
6790 })
6791 .map_err(Arc::new)
6792 })
6793 .shared();
6794 lsp_data.colors_update = Some((version_queried_for, new_task.clone()));
6795 Some(new_task)
6796 }
6797
6798 fn fetch_document_colors_for_buffer(
6799 &mut self,
6800 buffer: &Entity<Buffer>,
6801 cx: &mut Context<Self>,
6802 ) -> Task<anyhow::Result<HashMap<LanguageServerId, HashSet<DocumentColor>>>> {
6803 if let Some((client, project_id)) = self.upstream_client() {
6804 let request = GetDocumentColor {};
6805 if !self.is_capable_for_proto_request(buffer, &request, cx) {
6806 return Task::ready(Ok(HashMap::default()));
6807 }
6808
6809 let request_task = client.request(proto::MultiLspQuery {
6810 project_id,
6811 buffer_id: buffer.read(cx).remote_id().to_proto(),
6812 version: serialize_version(&buffer.read(cx).version()),
6813 strategy: Some(proto::multi_lsp_query::Strategy::All(
6814 proto::AllLanguageServers {},
6815 )),
6816 request: Some(proto::multi_lsp_query::Request::GetDocumentColor(
6817 request.to_proto(project_id, buffer.read(cx)),
6818 )),
6819 });
6820 let buffer = buffer.clone();
6821 cx.spawn(async move |project, cx| {
6822 let Some(project) = project.upgrade() else {
6823 return Ok(HashMap::default());
6824 };
6825 let colors = join_all(
6826 request_task
6827 .await
6828 .log_err()
6829 .map(|response| response.responses)
6830 .unwrap_or_default()
6831 .into_iter()
6832 .filter_map(|lsp_response| match lsp_response.response? {
6833 proto::lsp_response::Response::GetDocumentColorResponse(response) => {
6834 Some((
6835 LanguageServerId::from_proto(lsp_response.server_id),
6836 response,
6837 ))
6838 }
6839 unexpected => {
6840 debug_panic!("Unexpected response: {unexpected:?}");
6841 None
6842 }
6843 })
6844 .map(|(server_id, color_response)| {
6845 let response = request.response_from_proto(
6846 color_response,
6847 project.clone(),
6848 buffer.clone(),
6849 cx.clone(),
6850 );
6851 async move { (server_id, response.await.log_err().unwrap_or_default()) }
6852 }),
6853 )
6854 .await
6855 .into_iter()
6856 .fold(HashMap::default(), |mut acc, (server_id, colors)| {
6857 acc.entry(server_id)
6858 .or_insert_with(HashSet::default)
6859 .extend(colors);
6860 acc
6861 });
6862 Ok(colors)
6863 })
6864 } else {
6865 let document_colors_task =
6866 self.request_multiple_lsp_locally(buffer, None::<usize>, GetDocumentColor, cx);
6867 cx.background_spawn(async move {
6868 Ok(document_colors_task
6869 .await
6870 .into_iter()
6871 .fold(HashMap::default(), |mut acc, (server_id, colors)| {
6872 acc.entry(server_id)
6873 .or_insert_with(HashSet::default)
6874 .extend(colors);
6875 acc
6876 })
6877 .into_iter()
6878 .collect())
6879 })
6880 }
6881 }
6882
6883 pub fn signature_help<T: ToPointUtf16>(
6884 &mut self,
6885 buffer: &Entity<Buffer>,
6886 position: T,
6887 cx: &mut Context<Self>,
6888 ) -> Task<Vec<SignatureHelp>> {
6889 let position = position.to_point_utf16(buffer.read(cx));
6890
6891 if let Some((client, upstream_project_id)) = self.upstream_client() {
6892 let request = GetSignatureHelp { position };
6893 if !self.is_capable_for_proto_request(buffer, &request, cx) {
6894 return Task::ready(Vec::new());
6895 }
6896 let request_task = client.request(proto::MultiLspQuery {
6897 buffer_id: buffer.read(cx).remote_id().into(),
6898 version: serialize_version(&buffer.read(cx).version()),
6899 project_id: upstream_project_id,
6900 strategy: Some(proto::multi_lsp_query::Strategy::All(
6901 proto::AllLanguageServers {},
6902 )),
6903 request: Some(proto::multi_lsp_query::Request::GetSignatureHelp(
6904 request.to_proto(upstream_project_id, buffer.read(cx)),
6905 )),
6906 });
6907 let buffer = buffer.clone();
6908 cx.spawn(async move |weak_project, cx| {
6909 let Some(project) = weak_project.upgrade() else {
6910 return Vec::new();
6911 };
6912 join_all(
6913 request_task
6914 .await
6915 .log_err()
6916 .map(|response| response.responses)
6917 .unwrap_or_default()
6918 .into_iter()
6919 .filter_map(|lsp_response| match lsp_response.response? {
6920 proto::lsp_response::Response::GetSignatureHelpResponse(response) => {
6921 Some(response)
6922 }
6923 unexpected => {
6924 debug_panic!("Unexpected response: {unexpected:?}");
6925 None
6926 }
6927 })
6928 .map(|signature_response| {
6929 let response = GetSignatureHelp { position }.response_from_proto(
6930 signature_response,
6931 project.clone(),
6932 buffer.clone(),
6933 cx.clone(),
6934 );
6935 async move { response.await.log_err().flatten() }
6936 }),
6937 )
6938 .await
6939 .into_iter()
6940 .flatten()
6941 .collect()
6942 })
6943 } else {
6944 let all_actions_task = self.request_multiple_lsp_locally(
6945 buffer,
6946 Some(position),
6947 GetSignatureHelp { position },
6948 cx,
6949 );
6950 cx.background_spawn(async move {
6951 all_actions_task
6952 .await
6953 .into_iter()
6954 .flat_map(|(_, actions)| actions)
6955 .collect::<Vec<_>>()
6956 })
6957 }
6958 }
6959
6960 pub fn hover(
6961 &mut self,
6962 buffer: &Entity<Buffer>,
6963 position: PointUtf16,
6964 cx: &mut Context<Self>,
6965 ) -> Task<Vec<Hover>> {
6966 if let Some((client, upstream_project_id)) = self.upstream_client() {
6967 let request = GetHover { position };
6968 if !self.is_capable_for_proto_request(buffer, &request, cx) {
6969 return Task::ready(Vec::new());
6970 }
6971 let request_task = client.request(proto::MultiLspQuery {
6972 buffer_id: buffer.read(cx).remote_id().into(),
6973 version: serialize_version(&buffer.read(cx).version()),
6974 project_id: upstream_project_id,
6975 strategy: Some(proto::multi_lsp_query::Strategy::All(
6976 proto::AllLanguageServers {},
6977 )),
6978 request: Some(proto::multi_lsp_query::Request::GetHover(
6979 request.to_proto(upstream_project_id, buffer.read(cx)),
6980 )),
6981 });
6982 let buffer = buffer.clone();
6983 cx.spawn(async move |weak_project, cx| {
6984 let Some(project) = weak_project.upgrade() else {
6985 return Vec::new();
6986 };
6987 join_all(
6988 request_task
6989 .await
6990 .log_err()
6991 .map(|response| response.responses)
6992 .unwrap_or_default()
6993 .into_iter()
6994 .filter_map(|lsp_response| match lsp_response.response? {
6995 proto::lsp_response::Response::GetHoverResponse(response) => {
6996 Some(response)
6997 }
6998 unexpected => {
6999 debug_panic!("Unexpected response: {unexpected:?}");
7000 None
7001 }
7002 })
7003 .map(|hover_response| {
7004 let response = GetHover { position }.response_from_proto(
7005 hover_response,
7006 project.clone(),
7007 buffer.clone(),
7008 cx.clone(),
7009 );
7010 async move {
7011 response
7012 .await
7013 .log_err()
7014 .flatten()
7015 .and_then(remove_empty_hover_blocks)
7016 }
7017 }),
7018 )
7019 .await
7020 .into_iter()
7021 .flatten()
7022 .collect()
7023 })
7024 } else {
7025 let all_actions_task = self.request_multiple_lsp_locally(
7026 buffer,
7027 Some(position),
7028 GetHover { position },
7029 cx,
7030 );
7031 cx.background_spawn(async move {
7032 all_actions_task
7033 .await
7034 .into_iter()
7035 .filter_map(|(_, hover)| remove_empty_hover_blocks(hover?))
7036 .collect::<Vec<Hover>>()
7037 })
7038 }
7039 }
7040
7041 pub fn symbols(&self, query: &str, cx: &mut Context<Self>) -> Task<Result<Vec<Symbol>>> {
7042 let language_registry = self.languages.clone();
7043
7044 if let Some((upstream_client, project_id)) = self.upstream_client().as_ref() {
7045 let request = upstream_client.request(proto::GetProjectSymbols {
7046 project_id: *project_id,
7047 query: query.to_string(),
7048 });
7049 cx.foreground_executor().spawn(async move {
7050 let response = request.await?;
7051 let mut symbols = Vec::new();
7052 let core_symbols = response
7053 .symbols
7054 .into_iter()
7055 .filter_map(|symbol| Self::deserialize_symbol(symbol).log_err())
7056 .collect::<Vec<_>>();
7057 populate_labels_for_symbols(core_symbols, &language_registry, None, &mut symbols)
7058 .await;
7059 Ok(symbols)
7060 })
7061 } else if let Some(local) = self.as_local() {
7062 struct WorkspaceSymbolsResult {
7063 server_id: LanguageServerId,
7064 lsp_adapter: Arc<CachedLspAdapter>,
7065 worktree: WeakEntity<Worktree>,
7066 worktree_abs_path: Arc<Path>,
7067 lsp_symbols: Vec<(String, SymbolKind, lsp::Location)>,
7068 }
7069
7070 let mut requests = Vec::new();
7071 let mut requested_servers = BTreeSet::new();
7072 'next_server: for ((worktree_id, _), server_ids) in local.language_server_ids.iter() {
7073 let Some(worktree_handle) = self
7074 .worktree_store
7075 .read(cx)
7076 .worktree_for_id(*worktree_id, cx)
7077 else {
7078 continue;
7079 };
7080 let worktree = worktree_handle.read(cx);
7081 if !worktree.is_visible() {
7082 continue;
7083 }
7084
7085 let mut servers_to_query = server_ids
7086 .difference(&requested_servers)
7087 .cloned()
7088 .collect::<BTreeSet<_>>();
7089 for server_id in &servers_to_query {
7090 let (lsp_adapter, server) = match local.language_servers.get(server_id) {
7091 Some(LanguageServerState::Running {
7092 adapter, server, ..
7093 }) => (adapter.clone(), server),
7094
7095 _ => continue 'next_server,
7096 };
7097 let supports_workspace_symbol_request =
7098 match server.capabilities().workspace_symbol_provider {
7099 Some(OneOf::Left(supported)) => supported,
7100 Some(OneOf::Right(_)) => true,
7101 None => false,
7102 };
7103 if !supports_workspace_symbol_request {
7104 continue 'next_server;
7105 }
7106 let worktree_abs_path = worktree.abs_path().clone();
7107 let worktree_handle = worktree_handle.clone();
7108 let server_id = server.server_id();
7109 requests.push(
7110 server
7111 .request::<lsp::request::WorkspaceSymbolRequest>(
7112 lsp::WorkspaceSymbolParams {
7113 query: query.to_string(),
7114 ..Default::default()
7115 },
7116 )
7117 .map(move |response| {
7118 let lsp_symbols = response.into_response()
7119 .context("workspace symbols request")
7120 .log_err()
7121 .flatten()
7122 .map(|symbol_response| match symbol_response {
7123 lsp::WorkspaceSymbolResponse::Flat(flat_responses) => {
7124 flat_responses.into_iter().map(|lsp_symbol| {
7125 (lsp_symbol.name, lsp_symbol.kind, lsp_symbol.location)
7126 }).collect::<Vec<_>>()
7127 }
7128 lsp::WorkspaceSymbolResponse::Nested(nested_responses) => {
7129 nested_responses.into_iter().filter_map(|lsp_symbol| {
7130 let location = match lsp_symbol.location {
7131 OneOf::Left(location) => location,
7132 OneOf::Right(_) => {
7133 log::error!("Unexpected: client capabilities forbid symbol resolutions in workspace.symbol.resolveSupport");
7134 return None
7135 }
7136 };
7137 Some((lsp_symbol.name, lsp_symbol.kind, location))
7138 }).collect::<Vec<_>>()
7139 }
7140 }).unwrap_or_default();
7141
7142 WorkspaceSymbolsResult {
7143 server_id,
7144 lsp_adapter,
7145 worktree: worktree_handle.downgrade(),
7146 worktree_abs_path,
7147 lsp_symbols,
7148 }
7149 }),
7150 );
7151 }
7152 requested_servers.append(&mut servers_to_query);
7153 }
7154
7155 cx.spawn(async move |this, cx| {
7156 let responses = futures::future::join_all(requests).await;
7157 let this = match this.upgrade() {
7158 Some(this) => this,
7159 None => return Ok(Vec::new()),
7160 };
7161
7162 let mut symbols = Vec::new();
7163 for result in responses {
7164 let core_symbols = this.update(cx, |this, cx| {
7165 result
7166 .lsp_symbols
7167 .into_iter()
7168 .filter_map(|(symbol_name, symbol_kind, symbol_location)| {
7169 let abs_path = symbol_location.uri.to_file_path().ok()?;
7170 let source_worktree = result.worktree.upgrade()?;
7171 let source_worktree_id = source_worktree.read(cx).id();
7172
7173 let path;
7174 let worktree;
7175 if let Some((tree, rel_path)) =
7176 this.worktree_store.read(cx).find_worktree(&abs_path, cx)
7177 {
7178 worktree = tree;
7179 path = rel_path;
7180 } else {
7181 worktree = source_worktree.clone();
7182 path = relativize_path(&result.worktree_abs_path, &abs_path);
7183 }
7184
7185 let worktree_id = worktree.read(cx).id();
7186 let project_path = ProjectPath {
7187 worktree_id,
7188 path: path.into(),
7189 };
7190 let signature = this.symbol_signature(&project_path);
7191 Some(CoreSymbol {
7192 source_language_server_id: result.server_id,
7193 language_server_name: result.lsp_adapter.name.clone(),
7194 source_worktree_id,
7195 path: project_path,
7196 kind: symbol_kind,
7197 name: symbol_name,
7198 range: range_from_lsp(symbol_location.range),
7199 signature,
7200 })
7201 })
7202 .collect()
7203 })?;
7204
7205 populate_labels_for_symbols(
7206 core_symbols,
7207 &language_registry,
7208 Some(result.lsp_adapter),
7209 &mut symbols,
7210 )
7211 .await;
7212 }
7213
7214 Ok(symbols)
7215 })
7216 } else {
7217 Task::ready(Err(anyhow!("No upstream client or local language server")))
7218 }
7219 }
7220
7221 pub fn diagnostic_summary(&self, include_ignored: bool, cx: &App) -> DiagnosticSummary {
7222 let mut summary = DiagnosticSummary::default();
7223 for (_, _, path_summary) in self.diagnostic_summaries(include_ignored, cx) {
7224 summary.error_count += path_summary.error_count;
7225 summary.warning_count += path_summary.warning_count;
7226 }
7227 summary
7228 }
7229
7230 pub fn diagnostic_summaries<'a>(
7231 &'a self,
7232 include_ignored: bool,
7233 cx: &'a App,
7234 ) -> impl Iterator<Item = (ProjectPath, LanguageServerId, DiagnosticSummary)> + 'a {
7235 self.worktree_store
7236 .read(cx)
7237 .visible_worktrees(cx)
7238 .filter_map(|worktree| {
7239 let worktree = worktree.read(cx);
7240 Some((worktree, self.diagnostic_summaries.get(&worktree.id())?))
7241 })
7242 .flat_map(move |(worktree, summaries)| {
7243 let worktree_id = worktree.id();
7244 summaries
7245 .iter()
7246 .filter(move |(path, _)| {
7247 include_ignored
7248 || worktree
7249 .entry_for_path(path.as_ref())
7250 .map_or(false, |entry| !entry.is_ignored)
7251 })
7252 .flat_map(move |(path, summaries)| {
7253 summaries.iter().map(move |(server_id, summary)| {
7254 (
7255 ProjectPath {
7256 worktree_id,
7257 path: path.clone(),
7258 },
7259 *server_id,
7260 *summary,
7261 )
7262 })
7263 })
7264 })
7265 }
7266
7267 pub fn on_buffer_edited(
7268 &mut self,
7269 buffer: Entity<Buffer>,
7270 cx: &mut Context<Self>,
7271 ) -> Option<()> {
7272 let language_servers: Vec<_> = buffer.update(cx, |buffer, cx| {
7273 Some(
7274 self.as_local()?
7275 .language_servers_for_buffer(buffer, cx)
7276 .map(|i| i.1.clone())
7277 .collect(),
7278 )
7279 })?;
7280
7281 let buffer = buffer.read(cx);
7282 let file = File::from_dyn(buffer.file())?;
7283 let abs_path = file.as_local()?.abs_path(cx);
7284 let uri = lsp::Url::from_file_path(abs_path).unwrap();
7285 let next_snapshot = buffer.text_snapshot();
7286 for language_server in language_servers {
7287 let language_server = language_server.clone();
7288
7289 let buffer_snapshots = self
7290 .as_local_mut()
7291 .unwrap()
7292 .buffer_snapshots
7293 .get_mut(&buffer.remote_id())
7294 .and_then(|m| m.get_mut(&language_server.server_id()))?;
7295 let previous_snapshot = buffer_snapshots.last()?;
7296
7297 let build_incremental_change = || {
7298 buffer
7299 .edits_since::<Dimensions<PointUtf16, usize>>(
7300 previous_snapshot.snapshot.version(),
7301 )
7302 .map(|edit| {
7303 let edit_start = edit.new.start.0;
7304 let edit_end = edit_start + (edit.old.end.0 - edit.old.start.0);
7305 let new_text = next_snapshot
7306 .text_for_range(edit.new.start.1..edit.new.end.1)
7307 .collect();
7308 lsp::TextDocumentContentChangeEvent {
7309 range: Some(lsp::Range::new(
7310 point_to_lsp(edit_start),
7311 point_to_lsp(edit_end),
7312 )),
7313 range_length: None,
7314 text: new_text,
7315 }
7316 })
7317 .collect()
7318 };
7319
7320 let document_sync_kind = language_server
7321 .capabilities()
7322 .text_document_sync
7323 .as_ref()
7324 .and_then(|sync| match sync {
7325 lsp::TextDocumentSyncCapability::Kind(kind) => Some(*kind),
7326 lsp::TextDocumentSyncCapability::Options(options) => options.change,
7327 });
7328
7329 let content_changes: Vec<_> = match document_sync_kind {
7330 Some(lsp::TextDocumentSyncKind::FULL) => {
7331 vec![lsp::TextDocumentContentChangeEvent {
7332 range: None,
7333 range_length: None,
7334 text: next_snapshot.text(),
7335 }]
7336 }
7337 Some(lsp::TextDocumentSyncKind::INCREMENTAL) => build_incremental_change(),
7338 _ => {
7339 #[cfg(any(test, feature = "test-support"))]
7340 {
7341 build_incremental_change()
7342 }
7343
7344 #[cfg(not(any(test, feature = "test-support")))]
7345 {
7346 continue;
7347 }
7348 }
7349 };
7350
7351 let next_version = previous_snapshot.version + 1;
7352 buffer_snapshots.push(LspBufferSnapshot {
7353 version: next_version,
7354 snapshot: next_snapshot.clone(),
7355 });
7356
7357 language_server
7358 .notify::<lsp::notification::DidChangeTextDocument>(
7359 &lsp::DidChangeTextDocumentParams {
7360 text_document: lsp::VersionedTextDocumentIdentifier::new(
7361 uri.clone(),
7362 next_version,
7363 ),
7364 content_changes,
7365 },
7366 )
7367 .ok();
7368 self.pull_workspace_diagnostics(language_server.server_id());
7369 }
7370
7371 None
7372 }
7373
7374 pub fn on_buffer_saved(
7375 &mut self,
7376 buffer: Entity<Buffer>,
7377 cx: &mut Context<Self>,
7378 ) -> Option<()> {
7379 let file = File::from_dyn(buffer.read(cx).file())?;
7380 let worktree_id = file.worktree_id(cx);
7381 let abs_path = file.as_local()?.abs_path(cx);
7382 let text_document = lsp::TextDocumentIdentifier {
7383 uri: file_path_to_lsp_url(&abs_path).log_err()?,
7384 };
7385 let local = self.as_local()?;
7386
7387 for server in local.language_servers_for_worktree(worktree_id) {
7388 if let Some(include_text) = include_text(server.as_ref()) {
7389 let text = if include_text {
7390 Some(buffer.read(cx).text())
7391 } else {
7392 None
7393 };
7394 server
7395 .notify::<lsp::notification::DidSaveTextDocument>(
7396 &lsp::DidSaveTextDocumentParams {
7397 text_document: text_document.clone(),
7398 text,
7399 },
7400 )
7401 .ok();
7402 }
7403 }
7404
7405 let language_servers = buffer.update(cx, |buffer, cx| {
7406 local.language_server_ids_for_buffer(buffer, cx)
7407 });
7408 for language_server_id in language_servers {
7409 self.simulate_disk_based_diagnostics_events_if_needed(language_server_id, cx);
7410 }
7411
7412 None
7413 }
7414
7415 pub(crate) async fn refresh_workspace_configurations(
7416 lsp_store: &WeakEntity<Self>,
7417 fs: Arc<dyn Fs>,
7418 cx: &mut AsyncApp,
7419 ) {
7420 maybe!(async move {
7421 let mut refreshed_servers = HashSet::default();
7422 let servers = lsp_store
7423 .update(cx, |lsp_store, cx| {
7424 let toolchain_store = lsp_store.toolchain_store(cx);
7425 let Some(local) = lsp_store.as_local() else {
7426 return Vec::default();
7427 };
7428 local
7429 .language_server_ids
7430 .iter()
7431 .flat_map(|((worktree_id, _), server_ids)| {
7432 let worktree = lsp_store
7433 .worktree_store
7434 .read(cx)
7435 .worktree_for_id(*worktree_id, cx);
7436 let delegate = worktree.map(|worktree| {
7437 LocalLspAdapterDelegate::new(
7438 local.languages.clone(),
7439 &local.environment,
7440 cx.weak_entity(),
7441 &worktree,
7442 local.http_client.clone(),
7443 local.fs.clone(),
7444 cx,
7445 )
7446 });
7447
7448 let fs = fs.clone();
7449 let toolchain_store = toolchain_store.clone();
7450 server_ids.iter().filter_map(|server_id| {
7451 let delegate = delegate.clone()? as Arc<dyn LspAdapterDelegate>;
7452 let states = local.language_servers.get(server_id)?;
7453
7454 match states {
7455 LanguageServerState::Starting { .. } => None,
7456 LanguageServerState::Running {
7457 adapter, server, ..
7458 } => {
7459 let fs = fs.clone();
7460 let toolchain_store = toolchain_store.clone();
7461 let adapter = adapter.clone();
7462 let server = server.clone();
7463 refreshed_servers.insert(server.name());
7464 Some(cx.spawn(async move |_, cx| {
7465 let settings =
7466 LocalLspStore::workspace_configuration_for_adapter(
7467 adapter.adapter.clone(),
7468 fs.as_ref(),
7469 &delegate,
7470 toolchain_store,
7471 cx,
7472 )
7473 .await
7474 .ok()?;
7475 server
7476 .notify::<lsp::notification::DidChangeConfiguration>(
7477 &lsp::DidChangeConfigurationParams { settings },
7478 )
7479 .ok()?;
7480 Some(())
7481 }))
7482 }
7483 }
7484 }).collect::<Vec<_>>()
7485 })
7486 .collect::<Vec<_>>()
7487 })
7488 .ok()?;
7489
7490 log::info!("Refreshing workspace configurations for servers {refreshed_servers:?}");
7491 // TODO this asynchronous job runs concurrently with extension (de)registration and may take enough time for a certain extension
7492 // to stop and unregister its language server wrapper.
7493 // This is racy : an extension might have already removed all `local.language_servers` state, but here we `.clone()` and hold onto it anyway.
7494 // This now causes errors in the logs, we should find a way to remove such servers from the processing everywhere.
7495 let _: Vec<Option<()>> = join_all(servers).await;
7496 Some(())
7497 })
7498 .await;
7499 }
7500
7501 fn toolchain_store(&self, cx: &App) -> Arc<dyn LanguageToolchainStore> {
7502 if let Some(toolchain_store) = self.toolchain_store.as_ref() {
7503 toolchain_store.read(cx).as_language_toolchain_store()
7504 } else {
7505 Arc::new(EmptyToolchainStore)
7506 }
7507 }
7508 fn maintain_workspace_config(
7509 fs: Arc<dyn Fs>,
7510 external_refresh_requests: watch::Receiver<()>,
7511 cx: &mut Context<Self>,
7512 ) -> Task<Result<()>> {
7513 let (mut settings_changed_tx, mut settings_changed_rx) = watch::channel();
7514 let _ = postage::stream::Stream::try_recv(&mut settings_changed_rx);
7515
7516 let settings_observation = cx.observe_global::<SettingsStore>(move |_, _| {
7517 *settings_changed_tx.borrow_mut() = ();
7518 });
7519
7520 let mut joint_future =
7521 futures::stream::select(settings_changed_rx, external_refresh_requests);
7522 cx.spawn(async move |this, cx| {
7523 while let Some(()) = joint_future.next().await {
7524 Self::refresh_workspace_configurations(&this, fs.clone(), cx).await;
7525 }
7526
7527 drop(settings_observation);
7528 anyhow::Ok(())
7529 })
7530 }
7531
7532 pub fn language_servers_for_local_buffer<'a>(
7533 &'a self,
7534 buffer: &Buffer,
7535 cx: &mut App,
7536 ) -> impl Iterator<Item = (&'a Arc<CachedLspAdapter>, &'a Arc<LanguageServer>)> {
7537 let local = self.as_local();
7538 let language_server_ids = local
7539 .map(|local| local.language_server_ids_for_buffer(buffer, cx))
7540 .unwrap_or_default();
7541
7542 language_server_ids
7543 .into_iter()
7544 .filter_map(
7545 move |server_id| match local?.language_servers.get(&server_id)? {
7546 LanguageServerState::Running {
7547 adapter, server, ..
7548 } => Some((adapter, server)),
7549 _ => None,
7550 },
7551 )
7552 }
7553
7554 pub fn language_server_for_local_buffer<'a>(
7555 &'a self,
7556 buffer: &'a Buffer,
7557 server_id: LanguageServerId,
7558 cx: &'a mut App,
7559 ) -> Option<(&'a Arc<CachedLspAdapter>, &'a Arc<LanguageServer>)> {
7560 self.as_local()?
7561 .language_servers_for_buffer(buffer, cx)
7562 .find(|(_, s)| s.server_id() == server_id)
7563 }
7564
7565 fn remove_worktree(&mut self, id_to_remove: WorktreeId, cx: &mut Context<Self>) {
7566 self.diagnostic_summaries.remove(&id_to_remove);
7567 if let Some(local) = self.as_local_mut() {
7568 let to_remove = local.remove_worktree(id_to_remove, cx);
7569 for server in to_remove {
7570 self.language_server_statuses.remove(&server);
7571 }
7572 }
7573 }
7574
7575 pub fn shared(
7576 &mut self,
7577 project_id: u64,
7578 downstream_client: AnyProtoClient,
7579 _: &mut Context<Self>,
7580 ) {
7581 self.downstream_client = Some((downstream_client.clone(), project_id));
7582
7583 for (server_id, status) in &self.language_server_statuses {
7584 if let Some(server) = self.language_server_for_id(*server_id) {
7585 downstream_client
7586 .send(proto::StartLanguageServer {
7587 project_id,
7588 server: Some(proto::LanguageServer {
7589 id: server_id.to_proto(),
7590 name: status.name.to_string(),
7591 worktree_id: None,
7592 }),
7593 capabilities: serde_json::to_string(&server.capabilities())
7594 .expect("serializing server LSP capabilities"),
7595 })
7596 .log_err();
7597 }
7598 }
7599 }
7600
7601 pub fn disconnected_from_host(&mut self) {
7602 self.downstream_client.take();
7603 }
7604
7605 pub fn disconnected_from_ssh_remote(&mut self) {
7606 if let LspStoreMode::Remote(RemoteLspStore {
7607 upstream_client, ..
7608 }) = &mut self.mode
7609 {
7610 upstream_client.take();
7611 }
7612 }
7613
7614 pub(crate) fn set_language_server_statuses_from_proto(
7615 &mut self,
7616 language_servers: Vec<proto::LanguageServer>,
7617 server_capabilities: Vec<String>,
7618 ) {
7619 self.language_server_statuses = language_servers
7620 .into_iter()
7621 .zip(server_capabilities)
7622 .map(|(server, server_capabilities)| {
7623 let server_id = LanguageServerId(server.id as usize);
7624 if let Ok(server_capabilities) = serde_json::from_str(&server_capabilities) {
7625 self.lsp_server_capabilities
7626 .insert(server_id, server_capabilities);
7627 }
7628 (
7629 server_id,
7630 LanguageServerStatus {
7631 name: LanguageServerName::from_proto(server.name),
7632 pending_work: Default::default(),
7633 has_pending_diagnostic_updates: false,
7634 progress_tokens: Default::default(),
7635 },
7636 )
7637 })
7638 .collect();
7639 }
7640
7641 fn register_local_language_server(
7642 &mut self,
7643 worktree: Entity<Worktree>,
7644 language_server_name: LanguageServerName,
7645 language_server_id: LanguageServerId,
7646 cx: &mut App,
7647 ) {
7648 let Some(local) = self.as_local_mut() else {
7649 return;
7650 };
7651
7652 let worktree_id = worktree.read(cx).id();
7653 if worktree.read(cx).is_visible() {
7654 let path = ProjectPath {
7655 worktree_id,
7656 path: Arc::from("".as_ref()),
7657 };
7658 let delegate = Arc::new(ManifestQueryDelegate::new(worktree.read(cx).snapshot()));
7659 local.lsp_tree.update(cx, |language_server_tree, cx| {
7660 for node in language_server_tree.get(
7661 path,
7662 AdapterQuery::Adapter(&language_server_name),
7663 delegate,
7664 cx,
7665 ) {
7666 node.server_id_or_init(|disposition| {
7667 assert_eq!(disposition.server_name, &language_server_name);
7668
7669 language_server_id
7670 });
7671 }
7672 });
7673 }
7674
7675 local
7676 .language_server_ids
7677 .entry((worktree_id, language_server_name))
7678 .or_default()
7679 .insert(language_server_id);
7680 }
7681
7682 #[cfg(test)]
7683 pub fn update_diagnostic_entries(
7684 &mut self,
7685 server_id: LanguageServerId,
7686 abs_path: PathBuf,
7687 result_id: Option<String>,
7688 version: Option<i32>,
7689 diagnostics: Vec<DiagnosticEntry<Unclipped<PointUtf16>>>,
7690 cx: &mut Context<Self>,
7691 ) -> anyhow::Result<()> {
7692 self.merge_diagnostic_entries(
7693 vec![DocumentDiagnosticsUpdate {
7694 diagnostics: DocumentDiagnostics {
7695 diagnostics,
7696 document_abs_path: abs_path,
7697 version,
7698 },
7699 result_id,
7700 server_id,
7701 disk_based_sources: Cow::Borrowed(&[]),
7702 }],
7703 |_, _, _| false,
7704 cx,
7705 )?;
7706 Ok(())
7707 }
7708
7709 pub fn merge_diagnostic_entries<'a>(
7710 &mut self,
7711 diagnostic_updates: Vec<DocumentDiagnosticsUpdate<'a, DocumentDiagnostics>>,
7712 merge: impl Fn(&Buffer, &Diagnostic, &App) -> bool + Clone,
7713 cx: &mut Context<Self>,
7714 ) -> anyhow::Result<()> {
7715 let mut diagnostics_summary = None::<proto::UpdateDiagnosticSummary>;
7716 let mut updated_diagnostics_paths = HashMap::default();
7717 for mut update in diagnostic_updates {
7718 let abs_path = &update.diagnostics.document_abs_path;
7719 let server_id = update.server_id;
7720 let Some((worktree, relative_path)) =
7721 self.worktree_store.read(cx).find_worktree(abs_path, cx)
7722 else {
7723 log::warn!("skipping diagnostics update, no worktree found for path {abs_path:?}");
7724 return Ok(());
7725 };
7726
7727 let worktree_id = worktree.read(cx).id();
7728 let project_path = ProjectPath {
7729 worktree_id,
7730 path: relative_path.into(),
7731 };
7732
7733 if let Some(buffer_handle) = self.buffer_store.read(cx).get_by_path(&project_path) {
7734 let snapshot = buffer_handle.read(cx).snapshot();
7735 let buffer = buffer_handle.read(cx);
7736 let reused_diagnostics = buffer
7737 .get_diagnostics(server_id)
7738 .into_iter()
7739 .flat_map(|diag| {
7740 diag.iter()
7741 .filter(|v| merge(buffer, &v.diagnostic, cx))
7742 .map(|v| {
7743 let start = Unclipped(v.range.start.to_point_utf16(&snapshot));
7744 let end = Unclipped(v.range.end.to_point_utf16(&snapshot));
7745 DiagnosticEntry {
7746 range: start..end,
7747 diagnostic: v.diagnostic.clone(),
7748 }
7749 })
7750 })
7751 .collect::<Vec<_>>();
7752
7753 self.as_local_mut()
7754 .context("cannot merge diagnostics on a remote LspStore")?
7755 .update_buffer_diagnostics(
7756 &buffer_handle,
7757 server_id,
7758 update.result_id,
7759 update.diagnostics.version,
7760 update.diagnostics.diagnostics.clone(),
7761 reused_diagnostics.clone(),
7762 cx,
7763 )?;
7764
7765 update.diagnostics.diagnostics.extend(reused_diagnostics);
7766 }
7767
7768 let updated = worktree.update(cx, |worktree, cx| {
7769 self.update_worktree_diagnostics(
7770 worktree.id(),
7771 server_id,
7772 project_path.path.clone(),
7773 update.diagnostics.diagnostics,
7774 cx,
7775 )
7776 })?;
7777 match updated {
7778 ControlFlow::Continue(new_summary) => {
7779 if let Some((project_id, new_summary)) = new_summary {
7780 match &mut diagnostics_summary {
7781 Some(diagnostics_summary) => {
7782 diagnostics_summary
7783 .more_summaries
7784 .push(proto::DiagnosticSummary {
7785 path: project_path.path.as_ref().to_proto(),
7786 language_server_id: server_id.0 as u64,
7787 error_count: new_summary.error_count,
7788 warning_count: new_summary.warning_count,
7789 })
7790 }
7791 None => {
7792 diagnostics_summary = Some(proto::UpdateDiagnosticSummary {
7793 project_id: project_id,
7794 worktree_id: worktree_id.to_proto(),
7795 summary: Some(proto::DiagnosticSummary {
7796 path: project_path.path.as_ref().to_proto(),
7797 language_server_id: server_id.0 as u64,
7798 error_count: new_summary.error_count,
7799 warning_count: new_summary.warning_count,
7800 }),
7801 more_summaries: Vec::new(),
7802 })
7803 }
7804 }
7805 }
7806 updated_diagnostics_paths
7807 .entry(server_id)
7808 .or_insert_with(Vec::new)
7809 .push(project_path);
7810 }
7811 ControlFlow::Break(()) => {}
7812 }
7813 }
7814
7815 if let Some((diagnostics_summary, (downstream_client, _))) =
7816 diagnostics_summary.zip(self.downstream_client.as_ref())
7817 {
7818 downstream_client.send(diagnostics_summary).log_err();
7819 }
7820 for (server_id, paths) in updated_diagnostics_paths {
7821 cx.emit(LspStoreEvent::DiagnosticsUpdated { server_id, paths });
7822 }
7823 Ok(())
7824 }
7825
7826 fn update_worktree_diagnostics(
7827 &mut self,
7828 worktree_id: WorktreeId,
7829 server_id: LanguageServerId,
7830 path_in_worktree: Arc<Path>,
7831 diagnostics: Vec<DiagnosticEntry<Unclipped<PointUtf16>>>,
7832 _: &mut Context<Worktree>,
7833 ) -> Result<ControlFlow<(), Option<(u64, proto::DiagnosticSummary)>>> {
7834 let local = match &mut self.mode {
7835 LspStoreMode::Local(local_lsp_store) => local_lsp_store,
7836 _ => anyhow::bail!("update_worktree_diagnostics called on remote"),
7837 };
7838
7839 let summaries_for_tree = self.diagnostic_summaries.entry(worktree_id).or_default();
7840 let diagnostics_for_tree = local.diagnostics.entry(worktree_id).or_default();
7841 let summaries_by_server_id = summaries_for_tree
7842 .entry(path_in_worktree.clone())
7843 .or_default();
7844
7845 let old_summary = summaries_by_server_id
7846 .remove(&server_id)
7847 .unwrap_or_default();
7848
7849 let new_summary = DiagnosticSummary::new(&diagnostics);
7850 if new_summary.is_empty() {
7851 if let Some(diagnostics_by_server_id) = diagnostics_for_tree.get_mut(&path_in_worktree)
7852 {
7853 if let Ok(ix) = diagnostics_by_server_id.binary_search_by_key(&server_id, |e| e.0) {
7854 diagnostics_by_server_id.remove(ix);
7855 }
7856 if diagnostics_by_server_id.is_empty() {
7857 diagnostics_for_tree.remove(&path_in_worktree);
7858 }
7859 }
7860 } else {
7861 summaries_by_server_id.insert(server_id, new_summary);
7862 let diagnostics_by_server_id = diagnostics_for_tree
7863 .entry(path_in_worktree.clone())
7864 .or_default();
7865 match diagnostics_by_server_id.binary_search_by_key(&server_id, |e| e.0) {
7866 Ok(ix) => {
7867 diagnostics_by_server_id[ix] = (server_id, diagnostics);
7868 }
7869 Err(ix) => {
7870 diagnostics_by_server_id.insert(ix, (server_id, diagnostics));
7871 }
7872 }
7873 }
7874
7875 if !old_summary.is_empty() || !new_summary.is_empty() {
7876 if let Some((_, project_id)) = &self.downstream_client {
7877 Ok(ControlFlow::Continue(Some((
7878 *project_id,
7879 proto::DiagnosticSummary {
7880 path: path_in_worktree.to_proto(),
7881 language_server_id: server_id.0 as u64,
7882 error_count: new_summary.error_count as u32,
7883 warning_count: new_summary.warning_count as u32,
7884 },
7885 ))))
7886 } else {
7887 Ok(ControlFlow::Continue(None))
7888 }
7889 } else {
7890 Ok(ControlFlow::Break(()))
7891 }
7892 }
7893
7894 pub fn open_buffer_for_symbol(
7895 &mut self,
7896 symbol: &Symbol,
7897 cx: &mut Context<Self>,
7898 ) -> Task<Result<Entity<Buffer>>> {
7899 if let Some((client, project_id)) = self.upstream_client() {
7900 let request = client.request(proto::OpenBufferForSymbol {
7901 project_id,
7902 symbol: Some(Self::serialize_symbol(symbol)),
7903 });
7904 cx.spawn(async move |this, cx| {
7905 let response = request.await?;
7906 let buffer_id = BufferId::new(response.buffer_id)?;
7907 this.update(cx, |this, cx| this.wait_for_remote_buffer(buffer_id, cx))?
7908 .await
7909 })
7910 } else if let Some(local) = self.as_local() {
7911 let Some(language_server_id) = local
7912 .language_server_ids
7913 .get(&(
7914 symbol.source_worktree_id,
7915 symbol.language_server_name.clone(),
7916 ))
7917 .and_then(|ids| {
7918 ids.contains(&symbol.source_language_server_id)
7919 .then_some(symbol.source_language_server_id)
7920 })
7921 else {
7922 return Task::ready(Err(anyhow!(
7923 "language server for worktree and language not found"
7924 )));
7925 };
7926
7927 let worktree_abs_path = if let Some(worktree_abs_path) = self
7928 .worktree_store
7929 .read(cx)
7930 .worktree_for_id(symbol.path.worktree_id, cx)
7931 .map(|worktree| worktree.read(cx).abs_path())
7932 {
7933 worktree_abs_path
7934 } else {
7935 return Task::ready(Err(anyhow!("worktree not found for symbol")));
7936 };
7937
7938 let symbol_abs_path = resolve_path(&worktree_abs_path, &symbol.path.path);
7939 let symbol_uri = if let Ok(uri) = lsp::Url::from_file_path(symbol_abs_path) {
7940 uri
7941 } else {
7942 return Task::ready(Err(anyhow!("invalid symbol path")));
7943 };
7944
7945 self.open_local_buffer_via_lsp(
7946 symbol_uri,
7947 language_server_id,
7948 symbol.language_server_name.clone(),
7949 cx,
7950 )
7951 } else {
7952 Task::ready(Err(anyhow!("no upstream client or local store")))
7953 }
7954 }
7955
7956 pub fn open_local_buffer_via_lsp(
7957 &mut self,
7958 mut abs_path: lsp::Url,
7959 language_server_id: LanguageServerId,
7960 language_server_name: LanguageServerName,
7961 cx: &mut Context<Self>,
7962 ) -> Task<Result<Entity<Buffer>>> {
7963 cx.spawn(async move |lsp_store, cx| {
7964 // Escape percent-encoded string.
7965 let current_scheme = abs_path.scheme().to_owned();
7966 let _ = abs_path.set_scheme("file");
7967
7968 let abs_path = abs_path
7969 .to_file_path()
7970 .map_err(|()| anyhow!("can't convert URI to path"))?;
7971 let p = abs_path.clone();
7972 let yarn_worktree = lsp_store
7973 .update(cx, move |lsp_store, cx| match lsp_store.as_local() {
7974 Some(local_lsp_store) => local_lsp_store.yarn.update(cx, |_, cx| {
7975 cx.spawn(async move |this, cx| {
7976 let t = this
7977 .update(cx, |this, cx| this.process_path(&p, ¤t_scheme, cx))
7978 .ok()?;
7979 t.await
7980 })
7981 }),
7982 None => Task::ready(None),
7983 })?
7984 .await;
7985 let (worktree_root_target, known_relative_path) =
7986 if let Some((zip_root, relative_path)) = yarn_worktree {
7987 (zip_root, Some(relative_path))
7988 } else {
7989 (Arc::<Path>::from(abs_path.as_path()), None)
7990 };
7991 let (worktree, relative_path) = if let Some(result) =
7992 lsp_store.update(cx, |lsp_store, cx| {
7993 lsp_store.worktree_store.update(cx, |worktree_store, cx| {
7994 worktree_store.find_worktree(&worktree_root_target, cx)
7995 })
7996 })? {
7997 let relative_path =
7998 known_relative_path.unwrap_or_else(|| Arc::<Path>::from(result.1));
7999 (result.0, relative_path)
8000 } else {
8001 let worktree = lsp_store
8002 .update(cx, |lsp_store, cx| {
8003 lsp_store.worktree_store.update(cx, |worktree_store, cx| {
8004 worktree_store.create_worktree(&worktree_root_target, false, cx)
8005 })
8006 })?
8007 .await?;
8008 if worktree.read_with(cx, |worktree, _| worktree.is_local())? {
8009 lsp_store
8010 .update(cx, |lsp_store, cx| {
8011 lsp_store.register_local_language_server(
8012 worktree.clone(),
8013 language_server_name,
8014 language_server_id,
8015 cx,
8016 )
8017 })
8018 .ok();
8019 }
8020 let worktree_root = worktree.read_with(cx, |worktree, _| worktree.abs_path())?;
8021 let relative_path = if let Some(known_path) = known_relative_path {
8022 known_path
8023 } else {
8024 abs_path.strip_prefix(worktree_root)?.into()
8025 };
8026 (worktree, relative_path)
8027 };
8028 let project_path = ProjectPath {
8029 worktree_id: worktree.read_with(cx, |worktree, _| worktree.id())?,
8030 path: relative_path,
8031 };
8032 lsp_store
8033 .update(cx, |lsp_store, cx| {
8034 lsp_store.buffer_store().update(cx, |buffer_store, cx| {
8035 buffer_store.open_buffer(project_path, cx)
8036 })
8037 })?
8038 .await
8039 })
8040 }
8041
8042 fn request_multiple_lsp_locally<P, R>(
8043 &mut self,
8044 buffer: &Entity<Buffer>,
8045 position: Option<P>,
8046 request: R,
8047 cx: &mut Context<Self>,
8048 ) -> Task<Vec<(LanguageServerId, R::Response)>>
8049 where
8050 P: ToOffset,
8051 R: LspCommand + Clone,
8052 <R::LspRequest as lsp::request::Request>::Result: Send,
8053 <R::LspRequest as lsp::request::Request>::Params: Send,
8054 {
8055 let Some(local) = self.as_local() else {
8056 return Task::ready(Vec::new());
8057 };
8058
8059 let snapshot = buffer.read(cx).snapshot();
8060 let scope = position.and_then(|position| snapshot.language_scope_at(position));
8061
8062 let server_ids = buffer.update(cx, |buffer, cx| {
8063 local
8064 .language_servers_for_buffer(buffer, cx)
8065 .filter(|(adapter, _)| {
8066 scope
8067 .as_ref()
8068 .map(|scope| scope.language_allowed(&adapter.name))
8069 .unwrap_or(true)
8070 })
8071 .map(|(_, server)| server.server_id())
8072 .filter(|server_id| {
8073 self.as_local().is_none_or(|local| {
8074 local
8075 .buffers_opened_in_servers
8076 .get(&snapshot.remote_id())
8077 .is_some_and(|servers| servers.contains(server_id))
8078 })
8079 })
8080 .collect::<Vec<_>>()
8081 });
8082
8083 let mut response_results = server_ids
8084 .into_iter()
8085 .map(|server_id| {
8086 let task = self.request_lsp(
8087 buffer.clone(),
8088 LanguageServerToQuery::Other(server_id),
8089 request.clone(),
8090 cx,
8091 );
8092 async move { (server_id, task.await) }
8093 })
8094 .collect::<FuturesUnordered<_>>();
8095
8096 cx.background_spawn(async move {
8097 let mut responses = Vec::with_capacity(response_results.len());
8098 while let Some((server_id, response_result)) = response_results.next().await {
8099 if let Some(response) = response_result.log_err() {
8100 responses.push((server_id, response));
8101 }
8102 }
8103 responses
8104 })
8105 }
8106
8107 async fn handle_lsp_command<T: LspCommand>(
8108 this: Entity<Self>,
8109 envelope: TypedEnvelope<T::ProtoRequest>,
8110 mut cx: AsyncApp,
8111 ) -> Result<<T::ProtoRequest as proto::RequestMessage>::Response>
8112 where
8113 <T::LspRequest as lsp::request::Request>::Params: Send,
8114 <T::LspRequest as lsp::request::Request>::Result: Send,
8115 {
8116 let sender_id = envelope.original_sender_id().unwrap_or_default();
8117 let buffer_id = T::buffer_id_from_proto(&envelope.payload)?;
8118 let buffer_handle = this.update(&mut cx, |this, cx| {
8119 this.buffer_store.read(cx).get_existing(buffer_id)
8120 })??;
8121 let request = T::from_proto(
8122 envelope.payload,
8123 this.clone(),
8124 buffer_handle.clone(),
8125 cx.clone(),
8126 )
8127 .await?;
8128 let response = this
8129 .update(&mut cx, |this, cx| {
8130 this.request_lsp(
8131 buffer_handle.clone(),
8132 LanguageServerToQuery::FirstCapable,
8133 request,
8134 cx,
8135 )
8136 })?
8137 .await?;
8138 this.update(&mut cx, |this, cx| {
8139 Ok(T::response_to_proto(
8140 response,
8141 this,
8142 sender_id,
8143 &buffer_handle.read(cx).version(),
8144 cx,
8145 ))
8146 })?
8147 }
8148
8149 async fn handle_multi_lsp_query(
8150 lsp_store: Entity<Self>,
8151 envelope: TypedEnvelope<proto::MultiLspQuery>,
8152 mut cx: AsyncApp,
8153 ) -> Result<proto::MultiLspQueryResponse> {
8154 let response_from_ssh = lsp_store.read_with(&mut cx, |this, _| {
8155 let (upstream_client, project_id) = this.upstream_client()?;
8156 let mut payload = envelope.payload.clone();
8157 payload.project_id = project_id;
8158
8159 Some(upstream_client.request(payload))
8160 })?;
8161 if let Some(response_from_ssh) = response_from_ssh {
8162 return response_from_ssh.await;
8163 }
8164
8165 let sender_id = envelope.original_sender_id().unwrap_or_default();
8166 let buffer_id = BufferId::new(envelope.payload.buffer_id)?;
8167 let version = deserialize_version(&envelope.payload.version);
8168 let buffer = lsp_store.update(&mut cx, |this, cx| {
8169 this.buffer_store.read(cx).get_existing(buffer_id)
8170 })??;
8171 buffer
8172 .update(&mut cx, |buffer, _| {
8173 buffer.wait_for_version(version.clone())
8174 })?
8175 .await?;
8176 let buffer_version = buffer.read_with(&mut cx, |buffer, _| buffer.version())?;
8177 match envelope
8178 .payload
8179 .strategy
8180 .context("invalid request without the strategy")?
8181 {
8182 proto::multi_lsp_query::Strategy::All(_) => {
8183 // currently, there's only one multiple language servers query strategy,
8184 // so just ensure it's specified correctly
8185 }
8186 }
8187 match envelope.payload.request {
8188 Some(proto::multi_lsp_query::Request::GetHover(message)) => {
8189 buffer
8190 .update(&mut cx, |buffer, _| {
8191 buffer.wait_for_version(deserialize_version(&message.version))
8192 })?
8193 .await?;
8194 let get_hover =
8195 GetHover::from_proto(message, lsp_store.clone(), buffer.clone(), cx.clone())
8196 .await?;
8197 let all_hovers = lsp_store
8198 .update(&mut cx, |this, cx| {
8199 this.request_multiple_lsp_locally(
8200 &buffer,
8201 Some(get_hover.position),
8202 get_hover,
8203 cx,
8204 )
8205 })?
8206 .await
8207 .into_iter()
8208 .filter_map(|(server_id, hover)| {
8209 Some((server_id, remove_empty_hover_blocks(hover?)?))
8210 });
8211 lsp_store.update(&mut cx, |project, cx| proto::MultiLspQueryResponse {
8212 responses: all_hovers
8213 .map(|(server_id, hover)| proto::LspResponse {
8214 server_id: server_id.to_proto(),
8215 response: Some(proto::lsp_response::Response::GetHoverResponse(
8216 GetHover::response_to_proto(
8217 Some(hover),
8218 project,
8219 sender_id,
8220 &buffer_version,
8221 cx,
8222 ),
8223 )),
8224 })
8225 .collect(),
8226 })
8227 }
8228 Some(proto::multi_lsp_query::Request::GetCodeActions(message)) => {
8229 buffer
8230 .update(&mut cx, |buffer, _| {
8231 buffer.wait_for_version(deserialize_version(&message.version))
8232 })?
8233 .await?;
8234 let get_code_actions = GetCodeActions::from_proto(
8235 message,
8236 lsp_store.clone(),
8237 buffer.clone(),
8238 cx.clone(),
8239 )
8240 .await?;
8241
8242 let all_actions = lsp_store
8243 .update(&mut cx, |project, cx| {
8244 project.request_multiple_lsp_locally(
8245 &buffer,
8246 Some(get_code_actions.range.start),
8247 get_code_actions,
8248 cx,
8249 )
8250 })?
8251 .await
8252 .into_iter();
8253
8254 lsp_store.update(&mut cx, |project, cx| proto::MultiLspQueryResponse {
8255 responses: all_actions
8256 .map(|(server_id, code_actions)| proto::LspResponse {
8257 server_id: server_id.to_proto(),
8258 response: Some(proto::lsp_response::Response::GetCodeActionsResponse(
8259 GetCodeActions::response_to_proto(
8260 code_actions,
8261 project,
8262 sender_id,
8263 &buffer_version,
8264 cx,
8265 ),
8266 )),
8267 })
8268 .collect(),
8269 })
8270 }
8271 Some(proto::multi_lsp_query::Request::GetSignatureHelp(message)) => {
8272 buffer
8273 .update(&mut cx, |buffer, _| {
8274 buffer.wait_for_version(deserialize_version(&message.version))
8275 })?
8276 .await?;
8277 let get_signature_help = GetSignatureHelp::from_proto(
8278 message,
8279 lsp_store.clone(),
8280 buffer.clone(),
8281 cx.clone(),
8282 )
8283 .await?;
8284
8285 let all_signatures = lsp_store
8286 .update(&mut cx, |project, cx| {
8287 project.request_multiple_lsp_locally(
8288 &buffer,
8289 Some(get_signature_help.position),
8290 get_signature_help,
8291 cx,
8292 )
8293 })?
8294 .await
8295 .into_iter();
8296
8297 lsp_store.update(&mut cx, |project, cx| proto::MultiLspQueryResponse {
8298 responses: all_signatures
8299 .map(|(server_id, signature_help)| proto::LspResponse {
8300 server_id: server_id.to_proto(),
8301 response: Some(
8302 proto::lsp_response::Response::GetSignatureHelpResponse(
8303 GetSignatureHelp::response_to_proto(
8304 signature_help,
8305 project,
8306 sender_id,
8307 &buffer_version,
8308 cx,
8309 ),
8310 ),
8311 ),
8312 })
8313 .collect(),
8314 })
8315 }
8316 Some(proto::multi_lsp_query::Request::GetCodeLens(message)) => {
8317 buffer
8318 .update(&mut cx, |buffer, _| {
8319 buffer.wait_for_version(deserialize_version(&message.version))
8320 })?
8321 .await?;
8322 let get_code_lens =
8323 GetCodeLens::from_proto(message, lsp_store.clone(), buffer.clone(), cx.clone())
8324 .await?;
8325
8326 let code_lens_actions = lsp_store
8327 .update(&mut cx, |project, cx| {
8328 project.request_multiple_lsp_locally(
8329 &buffer,
8330 None::<usize>,
8331 get_code_lens,
8332 cx,
8333 )
8334 })?
8335 .await
8336 .into_iter();
8337
8338 lsp_store.update(&mut cx, |project, cx| proto::MultiLspQueryResponse {
8339 responses: code_lens_actions
8340 .map(|(server_id, actions)| proto::LspResponse {
8341 server_id: server_id.to_proto(),
8342 response: Some(proto::lsp_response::Response::GetCodeLensResponse(
8343 GetCodeLens::response_to_proto(
8344 actions,
8345 project,
8346 sender_id,
8347 &buffer_version,
8348 cx,
8349 ),
8350 )),
8351 })
8352 .collect(),
8353 })
8354 }
8355 Some(proto::multi_lsp_query::Request::GetDocumentDiagnostics(message)) => {
8356 buffer
8357 .update(&mut cx, |buffer, _| {
8358 buffer.wait_for_version(deserialize_version(&message.version))
8359 })?
8360 .await?;
8361 lsp_store
8362 .update(&mut cx, |lsp_store, cx| {
8363 lsp_store.pull_diagnostics_for_buffer(buffer, cx)
8364 })?
8365 .await?;
8366 // `pull_diagnostics_for_buffer` will merge in the new diagnostics and send them to the client.
8367 // The client cannot merge anything into its non-local LspStore, so we do not need to return anything.
8368 Ok(proto::MultiLspQueryResponse {
8369 responses: Vec::new(),
8370 })
8371 }
8372 Some(proto::multi_lsp_query::Request::GetDocumentColor(message)) => {
8373 buffer
8374 .update(&mut cx, |buffer, _| {
8375 buffer.wait_for_version(deserialize_version(&message.version))
8376 })?
8377 .await?;
8378 let get_document_color = GetDocumentColor::from_proto(
8379 message,
8380 lsp_store.clone(),
8381 buffer.clone(),
8382 cx.clone(),
8383 )
8384 .await?;
8385
8386 let all_colors = lsp_store
8387 .update(&mut cx, |project, cx| {
8388 project.request_multiple_lsp_locally(
8389 &buffer,
8390 None::<usize>,
8391 get_document_color,
8392 cx,
8393 )
8394 })?
8395 .await
8396 .into_iter();
8397
8398 lsp_store.update(&mut cx, |project, cx| proto::MultiLspQueryResponse {
8399 responses: all_colors
8400 .map(|(server_id, colors)| proto::LspResponse {
8401 server_id: server_id.to_proto(),
8402 response: Some(
8403 proto::lsp_response::Response::GetDocumentColorResponse(
8404 GetDocumentColor::response_to_proto(
8405 colors,
8406 project,
8407 sender_id,
8408 &buffer_version,
8409 cx,
8410 ),
8411 ),
8412 ),
8413 })
8414 .collect(),
8415 })
8416 }
8417 Some(proto::multi_lsp_query::Request::GetDefinition(message)) => {
8418 let get_definitions = GetDefinitions::from_proto(
8419 message,
8420 lsp_store.clone(),
8421 buffer.clone(),
8422 cx.clone(),
8423 )
8424 .await?;
8425
8426 let definitions = lsp_store
8427 .update(&mut cx, |project, cx| {
8428 project.request_multiple_lsp_locally(
8429 &buffer,
8430 Some(get_definitions.position),
8431 get_definitions,
8432 cx,
8433 )
8434 })?
8435 .await
8436 .into_iter();
8437
8438 lsp_store.update(&mut cx, |project, cx| proto::MultiLspQueryResponse {
8439 responses: definitions
8440 .map(|(server_id, definitions)| proto::LspResponse {
8441 server_id: server_id.to_proto(),
8442 response: Some(proto::lsp_response::Response::GetDefinitionResponse(
8443 GetDefinitions::response_to_proto(
8444 definitions,
8445 project,
8446 sender_id,
8447 &buffer_version,
8448 cx,
8449 ),
8450 )),
8451 })
8452 .collect(),
8453 })
8454 }
8455 Some(proto::multi_lsp_query::Request::GetDeclaration(message)) => {
8456 let get_declarations = GetDeclarations::from_proto(
8457 message,
8458 lsp_store.clone(),
8459 buffer.clone(),
8460 cx.clone(),
8461 )
8462 .await?;
8463
8464 let declarations = lsp_store
8465 .update(&mut cx, |project, cx| {
8466 project.request_multiple_lsp_locally(
8467 &buffer,
8468 Some(get_declarations.position),
8469 get_declarations,
8470 cx,
8471 )
8472 })?
8473 .await
8474 .into_iter();
8475
8476 lsp_store.update(&mut cx, |project, cx| proto::MultiLspQueryResponse {
8477 responses: declarations
8478 .map(|(server_id, declarations)| proto::LspResponse {
8479 server_id: server_id.to_proto(),
8480 response: Some(proto::lsp_response::Response::GetDeclarationResponse(
8481 GetDeclarations::response_to_proto(
8482 declarations,
8483 project,
8484 sender_id,
8485 &buffer_version,
8486 cx,
8487 ),
8488 )),
8489 })
8490 .collect(),
8491 })
8492 }
8493 Some(proto::multi_lsp_query::Request::GetTypeDefinition(message)) => {
8494 let get_type_definitions = GetTypeDefinitions::from_proto(
8495 message,
8496 lsp_store.clone(),
8497 buffer.clone(),
8498 cx.clone(),
8499 )
8500 .await?;
8501
8502 let type_definitions = lsp_store
8503 .update(&mut cx, |project, cx| {
8504 project.request_multiple_lsp_locally(
8505 &buffer,
8506 Some(get_type_definitions.position),
8507 get_type_definitions,
8508 cx,
8509 )
8510 })?
8511 .await
8512 .into_iter();
8513
8514 lsp_store.update(&mut cx, |project, cx| proto::MultiLspQueryResponse {
8515 responses: type_definitions
8516 .map(|(server_id, type_definitions)| proto::LspResponse {
8517 server_id: server_id.to_proto(),
8518 response: Some(
8519 proto::lsp_response::Response::GetTypeDefinitionResponse(
8520 GetTypeDefinitions::response_to_proto(
8521 type_definitions,
8522 project,
8523 sender_id,
8524 &buffer_version,
8525 cx,
8526 ),
8527 ),
8528 ),
8529 })
8530 .collect(),
8531 })
8532 }
8533 Some(proto::multi_lsp_query::Request::GetImplementation(message)) => {
8534 let get_implementations = GetImplementations::from_proto(
8535 message,
8536 lsp_store.clone(),
8537 buffer.clone(),
8538 cx.clone(),
8539 )
8540 .await?;
8541
8542 let implementations = lsp_store
8543 .update(&mut cx, |project, cx| {
8544 project.request_multiple_lsp_locally(
8545 &buffer,
8546 Some(get_implementations.position),
8547 get_implementations,
8548 cx,
8549 )
8550 })?
8551 .await
8552 .into_iter();
8553
8554 lsp_store.update(&mut cx, |project, cx| proto::MultiLspQueryResponse {
8555 responses: implementations
8556 .map(|(server_id, implementations)| proto::LspResponse {
8557 server_id: server_id.to_proto(),
8558 response: Some(
8559 proto::lsp_response::Response::GetImplementationResponse(
8560 GetImplementations::response_to_proto(
8561 implementations,
8562 project,
8563 sender_id,
8564 &buffer_version,
8565 cx,
8566 ),
8567 ),
8568 ),
8569 })
8570 .collect(),
8571 })
8572 }
8573 Some(proto::multi_lsp_query::Request::GetReferences(message)) => {
8574 let get_references = GetReferences::from_proto(
8575 message,
8576 lsp_store.clone(),
8577 buffer.clone(),
8578 cx.clone(),
8579 )
8580 .await?;
8581
8582 let references = lsp_store
8583 .update(&mut cx, |project, cx| {
8584 project.request_multiple_lsp_locally(
8585 &buffer,
8586 Some(get_references.position),
8587 get_references,
8588 cx,
8589 )
8590 })?
8591 .await
8592 .into_iter();
8593
8594 lsp_store.update(&mut cx, |project, cx| proto::MultiLspQueryResponse {
8595 responses: references
8596 .map(|(server_id, references)| proto::LspResponse {
8597 server_id: server_id.to_proto(),
8598 response: Some(proto::lsp_response::Response::GetReferencesResponse(
8599 GetReferences::response_to_proto(
8600 references,
8601 project,
8602 sender_id,
8603 &buffer_version,
8604 cx,
8605 ),
8606 )),
8607 })
8608 .collect(),
8609 })
8610 }
8611 None => anyhow::bail!("empty multi lsp query request"),
8612 }
8613 }
8614
8615 async fn handle_apply_code_action(
8616 this: Entity<Self>,
8617 envelope: TypedEnvelope<proto::ApplyCodeAction>,
8618 mut cx: AsyncApp,
8619 ) -> Result<proto::ApplyCodeActionResponse> {
8620 let sender_id = envelope.original_sender_id().unwrap_or_default();
8621 let action =
8622 Self::deserialize_code_action(envelope.payload.action.context("invalid action")?)?;
8623 let apply_code_action = this.update(&mut cx, |this, cx| {
8624 let buffer_id = BufferId::new(envelope.payload.buffer_id)?;
8625 let buffer = this.buffer_store.read(cx).get_existing(buffer_id)?;
8626 anyhow::Ok(this.apply_code_action(buffer, action, false, cx))
8627 })??;
8628
8629 let project_transaction = apply_code_action.await?;
8630 let project_transaction = this.update(&mut cx, |this, cx| {
8631 this.buffer_store.update(cx, |buffer_store, cx| {
8632 buffer_store.serialize_project_transaction_for_peer(
8633 project_transaction,
8634 sender_id,
8635 cx,
8636 )
8637 })
8638 })?;
8639 Ok(proto::ApplyCodeActionResponse {
8640 transaction: Some(project_transaction),
8641 })
8642 }
8643
8644 async fn handle_register_buffer_with_language_servers(
8645 this: Entity<Self>,
8646 envelope: TypedEnvelope<proto::RegisterBufferWithLanguageServers>,
8647 mut cx: AsyncApp,
8648 ) -> Result<proto::Ack> {
8649 let buffer_id = BufferId::new(envelope.payload.buffer_id)?;
8650 let peer_id = envelope.original_sender_id.unwrap_or(envelope.sender_id);
8651 this.update(&mut cx, |this, cx| {
8652 if let Some((upstream_client, upstream_project_id)) = this.upstream_client() {
8653 return upstream_client.send(proto::RegisterBufferWithLanguageServers {
8654 project_id: upstream_project_id,
8655 buffer_id: buffer_id.to_proto(),
8656 only_servers: envelope.payload.only_servers,
8657 });
8658 }
8659
8660 let Some(buffer) = this.buffer_store().read(cx).get(buffer_id) else {
8661 anyhow::bail!("buffer is not open");
8662 };
8663
8664 let handle = this.register_buffer_with_language_servers(
8665 &buffer,
8666 envelope
8667 .payload
8668 .only_servers
8669 .into_iter()
8670 .filter_map(|selector| {
8671 Some(match selector.selector? {
8672 proto::language_server_selector::Selector::ServerId(server_id) => {
8673 LanguageServerSelector::Id(LanguageServerId::from_proto(server_id))
8674 }
8675 proto::language_server_selector::Selector::Name(name) => {
8676 LanguageServerSelector::Name(LanguageServerName(
8677 SharedString::from(name),
8678 ))
8679 }
8680 })
8681 })
8682 .collect(),
8683 false,
8684 cx,
8685 );
8686 this.buffer_store().update(cx, |buffer_store, _| {
8687 buffer_store.register_shared_lsp_handle(peer_id, buffer_id, handle);
8688 });
8689
8690 Ok(())
8691 })??;
8692 Ok(proto::Ack {})
8693 }
8694
8695 async fn handle_rename_project_entry(
8696 this: Entity<Self>,
8697 envelope: TypedEnvelope<proto::RenameProjectEntry>,
8698 mut cx: AsyncApp,
8699 ) -> Result<proto::ProjectEntryResponse> {
8700 let entry_id = ProjectEntryId::from_proto(envelope.payload.entry_id);
8701 let (worktree_id, worktree, old_path, is_dir) = this
8702 .update(&mut cx, |this, cx| {
8703 this.worktree_store
8704 .read(cx)
8705 .worktree_and_entry_for_id(entry_id, cx)
8706 .map(|(worktree, entry)| {
8707 (
8708 worktree.read(cx).id(),
8709 worktree,
8710 entry.path.clone(),
8711 entry.is_dir(),
8712 )
8713 })
8714 })?
8715 .context("worktree not found")?;
8716 let (old_abs_path, new_abs_path) = {
8717 let root_path = worktree.read_with(&mut cx, |this, _| this.abs_path())?;
8718 let new_path = PathBuf::from_proto(envelope.payload.new_path.clone());
8719 (root_path.join(&old_path), root_path.join(&new_path))
8720 };
8721
8722 Self::will_rename_entry(
8723 this.downgrade(),
8724 worktree_id,
8725 &old_abs_path,
8726 &new_abs_path,
8727 is_dir,
8728 cx.clone(),
8729 )
8730 .await;
8731 let response = Worktree::handle_rename_entry(worktree, envelope.payload, cx.clone()).await;
8732 this.read_with(&mut cx, |this, _| {
8733 this.did_rename_entry(worktree_id, &old_abs_path, &new_abs_path, is_dir);
8734 })
8735 .ok();
8736 response
8737 }
8738
8739 async fn handle_update_diagnostic_summary(
8740 this: Entity<Self>,
8741 envelope: TypedEnvelope<proto::UpdateDiagnosticSummary>,
8742 mut cx: AsyncApp,
8743 ) -> Result<()> {
8744 this.update(&mut cx, |lsp_store, cx| {
8745 let worktree_id = WorktreeId::from_proto(envelope.payload.worktree_id);
8746 let mut updated_diagnostics_paths = HashMap::default();
8747 let mut diagnostics_summary = None::<proto::UpdateDiagnosticSummary>;
8748 for message_summary in envelope
8749 .payload
8750 .summary
8751 .into_iter()
8752 .chain(envelope.payload.more_summaries)
8753 {
8754 let project_path = ProjectPath {
8755 worktree_id,
8756 path: Arc::<Path>::from_proto(message_summary.path),
8757 };
8758 let path = project_path.path.clone();
8759 let server_id = LanguageServerId(message_summary.language_server_id as usize);
8760 let summary = DiagnosticSummary {
8761 error_count: message_summary.error_count as usize,
8762 warning_count: message_summary.warning_count as usize,
8763 };
8764
8765 if summary.is_empty() {
8766 if let Some(worktree_summaries) =
8767 lsp_store.diagnostic_summaries.get_mut(&worktree_id)
8768 {
8769 if let Some(summaries) = worktree_summaries.get_mut(&path) {
8770 summaries.remove(&server_id);
8771 if summaries.is_empty() {
8772 worktree_summaries.remove(&path);
8773 }
8774 }
8775 }
8776 } else {
8777 lsp_store
8778 .diagnostic_summaries
8779 .entry(worktree_id)
8780 .or_default()
8781 .entry(path)
8782 .or_default()
8783 .insert(server_id, summary);
8784 }
8785
8786 if let Some((_, project_id)) = &lsp_store.downstream_client {
8787 match &mut diagnostics_summary {
8788 Some(diagnostics_summary) => {
8789 diagnostics_summary
8790 .more_summaries
8791 .push(proto::DiagnosticSummary {
8792 path: project_path.path.as_ref().to_proto(),
8793 language_server_id: server_id.0 as u64,
8794 error_count: summary.error_count as u32,
8795 warning_count: summary.warning_count as u32,
8796 })
8797 }
8798 None => {
8799 diagnostics_summary = Some(proto::UpdateDiagnosticSummary {
8800 project_id: *project_id,
8801 worktree_id: worktree_id.to_proto(),
8802 summary: Some(proto::DiagnosticSummary {
8803 path: project_path.path.as_ref().to_proto(),
8804 language_server_id: server_id.0 as u64,
8805 error_count: summary.error_count as u32,
8806 warning_count: summary.warning_count as u32,
8807 }),
8808 more_summaries: Vec::new(),
8809 })
8810 }
8811 }
8812 }
8813 updated_diagnostics_paths
8814 .entry(server_id)
8815 .or_insert_with(Vec::new)
8816 .push(project_path);
8817 }
8818
8819 if let Some((diagnostics_summary, (downstream_client, _))) =
8820 diagnostics_summary.zip(lsp_store.downstream_client.as_ref())
8821 {
8822 downstream_client.send(diagnostics_summary).log_err();
8823 }
8824 for (server_id, paths) in updated_diagnostics_paths {
8825 cx.emit(LspStoreEvent::DiagnosticsUpdated { server_id, paths });
8826 }
8827 Ok(())
8828 })?
8829 }
8830
8831 async fn handle_start_language_server(
8832 lsp_store: Entity<Self>,
8833 envelope: TypedEnvelope<proto::StartLanguageServer>,
8834 mut cx: AsyncApp,
8835 ) -> Result<()> {
8836 let server = envelope.payload.server.context("invalid server")?;
8837 let server_capabilities =
8838 serde_json::from_str::<lsp::ServerCapabilities>(&envelope.payload.capabilities)
8839 .with_context(|| {
8840 format!(
8841 "incorrect server capabilities {}",
8842 envelope.payload.capabilities
8843 )
8844 })?;
8845 lsp_store.update(&mut cx, |lsp_store, cx| {
8846 let server_id = LanguageServerId(server.id as usize);
8847 let server_name = LanguageServerName::from_proto(server.name.clone());
8848 lsp_store
8849 .lsp_server_capabilities
8850 .insert(server_id, server_capabilities);
8851 lsp_store.language_server_statuses.insert(
8852 server_id,
8853 LanguageServerStatus {
8854 name: server_name.clone(),
8855 pending_work: Default::default(),
8856 has_pending_diagnostic_updates: false,
8857 progress_tokens: Default::default(),
8858 },
8859 );
8860 cx.emit(LspStoreEvent::LanguageServerAdded(
8861 server_id,
8862 server_name,
8863 server.worktree_id.map(WorktreeId::from_proto),
8864 ));
8865 cx.notify();
8866 })?;
8867 Ok(())
8868 }
8869
8870 async fn handle_update_language_server(
8871 lsp_store: Entity<Self>,
8872 envelope: TypedEnvelope<proto::UpdateLanguageServer>,
8873 mut cx: AsyncApp,
8874 ) -> Result<()> {
8875 lsp_store.update(&mut cx, |lsp_store, cx| {
8876 let language_server_id = LanguageServerId(envelope.payload.language_server_id as usize);
8877
8878 match envelope.payload.variant.context("invalid variant")? {
8879 proto::update_language_server::Variant::WorkStart(payload) => {
8880 lsp_store.on_lsp_work_start(
8881 language_server_id,
8882 payload.token,
8883 LanguageServerProgress {
8884 title: payload.title,
8885 is_disk_based_diagnostics_progress: false,
8886 is_cancellable: payload.is_cancellable.unwrap_or(false),
8887 message: payload.message,
8888 percentage: payload.percentage.map(|p| p as usize),
8889 last_update_at: cx.background_executor().now(),
8890 },
8891 cx,
8892 );
8893 }
8894 proto::update_language_server::Variant::WorkProgress(payload) => {
8895 lsp_store.on_lsp_work_progress(
8896 language_server_id,
8897 payload.token,
8898 LanguageServerProgress {
8899 title: None,
8900 is_disk_based_diagnostics_progress: false,
8901 is_cancellable: payload.is_cancellable.unwrap_or(false),
8902 message: payload.message,
8903 percentage: payload.percentage.map(|p| p as usize),
8904 last_update_at: cx.background_executor().now(),
8905 },
8906 cx,
8907 );
8908 }
8909
8910 proto::update_language_server::Variant::WorkEnd(payload) => {
8911 lsp_store.on_lsp_work_end(language_server_id, payload.token, cx);
8912 }
8913
8914 proto::update_language_server::Variant::DiskBasedDiagnosticsUpdating(_) => {
8915 lsp_store.disk_based_diagnostics_started(language_server_id, cx);
8916 }
8917
8918 proto::update_language_server::Variant::DiskBasedDiagnosticsUpdated(_) => {
8919 lsp_store.disk_based_diagnostics_finished(language_server_id, cx)
8920 }
8921
8922 non_lsp @ proto::update_language_server::Variant::StatusUpdate(_)
8923 | non_lsp @ proto::update_language_server::Variant::RegisteredForBuffer(_)
8924 | non_lsp @ proto::update_language_server::Variant::MetadataUpdated(_) => {
8925 cx.emit(LspStoreEvent::LanguageServerUpdate {
8926 language_server_id,
8927 name: envelope
8928 .payload
8929 .server_name
8930 .map(SharedString::new)
8931 .map(LanguageServerName),
8932 message: non_lsp,
8933 });
8934 }
8935 }
8936
8937 Ok(())
8938 })?
8939 }
8940
8941 async fn handle_language_server_log(
8942 this: Entity<Self>,
8943 envelope: TypedEnvelope<proto::LanguageServerLog>,
8944 mut cx: AsyncApp,
8945 ) -> Result<()> {
8946 let language_server_id = LanguageServerId(envelope.payload.language_server_id as usize);
8947 let log_type = envelope
8948 .payload
8949 .log_type
8950 .map(LanguageServerLogType::from_proto)
8951 .context("invalid language server log type")?;
8952
8953 let message = envelope.payload.message;
8954
8955 this.update(&mut cx, |_, cx| {
8956 cx.emit(LspStoreEvent::LanguageServerLog(
8957 language_server_id,
8958 log_type,
8959 message,
8960 ));
8961 })
8962 }
8963
8964 async fn handle_lsp_ext_cancel_flycheck(
8965 lsp_store: Entity<Self>,
8966 envelope: TypedEnvelope<proto::LspExtCancelFlycheck>,
8967 mut cx: AsyncApp,
8968 ) -> Result<proto::Ack> {
8969 let server_id = LanguageServerId(envelope.payload.language_server_id as usize);
8970 lsp_store.read_with(&mut cx, |lsp_store, _| {
8971 if let Some(server) = lsp_store.language_server_for_id(server_id) {
8972 server
8973 .notify::<lsp_store::lsp_ext_command::LspExtCancelFlycheck>(&())
8974 .context("handling lsp ext cancel flycheck")
8975 } else {
8976 anyhow::Ok(())
8977 }
8978 })??;
8979
8980 Ok(proto::Ack {})
8981 }
8982
8983 async fn handle_lsp_ext_run_flycheck(
8984 lsp_store: Entity<Self>,
8985 envelope: TypedEnvelope<proto::LspExtRunFlycheck>,
8986 mut cx: AsyncApp,
8987 ) -> Result<proto::Ack> {
8988 let server_id = LanguageServerId(envelope.payload.language_server_id as usize);
8989 lsp_store.update(&mut cx, |lsp_store, cx| {
8990 if let Some(server) = lsp_store.language_server_for_id(server_id) {
8991 let text_document = if envelope.payload.current_file_only {
8992 let buffer_id = BufferId::new(envelope.payload.buffer_id)?;
8993 lsp_store
8994 .buffer_store()
8995 .read(cx)
8996 .get(buffer_id)
8997 .and_then(|buffer| Some(buffer.read(cx).file()?.as_local()?.abs_path(cx)))
8998 .map(|path| make_text_document_identifier(&path))
8999 .transpose()?
9000 } else {
9001 None
9002 };
9003 server
9004 .notify::<lsp_store::lsp_ext_command::LspExtRunFlycheck>(
9005 &lsp_store::lsp_ext_command::RunFlycheckParams { text_document },
9006 )
9007 .context("handling lsp ext run flycheck")
9008 } else {
9009 anyhow::Ok(())
9010 }
9011 })??;
9012
9013 Ok(proto::Ack {})
9014 }
9015
9016 async fn handle_lsp_ext_clear_flycheck(
9017 lsp_store: Entity<Self>,
9018 envelope: TypedEnvelope<proto::LspExtClearFlycheck>,
9019 mut cx: AsyncApp,
9020 ) -> Result<proto::Ack> {
9021 let server_id = LanguageServerId(envelope.payload.language_server_id as usize);
9022 lsp_store.read_with(&mut cx, |lsp_store, _| {
9023 if let Some(server) = lsp_store.language_server_for_id(server_id) {
9024 server
9025 .notify::<lsp_store::lsp_ext_command::LspExtClearFlycheck>(&())
9026 .context("handling lsp ext clear flycheck")
9027 } else {
9028 anyhow::Ok(())
9029 }
9030 })??;
9031
9032 Ok(proto::Ack {})
9033 }
9034
9035 pub fn disk_based_diagnostics_started(
9036 &mut self,
9037 language_server_id: LanguageServerId,
9038 cx: &mut Context<Self>,
9039 ) {
9040 if let Some(language_server_status) =
9041 self.language_server_statuses.get_mut(&language_server_id)
9042 {
9043 language_server_status.has_pending_diagnostic_updates = true;
9044 }
9045
9046 cx.emit(LspStoreEvent::DiskBasedDiagnosticsStarted { language_server_id });
9047 cx.emit(LspStoreEvent::LanguageServerUpdate {
9048 language_server_id,
9049 name: self
9050 .language_server_adapter_for_id(language_server_id)
9051 .map(|adapter| adapter.name()),
9052 message: proto::update_language_server::Variant::DiskBasedDiagnosticsUpdating(
9053 Default::default(),
9054 ),
9055 })
9056 }
9057
9058 pub fn disk_based_diagnostics_finished(
9059 &mut self,
9060 language_server_id: LanguageServerId,
9061 cx: &mut Context<Self>,
9062 ) {
9063 if let Some(language_server_status) =
9064 self.language_server_statuses.get_mut(&language_server_id)
9065 {
9066 language_server_status.has_pending_diagnostic_updates = false;
9067 }
9068
9069 cx.emit(LspStoreEvent::DiskBasedDiagnosticsFinished { language_server_id });
9070 cx.emit(LspStoreEvent::LanguageServerUpdate {
9071 language_server_id,
9072 name: self
9073 .language_server_adapter_for_id(language_server_id)
9074 .map(|adapter| adapter.name()),
9075 message: proto::update_language_server::Variant::DiskBasedDiagnosticsUpdated(
9076 Default::default(),
9077 ),
9078 })
9079 }
9080
9081 // After saving a buffer using a language server that doesn't provide a disk-based progress token,
9082 // kick off a timer that will reset every time the buffer is saved. If the timer eventually fires,
9083 // simulate disk-based diagnostics being finished so that other pieces of UI (e.g., project
9084 // diagnostics view, diagnostic status bar) can update. We don't emit an event right away because
9085 // the language server might take some time to publish diagnostics.
9086 fn simulate_disk_based_diagnostics_events_if_needed(
9087 &mut self,
9088 language_server_id: LanguageServerId,
9089 cx: &mut Context<Self>,
9090 ) {
9091 const DISK_BASED_DIAGNOSTICS_DEBOUNCE: Duration = Duration::from_secs(1);
9092
9093 let Some(LanguageServerState::Running {
9094 simulate_disk_based_diagnostics_completion,
9095 adapter,
9096 ..
9097 }) = self
9098 .as_local_mut()
9099 .and_then(|local_store| local_store.language_servers.get_mut(&language_server_id))
9100 else {
9101 return;
9102 };
9103
9104 if adapter.disk_based_diagnostics_progress_token.is_some() {
9105 return;
9106 }
9107
9108 let prev_task =
9109 simulate_disk_based_diagnostics_completion.replace(cx.spawn(async move |this, cx| {
9110 cx.background_executor()
9111 .timer(DISK_BASED_DIAGNOSTICS_DEBOUNCE)
9112 .await;
9113
9114 this.update(cx, |this, cx| {
9115 this.disk_based_diagnostics_finished(language_server_id, cx);
9116
9117 if let Some(LanguageServerState::Running {
9118 simulate_disk_based_diagnostics_completion,
9119 ..
9120 }) = this.as_local_mut().and_then(|local_store| {
9121 local_store.language_servers.get_mut(&language_server_id)
9122 }) {
9123 *simulate_disk_based_diagnostics_completion = None;
9124 }
9125 })
9126 .ok();
9127 }));
9128
9129 if prev_task.is_none() {
9130 self.disk_based_diagnostics_started(language_server_id, cx);
9131 }
9132 }
9133
9134 pub fn language_server_statuses(
9135 &self,
9136 ) -> impl DoubleEndedIterator<Item = (LanguageServerId, &LanguageServerStatus)> {
9137 self.language_server_statuses
9138 .iter()
9139 .map(|(key, value)| (*key, value))
9140 }
9141
9142 pub(super) fn did_rename_entry(
9143 &self,
9144 worktree_id: WorktreeId,
9145 old_path: &Path,
9146 new_path: &Path,
9147 is_dir: bool,
9148 ) {
9149 maybe!({
9150 let local_store = self.as_local()?;
9151
9152 let old_uri = lsp::Url::from_file_path(old_path).ok().map(String::from)?;
9153 let new_uri = lsp::Url::from_file_path(new_path).ok().map(String::from)?;
9154
9155 for language_server in local_store.language_servers_for_worktree(worktree_id) {
9156 let Some(filter) = local_store
9157 .language_server_paths_watched_for_rename
9158 .get(&language_server.server_id())
9159 else {
9160 continue;
9161 };
9162
9163 if filter.should_send_did_rename(&old_uri, is_dir) {
9164 language_server
9165 .notify::<DidRenameFiles>(&RenameFilesParams {
9166 files: vec![FileRename {
9167 old_uri: old_uri.clone(),
9168 new_uri: new_uri.clone(),
9169 }],
9170 })
9171 .ok();
9172 }
9173 }
9174 Some(())
9175 });
9176 }
9177
9178 pub(super) fn will_rename_entry(
9179 this: WeakEntity<Self>,
9180 worktree_id: WorktreeId,
9181 old_path: &Path,
9182 new_path: &Path,
9183 is_dir: bool,
9184 cx: AsyncApp,
9185 ) -> Task<()> {
9186 let old_uri = lsp::Url::from_file_path(old_path).ok().map(String::from);
9187 let new_uri = lsp::Url::from_file_path(new_path).ok().map(String::from);
9188 cx.spawn(async move |cx| {
9189 let mut tasks = vec![];
9190 this.update(cx, |this, cx| {
9191 let local_store = this.as_local()?;
9192 let old_uri = old_uri?;
9193 let new_uri = new_uri?;
9194 for language_server in local_store.language_servers_for_worktree(worktree_id) {
9195 let Some(filter) = local_store
9196 .language_server_paths_watched_for_rename
9197 .get(&language_server.server_id())
9198 else {
9199 continue;
9200 };
9201 let Some(adapter) =
9202 this.language_server_adapter_for_id(language_server.server_id())
9203 else {
9204 continue;
9205 };
9206 if filter.should_send_will_rename(&old_uri, is_dir) {
9207 let apply_edit = cx.spawn({
9208 let old_uri = old_uri.clone();
9209 let new_uri = new_uri.clone();
9210 let language_server = language_server.clone();
9211 async move |this, cx| {
9212 let edit = language_server
9213 .request::<WillRenameFiles>(RenameFilesParams {
9214 files: vec![FileRename { old_uri, new_uri }],
9215 })
9216 .await
9217 .into_response()
9218 .context("will rename files")
9219 .log_err()
9220 .flatten()?;
9221
9222 LocalLspStore::deserialize_workspace_edit(
9223 this.upgrade()?,
9224 edit,
9225 false,
9226 adapter.clone(),
9227 language_server.clone(),
9228 cx,
9229 )
9230 .await
9231 .ok();
9232 Some(())
9233 }
9234 });
9235 tasks.push(apply_edit);
9236 }
9237 }
9238 Some(())
9239 })
9240 .ok()
9241 .flatten();
9242 for task in tasks {
9243 // Await on tasks sequentially so that the order of application of edits is deterministic
9244 // (at least with regards to the order of registration of language servers)
9245 task.await;
9246 }
9247 })
9248 }
9249
9250 fn lsp_notify_abs_paths_changed(
9251 &mut self,
9252 server_id: LanguageServerId,
9253 changes: Vec<PathEvent>,
9254 ) {
9255 maybe!({
9256 let server = self.language_server_for_id(server_id)?;
9257 let changes = changes
9258 .into_iter()
9259 .filter_map(|event| {
9260 let typ = match event.kind? {
9261 PathEventKind::Created => lsp::FileChangeType::CREATED,
9262 PathEventKind::Removed => lsp::FileChangeType::DELETED,
9263 PathEventKind::Changed => lsp::FileChangeType::CHANGED,
9264 };
9265 Some(lsp::FileEvent {
9266 uri: file_path_to_lsp_url(&event.path).log_err()?,
9267 typ,
9268 })
9269 })
9270 .collect::<Vec<_>>();
9271 if !changes.is_empty() {
9272 server
9273 .notify::<lsp::notification::DidChangeWatchedFiles>(
9274 &lsp::DidChangeWatchedFilesParams { changes },
9275 )
9276 .ok();
9277 }
9278 Some(())
9279 });
9280 }
9281
9282 pub fn language_server_for_id(&self, id: LanguageServerId) -> Option<Arc<LanguageServer>> {
9283 self.as_local()?.language_server_for_id(id)
9284 }
9285
9286 fn on_lsp_progress(
9287 &mut self,
9288 progress: lsp::ProgressParams,
9289 language_server_id: LanguageServerId,
9290 disk_based_diagnostics_progress_token: Option<String>,
9291 cx: &mut Context<Self>,
9292 ) {
9293 let token = match progress.token {
9294 lsp::NumberOrString::String(token) => token,
9295 lsp::NumberOrString::Number(token) => {
9296 log::info!("skipping numeric progress token {}", token);
9297 return;
9298 }
9299 };
9300
9301 match progress.value {
9302 lsp::ProgressParamsValue::WorkDone(progress) => {
9303 self.handle_work_done_progress(
9304 progress,
9305 language_server_id,
9306 disk_based_diagnostics_progress_token,
9307 token,
9308 cx,
9309 );
9310 }
9311 lsp::ProgressParamsValue::WorkspaceDiagnostic(report) => {
9312 if let Some(LanguageServerState::Running {
9313 workspace_refresh_task: Some(workspace_refresh_task),
9314 ..
9315 }) = self
9316 .as_local_mut()
9317 .and_then(|local| local.language_servers.get_mut(&language_server_id))
9318 {
9319 workspace_refresh_task.progress_tx.try_send(()).ok();
9320 self.apply_workspace_diagnostic_report(language_server_id, report, cx)
9321 }
9322 }
9323 }
9324 }
9325
9326 fn handle_work_done_progress(
9327 &mut self,
9328 progress: lsp::WorkDoneProgress,
9329 language_server_id: LanguageServerId,
9330 disk_based_diagnostics_progress_token: Option<String>,
9331 token: String,
9332 cx: &mut Context<Self>,
9333 ) {
9334 let language_server_status =
9335 if let Some(status) = self.language_server_statuses.get_mut(&language_server_id) {
9336 status
9337 } else {
9338 return;
9339 };
9340
9341 if !language_server_status.progress_tokens.contains(&token) {
9342 return;
9343 }
9344
9345 let is_disk_based_diagnostics_progress = disk_based_diagnostics_progress_token
9346 .as_ref()
9347 .map_or(false, |disk_based_token| {
9348 token.starts_with(disk_based_token)
9349 });
9350
9351 match progress {
9352 lsp::WorkDoneProgress::Begin(report) => {
9353 if is_disk_based_diagnostics_progress {
9354 self.disk_based_diagnostics_started(language_server_id, cx);
9355 }
9356 self.on_lsp_work_start(
9357 language_server_id,
9358 token.clone(),
9359 LanguageServerProgress {
9360 title: Some(report.title),
9361 is_disk_based_diagnostics_progress,
9362 is_cancellable: report.cancellable.unwrap_or(false),
9363 message: report.message.clone(),
9364 percentage: report.percentage.map(|p| p as usize),
9365 last_update_at: cx.background_executor().now(),
9366 },
9367 cx,
9368 );
9369 }
9370 lsp::WorkDoneProgress::Report(report) => self.on_lsp_work_progress(
9371 language_server_id,
9372 token,
9373 LanguageServerProgress {
9374 title: None,
9375 is_disk_based_diagnostics_progress,
9376 is_cancellable: report.cancellable.unwrap_or(false),
9377 message: report.message,
9378 percentage: report.percentage.map(|p| p as usize),
9379 last_update_at: cx.background_executor().now(),
9380 },
9381 cx,
9382 ),
9383 lsp::WorkDoneProgress::End(_) => {
9384 language_server_status.progress_tokens.remove(&token);
9385 self.on_lsp_work_end(language_server_id, token.clone(), cx);
9386 if is_disk_based_diagnostics_progress {
9387 self.disk_based_diagnostics_finished(language_server_id, cx);
9388 }
9389 }
9390 }
9391 }
9392
9393 fn on_lsp_work_start(
9394 &mut self,
9395 language_server_id: LanguageServerId,
9396 token: String,
9397 progress: LanguageServerProgress,
9398 cx: &mut Context<Self>,
9399 ) {
9400 if let Some(status) = self.language_server_statuses.get_mut(&language_server_id) {
9401 status.pending_work.insert(token.clone(), progress.clone());
9402 cx.notify();
9403 }
9404 cx.emit(LspStoreEvent::LanguageServerUpdate {
9405 language_server_id,
9406 name: self
9407 .language_server_adapter_for_id(language_server_id)
9408 .map(|adapter| adapter.name()),
9409 message: proto::update_language_server::Variant::WorkStart(proto::LspWorkStart {
9410 token,
9411 title: progress.title,
9412 message: progress.message,
9413 percentage: progress.percentage.map(|p| p as u32),
9414 is_cancellable: Some(progress.is_cancellable),
9415 }),
9416 })
9417 }
9418
9419 fn on_lsp_work_progress(
9420 &mut self,
9421 language_server_id: LanguageServerId,
9422 token: String,
9423 progress: LanguageServerProgress,
9424 cx: &mut Context<Self>,
9425 ) {
9426 let mut did_update = false;
9427 if let Some(status) = self.language_server_statuses.get_mut(&language_server_id) {
9428 match status.pending_work.entry(token.clone()) {
9429 btree_map::Entry::Vacant(entry) => {
9430 entry.insert(progress.clone());
9431 did_update = true;
9432 }
9433 btree_map::Entry::Occupied(mut entry) => {
9434 let entry = entry.get_mut();
9435 if (progress.last_update_at - entry.last_update_at)
9436 >= SERVER_PROGRESS_THROTTLE_TIMEOUT
9437 {
9438 entry.last_update_at = progress.last_update_at;
9439 if progress.message.is_some() {
9440 entry.message = progress.message.clone();
9441 }
9442 if progress.percentage.is_some() {
9443 entry.percentage = progress.percentage;
9444 }
9445 if progress.is_cancellable != entry.is_cancellable {
9446 entry.is_cancellable = progress.is_cancellable;
9447 }
9448 did_update = true;
9449 }
9450 }
9451 }
9452 }
9453
9454 if did_update {
9455 cx.emit(LspStoreEvent::LanguageServerUpdate {
9456 language_server_id,
9457 name: self
9458 .language_server_adapter_for_id(language_server_id)
9459 .map(|adapter| adapter.name()),
9460 message: proto::update_language_server::Variant::WorkProgress(
9461 proto::LspWorkProgress {
9462 token,
9463 message: progress.message,
9464 percentage: progress.percentage.map(|p| p as u32),
9465 is_cancellable: Some(progress.is_cancellable),
9466 },
9467 ),
9468 })
9469 }
9470 }
9471
9472 fn on_lsp_work_end(
9473 &mut self,
9474 language_server_id: LanguageServerId,
9475 token: String,
9476 cx: &mut Context<Self>,
9477 ) {
9478 if let Some(status) = self.language_server_statuses.get_mut(&language_server_id) {
9479 if let Some(work) = status.pending_work.remove(&token) {
9480 if !work.is_disk_based_diagnostics_progress {
9481 cx.emit(LspStoreEvent::RefreshInlayHints);
9482 }
9483 }
9484 cx.notify();
9485 }
9486
9487 cx.emit(LspStoreEvent::LanguageServerUpdate {
9488 language_server_id,
9489 name: self
9490 .language_server_adapter_for_id(language_server_id)
9491 .map(|adapter| adapter.name()),
9492 message: proto::update_language_server::Variant::WorkEnd(proto::LspWorkEnd { token }),
9493 })
9494 }
9495
9496 pub async fn handle_resolve_completion_documentation(
9497 this: Entity<Self>,
9498 envelope: TypedEnvelope<proto::ResolveCompletionDocumentation>,
9499 mut cx: AsyncApp,
9500 ) -> Result<proto::ResolveCompletionDocumentationResponse> {
9501 let lsp_completion = serde_json::from_slice(&envelope.payload.lsp_completion)?;
9502
9503 let completion = this
9504 .read_with(&cx, |this, cx| {
9505 let id = LanguageServerId(envelope.payload.language_server_id as usize);
9506 let server = this
9507 .language_server_for_id(id)
9508 .with_context(|| format!("No language server {id}"))?;
9509
9510 anyhow::Ok(cx.background_spawn(async move {
9511 let can_resolve = server
9512 .capabilities()
9513 .completion_provider
9514 .as_ref()
9515 .and_then(|options| options.resolve_provider)
9516 .unwrap_or(false);
9517 if can_resolve {
9518 server
9519 .request::<lsp::request::ResolveCompletionItem>(lsp_completion)
9520 .await
9521 .into_response()
9522 .context("resolve completion item")
9523 } else {
9524 anyhow::Ok(lsp_completion)
9525 }
9526 }))
9527 })??
9528 .await?;
9529
9530 let mut documentation_is_markdown = false;
9531 let lsp_completion = serde_json::to_string(&completion)?.into_bytes();
9532 let documentation = match completion.documentation {
9533 Some(lsp::Documentation::String(text)) => text,
9534
9535 Some(lsp::Documentation::MarkupContent(lsp::MarkupContent { kind, value })) => {
9536 documentation_is_markdown = kind == lsp::MarkupKind::Markdown;
9537 value
9538 }
9539
9540 _ => String::new(),
9541 };
9542
9543 // If we have a new buffer_id, that means we're talking to a new client
9544 // and want to check for new text_edits in the completion too.
9545 let mut old_replace_start = None;
9546 let mut old_replace_end = None;
9547 let mut old_insert_start = None;
9548 let mut old_insert_end = None;
9549 let mut new_text = String::default();
9550 if let Ok(buffer_id) = BufferId::new(envelope.payload.buffer_id) {
9551 let buffer_snapshot = this.update(&mut cx, |this, cx| {
9552 let buffer = this.buffer_store.read(cx).get_existing(buffer_id)?;
9553 anyhow::Ok(buffer.read(cx).snapshot())
9554 })??;
9555
9556 if let Some(text_edit) = completion.text_edit.as_ref() {
9557 let edit = parse_completion_text_edit(text_edit, &buffer_snapshot);
9558
9559 if let Some(mut edit) = edit {
9560 LineEnding::normalize(&mut edit.new_text);
9561
9562 new_text = edit.new_text;
9563 old_replace_start = Some(serialize_anchor(&edit.replace_range.start));
9564 old_replace_end = Some(serialize_anchor(&edit.replace_range.end));
9565 if let Some(insert_range) = edit.insert_range {
9566 old_insert_start = Some(serialize_anchor(&insert_range.start));
9567 old_insert_end = Some(serialize_anchor(&insert_range.end));
9568 }
9569 }
9570 }
9571 }
9572
9573 Ok(proto::ResolveCompletionDocumentationResponse {
9574 documentation,
9575 documentation_is_markdown,
9576 old_replace_start,
9577 old_replace_end,
9578 new_text,
9579 lsp_completion,
9580 old_insert_start,
9581 old_insert_end,
9582 })
9583 }
9584
9585 async fn handle_on_type_formatting(
9586 this: Entity<Self>,
9587 envelope: TypedEnvelope<proto::OnTypeFormatting>,
9588 mut cx: AsyncApp,
9589 ) -> Result<proto::OnTypeFormattingResponse> {
9590 let on_type_formatting = this.update(&mut cx, |this, cx| {
9591 let buffer_id = BufferId::new(envelope.payload.buffer_id)?;
9592 let buffer = this.buffer_store.read(cx).get_existing(buffer_id)?;
9593 let position = envelope
9594 .payload
9595 .position
9596 .and_then(deserialize_anchor)
9597 .context("invalid position")?;
9598 anyhow::Ok(this.apply_on_type_formatting(
9599 buffer,
9600 position,
9601 envelope.payload.trigger.clone(),
9602 cx,
9603 ))
9604 })??;
9605
9606 let transaction = on_type_formatting
9607 .await?
9608 .as_ref()
9609 .map(language::proto::serialize_transaction);
9610 Ok(proto::OnTypeFormattingResponse { transaction })
9611 }
9612
9613 async fn handle_refresh_inlay_hints(
9614 this: Entity<Self>,
9615 _: TypedEnvelope<proto::RefreshInlayHints>,
9616 mut cx: AsyncApp,
9617 ) -> Result<proto::Ack> {
9618 this.update(&mut cx, |_, cx| {
9619 cx.emit(LspStoreEvent::RefreshInlayHints);
9620 })?;
9621 Ok(proto::Ack {})
9622 }
9623
9624 async fn handle_pull_workspace_diagnostics(
9625 lsp_store: Entity<Self>,
9626 envelope: TypedEnvelope<proto::PullWorkspaceDiagnostics>,
9627 mut cx: AsyncApp,
9628 ) -> Result<proto::Ack> {
9629 let server_id = LanguageServerId::from_proto(envelope.payload.server_id);
9630 lsp_store.update(&mut cx, |lsp_store, _| {
9631 lsp_store.pull_workspace_diagnostics(server_id);
9632 })?;
9633 Ok(proto::Ack {})
9634 }
9635
9636 async fn handle_inlay_hints(
9637 this: Entity<Self>,
9638 envelope: TypedEnvelope<proto::InlayHints>,
9639 mut cx: AsyncApp,
9640 ) -> Result<proto::InlayHintsResponse> {
9641 let sender_id = envelope.original_sender_id().unwrap_or_default();
9642 let buffer_id = BufferId::new(envelope.payload.buffer_id)?;
9643 let buffer = this.update(&mut cx, |this, cx| {
9644 this.buffer_store.read(cx).get_existing(buffer_id)
9645 })??;
9646 buffer
9647 .update(&mut cx, |buffer, _| {
9648 buffer.wait_for_version(deserialize_version(&envelope.payload.version))
9649 })?
9650 .await
9651 .with_context(|| format!("waiting for version for buffer {}", buffer.entity_id()))?;
9652
9653 let start = envelope
9654 .payload
9655 .start
9656 .and_then(deserialize_anchor)
9657 .context("missing range start")?;
9658 let end = envelope
9659 .payload
9660 .end
9661 .and_then(deserialize_anchor)
9662 .context("missing range end")?;
9663 let buffer_hints = this
9664 .update(&mut cx, |lsp_store, cx| {
9665 lsp_store.inlay_hints(buffer.clone(), start..end, cx)
9666 })?
9667 .await
9668 .context("inlay hints fetch")?;
9669
9670 this.update(&mut cx, |project, cx| {
9671 InlayHints::response_to_proto(
9672 buffer_hints,
9673 project,
9674 sender_id,
9675 &buffer.read(cx).version(),
9676 cx,
9677 )
9678 })
9679 }
9680
9681 async fn handle_get_color_presentation(
9682 lsp_store: Entity<Self>,
9683 envelope: TypedEnvelope<proto::GetColorPresentation>,
9684 mut cx: AsyncApp,
9685 ) -> Result<proto::GetColorPresentationResponse> {
9686 let buffer_id = BufferId::new(envelope.payload.buffer_id)?;
9687 let buffer = lsp_store.update(&mut cx, |lsp_store, cx| {
9688 lsp_store.buffer_store.read(cx).get_existing(buffer_id)
9689 })??;
9690
9691 let color = envelope
9692 .payload
9693 .color
9694 .context("invalid color resolve request")?;
9695 let start = color
9696 .lsp_range_start
9697 .context("invalid color resolve request")?;
9698 let end = color
9699 .lsp_range_end
9700 .context("invalid color resolve request")?;
9701
9702 let color = DocumentColor {
9703 lsp_range: lsp::Range {
9704 start: point_to_lsp(PointUtf16::new(start.row, start.column)),
9705 end: point_to_lsp(PointUtf16::new(end.row, end.column)),
9706 },
9707 color: lsp::Color {
9708 red: color.red,
9709 green: color.green,
9710 blue: color.blue,
9711 alpha: color.alpha,
9712 },
9713 resolved: false,
9714 color_presentations: Vec::new(),
9715 };
9716 let resolved_color = lsp_store
9717 .update(&mut cx, |lsp_store, cx| {
9718 lsp_store.resolve_color_presentation(
9719 color,
9720 buffer.clone(),
9721 LanguageServerId(envelope.payload.server_id as usize),
9722 cx,
9723 )
9724 })?
9725 .await
9726 .context("resolving color presentation")?;
9727
9728 Ok(proto::GetColorPresentationResponse {
9729 presentations: resolved_color
9730 .color_presentations
9731 .into_iter()
9732 .map(|presentation| proto::ColorPresentation {
9733 label: presentation.label.to_string(),
9734 text_edit: presentation.text_edit.map(serialize_lsp_edit),
9735 additional_text_edits: presentation
9736 .additional_text_edits
9737 .into_iter()
9738 .map(serialize_lsp_edit)
9739 .collect(),
9740 })
9741 .collect(),
9742 })
9743 }
9744
9745 async fn handle_resolve_inlay_hint(
9746 this: Entity<Self>,
9747 envelope: TypedEnvelope<proto::ResolveInlayHint>,
9748 mut cx: AsyncApp,
9749 ) -> Result<proto::ResolveInlayHintResponse> {
9750 let proto_hint = envelope
9751 .payload
9752 .hint
9753 .expect("incorrect protobuf resolve inlay hint message: missing the inlay hint");
9754 let hint = InlayHints::proto_to_project_hint(proto_hint)
9755 .context("resolved proto inlay hint conversion")?;
9756 let buffer = this.update(&mut cx, |this, cx| {
9757 let buffer_id = BufferId::new(envelope.payload.buffer_id)?;
9758 this.buffer_store.read(cx).get_existing(buffer_id)
9759 })??;
9760 let response_hint = this
9761 .update(&mut cx, |this, cx| {
9762 this.resolve_inlay_hint(
9763 hint,
9764 buffer,
9765 LanguageServerId(envelope.payload.language_server_id as usize),
9766 cx,
9767 )
9768 })?
9769 .await
9770 .context("inlay hints fetch")?;
9771 Ok(proto::ResolveInlayHintResponse {
9772 hint: Some(InlayHints::project_to_proto_hint(response_hint)),
9773 })
9774 }
9775
9776 async fn handle_refresh_code_lens(
9777 this: Entity<Self>,
9778 _: TypedEnvelope<proto::RefreshCodeLens>,
9779 mut cx: AsyncApp,
9780 ) -> Result<proto::Ack> {
9781 this.update(&mut cx, |_, cx| {
9782 cx.emit(LspStoreEvent::RefreshCodeLens);
9783 })?;
9784 Ok(proto::Ack {})
9785 }
9786
9787 async fn handle_open_buffer_for_symbol(
9788 this: Entity<Self>,
9789 envelope: TypedEnvelope<proto::OpenBufferForSymbol>,
9790 mut cx: AsyncApp,
9791 ) -> Result<proto::OpenBufferForSymbolResponse> {
9792 let peer_id = envelope.original_sender_id().unwrap_or_default();
9793 let symbol = envelope.payload.symbol.context("invalid symbol")?;
9794 let symbol = Self::deserialize_symbol(symbol)?;
9795 let symbol = this.read_with(&mut cx, |this, _| {
9796 let signature = this.symbol_signature(&symbol.path);
9797 anyhow::ensure!(signature == symbol.signature, "invalid symbol signature");
9798 Ok(symbol)
9799 })??;
9800 let buffer = this
9801 .update(&mut cx, |this, cx| {
9802 this.open_buffer_for_symbol(
9803 &Symbol {
9804 language_server_name: symbol.language_server_name,
9805 source_worktree_id: symbol.source_worktree_id,
9806 source_language_server_id: symbol.source_language_server_id,
9807 path: symbol.path,
9808 name: symbol.name,
9809 kind: symbol.kind,
9810 range: symbol.range,
9811 signature: symbol.signature,
9812 label: CodeLabel {
9813 text: Default::default(),
9814 runs: Default::default(),
9815 filter_range: Default::default(),
9816 },
9817 },
9818 cx,
9819 )
9820 })?
9821 .await?;
9822
9823 this.update(&mut cx, |this, cx| {
9824 let is_private = buffer
9825 .read(cx)
9826 .file()
9827 .map(|f| f.is_private())
9828 .unwrap_or_default();
9829 if is_private {
9830 Err(anyhow!(rpc::ErrorCode::UnsharedItem))
9831 } else {
9832 this.buffer_store
9833 .update(cx, |buffer_store, cx| {
9834 buffer_store.create_buffer_for_peer(&buffer, peer_id, cx)
9835 })
9836 .detach_and_log_err(cx);
9837 let buffer_id = buffer.read(cx).remote_id().to_proto();
9838 Ok(proto::OpenBufferForSymbolResponse { buffer_id })
9839 }
9840 })?
9841 }
9842
9843 fn symbol_signature(&self, project_path: &ProjectPath) -> [u8; 32] {
9844 let mut hasher = Sha256::new();
9845 hasher.update(project_path.worktree_id.to_proto().to_be_bytes());
9846 hasher.update(project_path.path.to_string_lossy().as_bytes());
9847 hasher.update(self.nonce.to_be_bytes());
9848 hasher.finalize().as_slice().try_into().unwrap()
9849 }
9850
9851 pub async fn handle_get_project_symbols(
9852 this: Entity<Self>,
9853 envelope: TypedEnvelope<proto::GetProjectSymbols>,
9854 mut cx: AsyncApp,
9855 ) -> Result<proto::GetProjectSymbolsResponse> {
9856 let symbols = this
9857 .update(&mut cx, |this, cx| {
9858 this.symbols(&envelope.payload.query, cx)
9859 })?
9860 .await?;
9861
9862 Ok(proto::GetProjectSymbolsResponse {
9863 symbols: symbols.iter().map(Self::serialize_symbol).collect(),
9864 })
9865 }
9866
9867 pub async fn handle_restart_language_servers(
9868 this: Entity<Self>,
9869 envelope: TypedEnvelope<proto::RestartLanguageServers>,
9870 mut cx: AsyncApp,
9871 ) -> Result<proto::Ack> {
9872 this.update(&mut cx, |lsp_store, cx| {
9873 let buffers =
9874 lsp_store.buffer_ids_to_buffers(envelope.payload.buffer_ids.into_iter(), cx);
9875 lsp_store.restart_language_servers_for_buffers(
9876 buffers,
9877 envelope
9878 .payload
9879 .only_servers
9880 .into_iter()
9881 .filter_map(|selector| {
9882 Some(match selector.selector? {
9883 proto::language_server_selector::Selector::ServerId(server_id) => {
9884 LanguageServerSelector::Id(LanguageServerId::from_proto(server_id))
9885 }
9886 proto::language_server_selector::Selector::Name(name) => {
9887 LanguageServerSelector::Name(LanguageServerName(
9888 SharedString::from(name),
9889 ))
9890 }
9891 })
9892 })
9893 .collect(),
9894 cx,
9895 );
9896 })?;
9897
9898 Ok(proto::Ack {})
9899 }
9900
9901 pub async fn handle_stop_language_servers(
9902 lsp_store: Entity<Self>,
9903 envelope: TypedEnvelope<proto::StopLanguageServers>,
9904 mut cx: AsyncApp,
9905 ) -> Result<proto::Ack> {
9906 lsp_store.update(&mut cx, |lsp_store, cx| {
9907 if envelope.payload.all
9908 && envelope.payload.also_servers.is_empty()
9909 && envelope.payload.buffer_ids.is_empty()
9910 {
9911 lsp_store.stop_all_language_servers(cx);
9912 } else {
9913 let buffers =
9914 lsp_store.buffer_ids_to_buffers(envelope.payload.buffer_ids.into_iter(), cx);
9915 lsp_store
9916 .stop_language_servers_for_buffers(
9917 buffers,
9918 envelope
9919 .payload
9920 .also_servers
9921 .into_iter()
9922 .filter_map(|selector| {
9923 Some(match selector.selector? {
9924 proto::language_server_selector::Selector::ServerId(
9925 server_id,
9926 ) => LanguageServerSelector::Id(LanguageServerId::from_proto(
9927 server_id,
9928 )),
9929 proto::language_server_selector::Selector::Name(name) => {
9930 LanguageServerSelector::Name(LanguageServerName(
9931 SharedString::from(name),
9932 ))
9933 }
9934 })
9935 })
9936 .collect(),
9937 cx,
9938 )
9939 .detach_and_log_err(cx);
9940 }
9941 })?;
9942
9943 Ok(proto::Ack {})
9944 }
9945
9946 pub async fn handle_cancel_language_server_work(
9947 this: Entity<Self>,
9948 envelope: TypedEnvelope<proto::CancelLanguageServerWork>,
9949 mut cx: AsyncApp,
9950 ) -> Result<proto::Ack> {
9951 this.update(&mut cx, |this, cx| {
9952 if let Some(work) = envelope.payload.work {
9953 match work {
9954 proto::cancel_language_server_work::Work::Buffers(buffers) => {
9955 let buffers =
9956 this.buffer_ids_to_buffers(buffers.buffer_ids.into_iter(), cx);
9957 this.cancel_language_server_work_for_buffers(buffers, cx);
9958 }
9959 proto::cancel_language_server_work::Work::LanguageServerWork(work) => {
9960 let server_id = LanguageServerId::from_proto(work.language_server_id);
9961 this.cancel_language_server_work(server_id, work.token, cx);
9962 }
9963 }
9964 }
9965 })?;
9966
9967 Ok(proto::Ack {})
9968 }
9969
9970 fn buffer_ids_to_buffers(
9971 &mut self,
9972 buffer_ids: impl Iterator<Item = u64>,
9973 cx: &mut Context<Self>,
9974 ) -> Vec<Entity<Buffer>> {
9975 buffer_ids
9976 .into_iter()
9977 .flat_map(|buffer_id| {
9978 self.buffer_store
9979 .read(cx)
9980 .get(BufferId::new(buffer_id).log_err()?)
9981 })
9982 .collect::<Vec<_>>()
9983 }
9984
9985 async fn handle_apply_additional_edits_for_completion(
9986 this: Entity<Self>,
9987 envelope: TypedEnvelope<proto::ApplyCompletionAdditionalEdits>,
9988 mut cx: AsyncApp,
9989 ) -> Result<proto::ApplyCompletionAdditionalEditsResponse> {
9990 let (buffer, completion) = this.update(&mut cx, |this, cx| {
9991 let buffer_id = BufferId::new(envelope.payload.buffer_id)?;
9992 let buffer = this.buffer_store.read(cx).get_existing(buffer_id)?;
9993 let completion = Self::deserialize_completion(
9994 envelope.payload.completion.context("invalid completion")?,
9995 )?;
9996 anyhow::Ok((buffer, completion))
9997 })??;
9998
9999 let apply_additional_edits = this.update(&mut cx, |this, cx| {
10000 this.apply_additional_edits_for_completion(
10001 buffer,
10002 Rc::new(RefCell::new(Box::new([Completion {
10003 replace_range: completion.replace_range,
10004 new_text: completion.new_text,
10005 source: completion.source,
10006 documentation: None,
10007 label: CodeLabel {
10008 text: Default::default(),
10009 runs: Default::default(),
10010 filter_range: Default::default(),
10011 },
10012 insert_text_mode: None,
10013 icon_path: None,
10014 confirm: None,
10015 }]))),
10016 0,
10017 false,
10018 cx,
10019 )
10020 })?;
10021
10022 Ok(proto::ApplyCompletionAdditionalEditsResponse {
10023 transaction: apply_additional_edits
10024 .await?
10025 .as_ref()
10026 .map(language::proto::serialize_transaction),
10027 })
10028 }
10029
10030 pub fn last_formatting_failure(&self) -> Option<&str> {
10031 self.last_formatting_failure.as_deref()
10032 }
10033
10034 pub fn reset_last_formatting_failure(&mut self) {
10035 self.last_formatting_failure = None;
10036 }
10037
10038 pub fn environment_for_buffer(
10039 &self,
10040 buffer: &Entity<Buffer>,
10041 cx: &mut Context<Self>,
10042 ) -> Shared<Task<Option<HashMap<String, String>>>> {
10043 if let Some(environment) = &self.as_local().map(|local| local.environment.clone()) {
10044 environment.update(cx, |env, cx| {
10045 env.get_buffer_environment(&buffer, &self.worktree_store, cx)
10046 })
10047 } else {
10048 Task::ready(None).shared()
10049 }
10050 }
10051
10052 pub fn format(
10053 &mut self,
10054 buffers: HashSet<Entity<Buffer>>,
10055 target: LspFormatTarget,
10056 push_to_history: bool,
10057 trigger: FormatTrigger,
10058 cx: &mut Context<Self>,
10059 ) -> Task<anyhow::Result<ProjectTransaction>> {
10060 let logger = zlog::scoped!("format");
10061 if let Some(_) = self.as_local() {
10062 zlog::trace!(logger => "Formatting locally");
10063 let logger = zlog::scoped!(logger => "local");
10064 let buffers = buffers
10065 .into_iter()
10066 .map(|buffer_handle| {
10067 let buffer = buffer_handle.read(cx);
10068 let buffer_abs_path = File::from_dyn(buffer.file())
10069 .and_then(|file| file.as_local().map(|f| f.abs_path(cx)));
10070
10071 (buffer_handle, buffer_abs_path, buffer.remote_id())
10072 })
10073 .collect::<Vec<_>>();
10074
10075 cx.spawn(async move |lsp_store, cx| {
10076 let mut formattable_buffers = Vec::with_capacity(buffers.len());
10077
10078 for (handle, abs_path, id) in buffers {
10079 let env = lsp_store
10080 .update(cx, |lsp_store, cx| {
10081 lsp_store.environment_for_buffer(&handle, cx)
10082 })?
10083 .await;
10084
10085 let ranges = match &target {
10086 LspFormatTarget::Buffers => None,
10087 LspFormatTarget::Ranges(ranges) => {
10088 Some(ranges.get(&id).context("No format ranges provided for buffer")?.clone())
10089 }
10090 };
10091
10092 formattable_buffers.push(FormattableBuffer {
10093 handle,
10094 abs_path,
10095 env,
10096 ranges,
10097 });
10098 }
10099 zlog::trace!(logger => "Formatting {:?} buffers", formattable_buffers.len());
10100
10101 let format_timer = zlog::time!(logger => "Formatting buffers");
10102 let result = LocalLspStore::format_locally(
10103 lsp_store.clone(),
10104 formattable_buffers,
10105 push_to_history,
10106 trigger,
10107 logger,
10108 cx,
10109 )
10110 .await;
10111 format_timer.end();
10112
10113 zlog::trace!(logger => "Formatting completed with result {:?}", result.as_ref().map(|_| "<project-transaction>"));
10114
10115 lsp_store.update(cx, |lsp_store, _| {
10116 lsp_store.update_last_formatting_failure(&result);
10117 })?;
10118
10119 result
10120 })
10121 } else if let Some((client, project_id)) = self.upstream_client() {
10122 zlog::trace!(logger => "Formatting remotely");
10123 let logger = zlog::scoped!(logger => "remote");
10124 // Don't support formatting ranges via remote
10125 match target {
10126 LspFormatTarget::Buffers => {}
10127 LspFormatTarget::Ranges(_) => {
10128 zlog::trace!(logger => "Ignoring unsupported remote range formatting request");
10129 return Task::ready(Ok(ProjectTransaction::default()));
10130 }
10131 }
10132
10133 let buffer_store = self.buffer_store();
10134 cx.spawn(async move |lsp_store, cx| {
10135 zlog::trace!(logger => "Sending remote format request");
10136 let request_timer = zlog::time!(logger => "remote format request");
10137 let result = client
10138 .request(proto::FormatBuffers {
10139 project_id,
10140 trigger: trigger as i32,
10141 buffer_ids: buffers
10142 .iter()
10143 .map(|buffer| buffer.read_with(cx, |buffer, _| buffer.remote_id().into()))
10144 .collect::<Result<_>>()?,
10145 })
10146 .await
10147 .and_then(|result| result.transaction.context("missing transaction"));
10148 request_timer.end();
10149
10150 zlog::trace!(logger => "Remote format request resolved to {:?}", result.as_ref().map(|_| "<project_transaction>"));
10151
10152 lsp_store.update(cx, |lsp_store, _| {
10153 lsp_store.update_last_formatting_failure(&result);
10154 })?;
10155
10156 let transaction_response = result?;
10157 let _timer = zlog::time!(logger => "deserializing project transaction");
10158 buffer_store
10159 .update(cx, |buffer_store, cx| {
10160 buffer_store.deserialize_project_transaction(
10161 transaction_response,
10162 push_to_history,
10163 cx,
10164 )
10165 })?
10166 .await
10167 })
10168 } else {
10169 zlog::trace!(logger => "Not formatting");
10170 Task::ready(Ok(ProjectTransaction::default()))
10171 }
10172 }
10173
10174 async fn handle_format_buffers(
10175 this: Entity<Self>,
10176 envelope: TypedEnvelope<proto::FormatBuffers>,
10177 mut cx: AsyncApp,
10178 ) -> Result<proto::FormatBuffersResponse> {
10179 let sender_id = envelope.original_sender_id().unwrap_or_default();
10180 let format = this.update(&mut cx, |this, cx| {
10181 let mut buffers = HashSet::default();
10182 for buffer_id in &envelope.payload.buffer_ids {
10183 let buffer_id = BufferId::new(*buffer_id)?;
10184 buffers.insert(this.buffer_store.read(cx).get_existing(buffer_id)?);
10185 }
10186 let trigger = FormatTrigger::from_proto(envelope.payload.trigger);
10187 anyhow::Ok(this.format(buffers, LspFormatTarget::Buffers, false, trigger, cx))
10188 })??;
10189
10190 let project_transaction = format.await?;
10191 let project_transaction = this.update(&mut cx, |this, cx| {
10192 this.buffer_store.update(cx, |buffer_store, cx| {
10193 buffer_store.serialize_project_transaction_for_peer(
10194 project_transaction,
10195 sender_id,
10196 cx,
10197 )
10198 })
10199 })?;
10200 Ok(proto::FormatBuffersResponse {
10201 transaction: Some(project_transaction),
10202 })
10203 }
10204
10205 async fn handle_apply_code_action_kind(
10206 this: Entity<Self>,
10207 envelope: TypedEnvelope<proto::ApplyCodeActionKind>,
10208 mut cx: AsyncApp,
10209 ) -> Result<proto::ApplyCodeActionKindResponse> {
10210 let sender_id = envelope.original_sender_id().unwrap_or_default();
10211 let format = this.update(&mut cx, |this, cx| {
10212 let mut buffers = HashSet::default();
10213 for buffer_id in &envelope.payload.buffer_ids {
10214 let buffer_id = BufferId::new(*buffer_id)?;
10215 buffers.insert(this.buffer_store.read(cx).get_existing(buffer_id)?);
10216 }
10217 let kind = match envelope.payload.kind.as_str() {
10218 "" => CodeActionKind::EMPTY,
10219 "quickfix" => CodeActionKind::QUICKFIX,
10220 "refactor" => CodeActionKind::REFACTOR,
10221 "refactor.extract" => CodeActionKind::REFACTOR_EXTRACT,
10222 "refactor.inline" => CodeActionKind::REFACTOR_INLINE,
10223 "refactor.rewrite" => CodeActionKind::REFACTOR_REWRITE,
10224 "source" => CodeActionKind::SOURCE,
10225 "source.organizeImports" => CodeActionKind::SOURCE_ORGANIZE_IMPORTS,
10226 "source.fixAll" => CodeActionKind::SOURCE_FIX_ALL,
10227 _ => anyhow::bail!(
10228 "Invalid code action kind {}",
10229 envelope.payload.kind.as_str()
10230 ),
10231 };
10232 anyhow::Ok(this.apply_code_action_kind(buffers, kind, false, cx))
10233 })??;
10234
10235 let project_transaction = format.await?;
10236 let project_transaction = this.update(&mut cx, |this, cx| {
10237 this.buffer_store.update(cx, |buffer_store, cx| {
10238 buffer_store.serialize_project_transaction_for_peer(
10239 project_transaction,
10240 sender_id,
10241 cx,
10242 )
10243 })
10244 })?;
10245 Ok(proto::ApplyCodeActionKindResponse {
10246 transaction: Some(project_transaction),
10247 })
10248 }
10249
10250 async fn shutdown_language_server(
10251 server_state: Option<LanguageServerState>,
10252 name: LanguageServerName,
10253 cx: &mut AsyncApp,
10254 ) {
10255 let server = match server_state {
10256 Some(LanguageServerState::Starting { startup, .. }) => {
10257 let mut timer = cx
10258 .background_executor()
10259 .timer(SERVER_LAUNCHING_BEFORE_SHUTDOWN_TIMEOUT)
10260 .fuse();
10261
10262 select! {
10263 server = startup.fuse() => server,
10264 () = timer => {
10265 log::info!("timeout waiting for language server {name} to finish launching before stopping");
10266 None
10267 },
10268 }
10269 }
10270
10271 Some(LanguageServerState::Running { server, .. }) => Some(server),
10272
10273 None => None,
10274 };
10275
10276 if let Some(server) = server {
10277 if let Some(shutdown) = server.shutdown() {
10278 shutdown.await;
10279 }
10280 }
10281 }
10282
10283 // Returns a list of all of the worktrees which no longer have a language server and the root path
10284 // for the stopped server
10285 fn stop_local_language_server(
10286 &mut self,
10287 server_id: LanguageServerId,
10288 cx: &mut Context<Self>,
10289 ) -> Task<Vec<WorktreeId>> {
10290 let local = match &mut self.mode {
10291 LspStoreMode::Local(local) => local,
10292 _ => {
10293 return Task::ready(Vec::new());
10294 }
10295 };
10296
10297 let mut orphaned_worktrees = Vec::new();
10298 // Remove this server ID from all entries in the given worktree.
10299 local.language_server_ids.retain(|(worktree, _), ids| {
10300 if !ids.remove(&server_id) {
10301 return true;
10302 }
10303
10304 if ids.is_empty() {
10305 orphaned_worktrees.push(*worktree);
10306 false
10307 } else {
10308 true
10309 }
10310 });
10311 self.buffer_store.update(cx, |buffer_store, cx| {
10312 for buffer in buffer_store.buffers() {
10313 buffer.update(cx, |buffer, cx| {
10314 buffer.update_diagnostics(server_id, DiagnosticSet::new([], buffer), cx);
10315 buffer.set_completion_triggers(server_id, Default::default(), cx);
10316 });
10317 }
10318 });
10319
10320 for (worktree_id, summaries) in self.diagnostic_summaries.iter_mut() {
10321 summaries.retain(|path, summaries_by_server_id| {
10322 if summaries_by_server_id.remove(&server_id).is_some() {
10323 if let Some((client, project_id)) = self.downstream_client.clone() {
10324 client
10325 .send(proto::UpdateDiagnosticSummary {
10326 project_id,
10327 worktree_id: worktree_id.to_proto(),
10328 summary: Some(proto::DiagnosticSummary {
10329 path: path.as_ref().to_proto(),
10330 language_server_id: server_id.0 as u64,
10331 error_count: 0,
10332 warning_count: 0,
10333 }),
10334 more_summaries: Vec::new(),
10335 })
10336 .log_err();
10337 }
10338 !summaries_by_server_id.is_empty()
10339 } else {
10340 true
10341 }
10342 });
10343 }
10344
10345 let local = self.as_local_mut().unwrap();
10346 for diagnostics in local.diagnostics.values_mut() {
10347 diagnostics.retain(|_, diagnostics_by_server_id| {
10348 if let Ok(ix) = diagnostics_by_server_id.binary_search_by_key(&server_id, |e| e.0) {
10349 diagnostics_by_server_id.remove(ix);
10350 !diagnostics_by_server_id.is_empty()
10351 } else {
10352 true
10353 }
10354 });
10355 }
10356 local.language_server_watched_paths.remove(&server_id);
10357
10358 let server_state = local.language_servers.remove(&server_id);
10359 self.cleanup_lsp_data(server_id);
10360 let name = self
10361 .language_server_statuses
10362 .remove(&server_id)
10363 .map(|status| status.name.clone())
10364 .or_else(|| {
10365 if let Some(LanguageServerState::Running { adapter, .. }) = server_state.as_ref() {
10366 Some(adapter.name())
10367 } else {
10368 None
10369 }
10370 });
10371
10372 if let Some(name) = name {
10373 log::info!("stopping language server {name}");
10374 self.languages
10375 .update_lsp_binary_status(name.clone(), BinaryStatus::Stopping);
10376 cx.notify();
10377
10378 return cx.spawn(async move |lsp_store, cx| {
10379 Self::shutdown_language_server(server_state, name.clone(), cx).await;
10380 lsp_store
10381 .update(cx, |lsp_store, cx| {
10382 lsp_store
10383 .languages
10384 .update_lsp_binary_status(name, BinaryStatus::Stopped);
10385 cx.emit(LspStoreEvent::LanguageServerRemoved(server_id));
10386 cx.notify();
10387 })
10388 .ok();
10389 orphaned_worktrees
10390 });
10391 }
10392
10393 if server_state.is_some() {
10394 cx.emit(LspStoreEvent::LanguageServerRemoved(server_id));
10395 }
10396 Task::ready(orphaned_worktrees)
10397 }
10398
10399 pub fn stop_all_language_servers(&mut self, cx: &mut Context<Self>) {
10400 if let Some((client, project_id)) = self.upstream_client() {
10401 let request = client.request(proto::StopLanguageServers {
10402 project_id,
10403 buffer_ids: Vec::new(),
10404 also_servers: Vec::new(),
10405 all: true,
10406 });
10407 cx.background_spawn(request).detach_and_log_err(cx);
10408 } else {
10409 let Some(local) = self.as_local_mut() else {
10410 return;
10411 };
10412 let language_servers_to_stop = local
10413 .language_server_ids
10414 .values()
10415 .flatten()
10416 .copied()
10417 .collect();
10418 local.lsp_tree.update(cx, |this, _| {
10419 this.remove_nodes(&language_servers_to_stop);
10420 });
10421 let tasks = language_servers_to_stop
10422 .into_iter()
10423 .map(|server| self.stop_local_language_server(server, cx))
10424 .collect::<Vec<_>>();
10425 cx.background_spawn(async move {
10426 futures::future::join_all(tasks).await;
10427 })
10428 .detach();
10429 }
10430 }
10431
10432 pub fn restart_language_servers_for_buffers(
10433 &mut self,
10434 buffers: Vec<Entity<Buffer>>,
10435 only_restart_servers: HashSet<LanguageServerSelector>,
10436 cx: &mut Context<Self>,
10437 ) {
10438 if let Some((client, project_id)) = self.upstream_client() {
10439 let request = client.request(proto::RestartLanguageServers {
10440 project_id,
10441 buffer_ids: buffers
10442 .into_iter()
10443 .map(|b| b.read(cx).remote_id().to_proto())
10444 .collect(),
10445 only_servers: only_restart_servers
10446 .into_iter()
10447 .map(|selector| {
10448 let selector = match selector {
10449 LanguageServerSelector::Id(language_server_id) => {
10450 proto::language_server_selector::Selector::ServerId(
10451 language_server_id.to_proto(),
10452 )
10453 }
10454 LanguageServerSelector::Name(language_server_name) => {
10455 proto::language_server_selector::Selector::Name(
10456 language_server_name.to_string(),
10457 )
10458 }
10459 };
10460 proto::LanguageServerSelector {
10461 selector: Some(selector),
10462 }
10463 })
10464 .collect(),
10465 all: false,
10466 });
10467 cx.background_spawn(request).detach_and_log_err(cx);
10468 } else {
10469 let stop_task = if only_restart_servers.is_empty() {
10470 self.stop_local_language_servers_for_buffers(&buffers, HashSet::default(), cx)
10471 } else {
10472 self.stop_local_language_servers_for_buffers(&[], only_restart_servers.clone(), cx)
10473 };
10474 cx.spawn(async move |lsp_store, cx| {
10475 stop_task.await;
10476 lsp_store
10477 .update(cx, |lsp_store, cx| {
10478 for buffer in buffers {
10479 lsp_store.register_buffer_with_language_servers(
10480 &buffer,
10481 only_restart_servers.clone(),
10482 true,
10483 cx,
10484 );
10485 }
10486 })
10487 .ok()
10488 })
10489 .detach();
10490 }
10491 }
10492
10493 pub fn stop_language_servers_for_buffers(
10494 &mut self,
10495 buffers: Vec<Entity<Buffer>>,
10496 also_stop_servers: HashSet<LanguageServerSelector>,
10497 cx: &mut Context<Self>,
10498 ) -> Task<Result<()>> {
10499 if let Some((client, project_id)) = self.upstream_client() {
10500 let request = client.request(proto::StopLanguageServers {
10501 project_id,
10502 buffer_ids: buffers
10503 .into_iter()
10504 .map(|b| b.read(cx).remote_id().to_proto())
10505 .collect(),
10506 also_servers: also_stop_servers
10507 .into_iter()
10508 .map(|selector| {
10509 let selector = match selector {
10510 LanguageServerSelector::Id(language_server_id) => {
10511 proto::language_server_selector::Selector::ServerId(
10512 language_server_id.to_proto(),
10513 )
10514 }
10515 LanguageServerSelector::Name(language_server_name) => {
10516 proto::language_server_selector::Selector::Name(
10517 language_server_name.to_string(),
10518 )
10519 }
10520 };
10521 proto::LanguageServerSelector {
10522 selector: Some(selector),
10523 }
10524 })
10525 .collect(),
10526 all: false,
10527 });
10528 cx.background_spawn(async move {
10529 let _ = request.await?;
10530 Ok(())
10531 })
10532 } else {
10533 let task =
10534 self.stop_local_language_servers_for_buffers(&buffers, also_stop_servers, cx);
10535 cx.background_spawn(async move {
10536 task.await;
10537 Ok(())
10538 })
10539 }
10540 }
10541
10542 fn stop_local_language_servers_for_buffers(
10543 &mut self,
10544 buffers: &[Entity<Buffer>],
10545 also_stop_servers: HashSet<LanguageServerSelector>,
10546 cx: &mut Context<Self>,
10547 ) -> Task<()> {
10548 let Some(local) = self.as_local_mut() else {
10549 return Task::ready(());
10550 };
10551 let mut language_server_names_to_stop = BTreeSet::default();
10552 let mut language_servers_to_stop = also_stop_servers
10553 .into_iter()
10554 .flat_map(|selector| match selector {
10555 LanguageServerSelector::Id(id) => Some(id),
10556 LanguageServerSelector::Name(name) => {
10557 language_server_names_to_stop.insert(name);
10558 None
10559 }
10560 })
10561 .collect::<BTreeSet<_>>();
10562
10563 let mut covered_worktrees = HashSet::default();
10564 for buffer in buffers {
10565 buffer.update(cx, |buffer, cx| {
10566 language_servers_to_stop.extend(local.language_server_ids_for_buffer(buffer, cx));
10567 if let Some(worktree_id) = buffer.file().map(|f| f.worktree_id(cx)) {
10568 if covered_worktrees.insert(worktree_id) {
10569 language_server_names_to_stop.retain(|name| {
10570 match local.language_server_ids.get(&(worktree_id, name.clone())) {
10571 Some(server_ids) => {
10572 language_servers_to_stop
10573 .extend(server_ids.into_iter().copied());
10574 false
10575 }
10576 None => true,
10577 }
10578 });
10579 }
10580 }
10581 });
10582 }
10583 for name in language_server_names_to_stop {
10584 if let Some(server_ids) = local
10585 .language_server_ids
10586 .iter()
10587 .filter(|((_, server_name), _)| server_name == &name)
10588 .map(|((_, _), server_ids)| server_ids)
10589 .max_by_key(|server_ids| server_ids.len())
10590 {
10591 language_servers_to_stop.extend(server_ids.into_iter().copied());
10592 }
10593 }
10594
10595 local.lsp_tree.update(cx, |this, _| {
10596 this.remove_nodes(&language_servers_to_stop);
10597 });
10598 let tasks = language_servers_to_stop
10599 .into_iter()
10600 .map(|server| self.stop_local_language_server(server, cx))
10601 .collect::<Vec<_>>();
10602
10603 cx.background_spawn(futures::future::join_all(tasks).map(|_| ()))
10604 }
10605
10606 fn get_buffer<'a>(&self, abs_path: &Path, cx: &'a App) -> Option<&'a Buffer> {
10607 let (worktree, relative_path) =
10608 self.worktree_store.read(cx).find_worktree(&abs_path, cx)?;
10609
10610 let project_path = ProjectPath {
10611 worktree_id: worktree.read(cx).id(),
10612 path: relative_path.into(),
10613 };
10614
10615 Some(
10616 self.buffer_store()
10617 .read(cx)
10618 .get_by_path(&project_path)?
10619 .read(cx),
10620 )
10621 }
10622
10623 #[cfg(any(test, feature = "test-support"))]
10624 pub fn update_diagnostics(
10625 &mut self,
10626 server_id: LanguageServerId,
10627 diagnostics: lsp::PublishDiagnosticsParams,
10628 result_id: Option<String>,
10629 source_kind: DiagnosticSourceKind,
10630 disk_based_sources: &[String],
10631 cx: &mut Context<Self>,
10632 ) -> Result<()> {
10633 self.merge_lsp_diagnostics(
10634 source_kind,
10635 vec![DocumentDiagnosticsUpdate {
10636 diagnostics,
10637 result_id,
10638 server_id,
10639 disk_based_sources: Cow::Borrowed(disk_based_sources),
10640 }],
10641 |_, _, _| false,
10642 cx,
10643 )
10644 }
10645
10646 pub fn merge_lsp_diagnostics(
10647 &mut self,
10648 source_kind: DiagnosticSourceKind,
10649 lsp_diagnostics: Vec<DocumentDiagnosticsUpdate<lsp::PublishDiagnosticsParams>>,
10650 merge: impl Fn(&Buffer, &Diagnostic, &App) -> bool + Clone,
10651 cx: &mut Context<Self>,
10652 ) -> Result<()> {
10653 anyhow::ensure!(self.mode.is_local(), "called update_diagnostics on remote");
10654 let updates = lsp_diagnostics
10655 .into_iter()
10656 .filter_map(|update| {
10657 let abs_path = update.diagnostics.uri.to_file_path().ok()?;
10658 Some(DocumentDiagnosticsUpdate {
10659 diagnostics: self.lsp_to_document_diagnostics(
10660 abs_path,
10661 source_kind,
10662 update.server_id,
10663 update.diagnostics,
10664 &update.disk_based_sources,
10665 ),
10666 result_id: update.result_id,
10667 server_id: update.server_id,
10668 disk_based_sources: update.disk_based_sources,
10669 })
10670 })
10671 .collect();
10672 self.merge_diagnostic_entries(updates, merge, cx)?;
10673 Ok(())
10674 }
10675
10676 fn lsp_to_document_diagnostics(
10677 &mut self,
10678 document_abs_path: PathBuf,
10679 source_kind: DiagnosticSourceKind,
10680 server_id: LanguageServerId,
10681 mut lsp_diagnostics: lsp::PublishDiagnosticsParams,
10682 disk_based_sources: &[String],
10683 ) -> DocumentDiagnostics {
10684 let mut diagnostics = Vec::default();
10685 let mut primary_diagnostic_group_ids = HashMap::default();
10686 let mut sources_by_group_id = HashMap::default();
10687 let mut supporting_diagnostics = HashMap::default();
10688
10689 let adapter = self.language_server_adapter_for_id(server_id);
10690
10691 // Ensure that primary diagnostics are always the most severe
10692 lsp_diagnostics
10693 .diagnostics
10694 .sort_by_key(|item| item.severity);
10695
10696 for diagnostic in &lsp_diagnostics.diagnostics {
10697 let source = diagnostic.source.as_ref();
10698 let range = range_from_lsp(diagnostic.range);
10699 let is_supporting = diagnostic
10700 .related_information
10701 .as_ref()
10702 .map_or(false, |infos| {
10703 infos.iter().any(|info| {
10704 primary_diagnostic_group_ids.contains_key(&(
10705 source,
10706 diagnostic.code.clone(),
10707 range_from_lsp(info.location.range),
10708 ))
10709 })
10710 });
10711
10712 let is_unnecessary = diagnostic
10713 .tags
10714 .as_ref()
10715 .map_or(false, |tags| tags.contains(&DiagnosticTag::UNNECESSARY));
10716
10717 let underline = self
10718 .language_server_adapter_for_id(server_id)
10719 .map_or(true, |adapter| adapter.underline_diagnostic(diagnostic));
10720
10721 if is_supporting {
10722 supporting_diagnostics.insert(
10723 (source, diagnostic.code.clone(), range),
10724 (diagnostic.severity, is_unnecessary),
10725 );
10726 } else {
10727 let group_id = post_inc(&mut self.as_local_mut().unwrap().next_diagnostic_group_id);
10728 let is_disk_based =
10729 source.map_or(false, |source| disk_based_sources.contains(source));
10730
10731 sources_by_group_id.insert(group_id, source);
10732 primary_diagnostic_group_ids
10733 .insert((source, diagnostic.code.clone(), range.clone()), group_id);
10734
10735 diagnostics.push(DiagnosticEntry {
10736 range,
10737 diagnostic: Diagnostic {
10738 source: diagnostic.source.clone(),
10739 source_kind,
10740 code: diagnostic.code.clone(),
10741 code_description: diagnostic
10742 .code_description
10743 .as_ref()
10744 .and_then(|d| d.href.clone()),
10745 severity: diagnostic.severity.unwrap_or(DiagnosticSeverity::ERROR),
10746 markdown: adapter.as_ref().and_then(|adapter| {
10747 adapter.diagnostic_message_to_markdown(&diagnostic.message)
10748 }),
10749 message: diagnostic.message.trim().to_string(),
10750 group_id,
10751 is_primary: true,
10752 is_disk_based,
10753 is_unnecessary,
10754 underline,
10755 data: diagnostic.data.clone(),
10756 },
10757 });
10758 if let Some(infos) = &diagnostic.related_information {
10759 for info in infos {
10760 if info.location.uri == lsp_diagnostics.uri && !info.message.is_empty() {
10761 let range = range_from_lsp(info.location.range);
10762 diagnostics.push(DiagnosticEntry {
10763 range,
10764 diagnostic: Diagnostic {
10765 source: diagnostic.source.clone(),
10766 source_kind,
10767 code: diagnostic.code.clone(),
10768 code_description: diagnostic
10769 .code_description
10770 .as_ref()
10771 .and_then(|d| d.href.clone()),
10772 severity: DiagnosticSeverity::INFORMATION,
10773 markdown: adapter.as_ref().and_then(|adapter| {
10774 adapter.diagnostic_message_to_markdown(&info.message)
10775 }),
10776 message: info.message.trim().to_string(),
10777 group_id,
10778 is_primary: false,
10779 is_disk_based,
10780 is_unnecessary: false,
10781 underline,
10782 data: diagnostic.data.clone(),
10783 },
10784 });
10785 }
10786 }
10787 }
10788 }
10789 }
10790
10791 for entry in &mut diagnostics {
10792 let diagnostic = &mut entry.diagnostic;
10793 if !diagnostic.is_primary {
10794 let source = *sources_by_group_id.get(&diagnostic.group_id).unwrap();
10795 if let Some(&(severity, is_unnecessary)) = supporting_diagnostics.get(&(
10796 source,
10797 diagnostic.code.clone(),
10798 entry.range.clone(),
10799 )) {
10800 if let Some(severity) = severity {
10801 diagnostic.severity = severity;
10802 }
10803 diagnostic.is_unnecessary = is_unnecessary;
10804 }
10805 }
10806 }
10807
10808 DocumentDiagnostics {
10809 diagnostics,
10810 document_abs_path,
10811 version: lsp_diagnostics.version,
10812 }
10813 }
10814
10815 fn insert_newly_running_language_server(
10816 &mut self,
10817 adapter: Arc<CachedLspAdapter>,
10818 language_server: Arc<LanguageServer>,
10819 server_id: LanguageServerId,
10820 key: (WorktreeId, LanguageServerName),
10821 workspace_folders: Arc<Mutex<BTreeSet<Url>>>,
10822 cx: &mut Context<Self>,
10823 ) {
10824 let Some(local) = self.as_local_mut() else {
10825 return;
10826 };
10827 // If the language server for this key doesn't match the server id, don't store the
10828 // server. Which will cause it to be dropped, killing the process
10829 if local
10830 .language_server_ids
10831 .get(&key)
10832 .map(|ids| !ids.contains(&server_id))
10833 .unwrap_or(false)
10834 {
10835 return;
10836 }
10837
10838 // Update language_servers collection with Running variant of LanguageServerState
10839 // indicating that the server is up and running and ready
10840 let workspace_folders = workspace_folders.lock().clone();
10841 language_server.set_workspace_folders(workspace_folders);
10842
10843 local.language_servers.insert(
10844 server_id,
10845 LanguageServerState::Running {
10846 workspace_refresh_task: lsp_workspace_diagnostics_refresh(
10847 language_server.clone(),
10848 cx,
10849 ),
10850 adapter: adapter.clone(),
10851 server: language_server.clone(),
10852 simulate_disk_based_diagnostics_completion: None,
10853 },
10854 );
10855 local
10856 .languages
10857 .update_lsp_binary_status(adapter.name(), BinaryStatus::None);
10858 if let Some(file_ops_caps) = language_server
10859 .capabilities()
10860 .workspace
10861 .as_ref()
10862 .and_then(|ws| ws.file_operations.as_ref())
10863 {
10864 let did_rename_caps = file_ops_caps.did_rename.as_ref();
10865 let will_rename_caps = file_ops_caps.will_rename.as_ref();
10866 if did_rename_caps.or(will_rename_caps).is_some() {
10867 let watcher = RenamePathsWatchedForServer::default()
10868 .with_did_rename_patterns(did_rename_caps)
10869 .with_will_rename_patterns(will_rename_caps);
10870 local
10871 .language_server_paths_watched_for_rename
10872 .insert(server_id, watcher);
10873 }
10874 }
10875
10876 self.language_server_statuses.insert(
10877 server_id,
10878 LanguageServerStatus {
10879 name: language_server.name(),
10880 pending_work: Default::default(),
10881 has_pending_diagnostic_updates: false,
10882 progress_tokens: Default::default(),
10883 },
10884 );
10885
10886 cx.emit(LspStoreEvent::LanguageServerAdded(
10887 server_id,
10888 language_server.name(),
10889 Some(key.0),
10890 ));
10891 cx.emit(LspStoreEvent::RefreshInlayHints);
10892
10893 let server_capabilities = language_server.capabilities();
10894 if let Some((downstream_client, project_id)) = self.downstream_client.as_ref() {
10895 downstream_client
10896 .send(proto::StartLanguageServer {
10897 project_id: *project_id,
10898 server: Some(proto::LanguageServer {
10899 id: server_id.to_proto(),
10900 name: language_server.name().to_string(),
10901 worktree_id: Some(key.0.to_proto()),
10902 }),
10903 capabilities: serde_json::to_string(&server_capabilities)
10904 .expect("serializing server LSP capabilities"),
10905 })
10906 .log_err();
10907 }
10908 self.lsp_server_capabilities
10909 .insert(server_id, server_capabilities);
10910
10911 // Tell the language server about every open buffer in the worktree that matches the language.
10912 // Also check for buffers in worktrees that reused this server
10913 let mut worktrees_using_server = vec![key.0];
10914 if let Some(local) = self.as_local() {
10915 // Find all worktrees that have this server in their language server tree
10916 for (worktree_id, servers) in &local.lsp_tree.read(cx).instances {
10917 if *worktree_id != key.0 {
10918 for (_, server_map) in &servers.roots {
10919 if server_map.contains_key(&key.1) {
10920 worktrees_using_server.push(*worktree_id);
10921 }
10922 }
10923 }
10924 }
10925 }
10926
10927 let mut buffer_paths_registered = Vec::new();
10928 self.buffer_store.clone().update(cx, |buffer_store, cx| {
10929 for buffer_handle in buffer_store.buffers() {
10930 let buffer = buffer_handle.read(cx);
10931 let file = match File::from_dyn(buffer.file()) {
10932 Some(file) => file,
10933 None => continue,
10934 };
10935 let language = match buffer.language() {
10936 Some(language) => language,
10937 None => continue,
10938 };
10939
10940 if !worktrees_using_server.contains(&file.worktree.read(cx).id())
10941 || !self
10942 .languages
10943 .lsp_adapters(&language.name())
10944 .iter()
10945 .any(|a| a.name == key.1)
10946 {
10947 continue;
10948 }
10949 // didOpen
10950 let file = match file.as_local() {
10951 Some(file) => file,
10952 None => continue,
10953 };
10954
10955 let local = self.as_local_mut().unwrap();
10956
10957 let buffer_id = buffer.remote_id();
10958 if local.registered_buffers.contains_key(&buffer_id) {
10959 let versions = local
10960 .buffer_snapshots
10961 .entry(buffer_id)
10962 .or_default()
10963 .entry(server_id)
10964 .and_modify(|_| {
10965 assert!(
10966 false,
10967 "There should not be an existing snapshot for a newly inserted buffer"
10968 )
10969 })
10970 .or_insert_with(|| {
10971 vec![LspBufferSnapshot {
10972 version: 0,
10973 snapshot: buffer.text_snapshot(),
10974 }]
10975 });
10976
10977 let snapshot = versions.last().unwrap();
10978 let version = snapshot.version;
10979 let initial_snapshot = &snapshot.snapshot;
10980 let uri = lsp::Url::from_file_path(file.abs_path(cx)).unwrap();
10981 language_server.register_buffer(
10982 uri,
10983 adapter.language_id(&language.name()),
10984 version,
10985 initial_snapshot.text(),
10986 );
10987 buffer_paths_registered.push((buffer_id, file.abs_path(cx)));
10988 local
10989 .buffers_opened_in_servers
10990 .entry(buffer_id)
10991 .or_default()
10992 .insert(server_id);
10993 }
10994 buffer_handle.update(cx, |buffer, cx| {
10995 buffer.set_completion_triggers(
10996 server_id,
10997 language_server
10998 .capabilities()
10999 .completion_provider
11000 .as_ref()
11001 .and_then(|provider| {
11002 provider
11003 .trigger_characters
11004 .as_ref()
11005 .map(|characters| characters.iter().cloned().collect())
11006 })
11007 .unwrap_or_default(),
11008 cx,
11009 )
11010 });
11011 }
11012 });
11013
11014 for (buffer_id, abs_path) in buffer_paths_registered {
11015 cx.emit(LspStoreEvent::LanguageServerUpdate {
11016 language_server_id: server_id,
11017 name: Some(adapter.name()),
11018 message: proto::update_language_server::Variant::RegisteredForBuffer(
11019 proto::RegisteredForBuffer {
11020 buffer_abs_path: abs_path.to_string_lossy().to_string(),
11021 buffer_id: buffer_id.to_proto(),
11022 },
11023 ),
11024 });
11025 }
11026
11027 cx.notify();
11028 }
11029
11030 pub fn language_servers_running_disk_based_diagnostics(
11031 &self,
11032 ) -> impl Iterator<Item = LanguageServerId> + '_ {
11033 self.language_server_statuses
11034 .iter()
11035 .filter_map(|(id, status)| {
11036 if status.has_pending_diagnostic_updates {
11037 Some(*id)
11038 } else {
11039 None
11040 }
11041 })
11042 }
11043
11044 pub(crate) fn cancel_language_server_work_for_buffers(
11045 &mut self,
11046 buffers: impl IntoIterator<Item = Entity<Buffer>>,
11047 cx: &mut Context<Self>,
11048 ) {
11049 if let Some((client, project_id)) = self.upstream_client() {
11050 let request = client.request(proto::CancelLanguageServerWork {
11051 project_id,
11052 work: Some(proto::cancel_language_server_work::Work::Buffers(
11053 proto::cancel_language_server_work::Buffers {
11054 buffer_ids: buffers
11055 .into_iter()
11056 .map(|b| b.read(cx).remote_id().to_proto())
11057 .collect(),
11058 },
11059 )),
11060 });
11061 cx.background_spawn(request).detach_and_log_err(cx);
11062 } else if let Some(local) = self.as_local() {
11063 let servers = buffers
11064 .into_iter()
11065 .flat_map(|buffer| {
11066 buffer.update(cx, |buffer, cx| {
11067 local.language_server_ids_for_buffer(buffer, cx).into_iter()
11068 })
11069 })
11070 .collect::<HashSet<_>>();
11071 for server_id in servers {
11072 self.cancel_language_server_work(server_id, None, cx);
11073 }
11074 }
11075 }
11076
11077 pub(crate) fn cancel_language_server_work(
11078 &mut self,
11079 server_id: LanguageServerId,
11080 token_to_cancel: Option<String>,
11081 cx: &mut Context<Self>,
11082 ) {
11083 if let Some(local) = self.as_local() {
11084 let status = self.language_server_statuses.get(&server_id);
11085 let server = local.language_servers.get(&server_id);
11086 if let Some((LanguageServerState::Running { server, .. }, status)) = server.zip(status)
11087 {
11088 for (token, progress) in &status.pending_work {
11089 if let Some(token_to_cancel) = token_to_cancel.as_ref() {
11090 if token != token_to_cancel {
11091 continue;
11092 }
11093 }
11094 if progress.is_cancellable {
11095 server
11096 .notify::<lsp::notification::WorkDoneProgressCancel>(
11097 &WorkDoneProgressCancelParams {
11098 token: lsp::NumberOrString::String(token.clone()),
11099 },
11100 )
11101 .ok();
11102 }
11103 }
11104 }
11105 } else if let Some((client, project_id)) = self.upstream_client() {
11106 let request = client.request(proto::CancelLanguageServerWork {
11107 project_id,
11108 work: Some(
11109 proto::cancel_language_server_work::Work::LanguageServerWork(
11110 proto::cancel_language_server_work::LanguageServerWork {
11111 language_server_id: server_id.to_proto(),
11112 token: token_to_cancel,
11113 },
11114 ),
11115 ),
11116 });
11117 cx.background_spawn(request).detach_and_log_err(cx);
11118 }
11119 }
11120
11121 fn register_supplementary_language_server(
11122 &mut self,
11123 id: LanguageServerId,
11124 name: LanguageServerName,
11125 server: Arc<LanguageServer>,
11126 cx: &mut Context<Self>,
11127 ) {
11128 if let Some(local) = self.as_local_mut() {
11129 local
11130 .supplementary_language_servers
11131 .insert(id, (name.clone(), server));
11132 cx.emit(LspStoreEvent::LanguageServerAdded(id, name, None));
11133 }
11134 }
11135
11136 fn unregister_supplementary_language_server(
11137 &mut self,
11138 id: LanguageServerId,
11139 cx: &mut Context<Self>,
11140 ) {
11141 if let Some(local) = self.as_local_mut() {
11142 local.supplementary_language_servers.remove(&id);
11143 cx.emit(LspStoreEvent::LanguageServerRemoved(id));
11144 }
11145 }
11146
11147 pub(crate) fn supplementary_language_servers(
11148 &self,
11149 ) -> impl '_ + Iterator<Item = (LanguageServerId, LanguageServerName)> {
11150 self.as_local().into_iter().flat_map(|local| {
11151 local
11152 .supplementary_language_servers
11153 .iter()
11154 .map(|(id, (name, _))| (*id, name.clone()))
11155 })
11156 }
11157
11158 pub fn language_server_adapter_for_id(
11159 &self,
11160 id: LanguageServerId,
11161 ) -> Option<Arc<CachedLspAdapter>> {
11162 self.as_local()
11163 .and_then(|local| local.language_servers.get(&id))
11164 .and_then(|language_server_state| match language_server_state {
11165 LanguageServerState::Running { adapter, .. } => Some(adapter.clone()),
11166 _ => None,
11167 })
11168 }
11169
11170 pub(super) fn update_local_worktree_language_servers(
11171 &mut self,
11172 worktree_handle: &Entity<Worktree>,
11173 changes: &[(Arc<Path>, ProjectEntryId, PathChange)],
11174 cx: &mut Context<Self>,
11175 ) {
11176 if changes.is_empty() {
11177 return;
11178 }
11179
11180 let Some(local) = self.as_local() else { return };
11181
11182 local.prettier_store.update(cx, |prettier_store, cx| {
11183 prettier_store.update_prettier_settings(&worktree_handle, changes, cx)
11184 });
11185
11186 let worktree_id = worktree_handle.read(cx).id();
11187 let mut language_server_ids = local
11188 .language_server_ids
11189 .iter()
11190 .flat_map(|((server_worktree, _), server_ids)| {
11191 server_ids
11192 .iter()
11193 .filter_map(|server_id| server_worktree.eq(&worktree_id).then(|| *server_id))
11194 })
11195 .collect::<Vec<_>>();
11196 language_server_ids.sort();
11197 language_server_ids.dedup();
11198
11199 let abs_path = worktree_handle.read(cx).abs_path();
11200 for server_id in &language_server_ids {
11201 if let Some(LanguageServerState::Running { server, .. }) =
11202 local.language_servers.get(server_id)
11203 {
11204 if let Some(watched_paths) = local
11205 .language_server_watched_paths
11206 .get(server_id)
11207 .and_then(|paths| paths.worktree_paths.get(&worktree_id))
11208 {
11209 let params = lsp::DidChangeWatchedFilesParams {
11210 changes: changes
11211 .iter()
11212 .filter_map(|(path, _, change)| {
11213 if !watched_paths.is_match(path) {
11214 return None;
11215 }
11216 let typ = match change {
11217 PathChange::Loaded => return None,
11218 PathChange::Added => lsp::FileChangeType::CREATED,
11219 PathChange::Removed => lsp::FileChangeType::DELETED,
11220 PathChange::Updated => lsp::FileChangeType::CHANGED,
11221 PathChange::AddedOrUpdated => lsp::FileChangeType::CHANGED,
11222 };
11223 Some(lsp::FileEvent {
11224 uri: lsp::Url::from_file_path(abs_path.join(path)).unwrap(),
11225 typ,
11226 })
11227 })
11228 .collect(),
11229 };
11230 if !params.changes.is_empty() {
11231 server
11232 .notify::<lsp::notification::DidChangeWatchedFiles>(¶ms)
11233 .ok();
11234 }
11235 }
11236 }
11237 }
11238 }
11239
11240 pub fn wait_for_remote_buffer(
11241 &mut self,
11242 id: BufferId,
11243 cx: &mut Context<Self>,
11244 ) -> Task<Result<Entity<Buffer>>> {
11245 self.buffer_store.update(cx, |buffer_store, cx| {
11246 buffer_store.wait_for_remote_buffer(id, cx)
11247 })
11248 }
11249
11250 fn serialize_symbol(symbol: &Symbol) -> proto::Symbol {
11251 proto::Symbol {
11252 language_server_name: symbol.language_server_name.0.to_string(),
11253 source_worktree_id: symbol.source_worktree_id.to_proto(),
11254 language_server_id: symbol.source_language_server_id.to_proto(),
11255 worktree_id: symbol.path.worktree_id.to_proto(),
11256 path: symbol.path.path.as_ref().to_proto(),
11257 name: symbol.name.clone(),
11258 kind: unsafe { mem::transmute::<lsp::SymbolKind, i32>(symbol.kind) },
11259 start: Some(proto::PointUtf16 {
11260 row: symbol.range.start.0.row,
11261 column: symbol.range.start.0.column,
11262 }),
11263 end: Some(proto::PointUtf16 {
11264 row: symbol.range.end.0.row,
11265 column: symbol.range.end.0.column,
11266 }),
11267 signature: symbol.signature.to_vec(),
11268 }
11269 }
11270
11271 fn deserialize_symbol(serialized_symbol: proto::Symbol) -> Result<CoreSymbol> {
11272 let source_worktree_id = WorktreeId::from_proto(serialized_symbol.source_worktree_id);
11273 let worktree_id = WorktreeId::from_proto(serialized_symbol.worktree_id);
11274 let kind = unsafe { mem::transmute::<i32, lsp::SymbolKind>(serialized_symbol.kind) };
11275 let path = ProjectPath {
11276 worktree_id,
11277 path: Arc::<Path>::from_proto(serialized_symbol.path),
11278 };
11279
11280 let start = serialized_symbol.start.context("invalid start")?;
11281 let end = serialized_symbol.end.context("invalid end")?;
11282 Ok(CoreSymbol {
11283 language_server_name: LanguageServerName(serialized_symbol.language_server_name.into()),
11284 source_worktree_id,
11285 source_language_server_id: LanguageServerId::from_proto(
11286 serialized_symbol.language_server_id,
11287 ),
11288 path,
11289 name: serialized_symbol.name,
11290 range: Unclipped(PointUtf16::new(start.row, start.column))
11291 ..Unclipped(PointUtf16::new(end.row, end.column)),
11292 kind,
11293 signature: serialized_symbol
11294 .signature
11295 .try_into()
11296 .map_err(|_| anyhow!("invalid signature"))?,
11297 })
11298 }
11299
11300 pub(crate) fn serialize_completion(completion: &CoreCompletion) -> proto::Completion {
11301 let mut serialized_completion = proto::Completion {
11302 old_replace_start: Some(serialize_anchor(&completion.replace_range.start)),
11303 old_replace_end: Some(serialize_anchor(&completion.replace_range.end)),
11304 new_text: completion.new_text.clone(),
11305 ..proto::Completion::default()
11306 };
11307 match &completion.source {
11308 CompletionSource::Lsp {
11309 insert_range,
11310 server_id,
11311 lsp_completion,
11312 lsp_defaults,
11313 resolved,
11314 } => {
11315 let (old_insert_start, old_insert_end) = insert_range
11316 .as_ref()
11317 .map(|range| (serialize_anchor(&range.start), serialize_anchor(&range.end)))
11318 .unzip();
11319
11320 serialized_completion.old_insert_start = old_insert_start;
11321 serialized_completion.old_insert_end = old_insert_end;
11322 serialized_completion.source = proto::completion::Source::Lsp as i32;
11323 serialized_completion.server_id = server_id.0 as u64;
11324 serialized_completion.lsp_completion = serde_json::to_vec(lsp_completion).unwrap();
11325 serialized_completion.lsp_defaults = lsp_defaults
11326 .as_deref()
11327 .map(|lsp_defaults| serde_json::to_vec(lsp_defaults).unwrap());
11328 serialized_completion.resolved = *resolved;
11329 }
11330 CompletionSource::BufferWord {
11331 word_range,
11332 resolved,
11333 } => {
11334 serialized_completion.source = proto::completion::Source::BufferWord as i32;
11335 serialized_completion.buffer_word_start = Some(serialize_anchor(&word_range.start));
11336 serialized_completion.buffer_word_end = Some(serialize_anchor(&word_range.end));
11337 serialized_completion.resolved = *resolved;
11338 }
11339 CompletionSource::Custom => {
11340 serialized_completion.source = proto::completion::Source::Custom as i32;
11341 serialized_completion.resolved = true;
11342 }
11343 CompletionSource::Dap { sort_text } => {
11344 serialized_completion.source = proto::completion::Source::Dap as i32;
11345 serialized_completion.sort_text = Some(sort_text.clone());
11346 }
11347 }
11348
11349 serialized_completion
11350 }
11351
11352 pub(crate) fn deserialize_completion(completion: proto::Completion) -> Result<CoreCompletion> {
11353 let old_replace_start = completion
11354 .old_replace_start
11355 .and_then(deserialize_anchor)
11356 .context("invalid old start")?;
11357 let old_replace_end = completion
11358 .old_replace_end
11359 .and_then(deserialize_anchor)
11360 .context("invalid old end")?;
11361 let insert_range = {
11362 match completion.old_insert_start.zip(completion.old_insert_end) {
11363 Some((start, end)) => {
11364 let start = deserialize_anchor(start).context("invalid insert old start")?;
11365 let end = deserialize_anchor(end).context("invalid insert old end")?;
11366 Some(start..end)
11367 }
11368 None => None,
11369 }
11370 };
11371 Ok(CoreCompletion {
11372 replace_range: old_replace_start..old_replace_end,
11373 new_text: completion.new_text,
11374 source: match proto::completion::Source::from_i32(completion.source) {
11375 Some(proto::completion::Source::Custom) => CompletionSource::Custom,
11376 Some(proto::completion::Source::Lsp) => CompletionSource::Lsp {
11377 insert_range,
11378 server_id: LanguageServerId::from_proto(completion.server_id),
11379 lsp_completion: serde_json::from_slice(&completion.lsp_completion)?,
11380 lsp_defaults: completion
11381 .lsp_defaults
11382 .as_deref()
11383 .map(serde_json::from_slice)
11384 .transpose()?,
11385 resolved: completion.resolved,
11386 },
11387 Some(proto::completion::Source::BufferWord) => {
11388 let word_range = completion
11389 .buffer_word_start
11390 .and_then(deserialize_anchor)
11391 .context("invalid buffer word start")?
11392 ..completion
11393 .buffer_word_end
11394 .and_then(deserialize_anchor)
11395 .context("invalid buffer word end")?;
11396 CompletionSource::BufferWord {
11397 word_range,
11398 resolved: completion.resolved,
11399 }
11400 }
11401 Some(proto::completion::Source::Dap) => CompletionSource::Dap {
11402 sort_text: completion
11403 .sort_text
11404 .context("expected sort text to exist")?,
11405 },
11406 _ => anyhow::bail!("Unexpected completion source {}", completion.source),
11407 },
11408 })
11409 }
11410
11411 pub(crate) fn serialize_code_action(action: &CodeAction) -> proto::CodeAction {
11412 let (kind, lsp_action) = match &action.lsp_action {
11413 LspAction::Action(code_action) => (
11414 proto::code_action::Kind::Action as i32,
11415 serde_json::to_vec(code_action).unwrap(),
11416 ),
11417 LspAction::Command(command) => (
11418 proto::code_action::Kind::Command as i32,
11419 serde_json::to_vec(command).unwrap(),
11420 ),
11421 LspAction::CodeLens(code_lens) => (
11422 proto::code_action::Kind::CodeLens as i32,
11423 serde_json::to_vec(code_lens).unwrap(),
11424 ),
11425 };
11426
11427 proto::CodeAction {
11428 server_id: action.server_id.0 as u64,
11429 start: Some(serialize_anchor(&action.range.start)),
11430 end: Some(serialize_anchor(&action.range.end)),
11431 lsp_action,
11432 kind,
11433 resolved: action.resolved,
11434 }
11435 }
11436
11437 pub(crate) fn deserialize_code_action(action: proto::CodeAction) -> Result<CodeAction> {
11438 let start = action
11439 .start
11440 .and_then(deserialize_anchor)
11441 .context("invalid start")?;
11442 let end = action
11443 .end
11444 .and_then(deserialize_anchor)
11445 .context("invalid end")?;
11446 let lsp_action = match proto::code_action::Kind::from_i32(action.kind) {
11447 Some(proto::code_action::Kind::Action) => {
11448 LspAction::Action(serde_json::from_slice(&action.lsp_action)?)
11449 }
11450 Some(proto::code_action::Kind::Command) => {
11451 LspAction::Command(serde_json::from_slice(&action.lsp_action)?)
11452 }
11453 Some(proto::code_action::Kind::CodeLens) => {
11454 LspAction::CodeLens(serde_json::from_slice(&action.lsp_action)?)
11455 }
11456 None => anyhow::bail!("Unknown action kind {}", action.kind),
11457 };
11458 Ok(CodeAction {
11459 server_id: LanguageServerId(action.server_id as usize),
11460 range: start..end,
11461 resolved: action.resolved,
11462 lsp_action,
11463 })
11464 }
11465
11466 fn update_last_formatting_failure<T>(&mut self, formatting_result: &anyhow::Result<T>) {
11467 match &formatting_result {
11468 Ok(_) => self.last_formatting_failure = None,
11469 Err(error) => {
11470 let error_string = format!("{error:#}");
11471 log::error!("Formatting failed: {error_string}");
11472 self.last_formatting_failure
11473 .replace(error_string.lines().join(" "));
11474 }
11475 }
11476 }
11477
11478 fn cleanup_lsp_data(&mut self, for_server: LanguageServerId) {
11479 self.lsp_server_capabilities.remove(&for_server);
11480 for buffer_colors in self.lsp_document_colors.values_mut() {
11481 buffer_colors.colors.remove(&for_server);
11482 buffer_colors.cache_version += 1;
11483 }
11484 for buffer_lens in self.lsp_code_lens.values_mut() {
11485 buffer_lens.lens.remove(&for_server);
11486 }
11487 if let Some(local) = self.as_local_mut() {
11488 local.buffer_pull_diagnostics_result_ids.remove(&for_server);
11489 for buffer_servers in local.buffers_opened_in_servers.values_mut() {
11490 buffer_servers.remove(&for_server);
11491 }
11492 }
11493 }
11494
11495 pub fn result_id(
11496 &self,
11497 server_id: LanguageServerId,
11498 buffer_id: BufferId,
11499 cx: &App,
11500 ) -> Option<String> {
11501 let abs_path = self
11502 .buffer_store
11503 .read(cx)
11504 .get(buffer_id)
11505 .and_then(|b| File::from_dyn(b.read(cx).file()))
11506 .map(|f| f.abs_path(cx))?;
11507 self.as_local()?
11508 .buffer_pull_diagnostics_result_ids
11509 .get(&server_id)?
11510 .get(&abs_path)?
11511 .clone()
11512 }
11513
11514 pub fn all_result_ids(&self, server_id: LanguageServerId) -> HashMap<PathBuf, String> {
11515 let Some(local) = self.as_local() else {
11516 return HashMap::default();
11517 };
11518 local
11519 .buffer_pull_diagnostics_result_ids
11520 .get(&server_id)
11521 .into_iter()
11522 .flatten()
11523 .filter_map(|(abs_path, result_id)| Some((abs_path.clone(), result_id.clone()?)))
11524 .collect()
11525 }
11526
11527 pub fn pull_workspace_diagnostics(&mut self, server_id: LanguageServerId) {
11528 if let Some(LanguageServerState::Running {
11529 workspace_refresh_task: Some(workspace_refresh_task),
11530 ..
11531 }) = self
11532 .as_local_mut()
11533 .and_then(|local| local.language_servers.get_mut(&server_id))
11534 {
11535 workspace_refresh_task.refresh_tx.try_send(()).ok();
11536 }
11537 }
11538
11539 pub fn pull_workspace_diagnostics_for_buffer(&mut self, buffer_id: BufferId, cx: &mut App) {
11540 let Some(buffer) = self.buffer_store().read(cx).get_existing(buffer_id).ok() else {
11541 return;
11542 };
11543 let Some(local) = self.as_local_mut() else {
11544 return;
11545 };
11546
11547 for server_id in buffer.update(cx, |buffer, cx| {
11548 local.language_server_ids_for_buffer(buffer, cx)
11549 }) {
11550 if let Some(LanguageServerState::Running {
11551 workspace_refresh_task: Some(workspace_refresh_task),
11552 ..
11553 }) = local.language_servers.get_mut(&server_id)
11554 {
11555 workspace_refresh_task.refresh_tx.try_send(()).ok();
11556 }
11557 }
11558 }
11559
11560 fn apply_workspace_diagnostic_report(
11561 &mut self,
11562 server_id: LanguageServerId,
11563 report: lsp::WorkspaceDiagnosticReportResult,
11564 cx: &mut Context<Self>,
11565 ) {
11566 let workspace_diagnostics =
11567 GetDocumentDiagnostics::deserialize_workspace_diagnostics_report(report, server_id);
11568 let mut unchanged_buffers = HashSet::default();
11569 let mut changed_buffers = HashSet::default();
11570 let workspace_diagnostics_updates = workspace_diagnostics
11571 .into_iter()
11572 .filter_map(
11573 |workspace_diagnostics| match workspace_diagnostics.diagnostics {
11574 LspPullDiagnostics::Response {
11575 server_id,
11576 uri,
11577 diagnostics,
11578 } => Some((server_id, uri, diagnostics, workspace_diagnostics.version)),
11579 LspPullDiagnostics::Default => None,
11580 },
11581 )
11582 .fold(
11583 HashMap::default(),
11584 |mut acc, (server_id, uri, diagnostics, version)| {
11585 let (result_id, diagnostics) = match diagnostics {
11586 PulledDiagnostics::Unchanged { result_id } => {
11587 unchanged_buffers.insert(uri.clone());
11588 (Some(result_id), Vec::new())
11589 }
11590 PulledDiagnostics::Changed {
11591 result_id,
11592 diagnostics,
11593 } => {
11594 changed_buffers.insert(uri.clone());
11595 (result_id, diagnostics)
11596 }
11597 };
11598 let disk_based_sources = Cow::Owned(
11599 self.language_server_adapter_for_id(server_id)
11600 .as_ref()
11601 .map(|adapter| adapter.disk_based_diagnostic_sources.as_slice())
11602 .unwrap_or(&[])
11603 .to_vec(),
11604 );
11605 acc.entry(server_id)
11606 .or_insert_with(Vec::new)
11607 .push(DocumentDiagnosticsUpdate {
11608 server_id,
11609 diagnostics: lsp::PublishDiagnosticsParams {
11610 uri,
11611 diagnostics,
11612 version,
11613 },
11614 result_id,
11615 disk_based_sources,
11616 });
11617 acc
11618 },
11619 );
11620
11621 for diagnostic_updates in workspace_diagnostics_updates.into_values() {
11622 self.merge_lsp_diagnostics(
11623 DiagnosticSourceKind::Pulled,
11624 diagnostic_updates,
11625 |buffer, old_diagnostic, cx| {
11626 File::from_dyn(buffer.file())
11627 .and_then(|file| {
11628 let abs_path = file.as_local()?.abs_path(cx);
11629 lsp::Url::from_file_path(abs_path).ok()
11630 })
11631 .is_none_or(|buffer_uri| {
11632 unchanged_buffers.contains(&buffer_uri)
11633 || match old_diagnostic.source_kind {
11634 DiagnosticSourceKind::Pulled => {
11635 !changed_buffers.contains(&buffer_uri)
11636 }
11637 DiagnosticSourceKind::Other | DiagnosticSourceKind::Pushed => {
11638 true
11639 }
11640 }
11641 })
11642 },
11643 cx,
11644 )
11645 .log_err();
11646 }
11647 }
11648
11649 fn register_server_capabilities(
11650 &mut self,
11651 server_id: LanguageServerId,
11652 params: lsp::RegistrationParams,
11653 cx: &mut Context<Self>,
11654 ) -> anyhow::Result<()> {
11655 let server = self
11656 .language_server_for_id(server_id)
11657 .with_context(|| format!("no server {server_id} found"))?;
11658 for reg in params.registrations {
11659 match reg.method.as_str() {
11660 "workspace/didChangeWatchedFiles" => {
11661 if let Some(options) = reg.register_options {
11662 let notify = if let Some(local_lsp_store) = self.as_local_mut() {
11663 let caps = serde_json::from_value(options)?;
11664 local_lsp_store
11665 .on_lsp_did_change_watched_files(server_id, ®.id, caps, cx);
11666 true
11667 } else {
11668 false
11669 };
11670 if notify {
11671 notify_server_capabilities_updated(&server, cx);
11672 }
11673 }
11674 }
11675 "workspace/didChangeConfiguration" => {
11676 // Ignore payload since we notify clients of setting changes unconditionally, relying on them pulling the latest settings.
11677 }
11678 "workspace/symbol" => {
11679 if let Some(options) = parse_register_capabilities(reg)? {
11680 server.update_capabilities(|capabilities| {
11681 capabilities.workspace_symbol_provider = Some(options);
11682 });
11683 notify_server_capabilities_updated(&server, cx);
11684 }
11685 }
11686 "workspace/fileOperations" => {
11687 if let Some(options) = reg.register_options {
11688 let caps = serde_json::from_value(options)?;
11689 server.update_capabilities(|capabilities| {
11690 capabilities
11691 .workspace
11692 .get_or_insert_default()
11693 .file_operations = Some(caps);
11694 });
11695 notify_server_capabilities_updated(&server, cx);
11696 }
11697 }
11698 "workspace/executeCommand" => {
11699 if let Some(options) = reg.register_options {
11700 let options = serde_json::from_value(options)?;
11701 server.update_capabilities(|capabilities| {
11702 capabilities.execute_command_provider = Some(options);
11703 });
11704 notify_server_capabilities_updated(&server, cx);
11705 }
11706 }
11707 "textDocument/rangeFormatting" => {
11708 if let Some(options) = parse_register_capabilities(reg)? {
11709 server.update_capabilities(|capabilities| {
11710 capabilities.document_range_formatting_provider = Some(options);
11711 });
11712 notify_server_capabilities_updated(&server, cx);
11713 }
11714 }
11715 "textDocument/onTypeFormatting" => {
11716 if let Some(options) = reg
11717 .register_options
11718 .map(serde_json::from_value)
11719 .transpose()?
11720 {
11721 server.update_capabilities(|capabilities| {
11722 capabilities.document_on_type_formatting_provider = Some(options);
11723 });
11724 notify_server_capabilities_updated(&server, cx);
11725 }
11726 }
11727 "textDocument/formatting" => {
11728 if let Some(options) = parse_register_capabilities(reg)? {
11729 server.update_capabilities(|capabilities| {
11730 capabilities.document_formatting_provider = Some(options);
11731 });
11732 notify_server_capabilities_updated(&server, cx);
11733 }
11734 }
11735 "textDocument/rename" => {
11736 if let Some(options) = parse_register_capabilities(reg)? {
11737 server.update_capabilities(|capabilities| {
11738 capabilities.rename_provider = Some(options);
11739 });
11740 notify_server_capabilities_updated(&server, cx);
11741 }
11742 }
11743 "textDocument/inlayHint" => {
11744 if let Some(options) = parse_register_capabilities(reg)? {
11745 server.update_capabilities(|capabilities| {
11746 capabilities.inlay_hint_provider = Some(options);
11747 });
11748 notify_server_capabilities_updated(&server, cx);
11749 }
11750 }
11751 "textDocument/documentSymbol" => {
11752 if let Some(options) = parse_register_capabilities(reg)? {
11753 server.update_capabilities(|capabilities| {
11754 capabilities.document_symbol_provider = Some(options);
11755 });
11756 notify_server_capabilities_updated(&server, cx);
11757 }
11758 }
11759 "textDocument/codeAction" => {
11760 if let Some(options) = reg
11761 .register_options
11762 .map(serde_json::from_value)
11763 .transpose()?
11764 {
11765 server.update_capabilities(|capabilities| {
11766 capabilities.code_action_provider =
11767 Some(lsp::CodeActionProviderCapability::Options(options));
11768 });
11769 notify_server_capabilities_updated(&server, cx);
11770 }
11771 }
11772 "textDocument/definition" => {
11773 if let Some(options) = parse_register_capabilities(reg)? {
11774 server.update_capabilities(|capabilities| {
11775 capabilities.definition_provider = Some(options);
11776 });
11777 notify_server_capabilities_updated(&server, cx);
11778 }
11779 }
11780 "textDocument/completion" => {
11781 if let Some(caps) = reg
11782 .register_options
11783 .map(serde_json::from_value)
11784 .transpose()?
11785 {
11786 server.update_capabilities(|capabilities| {
11787 capabilities.completion_provider = Some(caps);
11788 });
11789 notify_server_capabilities_updated(&server, cx);
11790 }
11791 }
11792 "textDocument/hover" => {
11793 if let Some(caps) = reg
11794 .register_options
11795 .map(serde_json::from_value)
11796 .transpose()?
11797 {
11798 server.update_capabilities(|capabilities| {
11799 capabilities.hover_provider = Some(caps);
11800 });
11801 notify_server_capabilities_updated(&server, cx);
11802 }
11803 }
11804 "textDocument/signatureHelp" => {
11805 if let Some(caps) = reg
11806 .register_options
11807 .map(serde_json::from_value)
11808 .transpose()?
11809 {
11810 server.update_capabilities(|capabilities| {
11811 capabilities.signature_help_provider = Some(caps);
11812 });
11813 notify_server_capabilities_updated(&server, cx);
11814 }
11815 }
11816 "textDocument/synchronization" => {
11817 if let Some(caps) = reg
11818 .register_options
11819 .map(serde_json::from_value)
11820 .transpose()?
11821 {
11822 server.update_capabilities(|capabilities| {
11823 capabilities.text_document_sync = Some(caps);
11824 });
11825 notify_server_capabilities_updated(&server, cx);
11826 }
11827 }
11828 "textDocument/codeLens" => {
11829 if let Some(caps) = reg
11830 .register_options
11831 .map(serde_json::from_value)
11832 .transpose()?
11833 {
11834 server.update_capabilities(|capabilities| {
11835 capabilities.code_lens_provider = Some(caps);
11836 });
11837 notify_server_capabilities_updated(&server, cx);
11838 }
11839 }
11840 "textDocument/diagnostic" => {
11841 if let Some(caps) = reg
11842 .register_options
11843 .map(serde_json::from_value)
11844 .transpose()?
11845 {
11846 server.update_capabilities(|capabilities| {
11847 capabilities.diagnostic_provider = Some(caps);
11848 });
11849 notify_server_capabilities_updated(&server, cx);
11850 }
11851 }
11852 "textDocument/colorProvider" => {
11853 if let Some(caps) = reg
11854 .register_options
11855 .map(serde_json::from_value)
11856 .transpose()?
11857 {
11858 server.update_capabilities(|capabilities| {
11859 capabilities.color_provider = Some(caps);
11860 });
11861 notify_server_capabilities_updated(&server, cx);
11862 }
11863 }
11864 _ => log::warn!("unhandled capability registration: {reg:?}"),
11865 }
11866 }
11867
11868 Ok(())
11869 }
11870
11871 fn unregister_server_capabilities(
11872 &mut self,
11873 server_id: LanguageServerId,
11874 params: lsp::UnregistrationParams,
11875 cx: &mut Context<Self>,
11876 ) -> anyhow::Result<()> {
11877 let server = self
11878 .language_server_for_id(server_id)
11879 .with_context(|| format!("no server {server_id} found"))?;
11880 for unreg in params.unregisterations.iter() {
11881 match unreg.method.as_str() {
11882 "workspace/didChangeWatchedFiles" => {
11883 let notify = if let Some(local_lsp_store) = self.as_local_mut() {
11884 local_lsp_store
11885 .on_lsp_unregister_did_change_watched_files(server_id, &unreg.id, cx);
11886 true
11887 } else {
11888 false
11889 };
11890 if notify {
11891 notify_server_capabilities_updated(&server, cx);
11892 }
11893 }
11894 "workspace/didChangeConfiguration" => {
11895 // Ignore payload since we notify clients of setting changes unconditionally, relying on them pulling the latest settings.
11896 }
11897 "workspace/symbol" => {
11898 server.update_capabilities(|capabilities| {
11899 capabilities.workspace_symbol_provider = None
11900 });
11901 notify_server_capabilities_updated(&server, cx);
11902 }
11903 "workspace/fileOperations" => {
11904 server.update_capabilities(|capabilities| {
11905 capabilities
11906 .workspace
11907 .get_or_insert_with(|| lsp::WorkspaceServerCapabilities {
11908 workspace_folders: None,
11909 file_operations: None,
11910 })
11911 .file_operations = None;
11912 });
11913 notify_server_capabilities_updated(&server, cx);
11914 }
11915 "workspace/executeCommand" => {
11916 server.update_capabilities(|capabilities| {
11917 capabilities.execute_command_provider = None;
11918 });
11919 notify_server_capabilities_updated(&server, cx);
11920 }
11921 "textDocument/rangeFormatting" => {
11922 server.update_capabilities(|capabilities| {
11923 capabilities.document_range_formatting_provider = None
11924 });
11925 notify_server_capabilities_updated(&server, cx);
11926 }
11927 "textDocument/onTypeFormatting" => {
11928 server.update_capabilities(|capabilities| {
11929 capabilities.document_on_type_formatting_provider = None;
11930 });
11931 notify_server_capabilities_updated(&server, cx);
11932 }
11933 "textDocument/formatting" => {
11934 server.update_capabilities(|capabilities| {
11935 capabilities.document_formatting_provider = None;
11936 });
11937 notify_server_capabilities_updated(&server, cx);
11938 }
11939 "textDocument/rename" => {
11940 server.update_capabilities(|capabilities| capabilities.rename_provider = None);
11941 notify_server_capabilities_updated(&server, cx);
11942 }
11943 "textDocument/codeAction" => {
11944 server.update_capabilities(|capabilities| {
11945 capabilities.code_action_provider = None;
11946 });
11947 notify_server_capabilities_updated(&server, cx);
11948 }
11949 "textDocument/definition" => {
11950 server.update_capabilities(|capabilities| {
11951 capabilities.definition_provider = None;
11952 });
11953 notify_server_capabilities_updated(&server, cx);
11954 }
11955 "textDocument/completion" => {
11956 server.update_capabilities(|capabilities| {
11957 capabilities.completion_provider = None;
11958 });
11959 notify_server_capabilities_updated(&server, cx);
11960 }
11961 "textDocument/hover" => {
11962 server.update_capabilities(|capabilities| {
11963 capabilities.hover_provider = None;
11964 });
11965 notify_server_capabilities_updated(&server, cx);
11966 }
11967 "textDocument/signatureHelp" => {
11968 server.update_capabilities(|capabilities| {
11969 capabilities.signature_help_provider = None;
11970 });
11971 notify_server_capabilities_updated(&server, cx);
11972 }
11973 "textDocument/synchronization" => {
11974 server.update_capabilities(|capabilities| {
11975 capabilities.text_document_sync = None;
11976 });
11977 notify_server_capabilities_updated(&server, cx);
11978 }
11979 "textDocument/codeLens" => {
11980 server.update_capabilities(|capabilities| {
11981 capabilities.code_lens_provider = None;
11982 });
11983 notify_server_capabilities_updated(&server, cx);
11984 }
11985 "textDocument/diagnostic" => {
11986 server.update_capabilities(|capabilities| {
11987 capabilities.diagnostic_provider = None;
11988 });
11989 notify_server_capabilities_updated(&server, cx);
11990 }
11991 "textDocument/colorProvider" => {
11992 server.update_capabilities(|capabilities| {
11993 capabilities.color_provider = None;
11994 });
11995 notify_server_capabilities_updated(&server, cx);
11996 }
11997 _ => log::warn!("unhandled capability unregistration: {unreg:?}"),
11998 }
11999 }
12000
12001 Ok(())
12002 }
12003}
12004
12005// Registration with empty capabilities should be ignored.
12006// https://github.com/microsoft/vscode-languageserver-node/blob/d90a87f9557a0df9142cfb33e251cfa6fe27d970/client/src/common/formatting.ts#L67-L70
12007fn parse_register_capabilities<T: serde::de::DeserializeOwned>(
12008 reg: lsp::Registration,
12009) -> anyhow::Result<Option<OneOf<bool, T>>> {
12010 Ok(reg
12011 .register_options
12012 .map(|options| serde_json::from_value::<T>(options))
12013 .transpose()?
12014 .map(OneOf::Right))
12015}
12016
12017fn subscribe_to_binary_statuses(
12018 languages: &Arc<LanguageRegistry>,
12019 cx: &mut Context<'_, LspStore>,
12020) -> Task<()> {
12021 let mut server_statuses = languages.language_server_binary_statuses();
12022 cx.spawn(async move |lsp_store, cx| {
12023 while let Some((server_name, binary_status)) = server_statuses.next().await {
12024 if lsp_store
12025 .update(cx, |_, cx| {
12026 let mut message = None;
12027 let binary_status = match binary_status {
12028 BinaryStatus::None => proto::ServerBinaryStatus::None,
12029 BinaryStatus::CheckingForUpdate => {
12030 proto::ServerBinaryStatus::CheckingForUpdate
12031 }
12032 BinaryStatus::Downloading => proto::ServerBinaryStatus::Downloading,
12033 BinaryStatus::Starting => proto::ServerBinaryStatus::Starting,
12034 BinaryStatus::Stopping => proto::ServerBinaryStatus::Stopping,
12035 BinaryStatus::Stopped => proto::ServerBinaryStatus::Stopped,
12036 BinaryStatus::Failed { error } => {
12037 message = Some(error);
12038 proto::ServerBinaryStatus::Failed
12039 }
12040 };
12041 cx.emit(LspStoreEvent::LanguageServerUpdate {
12042 // Binary updates are about the binary that might not have any language server id at that point.
12043 // Reuse `LanguageServerUpdate` for them and provide a fake id that won't be used on the receiver side.
12044 language_server_id: LanguageServerId(0),
12045 name: Some(server_name),
12046 message: proto::update_language_server::Variant::StatusUpdate(
12047 proto::StatusUpdate {
12048 message,
12049 status: Some(proto::status_update::Status::Binary(
12050 binary_status as i32,
12051 )),
12052 },
12053 ),
12054 });
12055 })
12056 .is_err()
12057 {
12058 break;
12059 }
12060 }
12061 })
12062}
12063
12064fn lsp_workspace_diagnostics_refresh(
12065 server: Arc<LanguageServer>,
12066 cx: &mut Context<'_, LspStore>,
12067) -> Option<WorkspaceRefreshTask> {
12068 let identifier = match server.capabilities().diagnostic_provider? {
12069 lsp::DiagnosticServerCapabilities::Options(diagnostic_options) => {
12070 if !diagnostic_options.workspace_diagnostics {
12071 return None;
12072 }
12073 diagnostic_options.identifier
12074 }
12075 lsp::DiagnosticServerCapabilities::RegistrationOptions(registration_options) => {
12076 let diagnostic_options = registration_options.diagnostic_options;
12077 if !diagnostic_options.workspace_diagnostics {
12078 return None;
12079 }
12080 diagnostic_options.identifier
12081 }
12082 };
12083
12084 let (progress_tx, mut progress_rx) = mpsc::channel(1);
12085 let (mut refresh_tx, mut refresh_rx) = mpsc::channel(1);
12086 refresh_tx.try_send(()).ok();
12087
12088 let workspace_query_language_server = cx.spawn(async move |lsp_store, cx| {
12089 let mut attempts = 0;
12090 let max_attempts = 50;
12091 let mut requests = 0;
12092
12093 loop {
12094 let Some(()) = refresh_rx.recv().await else {
12095 return;
12096 };
12097
12098 'request: loop {
12099 requests += 1;
12100 if attempts > max_attempts {
12101 log::error!(
12102 "Failed to pull workspace diagnostics {max_attempts} times, aborting"
12103 );
12104 return;
12105 }
12106 let backoff_millis = (50 * (1 << attempts)).clamp(30, 1000);
12107 cx.background_executor()
12108 .timer(Duration::from_millis(backoff_millis))
12109 .await;
12110 attempts += 1;
12111
12112 let Ok(previous_result_ids) = lsp_store.update(cx, |lsp_store, _| {
12113 lsp_store
12114 .all_result_ids(server.server_id())
12115 .into_iter()
12116 .filter_map(|(abs_path, result_id)| {
12117 let uri = file_path_to_lsp_url(&abs_path).ok()?;
12118 Some(lsp::PreviousResultId {
12119 uri,
12120 value: result_id,
12121 })
12122 })
12123 .collect()
12124 }) else {
12125 return;
12126 };
12127
12128 let token = format!("workspace/diagnostic-{}-{}", server.server_id(), requests);
12129
12130 progress_rx.try_recv().ok();
12131 let timer =
12132 LanguageServer::default_request_timer(cx.background_executor().clone()).fuse();
12133 let progress = pin!(progress_rx.recv().fuse());
12134 let response_result = server
12135 .request_with_timer::<lsp::WorkspaceDiagnosticRequest, _>(
12136 lsp::WorkspaceDiagnosticParams {
12137 previous_result_ids,
12138 identifier: identifier.clone(),
12139 work_done_progress_params: Default::default(),
12140 partial_result_params: lsp::PartialResultParams {
12141 partial_result_token: Some(lsp::ProgressToken::String(token)),
12142 },
12143 },
12144 select(timer, progress).then(|either| match either {
12145 Either::Left((message, ..)) => ready(message).left_future(),
12146 Either::Right(..) => pending::<String>().right_future(),
12147 }),
12148 )
12149 .await;
12150
12151 // https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#diagnostic_refresh
12152 // > If a server closes a workspace diagnostic pull request the client should re-trigger the request.
12153 match response_result {
12154 ConnectionResult::Timeout => {
12155 log::error!("Timeout during workspace diagnostics pull");
12156 continue 'request;
12157 }
12158 ConnectionResult::ConnectionReset => {
12159 log::error!("Server closed a workspace diagnostics pull request");
12160 continue 'request;
12161 }
12162 ConnectionResult::Result(Err(e)) => {
12163 log::error!("Error during workspace diagnostics pull: {e:#}");
12164 break 'request;
12165 }
12166 ConnectionResult::Result(Ok(pulled_diagnostics)) => {
12167 attempts = 0;
12168 if lsp_store
12169 .update(cx, |lsp_store, cx| {
12170 lsp_store.apply_workspace_diagnostic_report(
12171 server.server_id(),
12172 pulled_diagnostics,
12173 cx,
12174 )
12175 })
12176 .is_err()
12177 {
12178 return;
12179 }
12180 break 'request;
12181 }
12182 }
12183 }
12184 }
12185 });
12186
12187 Some(WorkspaceRefreshTask {
12188 refresh_tx,
12189 progress_tx,
12190 task: workspace_query_language_server,
12191 })
12192}
12193
12194fn resolve_word_completion(snapshot: &BufferSnapshot, completion: &mut Completion) {
12195 let CompletionSource::BufferWord {
12196 word_range,
12197 resolved,
12198 } = &mut completion.source
12199 else {
12200 return;
12201 };
12202 if *resolved {
12203 return;
12204 }
12205
12206 if completion.new_text
12207 != snapshot
12208 .text_for_range(word_range.clone())
12209 .collect::<String>()
12210 {
12211 return;
12212 }
12213
12214 let mut offset = 0;
12215 for chunk in snapshot.chunks(word_range.clone(), true) {
12216 let end_offset = offset + chunk.text.len();
12217 if let Some(highlight_id) = chunk.syntax_highlight_id {
12218 completion
12219 .label
12220 .runs
12221 .push((offset..end_offset, highlight_id));
12222 }
12223 offset = end_offset;
12224 }
12225 *resolved = true;
12226}
12227
12228impl EventEmitter<LspStoreEvent> for LspStore {}
12229
12230fn remove_empty_hover_blocks(mut hover: Hover) -> Option<Hover> {
12231 hover
12232 .contents
12233 .retain(|hover_block| !hover_block.text.trim().is_empty());
12234 if hover.contents.is_empty() {
12235 None
12236 } else {
12237 Some(hover)
12238 }
12239}
12240
12241async fn populate_labels_for_completions(
12242 new_completions: Vec<CoreCompletion>,
12243 language: Option<Arc<Language>>,
12244 lsp_adapter: Option<Arc<CachedLspAdapter>>,
12245) -> Vec<Completion> {
12246 let lsp_completions = new_completions
12247 .iter()
12248 .filter_map(|new_completion| {
12249 if let Some(lsp_completion) = new_completion.source.lsp_completion(true) {
12250 Some(lsp_completion.into_owned())
12251 } else {
12252 None
12253 }
12254 })
12255 .collect::<Vec<_>>();
12256
12257 let mut labels = if let Some((language, lsp_adapter)) = language.as_ref().zip(lsp_adapter) {
12258 lsp_adapter
12259 .labels_for_completions(&lsp_completions, language)
12260 .await
12261 .log_err()
12262 .unwrap_or_default()
12263 } else {
12264 Vec::new()
12265 }
12266 .into_iter()
12267 .fuse();
12268
12269 let mut completions = Vec::new();
12270 for completion in new_completions {
12271 match completion.source.lsp_completion(true) {
12272 Some(lsp_completion) => {
12273 let documentation = if let Some(docs) = lsp_completion.documentation.clone() {
12274 Some(docs.into())
12275 } else {
12276 None
12277 };
12278
12279 let mut label = labels.next().flatten().unwrap_or_else(|| {
12280 CodeLabel::fallback_for_completion(&lsp_completion, language.as_deref())
12281 });
12282 ensure_uniform_list_compatible_label(&mut label);
12283 completions.push(Completion {
12284 label,
12285 documentation,
12286 replace_range: completion.replace_range,
12287 new_text: completion.new_text,
12288 insert_text_mode: lsp_completion.insert_text_mode,
12289 source: completion.source,
12290 icon_path: None,
12291 confirm: None,
12292 });
12293 }
12294 None => {
12295 let mut label = CodeLabel::plain(completion.new_text.clone(), None);
12296 ensure_uniform_list_compatible_label(&mut label);
12297 completions.push(Completion {
12298 label,
12299 documentation: None,
12300 replace_range: completion.replace_range,
12301 new_text: completion.new_text,
12302 source: completion.source,
12303 insert_text_mode: None,
12304 icon_path: None,
12305 confirm: None,
12306 });
12307 }
12308 }
12309 }
12310 completions
12311}
12312
12313#[derive(Debug)]
12314pub enum LanguageServerToQuery {
12315 /// Query language servers in order of users preference, up until one capable of handling the request is found.
12316 FirstCapable,
12317 /// Query a specific language server.
12318 Other(LanguageServerId),
12319}
12320
12321#[derive(Default)]
12322struct RenamePathsWatchedForServer {
12323 did_rename: Vec<RenameActionPredicate>,
12324 will_rename: Vec<RenameActionPredicate>,
12325}
12326
12327impl RenamePathsWatchedForServer {
12328 fn with_did_rename_patterns(
12329 mut self,
12330 did_rename: Option<&FileOperationRegistrationOptions>,
12331 ) -> Self {
12332 if let Some(did_rename) = did_rename {
12333 self.did_rename = did_rename
12334 .filters
12335 .iter()
12336 .filter_map(|filter| filter.try_into().log_err())
12337 .collect();
12338 }
12339 self
12340 }
12341 fn with_will_rename_patterns(
12342 mut self,
12343 will_rename: Option<&FileOperationRegistrationOptions>,
12344 ) -> Self {
12345 if let Some(will_rename) = will_rename {
12346 self.will_rename = will_rename
12347 .filters
12348 .iter()
12349 .filter_map(|filter| filter.try_into().log_err())
12350 .collect();
12351 }
12352 self
12353 }
12354
12355 fn should_send_did_rename(&self, path: &str, is_dir: bool) -> bool {
12356 self.did_rename.iter().any(|pred| pred.eval(path, is_dir))
12357 }
12358 fn should_send_will_rename(&self, path: &str, is_dir: bool) -> bool {
12359 self.will_rename.iter().any(|pred| pred.eval(path, is_dir))
12360 }
12361}
12362
12363impl TryFrom<&FileOperationFilter> for RenameActionPredicate {
12364 type Error = globset::Error;
12365 fn try_from(ops: &FileOperationFilter) -> Result<Self, globset::Error> {
12366 Ok(Self {
12367 kind: ops.pattern.matches.clone(),
12368 glob: GlobBuilder::new(&ops.pattern.glob)
12369 .case_insensitive(
12370 ops.pattern
12371 .options
12372 .as_ref()
12373 .map_or(false, |ops| ops.ignore_case.unwrap_or(false)),
12374 )
12375 .build()?
12376 .compile_matcher(),
12377 })
12378 }
12379}
12380struct RenameActionPredicate {
12381 glob: GlobMatcher,
12382 kind: Option<FileOperationPatternKind>,
12383}
12384
12385impl RenameActionPredicate {
12386 // Returns true if language server should be notified
12387 fn eval(&self, path: &str, is_dir: bool) -> bool {
12388 self.kind.as_ref().map_or(true, |kind| {
12389 let expected_kind = if is_dir {
12390 FileOperationPatternKind::Folder
12391 } else {
12392 FileOperationPatternKind::File
12393 };
12394 kind == &expected_kind
12395 }) && self.glob.is_match(path)
12396 }
12397}
12398
12399#[derive(Default)]
12400struct LanguageServerWatchedPaths {
12401 worktree_paths: HashMap<WorktreeId, GlobSet>,
12402 abs_paths: HashMap<Arc<Path>, (GlobSet, Task<()>)>,
12403}
12404
12405#[derive(Default)]
12406struct LanguageServerWatchedPathsBuilder {
12407 worktree_paths: HashMap<WorktreeId, GlobSet>,
12408 abs_paths: HashMap<Arc<Path>, GlobSet>,
12409}
12410
12411impl LanguageServerWatchedPathsBuilder {
12412 fn watch_worktree(&mut self, worktree_id: WorktreeId, glob_set: GlobSet) {
12413 self.worktree_paths.insert(worktree_id, glob_set);
12414 }
12415 fn watch_abs_path(&mut self, path: Arc<Path>, glob_set: GlobSet) {
12416 self.abs_paths.insert(path, glob_set);
12417 }
12418 fn build(
12419 self,
12420 fs: Arc<dyn Fs>,
12421 language_server_id: LanguageServerId,
12422 cx: &mut Context<LspStore>,
12423 ) -> LanguageServerWatchedPaths {
12424 let project = cx.weak_entity();
12425
12426 const LSP_ABS_PATH_OBSERVE: Duration = Duration::from_millis(100);
12427 let abs_paths = self
12428 .abs_paths
12429 .into_iter()
12430 .map(|(abs_path, globset)| {
12431 let task = cx.spawn({
12432 let abs_path = abs_path.clone();
12433 let fs = fs.clone();
12434
12435 let lsp_store = project.clone();
12436 async move |_, cx| {
12437 maybe!(async move {
12438 let mut push_updates = fs.watch(&abs_path, LSP_ABS_PATH_OBSERVE).await;
12439 while let Some(update) = push_updates.0.next().await {
12440 let action = lsp_store
12441 .update(cx, |this, _| {
12442 let Some(local) = this.as_local() else {
12443 return ControlFlow::Break(());
12444 };
12445 let Some(watcher) = local
12446 .language_server_watched_paths
12447 .get(&language_server_id)
12448 else {
12449 return ControlFlow::Break(());
12450 };
12451 let (globs, _) = watcher.abs_paths.get(&abs_path).expect(
12452 "Watched abs path is not registered with a watcher",
12453 );
12454 let matching_entries = update
12455 .into_iter()
12456 .filter(|event| globs.is_match(&event.path))
12457 .collect::<Vec<_>>();
12458 this.lsp_notify_abs_paths_changed(
12459 language_server_id,
12460 matching_entries,
12461 );
12462 ControlFlow::Continue(())
12463 })
12464 .ok()?;
12465
12466 if action.is_break() {
12467 break;
12468 }
12469 }
12470 Some(())
12471 })
12472 .await;
12473 }
12474 });
12475 (abs_path, (globset, task))
12476 })
12477 .collect();
12478 LanguageServerWatchedPaths {
12479 worktree_paths: self.worktree_paths,
12480 abs_paths,
12481 }
12482 }
12483}
12484
12485struct LspBufferSnapshot {
12486 version: i32,
12487 snapshot: TextBufferSnapshot,
12488}
12489
12490/// A prompt requested by LSP server.
12491#[derive(Clone, Debug)]
12492pub struct LanguageServerPromptRequest {
12493 pub level: PromptLevel,
12494 pub message: String,
12495 pub actions: Vec<MessageActionItem>,
12496 pub lsp_name: String,
12497 pub(crate) response_channel: Sender<MessageActionItem>,
12498}
12499
12500impl LanguageServerPromptRequest {
12501 pub async fn respond(self, index: usize) -> Option<()> {
12502 if let Some(response) = self.actions.into_iter().nth(index) {
12503 self.response_channel.send(response).await.ok()
12504 } else {
12505 None
12506 }
12507 }
12508}
12509impl PartialEq for LanguageServerPromptRequest {
12510 fn eq(&self, other: &Self) -> bool {
12511 self.message == other.message && self.actions == other.actions
12512 }
12513}
12514
12515#[derive(Clone, Debug, PartialEq)]
12516pub enum LanguageServerLogType {
12517 Log(MessageType),
12518 Trace(Option<String>),
12519}
12520
12521impl LanguageServerLogType {
12522 pub fn to_proto(&self) -> proto::language_server_log::LogType {
12523 match self {
12524 Self::Log(log_type) => {
12525 let message_type = match *log_type {
12526 MessageType::ERROR => 1,
12527 MessageType::WARNING => 2,
12528 MessageType::INFO => 3,
12529 MessageType::LOG => 4,
12530 other => {
12531 log::warn!("Unknown lsp log message type: {:?}", other);
12532 4
12533 }
12534 };
12535 proto::language_server_log::LogType::LogMessageType(message_type)
12536 }
12537 Self::Trace(message) => {
12538 proto::language_server_log::LogType::LogTrace(proto::LspLogTrace {
12539 message: message.clone(),
12540 })
12541 }
12542 }
12543 }
12544
12545 pub fn from_proto(log_type: proto::language_server_log::LogType) -> Self {
12546 match log_type {
12547 proto::language_server_log::LogType::LogMessageType(message_type) => {
12548 Self::Log(match message_type {
12549 1 => MessageType::ERROR,
12550 2 => MessageType::WARNING,
12551 3 => MessageType::INFO,
12552 4 => MessageType::LOG,
12553 _ => MessageType::LOG,
12554 })
12555 }
12556 proto::language_server_log::LogType::LogTrace(trace) => Self::Trace(trace.message),
12557 }
12558 }
12559}
12560
12561pub struct WorkspaceRefreshTask {
12562 refresh_tx: mpsc::Sender<()>,
12563 progress_tx: mpsc::Sender<()>,
12564 #[allow(dead_code)]
12565 task: Task<()>,
12566}
12567
12568pub enum LanguageServerState {
12569 Starting {
12570 startup: Task<Option<Arc<LanguageServer>>>,
12571 /// List of language servers that will be added to the workspace once it's initialization completes.
12572 pending_workspace_folders: Arc<Mutex<BTreeSet<Url>>>,
12573 },
12574
12575 Running {
12576 adapter: Arc<CachedLspAdapter>,
12577 server: Arc<LanguageServer>,
12578 simulate_disk_based_diagnostics_completion: Option<Task<()>>,
12579 workspace_refresh_task: Option<WorkspaceRefreshTask>,
12580 },
12581}
12582
12583impl LanguageServerState {
12584 fn add_workspace_folder(&self, uri: Url) {
12585 match self {
12586 LanguageServerState::Starting {
12587 pending_workspace_folders,
12588 ..
12589 } => {
12590 pending_workspace_folders.lock().insert(uri);
12591 }
12592 LanguageServerState::Running { server, .. } => {
12593 server.add_workspace_folder(uri);
12594 }
12595 }
12596 }
12597 fn _remove_workspace_folder(&self, uri: Url) {
12598 match self {
12599 LanguageServerState::Starting {
12600 pending_workspace_folders,
12601 ..
12602 } => {
12603 pending_workspace_folders.lock().remove(&uri);
12604 }
12605 LanguageServerState::Running { server, .. } => server.remove_workspace_folder(uri),
12606 }
12607 }
12608}
12609
12610impl std::fmt::Debug for LanguageServerState {
12611 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
12612 match self {
12613 LanguageServerState::Starting { .. } => {
12614 f.debug_struct("LanguageServerState::Starting").finish()
12615 }
12616 LanguageServerState::Running { .. } => {
12617 f.debug_struct("LanguageServerState::Running").finish()
12618 }
12619 }
12620 }
12621}
12622
12623#[derive(Clone, Debug, Serialize)]
12624pub struct LanguageServerProgress {
12625 pub is_disk_based_diagnostics_progress: bool,
12626 pub is_cancellable: bool,
12627 pub title: Option<String>,
12628 pub message: Option<String>,
12629 pub percentage: Option<usize>,
12630 #[serde(skip_serializing)]
12631 pub last_update_at: Instant,
12632}
12633
12634#[derive(Copy, Clone, Debug, Default, PartialEq, Serialize)]
12635pub struct DiagnosticSummary {
12636 pub error_count: usize,
12637 pub warning_count: usize,
12638}
12639
12640impl DiagnosticSummary {
12641 pub fn new<'a, T: 'a>(diagnostics: impl IntoIterator<Item = &'a DiagnosticEntry<T>>) -> Self {
12642 let mut this = Self {
12643 error_count: 0,
12644 warning_count: 0,
12645 };
12646
12647 for entry in diagnostics {
12648 if entry.diagnostic.is_primary {
12649 match entry.diagnostic.severity {
12650 DiagnosticSeverity::ERROR => this.error_count += 1,
12651 DiagnosticSeverity::WARNING => this.warning_count += 1,
12652 _ => {}
12653 }
12654 }
12655 }
12656
12657 this
12658 }
12659
12660 pub fn is_empty(&self) -> bool {
12661 self.error_count == 0 && self.warning_count == 0
12662 }
12663
12664 pub fn to_proto(
12665 &self,
12666 language_server_id: LanguageServerId,
12667 path: &Path,
12668 ) -> proto::DiagnosticSummary {
12669 proto::DiagnosticSummary {
12670 path: path.to_proto(),
12671 language_server_id: language_server_id.0 as u64,
12672 error_count: self.error_count as u32,
12673 warning_count: self.warning_count as u32,
12674 }
12675 }
12676}
12677
12678#[derive(Clone, Debug)]
12679pub enum CompletionDocumentation {
12680 /// There is no documentation for this completion.
12681 Undocumented,
12682 /// A single line of documentation.
12683 SingleLine(SharedString),
12684 /// Multiple lines of plain text documentation.
12685 MultiLinePlainText(SharedString),
12686 /// Markdown documentation.
12687 MultiLineMarkdown(SharedString),
12688 /// Both single line and multiple lines of plain text documentation.
12689 SingleLineAndMultiLinePlainText {
12690 single_line: SharedString,
12691 plain_text: Option<SharedString>,
12692 },
12693}
12694
12695impl From<lsp::Documentation> for CompletionDocumentation {
12696 fn from(docs: lsp::Documentation) -> Self {
12697 match docs {
12698 lsp::Documentation::String(text) => {
12699 if text.lines().count() <= 1 {
12700 CompletionDocumentation::SingleLine(text.into())
12701 } else {
12702 CompletionDocumentation::MultiLinePlainText(text.into())
12703 }
12704 }
12705
12706 lsp::Documentation::MarkupContent(lsp::MarkupContent { kind, value }) => match kind {
12707 lsp::MarkupKind::PlainText => {
12708 if value.lines().count() <= 1 {
12709 CompletionDocumentation::SingleLine(value.into())
12710 } else {
12711 CompletionDocumentation::MultiLinePlainText(value.into())
12712 }
12713 }
12714
12715 lsp::MarkupKind::Markdown => {
12716 CompletionDocumentation::MultiLineMarkdown(value.into())
12717 }
12718 },
12719 }
12720 }
12721}
12722
12723fn glob_literal_prefix(glob: &Path) -> PathBuf {
12724 glob.components()
12725 .take_while(|component| match component {
12726 path::Component::Normal(part) => !part.to_string_lossy().contains(['*', '?', '{', '}']),
12727 _ => true,
12728 })
12729 .collect()
12730}
12731
12732pub struct SshLspAdapter {
12733 name: LanguageServerName,
12734 binary: LanguageServerBinary,
12735 initialization_options: Option<String>,
12736 code_action_kinds: Option<Vec<CodeActionKind>>,
12737}
12738
12739impl SshLspAdapter {
12740 pub fn new(
12741 name: LanguageServerName,
12742 binary: LanguageServerBinary,
12743 initialization_options: Option<String>,
12744 code_action_kinds: Option<String>,
12745 ) -> Self {
12746 Self {
12747 name,
12748 binary,
12749 initialization_options,
12750 code_action_kinds: code_action_kinds
12751 .as_ref()
12752 .and_then(|c| serde_json::from_str(c).ok()),
12753 }
12754 }
12755}
12756
12757#[async_trait(?Send)]
12758impl LspAdapter for SshLspAdapter {
12759 fn name(&self) -> LanguageServerName {
12760 self.name.clone()
12761 }
12762
12763 async fn initialization_options(
12764 self: Arc<Self>,
12765 _: &dyn Fs,
12766 _: &Arc<dyn LspAdapterDelegate>,
12767 ) -> Result<Option<serde_json::Value>> {
12768 let Some(options) = &self.initialization_options else {
12769 return Ok(None);
12770 };
12771 let result = serde_json::from_str(options)?;
12772 Ok(result)
12773 }
12774
12775 fn code_action_kinds(&self) -> Option<Vec<CodeActionKind>> {
12776 self.code_action_kinds.clone()
12777 }
12778
12779 async fn check_if_user_installed(
12780 &self,
12781 _: &dyn LspAdapterDelegate,
12782 _: Arc<dyn LanguageToolchainStore>,
12783 _: &AsyncApp,
12784 ) -> Option<LanguageServerBinary> {
12785 Some(self.binary.clone())
12786 }
12787
12788 async fn cached_server_binary(
12789 &self,
12790 _: PathBuf,
12791 _: &dyn LspAdapterDelegate,
12792 ) -> Option<LanguageServerBinary> {
12793 None
12794 }
12795
12796 async fn fetch_latest_server_version(
12797 &self,
12798 _: &dyn LspAdapterDelegate,
12799 ) -> Result<Box<dyn 'static + Send + Any>> {
12800 anyhow::bail!("SshLspAdapter does not support fetch_latest_server_version")
12801 }
12802
12803 async fn fetch_server_binary(
12804 &self,
12805 _: Box<dyn 'static + Send + Any>,
12806 _: PathBuf,
12807 _: &dyn LspAdapterDelegate,
12808 ) -> Result<LanguageServerBinary> {
12809 anyhow::bail!("SshLspAdapter does not support fetch_server_binary")
12810 }
12811}
12812
12813pub fn language_server_settings<'a>(
12814 delegate: &'a dyn LspAdapterDelegate,
12815 language: &LanguageServerName,
12816 cx: &'a App,
12817) -> Option<&'a LspSettings> {
12818 language_server_settings_for(
12819 SettingsLocation {
12820 worktree_id: delegate.worktree_id(),
12821 path: delegate.worktree_root_path(),
12822 },
12823 language,
12824 cx,
12825 )
12826}
12827
12828pub(crate) fn language_server_settings_for<'a>(
12829 location: SettingsLocation<'a>,
12830 language: &LanguageServerName,
12831 cx: &'a App,
12832) -> Option<&'a LspSettings> {
12833 ProjectSettings::get(Some(location), cx).lsp.get(language)
12834}
12835
12836pub struct LocalLspAdapterDelegate {
12837 lsp_store: WeakEntity<LspStore>,
12838 worktree: worktree::Snapshot,
12839 fs: Arc<dyn Fs>,
12840 http_client: Arc<dyn HttpClient>,
12841 language_registry: Arc<LanguageRegistry>,
12842 load_shell_env_task: Shared<Task<Option<HashMap<String, String>>>>,
12843}
12844
12845impl LocalLspAdapterDelegate {
12846 pub fn new(
12847 language_registry: Arc<LanguageRegistry>,
12848 environment: &Entity<ProjectEnvironment>,
12849 lsp_store: WeakEntity<LspStore>,
12850 worktree: &Entity<Worktree>,
12851 http_client: Arc<dyn HttpClient>,
12852 fs: Arc<dyn Fs>,
12853 cx: &mut App,
12854 ) -> Arc<Self> {
12855 let load_shell_env_task = environment.update(cx, |env, cx| {
12856 env.get_worktree_environment(worktree.clone(), cx)
12857 });
12858
12859 Arc::new(Self {
12860 lsp_store,
12861 worktree: worktree.read(cx).snapshot(),
12862 fs,
12863 http_client,
12864 language_registry,
12865 load_shell_env_task,
12866 })
12867 }
12868
12869 fn from_local_lsp(
12870 local: &LocalLspStore,
12871 worktree: &Entity<Worktree>,
12872 cx: &mut App,
12873 ) -> Arc<Self> {
12874 Self::new(
12875 local.languages.clone(),
12876 &local.environment,
12877 local.weak.clone(),
12878 worktree,
12879 local.http_client.clone(),
12880 local.fs.clone(),
12881 cx,
12882 )
12883 }
12884}
12885
12886#[async_trait]
12887impl LspAdapterDelegate for LocalLspAdapterDelegate {
12888 fn show_notification(&self, message: &str, cx: &mut App) {
12889 self.lsp_store
12890 .update(cx, |_, cx| {
12891 cx.emit(LspStoreEvent::Notification(message.to_owned()))
12892 })
12893 .ok();
12894 }
12895
12896 fn http_client(&self) -> Arc<dyn HttpClient> {
12897 self.http_client.clone()
12898 }
12899
12900 fn worktree_id(&self) -> WorktreeId {
12901 self.worktree.id()
12902 }
12903
12904 fn worktree_root_path(&self) -> &Path {
12905 self.worktree.abs_path().as_ref()
12906 }
12907
12908 async fn shell_env(&self) -> HashMap<String, String> {
12909 let task = self.load_shell_env_task.clone();
12910 task.await.unwrap_or_default()
12911 }
12912
12913 async fn npm_package_installed_version(
12914 &self,
12915 package_name: &str,
12916 ) -> Result<Option<(PathBuf, String)>> {
12917 let local_package_directory = self.worktree_root_path();
12918 let node_modules_directory = local_package_directory.join("node_modules");
12919
12920 if let Some(version) =
12921 read_package_installed_version(node_modules_directory.clone(), package_name).await?
12922 {
12923 return Ok(Some((node_modules_directory, version)));
12924 }
12925 let Some(npm) = self.which("npm".as_ref()).await else {
12926 log::warn!(
12927 "Failed to find npm executable for {:?}",
12928 local_package_directory
12929 );
12930 return Ok(None);
12931 };
12932
12933 let env = self.shell_env().await;
12934 let output = util::command::new_smol_command(&npm)
12935 .args(["root", "-g"])
12936 .envs(env)
12937 .current_dir(local_package_directory)
12938 .output()
12939 .await?;
12940 let global_node_modules =
12941 PathBuf::from(String::from_utf8_lossy(&output.stdout).to_string());
12942
12943 if let Some(version) =
12944 read_package_installed_version(global_node_modules.clone(), package_name).await?
12945 {
12946 return Ok(Some((global_node_modules, version)));
12947 }
12948 return Ok(None);
12949 }
12950
12951 #[cfg(not(target_os = "windows"))]
12952 async fn which(&self, command: &OsStr) -> Option<PathBuf> {
12953 let worktree_abs_path = self.worktree.abs_path();
12954 let shell_path = self.shell_env().await.get("PATH").cloned();
12955 which::which_in(command, shell_path.as_ref(), worktree_abs_path).ok()
12956 }
12957
12958 #[cfg(target_os = "windows")]
12959 async fn which(&self, command: &OsStr) -> Option<PathBuf> {
12960 // todo(windows) Getting the shell env variables in a current directory on Windows is more complicated than other platforms
12961 // there isn't a 'default shell' necessarily. The closest would be the default profile on the windows terminal
12962 // SEE: https://learn.microsoft.com/en-us/windows/terminal/customize-settings/startup
12963 which::which(command).ok()
12964 }
12965
12966 async fn try_exec(&self, command: LanguageServerBinary) -> Result<()> {
12967 let working_dir = self.worktree_root_path();
12968 let output = util::command::new_smol_command(&command.path)
12969 .args(command.arguments)
12970 .envs(command.env.clone().unwrap_or_default())
12971 .current_dir(working_dir)
12972 .output()
12973 .await?;
12974
12975 anyhow::ensure!(
12976 output.status.success(),
12977 "{}, stdout: {:?}, stderr: {:?}",
12978 output.status,
12979 String::from_utf8_lossy(&output.stdout),
12980 String::from_utf8_lossy(&output.stderr)
12981 );
12982 Ok(())
12983 }
12984
12985 fn update_status(&self, server_name: LanguageServerName, status: language::BinaryStatus) {
12986 self.language_registry
12987 .update_lsp_binary_status(server_name, status);
12988 }
12989
12990 fn registered_lsp_adapters(&self) -> Vec<Arc<dyn LspAdapter>> {
12991 self.language_registry
12992 .all_lsp_adapters()
12993 .into_iter()
12994 .map(|adapter| adapter.adapter.clone() as Arc<dyn LspAdapter>)
12995 .collect()
12996 }
12997
12998 async fn language_server_download_dir(&self, name: &LanguageServerName) -> Option<Arc<Path>> {
12999 let dir = self.language_registry.language_server_download_dir(name)?;
13000
13001 if !dir.exists() {
13002 smol::fs::create_dir_all(&dir)
13003 .await
13004 .context("failed to create container directory")
13005 .log_err()?;
13006 }
13007
13008 Some(dir)
13009 }
13010
13011 async fn read_text_file(&self, path: PathBuf) -> Result<String> {
13012 let entry = self
13013 .worktree
13014 .entry_for_path(&path)
13015 .with_context(|| format!("no worktree entry for path {path:?}"))?;
13016 let abs_path = self
13017 .worktree
13018 .absolutize(&entry.path)
13019 .with_context(|| format!("cannot absolutize path {path:?}"))?;
13020
13021 self.fs.load(&abs_path).await
13022 }
13023}
13024
13025async fn populate_labels_for_symbols(
13026 symbols: Vec<CoreSymbol>,
13027 language_registry: &Arc<LanguageRegistry>,
13028 lsp_adapter: Option<Arc<CachedLspAdapter>>,
13029 output: &mut Vec<Symbol>,
13030) {
13031 #[allow(clippy::mutable_key_type)]
13032 let mut symbols_by_language = HashMap::<Option<Arc<Language>>, Vec<CoreSymbol>>::default();
13033
13034 let mut unknown_paths = BTreeSet::new();
13035 for symbol in symbols {
13036 let language = language_registry
13037 .language_for_file_path(&symbol.path.path)
13038 .await
13039 .ok()
13040 .or_else(|| {
13041 unknown_paths.insert(symbol.path.path.clone());
13042 None
13043 });
13044 symbols_by_language
13045 .entry(language)
13046 .or_default()
13047 .push(symbol);
13048 }
13049
13050 for unknown_path in unknown_paths {
13051 log::info!(
13052 "no language found for symbol path {}",
13053 unknown_path.display()
13054 );
13055 }
13056
13057 let mut label_params = Vec::new();
13058 for (language, mut symbols) in symbols_by_language {
13059 label_params.clear();
13060 label_params.extend(
13061 symbols
13062 .iter_mut()
13063 .map(|symbol| (mem::take(&mut symbol.name), symbol.kind)),
13064 );
13065
13066 let mut labels = Vec::new();
13067 if let Some(language) = language {
13068 let lsp_adapter = lsp_adapter.clone().or_else(|| {
13069 language_registry
13070 .lsp_adapters(&language.name())
13071 .first()
13072 .cloned()
13073 });
13074 if let Some(lsp_adapter) = lsp_adapter {
13075 labels = lsp_adapter
13076 .labels_for_symbols(&label_params, &language)
13077 .await
13078 .log_err()
13079 .unwrap_or_default();
13080 }
13081 }
13082
13083 for ((symbol, (name, _)), label) in symbols
13084 .into_iter()
13085 .zip(label_params.drain(..))
13086 .zip(labels.into_iter().chain(iter::repeat(None)))
13087 {
13088 output.push(Symbol {
13089 language_server_name: symbol.language_server_name,
13090 source_worktree_id: symbol.source_worktree_id,
13091 source_language_server_id: symbol.source_language_server_id,
13092 path: symbol.path,
13093 label: label.unwrap_or_else(|| CodeLabel::plain(name.clone(), None)),
13094 name,
13095 kind: symbol.kind,
13096 range: symbol.range,
13097 signature: symbol.signature,
13098 });
13099 }
13100 }
13101}
13102
13103fn include_text(server: &lsp::LanguageServer) -> Option<bool> {
13104 match server.capabilities().text_document_sync.as_ref()? {
13105 lsp::TextDocumentSyncCapability::Kind(kind) => match *kind {
13106 lsp::TextDocumentSyncKind::NONE => None,
13107 lsp::TextDocumentSyncKind::FULL => Some(true),
13108 lsp::TextDocumentSyncKind::INCREMENTAL => Some(false),
13109 _ => None,
13110 },
13111 lsp::TextDocumentSyncCapability::Options(options) => match options.save.as_ref()? {
13112 lsp::TextDocumentSyncSaveOptions::Supported(supported) => {
13113 if *supported {
13114 Some(true)
13115 } else {
13116 None
13117 }
13118 }
13119 lsp::TextDocumentSyncSaveOptions::SaveOptions(save_options) => {
13120 Some(save_options.include_text.unwrap_or(false))
13121 }
13122 },
13123 }
13124}
13125
13126/// Completion items are displayed in a `UniformList`.
13127/// Usually, those items are single-line strings, but in LSP responses,
13128/// completion items `label`, `detail` and `label_details.description` may contain newlines or long spaces.
13129/// Many language plugins construct these items by joining these parts together, and we may use `CodeLabel::fallback_for_completion` that uses `label` at least.
13130/// All that may lead to a newline being inserted into resulting `CodeLabel.text`, which will force `UniformList` to bloat each entry to occupy more space,
13131/// breaking the completions menu presentation.
13132///
13133/// Sanitize the text to ensure there are no newlines, or, if there are some, remove them and also remove long space sequences if there were newlines.
13134fn ensure_uniform_list_compatible_label(label: &mut CodeLabel) {
13135 let mut new_text = String::with_capacity(label.text.len());
13136 let mut offset_map = vec![0; label.text.len() + 1];
13137 let mut last_char_was_space = false;
13138 let mut new_idx = 0;
13139 let mut chars = label.text.char_indices().fuse();
13140 let mut newlines_removed = false;
13141
13142 while let Some((idx, c)) = chars.next() {
13143 offset_map[idx] = new_idx;
13144
13145 match c {
13146 '\n' if last_char_was_space => {
13147 newlines_removed = true;
13148 }
13149 '\t' | ' ' if last_char_was_space => {}
13150 '\n' if !last_char_was_space => {
13151 new_text.push(' ');
13152 new_idx += 1;
13153 last_char_was_space = true;
13154 newlines_removed = true;
13155 }
13156 ' ' | '\t' => {
13157 new_text.push(' ');
13158 new_idx += 1;
13159 last_char_was_space = true;
13160 }
13161 _ => {
13162 new_text.push(c);
13163 new_idx += c.len_utf8();
13164 last_char_was_space = false;
13165 }
13166 }
13167 }
13168 offset_map[label.text.len()] = new_idx;
13169
13170 // Only modify the label if newlines were removed.
13171 if !newlines_removed {
13172 return;
13173 }
13174
13175 let last_index = new_idx;
13176 let mut run_ranges_errors = Vec::new();
13177 label.runs.retain_mut(|(range, _)| {
13178 match offset_map.get(range.start) {
13179 Some(&start) => range.start = start,
13180 None => {
13181 run_ranges_errors.push(range.clone());
13182 return false;
13183 }
13184 }
13185
13186 match offset_map.get(range.end) {
13187 Some(&end) => range.end = end,
13188 None => {
13189 run_ranges_errors.push(range.clone());
13190 range.end = last_index;
13191 }
13192 }
13193 true
13194 });
13195 if !run_ranges_errors.is_empty() {
13196 log::error!(
13197 "Completion label has errors in its run ranges: {run_ranges_errors:?}, label text: {}",
13198 label.text
13199 );
13200 }
13201
13202 let mut wrong_filter_range = None;
13203 if label.filter_range == (0..label.text.len()) {
13204 label.filter_range = 0..new_text.len();
13205 } else {
13206 let mut original_filter_range = Some(label.filter_range.clone());
13207 match offset_map.get(label.filter_range.start) {
13208 Some(&start) => label.filter_range.start = start,
13209 None => {
13210 wrong_filter_range = original_filter_range.take();
13211 label.filter_range.start = last_index;
13212 }
13213 }
13214
13215 match offset_map.get(label.filter_range.end) {
13216 Some(&end) => label.filter_range.end = end,
13217 None => {
13218 wrong_filter_range = original_filter_range.take();
13219 label.filter_range.end = last_index;
13220 }
13221 }
13222 }
13223 if let Some(wrong_filter_range) = wrong_filter_range {
13224 log::error!(
13225 "Completion label has an invalid filter range: {wrong_filter_range:?}, label text: {}",
13226 label.text
13227 );
13228 }
13229
13230 label.text = new_text;
13231}
13232
13233#[cfg(test)]
13234mod tests {
13235 use language::HighlightId;
13236
13237 use super::*;
13238
13239 #[test]
13240 fn test_glob_literal_prefix() {
13241 assert_eq!(glob_literal_prefix(Path::new("**/*.js")), Path::new(""));
13242 assert_eq!(
13243 glob_literal_prefix(Path::new("node_modules/**/*.js")),
13244 Path::new("node_modules")
13245 );
13246 assert_eq!(
13247 glob_literal_prefix(Path::new("foo/{bar,baz}.js")),
13248 Path::new("foo")
13249 );
13250 assert_eq!(
13251 glob_literal_prefix(Path::new("foo/bar/baz.js")),
13252 Path::new("foo/bar/baz.js")
13253 );
13254
13255 #[cfg(target_os = "windows")]
13256 {
13257 assert_eq!(glob_literal_prefix(Path::new("**\\*.js")), Path::new(""));
13258 assert_eq!(
13259 glob_literal_prefix(Path::new("node_modules\\**/*.js")),
13260 Path::new("node_modules")
13261 );
13262 assert_eq!(
13263 glob_literal_prefix(Path::new("foo/{bar,baz}.js")),
13264 Path::new("foo")
13265 );
13266 assert_eq!(
13267 glob_literal_prefix(Path::new("foo\\bar\\baz.js")),
13268 Path::new("foo/bar/baz.js")
13269 );
13270 }
13271 }
13272
13273 #[test]
13274 fn test_multi_len_chars_normalization() {
13275 let mut label = CodeLabel {
13276 text: "myElˇ (parameter) myElˇ: {\n foo: string;\n}".to_string(),
13277 runs: vec![(0..6, HighlightId(1))],
13278 filter_range: 0..6,
13279 };
13280 ensure_uniform_list_compatible_label(&mut label);
13281 assert_eq!(
13282 label,
13283 CodeLabel {
13284 text: "myElˇ (parameter) myElˇ: { foo: string; }".to_string(),
13285 runs: vec![(0..6, HighlightId(1))],
13286 filter_range: 0..6,
13287 }
13288 );
13289 }
13290}