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