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