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
5125 cx.spawn(async move |this, cx| {
5126 if let Some(waiter) =
5127 buffer.update(cx, |buffer, _| buffer.wait_for_autoindent_applied())?
5128 {
5129 waiter.await?;
5130 }
5131 cx.update(|cx| {
5132 this.update(cx, |this, cx| {
5133 this.request_lsp(
5134 buffer.clone(),
5135 LanguageServerToQuery::FirstCapable,
5136 OnTypeFormatting {
5137 position,
5138 trigger,
5139 options,
5140 push_to_history,
5141 },
5142 cx,
5143 )
5144 })
5145 })??
5146 .await
5147 })
5148 }
5149
5150 pub fn code_actions(
5151 &mut self,
5152 buffer_handle: &Entity<Buffer>,
5153 range: Range<Anchor>,
5154 kinds: Option<Vec<CodeActionKind>>,
5155 cx: &mut Context<Self>,
5156 ) -> Task<Result<Vec<CodeAction>>> {
5157 if let Some((upstream_client, project_id)) = self.upstream_client() {
5158 let request_task = upstream_client.request(proto::MultiLspQuery {
5159 buffer_id: buffer_handle.read(cx).remote_id().into(),
5160 version: serialize_version(&buffer_handle.read(cx).version()),
5161 project_id,
5162 strategy: Some(proto::multi_lsp_query::Strategy::All(
5163 proto::AllLanguageServers {},
5164 )),
5165 request: Some(proto::multi_lsp_query::Request::GetCodeActions(
5166 GetCodeActions {
5167 range: range.clone(),
5168 kinds: kinds.clone(),
5169 }
5170 .to_proto(project_id, buffer_handle.read(cx)),
5171 )),
5172 });
5173 let buffer = buffer_handle.clone();
5174 cx.spawn(async move |weak_project, cx| {
5175 let Some(project) = weak_project.upgrade() else {
5176 return Ok(Vec::new());
5177 };
5178 let responses = request_task.await?.responses;
5179 let actions = join_all(
5180 responses
5181 .into_iter()
5182 .filter_map(|lsp_response| match lsp_response.response? {
5183 proto::lsp_response::Response::GetCodeActionsResponse(response) => {
5184 Some(response)
5185 }
5186 unexpected => {
5187 debug_panic!("Unexpected response: {unexpected:?}");
5188 None
5189 }
5190 })
5191 .map(|code_actions_response| {
5192 GetCodeActions {
5193 range: range.clone(),
5194 kinds: kinds.clone(),
5195 }
5196 .response_from_proto(
5197 code_actions_response,
5198 project.clone(),
5199 buffer.clone(),
5200 cx.clone(),
5201 )
5202 }),
5203 )
5204 .await;
5205
5206 Ok(actions
5207 .into_iter()
5208 .collect::<Result<Vec<Vec<_>>>>()?
5209 .into_iter()
5210 .flatten()
5211 .collect())
5212 })
5213 } else {
5214 let all_actions_task = self.request_multiple_lsp_locally(
5215 buffer_handle,
5216 Some(range.start),
5217 GetCodeActions {
5218 range: range.clone(),
5219 kinds: kinds.clone(),
5220 },
5221 cx,
5222 );
5223 cx.spawn(async move |_, _| {
5224 Ok(all_actions_task
5225 .await
5226 .into_iter()
5227 .flat_map(|(_, actions)| actions)
5228 .collect())
5229 })
5230 }
5231 }
5232
5233 pub fn code_lens(
5234 &mut self,
5235 buffer_handle: &Entity<Buffer>,
5236 cx: &mut Context<Self>,
5237 ) -> Task<Result<Vec<CodeAction>>> {
5238 if let Some((upstream_client, project_id)) = self.upstream_client() {
5239 let request_task = upstream_client.request(proto::MultiLspQuery {
5240 buffer_id: buffer_handle.read(cx).remote_id().into(),
5241 version: serialize_version(&buffer_handle.read(cx).version()),
5242 project_id,
5243 strategy: Some(proto::multi_lsp_query::Strategy::All(
5244 proto::AllLanguageServers {},
5245 )),
5246 request: Some(proto::multi_lsp_query::Request::GetCodeLens(
5247 GetCodeLens.to_proto(project_id, buffer_handle.read(cx)),
5248 )),
5249 });
5250 let buffer = buffer_handle.clone();
5251 cx.spawn(async move |weak_project, cx| {
5252 let Some(project) = weak_project.upgrade() else {
5253 return Ok(Vec::new());
5254 };
5255 let responses = request_task.await?.responses;
5256 let code_lens = join_all(
5257 responses
5258 .into_iter()
5259 .filter_map(|lsp_response| match lsp_response.response? {
5260 proto::lsp_response::Response::GetCodeLensResponse(response) => {
5261 Some(response)
5262 }
5263 unexpected => {
5264 debug_panic!("Unexpected response: {unexpected:?}");
5265 None
5266 }
5267 })
5268 .map(|code_lens_response| {
5269 GetCodeLens.response_from_proto(
5270 code_lens_response,
5271 project.clone(),
5272 buffer.clone(),
5273 cx.clone(),
5274 )
5275 }),
5276 )
5277 .await;
5278
5279 Ok(code_lens
5280 .into_iter()
5281 .collect::<Result<Vec<Vec<_>>>>()?
5282 .into_iter()
5283 .flatten()
5284 .collect())
5285 })
5286 } else {
5287 let code_lens_task =
5288 self.request_multiple_lsp_locally(buffer_handle, None::<usize>, GetCodeLens, cx);
5289 cx.spawn(async move |_, _| {
5290 Ok(code_lens_task
5291 .await
5292 .into_iter()
5293 .flat_map(|(_, code_lens)| code_lens)
5294 .collect())
5295 })
5296 }
5297 }
5298
5299 #[inline(never)]
5300 pub fn completions(
5301 &self,
5302 buffer: &Entity<Buffer>,
5303 position: PointUtf16,
5304 context: CompletionContext,
5305 cx: &mut Context<Self>,
5306 ) -> Task<Result<Vec<CompletionResponse>>> {
5307 let language_registry = self.languages.clone();
5308
5309 if let Some((upstream_client, project_id)) = self.upstream_client() {
5310 let task = self.send_lsp_proto_request(
5311 buffer.clone(),
5312 upstream_client,
5313 project_id,
5314 GetCompletions { position, context },
5315 cx,
5316 );
5317 let language = buffer.read(cx).language().cloned();
5318
5319 // In the future, we should provide project guests with the names of LSP adapters,
5320 // so that they can use the correct LSP adapter when computing labels. For now,
5321 // guests just use the first LSP adapter associated with the buffer's language.
5322 let lsp_adapter = language.as_ref().and_then(|language| {
5323 language_registry
5324 .lsp_adapters(&language.name())
5325 .first()
5326 .cloned()
5327 });
5328
5329 cx.foreground_executor().spawn(async move {
5330 let completion_response = task.await?;
5331 let completions = populate_labels_for_completions(
5332 completion_response.completions,
5333 language,
5334 lsp_adapter,
5335 )
5336 .await;
5337 Ok(vec![CompletionResponse {
5338 completions,
5339 is_incomplete: completion_response.is_incomplete,
5340 }])
5341 })
5342 } else if let Some(local) = self.as_local() {
5343 let snapshot = buffer.read(cx).snapshot();
5344 let offset = position.to_offset(&snapshot);
5345 let scope = snapshot.language_scope_at(offset);
5346 let language = snapshot.language().cloned();
5347 let completion_settings = language_settings(
5348 language.as_ref().map(|language| language.name()),
5349 buffer.read(cx).file(),
5350 cx,
5351 )
5352 .completions;
5353 if !completion_settings.lsp {
5354 return Task::ready(Ok(Vec::new()));
5355 }
5356
5357 let server_ids: Vec<_> = buffer.update(cx, |buffer, cx| {
5358 local
5359 .language_servers_for_buffer(buffer, cx)
5360 .filter(|(_, server)| server.capabilities().completion_provider.is_some())
5361 .filter(|(adapter, _)| {
5362 scope
5363 .as_ref()
5364 .map(|scope| scope.language_allowed(&adapter.name))
5365 .unwrap_or(true)
5366 })
5367 .map(|(_, server)| server.server_id())
5368 .collect()
5369 });
5370
5371 let buffer = buffer.clone();
5372 let lsp_timeout = completion_settings.lsp_fetch_timeout_ms;
5373 let lsp_timeout = if lsp_timeout > 0 {
5374 Some(Duration::from_millis(lsp_timeout))
5375 } else {
5376 None
5377 };
5378 cx.spawn(async move |this, cx| {
5379 let mut tasks = Vec::with_capacity(server_ids.len());
5380 this.update(cx, |lsp_store, cx| {
5381 for server_id in server_ids {
5382 let lsp_adapter = lsp_store.language_server_adapter_for_id(server_id);
5383 let lsp_timeout = lsp_timeout
5384 .map(|lsp_timeout| cx.background_executor().timer(lsp_timeout));
5385 let mut timeout = cx.background_spawn(async move {
5386 match lsp_timeout {
5387 Some(lsp_timeout) => {
5388 lsp_timeout.await;
5389 true
5390 },
5391 None => false,
5392 }
5393 }).fuse();
5394 let mut lsp_request = lsp_store.request_lsp(
5395 buffer.clone(),
5396 LanguageServerToQuery::Other(server_id),
5397 GetCompletions {
5398 position,
5399 context: context.clone(),
5400 },
5401 cx,
5402 ).fuse();
5403 let new_task = cx.background_spawn(async move {
5404 select_biased! {
5405 response = lsp_request => anyhow::Ok(Some(response?)),
5406 timeout_happened = timeout => {
5407 if timeout_happened {
5408 log::warn!("Fetching completions from server {server_id} timed out, timeout ms: {}", completion_settings.lsp_fetch_timeout_ms);
5409 Ok(None)
5410 } else {
5411 let completions = lsp_request.await?;
5412 Ok(Some(completions))
5413 }
5414 },
5415 }
5416 });
5417 tasks.push((lsp_adapter, new_task));
5418 }
5419 })?;
5420
5421 let futures = tasks.into_iter().map(async |(lsp_adapter, task)| {
5422 let completion_response = task.await.ok()??;
5423 let completions = populate_labels_for_completions(
5424 completion_response.completions,
5425 language.clone(),
5426 lsp_adapter,
5427 )
5428 .await;
5429 Some(CompletionResponse {
5430 completions,
5431 is_incomplete: completion_response.is_incomplete,
5432 })
5433 });
5434
5435 let responses: Vec<Option<CompletionResponse>> = join_all(futures).await;
5436
5437 Ok(responses.into_iter().flatten().collect())
5438 })
5439 } else {
5440 Task::ready(Err(anyhow!("No upstream client or local language server")))
5441 }
5442 }
5443
5444 pub fn resolve_completions(
5445 &self,
5446 buffer: Entity<Buffer>,
5447 completion_indices: Vec<usize>,
5448 completions: Rc<RefCell<Box<[Completion]>>>,
5449 cx: &mut Context<Self>,
5450 ) -> Task<Result<bool>> {
5451 let client = self.upstream_client();
5452
5453 let buffer_id = buffer.read(cx).remote_id();
5454 let buffer_snapshot = buffer.read(cx).snapshot();
5455
5456 cx.spawn(async move |this, cx| {
5457 let mut did_resolve = false;
5458 if let Some((client, project_id)) = client {
5459 for completion_index in completion_indices {
5460 let server_id = {
5461 let completion = &completions.borrow()[completion_index];
5462 completion.source.server_id()
5463 };
5464 if let Some(server_id) = server_id {
5465 if Self::resolve_completion_remote(
5466 project_id,
5467 server_id,
5468 buffer_id,
5469 completions.clone(),
5470 completion_index,
5471 client.clone(),
5472 )
5473 .await
5474 .log_err()
5475 .is_some()
5476 {
5477 did_resolve = true;
5478 }
5479 } else {
5480 resolve_word_completion(
5481 &buffer_snapshot,
5482 &mut completions.borrow_mut()[completion_index],
5483 );
5484 }
5485 }
5486 } else {
5487 for completion_index in completion_indices {
5488 let server_id = {
5489 let completion = &completions.borrow()[completion_index];
5490 completion.source.server_id()
5491 };
5492 if let Some(server_id) = server_id {
5493 let server_and_adapter = this
5494 .read_with(cx, |lsp_store, _| {
5495 let server = lsp_store.language_server_for_id(server_id)?;
5496 let adapter =
5497 lsp_store.language_server_adapter_for_id(server.server_id())?;
5498 Some((server, adapter))
5499 })
5500 .ok()
5501 .flatten();
5502 let Some((server, adapter)) = server_and_adapter else {
5503 continue;
5504 };
5505
5506 let resolved = Self::resolve_completion_local(
5507 server,
5508 &buffer_snapshot,
5509 completions.clone(),
5510 completion_index,
5511 )
5512 .await
5513 .log_err()
5514 .is_some();
5515 if resolved {
5516 Self::regenerate_completion_labels(
5517 adapter,
5518 &buffer_snapshot,
5519 completions.clone(),
5520 completion_index,
5521 )
5522 .await
5523 .log_err();
5524 did_resolve = true;
5525 }
5526 } else {
5527 resolve_word_completion(
5528 &buffer_snapshot,
5529 &mut completions.borrow_mut()[completion_index],
5530 );
5531 }
5532 }
5533 }
5534
5535 Ok(did_resolve)
5536 })
5537 }
5538
5539 async fn resolve_completion_local(
5540 server: Arc<lsp::LanguageServer>,
5541 snapshot: &BufferSnapshot,
5542 completions: Rc<RefCell<Box<[Completion]>>>,
5543 completion_index: usize,
5544 ) -> Result<()> {
5545 let server_id = server.server_id();
5546 let can_resolve = server
5547 .capabilities()
5548 .completion_provider
5549 .as_ref()
5550 .and_then(|options| options.resolve_provider)
5551 .unwrap_or(false);
5552 if !can_resolve {
5553 return Ok(());
5554 }
5555
5556 let request = {
5557 let completion = &completions.borrow()[completion_index];
5558 match &completion.source {
5559 CompletionSource::Lsp {
5560 lsp_completion,
5561 resolved,
5562 server_id: completion_server_id,
5563 ..
5564 } => {
5565 if *resolved {
5566 return Ok(());
5567 }
5568 anyhow::ensure!(
5569 server_id == *completion_server_id,
5570 "server_id mismatch, querying completion resolve for {server_id} but completion server id is {completion_server_id}"
5571 );
5572 server.request::<lsp::request::ResolveCompletionItem>(*lsp_completion.clone())
5573 }
5574 CompletionSource::BufferWord { .. } | CompletionSource::Custom => {
5575 return Ok(());
5576 }
5577 }
5578 };
5579 let resolved_completion = request
5580 .await
5581 .into_response()
5582 .context("resolve completion")?;
5583
5584 if let Some(text_edit) = resolved_completion.text_edit.as_ref() {
5585 // Technically we don't have to parse the whole `text_edit`, since the only
5586 // language server we currently use that does update `text_edit` in `completionItem/resolve`
5587 // is `typescript-language-server` and they only update `text_edit.new_text`.
5588 // But we should not rely on that.
5589 let edit = parse_completion_text_edit(text_edit, snapshot);
5590
5591 if let Some(mut parsed_edit) = edit {
5592 LineEnding::normalize(&mut parsed_edit.new_text);
5593
5594 let mut completions = completions.borrow_mut();
5595 let completion = &mut completions[completion_index];
5596
5597 completion.new_text = parsed_edit.new_text;
5598 completion.replace_range = parsed_edit.replace_range;
5599 if let CompletionSource::Lsp { insert_range, .. } = &mut completion.source {
5600 *insert_range = parsed_edit.insert_range;
5601 }
5602 }
5603 }
5604
5605 let mut completions = completions.borrow_mut();
5606 let completion = &mut completions[completion_index];
5607 if let CompletionSource::Lsp {
5608 lsp_completion,
5609 resolved,
5610 server_id: completion_server_id,
5611 ..
5612 } = &mut completion.source
5613 {
5614 if *resolved {
5615 return Ok(());
5616 }
5617 anyhow::ensure!(
5618 server_id == *completion_server_id,
5619 "server_id mismatch, applying completion resolve for {server_id} but completion server id is {completion_server_id}"
5620 );
5621 *lsp_completion = Box::new(resolved_completion);
5622 *resolved = true;
5623 }
5624 Ok(())
5625 }
5626
5627 async fn regenerate_completion_labels(
5628 adapter: Arc<CachedLspAdapter>,
5629 snapshot: &BufferSnapshot,
5630 completions: Rc<RefCell<Box<[Completion]>>>,
5631 completion_index: usize,
5632 ) -> Result<()> {
5633 let completion_item = completions.borrow()[completion_index]
5634 .source
5635 .lsp_completion(true)
5636 .map(Cow::into_owned);
5637 if let Some(lsp_documentation) = completion_item
5638 .as_ref()
5639 .and_then(|completion_item| completion_item.documentation.clone())
5640 {
5641 let mut completions = completions.borrow_mut();
5642 let completion = &mut completions[completion_index];
5643 completion.documentation = Some(lsp_documentation.into());
5644 } else {
5645 let mut completions = completions.borrow_mut();
5646 let completion = &mut completions[completion_index];
5647 completion.documentation = Some(CompletionDocumentation::Undocumented);
5648 }
5649
5650 let mut new_label = match completion_item {
5651 Some(completion_item) => {
5652 // 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
5653 // So we have to update the label here anyway...
5654 let language = snapshot.language();
5655 match language {
5656 Some(language) => {
5657 adapter
5658 .labels_for_completions(&[completion_item.clone()], language)
5659 .await?
5660 }
5661 None => Vec::new(),
5662 }
5663 .pop()
5664 .flatten()
5665 .unwrap_or_else(|| {
5666 CodeLabel::fallback_for_completion(
5667 &completion_item,
5668 language.map(|language| language.as_ref()),
5669 )
5670 })
5671 }
5672 None => CodeLabel::plain(
5673 completions.borrow()[completion_index].new_text.clone(),
5674 None,
5675 ),
5676 };
5677 ensure_uniform_list_compatible_label(&mut new_label);
5678
5679 let mut completions = completions.borrow_mut();
5680 let completion = &mut completions[completion_index];
5681 if completion.label.filter_text() == new_label.filter_text() {
5682 completion.label = new_label;
5683 } else {
5684 log::error!(
5685 "Resolved completion changed display label from {} to {}. \
5686 Refusing to apply this because it changes the fuzzy match text from {} to {}",
5687 completion.label.text(),
5688 new_label.text(),
5689 completion.label.filter_text(),
5690 new_label.filter_text()
5691 );
5692 }
5693
5694 Ok(())
5695 }
5696
5697 async fn resolve_completion_remote(
5698 project_id: u64,
5699 server_id: LanguageServerId,
5700 buffer_id: BufferId,
5701 completions: Rc<RefCell<Box<[Completion]>>>,
5702 completion_index: usize,
5703 client: AnyProtoClient,
5704 ) -> Result<()> {
5705 let lsp_completion = {
5706 let completion = &completions.borrow()[completion_index];
5707 match &completion.source {
5708 CompletionSource::Lsp {
5709 lsp_completion,
5710 resolved,
5711 server_id: completion_server_id,
5712 ..
5713 } => {
5714 anyhow::ensure!(
5715 server_id == *completion_server_id,
5716 "remote server_id mismatch, querying completion resolve for {server_id} but completion server id is {completion_server_id}"
5717 );
5718 if *resolved {
5719 return Ok(());
5720 }
5721 serde_json::to_string(lsp_completion).unwrap().into_bytes()
5722 }
5723 CompletionSource::Custom | CompletionSource::BufferWord { .. } => {
5724 return Ok(());
5725 }
5726 }
5727 };
5728 let request = proto::ResolveCompletionDocumentation {
5729 project_id,
5730 language_server_id: server_id.0 as u64,
5731 lsp_completion,
5732 buffer_id: buffer_id.into(),
5733 };
5734
5735 let response = client
5736 .request(request)
5737 .await
5738 .context("completion documentation resolve proto request")?;
5739 let resolved_lsp_completion = serde_json::from_slice(&response.lsp_completion)?;
5740
5741 let documentation = if response.documentation.is_empty() {
5742 CompletionDocumentation::Undocumented
5743 } else if response.documentation_is_markdown {
5744 CompletionDocumentation::MultiLineMarkdown(response.documentation.into())
5745 } else if response.documentation.lines().count() <= 1 {
5746 CompletionDocumentation::SingleLine(response.documentation.into())
5747 } else {
5748 CompletionDocumentation::MultiLinePlainText(response.documentation.into())
5749 };
5750
5751 let mut completions = completions.borrow_mut();
5752 let completion = &mut completions[completion_index];
5753 completion.documentation = Some(documentation);
5754 if let CompletionSource::Lsp {
5755 insert_range,
5756 lsp_completion,
5757 resolved,
5758 server_id: completion_server_id,
5759 lsp_defaults: _,
5760 } = &mut completion.source
5761 {
5762 let completion_insert_range = response
5763 .old_insert_start
5764 .and_then(deserialize_anchor)
5765 .zip(response.old_insert_end.and_then(deserialize_anchor));
5766 *insert_range = completion_insert_range.map(|(start, end)| start..end);
5767
5768 if *resolved {
5769 return Ok(());
5770 }
5771 anyhow::ensure!(
5772 server_id == *completion_server_id,
5773 "remote server_id mismatch, applying completion resolve for {server_id} but completion server id is {completion_server_id}"
5774 );
5775 *lsp_completion = Box::new(resolved_lsp_completion);
5776 *resolved = true;
5777 }
5778
5779 let replace_range = response
5780 .old_replace_start
5781 .and_then(deserialize_anchor)
5782 .zip(response.old_replace_end.and_then(deserialize_anchor));
5783 if let Some((old_replace_start, old_replace_end)) = replace_range {
5784 if !response.new_text.is_empty() {
5785 completion.new_text = response.new_text;
5786 completion.replace_range = old_replace_start..old_replace_end;
5787 }
5788 }
5789
5790 Ok(())
5791 }
5792
5793 pub fn apply_additional_edits_for_completion(
5794 &self,
5795 buffer_handle: Entity<Buffer>,
5796 completions: Rc<RefCell<Box<[Completion]>>>,
5797 completion_index: usize,
5798 push_to_history: bool,
5799 cx: &mut Context<Self>,
5800 ) -> Task<Result<Option<Transaction>>> {
5801 if let Some((client, project_id)) = self.upstream_client() {
5802 let buffer = buffer_handle.read(cx);
5803 let buffer_id = buffer.remote_id();
5804 cx.spawn(async move |_, cx| {
5805 let request = {
5806 let completion = completions.borrow()[completion_index].clone();
5807 proto::ApplyCompletionAdditionalEdits {
5808 project_id,
5809 buffer_id: buffer_id.into(),
5810 completion: Some(Self::serialize_completion(&CoreCompletion {
5811 replace_range: completion.replace_range,
5812 new_text: completion.new_text,
5813 source: completion.source,
5814 })),
5815 }
5816 };
5817
5818 if let Some(transaction) = client.request(request).await?.transaction {
5819 let transaction = language::proto::deserialize_transaction(transaction)?;
5820 buffer_handle
5821 .update(cx, |buffer, _| {
5822 buffer.wait_for_edits(transaction.edit_ids.iter().copied())
5823 })?
5824 .await?;
5825 if push_to_history {
5826 buffer_handle.update(cx, |buffer, _| {
5827 buffer.push_transaction(transaction.clone(), Instant::now());
5828 buffer.finalize_last_transaction();
5829 })?;
5830 }
5831 Ok(Some(transaction))
5832 } else {
5833 Ok(None)
5834 }
5835 })
5836 } else {
5837 let Some(server) = buffer_handle.update(cx, |buffer, cx| {
5838 let completion = &completions.borrow()[completion_index];
5839 let server_id = completion.source.server_id()?;
5840 Some(
5841 self.language_server_for_local_buffer(buffer, server_id, cx)?
5842 .1
5843 .clone(),
5844 )
5845 }) else {
5846 return Task::ready(Ok(None));
5847 };
5848 let snapshot = buffer_handle.read(&cx).snapshot();
5849
5850 cx.spawn(async move |this, cx| {
5851 Self::resolve_completion_local(
5852 server.clone(),
5853 &snapshot,
5854 completions.clone(),
5855 completion_index,
5856 )
5857 .await
5858 .context("resolving completion")?;
5859 let completion = completions.borrow()[completion_index].clone();
5860 let additional_text_edits = completion
5861 .source
5862 .lsp_completion(true)
5863 .as_ref()
5864 .and_then(|lsp_completion| lsp_completion.additional_text_edits.clone());
5865 if let Some(edits) = additional_text_edits {
5866 let edits = this
5867 .update(cx, |this, cx| {
5868 this.as_local_mut().unwrap().edits_from_lsp(
5869 &buffer_handle,
5870 edits,
5871 server.server_id(),
5872 None,
5873 cx,
5874 )
5875 })?
5876 .await?;
5877
5878 buffer_handle.update(cx, |buffer, cx| {
5879 buffer.finalize_last_transaction();
5880 buffer.start_transaction();
5881
5882 for (range, text) in edits {
5883 let primary = &completion.replace_range;
5884 let start_within = primary.start.cmp(&range.start, buffer).is_le()
5885 && primary.end.cmp(&range.start, buffer).is_ge();
5886 let end_within = range.start.cmp(&primary.end, buffer).is_le()
5887 && range.end.cmp(&primary.end, buffer).is_ge();
5888
5889 //Skip additional edits which overlap with the primary completion edit
5890 //https://github.com/zed-industries/zed/pull/1871
5891 if !start_within && !end_within {
5892 buffer.edit([(range, text)], None, cx);
5893 }
5894 }
5895
5896 let transaction = if buffer.end_transaction(cx).is_some() {
5897 let transaction = buffer.finalize_last_transaction().unwrap().clone();
5898 if !push_to_history {
5899 buffer.forget_transaction(transaction.id);
5900 }
5901 Some(transaction)
5902 } else {
5903 None
5904 };
5905 Ok(transaction)
5906 })?
5907 } else {
5908 Ok(None)
5909 }
5910 })
5911 }
5912 }
5913
5914 pub fn pull_diagnostics(
5915 &mut self,
5916 buffer_handle: Entity<Buffer>,
5917 cx: &mut Context<Self>,
5918 ) -> Task<Result<Vec<LspPullDiagnostics>>> {
5919 let buffer = buffer_handle.read(cx);
5920 let buffer_id = buffer.remote_id();
5921
5922 if let Some((client, upstream_project_id)) = self.upstream_client() {
5923 let request_task = client.request(proto::MultiLspQuery {
5924 buffer_id: buffer_id.to_proto(),
5925 version: serialize_version(&buffer_handle.read(cx).version()),
5926 project_id: upstream_project_id,
5927 strategy: Some(proto::multi_lsp_query::Strategy::All(
5928 proto::AllLanguageServers {},
5929 )),
5930 request: Some(proto::multi_lsp_query::Request::GetDocumentDiagnostics(
5931 proto::GetDocumentDiagnostics {
5932 project_id: upstream_project_id,
5933 buffer_id: buffer_id.to_proto(),
5934 version: serialize_version(&buffer_handle.read(cx).version()),
5935 },
5936 )),
5937 });
5938 cx.background_spawn(async move {
5939 Ok(request_task
5940 .await?
5941 .responses
5942 .into_iter()
5943 .filter_map(|lsp_response| match lsp_response.response? {
5944 proto::lsp_response::Response::GetDocumentDiagnosticsResponse(response) => {
5945 Some(response)
5946 }
5947 unexpected => {
5948 debug_panic!("Unexpected response: {unexpected:?}");
5949 None
5950 }
5951 })
5952 .flat_map(GetDocumentDiagnostics::diagnostics_from_proto)
5953 .collect())
5954 })
5955 } else {
5956 let server_ids = buffer_handle.update(cx, |buffer, cx| {
5957 self.language_servers_for_local_buffer(buffer, cx)
5958 .map(|(_, server)| server.server_id())
5959 .collect::<Vec<_>>()
5960 });
5961 let pull_diagnostics = server_ids
5962 .into_iter()
5963 .map(|server_id| {
5964 let result_id = self.result_id(server_id, buffer_id, cx);
5965 self.request_lsp(
5966 buffer_handle.clone(),
5967 LanguageServerToQuery::Other(server_id),
5968 GetDocumentDiagnostics {
5969 previous_result_id: result_id,
5970 },
5971 cx,
5972 )
5973 })
5974 .collect::<Vec<_>>();
5975
5976 cx.background_spawn(async move {
5977 let mut responses = Vec::new();
5978 for diagnostics in join_all(pull_diagnostics).await {
5979 responses.extend(diagnostics?);
5980 }
5981 Ok(responses)
5982 })
5983 }
5984 }
5985
5986 pub fn inlay_hints(
5987 &mut self,
5988 buffer_handle: Entity<Buffer>,
5989 range: Range<Anchor>,
5990 cx: &mut Context<Self>,
5991 ) -> Task<anyhow::Result<Vec<InlayHint>>> {
5992 let buffer = buffer_handle.read(cx);
5993 let range_start = range.start;
5994 let range_end = range.end;
5995 let buffer_id = buffer.remote_id().into();
5996 let lsp_request = InlayHints { range };
5997
5998 if let Some((client, project_id)) = self.upstream_client() {
5999 let request = proto::InlayHints {
6000 project_id,
6001 buffer_id,
6002 start: Some(serialize_anchor(&range_start)),
6003 end: Some(serialize_anchor(&range_end)),
6004 version: serialize_version(&buffer_handle.read(cx).version()),
6005 };
6006 cx.spawn(async move |project, cx| {
6007 let response = client
6008 .request(request)
6009 .await
6010 .context("inlay hints proto request")?;
6011 LspCommand::response_from_proto(
6012 lsp_request,
6013 response,
6014 project.upgrade().context("No project")?,
6015 buffer_handle.clone(),
6016 cx.clone(),
6017 )
6018 .await
6019 .context("inlay hints proto response conversion")
6020 })
6021 } else {
6022 let lsp_request_task = self.request_lsp(
6023 buffer_handle.clone(),
6024 LanguageServerToQuery::FirstCapable,
6025 lsp_request,
6026 cx,
6027 );
6028 cx.spawn(async move |_, cx| {
6029 buffer_handle
6030 .update(cx, |buffer, _| {
6031 buffer.wait_for_edits(vec![range_start.timestamp, range_end.timestamp])
6032 })?
6033 .await
6034 .context("waiting for inlay hint request range edits")?;
6035 lsp_request_task.await.context("inlay hints LSP request")
6036 })
6037 }
6038 }
6039
6040 pub fn pull_diagnostics_for_buffer(
6041 &mut self,
6042 buffer: Entity<Buffer>,
6043 cx: &mut Context<Self>,
6044 ) -> Task<anyhow::Result<()>> {
6045 let buffer_id = buffer.read(cx).remote_id();
6046 let diagnostics = self.pull_diagnostics(buffer, cx);
6047 cx.spawn(async move |lsp_store, cx| {
6048 let diagnostics = diagnostics.await.context("pulling diagnostics")?;
6049 lsp_store.update(cx, |lsp_store, cx| {
6050 if lsp_store.as_local().is_none() {
6051 return;
6052 }
6053
6054 for diagnostics_set in diagnostics {
6055 let LspPullDiagnostics::Response {
6056 server_id,
6057 uri,
6058 diagnostics,
6059 } = diagnostics_set
6060 else {
6061 continue;
6062 };
6063
6064 let adapter = lsp_store.language_server_adapter_for_id(server_id);
6065 let disk_based_sources = adapter
6066 .as_ref()
6067 .map(|adapter| adapter.disk_based_diagnostic_sources.as_slice())
6068 .unwrap_or(&[]);
6069 match diagnostics {
6070 PulledDiagnostics::Unchanged { result_id } => {
6071 lsp_store
6072 .merge_diagnostics(
6073 server_id,
6074 lsp::PublishDiagnosticsParams {
6075 uri: uri.clone(),
6076 diagnostics: Vec::new(),
6077 version: None,
6078 },
6079 Some(result_id),
6080 DiagnosticSourceKind::Pulled,
6081 disk_based_sources,
6082 |_, _, _| true,
6083 cx,
6084 )
6085 .log_err();
6086 }
6087 PulledDiagnostics::Changed {
6088 diagnostics,
6089 result_id,
6090 } => {
6091 lsp_store
6092 .merge_diagnostics(
6093 server_id,
6094 lsp::PublishDiagnosticsParams {
6095 uri: uri.clone(),
6096 diagnostics,
6097 version: None,
6098 },
6099 result_id,
6100 DiagnosticSourceKind::Pulled,
6101 disk_based_sources,
6102 |buffer, old_diagnostic, _| match old_diagnostic.source_kind {
6103 DiagnosticSourceKind::Pulled => {
6104 buffer.remote_id() != buffer_id
6105 }
6106 DiagnosticSourceKind::Other
6107 | DiagnosticSourceKind::Pushed => true,
6108 },
6109 cx,
6110 )
6111 .log_err();
6112 }
6113 }
6114 }
6115 })
6116 })
6117 }
6118
6119 pub fn document_colors(
6120 &mut self,
6121 fetch_strategy: ColorFetchStrategy,
6122 buffer: Entity<Buffer>,
6123 cx: &mut Context<Self>,
6124 ) -> Option<DocumentColorTask> {
6125 let version_queried_for = buffer.read(cx).version();
6126 let buffer_id = buffer.read(cx).remote_id();
6127
6128 match fetch_strategy {
6129 ColorFetchStrategy::IgnoreCache => {}
6130 ColorFetchStrategy::UseCache {
6131 known_cache_version,
6132 } => {
6133 if let Some(cached_data) = self.lsp_data.get(&buffer_id) {
6134 if !version_queried_for.changed_since(&cached_data.colors_for_version) {
6135 let has_different_servers = self.as_local().is_some_and(|local| {
6136 local
6137 .buffers_opened_in_servers
6138 .get(&buffer_id)
6139 .cloned()
6140 .unwrap_or_default()
6141 != cached_data.colors.keys().copied().collect()
6142 });
6143 if !has_different_servers {
6144 if Some(cached_data.cache_version) == known_cache_version {
6145 return None;
6146 } else {
6147 return Some(
6148 Task::ready(Ok(DocumentColors {
6149 colors: cached_data
6150 .colors
6151 .values()
6152 .flatten()
6153 .cloned()
6154 .collect(),
6155 cache_version: Some(cached_data.cache_version),
6156 }))
6157 .shared(),
6158 );
6159 }
6160 }
6161 }
6162 }
6163 }
6164 }
6165
6166 let lsp_data = self.lsp_data.entry(buffer_id).or_default();
6167 if let Some((updating_for, running_update)) = &lsp_data.colors_update {
6168 if !version_queried_for.changed_since(&updating_for) {
6169 return Some(running_update.clone());
6170 }
6171 }
6172 let query_version_queried_for = version_queried_for.clone();
6173 let new_task = cx
6174 .spawn(async move |lsp_store, cx| {
6175 cx.background_executor()
6176 .timer(Duration::from_millis(30))
6177 .await;
6178 let fetched_colors = lsp_store
6179 .update(cx, |lsp_store, cx| {
6180 lsp_store.fetch_document_colors_for_buffer(buffer.clone(), cx)
6181 })?
6182 .await
6183 .context("fetching document colors")
6184 .map_err(Arc::new);
6185 let fetched_colors = match fetched_colors {
6186 Ok(fetched_colors) => {
6187 if fetch_strategy != ColorFetchStrategy::IgnoreCache
6188 && Some(true)
6189 == buffer
6190 .update(cx, |buffer, _| {
6191 buffer.version() != query_version_queried_for
6192 })
6193 .ok()
6194 {
6195 return Ok(DocumentColors::default());
6196 }
6197 fetched_colors
6198 }
6199 Err(e) => {
6200 lsp_store
6201 .update(cx, |lsp_store, _| {
6202 lsp_store
6203 .lsp_data
6204 .entry(buffer_id)
6205 .or_default()
6206 .colors_update = None;
6207 })
6208 .ok();
6209 return Err(e);
6210 }
6211 };
6212
6213 lsp_store
6214 .update(cx, |lsp_store, _| {
6215 let lsp_data = lsp_store.lsp_data.entry(buffer_id).or_default();
6216
6217 if lsp_data.colors_for_version == query_version_queried_for {
6218 lsp_data.colors.extend(fetched_colors.clone());
6219 lsp_data.cache_version += 1;
6220 } else if !lsp_data
6221 .colors_for_version
6222 .changed_since(&query_version_queried_for)
6223 {
6224 lsp_data.colors_for_version = query_version_queried_for;
6225 lsp_data.colors = fetched_colors.clone();
6226 lsp_data.cache_version += 1;
6227 }
6228 lsp_data.colors_update = None;
6229 let colors = lsp_data
6230 .colors
6231 .values()
6232 .flatten()
6233 .cloned()
6234 .collect::<HashSet<_>>();
6235 DocumentColors {
6236 colors,
6237 cache_version: Some(lsp_data.cache_version),
6238 }
6239 })
6240 .map_err(Arc::new)
6241 })
6242 .shared();
6243 lsp_data.colors_update = Some((version_queried_for, new_task.clone()));
6244 Some(new_task)
6245 }
6246
6247 fn fetch_document_colors_for_buffer(
6248 &mut self,
6249 buffer: Entity<Buffer>,
6250 cx: &mut Context<Self>,
6251 ) -> Task<anyhow::Result<HashMap<LanguageServerId, HashSet<DocumentColor>>>> {
6252 if let Some((client, project_id)) = self.upstream_client() {
6253 let request_task = client.request(proto::MultiLspQuery {
6254 project_id,
6255 buffer_id: buffer.read(cx).remote_id().to_proto(),
6256 version: serialize_version(&buffer.read(cx).version()),
6257 strategy: Some(proto::multi_lsp_query::Strategy::All(
6258 proto::AllLanguageServers {},
6259 )),
6260 request: Some(proto::multi_lsp_query::Request::GetDocumentColor(
6261 GetDocumentColor {}.to_proto(project_id, buffer.read(cx)),
6262 )),
6263 });
6264 cx.spawn(async move |project, cx| {
6265 let Some(project) = project.upgrade() else {
6266 return Ok(HashMap::default());
6267 };
6268 let colors = join_all(
6269 request_task
6270 .await
6271 .log_err()
6272 .map(|response| response.responses)
6273 .unwrap_or_default()
6274 .into_iter()
6275 .filter_map(|lsp_response| match lsp_response.response? {
6276 proto::lsp_response::Response::GetDocumentColorResponse(response) => {
6277 Some((
6278 LanguageServerId::from_proto(lsp_response.server_id),
6279 response,
6280 ))
6281 }
6282 unexpected => {
6283 debug_panic!("Unexpected response: {unexpected:?}");
6284 None
6285 }
6286 })
6287 .map(|(server_id, color_response)| {
6288 let response = GetDocumentColor {}.response_from_proto(
6289 color_response,
6290 project.clone(),
6291 buffer.clone(),
6292 cx.clone(),
6293 );
6294 async move { (server_id, response.await.log_err().unwrap_or_default()) }
6295 }),
6296 )
6297 .await
6298 .into_iter()
6299 .fold(HashMap::default(), |mut acc, (server_id, colors)| {
6300 acc.entry(server_id)
6301 .or_insert_with(HashSet::default)
6302 .extend(colors);
6303 acc
6304 });
6305 Ok(colors)
6306 })
6307 } else {
6308 let document_colors_task =
6309 self.request_multiple_lsp_locally(&buffer, None::<usize>, GetDocumentColor, cx);
6310 cx.spawn(async move |_, _| {
6311 Ok(document_colors_task
6312 .await
6313 .into_iter()
6314 .fold(HashMap::default(), |mut acc, (server_id, colors)| {
6315 acc.entry(server_id)
6316 .or_insert_with(HashSet::default)
6317 .extend(colors);
6318 acc
6319 })
6320 .into_iter()
6321 .collect())
6322 })
6323 }
6324 }
6325
6326 pub fn signature_help<T: ToPointUtf16>(
6327 &mut self,
6328 buffer: &Entity<Buffer>,
6329 position: T,
6330 cx: &mut Context<Self>,
6331 ) -> Task<Vec<SignatureHelp>> {
6332 let position = position.to_point_utf16(buffer.read(cx));
6333
6334 if let Some((client, upstream_project_id)) = self.upstream_client() {
6335 let request_task = client.request(proto::MultiLspQuery {
6336 buffer_id: buffer.read(cx).remote_id().into(),
6337 version: serialize_version(&buffer.read(cx).version()),
6338 project_id: upstream_project_id,
6339 strategy: Some(proto::multi_lsp_query::Strategy::All(
6340 proto::AllLanguageServers {},
6341 )),
6342 request: Some(proto::multi_lsp_query::Request::GetSignatureHelp(
6343 GetSignatureHelp { position }.to_proto(upstream_project_id, buffer.read(cx)),
6344 )),
6345 });
6346 let buffer = buffer.clone();
6347 cx.spawn(async move |weak_project, cx| {
6348 let Some(project) = weak_project.upgrade() else {
6349 return Vec::new();
6350 };
6351 join_all(
6352 request_task
6353 .await
6354 .log_err()
6355 .map(|response| response.responses)
6356 .unwrap_or_default()
6357 .into_iter()
6358 .filter_map(|lsp_response| match lsp_response.response? {
6359 proto::lsp_response::Response::GetSignatureHelpResponse(response) => {
6360 Some(response)
6361 }
6362 unexpected => {
6363 debug_panic!("Unexpected response: {unexpected:?}");
6364 None
6365 }
6366 })
6367 .map(|signature_response| {
6368 let response = GetSignatureHelp { position }.response_from_proto(
6369 signature_response,
6370 project.clone(),
6371 buffer.clone(),
6372 cx.clone(),
6373 );
6374 async move { response.await.log_err().flatten() }
6375 }),
6376 )
6377 .await
6378 .into_iter()
6379 .flatten()
6380 .collect()
6381 })
6382 } else {
6383 let all_actions_task = self.request_multiple_lsp_locally(
6384 buffer,
6385 Some(position),
6386 GetSignatureHelp { position },
6387 cx,
6388 );
6389 cx.spawn(async move |_, _| {
6390 all_actions_task
6391 .await
6392 .into_iter()
6393 .flat_map(|(_, actions)| actions)
6394 .filter(|help| !help.label.is_empty())
6395 .collect::<Vec<_>>()
6396 })
6397 }
6398 }
6399
6400 pub fn hover(
6401 &mut self,
6402 buffer: &Entity<Buffer>,
6403 position: PointUtf16,
6404 cx: &mut Context<Self>,
6405 ) -> Task<Vec<Hover>> {
6406 if let Some((client, upstream_project_id)) = self.upstream_client() {
6407 let request_task = client.request(proto::MultiLspQuery {
6408 buffer_id: buffer.read(cx).remote_id().into(),
6409 version: serialize_version(&buffer.read(cx).version()),
6410 project_id: upstream_project_id,
6411 strategy: Some(proto::multi_lsp_query::Strategy::All(
6412 proto::AllLanguageServers {},
6413 )),
6414 request: Some(proto::multi_lsp_query::Request::GetHover(
6415 GetHover { position }.to_proto(upstream_project_id, buffer.read(cx)),
6416 )),
6417 });
6418 let buffer = buffer.clone();
6419 cx.spawn(async move |weak_project, cx| {
6420 let Some(project) = weak_project.upgrade() else {
6421 return Vec::new();
6422 };
6423 join_all(
6424 request_task
6425 .await
6426 .log_err()
6427 .map(|response| response.responses)
6428 .unwrap_or_default()
6429 .into_iter()
6430 .filter_map(|lsp_response| match lsp_response.response? {
6431 proto::lsp_response::Response::GetHoverResponse(response) => {
6432 Some(response)
6433 }
6434 unexpected => {
6435 debug_panic!("Unexpected response: {unexpected:?}");
6436 None
6437 }
6438 })
6439 .map(|hover_response| {
6440 let response = GetHover { position }.response_from_proto(
6441 hover_response,
6442 project.clone(),
6443 buffer.clone(),
6444 cx.clone(),
6445 );
6446 async move {
6447 response
6448 .await
6449 .log_err()
6450 .flatten()
6451 .and_then(remove_empty_hover_blocks)
6452 }
6453 }),
6454 )
6455 .await
6456 .into_iter()
6457 .flatten()
6458 .collect()
6459 })
6460 } else {
6461 let all_actions_task = self.request_multiple_lsp_locally(
6462 buffer,
6463 Some(position),
6464 GetHover { position },
6465 cx,
6466 );
6467 cx.spawn(async move |_, _| {
6468 all_actions_task
6469 .await
6470 .into_iter()
6471 .filter_map(|(_, hover)| remove_empty_hover_blocks(hover?))
6472 .collect::<Vec<Hover>>()
6473 })
6474 }
6475 }
6476
6477 pub fn symbols(&self, query: &str, cx: &mut Context<Self>) -> Task<Result<Vec<Symbol>>> {
6478 let language_registry = self.languages.clone();
6479
6480 if let Some((upstream_client, project_id)) = self.upstream_client().as_ref() {
6481 let request = upstream_client.request(proto::GetProjectSymbols {
6482 project_id: *project_id,
6483 query: query.to_string(),
6484 });
6485 cx.foreground_executor().spawn(async move {
6486 let response = request.await?;
6487 let mut symbols = Vec::new();
6488 let core_symbols = response
6489 .symbols
6490 .into_iter()
6491 .filter_map(|symbol| Self::deserialize_symbol(symbol).log_err())
6492 .collect::<Vec<_>>();
6493 populate_labels_for_symbols(core_symbols, &language_registry, None, &mut symbols)
6494 .await;
6495 Ok(symbols)
6496 })
6497 } else if let Some(local) = self.as_local() {
6498 struct WorkspaceSymbolsResult {
6499 server_id: LanguageServerId,
6500 lsp_adapter: Arc<CachedLspAdapter>,
6501 worktree: WeakEntity<Worktree>,
6502 worktree_abs_path: Arc<Path>,
6503 lsp_symbols: Vec<(String, SymbolKind, lsp::Location)>,
6504 }
6505
6506 let mut requests = Vec::new();
6507 let mut requested_servers = BTreeSet::new();
6508 'next_server: for ((worktree_id, _), server_ids) in local.language_server_ids.iter() {
6509 let Some(worktree_handle) = self
6510 .worktree_store
6511 .read(cx)
6512 .worktree_for_id(*worktree_id, cx)
6513 else {
6514 continue;
6515 };
6516 let worktree = worktree_handle.read(cx);
6517 if !worktree.is_visible() {
6518 continue;
6519 }
6520
6521 let mut servers_to_query = server_ids
6522 .difference(&requested_servers)
6523 .cloned()
6524 .collect::<BTreeSet<_>>();
6525 for server_id in &servers_to_query {
6526 let (lsp_adapter, server) = match local.language_servers.get(server_id) {
6527 Some(LanguageServerState::Running {
6528 adapter, server, ..
6529 }) => (adapter.clone(), server),
6530
6531 _ => continue 'next_server,
6532 };
6533 let supports_workspace_symbol_request =
6534 match server.capabilities().workspace_symbol_provider {
6535 Some(OneOf::Left(supported)) => supported,
6536 Some(OneOf::Right(_)) => true,
6537 None => false,
6538 };
6539 if !supports_workspace_symbol_request {
6540 continue 'next_server;
6541 }
6542 let worktree_abs_path = worktree.abs_path().clone();
6543 let worktree_handle = worktree_handle.clone();
6544 let server_id = server.server_id();
6545 requests.push(
6546 server
6547 .request::<lsp::request::WorkspaceSymbolRequest>(
6548 lsp::WorkspaceSymbolParams {
6549 query: query.to_string(),
6550 ..Default::default()
6551 },
6552 )
6553 .map(move |response| {
6554 let lsp_symbols = response.into_response()
6555 .context("workspace symbols request")
6556 .log_err()
6557 .flatten()
6558 .map(|symbol_response| match symbol_response {
6559 lsp::WorkspaceSymbolResponse::Flat(flat_responses) => {
6560 flat_responses.into_iter().map(|lsp_symbol| {
6561 (lsp_symbol.name, lsp_symbol.kind, lsp_symbol.location)
6562 }).collect::<Vec<_>>()
6563 }
6564 lsp::WorkspaceSymbolResponse::Nested(nested_responses) => {
6565 nested_responses.into_iter().filter_map(|lsp_symbol| {
6566 let location = match lsp_symbol.location {
6567 OneOf::Left(location) => location,
6568 OneOf::Right(_) => {
6569 log::error!("Unexpected: client capabilities forbid symbol resolutions in workspace.symbol.resolveSupport");
6570 return None
6571 }
6572 };
6573 Some((lsp_symbol.name, lsp_symbol.kind, location))
6574 }).collect::<Vec<_>>()
6575 }
6576 }).unwrap_or_default();
6577
6578 WorkspaceSymbolsResult {
6579 server_id,
6580 lsp_adapter,
6581 worktree: worktree_handle.downgrade(),
6582 worktree_abs_path,
6583 lsp_symbols,
6584 }
6585 }),
6586 );
6587 }
6588 requested_servers.append(&mut servers_to_query);
6589 }
6590
6591 cx.spawn(async move |this, cx| {
6592 let responses = futures::future::join_all(requests).await;
6593 let this = match this.upgrade() {
6594 Some(this) => this,
6595 None => return Ok(Vec::new()),
6596 };
6597
6598 let mut symbols = Vec::new();
6599 for result in responses {
6600 let core_symbols = this.update(cx, |this, cx| {
6601 result
6602 .lsp_symbols
6603 .into_iter()
6604 .filter_map(|(symbol_name, symbol_kind, symbol_location)| {
6605 let abs_path = symbol_location.uri.to_file_path().ok()?;
6606 let source_worktree = result.worktree.upgrade()?;
6607 let source_worktree_id = source_worktree.read(cx).id();
6608
6609 let path;
6610 let worktree;
6611 if let Some((tree, rel_path)) =
6612 this.worktree_store.read(cx).find_worktree(&abs_path, cx)
6613 {
6614 worktree = tree;
6615 path = rel_path;
6616 } else {
6617 worktree = source_worktree.clone();
6618 path = relativize_path(&result.worktree_abs_path, &abs_path);
6619 }
6620
6621 let worktree_id = worktree.read(cx).id();
6622 let project_path = ProjectPath {
6623 worktree_id,
6624 path: path.into(),
6625 };
6626 let signature = this.symbol_signature(&project_path);
6627 Some(CoreSymbol {
6628 source_language_server_id: result.server_id,
6629 language_server_name: result.lsp_adapter.name.clone(),
6630 source_worktree_id,
6631 path: project_path,
6632 kind: symbol_kind,
6633 name: symbol_name,
6634 range: range_from_lsp(symbol_location.range),
6635 signature,
6636 })
6637 })
6638 .collect()
6639 })?;
6640
6641 populate_labels_for_symbols(
6642 core_symbols,
6643 &language_registry,
6644 Some(result.lsp_adapter),
6645 &mut symbols,
6646 )
6647 .await;
6648 }
6649
6650 Ok(symbols)
6651 })
6652 } else {
6653 Task::ready(Err(anyhow!("No upstream client or local language server")))
6654 }
6655 }
6656
6657 pub fn diagnostic_summary(&self, include_ignored: bool, cx: &App) -> DiagnosticSummary {
6658 let mut summary = DiagnosticSummary::default();
6659 for (_, _, path_summary) in self.diagnostic_summaries(include_ignored, cx) {
6660 summary.error_count += path_summary.error_count;
6661 summary.warning_count += path_summary.warning_count;
6662 }
6663 summary
6664 }
6665
6666 pub fn diagnostic_summaries<'a>(
6667 &'a self,
6668 include_ignored: bool,
6669 cx: &'a App,
6670 ) -> impl Iterator<Item = (ProjectPath, LanguageServerId, DiagnosticSummary)> + 'a {
6671 self.worktree_store
6672 .read(cx)
6673 .visible_worktrees(cx)
6674 .filter_map(|worktree| {
6675 let worktree = worktree.read(cx);
6676 Some((worktree, self.diagnostic_summaries.get(&worktree.id())?))
6677 })
6678 .flat_map(move |(worktree, summaries)| {
6679 let worktree_id = worktree.id();
6680 summaries
6681 .iter()
6682 .filter(move |(path, _)| {
6683 include_ignored
6684 || worktree
6685 .entry_for_path(path.as_ref())
6686 .map_or(false, |entry| !entry.is_ignored)
6687 })
6688 .flat_map(move |(path, summaries)| {
6689 summaries.iter().map(move |(server_id, summary)| {
6690 (
6691 ProjectPath {
6692 worktree_id,
6693 path: path.clone(),
6694 },
6695 *server_id,
6696 *summary,
6697 )
6698 })
6699 })
6700 })
6701 }
6702
6703 pub fn on_buffer_edited(
6704 &mut self,
6705 buffer: Entity<Buffer>,
6706 cx: &mut Context<Self>,
6707 ) -> Option<()> {
6708 let language_servers: Vec<_> = buffer.update(cx, |buffer, cx| {
6709 Some(
6710 self.as_local()?
6711 .language_servers_for_buffer(buffer, cx)
6712 .map(|i| i.1.clone())
6713 .collect(),
6714 )
6715 })?;
6716
6717 let buffer = buffer.read(cx);
6718 let file = File::from_dyn(buffer.file())?;
6719 let abs_path = file.as_local()?.abs_path(cx);
6720 let uri = lsp::Url::from_file_path(abs_path).unwrap();
6721 let next_snapshot = buffer.text_snapshot();
6722 for language_server in language_servers {
6723 let language_server = language_server.clone();
6724
6725 let buffer_snapshots = self
6726 .as_local_mut()
6727 .unwrap()
6728 .buffer_snapshots
6729 .get_mut(&buffer.remote_id())
6730 .and_then(|m| m.get_mut(&language_server.server_id()))?;
6731 let previous_snapshot = buffer_snapshots.last()?;
6732
6733 let build_incremental_change = || {
6734 buffer
6735 .edits_since::<(PointUtf16, usize)>(previous_snapshot.snapshot.version())
6736 .map(|edit| {
6737 let edit_start = edit.new.start.0;
6738 let edit_end = edit_start + (edit.old.end.0 - edit.old.start.0);
6739 let new_text = next_snapshot
6740 .text_for_range(edit.new.start.1..edit.new.end.1)
6741 .collect();
6742 lsp::TextDocumentContentChangeEvent {
6743 range: Some(lsp::Range::new(
6744 point_to_lsp(edit_start),
6745 point_to_lsp(edit_end),
6746 )),
6747 range_length: None,
6748 text: new_text,
6749 }
6750 })
6751 .collect()
6752 };
6753
6754 let document_sync_kind = language_server
6755 .capabilities()
6756 .text_document_sync
6757 .as_ref()
6758 .and_then(|sync| match sync {
6759 lsp::TextDocumentSyncCapability::Kind(kind) => Some(*kind),
6760 lsp::TextDocumentSyncCapability::Options(options) => options.change,
6761 });
6762
6763 let content_changes: Vec<_> = match document_sync_kind {
6764 Some(lsp::TextDocumentSyncKind::FULL) => {
6765 vec![lsp::TextDocumentContentChangeEvent {
6766 range: None,
6767 range_length: None,
6768 text: next_snapshot.text(),
6769 }]
6770 }
6771 Some(lsp::TextDocumentSyncKind::INCREMENTAL) => build_incremental_change(),
6772 _ => {
6773 #[cfg(any(test, feature = "test-support"))]
6774 {
6775 build_incremental_change()
6776 }
6777
6778 #[cfg(not(any(test, feature = "test-support")))]
6779 {
6780 continue;
6781 }
6782 }
6783 };
6784
6785 let next_version = previous_snapshot.version + 1;
6786 buffer_snapshots.push(LspBufferSnapshot {
6787 version: next_version,
6788 snapshot: next_snapshot.clone(),
6789 });
6790
6791 language_server
6792 .notify::<lsp::notification::DidChangeTextDocument>(
6793 &lsp::DidChangeTextDocumentParams {
6794 text_document: lsp::VersionedTextDocumentIdentifier::new(
6795 uri.clone(),
6796 next_version,
6797 ),
6798 content_changes,
6799 },
6800 )
6801 .ok();
6802 self.pull_workspace_diagnostics(language_server.server_id());
6803 }
6804
6805 None
6806 }
6807
6808 pub fn on_buffer_saved(
6809 &mut self,
6810 buffer: Entity<Buffer>,
6811 cx: &mut Context<Self>,
6812 ) -> Option<()> {
6813 let file = File::from_dyn(buffer.read(cx).file())?;
6814 let worktree_id = file.worktree_id(cx);
6815 let abs_path = file.as_local()?.abs_path(cx);
6816 let text_document = lsp::TextDocumentIdentifier {
6817 uri: file_path_to_lsp_url(&abs_path).log_err()?,
6818 };
6819 let local = self.as_local()?;
6820
6821 for server in local.language_servers_for_worktree(worktree_id) {
6822 if let Some(include_text) = include_text(server.as_ref()) {
6823 let text = if include_text {
6824 Some(buffer.read(cx).text())
6825 } else {
6826 None
6827 };
6828 server
6829 .notify::<lsp::notification::DidSaveTextDocument>(
6830 &lsp::DidSaveTextDocumentParams {
6831 text_document: text_document.clone(),
6832 text,
6833 },
6834 )
6835 .ok();
6836 }
6837 }
6838
6839 let language_servers = buffer.update(cx, |buffer, cx| {
6840 local.language_server_ids_for_buffer(buffer, cx)
6841 });
6842 for language_server_id in language_servers {
6843 self.simulate_disk_based_diagnostics_events_if_needed(language_server_id, cx);
6844 }
6845
6846 None
6847 }
6848
6849 pub(crate) async fn refresh_workspace_configurations(
6850 this: &WeakEntity<Self>,
6851 fs: Arc<dyn Fs>,
6852 cx: &mut AsyncApp,
6853 ) {
6854 maybe!(async move {
6855 let servers = this
6856 .update(cx, |this, cx| {
6857 let Some(local) = this.as_local() else {
6858 return Vec::default();
6859 };
6860 local
6861 .language_server_ids
6862 .iter()
6863 .flat_map(|((worktree_id, _), server_ids)| {
6864 let worktree = this
6865 .worktree_store
6866 .read(cx)
6867 .worktree_for_id(*worktree_id, cx);
6868 let delegate = worktree.map(|worktree| {
6869 LocalLspAdapterDelegate::new(
6870 local.languages.clone(),
6871 &local.environment,
6872 cx.weak_entity(),
6873 &worktree,
6874 local.http_client.clone(),
6875 local.fs.clone(),
6876 cx,
6877 )
6878 });
6879
6880 server_ids.iter().filter_map(move |server_id| {
6881 let states = local.language_servers.get(server_id)?;
6882
6883 match states {
6884 LanguageServerState::Starting { .. } => None,
6885 LanguageServerState::Running {
6886 adapter, server, ..
6887 } => Some((
6888 adapter.adapter.clone(),
6889 server.clone(),
6890 delegate.clone()? as Arc<dyn LspAdapterDelegate>,
6891 )),
6892 }
6893 })
6894 })
6895 .collect::<Vec<_>>()
6896 })
6897 .ok()?;
6898
6899 let toolchain_store = this.update(cx, |this, cx| this.toolchain_store(cx)).ok()?;
6900 for (adapter, server, delegate) in servers {
6901 let settings = LocalLspStore::workspace_configuration_for_adapter(
6902 adapter,
6903 fs.as_ref(),
6904 &delegate,
6905 toolchain_store.clone(),
6906 cx,
6907 )
6908 .await
6909 .ok()?;
6910
6911 server
6912 .notify::<lsp::notification::DidChangeConfiguration>(
6913 &lsp::DidChangeConfigurationParams { settings },
6914 )
6915 .ok();
6916 }
6917 Some(())
6918 })
6919 .await;
6920 }
6921
6922 fn toolchain_store(&self, cx: &App) -> Arc<dyn LanguageToolchainStore> {
6923 if let Some(toolchain_store) = self.toolchain_store.as_ref() {
6924 toolchain_store.read(cx).as_language_toolchain_store()
6925 } else {
6926 Arc::new(EmptyToolchainStore)
6927 }
6928 }
6929 fn maintain_workspace_config(
6930 fs: Arc<dyn Fs>,
6931 external_refresh_requests: watch::Receiver<()>,
6932 cx: &mut Context<Self>,
6933 ) -> Task<Result<()>> {
6934 let (mut settings_changed_tx, mut settings_changed_rx) = watch::channel();
6935 let _ = postage::stream::Stream::try_recv(&mut settings_changed_rx);
6936
6937 let settings_observation = cx.observe_global::<SettingsStore>(move |_, _| {
6938 *settings_changed_tx.borrow_mut() = ();
6939 });
6940
6941 let mut joint_future =
6942 futures::stream::select(settings_changed_rx, external_refresh_requests);
6943 cx.spawn(async move |this, cx| {
6944 while let Some(()) = joint_future.next().await {
6945 Self::refresh_workspace_configurations(&this, fs.clone(), cx).await;
6946 }
6947
6948 drop(settings_observation);
6949 anyhow::Ok(())
6950 })
6951 }
6952
6953 pub fn language_servers_for_local_buffer<'a>(
6954 &'a self,
6955 buffer: &Buffer,
6956 cx: &mut App,
6957 ) -> impl Iterator<Item = (&'a Arc<CachedLspAdapter>, &'a Arc<LanguageServer>)> {
6958 let local = self.as_local();
6959 let language_server_ids = local
6960 .map(|local| local.language_server_ids_for_buffer(buffer, cx))
6961 .unwrap_or_default();
6962
6963 language_server_ids
6964 .into_iter()
6965 .filter_map(
6966 move |server_id| match local?.language_servers.get(&server_id)? {
6967 LanguageServerState::Running {
6968 adapter, server, ..
6969 } => Some((adapter, server)),
6970 _ => None,
6971 },
6972 )
6973 }
6974
6975 pub fn language_server_for_local_buffer<'a>(
6976 &'a self,
6977 buffer: &'a Buffer,
6978 server_id: LanguageServerId,
6979 cx: &'a mut App,
6980 ) -> Option<(&'a Arc<CachedLspAdapter>, &'a Arc<LanguageServer>)> {
6981 self.as_local()?
6982 .language_servers_for_buffer(buffer, cx)
6983 .find(|(_, s)| s.server_id() == server_id)
6984 }
6985
6986 fn remove_worktree(&mut self, id_to_remove: WorktreeId, cx: &mut Context<Self>) {
6987 self.diagnostic_summaries.remove(&id_to_remove);
6988 if let Some(local) = self.as_local_mut() {
6989 let to_remove = local.remove_worktree(id_to_remove, cx);
6990 for server in to_remove {
6991 self.language_server_statuses.remove(&server);
6992 }
6993 }
6994 }
6995
6996 pub fn shared(
6997 &mut self,
6998 project_id: u64,
6999 downstream_client: AnyProtoClient,
7000 _: &mut Context<Self>,
7001 ) {
7002 self.downstream_client = Some((downstream_client.clone(), project_id));
7003
7004 for (server_id, status) in &self.language_server_statuses {
7005 downstream_client
7006 .send(proto::StartLanguageServer {
7007 project_id,
7008 server: Some(proto::LanguageServer {
7009 id: server_id.0 as u64,
7010 name: status.name.clone(),
7011 worktree_id: None,
7012 }),
7013 })
7014 .log_err();
7015 }
7016 }
7017
7018 pub fn disconnected_from_host(&mut self) {
7019 self.downstream_client.take();
7020 }
7021
7022 pub fn disconnected_from_ssh_remote(&mut self) {
7023 if let LspStoreMode::Remote(RemoteLspStore {
7024 upstream_client, ..
7025 }) = &mut self.mode
7026 {
7027 upstream_client.take();
7028 }
7029 }
7030
7031 pub(crate) fn set_language_server_statuses_from_proto(
7032 &mut self,
7033 language_servers: Vec<proto::LanguageServer>,
7034 ) {
7035 self.language_server_statuses = language_servers
7036 .into_iter()
7037 .map(|server| {
7038 (
7039 LanguageServerId(server.id as usize),
7040 LanguageServerStatus {
7041 name: server.name,
7042 pending_work: Default::default(),
7043 has_pending_diagnostic_updates: false,
7044 progress_tokens: Default::default(),
7045 },
7046 )
7047 })
7048 .collect();
7049 }
7050
7051 fn register_local_language_server(
7052 &mut self,
7053 worktree: Entity<Worktree>,
7054 language_server_name: LanguageServerName,
7055 language_server_id: LanguageServerId,
7056 cx: &mut App,
7057 ) {
7058 let Some(local) = self.as_local_mut() else {
7059 return;
7060 };
7061
7062 let worktree_id = worktree.read(cx).id();
7063 if worktree.read(cx).is_visible() {
7064 let path = ProjectPath {
7065 worktree_id,
7066 path: Arc::from("".as_ref()),
7067 };
7068 let delegate = Arc::new(ManifestQueryDelegate::new(worktree.read(cx).snapshot()));
7069 local.lsp_tree.update(cx, |language_server_tree, cx| {
7070 for node in language_server_tree.get(
7071 path,
7072 AdapterQuery::Adapter(&language_server_name),
7073 delegate,
7074 cx,
7075 ) {
7076 node.server_id_or_init(|disposition| {
7077 assert_eq!(disposition.server_name, &language_server_name);
7078
7079 language_server_id
7080 });
7081 }
7082 });
7083 }
7084
7085 local
7086 .language_server_ids
7087 .entry((worktree_id, language_server_name))
7088 .or_default()
7089 .insert(language_server_id);
7090 }
7091
7092 #[cfg(test)]
7093 pub fn update_diagnostic_entries(
7094 &mut self,
7095 server_id: LanguageServerId,
7096 abs_path: PathBuf,
7097 result_id: Option<String>,
7098 version: Option<i32>,
7099 diagnostics: Vec<DiagnosticEntry<Unclipped<PointUtf16>>>,
7100 cx: &mut Context<Self>,
7101 ) -> anyhow::Result<()> {
7102 self.merge_diagnostic_entries(
7103 server_id,
7104 abs_path,
7105 result_id,
7106 version,
7107 diagnostics,
7108 |_, _, _| false,
7109 cx,
7110 )
7111 }
7112
7113 pub fn merge_diagnostic_entries(
7114 &mut self,
7115 server_id: LanguageServerId,
7116 abs_path: PathBuf,
7117 result_id: Option<String>,
7118 version: Option<i32>,
7119 mut diagnostics: Vec<DiagnosticEntry<Unclipped<PointUtf16>>>,
7120 filter: impl Fn(&Buffer, &Diagnostic, &App) -> bool + Clone,
7121 cx: &mut Context<Self>,
7122 ) -> anyhow::Result<()> {
7123 let Some((worktree, relative_path)) =
7124 self.worktree_store.read(cx).find_worktree(&abs_path, cx)
7125 else {
7126 log::warn!("skipping diagnostics update, no worktree found for path {abs_path:?}");
7127 return Ok(());
7128 };
7129
7130 let project_path = ProjectPath {
7131 worktree_id: worktree.read(cx).id(),
7132 path: relative_path.into(),
7133 };
7134
7135 if let Some(buffer_handle) = self.buffer_store.read(cx).get_by_path(&project_path, cx) {
7136 let snapshot = buffer_handle.read(cx).snapshot();
7137 let buffer = buffer_handle.read(cx);
7138 let reused_diagnostics = buffer
7139 .get_diagnostics(server_id)
7140 .into_iter()
7141 .flat_map(|diag| {
7142 diag.iter()
7143 .filter(|v| filter(buffer, &v.diagnostic, cx))
7144 .map(|v| {
7145 let start = Unclipped(v.range.start.to_point_utf16(&snapshot));
7146 let end = Unclipped(v.range.end.to_point_utf16(&snapshot));
7147 DiagnosticEntry {
7148 range: start..end,
7149 diagnostic: v.diagnostic.clone(),
7150 }
7151 })
7152 })
7153 .collect::<Vec<_>>();
7154
7155 self.as_local_mut()
7156 .context("cannot merge diagnostics on a remote LspStore")?
7157 .update_buffer_diagnostics(
7158 &buffer_handle,
7159 server_id,
7160 result_id,
7161 version,
7162 diagnostics.clone(),
7163 reused_diagnostics.clone(),
7164 cx,
7165 )?;
7166
7167 diagnostics.extend(reused_diagnostics);
7168 }
7169
7170 let updated = worktree.update(cx, |worktree, cx| {
7171 self.update_worktree_diagnostics(
7172 worktree.id(),
7173 server_id,
7174 project_path.path.clone(),
7175 diagnostics,
7176 cx,
7177 )
7178 })?;
7179 if updated {
7180 cx.emit(LspStoreEvent::DiagnosticsUpdated {
7181 language_server_id: server_id,
7182 path: project_path,
7183 })
7184 }
7185 Ok(())
7186 }
7187
7188 fn update_worktree_diagnostics(
7189 &mut self,
7190 worktree_id: WorktreeId,
7191 server_id: LanguageServerId,
7192 worktree_path: Arc<Path>,
7193 diagnostics: Vec<DiagnosticEntry<Unclipped<PointUtf16>>>,
7194 _: &mut Context<Worktree>,
7195 ) -> Result<bool> {
7196 let local = match &mut self.mode {
7197 LspStoreMode::Local(local_lsp_store) => local_lsp_store,
7198 _ => anyhow::bail!("update_worktree_diagnostics called on remote"),
7199 };
7200
7201 let summaries_for_tree = self.diagnostic_summaries.entry(worktree_id).or_default();
7202 let diagnostics_for_tree = local.diagnostics.entry(worktree_id).or_default();
7203 let summaries_by_server_id = summaries_for_tree.entry(worktree_path.clone()).or_default();
7204
7205 let old_summary = summaries_by_server_id
7206 .remove(&server_id)
7207 .unwrap_or_default();
7208
7209 let new_summary = DiagnosticSummary::new(&diagnostics);
7210 if new_summary.is_empty() {
7211 if let Some(diagnostics_by_server_id) = diagnostics_for_tree.get_mut(&worktree_path) {
7212 if let Ok(ix) = diagnostics_by_server_id.binary_search_by_key(&server_id, |e| e.0) {
7213 diagnostics_by_server_id.remove(ix);
7214 }
7215 if diagnostics_by_server_id.is_empty() {
7216 diagnostics_for_tree.remove(&worktree_path);
7217 }
7218 }
7219 } else {
7220 summaries_by_server_id.insert(server_id, new_summary);
7221 let diagnostics_by_server_id = diagnostics_for_tree
7222 .entry(worktree_path.clone())
7223 .or_default();
7224 match diagnostics_by_server_id.binary_search_by_key(&server_id, |e| e.0) {
7225 Ok(ix) => {
7226 diagnostics_by_server_id[ix] = (server_id, diagnostics);
7227 }
7228 Err(ix) => {
7229 diagnostics_by_server_id.insert(ix, (server_id, diagnostics));
7230 }
7231 }
7232 }
7233
7234 if !old_summary.is_empty() || !new_summary.is_empty() {
7235 if let Some((downstream_client, project_id)) = &self.downstream_client {
7236 downstream_client
7237 .send(proto::UpdateDiagnosticSummary {
7238 project_id: *project_id,
7239 worktree_id: worktree_id.to_proto(),
7240 summary: Some(proto::DiagnosticSummary {
7241 path: worktree_path.to_proto(),
7242 language_server_id: server_id.0 as u64,
7243 error_count: new_summary.error_count as u32,
7244 warning_count: new_summary.warning_count as u32,
7245 }),
7246 })
7247 .log_err();
7248 }
7249 }
7250
7251 Ok(!old_summary.is_empty() || !new_summary.is_empty())
7252 }
7253
7254 pub fn open_buffer_for_symbol(
7255 &mut self,
7256 symbol: &Symbol,
7257 cx: &mut Context<Self>,
7258 ) -> Task<Result<Entity<Buffer>>> {
7259 if let Some((client, project_id)) = self.upstream_client() {
7260 let request = client.request(proto::OpenBufferForSymbol {
7261 project_id,
7262 symbol: Some(Self::serialize_symbol(symbol)),
7263 });
7264 cx.spawn(async move |this, cx| {
7265 let response = request.await?;
7266 let buffer_id = BufferId::new(response.buffer_id)?;
7267 this.update(cx, |this, cx| this.wait_for_remote_buffer(buffer_id, cx))?
7268 .await
7269 })
7270 } else if let Some(local) = self.as_local() {
7271 let Some(language_server_id) = local
7272 .language_server_ids
7273 .get(&(
7274 symbol.source_worktree_id,
7275 symbol.language_server_name.clone(),
7276 ))
7277 .and_then(|ids| {
7278 ids.contains(&symbol.source_language_server_id)
7279 .then_some(symbol.source_language_server_id)
7280 })
7281 else {
7282 return Task::ready(Err(anyhow!(
7283 "language server for worktree and language not found"
7284 )));
7285 };
7286
7287 let worktree_abs_path = if let Some(worktree_abs_path) = self
7288 .worktree_store
7289 .read(cx)
7290 .worktree_for_id(symbol.path.worktree_id, cx)
7291 .map(|worktree| worktree.read(cx).abs_path())
7292 {
7293 worktree_abs_path
7294 } else {
7295 return Task::ready(Err(anyhow!("worktree not found for symbol")));
7296 };
7297
7298 let symbol_abs_path = resolve_path(&worktree_abs_path, &symbol.path.path);
7299 let symbol_uri = if let Ok(uri) = lsp::Url::from_file_path(symbol_abs_path) {
7300 uri
7301 } else {
7302 return Task::ready(Err(anyhow!("invalid symbol path")));
7303 };
7304
7305 self.open_local_buffer_via_lsp(
7306 symbol_uri,
7307 language_server_id,
7308 symbol.language_server_name.clone(),
7309 cx,
7310 )
7311 } else {
7312 Task::ready(Err(anyhow!("no upstream client or local store")))
7313 }
7314 }
7315
7316 pub fn open_local_buffer_via_lsp(
7317 &mut self,
7318 mut abs_path: lsp::Url,
7319 language_server_id: LanguageServerId,
7320 language_server_name: LanguageServerName,
7321 cx: &mut Context<Self>,
7322 ) -> Task<Result<Entity<Buffer>>> {
7323 cx.spawn(async move |lsp_store, cx| {
7324 // Escape percent-encoded string.
7325 let current_scheme = abs_path.scheme().to_owned();
7326 let _ = abs_path.set_scheme("file");
7327
7328 let abs_path = abs_path
7329 .to_file_path()
7330 .map_err(|()| anyhow!("can't convert URI to path"))?;
7331 let p = abs_path.clone();
7332 let yarn_worktree = lsp_store
7333 .update(cx, move |lsp_store, cx| match lsp_store.as_local() {
7334 Some(local_lsp_store) => local_lsp_store.yarn.update(cx, |_, cx| {
7335 cx.spawn(async move |this, cx| {
7336 let t = this
7337 .update(cx, |this, cx| this.process_path(&p, ¤t_scheme, cx))
7338 .ok()?;
7339 t.await
7340 })
7341 }),
7342 None => Task::ready(None),
7343 })?
7344 .await;
7345 let (worktree_root_target, known_relative_path) =
7346 if let Some((zip_root, relative_path)) = yarn_worktree {
7347 (zip_root, Some(relative_path))
7348 } else {
7349 (Arc::<Path>::from(abs_path.as_path()), None)
7350 };
7351 let (worktree, relative_path) = if let Some(result) =
7352 lsp_store.update(cx, |lsp_store, cx| {
7353 lsp_store.worktree_store.update(cx, |worktree_store, cx| {
7354 worktree_store.find_worktree(&worktree_root_target, cx)
7355 })
7356 })? {
7357 let relative_path =
7358 known_relative_path.unwrap_or_else(|| Arc::<Path>::from(result.1));
7359 (result.0, relative_path)
7360 } else {
7361 let worktree = lsp_store
7362 .update(cx, |lsp_store, cx| {
7363 lsp_store.worktree_store.update(cx, |worktree_store, cx| {
7364 worktree_store.create_worktree(&worktree_root_target, false, cx)
7365 })
7366 })?
7367 .await?;
7368 if worktree.read_with(cx, |worktree, _| worktree.is_local())? {
7369 lsp_store
7370 .update(cx, |lsp_store, cx| {
7371 lsp_store.register_local_language_server(
7372 worktree.clone(),
7373 language_server_name,
7374 language_server_id,
7375 cx,
7376 )
7377 })
7378 .ok();
7379 }
7380 let worktree_root = worktree.read_with(cx, |worktree, _| worktree.abs_path())?;
7381 let relative_path = if let Some(known_path) = known_relative_path {
7382 known_path
7383 } else {
7384 abs_path.strip_prefix(worktree_root)?.into()
7385 };
7386 (worktree, relative_path)
7387 };
7388 let project_path = ProjectPath {
7389 worktree_id: worktree.read_with(cx, |worktree, _| worktree.id())?,
7390 path: relative_path,
7391 };
7392 lsp_store
7393 .update(cx, |lsp_store, cx| {
7394 lsp_store.buffer_store().update(cx, |buffer_store, cx| {
7395 buffer_store.open_buffer(project_path, cx)
7396 })
7397 })?
7398 .await
7399 })
7400 }
7401
7402 fn request_multiple_lsp_locally<P, R>(
7403 &mut self,
7404 buffer: &Entity<Buffer>,
7405 position: Option<P>,
7406 request: R,
7407 cx: &mut Context<Self>,
7408 ) -> Task<Vec<(LanguageServerId, R::Response)>>
7409 where
7410 P: ToOffset,
7411 R: LspCommand + Clone,
7412 <R::LspRequest as lsp::request::Request>::Result: Send,
7413 <R::LspRequest as lsp::request::Request>::Params: Send,
7414 {
7415 let Some(local) = self.as_local() else {
7416 return Task::ready(Vec::new());
7417 };
7418
7419 let snapshot = buffer.read(cx).snapshot();
7420 let scope = position.and_then(|position| snapshot.language_scope_at(position));
7421
7422 let server_ids = buffer.update(cx, |buffer, cx| {
7423 local
7424 .language_servers_for_buffer(buffer, cx)
7425 .filter(|(adapter, _)| {
7426 scope
7427 .as_ref()
7428 .map(|scope| scope.language_allowed(&adapter.name))
7429 .unwrap_or(true)
7430 })
7431 .map(|(_, server)| server.server_id())
7432 .filter(|server_id| {
7433 self.as_local().is_none_or(|local| {
7434 local
7435 .buffers_opened_in_servers
7436 .get(&snapshot.remote_id())
7437 .is_some_and(|servers| servers.contains(server_id))
7438 })
7439 })
7440 .collect::<Vec<_>>()
7441 });
7442
7443 let mut response_results = server_ids
7444 .into_iter()
7445 .map(|server_id| {
7446 let task = self.request_lsp(
7447 buffer.clone(),
7448 LanguageServerToQuery::Other(server_id),
7449 request.clone(),
7450 cx,
7451 );
7452 async move { (server_id, task.await) }
7453 })
7454 .collect::<FuturesUnordered<_>>();
7455
7456 cx.spawn(async move |_, _| {
7457 let mut responses = Vec::with_capacity(response_results.len());
7458 while let Some((server_id, response_result)) = response_results.next().await {
7459 if let Some(response) = response_result.log_err() {
7460 responses.push((server_id, response));
7461 }
7462 }
7463 responses
7464 })
7465 }
7466
7467 async fn handle_lsp_command<T: LspCommand>(
7468 this: Entity<Self>,
7469 envelope: TypedEnvelope<T::ProtoRequest>,
7470 mut cx: AsyncApp,
7471 ) -> Result<<T::ProtoRequest as proto::RequestMessage>::Response>
7472 where
7473 <T::LspRequest as lsp::request::Request>::Params: Send,
7474 <T::LspRequest as lsp::request::Request>::Result: Send,
7475 {
7476 let sender_id = envelope.original_sender_id().unwrap_or_default();
7477 let buffer_id = T::buffer_id_from_proto(&envelope.payload)?;
7478 let buffer_handle = this.update(&mut cx, |this, cx| {
7479 this.buffer_store.read(cx).get_existing(buffer_id)
7480 })??;
7481 let request = T::from_proto(
7482 envelope.payload,
7483 this.clone(),
7484 buffer_handle.clone(),
7485 cx.clone(),
7486 )
7487 .await?;
7488 let response = this
7489 .update(&mut cx, |this, cx| {
7490 this.request_lsp(
7491 buffer_handle.clone(),
7492 LanguageServerToQuery::FirstCapable,
7493 request,
7494 cx,
7495 )
7496 })?
7497 .await?;
7498 this.update(&mut cx, |this, cx| {
7499 Ok(T::response_to_proto(
7500 response,
7501 this,
7502 sender_id,
7503 &buffer_handle.read(cx).version(),
7504 cx,
7505 ))
7506 })?
7507 }
7508
7509 async fn handle_multi_lsp_query(
7510 lsp_store: Entity<Self>,
7511 envelope: TypedEnvelope<proto::MultiLspQuery>,
7512 mut cx: AsyncApp,
7513 ) -> Result<proto::MultiLspQueryResponse> {
7514 let response_from_ssh = lsp_store.read_with(&mut cx, |this, _| {
7515 let (upstream_client, project_id) = this.upstream_client()?;
7516 let mut payload = envelope.payload.clone();
7517 payload.project_id = project_id;
7518
7519 Some(upstream_client.request(payload))
7520 })?;
7521 if let Some(response_from_ssh) = response_from_ssh {
7522 return response_from_ssh.await;
7523 }
7524
7525 let sender_id = envelope.original_sender_id().unwrap_or_default();
7526 let buffer_id = BufferId::new(envelope.payload.buffer_id)?;
7527 let version = deserialize_version(&envelope.payload.version);
7528 let buffer = lsp_store.update(&mut cx, |this, cx| {
7529 this.buffer_store.read(cx).get_existing(buffer_id)
7530 })??;
7531 buffer
7532 .update(&mut cx, |buffer, _| {
7533 buffer.wait_for_version(version.clone())
7534 })?
7535 .await?;
7536 let buffer_version = buffer.read_with(&mut cx, |buffer, _| buffer.version())?;
7537 match envelope
7538 .payload
7539 .strategy
7540 .context("invalid request without the strategy")?
7541 {
7542 proto::multi_lsp_query::Strategy::All(_) => {
7543 // currently, there's only one multiple language servers query strategy,
7544 // so just ensure it's specified correctly
7545 }
7546 }
7547 match envelope.payload.request {
7548 Some(proto::multi_lsp_query::Request::GetHover(message)) => {
7549 buffer
7550 .update(&mut cx, |buffer, _| {
7551 buffer.wait_for_version(deserialize_version(&message.version))
7552 })?
7553 .await?;
7554 let get_hover =
7555 GetHover::from_proto(message, lsp_store.clone(), buffer.clone(), cx.clone())
7556 .await?;
7557 let all_hovers = lsp_store
7558 .update(&mut cx, |this, cx| {
7559 this.request_multiple_lsp_locally(
7560 &buffer,
7561 Some(get_hover.position),
7562 get_hover,
7563 cx,
7564 )
7565 })?
7566 .await
7567 .into_iter()
7568 .filter_map(|(server_id, hover)| {
7569 Some((server_id, remove_empty_hover_blocks(hover?)?))
7570 });
7571 lsp_store.update(&mut cx, |project, cx| proto::MultiLspQueryResponse {
7572 responses: all_hovers
7573 .map(|(server_id, hover)| proto::LspResponse {
7574 server_id: server_id.to_proto(),
7575 response: Some(proto::lsp_response::Response::GetHoverResponse(
7576 GetHover::response_to_proto(
7577 Some(hover),
7578 project,
7579 sender_id,
7580 &buffer_version,
7581 cx,
7582 ),
7583 )),
7584 })
7585 .collect(),
7586 })
7587 }
7588 Some(proto::multi_lsp_query::Request::GetCodeActions(message)) => {
7589 buffer
7590 .update(&mut cx, |buffer, _| {
7591 buffer.wait_for_version(deserialize_version(&message.version))
7592 })?
7593 .await?;
7594 let get_code_actions = GetCodeActions::from_proto(
7595 message,
7596 lsp_store.clone(),
7597 buffer.clone(),
7598 cx.clone(),
7599 )
7600 .await?;
7601
7602 let all_actions = lsp_store
7603 .update(&mut cx, |project, cx| {
7604 project.request_multiple_lsp_locally(
7605 &buffer,
7606 Some(get_code_actions.range.start),
7607 get_code_actions,
7608 cx,
7609 )
7610 })?
7611 .await
7612 .into_iter();
7613
7614 lsp_store.update(&mut cx, |project, cx| proto::MultiLspQueryResponse {
7615 responses: all_actions
7616 .map(|(server_id, code_actions)| proto::LspResponse {
7617 server_id: server_id.to_proto(),
7618 response: Some(proto::lsp_response::Response::GetCodeActionsResponse(
7619 GetCodeActions::response_to_proto(
7620 code_actions,
7621 project,
7622 sender_id,
7623 &buffer_version,
7624 cx,
7625 ),
7626 )),
7627 })
7628 .collect(),
7629 })
7630 }
7631 Some(proto::multi_lsp_query::Request::GetSignatureHelp(message)) => {
7632 buffer
7633 .update(&mut cx, |buffer, _| {
7634 buffer.wait_for_version(deserialize_version(&message.version))
7635 })?
7636 .await?;
7637 let get_signature_help = GetSignatureHelp::from_proto(
7638 message,
7639 lsp_store.clone(),
7640 buffer.clone(),
7641 cx.clone(),
7642 )
7643 .await?;
7644
7645 let all_signatures = lsp_store
7646 .update(&mut cx, |project, cx| {
7647 project.request_multiple_lsp_locally(
7648 &buffer,
7649 Some(get_signature_help.position),
7650 get_signature_help,
7651 cx,
7652 )
7653 })?
7654 .await
7655 .into_iter();
7656
7657 lsp_store.update(&mut cx, |project, cx| proto::MultiLspQueryResponse {
7658 responses: all_signatures
7659 .map(|(server_id, signature_help)| proto::LspResponse {
7660 server_id: server_id.to_proto(),
7661 response: Some(
7662 proto::lsp_response::Response::GetSignatureHelpResponse(
7663 GetSignatureHelp::response_to_proto(
7664 signature_help,
7665 project,
7666 sender_id,
7667 &buffer_version,
7668 cx,
7669 ),
7670 ),
7671 ),
7672 })
7673 .collect(),
7674 })
7675 }
7676 Some(proto::multi_lsp_query::Request::GetCodeLens(message)) => {
7677 buffer
7678 .update(&mut cx, |buffer, _| {
7679 buffer.wait_for_version(deserialize_version(&message.version))
7680 })?
7681 .await?;
7682 let get_code_lens =
7683 GetCodeLens::from_proto(message, lsp_store.clone(), buffer.clone(), cx.clone())
7684 .await?;
7685
7686 let code_lens_actions = lsp_store
7687 .update(&mut cx, |project, cx| {
7688 project.request_multiple_lsp_locally(
7689 &buffer,
7690 None::<usize>,
7691 get_code_lens,
7692 cx,
7693 )
7694 })?
7695 .await
7696 .into_iter();
7697
7698 lsp_store.update(&mut cx, |project, cx| proto::MultiLspQueryResponse {
7699 responses: code_lens_actions
7700 .map(|(server_id, actions)| proto::LspResponse {
7701 server_id: server_id.to_proto(),
7702 response: Some(proto::lsp_response::Response::GetCodeLensResponse(
7703 GetCodeLens::response_to_proto(
7704 actions,
7705 project,
7706 sender_id,
7707 &buffer_version,
7708 cx,
7709 ),
7710 )),
7711 })
7712 .collect(),
7713 })
7714 }
7715 Some(proto::multi_lsp_query::Request::GetDocumentDiagnostics(message)) => {
7716 buffer
7717 .update(&mut cx, |buffer, _| {
7718 buffer.wait_for_version(deserialize_version(&message.version))
7719 })?
7720 .await?;
7721 lsp_store
7722 .update(&mut cx, |lsp_store, cx| {
7723 lsp_store.pull_diagnostics_for_buffer(buffer, cx)
7724 })?
7725 .await?;
7726 // `pull_diagnostics_for_buffer` will merge in the new diagnostics and send them to the client.
7727 // The client cannot merge anything into its non-local LspStore, so we do not need to return anything.
7728 Ok(proto::MultiLspQueryResponse {
7729 responses: Vec::new(),
7730 })
7731 }
7732 Some(proto::multi_lsp_query::Request::GetDocumentColor(message)) => {
7733 buffer
7734 .update(&mut cx, |buffer, _| {
7735 buffer.wait_for_version(deserialize_version(&message.version))
7736 })?
7737 .await?;
7738 let get_document_color = GetDocumentColor::from_proto(
7739 message,
7740 lsp_store.clone(),
7741 buffer.clone(),
7742 cx.clone(),
7743 )
7744 .await?;
7745
7746 let all_colors = lsp_store
7747 .update(&mut cx, |project, cx| {
7748 project.request_multiple_lsp_locally(
7749 &buffer,
7750 None::<usize>,
7751 get_document_color,
7752 cx,
7753 )
7754 })?
7755 .await
7756 .into_iter();
7757
7758 lsp_store.update(&mut cx, |project, cx| proto::MultiLspQueryResponse {
7759 responses: all_colors
7760 .map(|(server_id, colors)| proto::LspResponse {
7761 server_id: server_id.to_proto(),
7762 response: Some(
7763 proto::lsp_response::Response::GetDocumentColorResponse(
7764 GetDocumentColor::response_to_proto(
7765 colors,
7766 project,
7767 sender_id,
7768 &buffer_version,
7769 cx,
7770 ),
7771 ),
7772 ),
7773 })
7774 .collect(),
7775 })
7776 }
7777 None => anyhow::bail!("empty multi lsp query request"),
7778 }
7779 }
7780
7781 async fn handle_apply_code_action(
7782 this: Entity<Self>,
7783 envelope: TypedEnvelope<proto::ApplyCodeAction>,
7784 mut cx: AsyncApp,
7785 ) -> Result<proto::ApplyCodeActionResponse> {
7786 let sender_id = envelope.original_sender_id().unwrap_or_default();
7787 let action =
7788 Self::deserialize_code_action(envelope.payload.action.context("invalid action")?)?;
7789 let apply_code_action = this.update(&mut cx, |this, cx| {
7790 let buffer_id = BufferId::new(envelope.payload.buffer_id)?;
7791 let buffer = this.buffer_store.read(cx).get_existing(buffer_id)?;
7792 anyhow::Ok(this.apply_code_action(buffer, action, false, cx))
7793 })??;
7794
7795 let project_transaction = apply_code_action.await?;
7796 let project_transaction = this.update(&mut cx, |this, cx| {
7797 this.buffer_store.update(cx, |buffer_store, cx| {
7798 buffer_store.serialize_project_transaction_for_peer(
7799 project_transaction,
7800 sender_id,
7801 cx,
7802 )
7803 })
7804 })?;
7805 Ok(proto::ApplyCodeActionResponse {
7806 transaction: Some(project_transaction),
7807 })
7808 }
7809
7810 async fn handle_register_buffer_with_language_servers(
7811 this: Entity<Self>,
7812 envelope: TypedEnvelope<proto::RegisterBufferWithLanguageServers>,
7813 mut cx: AsyncApp,
7814 ) -> Result<proto::Ack> {
7815 let buffer_id = BufferId::new(envelope.payload.buffer_id)?;
7816 let peer_id = envelope.original_sender_id.unwrap_or(envelope.sender_id);
7817 this.update(&mut cx, |this, cx| {
7818 if let Some((upstream_client, upstream_project_id)) = this.upstream_client() {
7819 return upstream_client.send(proto::RegisterBufferWithLanguageServers {
7820 project_id: upstream_project_id,
7821 buffer_id: buffer_id.to_proto(),
7822 });
7823 }
7824
7825 let Some(buffer) = this.buffer_store().read(cx).get(buffer_id) else {
7826 anyhow::bail!("buffer is not open");
7827 };
7828
7829 let handle = this.register_buffer_with_language_servers(&buffer, false, cx);
7830 this.buffer_store().update(cx, |buffer_store, _| {
7831 buffer_store.register_shared_lsp_handle(peer_id, buffer_id, handle);
7832 });
7833
7834 Ok(())
7835 })??;
7836 Ok(proto::Ack {})
7837 }
7838
7839 async fn handle_language_server_id_for_name(
7840 lsp_store: Entity<Self>,
7841 envelope: TypedEnvelope<proto::LanguageServerIdForName>,
7842 mut cx: AsyncApp,
7843 ) -> Result<proto::LanguageServerIdForNameResponse> {
7844 let name = &envelope.payload.name;
7845 let buffer_id = BufferId::new(envelope.payload.buffer_id)?;
7846 lsp_store
7847 .update(&mut cx, |lsp_store, cx| {
7848 let buffer = lsp_store.buffer_store.read(cx).get_existing(buffer_id)?;
7849 let server_id = buffer.update(cx, |buffer, cx| {
7850 lsp_store
7851 .language_servers_for_local_buffer(buffer, cx)
7852 .find_map(|(adapter, server)| {
7853 if adapter.name.0.as_ref() == name {
7854 Some(server.server_id())
7855 } else {
7856 None
7857 }
7858 })
7859 });
7860 Ok(server_id)
7861 })?
7862 .map(|server_id| proto::LanguageServerIdForNameResponse {
7863 server_id: server_id.map(|id| id.to_proto()),
7864 })
7865 }
7866
7867 async fn handle_rename_project_entry(
7868 this: Entity<Self>,
7869 envelope: TypedEnvelope<proto::RenameProjectEntry>,
7870 mut cx: AsyncApp,
7871 ) -> Result<proto::ProjectEntryResponse> {
7872 let entry_id = ProjectEntryId::from_proto(envelope.payload.entry_id);
7873 let (worktree_id, worktree, old_path, is_dir) = this
7874 .update(&mut cx, |this, cx| {
7875 this.worktree_store
7876 .read(cx)
7877 .worktree_and_entry_for_id(entry_id, cx)
7878 .map(|(worktree, entry)| {
7879 (
7880 worktree.read(cx).id(),
7881 worktree,
7882 entry.path.clone(),
7883 entry.is_dir(),
7884 )
7885 })
7886 })?
7887 .context("worktree not found")?;
7888 let (old_abs_path, new_abs_path) = {
7889 let root_path = worktree.read_with(&mut cx, |this, _| this.abs_path())?;
7890 let new_path = PathBuf::from_proto(envelope.payload.new_path.clone());
7891 (root_path.join(&old_path), root_path.join(&new_path))
7892 };
7893
7894 Self::will_rename_entry(
7895 this.downgrade(),
7896 worktree_id,
7897 &old_abs_path,
7898 &new_abs_path,
7899 is_dir,
7900 cx.clone(),
7901 )
7902 .await;
7903 let response = Worktree::handle_rename_entry(worktree, envelope.payload, cx.clone()).await;
7904 this.read_with(&mut cx, |this, _| {
7905 this.did_rename_entry(worktree_id, &old_abs_path, &new_abs_path, is_dir);
7906 })
7907 .ok();
7908 response
7909 }
7910
7911 async fn handle_update_diagnostic_summary(
7912 this: Entity<Self>,
7913 envelope: TypedEnvelope<proto::UpdateDiagnosticSummary>,
7914 mut cx: AsyncApp,
7915 ) -> Result<()> {
7916 this.update(&mut cx, |this, cx| {
7917 let worktree_id = WorktreeId::from_proto(envelope.payload.worktree_id);
7918 if let Some(message) = envelope.payload.summary {
7919 let project_path = ProjectPath {
7920 worktree_id,
7921 path: Arc::<Path>::from_proto(message.path),
7922 };
7923 let path = project_path.path.clone();
7924 let server_id = LanguageServerId(message.language_server_id as usize);
7925 let summary = DiagnosticSummary {
7926 error_count: message.error_count as usize,
7927 warning_count: message.warning_count as usize,
7928 };
7929
7930 if summary.is_empty() {
7931 if let Some(worktree_summaries) =
7932 this.diagnostic_summaries.get_mut(&worktree_id)
7933 {
7934 if let Some(summaries) = worktree_summaries.get_mut(&path) {
7935 summaries.remove(&server_id);
7936 if summaries.is_empty() {
7937 worktree_summaries.remove(&path);
7938 }
7939 }
7940 }
7941 } else {
7942 this.diagnostic_summaries
7943 .entry(worktree_id)
7944 .or_default()
7945 .entry(path)
7946 .or_default()
7947 .insert(server_id, summary);
7948 }
7949 if let Some((downstream_client, project_id)) = &this.downstream_client {
7950 downstream_client
7951 .send(proto::UpdateDiagnosticSummary {
7952 project_id: *project_id,
7953 worktree_id: worktree_id.to_proto(),
7954 summary: Some(proto::DiagnosticSummary {
7955 path: project_path.path.as_ref().to_proto(),
7956 language_server_id: server_id.0 as u64,
7957 error_count: summary.error_count as u32,
7958 warning_count: summary.warning_count as u32,
7959 }),
7960 })
7961 .log_err();
7962 }
7963 cx.emit(LspStoreEvent::DiagnosticsUpdated {
7964 language_server_id: LanguageServerId(message.language_server_id as usize),
7965 path: project_path,
7966 });
7967 }
7968 Ok(())
7969 })?
7970 }
7971
7972 async fn handle_start_language_server(
7973 this: Entity<Self>,
7974 envelope: TypedEnvelope<proto::StartLanguageServer>,
7975 mut cx: AsyncApp,
7976 ) -> Result<()> {
7977 let server = envelope.payload.server.context("invalid server")?;
7978
7979 this.update(&mut cx, |this, cx| {
7980 let server_id = LanguageServerId(server.id as usize);
7981 this.language_server_statuses.insert(
7982 server_id,
7983 LanguageServerStatus {
7984 name: server.name.clone(),
7985 pending_work: Default::default(),
7986 has_pending_diagnostic_updates: false,
7987 progress_tokens: Default::default(),
7988 },
7989 );
7990 cx.emit(LspStoreEvent::LanguageServerAdded(
7991 server_id,
7992 LanguageServerName(server.name.into()),
7993 server.worktree_id.map(WorktreeId::from_proto),
7994 ));
7995 cx.notify();
7996 })?;
7997 Ok(())
7998 }
7999
8000 async fn handle_update_language_server(
8001 this: Entity<Self>,
8002 envelope: TypedEnvelope<proto::UpdateLanguageServer>,
8003 mut cx: AsyncApp,
8004 ) -> Result<()> {
8005 this.update(&mut cx, |this, cx| {
8006 let language_server_id = LanguageServerId(envelope.payload.language_server_id as usize);
8007
8008 match envelope.payload.variant.context("invalid variant")? {
8009 proto::update_language_server::Variant::WorkStart(payload) => {
8010 this.on_lsp_work_start(
8011 language_server_id,
8012 payload.token,
8013 LanguageServerProgress {
8014 title: payload.title,
8015 is_disk_based_diagnostics_progress: false,
8016 is_cancellable: payload.is_cancellable.unwrap_or(false),
8017 message: payload.message,
8018 percentage: payload.percentage.map(|p| p as usize),
8019 last_update_at: cx.background_executor().now(),
8020 },
8021 cx,
8022 );
8023 }
8024
8025 proto::update_language_server::Variant::WorkProgress(payload) => {
8026 this.on_lsp_work_progress(
8027 language_server_id,
8028 payload.token,
8029 LanguageServerProgress {
8030 title: None,
8031 is_disk_based_diagnostics_progress: false,
8032 is_cancellable: payload.is_cancellable.unwrap_or(false),
8033 message: payload.message,
8034 percentage: payload.percentage.map(|p| p as usize),
8035 last_update_at: cx.background_executor().now(),
8036 },
8037 cx,
8038 );
8039 }
8040
8041 proto::update_language_server::Variant::WorkEnd(payload) => {
8042 this.on_lsp_work_end(language_server_id, payload.token, cx);
8043 }
8044
8045 proto::update_language_server::Variant::DiskBasedDiagnosticsUpdating(_) => {
8046 this.disk_based_diagnostics_started(language_server_id, cx);
8047 }
8048
8049 proto::update_language_server::Variant::DiskBasedDiagnosticsUpdated(_) => {
8050 this.disk_based_diagnostics_finished(language_server_id, cx)
8051 }
8052 }
8053
8054 Ok(())
8055 })?
8056 }
8057
8058 async fn handle_language_server_log(
8059 this: Entity<Self>,
8060 envelope: TypedEnvelope<proto::LanguageServerLog>,
8061 mut cx: AsyncApp,
8062 ) -> Result<()> {
8063 let language_server_id = LanguageServerId(envelope.payload.language_server_id as usize);
8064 let log_type = envelope
8065 .payload
8066 .log_type
8067 .map(LanguageServerLogType::from_proto)
8068 .context("invalid language server log type")?;
8069
8070 let message = envelope.payload.message;
8071
8072 this.update(&mut cx, |_, cx| {
8073 cx.emit(LspStoreEvent::LanguageServerLog(
8074 language_server_id,
8075 log_type,
8076 message,
8077 ));
8078 })
8079 }
8080
8081 async fn handle_lsp_ext_cancel_flycheck(
8082 lsp_store: Entity<Self>,
8083 envelope: TypedEnvelope<proto::LspExtCancelFlycheck>,
8084 mut cx: AsyncApp,
8085 ) -> Result<proto::Ack> {
8086 let server_id = LanguageServerId(envelope.payload.language_server_id as usize);
8087 lsp_store.read_with(&mut cx, |lsp_store, _| {
8088 if let Some(server) = lsp_store.language_server_for_id(server_id) {
8089 server
8090 .notify::<lsp_store::lsp_ext_command::LspExtCancelFlycheck>(&())
8091 .context("handling lsp ext cancel flycheck")
8092 } else {
8093 anyhow::Ok(())
8094 }
8095 })??;
8096
8097 Ok(proto::Ack {})
8098 }
8099
8100 async fn handle_lsp_ext_run_flycheck(
8101 lsp_store: Entity<Self>,
8102 envelope: TypedEnvelope<proto::LspExtRunFlycheck>,
8103 mut cx: AsyncApp,
8104 ) -> Result<proto::Ack> {
8105 let server_id = LanguageServerId(envelope.payload.language_server_id as usize);
8106 lsp_store.update(&mut cx, |lsp_store, cx| {
8107 if let Some(server) = lsp_store.language_server_for_id(server_id) {
8108 let text_document = if envelope.payload.current_file_only {
8109 let buffer_id = BufferId::new(envelope.payload.buffer_id)?;
8110 lsp_store
8111 .buffer_store()
8112 .read(cx)
8113 .get(buffer_id)
8114 .and_then(|buffer| Some(buffer.read(cx).file()?.as_local()?.abs_path(cx)))
8115 .map(|path| make_text_document_identifier(&path))
8116 .transpose()?
8117 } else {
8118 None
8119 };
8120 server
8121 .notify::<lsp_store::lsp_ext_command::LspExtRunFlycheck>(
8122 &lsp_store::lsp_ext_command::RunFlycheckParams { text_document },
8123 )
8124 .context("handling lsp ext run flycheck")
8125 } else {
8126 anyhow::Ok(())
8127 }
8128 })??;
8129
8130 Ok(proto::Ack {})
8131 }
8132
8133 async fn handle_lsp_ext_clear_flycheck(
8134 lsp_store: Entity<Self>,
8135 envelope: TypedEnvelope<proto::LspExtClearFlycheck>,
8136 mut cx: AsyncApp,
8137 ) -> Result<proto::Ack> {
8138 let server_id = LanguageServerId(envelope.payload.language_server_id as usize);
8139 lsp_store.read_with(&mut cx, |lsp_store, _| {
8140 if let Some(server) = lsp_store.language_server_for_id(server_id) {
8141 server
8142 .notify::<lsp_store::lsp_ext_command::LspExtClearFlycheck>(&())
8143 .context("handling lsp ext clear flycheck")
8144 } else {
8145 anyhow::Ok(())
8146 }
8147 })??;
8148
8149 Ok(proto::Ack {})
8150 }
8151
8152 pub fn disk_based_diagnostics_started(
8153 &mut self,
8154 language_server_id: LanguageServerId,
8155 cx: &mut Context<Self>,
8156 ) {
8157 if let Some(language_server_status) =
8158 self.language_server_statuses.get_mut(&language_server_id)
8159 {
8160 language_server_status.has_pending_diagnostic_updates = true;
8161 }
8162
8163 cx.emit(LspStoreEvent::DiskBasedDiagnosticsStarted { language_server_id });
8164 cx.emit(LspStoreEvent::LanguageServerUpdate {
8165 language_server_id,
8166 message: proto::update_language_server::Variant::DiskBasedDiagnosticsUpdating(
8167 Default::default(),
8168 ),
8169 })
8170 }
8171
8172 pub fn disk_based_diagnostics_finished(
8173 &mut self,
8174 language_server_id: LanguageServerId,
8175 cx: &mut Context<Self>,
8176 ) {
8177 if let Some(language_server_status) =
8178 self.language_server_statuses.get_mut(&language_server_id)
8179 {
8180 language_server_status.has_pending_diagnostic_updates = false;
8181 }
8182
8183 cx.emit(LspStoreEvent::DiskBasedDiagnosticsFinished { language_server_id });
8184 cx.emit(LspStoreEvent::LanguageServerUpdate {
8185 language_server_id,
8186 message: proto::update_language_server::Variant::DiskBasedDiagnosticsUpdated(
8187 Default::default(),
8188 ),
8189 })
8190 }
8191
8192 // After saving a buffer using a language server that doesn't provide a disk-based progress token,
8193 // kick off a timer that will reset every time the buffer is saved. If the timer eventually fires,
8194 // simulate disk-based diagnostics being finished so that other pieces of UI (e.g., project
8195 // diagnostics view, diagnostic status bar) can update. We don't emit an event right away because
8196 // the language server might take some time to publish diagnostics.
8197 fn simulate_disk_based_diagnostics_events_if_needed(
8198 &mut self,
8199 language_server_id: LanguageServerId,
8200 cx: &mut Context<Self>,
8201 ) {
8202 const DISK_BASED_DIAGNOSTICS_DEBOUNCE: Duration = Duration::from_secs(1);
8203
8204 let Some(LanguageServerState::Running {
8205 simulate_disk_based_diagnostics_completion,
8206 adapter,
8207 ..
8208 }) = self
8209 .as_local_mut()
8210 .and_then(|local_store| local_store.language_servers.get_mut(&language_server_id))
8211 else {
8212 return;
8213 };
8214
8215 if adapter.disk_based_diagnostics_progress_token.is_some() {
8216 return;
8217 }
8218
8219 let prev_task =
8220 simulate_disk_based_diagnostics_completion.replace(cx.spawn(async move |this, cx| {
8221 cx.background_executor()
8222 .timer(DISK_BASED_DIAGNOSTICS_DEBOUNCE)
8223 .await;
8224
8225 this.update(cx, |this, cx| {
8226 this.disk_based_diagnostics_finished(language_server_id, cx);
8227
8228 if let Some(LanguageServerState::Running {
8229 simulate_disk_based_diagnostics_completion,
8230 ..
8231 }) = this.as_local_mut().and_then(|local_store| {
8232 local_store.language_servers.get_mut(&language_server_id)
8233 }) {
8234 *simulate_disk_based_diagnostics_completion = None;
8235 }
8236 })
8237 .ok();
8238 }));
8239
8240 if prev_task.is_none() {
8241 self.disk_based_diagnostics_started(language_server_id, cx);
8242 }
8243 }
8244
8245 pub fn language_server_statuses(
8246 &self,
8247 ) -> impl DoubleEndedIterator<Item = (LanguageServerId, &LanguageServerStatus)> {
8248 self.language_server_statuses
8249 .iter()
8250 .map(|(key, value)| (*key, value))
8251 }
8252
8253 pub(super) fn did_rename_entry(
8254 &self,
8255 worktree_id: WorktreeId,
8256 old_path: &Path,
8257 new_path: &Path,
8258 is_dir: bool,
8259 ) {
8260 maybe!({
8261 let local_store = self.as_local()?;
8262
8263 let old_uri = lsp::Url::from_file_path(old_path).ok().map(String::from)?;
8264 let new_uri = lsp::Url::from_file_path(new_path).ok().map(String::from)?;
8265
8266 for language_server in local_store.language_servers_for_worktree(worktree_id) {
8267 let Some(filter) = local_store
8268 .language_server_paths_watched_for_rename
8269 .get(&language_server.server_id())
8270 else {
8271 continue;
8272 };
8273
8274 if filter.should_send_did_rename(&old_uri, is_dir) {
8275 language_server
8276 .notify::<DidRenameFiles>(&RenameFilesParams {
8277 files: vec![FileRename {
8278 old_uri: old_uri.clone(),
8279 new_uri: new_uri.clone(),
8280 }],
8281 })
8282 .ok();
8283 }
8284 }
8285 Some(())
8286 });
8287 }
8288
8289 pub(super) fn will_rename_entry(
8290 this: WeakEntity<Self>,
8291 worktree_id: WorktreeId,
8292 old_path: &Path,
8293 new_path: &Path,
8294 is_dir: bool,
8295 cx: AsyncApp,
8296 ) -> Task<()> {
8297 let old_uri = lsp::Url::from_file_path(old_path).ok().map(String::from);
8298 let new_uri = lsp::Url::from_file_path(new_path).ok().map(String::from);
8299 cx.spawn(async move |cx| {
8300 let mut tasks = vec![];
8301 this.update(cx, |this, cx| {
8302 let local_store = this.as_local()?;
8303 let old_uri = old_uri?;
8304 let new_uri = new_uri?;
8305 for language_server in local_store.language_servers_for_worktree(worktree_id) {
8306 let Some(filter) = local_store
8307 .language_server_paths_watched_for_rename
8308 .get(&language_server.server_id())
8309 else {
8310 continue;
8311 };
8312 let Some(adapter) =
8313 this.language_server_adapter_for_id(language_server.server_id())
8314 else {
8315 continue;
8316 };
8317 if filter.should_send_will_rename(&old_uri, is_dir) {
8318 let apply_edit = cx.spawn({
8319 let old_uri = old_uri.clone();
8320 let new_uri = new_uri.clone();
8321 let language_server = language_server.clone();
8322 async move |this, cx| {
8323 let edit = language_server
8324 .request::<WillRenameFiles>(RenameFilesParams {
8325 files: vec![FileRename { old_uri, new_uri }],
8326 })
8327 .await
8328 .into_response()
8329 .context("will rename files")
8330 .log_err()
8331 .flatten()?;
8332
8333 LocalLspStore::deserialize_workspace_edit(
8334 this.upgrade()?,
8335 edit,
8336 false,
8337 adapter.clone(),
8338 language_server.clone(),
8339 cx,
8340 )
8341 .await
8342 .ok();
8343 Some(())
8344 }
8345 });
8346 tasks.push(apply_edit);
8347 }
8348 }
8349 Some(())
8350 })
8351 .ok()
8352 .flatten();
8353 for task in tasks {
8354 // Await on tasks sequentially so that the order of application of edits is deterministic
8355 // (at least with regards to the order of registration of language servers)
8356 task.await;
8357 }
8358 })
8359 }
8360
8361 fn lsp_notify_abs_paths_changed(
8362 &mut self,
8363 server_id: LanguageServerId,
8364 changes: Vec<PathEvent>,
8365 ) {
8366 maybe!({
8367 let server = self.language_server_for_id(server_id)?;
8368 let changes = changes
8369 .into_iter()
8370 .filter_map(|event| {
8371 let typ = match event.kind? {
8372 PathEventKind::Created => lsp::FileChangeType::CREATED,
8373 PathEventKind::Removed => lsp::FileChangeType::DELETED,
8374 PathEventKind::Changed => lsp::FileChangeType::CHANGED,
8375 };
8376 Some(lsp::FileEvent {
8377 uri: file_path_to_lsp_url(&event.path).log_err()?,
8378 typ,
8379 })
8380 })
8381 .collect::<Vec<_>>();
8382 if !changes.is_empty() {
8383 server
8384 .notify::<lsp::notification::DidChangeWatchedFiles>(
8385 &lsp::DidChangeWatchedFilesParams { changes },
8386 )
8387 .ok();
8388 }
8389 Some(())
8390 });
8391 }
8392
8393 pub fn language_server_for_id(&self, id: LanguageServerId) -> Option<Arc<LanguageServer>> {
8394 let local_lsp_store = self.as_local()?;
8395 if let Some(LanguageServerState::Running { server, .. }) =
8396 local_lsp_store.language_servers.get(&id)
8397 {
8398 Some(server.clone())
8399 } else if let Some((_, server)) = local_lsp_store.supplementary_language_servers.get(&id) {
8400 Some(Arc::clone(server))
8401 } else {
8402 None
8403 }
8404 }
8405
8406 fn on_lsp_progress(
8407 &mut self,
8408 progress: lsp::ProgressParams,
8409 language_server_id: LanguageServerId,
8410 disk_based_diagnostics_progress_token: Option<String>,
8411 cx: &mut Context<Self>,
8412 ) {
8413 let token = match progress.token {
8414 lsp::NumberOrString::String(token) => token,
8415 lsp::NumberOrString::Number(token) => {
8416 log::info!("skipping numeric progress token {}", token);
8417 return;
8418 }
8419 };
8420
8421 let lsp::ProgressParamsValue::WorkDone(progress) = progress.value;
8422 let language_server_status =
8423 if let Some(status) = self.language_server_statuses.get_mut(&language_server_id) {
8424 status
8425 } else {
8426 return;
8427 };
8428
8429 if !language_server_status.progress_tokens.contains(&token) {
8430 return;
8431 }
8432
8433 let is_disk_based_diagnostics_progress = disk_based_diagnostics_progress_token
8434 .as_ref()
8435 .map_or(false, |disk_based_token| {
8436 token.starts_with(disk_based_token)
8437 });
8438
8439 match progress {
8440 lsp::WorkDoneProgress::Begin(report) => {
8441 if is_disk_based_diagnostics_progress {
8442 self.disk_based_diagnostics_started(language_server_id, cx);
8443 }
8444 self.on_lsp_work_start(
8445 language_server_id,
8446 token.clone(),
8447 LanguageServerProgress {
8448 title: Some(report.title),
8449 is_disk_based_diagnostics_progress,
8450 is_cancellable: report.cancellable.unwrap_or(false),
8451 message: report.message.clone(),
8452 percentage: report.percentage.map(|p| p as usize),
8453 last_update_at: cx.background_executor().now(),
8454 },
8455 cx,
8456 );
8457 }
8458 lsp::WorkDoneProgress::Report(report) => self.on_lsp_work_progress(
8459 language_server_id,
8460 token,
8461 LanguageServerProgress {
8462 title: None,
8463 is_disk_based_diagnostics_progress,
8464 is_cancellable: report.cancellable.unwrap_or(false),
8465 message: report.message,
8466 percentage: report.percentage.map(|p| p as usize),
8467 last_update_at: cx.background_executor().now(),
8468 },
8469 cx,
8470 ),
8471 lsp::WorkDoneProgress::End(_) => {
8472 language_server_status.progress_tokens.remove(&token);
8473 self.on_lsp_work_end(language_server_id, token.clone(), cx);
8474 if is_disk_based_diagnostics_progress {
8475 self.disk_based_diagnostics_finished(language_server_id, cx);
8476 }
8477 }
8478 }
8479 }
8480
8481 fn on_lsp_work_start(
8482 &mut self,
8483 language_server_id: LanguageServerId,
8484 token: String,
8485 progress: LanguageServerProgress,
8486 cx: &mut Context<Self>,
8487 ) {
8488 if let Some(status) = self.language_server_statuses.get_mut(&language_server_id) {
8489 status.pending_work.insert(token.clone(), progress.clone());
8490 cx.notify();
8491 }
8492 cx.emit(LspStoreEvent::LanguageServerUpdate {
8493 language_server_id,
8494 message: proto::update_language_server::Variant::WorkStart(proto::LspWorkStart {
8495 token,
8496 title: progress.title,
8497 message: progress.message,
8498 percentage: progress.percentage.map(|p| p as u32),
8499 is_cancellable: Some(progress.is_cancellable),
8500 }),
8501 })
8502 }
8503
8504 fn on_lsp_work_progress(
8505 &mut self,
8506 language_server_id: LanguageServerId,
8507 token: String,
8508 progress: LanguageServerProgress,
8509 cx: &mut Context<Self>,
8510 ) {
8511 let mut did_update = false;
8512 if let Some(status) = self.language_server_statuses.get_mut(&language_server_id) {
8513 match status.pending_work.entry(token.clone()) {
8514 btree_map::Entry::Vacant(entry) => {
8515 entry.insert(progress.clone());
8516 did_update = true;
8517 }
8518 btree_map::Entry::Occupied(mut entry) => {
8519 let entry = entry.get_mut();
8520 if (progress.last_update_at - entry.last_update_at)
8521 >= SERVER_PROGRESS_THROTTLE_TIMEOUT
8522 {
8523 entry.last_update_at = progress.last_update_at;
8524 if progress.message.is_some() {
8525 entry.message = progress.message.clone();
8526 }
8527 if progress.percentage.is_some() {
8528 entry.percentage = progress.percentage;
8529 }
8530 if progress.is_cancellable != entry.is_cancellable {
8531 entry.is_cancellable = progress.is_cancellable;
8532 }
8533 did_update = true;
8534 }
8535 }
8536 }
8537 }
8538
8539 if did_update {
8540 cx.emit(LspStoreEvent::LanguageServerUpdate {
8541 language_server_id,
8542 message: proto::update_language_server::Variant::WorkProgress(
8543 proto::LspWorkProgress {
8544 token,
8545 message: progress.message,
8546 percentage: progress.percentage.map(|p| p as u32),
8547 is_cancellable: Some(progress.is_cancellable),
8548 },
8549 ),
8550 })
8551 }
8552 }
8553
8554 fn on_lsp_work_end(
8555 &mut self,
8556 language_server_id: LanguageServerId,
8557 token: String,
8558 cx: &mut Context<Self>,
8559 ) {
8560 if let Some(status) = self.language_server_statuses.get_mut(&language_server_id) {
8561 if let Some(work) = status.pending_work.remove(&token) {
8562 if !work.is_disk_based_diagnostics_progress {
8563 cx.emit(LspStoreEvent::RefreshInlayHints);
8564 }
8565 }
8566 cx.notify();
8567 }
8568
8569 cx.emit(LspStoreEvent::LanguageServerUpdate {
8570 language_server_id,
8571 message: proto::update_language_server::Variant::WorkEnd(proto::LspWorkEnd { token }),
8572 })
8573 }
8574
8575 pub async fn handle_resolve_completion_documentation(
8576 this: Entity<Self>,
8577 envelope: TypedEnvelope<proto::ResolveCompletionDocumentation>,
8578 mut cx: AsyncApp,
8579 ) -> Result<proto::ResolveCompletionDocumentationResponse> {
8580 let lsp_completion = serde_json::from_slice(&envelope.payload.lsp_completion)?;
8581
8582 let completion = this
8583 .read_with(&cx, |this, cx| {
8584 let id = LanguageServerId(envelope.payload.language_server_id as usize);
8585 let server = this
8586 .language_server_for_id(id)
8587 .with_context(|| format!("No language server {id}"))?;
8588
8589 anyhow::Ok(cx.background_spawn(async move {
8590 let can_resolve = server
8591 .capabilities()
8592 .completion_provider
8593 .as_ref()
8594 .and_then(|options| options.resolve_provider)
8595 .unwrap_or(false);
8596 if can_resolve {
8597 server
8598 .request::<lsp::request::ResolveCompletionItem>(lsp_completion)
8599 .await
8600 .into_response()
8601 .context("resolve completion item")
8602 } else {
8603 anyhow::Ok(lsp_completion)
8604 }
8605 }))
8606 })??
8607 .await?;
8608
8609 let mut documentation_is_markdown = false;
8610 let lsp_completion = serde_json::to_string(&completion)?.into_bytes();
8611 let documentation = match completion.documentation {
8612 Some(lsp::Documentation::String(text)) => text,
8613
8614 Some(lsp::Documentation::MarkupContent(lsp::MarkupContent { kind, value })) => {
8615 documentation_is_markdown = kind == lsp::MarkupKind::Markdown;
8616 value
8617 }
8618
8619 _ => String::new(),
8620 };
8621
8622 // If we have a new buffer_id, that means we're talking to a new client
8623 // and want to check for new text_edits in the completion too.
8624 let mut old_replace_start = None;
8625 let mut old_replace_end = None;
8626 let mut old_insert_start = None;
8627 let mut old_insert_end = None;
8628 let mut new_text = String::default();
8629 if let Ok(buffer_id) = BufferId::new(envelope.payload.buffer_id) {
8630 let buffer_snapshot = this.update(&mut cx, |this, cx| {
8631 let buffer = this.buffer_store.read(cx).get_existing(buffer_id)?;
8632 anyhow::Ok(buffer.read(cx).snapshot())
8633 })??;
8634
8635 if let Some(text_edit) = completion.text_edit.as_ref() {
8636 let edit = parse_completion_text_edit(text_edit, &buffer_snapshot);
8637
8638 if let Some(mut edit) = edit {
8639 LineEnding::normalize(&mut edit.new_text);
8640
8641 new_text = edit.new_text;
8642 old_replace_start = Some(serialize_anchor(&edit.replace_range.start));
8643 old_replace_end = Some(serialize_anchor(&edit.replace_range.end));
8644 if let Some(insert_range) = edit.insert_range {
8645 old_insert_start = Some(serialize_anchor(&insert_range.start));
8646 old_insert_end = Some(serialize_anchor(&insert_range.end));
8647 }
8648 }
8649 }
8650 }
8651
8652 Ok(proto::ResolveCompletionDocumentationResponse {
8653 documentation,
8654 documentation_is_markdown,
8655 old_replace_start,
8656 old_replace_end,
8657 new_text,
8658 lsp_completion,
8659 old_insert_start,
8660 old_insert_end,
8661 })
8662 }
8663
8664 async fn handle_on_type_formatting(
8665 this: Entity<Self>,
8666 envelope: TypedEnvelope<proto::OnTypeFormatting>,
8667 mut cx: AsyncApp,
8668 ) -> Result<proto::OnTypeFormattingResponse> {
8669 let on_type_formatting = this.update(&mut cx, |this, cx| {
8670 let buffer_id = BufferId::new(envelope.payload.buffer_id)?;
8671 let buffer = this.buffer_store.read(cx).get_existing(buffer_id)?;
8672 let position = envelope
8673 .payload
8674 .position
8675 .and_then(deserialize_anchor)
8676 .context("invalid position")?;
8677 anyhow::Ok(this.apply_on_type_formatting(
8678 buffer,
8679 position,
8680 envelope.payload.trigger.clone(),
8681 cx,
8682 ))
8683 })??;
8684
8685 let transaction = on_type_formatting
8686 .await?
8687 .as_ref()
8688 .map(language::proto::serialize_transaction);
8689 Ok(proto::OnTypeFormattingResponse { transaction })
8690 }
8691
8692 async fn handle_refresh_inlay_hints(
8693 this: Entity<Self>,
8694 _: TypedEnvelope<proto::RefreshInlayHints>,
8695 mut cx: AsyncApp,
8696 ) -> Result<proto::Ack> {
8697 this.update(&mut cx, |_, cx| {
8698 cx.emit(LspStoreEvent::RefreshInlayHints);
8699 })?;
8700 Ok(proto::Ack {})
8701 }
8702
8703 async fn handle_pull_workspace_diagnostics(
8704 lsp_store: Entity<Self>,
8705 envelope: TypedEnvelope<proto::PullWorkspaceDiagnostics>,
8706 mut cx: AsyncApp,
8707 ) -> Result<proto::Ack> {
8708 let server_id = LanguageServerId::from_proto(envelope.payload.server_id);
8709 lsp_store.update(&mut cx, |lsp_store, _| {
8710 lsp_store.pull_workspace_diagnostics(server_id);
8711 })?;
8712 Ok(proto::Ack {})
8713 }
8714
8715 async fn handle_inlay_hints(
8716 this: Entity<Self>,
8717 envelope: TypedEnvelope<proto::InlayHints>,
8718 mut cx: AsyncApp,
8719 ) -> Result<proto::InlayHintsResponse> {
8720 let sender_id = envelope.original_sender_id().unwrap_or_default();
8721 let buffer_id = BufferId::new(envelope.payload.buffer_id)?;
8722 let buffer = this.update(&mut cx, |this, cx| {
8723 this.buffer_store.read(cx).get_existing(buffer_id)
8724 })??;
8725 buffer
8726 .update(&mut cx, |buffer, _| {
8727 buffer.wait_for_version(deserialize_version(&envelope.payload.version))
8728 })?
8729 .await
8730 .with_context(|| format!("waiting for version for buffer {}", buffer.entity_id()))?;
8731
8732 let start = envelope
8733 .payload
8734 .start
8735 .and_then(deserialize_anchor)
8736 .context("missing range start")?;
8737 let end = envelope
8738 .payload
8739 .end
8740 .and_then(deserialize_anchor)
8741 .context("missing range end")?;
8742 let buffer_hints = this
8743 .update(&mut cx, |lsp_store, cx| {
8744 lsp_store.inlay_hints(buffer.clone(), start..end, cx)
8745 })?
8746 .await
8747 .context("inlay hints fetch")?;
8748
8749 this.update(&mut cx, |project, cx| {
8750 InlayHints::response_to_proto(
8751 buffer_hints,
8752 project,
8753 sender_id,
8754 &buffer.read(cx).version(),
8755 cx,
8756 )
8757 })
8758 }
8759
8760 async fn handle_get_color_presentation(
8761 lsp_store: Entity<Self>,
8762 envelope: TypedEnvelope<proto::GetColorPresentation>,
8763 mut cx: AsyncApp,
8764 ) -> Result<proto::GetColorPresentationResponse> {
8765 let buffer_id = BufferId::new(envelope.payload.buffer_id)?;
8766 let buffer = lsp_store.update(&mut cx, |lsp_store, cx| {
8767 lsp_store.buffer_store.read(cx).get_existing(buffer_id)
8768 })??;
8769
8770 let color = envelope
8771 .payload
8772 .color
8773 .context("invalid color resolve request")?;
8774 let start = color
8775 .lsp_range_start
8776 .context("invalid color resolve request")?;
8777 let end = color
8778 .lsp_range_end
8779 .context("invalid color resolve request")?;
8780
8781 let color = DocumentColor {
8782 lsp_range: lsp::Range {
8783 start: point_to_lsp(PointUtf16::new(start.row, start.column)),
8784 end: point_to_lsp(PointUtf16::new(end.row, end.column)),
8785 },
8786 color: lsp::Color {
8787 red: color.red,
8788 green: color.green,
8789 blue: color.blue,
8790 alpha: color.alpha,
8791 },
8792 resolved: false,
8793 color_presentations: Vec::new(),
8794 };
8795 let resolved_color = lsp_store
8796 .update(&mut cx, |lsp_store, cx| {
8797 lsp_store.resolve_color_presentation(
8798 color,
8799 buffer.clone(),
8800 LanguageServerId(envelope.payload.server_id as usize),
8801 cx,
8802 )
8803 })?
8804 .await
8805 .context("resolving color presentation")?;
8806
8807 Ok(proto::GetColorPresentationResponse {
8808 presentations: resolved_color
8809 .color_presentations
8810 .into_iter()
8811 .map(|presentation| proto::ColorPresentation {
8812 label: presentation.label.to_string(),
8813 text_edit: presentation.text_edit.map(serialize_lsp_edit),
8814 additional_text_edits: presentation
8815 .additional_text_edits
8816 .into_iter()
8817 .map(serialize_lsp_edit)
8818 .collect(),
8819 })
8820 .collect(),
8821 })
8822 }
8823
8824 async fn handle_resolve_inlay_hint(
8825 this: Entity<Self>,
8826 envelope: TypedEnvelope<proto::ResolveInlayHint>,
8827 mut cx: AsyncApp,
8828 ) -> Result<proto::ResolveInlayHintResponse> {
8829 let proto_hint = envelope
8830 .payload
8831 .hint
8832 .expect("incorrect protobuf resolve inlay hint message: missing the inlay hint");
8833 let hint = InlayHints::proto_to_project_hint(proto_hint)
8834 .context("resolved proto inlay hint conversion")?;
8835 let buffer = this.update(&mut cx, |this, cx| {
8836 let buffer_id = BufferId::new(envelope.payload.buffer_id)?;
8837 this.buffer_store.read(cx).get_existing(buffer_id)
8838 })??;
8839 let response_hint = this
8840 .update(&mut cx, |this, cx| {
8841 this.resolve_inlay_hint(
8842 hint,
8843 buffer,
8844 LanguageServerId(envelope.payload.language_server_id as usize),
8845 cx,
8846 )
8847 })?
8848 .await
8849 .context("inlay hints fetch")?;
8850 Ok(proto::ResolveInlayHintResponse {
8851 hint: Some(InlayHints::project_to_proto_hint(response_hint)),
8852 })
8853 }
8854
8855 async fn handle_refresh_code_lens(
8856 this: Entity<Self>,
8857 _: TypedEnvelope<proto::RefreshCodeLens>,
8858 mut cx: AsyncApp,
8859 ) -> Result<proto::Ack> {
8860 this.update(&mut cx, |_, cx| {
8861 cx.emit(LspStoreEvent::RefreshCodeLens);
8862 })?;
8863 Ok(proto::Ack {})
8864 }
8865
8866 async fn handle_open_buffer_for_symbol(
8867 this: Entity<Self>,
8868 envelope: TypedEnvelope<proto::OpenBufferForSymbol>,
8869 mut cx: AsyncApp,
8870 ) -> Result<proto::OpenBufferForSymbolResponse> {
8871 let peer_id = envelope.original_sender_id().unwrap_or_default();
8872 let symbol = envelope.payload.symbol.context("invalid symbol")?;
8873 let symbol = Self::deserialize_symbol(symbol)?;
8874 let symbol = this.read_with(&mut cx, |this, _| {
8875 let signature = this.symbol_signature(&symbol.path);
8876 anyhow::ensure!(signature == symbol.signature, "invalid symbol signature");
8877 Ok(symbol)
8878 })??;
8879 let buffer = this
8880 .update(&mut cx, |this, cx| {
8881 this.open_buffer_for_symbol(
8882 &Symbol {
8883 language_server_name: symbol.language_server_name,
8884 source_worktree_id: symbol.source_worktree_id,
8885 source_language_server_id: symbol.source_language_server_id,
8886 path: symbol.path,
8887 name: symbol.name,
8888 kind: symbol.kind,
8889 range: symbol.range,
8890 signature: symbol.signature,
8891 label: CodeLabel {
8892 text: Default::default(),
8893 runs: Default::default(),
8894 filter_range: Default::default(),
8895 },
8896 },
8897 cx,
8898 )
8899 })?
8900 .await?;
8901
8902 this.update(&mut cx, |this, cx| {
8903 let is_private = buffer
8904 .read(cx)
8905 .file()
8906 .map(|f| f.is_private())
8907 .unwrap_or_default();
8908 if is_private {
8909 Err(anyhow!(rpc::ErrorCode::UnsharedItem))
8910 } else {
8911 this.buffer_store
8912 .update(cx, |buffer_store, cx| {
8913 buffer_store.create_buffer_for_peer(&buffer, peer_id, cx)
8914 })
8915 .detach_and_log_err(cx);
8916 let buffer_id = buffer.read(cx).remote_id().to_proto();
8917 Ok(proto::OpenBufferForSymbolResponse { buffer_id })
8918 }
8919 })?
8920 }
8921
8922 fn symbol_signature(&self, project_path: &ProjectPath) -> [u8; 32] {
8923 let mut hasher = Sha256::new();
8924 hasher.update(project_path.worktree_id.to_proto().to_be_bytes());
8925 hasher.update(project_path.path.to_string_lossy().as_bytes());
8926 hasher.update(self.nonce.to_be_bytes());
8927 hasher.finalize().as_slice().try_into().unwrap()
8928 }
8929
8930 pub async fn handle_get_project_symbols(
8931 this: Entity<Self>,
8932 envelope: TypedEnvelope<proto::GetProjectSymbols>,
8933 mut cx: AsyncApp,
8934 ) -> Result<proto::GetProjectSymbolsResponse> {
8935 let symbols = this
8936 .update(&mut cx, |this, cx| {
8937 this.symbols(&envelope.payload.query, cx)
8938 })?
8939 .await?;
8940
8941 Ok(proto::GetProjectSymbolsResponse {
8942 symbols: symbols.iter().map(Self::serialize_symbol).collect(),
8943 })
8944 }
8945
8946 pub async fn handle_restart_language_servers(
8947 this: Entity<Self>,
8948 envelope: TypedEnvelope<proto::RestartLanguageServers>,
8949 mut cx: AsyncApp,
8950 ) -> Result<proto::Ack> {
8951 this.update(&mut cx, |this, cx| {
8952 let buffers = this.buffer_ids_to_buffers(envelope.payload.buffer_ids.into_iter(), cx);
8953 this.restart_language_servers_for_buffers(buffers, cx);
8954 })?;
8955
8956 Ok(proto::Ack {})
8957 }
8958
8959 pub async fn handle_stop_language_servers(
8960 this: Entity<Self>,
8961 envelope: TypedEnvelope<proto::StopLanguageServers>,
8962 mut cx: AsyncApp,
8963 ) -> Result<proto::Ack> {
8964 this.update(&mut cx, |this, cx| {
8965 let buffers = this.buffer_ids_to_buffers(envelope.payload.buffer_ids.into_iter(), cx);
8966 this.stop_language_servers_for_buffers(buffers, cx);
8967 })?;
8968
8969 Ok(proto::Ack {})
8970 }
8971
8972 pub async fn handle_cancel_language_server_work(
8973 this: Entity<Self>,
8974 envelope: TypedEnvelope<proto::CancelLanguageServerWork>,
8975 mut cx: AsyncApp,
8976 ) -> Result<proto::Ack> {
8977 this.update(&mut cx, |this, cx| {
8978 if let Some(work) = envelope.payload.work {
8979 match work {
8980 proto::cancel_language_server_work::Work::Buffers(buffers) => {
8981 let buffers =
8982 this.buffer_ids_to_buffers(buffers.buffer_ids.into_iter(), cx);
8983 this.cancel_language_server_work_for_buffers(buffers, cx);
8984 }
8985 proto::cancel_language_server_work::Work::LanguageServerWork(work) => {
8986 let server_id = LanguageServerId::from_proto(work.language_server_id);
8987 this.cancel_language_server_work(server_id, work.token, cx);
8988 }
8989 }
8990 }
8991 })?;
8992
8993 Ok(proto::Ack {})
8994 }
8995
8996 fn buffer_ids_to_buffers(
8997 &mut self,
8998 buffer_ids: impl Iterator<Item = u64>,
8999 cx: &mut Context<Self>,
9000 ) -> Vec<Entity<Buffer>> {
9001 buffer_ids
9002 .into_iter()
9003 .flat_map(|buffer_id| {
9004 self.buffer_store
9005 .read(cx)
9006 .get(BufferId::new(buffer_id).log_err()?)
9007 })
9008 .collect::<Vec<_>>()
9009 }
9010
9011 async fn handle_apply_additional_edits_for_completion(
9012 this: Entity<Self>,
9013 envelope: TypedEnvelope<proto::ApplyCompletionAdditionalEdits>,
9014 mut cx: AsyncApp,
9015 ) -> Result<proto::ApplyCompletionAdditionalEditsResponse> {
9016 let (buffer, completion) = this.update(&mut cx, |this, cx| {
9017 let buffer_id = BufferId::new(envelope.payload.buffer_id)?;
9018 let buffer = this.buffer_store.read(cx).get_existing(buffer_id)?;
9019 let completion = Self::deserialize_completion(
9020 envelope.payload.completion.context("invalid completion")?,
9021 )?;
9022 anyhow::Ok((buffer, completion))
9023 })??;
9024
9025 let apply_additional_edits = this.update(&mut cx, |this, cx| {
9026 this.apply_additional_edits_for_completion(
9027 buffer,
9028 Rc::new(RefCell::new(Box::new([Completion {
9029 replace_range: completion.replace_range,
9030 new_text: completion.new_text,
9031 source: completion.source,
9032 documentation: None,
9033 label: CodeLabel {
9034 text: Default::default(),
9035 runs: Default::default(),
9036 filter_range: Default::default(),
9037 },
9038 insert_text_mode: None,
9039 icon_path: None,
9040 confirm: None,
9041 }]))),
9042 0,
9043 false,
9044 cx,
9045 )
9046 })?;
9047
9048 Ok(proto::ApplyCompletionAdditionalEditsResponse {
9049 transaction: apply_additional_edits
9050 .await?
9051 .as_ref()
9052 .map(language::proto::serialize_transaction),
9053 })
9054 }
9055
9056 pub fn last_formatting_failure(&self) -> Option<&str> {
9057 self.last_formatting_failure.as_deref()
9058 }
9059
9060 pub fn reset_last_formatting_failure(&mut self) {
9061 self.last_formatting_failure = None;
9062 }
9063
9064 pub fn environment_for_buffer(
9065 &self,
9066 buffer: &Entity<Buffer>,
9067 cx: &mut Context<Self>,
9068 ) -> Shared<Task<Option<HashMap<String, String>>>> {
9069 if let Some(environment) = &self.as_local().map(|local| local.environment.clone()) {
9070 environment.update(cx, |env, cx| {
9071 env.get_buffer_environment(&buffer, &self.worktree_store, cx)
9072 })
9073 } else {
9074 Task::ready(None).shared()
9075 }
9076 }
9077
9078 pub fn format(
9079 &mut self,
9080 buffers: HashSet<Entity<Buffer>>,
9081 target: LspFormatTarget,
9082 push_to_history: bool,
9083 trigger: FormatTrigger,
9084 cx: &mut Context<Self>,
9085 ) -> Task<anyhow::Result<ProjectTransaction>> {
9086 let logger = zlog::scoped!("format");
9087 if let Some(_) = self.as_local() {
9088 zlog::trace!(logger => "Formatting locally");
9089 let logger = zlog::scoped!(logger => "local");
9090 let buffers = buffers
9091 .into_iter()
9092 .map(|buffer_handle| {
9093 let buffer = buffer_handle.read(cx);
9094 let buffer_abs_path = File::from_dyn(buffer.file())
9095 .and_then(|file| file.as_local().map(|f| f.abs_path(cx)));
9096
9097 (buffer_handle, buffer_abs_path, buffer.remote_id())
9098 })
9099 .collect::<Vec<_>>();
9100
9101 cx.spawn(async move |lsp_store, cx| {
9102 let mut formattable_buffers = Vec::with_capacity(buffers.len());
9103
9104 for (handle, abs_path, id) in buffers {
9105 let env = lsp_store
9106 .update(cx, |lsp_store, cx| {
9107 lsp_store.environment_for_buffer(&handle, cx)
9108 })?
9109 .await;
9110
9111 let ranges = match &target {
9112 LspFormatTarget::Buffers => None,
9113 LspFormatTarget::Ranges(ranges) => {
9114 Some(ranges.get(&id).context("No format ranges provided for buffer")?.clone())
9115 }
9116 };
9117
9118 formattable_buffers.push(FormattableBuffer {
9119 handle,
9120 abs_path,
9121 env,
9122 ranges,
9123 });
9124 }
9125 zlog::trace!(logger => "Formatting {:?} buffers", formattable_buffers.len());
9126
9127 let format_timer = zlog::time!(logger => "Formatting buffers");
9128 let result = LocalLspStore::format_locally(
9129 lsp_store.clone(),
9130 formattable_buffers,
9131 push_to_history,
9132 trigger,
9133 logger,
9134 cx,
9135 )
9136 .await;
9137 format_timer.end();
9138
9139 zlog::trace!(logger => "Formatting completed with result {:?}", result.as_ref().map(|_| "<project-transaction>"));
9140
9141 lsp_store.update(cx, |lsp_store, _| {
9142 lsp_store.update_last_formatting_failure(&result);
9143 })?;
9144
9145 result
9146 })
9147 } else if let Some((client, project_id)) = self.upstream_client() {
9148 zlog::trace!(logger => "Formatting remotely");
9149 let logger = zlog::scoped!(logger => "remote");
9150 // Don't support formatting ranges via remote
9151 match target {
9152 LspFormatTarget::Buffers => {}
9153 LspFormatTarget::Ranges(_) => {
9154 zlog::trace!(logger => "Ignoring unsupported remote range formatting request");
9155 return Task::ready(Ok(ProjectTransaction::default()));
9156 }
9157 }
9158
9159 let buffer_store = self.buffer_store();
9160 cx.spawn(async move |lsp_store, cx| {
9161 zlog::trace!(logger => "Sending remote format request");
9162 let request_timer = zlog::time!(logger => "remote format request");
9163 let result = client
9164 .request(proto::FormatBuffers {
9165 project_id,
9166 trigger: trigger as i32,
9167 buffer_ids: buffers
9168 .iter()
9169 .map(|buffer| buffer.read_with(cx, |buffer, _| buffer.remote_id().into()))
9170 .collect::<Result<_>>()?,
9171 })
9172 .await
9173 .and_then(|result| result.transaction.context("missing transaction"));
9174 request_timer.end();
9175
9176 zlog::trace!(logger => "Remote format request resolved to {:?}", result.as_ref().map(|_| "<project_transaction>"));
9177
9178 lsp_store.update(cx, |lsp_store, _| {
9179 lsp_store.update_last_formatting_failure(&result);
9180 })?;
9181
9182 let transaction_response = result?;
9183 let _timer = zlog::time!(logger => "deserializing project transaction");
9184 buffer_store
9185 .update(cx, |buffer_store, cx| {
9186 buffer_store.deserialize_project_transaction(
9187 transaction_response,
9188 push_to_history,
9189 cx,
9190 )
9191 })?
9192 .await
9193 })
9194 } else {
9195 zlog::trace!(logger => "Not formatting");
9196 Task::ready(Ok(ProjectTransaction::default()))
9197 }
9198 }
9199
9200 async fn handle_format_buffers(
9201 this: Entity<Self>,
9202 envelope: TypedEnvelope<proto::FormatBuffers>,
9203 mut cx: AsyncApp,
9204 ) -> Result<proto::FormatBuffersResponse> {
9205 let sender_id = envelope.original_sender_id().unwrap_or_default();
9206 let format = this.update(&mut cx, |this, cx| {
9207 let mut buffers = HashSet::default();
9208 for buffer_id in &envelope.payload.buffer_ids {
9209 let buffer_id = BufferId::new(*buffer_id)?;
9210 buffers.insert(this.buffer_store.read(cx).get_existing(buffer_id)?);
9211 }
9212 let trigger = FormatTrigger::from_proto(envelope.payload.trigger);
9213 anyhow::Ok(this.format(buffers, LspFormatTarget::Buffers, false, trigger, cx))
9214 })??;
9215
9216 let project_transaction = format.await?;
9217 let project_transaction = this.update(&mut cx, |this, cx| {
9218 this.buffer_store.update(cx, |buffer_store, cx| {
9219 buffer_store.serialize_project_transaction_for_peer(
9220 project_transaction,
9221 sender_id,
9222 cx,
9223 )
9224 })
9225 })?;
9226 Ok(proto::FormatBuffersResponse {
9227 transaction: Some(project_transaction),
9228 })
9229 }
9230
9231 async fn handle_apply_code_action_kind(
9232 this: Entity<Self>,
9233 envelope: TypedEnvelope<proto::ApplyCodeActionKind>,
9234 mut cx: AsyncApp,
9235 ) -> Result<proto::ApplyCodeActionKindResponse> {
9236 let sender_id = envelope.original_sender_id().unwrap_or_default();
9237 let format = this.update(&mut cx, |this, cx| {
9238 let mut buffers = HashSet::default();
9239 for buffer_id in &envelope.payload.buffer_ids {
9240 let buffer_id = BufferId::new(*buffer_id)?;
9241 buffers.insert(this.buffer_store.read(cx).get_existing(buffer_id)?);
9242 }
9243 let kind = match envelope.payload.kind.as_str() {
9244 "" => CodeActionKind::EMPTY,
9245 "quickfix" => CodeActionKind::QUICKFIX,
9246 "refactor" => CodeActionKind::REFACTOR,
9247 "refactor.extract" => CodeActionKind::REFACTOR_EXTRACT,
9248 "refactor.inline" => CodeActionKind::REFACTOR_INLINE,
9249 "refactor.rewrite" => CodeActionKind::REFACTOR_REWRITE,
9250 "source" => CodeActionKind::SOURCE,
9251 "source.organizeImports" => CodeActionKind::SOURCE_ORGANIZE_IMPORTS,
9252 "source.fixAll" => CodeActionKind::SOURCE_FIX_ALL,
9253 _ => anyhow::bail!(
9254 "Invalid code action kind {}",
9255 envelope.payload.kind.as_str()
9256 ),
9257 };
9258 anyhow::Ok(this.apply_code_action_kind(buffers, kind, false, cx))
9259 })??;
9260
9261 let project_transaction = format.await?;
9262 let project_transaction = this.update(&mut cx, |this, cx| {
9263 this.buffer_store.update(cx, |buffer_store, cx| {
9264 buffer_store.serialize_project_transaction_for_peer(
9265 project_transaction,
9266 sender_id,
9267 cx,
9268 )
9269 })
9270 })?;
9271 Ok(proto::ApplyCodeActionKindResponse {
9272 transaction: Some(project_transaction),
9273 })
9274 }
9275
9276 async fn shutdown_language_server(
9277 server_state: Option<LanguageServerState>,
9278 name: LanguageServerName,
9279 cx: &mut AsyncApp,
9280 ) {
9281 let server = match server_state {
9282 Some(LanguageServerState::Starting { startup, .. }) => {
9283 let mut timer = cx
9284 .background_executor()
9285 .timer(SERVER_LAUNCHING_BEFORE_SHUTDOWN_TIMEOUT)
9286 .fuse();
9287
9288 select! {
9289 server = startup.fuse() => server,
9290 _ = timer => {
9291 log::info!(
9292 "timeout waiting for language server {} to finish launching before stopping",
9293 name
9294 );
9295 None
9296 },
9297 }
9298 }
9299
9300 Some(LanguageServerState::Running { server, .. }) => Some(server),
9301
9302 None => None,
9303 };
9304
9305 if let Some(server) = server {
9306 if let Some(shutdown) = server.shutdown() {
9307 shutdown.await;
9308 }
9309 }
9310 }
9311
9312 // Returns a list of all of the worktrees which no longer have a language server and the root path
9313 // for the stopped server
9314 fn stop_local_language_server(
9315 &mut self,
9316 server_id: LanguageServerId,
9317 name: LanguageServerName,
9318 cx: &mut Context<Self>,
9319 ) -> Task<Vec<WorktreeId>> {
9320 let local = match &mut self.mode {
9321 LspStoreMode::Local(local) => local,
9322 _ => {
9323 return Task::ready(Vec::new());
9324 }
9325 };
9326
9327 let mut orphaned_worktrees = vec![];
9328 // Remove this server ID from all entries in the given worktree.
9329 local.language_server_ids.retain(|(worktree, _), ids| {
9330 if !ids.remove(&server_id) {
9331 return true;
9332 }
9333
9334 if ids.is_empty() {
9335 orphaned_worktrees.push(*worktree);
9336 false
9337 } else {
9338 true
9339 }
9340 });
9341 let _ = self.language_server_statuses.remove(&server_id);
9342 log::info!("stopping language server {name}");
9343 self.buffer_store.update(cx, |buffer_store, cx| {
9344 for buffer in buffer_store.buffers() {
9345 buffer.update(cx, |buffer, cx| {
9346 buffer.update_diagnostics(server_id, DiagnosticSet::new([], buffer), cx);
9347 buffer.set_completion_triggers(server_id, Default::default(), cx);
9348 });
9349 }
9350 });
9351
9352 for (worktree_id, summaries) in self.diagnostic_summaries.iter_mut() {
9353 summaries.retain(|path, summaries_by_server_id| {
9354 if summaries_by_server_id.remove(&server_id).is_some() {
9355 if let Some((client, project_id)) = self.downstream_client.clone() {
9356 client
9357 .send(proto::UpdateDiagnosticSummary {
9358 project_id,
9359 worktree_id: worktree_id.to_proto(),
9360 summary: Some(proto::DiagnosticSummary {
9361 path: path.as_ref().to_proto(),
9362 language_server_id: server_id.0 as u64,
9363 error_count: 0,
9364 warning_count: 0,
9365 }),
9366 })
9367 .log_err();
9368 }
9369 !summaries_by_server_id.is_empty()
9370 } else {
9371 true
9372 }
9373 });
9374 }
9375
9376 let local = self.as_local_mut().unwrap();
9377 for diagnostics in local.diagnostics.values_mut() {
9378 diagnostics.retain(|_, diagnostics_by_server_id| {
9379 if let Ok(ix) = diagnostics_by_server_id.binary_search_by_key(&server_id, |e| e.0) {
9380 diagnostics_by_server_id.remove(ix);
9381 !diagnostics_by_server_id.is_empty()
9382 } else {
9383 true
9384 }
9385 });
9386 }
9387 local.language_server_watched_paths.remove(&server_id);
9388 let server_state = local.language_servers.remove(&server_id);
9389 cx.notify();
9390 self.cleanup_lsp_data(server_id);
9391 cx.emit(LspStoreEvent::LanguageServerRemoved(server_id));
9392 cx.spawn(async move |_, cx| {
9393 Self::shutdown_language_server(server_state, name, cx).await;
9394 orphaned_worktrees
9395 })
9396 }
9397
9398 pub fn restart_language_servers_for_buffers(
9399 &mut self,
9400 buffers: Vec<Entity<Buffer>>,
9401 cx: &mut Context<Self>,
9402 ) {
9403 if let Some((client, project_id)) = self.upstream_client() {
9404 let request = client.request(proto::RestartLanguageServers {
9405 project_id,
9406 buffer_ids: buffers
9407 .into_iter()
9408 .map(|b| b.read(cx).remote_id().to_proto())
9409 .collect(),
9410 });
9411 cx.background_spawn(request).detach_and_log_err(cx);
9412 } else {
9413 let stop_task = self.stop_local_language_servers_for_buffers(&buffers, cx);
9414 cx.spawn(async move |this, cx| {
9415 stop_task.await;
9416 this.update(cx, |this, cx| {
9417 for buffer in buffers {
9418 this.register_buffer_with_language_servers(&buffer, true, cx);
9419 }
9420 })
9421 .ok()
9422 })
9423 .detach();
9424 }
9425 }
9426
9427 pub fn stop_language_servers_for_buffers(
9428 &mut self,
9429 buffers: Vec<Entity<Buffer>>,
9430 cx: &mut Context<Self>,
9431 ) {
9432 if let Some((client, project_id)) = self.upstream_client() {
9433 let request = client.request(proto::StopLanguageServers {
9434 project_id,
9435 buffer_ids: buffers
9436 .into_iter()
9437 .map(|b| b.read(cx).remote_id().to_proto())
9438 .collect(),
9439 });
9440 cx.background_spawn(request).detach_and_log_err(cx);
9441 } else {
9442 self.stop_local_language_servers_for_buffers(&buffers, cx)
9443 .detach();
9444 }
9445 }
9446
9447 fn stop_local_language_servers_for_buffers(
9448 &mut self,
9449 buffers: &[Entity<Buffer>],
9450 cx: &mut Context<Self>,
9451 ) -> Task<()> {
9452 let Some(local) = self.as_local_mut() else {
9453 return Task::ready(());
9454 };
9455 let language_servers_to_stop = buffers
9456 .iter()
9457 .flat_map(|buffer| {
9458 buffer.update(cx, |buffer, cx| {
9459 local.language_server_ids_for_buffer(buffer, cx)
9460 })
9461 })
9462 .collect::<BTreeSet<_>>();
9463 local.lsp_tree.update(cx, |this, _| {
9464 this.remove_nodes(&language_servers_to_stop);
9465 });
9466 let tasks = language_servers_to_stop
9467 .into_iter()
9468 .map(|server| {
9469 let name = self
9470 .language_server_statuses
9471 .get(&server)
9472 .map(|state| state.name.as_str().into())
9473 .unwrap_or_else(|| LanguageServerName::from("Unknown"));
9474 self.stop_local_language_server(server, name, cx)
9475 })
9476 .collect::<Vec<_>>();
9477
9478 cx.background_spawn(futures::future::join_all(tasks).map(|_| ()))
9479 }
9480
9481 fn get_buffer<'a>(&self, abs_path: &Path, cx: &'a App) -> Option<&'a Buffer> {
9482 let (worktree, relative_path) =
9483 self.worktree_store.read(cx).find_worktree(&abs_path, cx)?;
9484
9485 let project_path = ProjectPath {
9486 worktree_id: worktree.read(cx).id(),
9487 path: relative_path.into(),
9488 };
9489
9490 Some(
9491 self.buffer_store()
9492 .read(cx)
9493 .get_by_path(&project_path, cx)?
9494 .read(cx),
9495 )
9496 }
9497
9498 pub fn update_diagnostics(
9499 &mut self,
9500 language_server_id: LanguageServerId,
9501 params: lsp::PublishDiagnosticsParams,
9502 result_id: Option<String>,
9503 source_kind: DiagnosticSourceKind,
9504 disk_based_sources: &[String],
9505 cx: &mut Context<Self>,
9506 ) -> Result<()> {
9507 self.merge_diagnostics(
9508 language_server_id,
9509 params,
9510 result_id,
9511 source_kind,
9512 disk_based_sources,
9513 |_, _, _| false,
9514 cx,
9515 )
9516 }
9517
9518 pub fn merge_diagnostics(
9519 &mut self,
9520 language_server_id: LanguageServerId,
9521 mut params: lsp::PublishDiagnosticsParams,
9522 result_id: Option<String>,
9523 source_kind: DiagnosticSourceKind,
9524 disk_based_sources: &[String],
9525 filter: impl Fn(&Buffer, &Diagnostic, &App) -> bool + Clone,
9526 cx: &mut Context<Self>,
9527 ) -> Result<()> {
9528 anyhow::ensure!(self.mode.is_local(), "called update_diagnostics on remote");
9529 let abs_path = params
9530 .uri
9531 .to_file_path()
9532 .map_err(|()| anyhow!("URI is not a file"))?;
9533 let mut diagnostics = Vec::default();
9534 let mut primary_diagnostic_group_ids = HashMap::default();
9535 let mut sources_by_group_id = HashMap::default();
9536 let mut supporting_diagnostics = HashMap::default();
9537
9538 let adapter = self.language_server_adapter_for_id(language_server_id);
9539
9540 // Ensure that primary diagnostics are always the most severe
9541 params.diagnostics.sort_by_key(|item| item.severity);
9542
9543 for diagnostic in ¶ms.diagnostics {
9544 let source = diagnostic.source.as_ref();
9545 let range = range_from_lsp(diagnostic.range);
9546 let is_supporting = diagnostic
9547 .related_information
9548 .as_ref()
9549 .map_or(false, |infos| {
9550 infos.iter().any(|info| {
9551 primary_diagnostic_group_ids.contains_key(&(
9552 source,
9553 diagnostic.code.clone(),
9554 range_from_lsp(info.location.range),
9555 ))
9556 })
9557 });
9558
9559 let is_unnecessary = diagnostic
9560 .tags
9561 .as_ref()
9562 .map_or(false, |tags| tags.contains(&DiagnosticTag::UNNECESSARY));
9563
9564 let underline = self
9565 .language_server_adapter_for_id(language_server_id)
9566 .map_or(true, |adapter| adapter.underline_diagnostic(diagnostic));
9567
9568 if is_supporting {
9569 supporting_diagnostics.insert(
9570 (source, diagnostic.code.clone(), range),
9571 (diagnostic.severity, is_unnecessary),
9572 );
9573 } else {
9574 let group_id = post_inc(&mut self.as_local_mut().unwrap().next_diagnostic_group_id);
9575 let is_disk_based =
9576 source.map_or(false, |source| disk_based_sources.contains(source));
9577
9578 sources_by_group_id.insert(group_id, source);
9579 primary_diagnostic_group_ids
9580 .insert((source, diagnostic.code.clone(), range.clone()), group_id);
9581
9582 diagnostics.push(DiagnosticEntry {
9583 range,
9584 diagnostic: Diagnostic {
9585 source: diagnostic.source.clone(),
9586 source_kind,
9587 code: diagnostic.code.clone(),
9588 code_description: diagnostic
9589 .code_description
9590 .as_ref()
9591 .map(|d| d.href.clone()),
9592 severity: diagnostic.severity.unwrap_or(DiagnosticSeverity::ERROR),
9593 markdown: adapter.as_ref().and_then(|adapter| {
9594 adapter.diagnostic_message_to_markdown(&diagnostic.message)
9595 }),
9596 message: diagnostic.message.trim().to_string(),
9597 group_id,
9598 is_primary: true,
9599 is_disk_based,
9600 is_unnecessary,
9601 underline,
9602 data: diagnostic.data.clone(),
9603 },
9604 });
9605 if let Some(infos) = &diagnostic.related_information {
9606 for info in infos {
9607 if info.location.uri == params.uri && !info.message.is_empty() {
9608 let range = range_from_lsp(info.location.range);
9609 diagnostics.push(DiagnosticEntry {
9610 range,
9611 diagnostic: Diagnostic {
9612 source: diagnostic.source.clone(),
9613 source_kind,
9614 code: diagnostic.code.clone(),
9615 code_description: diagnostic
9616 .code_description
9617 .as_ref()
9618 .map(|c| c.href.clone()),
9619 severity: DiagnosticSeverity::INFORMATION,
9620 markdown: adapter.as_ref().and_then(|adapter| {
9621 adapter.diagnostic_message_to_markdown(&info.message)
9622 }),
9623 message: info.message.trim().to_string(),
9624 group_id,
9625 is_primary: false,
9626 is_disk_based,
9627 is_unnecessary: false,
9628 underline,
9629 data: diagnostic.data.clone(),
9630 },
9631 });
9632 }
9633 }
9634 }
9635 }
9636 }
9637
9638 for entry in &mut diagnostics {
9639 let diagnostic = &mut entry.diagnostic;
9640 if !diagnostic.is_primary {
9641 let source = *sources_by_group_id.get(&diagnostic.group_id).unwrap();
9642 if let Some(&(severity, is_unnecessary)) = supporting_diagnostics.get(&(
9643 source,
9644 diagnostic.code.clone(),
9645 entry.range.clone(),
9646 )) {
9647 if let Some(severity) = severity {
9648 diagnostic.severity = severity;
9649 }
9650 diagnostic.is_unnecessary = is_unnecessary;
9651 }
9652 }
9653 }
9654
9655 self.merge_diagnostic_entries(
9656 language_server_id,
9657 abs_path,
9658 result_id,
9659 params.version,
9660 diagnostics,
9661 filter,
9662 cx,
9663 )?;
9664 Ok(())
9665 }
9666
9667 fn insert_newly_running_language_server(
9668 &mut self,
9669 adapter: Arc<CachedLspAdapter>,
9670 language_server: Arc<LanguageServer>,
9671 server_id: LanguageServerId,
9672 key: (WorktreeId, LanguageServerName),
9673 workspace_folders: Arc<Mutex<BTreeSet<Url>>>,
9674 cx: &mut Context<Self>,
9675 ) {
9676 let Some(local) = self.as_local_mut() else {
9677 return;
9678 };
9679 // If the language server for this key doesn't match the server id, don't store the
9680 // server. Which will cause it to be dropped, killing the process
9681 if local
9682 .language_server_ids
9683 .get(&key)
9684 .map(|ids| !ids.contains(&server_id))
9685 .unwrap_or(false)
9686 {
9687 return;
9688 }
9689
9690 // Update language_servers collection with Running variant of LanguageServerState
9691 // indicating that the server is up and running and ready
9692 let workspace_folders = workspace_folders.lock().clone();
9693 language_server.set_workspace_folders(workspace_folders);
9694
9695 local.language_servers.insert(
9696 server_id,
9697 LanguageServerState::Running {
9698 workspace_refresh_task: lsp_workspace_diagnostics_refresh(
9699 language_server.clone(),
9700 cx,
9701 ),
9702 adapter: adapter.clone(),
9703 server: language_server.clone(),
9704 simulate_disk_based_diagnostics_completion: None,
9705 },
9706 );
9707 if let Some(file_ops_caps) = language_server
9708 .capabilities()
9709 .workspace
9710 .as_ref()
9711 .and_then(|ws| ws.file_operations.as_ref())
9712 {
9713 let did_rename_caps = file_ops_caps.did_rename.as_ref();
9714 let will_rename_caps = file_ops_caps.will_rename.as_ref();
9715 if did_rename_caps.or(will_rename_caps).is_some() {
9716 let watcher = RenamePathsWatchedForServer::default()
9717 .with_did_rename_patterns(did_rename_caps)
9718 .with_will_rename_patterns(will_rename_caps);
9719 local
9720 .language_server_paths_watched_for_rename
9721 .insert(server_id, watcher);
9722 }
9723 }
9724
9725 self.language_server_statuses.insert(
9726 server_id,
9727 LanguageServerStatus {
9728 name: language_server.name().to_string(),
9729 pending_work: Default::default(),
9730 has_pending_diagnostic_updates: false,
9731 progress_tokens: Default::default(),
9732 },
9733 );
9734
9735 cx.emit(LspStoreEvent::LanguageServerAdded(
9736 server_id,
9737 language_server.name(),
9738 Some(key.0),
9739 ));
9740 cx.emit(LspStoreEvent::RefreshInlayHints);
9741
9742 if let Some((downstream_client, project_id)) = self.downstream_client.as_ref() {
9743 downstream_client
9744 .send(proto::StartLanguageServer {
9745 project_id: *project_id,
9746 server: Some(proto::LanguageServer {
9747 id: server_id.0 as u64,
9748 name: language_server.name().to_string(),
9749 worktree_id: Some(key.0.to_proto()),
9750 }),
9751 })
9752 .log_err();
9753 }
9754
9755 // Tell the language server about every open buffer in the worktree that matches the language.
9756 let mut buffer_paths_registered = Vec::new();
9757 self.buffer_store.clone().update(cx, |buffer_store, cx| {
9758 for buffer_handle in buffer_store.buffers() {
9759 let buffer = buffer_handle.read(cx);
9760 let file = match File::from_dyn(buffer.file()) {
9761 Some(file) => file,
9762 None => continue,
9763 };
9764 let language = match buffer.language() {
9765 Some(language) => language,
9766 None => continue,
9767 };
9768
9769 if file.worktree.read(cx).id() != key.0
9770 || !self
9771 .languages
9772 .lsp_adapters(&language.name())
9773 .iter()
9774 .any(|a| a.name == key.1)
9775 {
9776 continue;
9777 }
9778 // didOpen
9779 let file = match file.as_local() {
9780 Some(file) => file,
9781 None => continue,
9782 };
9783
9784 let local = self.as_local_mut().unwrap();
9785
9786 if local.registered_buffers.contains_key(&buffer.remote_id()) {
9787 let versions = local
9788 .buffer_snapshots
9789 .entry(buffer.remote_id())
9790 .or_default()
9791 .entry(server_id)
9792 .and_modify(|_| {
9793 assert!(
9794 false,
9795 "There should not be an existing snapshot for a newly inserted buffer"
9796 )
9797 })
9798 .or_insert_with(|| {
9799 vec![LspBufferSnapshot {
9800 version: 0,
9801 snapshot: buffer.text_snapshot(),
9802 }]
9803 });
9804
9805 let snapshot = versions.last().unwrap();
9806 let version = snapshot.version;
9807 let initial_snapshot = &snapshot.snapshot;
9808 let uri = lsp::Url::from_file_path(file.abs_path(cx)).unwrap();
9809 language_server.register_buffer(
9810 uri,
9811 adapter.language_id(&language.name()),
9812 version,
9813 initial_snapshot.text(),
9814 );
9815 buffer_paths_registered.push(file.abs_path(cx));
9816 local
9817 .buffers_opened_in_servers
9818 .entry(buffer.remote_id())
9819 .or_default()
9820 .insert(server_id);
9821 }
9822 buffer_handle.update(cx, |buffer, cx| {
9823 buffer.set_completion_triggers(
9824 server_id,
9825 language_server
9826 .capabilities()
9827 .completion_provider
9828 .as_ref()
9829 .and_then(|provider| {
9830 provider
9831 .trigger_characters
9832 .as_ref()
9833 .map(|characters| characters.iter().cloned().collect())
9834 })
9835 .unwrap_or_default(),
9836 cx,
9837 )
9838 });
9839 }
9840 });
9841
9842 cx.notify();
9843 }
9844
9845 pub fn language_servers_running_disk_based_diagnostics(
9846 &self,
9847 ) -> impl Iterator<Item = LanguageServerId> + '_ {
9848 self.language_server_statuses
9849 .iter()
9850 .filter_map(|(id, status)| {
9851 if status.has_pending_diagnostic_updates {
9852 Some(*id)
9853 } else {
9854 None
9855 }
9856 })
9857 }
9858
9859 pub(crate) fn cancel_language_server_work_for_buffers(
9860 &mut self,
9861 buffers: impl IntoIterator<Item = Entity<Buffer>>,
9862 cx: &mut Context<Self>,
9863 ) {
9864 if let Some((client, project_id)) = self.upstream_client() {
9865 let request = client.request(proto::CancelLanguageServerWork {
9866 project_id,
9867 work: Some(proto::cancel_language_server_work::Work::Buffers(
9868 proto::cancel_language_server_work::Buffers {
9869 buffer_ids: buffers
9870 .into_iter()
9871 .map(|b| b.read(cx).remote_id().to_proto())
9872 .collect(),
9873 },
9874 )),
9875 });
9876 cx.background_spawn(request).detach_and_log_err(cx);
9877 } else if let Some(local) = self.as_local() {
9878 let servers = buffers
9879 .into_iter()
9880 .flat_map(|buffer| {
9881 buffer.update(cx, |buffer, cx| {
9882 local.language_server_ids_for_buffer(buffer, cx).into_iter()
9883 })
9884 })
9885 .collect::<HashSet<_>>();
9886 for server_id in servers {
9887 self.cancel_language_server_work(server_id, None, cx);
9888 }
9889 }
9890 }
9891
9892 pub(crate) fn cancel_language_server_work(
9893 &mut self,
9894 server_id: LanguageServerId,
9895 token_to_cancel: Option<String>,
9896 cx: &mut Context<Self>,
9897 ) {
9898 if let Some(local) = self.as_local() {
9899 let status = self.language_server_statuses.get(&server_id);
9900 let server = local.language_servers.get(&server_id);
9901 if let Some((LanguageServerState::Running { server, .. }, status)) = server.zip(status)
9902 {
9903 for (token, progress) in &status.pending_work {
9904 if let Some(token_to_cancel) = token_to_cancel.as_ref() {
9905 if token != token_to_cancel {
9906 continue;
9907 }
9908 }
9909 if progress.is_cancellable {
9910 server
9911 .notify::<lsp::notification::WorkDoneProgressCancel>(
9912 &WorkDoneProgressCancelParams {
9913 token: lsp::NumberOrString::String(token.clone()),
9914 },
9915 )
9916 .ok();
9917 }
9918 }
9919 }
9920 } else if let Some((client, project_id)) = self.upstream_client() {
9921 let request = client.request(proto::CancelLanguageServerWork {
9922 project_id,
9923 work: Some(
9924 proto::cancel_language_server_work::Work::LanguageServerWork(
9925 proto::cancel_language_server_work::LanguageServerWork {
9926 language_server_id: server_id.to_proto(),
9927 token: token_to_cancel,
9928 },
9929 ),
9930 ),
9931 });
9932 cx.background_spawn(request).detach_and_log_err(cx);
9933 }
9934 }
9935
9936 fn register_supplementary_language_server(
9937 &mut self,
9938 id: LanguageServerId,
9939 name: LanguageServerName,
9940 server: Arc<LanguageServer>,
9941 cx: &mut Context<Self>,
9942 ) {
9943 if let Some(local) = self.as_local_mut() {
9944 local
9945 .supplementary_language_servers
9946 .insert(id, (name.clone(), server));
9947 cx.emit(LspStoreEvent::LanguageServerAdded(id, name, None));
9948 }
9949 }
9950
9951 fn unregister_supplementary_language_server(
9952 &mut self,
9953 id: LanguageServerId,
9954 cx: &mut Context<Self>,
9955 ) {
9956 if let Some(local) = self.as_local_mut() {
9957 local.supplementary_language_servers.remove(&id);
9958 cx.emit(LspStoreEvent::LanguageServerRemoved(id));
9959 }
9960 }
9961
9962 pub(crate) fn supplementary_language_servers(
9963 &self,
9964 ) -> impl '_ + Iterator<Item = (LanguageServerId, LanguageServerName)> {
9965 self.as_local().into_iter().flat_map(|local| {
9966 local
9967 .supplementary_language_servers
9968 .iter()
9969 .map(|(id, (name, _))| (*id, name.clone()))
9970 })
9971 }
9972
9973 pub fn language_server_adapter_for_id(
9974 &self,
9975 id: LanguageServerId,
9976 ) -> Option<Arc<CachedLspAdapter>> {
9977 self.as_local()
9978 .and_then(|local| local.language_servers.get(&id))
9979 .and_then(|language_server_state| match language_server_state {
9980 LanguageServerState::Running { adapter, .. } => Some(adapter.clone()),
9981 _ => None,
9982 })
9983 }
9984
9985 pub(super) fn update_local_worktree_language_servers(
9986 &mut self,
9987 worktree_handle: &Entity<Worktree>,
9988 changes: &[(Arc<Path>, ProjectEntryId, PathChange)],
9989 cx: &mut Context<Self>,
9990 ) {
9991 if changes.is_empty() {
9992 return;
9993 }
9994
9995 let Some(local) = self.as_local() else { return };
9996
9997 local.prettier_store.update(cx, |prettier_store, cx| {
9998 prettier_store.update_prettier_settings(&worktree_handle, changes, cx)
9999 });
10000
10001 let worktree_id = worktree_handle.read(cx).id();
10002 let mut language_server_ids = local
10003 .language_server_ids
10004 .iter()
10005 .flat_map(|((server_worktree, _), server_ids)| {
10006 server_ids
10007 .iter()
10008 .filter_map(|server_id| server_worktree.eq(&worktree_id).then(|| *server_id))
10009 })
10010 .collect::<Vec<_>>();
10011 language_server_ids.sort();
10012 language_server_ids.dedup();
10013
10014 let abs_path = worktree_handle.read(cx).abs_path();
10015 for server_id in &language_server_ids {
10016 if let Some(LanguageServerState::Running { server, .. }) =
10017 local.language_servers.get(server_id)
10018 {
10019 if let Some(watched_paths) = local
10020 .language_server_watched_paths
10021 .get(server_id)
10022 .and_then(|paths| paths.worktree_paths.get(&worktree_id))
10023 {
10024 let params = lsp::DidChangeWatchedFilesParams {
10025 changes: changes
10026 .iter()
10027 .filter_map(|(path, _, change)| {
10028 if !watched_paths.is_match(path) {
10029 return None;
10030 }
10031 let typ = match change {
10032 PathChange::Loaded => return None,
10033 PathChange::Added => lsp::FileChangeType::CREATED,
10034 PathChange::Removed => lsp::FileChangeType::DELETED,
10035 PathChange::Updated => lsp::FileChangeType::CHANGED,
10036 PathChange::AddedOrUpdated => lsp::FileChangeType::CHANGED,
10037 };
10038 Some(lsp::FileEvent {
10039 uri: lsp::Url::from_file_path(abs_path.join(path)).unwrap(),
10040 typ,
10041 })
10042 })
10043 .collect(),
10044 };
10045 if !params.changes.is_empty() {
10046 server
10047 .notify::<lsp::notification::DidChangeWatchedFiles>(¶ms)
10048 .ok();
10049 }
10050 }
10051 }
10052 }
10053 }
10054
10055 pub fn wait_for_remote_buffer(
10056 &mut self,
10057 id: BufferId,
10058 cx: &mut Context<Self>,
10059 ) -> Task<Result<Entity<Buffer>>> {
10060 self.buffer_store.update(cx, |buffer_store, cx| {
10061 buffer_store.wait_for_remote_buffer(id, cx)
10062 })
10063 }
10064
10065 fn serialize_symbol(symbol: &Symbol) -> proto::Symbol {
10066 proto::Symbol {
10067 language_server_name: symbol.language_server_name.0.to_string(),
10068 source_worktree_id: symbol.source_worktree_id.to_proto(),
10069 language_server_id: symbol.source_language_server_id.to_proto(),
10070 worktree_id: symbol.path.worktree_id.to_proto(),
10071 path: symbol.path.path.as_ref().to_proto(),
10072 name: symbol.name.clone(),
10073 kind: unsafe { mem::transmute::<lsp::SymbolKind, i32>(symbol.kind) },
10074 start: Some(proto::PointUtf16 {
10075 row: symbol.range.start.0.row,
10076 column: symbol.range.start.0.column,
10077 }),
10078 end: Some(proto::PointUtf16 {
10079 row: symbol.range.end.0.row,
10080 column: symbol.range.end.0.column,
10081 }),
10082 signature: symbol.signature.to_vec(),
10083 }
10084 }
10085
10086 fn deserialize_symbol(serialized_symbol: proto::Symbol) -> Result<CoreSymbol> {
10087 let source_worktree_id = WorktreeId::from_proto(serialized_symbol.source_worktree_id);
10088 let worktree_id = WorktreeId::from_proto(serialized_symbol.worktree_id);
10089 let kind = unsafe { mem::transmute::<i32, lsp::SymbolKind>(serialized_symbol.kind) };
10090 let path = ProjectPath {
10091 worktree_id,
10092 path: Arc::<Path>::from_proto(serialized_symbol.path),
10093 };
10094
10095 let start = serialized_symbol.start.context("invalid start")?;
10096 let end = serialized_symbol.end.context("invalid end")?;
10097 Ok(CoreSymbol {
10098 language_server_name: LanguageServerName(serialized_symbol.language_server_name.into()),
10099 source_worktree_id,
10100 source_language_server_id: LanguageServerId::from_proto(
10101 serialized_symbol.language_server_id,
10102 ),
10103 path,
10104 name: serialized_symbol.name,
10105 range: Unclipped(PointUtf16::new(start.row, start.column))
10106 ..Unclipped(PointUtf16::new(end.row, end.column)),
10107 kind,
10108 signature: serialized_symbol
10109 .signature
10110 .try_into()
10111 .map_err(|_| anyhow!("invalid signature"))?,
10112 })
10113 }
10114
10115 pub(crate) fn serialize_completion(completion: &CoreCompletion) -> proto::Completion {
10116 let mut serialized_completion = proto::Completion {
10117 old_replace_start: Some(serialize_anchor(&completion.replace_range.start)),
10118 old_replace_end: Some(serialize_anchor(&completion.replace_range.end)),
10119 new_text: completion.new_text.clone(),
10120 ..proto::Completion::default()
10121 };
10122 match &completion.source {
10123 CompletionSource::Lsp {
10124 insert_range,
10125 server_id,
10126 lsp_completion,
10127 lsp_defaults,
10128 resolved,
10129 } => {
10130 let (old_insert_start, old_insert_end) = insert_range
10131 .as_ref()
10132 .map(|range| (serialize_anchor(&range.start), serialize_anchor(&range.end)))
10133 .unzip();
10134
10135 serialized_completion.old_insert_start = old_insert_start;
10136 serialized_completion.old_insert_end = old_insert_end;
10137 serialized_completion.source = proto::completion::Source::Lsp as i32;
10138 serialized_completion.server_id = server_id.0 as u64;
10139 serialized_completion.lsp_completion = serde_json::to_vec(lsp_completion).unwrap();
10140 serialized_completion.lsp_defaults = lsp_defaults
10141 .as_deref()
10142 .map(|lsp_defaults| serde_json::to_vec(lsp_defaults).unwrap());
10143 serialized_completion.resolved = *resolved;
10144 }
10145 CompletionSource::BufferWord {
10146 word_range,
10147 resolved,
10148 } => {
10149 serialized_completion.source = proto::completion::Source::BufferWord as i32;
10150 serialized_completion.buffer_word_start = Some(serialize_anchor(&word_range.start));
10151 serialized_completion.buffer_word_end = Some(serialize_anchor(&word_range.end));
10152 serialized_completion.resolved = *resolved;
10153 }
10154 CompletionSource::Custom => {
10155 serialized_completion.source = proto::completion::Source::Custom as i32;
10156 serialized_completion.resolved = true;
10157 }
10158 }
10159
10160 serialized_completion
10161 }
10162
10163 pub(crate) fn deserialize_completion(completion: proto::Completion) -> Result<CoreCompletion> {
10164 let old_replace_start = completion
10165 .old_replace_start
10166 .and_then(deserialize_anchor)
10167 .context("invalid old start")?;
10168 let old_replace_end = completion
10169 .old_replace_end
10170 .and_then(deserialize_anchor)
10171 .context("invalid old end")?;
10172 let insert_range = {
10173 match completion.old_insert_start.zip(completion.old_insert_end) {
10174 Some((start, end)) => {
10175 let start = deserialize_anchor(start).context("invalid insert old start")?;
10176 let end = deserialize_anchor(end).context("invalid insert old end")?;
10177 Some(start..end)
10178 }
10179 None => None,
10180 }
10181 };
10182 Ok(CoreCompletion {
10183 replace_range: old_replace_start..old_replace_end,
10184 new_text: completion.new_text,
10185 source: match proto::completion::Source::from_i32(completion.source) {
10186 Some(proto::completion::Source::Custom) => CompletionSource::Custom,
10187 Some(proto::completion::Source::Lsp) => CompletionSource::Lsp {
10188 insert_range,
10189 server_id: LanguageServerId::from_proto(completion.server_id),
10190 lsp_completion: serde_json::from_slice(&completion.lsp_completion)?,
10191 lsp_defaults: completion
10192 .lsp_defaults
10193 .as_deref()
10194 .map(serde_json::from_slice)
10195 .transpose()?,
10196 resolved: completion.resolved,
10197 },
10198 Some(proto::completion::Source::BufferWord) => {
10199 let word_range = completion
10200 .buffer_word_start
10201 .and_then(deserialize_anchor)
10202 .context("invalid buffer word start")?
10203 ..completion
10204 .buffer_word_end
10205 .and_then(deserialize_anchor)
10206 .context("invalid buffer word end")?;
10207 CompletionSource::BufferWord {
10208 word_range,
10209 resolved: completion.resolved,
10210 }
10211 }
10212 _ => anyhow::bail!("Unexpected completion source {}", completion.source),
10213 },
10214 })
10215 }
10216
10217 pub(crate) fn serialize_code_action(action: &CodeAction) -> proto::CodeAction {
10218 let (kind, lsp_action) = match &action.lsp_action {
10219 LspAction::Action(code_action) => (
10220 proto::code_action::Kind::Action as i32,
10221 serde_json::to_vec(code_action).unwrap(),
10222 ),
10223 LspAction::Command(command) => (
10224 proto::code_action::Kind::Command as i32,
10225 serde_json::to_vec(command).unwrap(),
10226 ),
10227 LspAction::CodeLens(code_lens) => (
10228 proto::code_action::Kind::CodeLens as i32,
10229 serde_json::to_vec(code_lens).unwrap(),
10230 ),
10231 };
10232
10233 proto::CodeAction {
10234 server_id: action.server_id.0 as u64,
10235 start: Some(serialize_anchor(&action.range.start)),
10236 end: Some(serialize_anchor(&action.range.end)),
10237 lsp_action,
10238 kind,
10239 resolved: action.resolved,
10240 }
10241 }
10242
10243 pub(crate) fn deserialize_code_action(action: proto::CodeAction) -> Result<CodeAction> {
10244 let start = action
10245 .start
10246 .and_then(deserialize_anchor)
10247 .context("invalid start")?;
10248 let end = action
10249 .end
10250 .and_then(deserialize_anchor)
10251 .context("invalid end")?;
10252 let lsp_action = match proto::code_action::Kind::from_i32(action.kind) {
10253 Some(proto::code_action::Kind::Action) => {
10254 LspAction::Action(serde_json::from_slice(&action.lsp_action)?)
10255 }
10256 Some(proto::code_action::Kind::Command) => {
10257 LspAction::Command(serde_json::from_slice(&action.lsp_action)?)
10258 }
10259 Some(proto::code_action::Kind::CodeLens) => {
10260 LspAction::CodeLens(serde_json::from_slice(&action.lsp_action)?)
10261 }
10262 None => anyhow::bail!("Unknown action kind {}", action.kind),
10263 };
10264 Ok(CodeAction {
10265 server_id: LanguageServerId(action.server_id as usize),
10266 range: start..end,
10267 resolved: action.resolved,
10268 lsp_action,
10269 })
10270 }
10271
10272 fn update_last_formatting_failure<T>(&mut self, formatting_result: &anyhow::Result<T>) {
10273 match &formatting_result {
10274 Ok(_) => self.last_formatting_failure = None,
10275 Err(error) => {
10276 let error_string = format!("{error:#}");
10277 log::error!("Formatting failed: {error_string}");
10278 self.last_formatting_failure
10279 .replace(error_string.lines().join(" "));
10280 }
10281 }
10282 }
10283
10284 fn cleanup_lsp_data(&mut self, for_server: LanguageServerId) {
10285 for buffer_lsp_data in self.lsp_data.values_mut() {
10286 buffer_lsp_data.colors.remove(&for_server);
10287 buffer_lsp_data.cache_version += 1;
10288 }
10289 if let Some(local) = self.as_local_mut() {
10290 local.buffer_pull_diagnostics_result_ids.remove(&for_server);
10291 for buffer_servers in local.buffers_opened_in_servers.values_mut() {
10292 buffer_servers.remove(&for_server);
10293 }
10294 }
10295 }
10296
10297 pub fn result_id(
10298 &self,
10299 server_id: LanguageServerId,
10300 buffer_id: BufferId,
10301 cx: &App,
10302 ) -> Option<String> {
10303 let abs_path = self
10304 .buffer_store
10305 .read(cx)
10306 .get(buffer_id)
10307 .and_then(|b| File::from_dyn(b.read(cx).file()))
10308 .map(|f| f.abs_path(cx))?;
10309 self.as_local()?
10310 .buffer_pull_diagnostics_result_ids
10311 .get(&server_id)?
10312 .get(&abs_path)?
10313 .clone()
10314 }
10315
10316 pub fn all_result_ids(&self, server_id: LanguageServerId) -> HashMap<PathBuf, String> {
10317 let Some(local) = self.as_local() else {
10318 return HashMap::default();
10319 };
10320 local
10321 .buffer_pull_diagnostics_result_ids
10322 .get(&server_id)
10323 .into_iter()
10324 .flatten()
10325 .filter_map(|(abs_path, result_id)| Some((abs_path.clone(), result_id.clone()?)))
10326 .collect()
10327 }
10328
10329 pub fn pull_workspace_diagnostics(&mut self, server_id: LanguageServerId) {
10330 if let Some(LanguageServerState::Running {
10331 workspace_refresh_task: Some((tx, _)),
10332 ..
10333 }) = self
10334 .as_local_mut()
10335 .and_then(|local| local.language_servers.get_mut(&server_id))
10336 {
10337 tx.try_send(()).ok();
10338 }
10339 }
10340
10341 pub fn pull_workspace_diagnostics_for_buffer(&mut self, buffer_id: BufferId, cx: &mut App) {
10342 let Some(buffer) = self.buffer_store().read(cx).get_existing(buffer_id).ok() else {
10343 return;
10344 };
10345 let Some(local) = self.as_local_mut() else {
10346 return;
10347 };
10348
10349 for server_id in buffer.update(cx, |buffer, cx| {
10350 local.language_server_ids_for_buffer(buffer, cx)
10351 }) {
10352 if let Some(LanguageServerState::Running {
10353 workspace_refresh_task: Some((tx, _)),
10354 ..
10355 }) = local.language_servers.get_mut(&server_id)
10356 {
10357 tx.try_send(()).ok();
10358 }
10359 }
10360 }
10361}
10362
10363fn lsp_workspace_diagnostics_refresh(
10364 server: Arc<LanguageServer>,
10365 cx: &mut Context<'_, LspStore>,
10366) -> Option<(mpsc::Sender<()>, Task<()>)> {
10367 let identifier = match server.capabilities().diagnostic_provider? {
10368 lsp::DiagnosticServerCapabilities::Options(diagnostic_options) => {
10369 if !diagnostic_options.workspace_diagnostics {
10370 return None;
10371 }
10372 diagnostic_options.identifier
10373 }
10374 lsp::DiagnosticServerCapabilities::RegistrationOptions(registration_options) => {
10375 let diagnostic_options = registration_options.diagnostic_options;
10376 if !diagnostic_options.workspace_diagnostics {
10377 return None;
10378 }
10379 diagnostic_options.identifier
10380 }
10381 };
10382
10383 let (mut tx, mut rx) = mpsc::channel(1);
10384 tx.try_send(()).ok();
10385
10386 let workspace_query_language_server = cx.spawn(async move |lsp_store, cx| {
10387 let mut attempts = 0;
10388 let max_attempts = 50;
10389
10390 loop {
10391 let Some(()) = rx.recv().await else {
10392 return;
10393 };
10394
10395 'request: loop {
10396 if attempts > max_attempts {
10397 log::error!(
10398 "Failed to pull workspace diagnostics {max_attempts} times, aborting"
10399 );
10400 return;
10401 }
10402 let backoff_millis = (50 * (1 << attempts)).clamp(30, 1000);
10403 cx.background_executor()
10404 .timer(Duration::from_millis(backoff_millis))
10405 .await;
10406 attempts += 1;
10407
10408 let Ok(previous_result_ids) = lsp_store.update(cx, |lsp_store, _| {
10409 lsp_store
10410 .all_result_ids(server.server_id())
10411 .into_iter()
10412 .filter_map(|(abs_path, result_id)| {
10413 let uri = file_path_to_lsp_url(&abs_path).ok()?;
10414 Some(lsp::PreviousResultId {
10415 uri,
10416 value: result_id,
10417 })
10418 })
10419 .collect()
10420 }) else {
10421 return;
10422 };
10423
10424 let response_result = server
10425 .request::<lsp::WorkspaceDiagnosticRequest>(lsp::WorkspaceDiagnosticParams {
10426 previous_result_ids,
10427 identifier: identifier.clone(),
10428 work_done_progress_params: Default::default(),
10429 partial_result_params: Default::default(),
10430 })
10431 .await;
10432 // https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#diagnostic_refresh
10433 // > If a server closes a workspace diagnostic pull request the client should re-trigger the request.
10434 match response_result {
10435 ConnectionResult::Timeout => {
10436 log::error!("Timeout during workspace diagnostics pull");
10437 continue 'request;
10438 }
10439 ConnectionResult::ConnectionReset => {
10440 log::error!("Server closed a workspace diagnostics pull request");
10441 continue 'request;
10442 }
10443 ConnectionResult::Result(Err(e)) => {
10444 log::error!("Error during workspace diagnostics pull: {e:#}");
10445 break 'request;
10446 }
10447 ConnectionResult::Result(Ok(pulled_diagnostics)) => {
10448 attempts = 0;
10449 if lsp_store
10450 .update(cx, |lsp_store, cx| {
10451 let workspace_diagnostics =
10452 GetDocumentDiagnostics::deserialize_workspace_diagnostics_report(pulled_diagnostics, server.server_id());
10453 for workspace_diagnostics in workspace_diagnostics {
10454 let LspPullDiagnostics::Response {
10455 server_id,
10456 uri,
10457 diagnostics,
10458 } = workspace_diagnostics.diagnostics
10459 else {
10460 continue;
10461 };
10462
10463 let adapter = lsp_store.language_server_adapter_for_id(server_id);
10464 let disk_based_sources = adapter
10465 .as_ref()
10466 .map(|adapter| adapter.disk_based_diagnostic_sources.as_slice())
10467 .unwrap_or(&[]);
10468
10469 match diagnostics {
10470 PulledDiagnostics::Unchanged { result_id } => {
10471 lsp_store
10472 .merge_diagnostics(
10473 server_id,
10474 lsp::PublishDiagnosticsParams {
10475 uri: uri.clone(),
10476 diagnostics: Vec::new(),
10477 version: None,
10478 },
10479 Some(result_id),
10480 DiagnosticSourceKind::Pulled,
10481 disk_based_sources,
10482 |_, _, _| true,
10483 cx,
10484 )
10485 .log_err();
10486 }
10487 PulledDiagnostics::Changed {
10488 diagnostics,
10489 result_id,
10490 } => {
10491 lsp_store
10492 .merge_diagnostics(
10493 server_id,
10494 lsp::PublishDiagnosticsParams {
10495 uri: uri.clone(),
10496 diagnostics,
10497 version: workspace_diagnostics.version,
10498 },
10499 result_id,
10500 DiagnosticSourceKind::Pulled,
10501 disk_based_sources,
10502 |buffer, old_diagnostic, cx| match old_diagnostic.source_kind {
10503 DiagnosticSourceKind::Pulled => {
10504 let buffer_url = File::from_dyn(buffer.file()).map(|f| f.abs_path(cx))
10505 .and_then(|abs_path| file_path_to_lsp_url(&abs_path).ok());
10506 buffer_url.is_none_or(|buffer_url| buffer_url != uri)
10507 },
10508 DiagnosticSourceKind::Other
10509 | DiagnosticSourceKind::Pushed => true,
10510 },
10511 cx,
10512 )
10513 .log_err();
10514 }
10515 }
10516 }
10517 })
10518 .is_err()
10519 {
10520 return;
10521 }
10522 break 'request;
10523 }
10524 }
10525 }
10526 }
10527 });
10528
10529 Some((tx, workspace_query_language_server))
10530}
10531
10532fn resolve_word_completion(snapshot: &BufferSnapshot, completion: &mut Completion) {
10533 let CompletionSource::BufferWord {
10534 word_range,
10535 resolved,
10536 } = &mut completion.source
10537 else {
10538 return;
10539 };
10540 if *resolved {
10541 return;
10542 }
10543
10544 if completion.new_text
10545 != snapshot
10546 .text_for_range(word_range.clone())
10547 .collect::<String>()
10548 {
10549 return;
10550 }
10551
10552 let mut offset = 0;
10553 for chunk in snapshot.chunks(word_range.clone(), true) {
10554 let end_offset = offset + chunk.text.len();
10555 if let Some(highlight_id) = chunk.syntax_highlight_id {
10556 completion
10557 .label
10558 .runs
10559 .push((offset..end_offset, highlight_id));
10560 }
10561 offset = end_offset;
10562 }
10563 *resolved = true;
10564}
10565
10566impl EventEmitter<LspStoreEvent> for LspStore {}
10567
10568fn remove_empty_hover_blocks(mut hover: Hover) -> Option<Hover> {
10569 hover
10570 .contents
10571 .retain(|hover_block| !hover_block.text.trim().is_empty());
10572 if hover.contents.is_empty() {
10573 None
10574 } else {
10575 Some(hover)
10576 }
10577}
10578
10579async fn populate_labels_for_completions(
10580 new_completions: Vec<CoreCompletion>,
10581 language: Option<Arc<Language>>,
10582 lsp_adapter: Option<Arc<CachedLspAdapter>>,
10583) -> Vec<Completion> {
10584 let lsp_completions = new_completions
10585 .iter()
10586 .filter_map(|new_completion| {
10587 if let Some(lsp_completion) = new_completion.source.lsp_completion(true) {
10588 Some(lsp_completion.into_owned())
10589 } else {
10590 None
10591 }
10592 })
10593 .collect::<Vec<_>>();
10594
10595 let mut labels = if let Some((language, lsp_adapter)) = language.as_ref().zip(lsp_adapter) {
10596 lsp_adapter
10597 .labels_for_completions(&lsp_completions, language)
10598 .await
10599 .log_err()
10600 .unwrap_or_default()
10601 } else {
10602 Vec::new()
10603 }
10604 .into_iter()
10605 .fuse();
10606
10607 let mut completions = Vec::new();
10608 for completion in new_completions {
10609 match completion.source.lsp_completion(true) {
10610 Some(lsp_completion) => {
10611 let documentation = if let Some(docs) = lsp_completion.documentation.clone() {
10612 Some(docs.into())
10613 } else {
10614 None
10615 };
10616
10617 let mut label = labels.next().flatten().unwrap_or_else(|| {
10618 CodeLabel::fallback_for_completion(&lsp_completion, language.as_deref())
10619 });
10620 ensure_uniform_list_compatible_label(&mut label);
10621 completions.push(Completion {
10622 label,
10623 documentation,
10624 replace_range: completion.replace_range,
10625 new_text: completion.new_text,
10626 insert_text_mode: lsp_completion.insert_text_mode,
10627 source: completion.source,
10628 icon_path: None,
10629 confirm: None,
10630 });
10631 }
10632 None => {
10633 let mut label = CodeLabel::plain(completion.new_text.clone(), None);
10634 ensure_uniform_list_compatible_label(&mut label);
10635 completions.push(Completion {
10636 label,
10637 documentation: None,
10638 replace_range: completion.replace_range,
10639 new_text: completion.new_text,
10640 source: completion.source,
10641 insert_text_mode: None,
10642 icon_path: None,
10643 confirm: None,
10644 });
10645 }
10646 }
10647 }
10648 completions
10649}
10650
10651#[derive(Debug)]
10652pub enum LanguageServerToQuery {
10653 /// Query language servers in order of users preference, up until one capable of handling the request is found.
10654 FirstCapable,
10655 /// Query a specific language server.
10656 Other(LanguageServerId),
10657}
10658
10659#[derive(Default)]
10660struct RenamePathsWatchedForServer {
10661 did_rename: Vec<RenameActionPredicate>,
10662 will_rename: Vec<RenameActionPredicate>,
10663}
10664
10665impl RenamePathsWatchedForServer {
10666 fn with_did_rename_patterns(
10667 mut self,
10668 did_rename: Option<&FileOperationRegistrationOptions>,
10669 ) -> Self {
10670 if let Some(did_rename) = did_rename {
10671 self.did_rename = did_rename
10672 .filters
10673 .iter()
10674 .filter_map(|filter| filter.try_into().log_err())
10675 .collect();
10676 }
10677 self
10678 }
10679 fn with_will_rename_patterns(
10680 mut self,
10681 will_rename: Option<&FileOperationRegistrationOptions>,
10682 ) -> Self {
10683 if let Some(will_rename) = will_rename {
10684 self.will_rename = will_rename
10685 .filters
10686 .iter()
10687 .filter_map(|filter| filter.try_into().log_err())
10688 .collect();
10689 }
10690 self
10691 }
10692
10693 fn should_send_did_rename(&self, path: &str, is_dir: bool) -> bool {
10694 self.did_rename.iter().any(|pred| pred.eval(path, is_dir))
10695 }
10696 fn should_send_will_rename(&self, path: &str, is_dir: bool) -> bool {
10697 self.will_rename.iter().any(|pred| pred.eval(path, is_dir))
10698 }
10699}
10700
10701impl TryFrom<&FileOperationFilter> for RenameActionPredicate {
10702 type Error = globset::Error;
10703 fn try_from(ops: &FileOperationFilter) -> Result<Self, globset::Error> {
10704 Ok(Self {
10705 kind: ops.pattern.matches.clone(),
10706 glob: GlobBuilder::new(&ops.pattern.glob)
10707 .case_insensitive(
10708 ops.pattern
10709 .options
10710 .as_ref()
10711 .map_or(false, |ops| ops.ignore_case.unwrap_or(false)),
10712 )
10713 .build()?
10714 .compile_matcher(),
10715 })
10716 }
10717}
10718struct RenameActionPredicate {
10719 glob: GlobMatcher,
10720 kind: Option<FileOperationPatternKind>,
10721}
10722
10723impl RenameActionPredicate {
10724 // Returns true if language server should be notified
10725 fn eval(&self, path: &str, is_dir: bool) -> bool {
10726 self.kind.as_ref().map_or(true, |kind| {
10727 let expected_kind = if is_dir {
10728 FileOperationPatternKind::Folder
10729 } else {
10730 FileOperationPatternKind::File
10731 };
10732 kind == &expected_kind
10733 }) && self.glob.is_match(path)
10734 }
10735}
10736
10737#[derive(Default)]
10738struct LanguageServerWatchedPaths {
10739 worktree_paths: HashMap<WorktreeId, GlobSet>,
10740 abs_paths: HashMap<Arc<Path>, (GlobSet, Task<()>)>,
10741}
10742
10743#[derive(Default)]
10744struct LanguageServerWatchedPathsBuilder {
10745 worktree_paths: HashMap<WorktreeId, GlobSet>,
10746 abs_paths: HashMap<Arc<Path>, GlobSet>,
10747}
10748
10749impl LanguageServerWatchedPathsBuilder {
10750 fn watch_worktree(&mut self, worktree_id: WorktreeId, glob_set: GlobSet) {
10751 self.worktree_paths.insert(worktree_id, glob_set);
10752 }
10753 fn watch_abs_path(&mut self, path: Arc<Path>, glob_set: GlobSet) {
10754 self.abs_paths.insert(path, glob_set);
10755 }
10756 fn build(
10757 self,
10758 fs: Arc<dyn Fs>,
10759 language_server_id: LanguageServerId,
10760 cx: &mut Context<LspStore>,
10761 ) -> LanguageServerWatchedPaths {
10762 let project = cx.weak_entity();
10763
10764 const LSP_ABS_PATH_OBSERVE: Duration = Duration::from_millis(100);
10765 let abs_paths = self
10766 .abs_paths
10767 .into_iter()
10768 .map(|(abs_path, globset)| {
10769 let task = cx.spawn({
10770 let abs_path = abs_path.clone();
10771 let fs = fs.clone();
10772
10773 let lsp_store = project.clone();
10774 async move |_, cx| {
10775 maybe!(async move {
10776 let mut push_updates = fs.watch(&abs_path, LSP_ABS_PATH_OBSERVE).await;
10777 while let Some(update) = push_updates.0.next().await {
10778 let action = lsp_store
10779 .update(cx, |this, _| {
10780 let Some(local) = this.as_local() else {
10781 return ControlFlow::Break(());
10782 };
10783 let Some(watcher) = local
10784 .language_server_watched_paths
10785 .get(&language_server_id)
10786 else {
10787 return ControlFlow::Break(());
10788 };
10789 let (globs, _) = watcher.abs_paths.get(&abs_path).expect(
10790 "Watched abs path is not registered with a watcher",
10791 );
10792 let matching_entries = update
10793 .into_iter()
10794 .filter(|event| globs.is_match(&event.path))
10795 .collect::<Vec<_>>();
10796 this.lsp_notify_abs_paths_changed(
10797 language_server_id,
10798 matching_entries,
10799 );
10800 ControlFlow::Continue(())
10801 })
10802 .ok()?;
10803
10804 if action.is_break() {
10805 break;
10806 }
10807 }
10808 Some(())
10809 })
10810 .await;
10811 }
10812 });
10813 (abs_path, (globset, task))
10814 })
10815 .collect();
10816 LanguageServerWatchedPaths {
10817 worktree_paths: self.worktree_paths,
10818 abs_paths,
10819 }
10820 }
10821}
10822
10823struct LspBufferSnapshot {
10824 version: i32,
10825 snapshot: TextBufferSnapshot,
10826}
10827
10828/// A prompt requested by LSP server.
10829#[derive(Clone, Debug)]
10830pub struct LanguageServerPromptRequest {
10831 pub level: PromptLevel,
10832 pub message: String,
10833 pub actions: Vec<MessageActionItem>,
10834 pub lsp_name: String,
10835 pub(crate) response_channel: Sender<MessageActionItem>,
10836}
10837
10838impl LanguageServerPromptRequest {
10839 pub async fn respond(self, index: usize) -> Option<()> {
10840 if let Some(response) = self.actions.into_iter().nth(index) {
10841 self.response_channel.send(response).await.ok()
10842 } else {
10843 None
10844 }
10845 }
10846}
10847impl PartialEq for LanguageServerPromptRequest {
10848 fn eq(&self, other: &Self) -> bool {
10849 self.message == other.message && self.actions == other.actions
10850 }
10851}
10852
10853#[derive(Clone, Debug, PartialEq)]
10854pub enum LanguageServerLogType {
10855 Log(MessageType),
10856 Trace(Option<String>),
10857}
10858
10859impl LanguageServerLogType {
10860 pub fn to_proto(&self) -> proto::language_server_log::LogType {
10861 match self {
10862 Self::Log(log_type) => {
10863 let message_type = match *log_type {
10864 MessageType::ERROR => 1,
10865 MessageType::WARNING => 2,
10866 MessageType::INFO => 3,
10867 MessageType::LOG => 4,
10868 other => {
10869 log::warn!("Unknown lsp log message type: {:?}", other);
10870 4
10871 }
10872 };
10873 proto::language_server_log::LogType::LogMessageType(message_type)
10874 }
10875 Self::Trace(message) => {
10876 proto::language_server_log::LogType::LogTrace(proto::LspLogTrace {
10877 message: message.clone(),
10878 })
10879 }
10880 }
10881 }
10882
10883 pub fn from_proto(log_type: proto::language_server_log::LogType) -> Self {
10884 match log_type {
10885 proto::language_server_log::LogType::LogMessageType(message_type) => {
10886 Self::Log(match message_type {
10887 1 => MessageType::ERROR,
10888 2 => MessageType::WARNING,
10889 3 => MessageType::INFO,
10890 4 => MessageType::LOG,
10891 _ => MessageType::LOG,
10892 })
10893 }
10894 proto::language_server_log::LogType::LogTrace(trace) => Self::Trace(trace.message),
10895 }
10896 }
10897}
10898
10899pub enum LanguageServerState {
10900 Starting {
10901 startup: Task<Option<Arc<LanguageServer>>>,
10902 /// List of language servers that will be added to the workspace once it's initialization completes.
10903 pending_workspace_folders: Arc<Mutex<BTreeSet<Url>>>,
10904 },
10905
10906 Running {
10907 adapter: Arc<CachedLspAdapter>,
10908 server: Arc<LanguageServer>,
10909 simulate_disk_based_diagnostics_completion: Option<Task<()>>,
10910 workspace_refresh_task: Option<(mpsc::Sender<()>, Task<()>)>,
10911 },
10912}
10913
10914impl LanguageServerState {
10915 fn add_workspace_folder(&self, uri: Url) {
10916 match self {
10917 LanguageServerState::Starting {
10918 pending_workspace_folders,
10919 ..
10920 } => {
10921 pending_workspace_folders.lock().insert(uri);
10922 }
10923 LanguageServerState::Running { server, .. } => {
10924 server.add_workspace_folder(uri);
10925 }
10926 }
10927 }
10928 fn _remove_workspace_folder(&self, uri: Url) {
10929 match self {
10930 LanguageServerState::Starting {
10931 pending_workspace_folders,
10932 ..
10933 } => {
10934 pending_workspace_folders.lock().remove(&uri);
10935 }
10936 LanguageServerState::Running { server, .. } => server.remove_workspace_folder(uri),
10937 }
10938 }
10939}
10940
10941impl std::fmt::Debug for LanguageServerState {
10942 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
10943 match self {
10944 LanguageServerState::Starting { .. } => {
10945 f.debug_struct("LanguageServerState::Starting").finish()
10946 }
10947 LanguageServerState::Running { .. } => {
10948 f.debug_struct("LanguageServerState::Running").finish()
10949 }
10950 }
10951 }
10952}
10953
10954#[derive(Clone, Debug, Serialize)]
10955pub struct LanguageServerProgress {
10956 pub is_disk_based_diagnostics_progress: bool,
10957 pub is_cancellable: bool,
10958 pub title: Option<String>,
10959 pub message: Option<String>,
10960 pub percentage: Option<usize>,
10961 #[serde(skip_serializing)]
10962 pub last_update_at: Instant,
10963}
10964
10965#[derive(Copy, Clone, Debug, Default, PartialEq, Serialize)]
10966pub struct DiagnosticSummary {
10967 pub error_count: usize,
10968 pub warning_count: usize,
10969}
10970
10971impl DiagnosticSummary {
10972 pub fn new<'a, T: 'a>(diagnostics: impl IntoIterator<Item = &'a DiagnosticEntry<T>>) -> Self {
10973 let mut this = Self {
10974 error_count: 0,
10975 warning_count: 0,
10976 };
10977
10978 for entry in diagnostics {
10979 if entry.diagnostic.is_primary {
10980 match entry.diagnostic.severity {
10981 DiagnosticSeverity::ERROR => this.error_count += 1,
10982 DiagnosticSeverity::WARNING => this.warning_count += 1,
10983 _ => {}
10984 }
10985 }
10986 }
10987
10988 this
10989 }
10990
10991 pub fn is_empty(&self) -> bool {
10992 self.error_count == 0 && self.warning_count == 0
10993 }
10994
10995 pub fn to_proto(
10996 &self,
10997 language_server_id: LanguageServerId,
10998 path: &Path,
10999 ) -> proto::DiagnosticSummary {
11000 proto::DiagnosticSummary {
11001 path: path.to_proto(),
11002 language_server_id: language_server_id.0 as u64,
11003 error_count: self.error_count as u32,
11004 warning_count: self.warning_count as u32,
11005 }
11006 }
11007}
11008
11009#[derive(Clone, Debug)]
11010pub enum CompletionDocumentation {
11011 /// There is no documentation for this completion.
11012 Undocumented,
11013 /// A single line of documentation.
11014 SingleLine(SharedString),
11015 /// Multiple lines of plain text documentation.
11016 MultiLinePlainText(SharedString),
11017 /// Markdown documentation.
11018 MultiLineMarkdown(SharedString),
11019 /// Both single line and multiple lines of plain text documentation.
11020 SingleLineAndMultiLinePlainText {
11021 single_line: SharedString,
11022 plain_text: Option<SharedString>,
11023 },
11024}
11025
11026impl From<lsp::Documentation> for CompletionDocumentation {
11027 fn from(docs: lsp::Documentation) -> Self {
11028 match docs {
11029 lsp::Documentation::String(text) => {
11030 if text.lines().count() <= 1 {
11031 CompletionDocumentation::SingleLine(text.into())
11032 } else {
11033 CompletionDocumentation::MultiLinePlainText(text.into())
11034 }
11035 }
11036
11037 lsp::Documentation::MarkupContent(lsp::MarkupContent { kind, value }) => match kind {
11038 lsp::MarkupKind::PlainText => {
11039 if value.lines().count() <= 1 {
11040 CompletionDocumentation::SingleLine(value.into())
11041 } else {
11042 CompletionDocumentation::MultiLinePlainText(value.into())
11043 }
11044 }
11045
11046 lsp::MarkupKind::Markdown => {
11047 CompletionDocumentation::MultiLineMarkdown(value.into())
11048 }
11049 },
11050 }
11051 }
11052}
11053
11054fn glob_literal_prefix(glob: &Path) -> PathBuf {
11055 glob.components()
11056 .take_while(|component| match component {
11057 path::Component::Normal(part) => !part.to_string_lossy().contains(['*', '?', '{', '}']),
11058 _ => true,
11059 })
11060 .collect()
11061}
11062
11063pub struct SshLspAdapter {
11064 name: LanguageServerName,
11065 binary: LanguageServerBinary,
11066 initialization_options: Option<String>,
11067 code_action_kinds: Option<Vec<CodeActionKind>>,
11068}
11069
11070impl SshLspAdapter {
11071 pub fn new(
11072 name: LanguageServerName,
11073 binary: LanguageServerBinary,
11074 initialization_options: Option<String>,
11075 code_action_kinds: Option<String>,
11076 ) -> Self {
11077 Self {
11078 name,
11079 binary,
11080 initialization_options,
11081 code_action_kinds: code_action_kinds
11082 .as_ref()
11083 .and_then(|c| serde_json::from_str(c).ok()),
11084 }
11085 }
11086}
11087
11088#[async_trait(?Send)]
11089impl LspAdapter for SshLspAdapter {
11090 fn name(&self) -> LanguageServerName {
11091 self.name.clone()
11092 }
11093
11094 async fn initialization_options(
11095 self: Arc<Self>,
11096 _: &dyn Fs,
11097 _: &Arc<dyn LspAdapterDelegate>,
11098 ) -> Result<Option<serde_json::Value>> {
11099 let Some(options) = &self.initialization_options else {
11100 return Ok(None);
11101 };
11102 let result = serde_json::from_str(options)?;
11103 Ok(result)
11104 }
11105
11106 fn code_action_kinds(&self) -> Option<Vec<CodeActionKind>> {
11107 self.code_action_kinds.clone()
11108 }
11109
11110 async fn check_if_user_installed(
11111 &self,
11112 _: &dyn LspAdapterDelegate,
11113 _: Arc<dyn LanguageToolchainStore>,
11114 _: &AsyncApp,
11115 ) -> Option<LanguageServerBinary> {
11116 Some(self.binary.clone())
11117 }
11118
11119 async fn cached_server_binary(
11120 &self,
11121 _: PathBuf,
11122 _: &dyn LspAdapterDelegate,
11123 ) -> Option<LanguageServerBinary> {
11124 None
11125 }
11126
11127 async fn fetch_latest_server_version(
11128 &self,
11129 _: &dyn LspAdapterDelegate,
11130 ) -> Result<Box<dyn 'static + Send + Any>> {
11131 anyhow::bail!("SshLspAdapter does not support fetch_latest_server_version")
11132 }
11133
11134 async fn fetch_server_binary(
11135 &self,
11136 _: Box<dyn 'static + Send + Any>,
11137 _: PathBuf,
11138 _: &dyn LspAdapterDelegate,
11139 ) -> Result<LanguageServerBinary> {
11140 anyhow::bail!("SshLspAdapter does not support fetch_server_binary")
11141 }
11142}
11143
11144pub fn language_server_settings<'a>(
11145 delegate: &'a dyn LspAdapterDelegate,
11146 language: &LanguageServerName,
11147 cx: &'a App,
11148) -> Option<&'a LspSettings> {
11149 language_server_settings_for(
11150 SettingsLocation {
11151 worktree_id: delegate.worktree_id(),
11152 path: delegate.worktree_root_path(),
11153 },
11154 language,
11155 cx,
11156 )
11157}
11158
11159pub(crate) fn language_server_settings_for<'a>(
11160 location: SettingsLocation<'a>,
11161 language: &LanguageServerName,
11162 cx: &'a App,
11163) -> Option<&'a LspSettings> {
11164 ProjectSettings::get(Some(location), cx).lsp.get(language)
11165}
11166
11167pub struct LocalLspAdapterDelegate {
11168 lsp_store: WeakEntity<LspStore>,
11169 worktree: worktree::Snapshot,
11170 fs: Arc<dyn Fs>,
11171 http_client: Arc<dyn HttpClient>,
11172 language_registry: Arc<LanguageRegistry>,
11173 load_shell_env_task: Shared<Task<Option<HashMap<String, String>>>>,
11174}
11175
11176impl LocalLspAdapterDelegate {
11177 pub fn new(
11178 language_registry: Arc<LanguageRegistry>,
11179 environment: &Entity<ProjectEnvironment>,
11180 lsp_store: WeakEntity<LspStore>,
11181 worktree: &Entity<Worktree>,
11182 http_client: Arc<dyn HttpClient>,
11183 fs: Arc<dyn Fs>,
11184 cx: &mut App,
11185 ) -> Arc<Self> {
11186 let load_shell_env_task = environment.update(cx, |env, cx| {
11187 env.get_worktree_environment(worktree.clone(), cx)
11188 });
11189
11190 Arc::new(Self {
11191 lsp_store,
11192 worktree: worktree.read(cx).snapshot(),
11193 fs,
11194 http_client,
11195 language_registry,
11196 load_shell_env_task,
11197 })
11198 }
11199
11200 fn from_local_lsp(
11201 local: &LocalLspStore,
11202 worktree: &Entity<Worktree>,
11203 cx: &mut App,
11204 ) -> Arc<Self> {
11205 Self::new(
11206 local.languages.clone(),
11207 &local.environment,
11208 local.weak.clone(),
11209 worktree,
11210 local.http_client.clone(),
11211 local.fs.clone(),
11212 cx,
11213 )
11214 }
11215}
11216
11217#[async_trait]
11218impl LspAdapterDelegate for LocalLspAdapterDelegate {
11219 fn show_notification(&self, message: &str, cx: &mut App) {
11220 self.lsp_store
11221 .update(cx, |_, cx| {
11222 cx.emit(LspStoreEvent::Notification(message.to_owned()))
11223 })
11224 .ok();
11225 }
11226
11227 fn http_client(&self) -> Arc<dyn HttpClient> {
11228 self.http_client.clone()
11229 }
11230
11231 fn worktree_id(&self) -> WorktreeId {
11232 self.worktree.id()
11233 }
11234
11235 fn worktree_root_path(&self) -> &Path {
11236 self.worktree.abs_path().as_ref()
11237 }
11238
11239 async fn shell_env(&self) -> HashMap<String, String> {
11240 let task = self.load_shell_env_task.clone();
11241 task.await.unwrap_or_default()
11242 }
11243
11244 async fn npm_package_installed_version(
11245 &self,
11246 package_name: &str,
11247 ) -> Result<Option<(PathBuf, String)>> {
11248 let local_package_directory = self.worktree_root_path();
11249 let node_modules_directory = local_package_directory.join("node_modules");
11250
11251 if let Some(version) =
11252 read_package_installed_version(node_modules_directory.clone(), package_name).await?
11253 {
11254 return Ok(Some((node_modules_directory, version)));
11255 }
11256 let Some(npm) = self.which("npm".as_ref()).await else {
11257 log::warn!(
11258 "Failed to find npm executable for {:?}",
11259 local_package_directory
11260 );
11261 return Ok(None);
11262 };
11263
11264 let env = self.shell_env().await;
11265 let output = util::command::new_smol_command(&npm)
11266 .args(["root", "-g"])
11267 .envs(env)
11268 .current_dir(local_package_directory)
11269 .output()
11270 .await?;
11271 let global_node_modules =
11272 PathBuf::from(String::from_utf8_lossy(&output.stdout).to_string());
11273
11274 if let Some(version) =
11275 read_package_installed_version(global_node_modules.clone(), package_name).await?
11276 {
11277 return Ok(Some((global_node_modules, version)));
11278 }
11279 return Ok(None);
11280 }
11281
11282 #[cfg(not(target_os = "windows"))]
11283 async fn which(&self, command: &OsStr) -> Option<PathBuf> {
11284 let worktree_abs_path = self.worktree.abs_path();
11285 let shell_path = self.shell_env().await.get("PATH").cloned();
11286 which::which_in(command, shell_path.as_ref(), worktree_abs_path).ok()
11287 }
11288
11289 #[cfg(target_os = "windows")]
11290 async fn which(&self, command: &OsStr) -> Option<PathBuf> {
11291 // todo(windows) Getting the shell env variables in a current directory on Windows is more complicated than other platforms
11292 // there isn't a 'default shell' necessarily. The closest would be the default profile on the windows terminal
11293 // SEE: https://learn.microsoft.com/en-us/windows/terminal/customize-settings/startup
11294 which::which(command).ok()
11295 }
11296
11297 async fn try_exec(&self, command: LanguageServerBinary) -> Result<()> {
11298 let working_dir = self.worktree_root_path();
11299 let output = util::command::new_smol_command(&command.path)
11300 .args(command.arguments)
11301 .envs(command.env.clone().unwrap_or_default())
11302 .current_dir(working_dir)
11303 .output()
11304 .await?;
11305
11306 anyhow::ensure!(
11307 output.status.success(),
11308 "{}, stdout: {:?}, stderr: {:?}",
11309 output.status,
11310 String::from_utf8_lossy(&output.stdout),
11311 String::from_utf8_lossy(&output.stderr)
11312 );
11313 Ok(())
11314 }
11315
11316 fn update_status(&self, server_name: LanguageServerName, status: language::BinaryStatus) {
11317 self.language_registry
11318 .update_lsp_status(server_name, LanguageServerStatusUpdate::Binary(status));
11319 }
11320
11321 fn registered_lsp_adapters(&self) -> Vec<Arc<dyn LspAdapter>> {
11322 self.language_registry
11323 .all_lsp_adapters()
11324 .into_iter()
11325 .map(|adapter| adapter.adapter.clone() as Arc<dyn LspAdapter>)
11326 .collect()
11327 }
11328
11329 async fn language_server_download_dir(&self, name: &LanguageServerName) -> Option<Arc<Path>> {
11330 let dir = self.language_registry.language_server_download_dir(name)?;
11331
11332 if !dir.exists() {
11333 smol::fs::create_dir_all(&dir)
11334 .await
11335 .context("failed to create container directory")
11336 .log_err()?;
11337 }
11338
11339 Some(dir)
11340 }
11341
11342 async fn read_text_file(&self, path: PathBuf) -> Result<String> {
11343 let entry = self
11344 .worktree
11345 .entry_for_path(&path)
11346 .with_context(|| format!("no worktree entry for path {path:?}"))?;
11347 let abs_path = self
11348 .worktree
11349 .absolutize(&entry.path)
11350 .with_context(|| format!("cannot absolutize path {path:?}"))?;
11351
11352 self.fs.load(&abs_path).await
11353 }
11354}
11355
11356async fn populate_labels_for_symbols(
11357 symbols: Vec<CoreSymbol>,
11358 language_registry: &Arc<LanguageRegistry>,
11359 lsp_adapter: Option<Arc<CachedLspAdapter>>,
11360 output: &mut Vec<Symbol>,
11361) {
11362 #[allow(clippy::mutable_key_type)]
11363 let mut symbols_by_language = HashMap::<Option<Arc<Language>>, Vec<CoreSymbol>>::default();
11364
11365 let mut unknown_paths = BTreeSet::new();
11366 for symbol in symbols {
11367 let language = language_registry
11368 .language_for_file_path(&symbol.path.path)
11369 .await
11370 .ok()
11371 .or_else(|| {
11372 unknown_paths.insert(symbol.path.path.clone());
11373 None
11374 });
11375 symbols_by_language
11376 .entry(language)
11377 .or_default()
11378 .push(symbol);
11379 }
11380
11381 for unknown_path in unknown_paths {
11382 log::info!(
11383 "no language found for symbol path {}",
11384 unknown_path.display()
11385 );
11386 }
11387
11388 let mut label_params = Vec::new();
11389 for (language, mut symbols) in symbols_by_language {
11390 label_params.clear();
11391 label_params.extend(
11392 symbols
11393 .iter_mut()
11394 .map(|symbol| (mem::take(&mut symbol.name), symbol.kind)),
11395 );
11396
11397 let mut labels = Vec::new();
11398 if let Some(language) = language {
11399 let lsp_adapter = lsp_adapter.clone().or_else(|| {
11400 language_registry
11401 .lsp_adapters(&language.name())
11402 .first()
11403 .cloned()
11404 });
11405 if let Some(lsp_adapter) = lsp_adapter {
11406 labels = lsp_adapter
11407 .labels_for_symbols(&label_params, &language)
11408 .await
11409 .log_err()
11410 .unwrap_or_default();
11411 }
11412 }
11413
11414 for ((symbol, (name, _)), label) in symbols
11415 .into_iter()
11416 .zip(label_params.drain(..))
11417 .zip(labels.into_iter().chain(iter::repeat(None)))
11418 {
11419 output.push(Symbol {
11420 language_server_name: symbol.language_server_name,
11421 source_worktree_id: symbol.source_worktree_id,
11422 source_language_server_id: symbol.source_language_server_id,
11423 path: symbol.path,
11424 label: label.unwrap_or_else(|| CodeLabel::plain(name.clone(), None)),
11425 name,
11426 kind: symbol.kind,
11427 range: symbol.range,
11428 signature: symbol.signature,
11429 });
11430 }
11431 }
11432}
11433
11434fn include_text(server: &lsp::LanguageServer) -> Option<bool> {
11435 match server.capabilities().text_document_sync.as_ref()? {
11436 lsp::TextDocumentSyncCapability::Kind(kind) => match *kind {
11437 lsp::TextDocumentSyncKind::NONE => None,
11438 lsp::TextDocumentSyncKind::FULL => Some(true),
11439 lsp::TextDocumentSyncKind::INCREMENTAL => Some(false),
11440 _ => None,
11441 },
11442 lsp::TextDocumentSyncCapability::Options(options) => match options.save.as_ref()? {
11443 lsp::TextDocumentSyncSaveOptions::Supported(supported) => {
11444 if *supported {
11445 Some(true)
11446 } else {
11447 None
11448 }
11449 }
11450 lsp::TextDocumentSyncSaveOptions::SaveOptions(save_options) => {
11451 Some(save_options.include_text.unwrap_or(false))
11452 }
11453 },
11454 }
11455}
11456
11457/// Completion items are displayed in a `UniformList`.
11458/// Usually, those items are single-line strings, but in LSP responses,
11459/// completion items `label`, `detail` and `label_details.description` may contain newlines or long spaces.
11460/// Many language plugins construct these items by joining these parts together, and we may use `CodeLabel::fallback_for_completion` that uses `label` at least.
11461/// 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,
11462/// breaking the completions menu presentation.
11463///
11464/// 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.
11465fn ensure_uniform_list_compatible_label(label: &mut CodeLabel) {
11466 let mut new_text = String::with_capacity(label.text.len());
11467 let mut offset_map = vec![0; label.text.len() + 1];
11468 let mut last_char_was_space = false;
11469 let mut new_idx = 0;
11470 let mut chars = label.text.char_indices().fuse();
11471 let mut newlines_removed = false;
11472
11473 while let Some((idx, c)) = chars.next() {
11474 offset_map[idx] = new_idx;
11475
11476 match c {
11477 '\n' if last_char_was_space => {
11478 newlines_removed = true;
11479 }
11480 '\t' | ' ' if last_char_was_space => {}
11481 '\n' if !last_char_was_space => {
11482 new_text.push(' ');
11483 new_idx += 1;
11484 last_char_was_space = true;
11485 newlines_removed = true;
11486 }
11487 ' ' | '\t' => {
11488 new_text.push(' ');
11489 new_idx += 1;
11490 last_char_was_space = true;
11491 }
11492 _ => {
11493 new_text.push(c);
11494 new_idx += c.len_utf8();
11495 last_char_was_space = false;
11496 }
11497 }
11498 }
11499 offset_map[label.text.len()] = new_idx;
11500
11501 // Only modify the label if newlines were removed.
11502 if !newlines_removed {
11503 return;
11504 }
11505
11506 let last_index = new_idx;
11507 let mut run_ranges_errors = Vec::new();
11508 label.runs.retain_mut(|(range, _)| {
11509 match offset_map.get(range.start) {
11510 Some(&start) => range.start = start,
11511 None => {
11512 run_ranges_errors.push(range.clone());
11513 return false;
11514 }
11515 }
11516
11517 match offset_map.get(range.end) {
11518 Some(&end) => range.end = end,
11519 None => {
11520 run_ranges_errors.push(range.clone());
11521 range.end = last_index;
11522 }
11523 }
11524 true
11525 });
11526 if !run_ranges_errors.is_empty() {
11527 log::error!(
11528 "Completion label has errors in its run ranges: {run_ranges_errors:?}, label text: {}",
11529 label.text
11530 );
11531 }
11532
11533 let mut wrong_filter_range = None;
11534 if label.filter_range == (0..label.text.len()) {
11535 label.filter_range = 0..new_text.len();
11536 } else {
11537 let mut original_filter_range = Some(label.filter_range.clone());
11538 match offset_map.get(label.filter_range.start) {
11539 Some(&start) => label.filter_range.start = start,
11540 None => {
11541 wrong_filter_range = original_filter_range.take();
11542 label.filter_range.start = last_index;
11543 }
11544 }
11545
11546 match offset_map.get(label.filter_range.end) {
11547 Some(&end) => label.filter_range.end = end,
11548 None => {
11549 wrong_filter_range = original_filter_range.take();
11550 label.filter_range.end = last_index;
11551 }
11552 }
11553 }
11554 if let Some(wrong_filter_range) = wrong_filter_range {
11555 log::error!(
11556 "Completion label has an invalid filter range: {wrong_filter_range:?}, label text: {}",
11557 label.text
11558 );
11559 }
11560
11561 label.text = new_text;
11562}
11563
11564#[cfg(test)]
11565mod tests {
11566 use language::HighlightId;
11567
11568 use super::*;
11569
11570 #[test]
11571 fn test_glob_literal_prefix() {
11572 assert_eq!(glob_literal_prefix(Path::new("**/*.js")), Path::new(""));
11573 assert_eq!(
11574 glob_literal_prefix(Path::new("node_modules/**/*.js")),
11575 Path::new("node_modules")
11576 );
11577 assert_eq!(
11578 glob_literal_prefix(Path::new("foo/{bar,baz}.js")),
11579 Path::new("foo")
11580 );
11581 assert_eq!(
11582 glob_literal_prefix(Path::new("foo/bar/baz.js")),
11583 Path::new("foo/bar/baz.js")
11584 );
11585
11586 #[cfg(target_os = "windows")]
11587 {
11588 assert_eq!(glob_literal_prefix(Path::new("**\\*.js")), Path::new(""));
11589 assert_eq!(
11590 glob_literal_prefix(Path::new("node_modules\\**/*.js")),
11591 Path::new("node_modules")
11592 );
11593 assert_eq!(
11594 glob_literal_prefix(Path::new("foo/{bar,baz}.js")),
11595 Path::new("foo")
11596 );
11597 assert_eq!(
11598 glob_literal_prefix(Path::new("foo\\bar\\baz.js")),
11599 Path::new("foo/bar/baz.js")
11600 );
11601 }
11602 }
11603
11604 #[test]
11605 fn test_multi_len_chars_normalization() {
11606 let mut label = CodeLabel {
11607 text: "myElˇ (parameter) myElˇ: {\n foo: string;\n}".to_string(),
11608 runs: vec![(0..6, HighlightId(1))],
11609 filter_range: 0..6,
11610 };
11611 ensure_uniform_list_compatible_label(&mut label);
11612 assert_eq!(
11613 label,
11614 CodeLabel {
11615 text: "myElˇ (parameter) myElˇ: { foo: string; }".to_string(),
11616 runs: vec![(0..6, HighlightId(1))],
11617 filter_range: 0..6,
11618 }
11619 );
11620 }
11621}