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