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