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