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