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