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