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