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