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