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