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