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