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