1use std::{
2 cmp,
3 ops::{ControlFlow, Range},
4 sync::Arc,
5 time::Duration,
6};
7
8use crate::{
9 display_map::Inlay, Anchor, Editor, ExcerptId, InlayId, MultiBuffer, MultiBufferSnapshot,
10};
11use anyhow::Context;
12use clock::Global;
13use futures::future;
14use gpui::{Model, ModelContext, Task, ViewContext};
15use language::{language_settings::InlayHintKind, Buffer, BufferSnapshot};
16use parking_lot::RwLock;
17use project::{InlayHint, ResolveState};
18
19use collections::{hash_map, HashMap, HashSet};
20use language::language_settings::InlayHintSettings;
21use smol::lock::Semaphore;
22use sum_tree::Bias;
23use text::{ToOffset, ToPoint};
24use util::post_inc;
25
26pub struct InlayHintCache {
27 hints: HashMap<ExcerptId, Arc<RwLock<CachedExcerptHints>>>,
28 allowed_hint_kinds: HashSet<Option<InlayHintKind>>,
29 version: usize,
30 pub(super) enabled: bool,
31 update_tasks: HashMap<ExcerptId, TasksForRanges>,
32 lsp_request_limiter: Arc<Semaphore>,
33}
34
35#[derive(Debug)]
36struct TasksForRanges {
37 tasks: Vec<Task<()>>,
38 sorted_ranges: Vec<Range<language::Anchor>>,
39}
40
41#[derive(Debug)]
42pub struct CachedExcerptHints {
43 version: usize,
44 buffer_version: Global,
45 buffer_id: u64,
46 ordered_hints: Vec<InlayId>,
47 hints_by_id: HashMap<InlayId, InlayHint>,
48}
49
50#[derive(Debug, Clone, Copy)]
51pub enum InvalidationStrategy {
52 RefreshRequested,
53 BufferEdited,
54 None,
55}
56
57#[derive(Debug, Default)]
58pub struct InlaySplice {
59 pub to_remove: Vec<InlayId>,
60 pub to_insert: Vec<Inlay>,
61}
62
63#[derive(Debug)]
64struct ExcerptHintsUpdate {
65 excerpt_id: ExcerptId,
66 remove_from_visible: Vec<InlayId>,
67 remove_from_cache: HashSet<InlayId>,
68 add_to_cache: Vec<InlayHint>,
69}
70
71#[derive(Debug, Clone, Copy)]
72struct ExcerptQuery {
73 buffer_id: u64,
74 excerpt_id: ExcerptId,
75 cache_version: usize,
76 invalidate: InvalidationStrategy,
77 reason: &'static str,
78}
79
80impl InvalidationStrategy {
81 fn should_invalidate(&self) -> bool {
82 matches!(
83 self,
84 InvalidationStrategy::RefreshRequested | InvalidationStrategy::BufferEdited
85 )
86 }
87}
88
89impl TasksForRanges {
90 fn new(query_ranges: QueryRanges, task: Task<()>) -> Self {
91 let mut sorted_ranges = Vec::new();
92 sorted_ranges.extend(query_ranges.before_visible);
93 sorted_ranges.extend(query_ranges.visible);
94 sorted_ranges.extend(query_ranges.after_visible);
95 Self {
96 tasks: vec![task],
97 sorted_ranges,
98 }
99 }
100
101 fn update_cached_tasks(
102 &mut self,
103 buffer_snapshot: &BufferSnapshot,
104 query_ranges: QueryRanges,
105 invalidate: InvalidationStrategy,
106 spawn_task: impl FnOnce(QueryRanges) -> Task<()>,
107 ) {
108 let query_ranges = if invalidate.should_invalidate() {
109 self.tasks.clear();
110 self.sorted_ranges.clear();
111 query_ranges
112 } else {
113 let mut non_cached_query_ranges = query_ranges;
114 non_cached_query_ranges.before_visible = non_cached_query_ranges
115 .before_visible
116 .into_iter()
117 .flat_map(|query_range| {
118 self.remove_cached_ranges_from_query(buffer_snapshot, query_range)
119 })
120 .collect();
121 non_cached_query_ranges.visible = non_cached_query_ranges
122 .visible
123 .into_iter()
124 .flat_map(|query_range| {
125 self.remove_cached_ranges_from_query(buffer_snapshot, query_range)
126 })
127 .collect();
128 non_cached_query_ranges.after_visible = non_cached_query_ranges
129 .after_visible
130 .into_iter()
131 .flat_map(|query_range| {
132 self.remove_cached_ranges_from_query(buffer_snapshot, query_range)
133 })
134 .collect();
135 non_cached_query_ranges
136 };
137
138 if !query_ranges.is_empty() {
139 self.tasks.push(spawn_task(query_ranges));
140 }
141 }
142
143 fn remove_cached_ranges_from_query(
144 &mut self,
145 buffer_snapshot: &BufferSnapshot,
146 query_range: Range<language::Anchor>,
147 ) -> Vec<Range<language::Anchor>> {
148 let mut ranges_to_query = Vec::new();
149 let mut latest_cached_range = None::<&mut Range<language::Anchor>>;
150 for cached_range in self
151 .sorted_ranges
152 .iter_mut()
153 .skip_while(|cached_range| {
154 cached_range
155 .end
156 .cmp(&query_range.start, buffer_snapshot)
157 .is_lt()
158 })
159 .take_while(|cached_range| {
160 cached_range
161 .start
162 .cmp(&query_range.end, buffer_snapshot)
163 .is_le()
164 })
165 {
166 match latest_cached_range {
167 Some(latest_cached_range) => {
168 if latest_cached_range.end.offset.saturating_add(1) < cached_range.start.offset
169 {
170 ranges_to_query.push(latest_cached_range.end..cached_range.start);
171 cached_range.start = latest_cached_range.end;
172 }
173 }
174 None => {
175 if query_range
176 .start
177 .cmp(&cached_range.start, buffer_snapshot)
178 .is_lt()
179 {
180 ranges_to_query.push(query_range.start..cached_range.start);
181 cached_range.start = query_range.start;
182 }
183 }
184 }
185 latest_cached_range = Some(cached_range);
186 }
187
188 match latest_cached_range {
189 Some(latest_cached_range) => {
190 if latest_cached_range.end.offset.saturating_add(1) < query_range.end.offset {
191 ranges_to_query.push(latest_cached_range.end..query_range.end);
192 latest_cached_range.end = query_range.end;
193 }
194 }
195 None => {
196 ranges_to_query.push(query_range.clone());
197 self.sorted_ranges.push(query_range);
198 self.sorted_ranges
199 .sort_by(|range_a, range_b| range_a.start.cmp(&range_b.start, buffer_snapshot));
200 }
201 }
202
203 ranges_to_query
204 }
205
206 fn invalidate_range(&mut self, buffer: &BufferSnapshot, range: &Range<language::Anchor>) {
207 self.sorted_ranges = self
208 .sorted_ranges
209 .drain(..)
210 .filter_map(|mut cached_range| {
211 if cached_range.start.cmp(&range.end, buffer).is_gt()
212 || cached_range.end.cmp(&range.start, buffer).is_lt()
213 {
214 Some(vec![cached_range])
215 } else if cached_range.start.cmp(&range.start, buffer).is_ge()
216 && cached_range.end.cmp(&range.end, buffer).is_le()
217 {
218 None
219 } else if range.start.cmp(&cached_range.start, buffer).is_ge()
220 && range.end.cmp(&cached_range.end, buffer).is_le()
221 {
222 Some(vec![
223 cached_range.start..range.start,
224 range.end..cached_range.end,
225 ])
226 } else if cached_range.start.cmp(&range.start, buffer).is_ge() {
227 cached_range.start = range.end;
228 Some(vec![cached_range])
229 } else {
230 cached_range.end = range.start;
231 Some(vec![cached_range])
232 }
233 })
234 .flatten()
235 .collect();
236 }
237}
238
239impl InlayHintCache {
240 pub fn new(inlay_hint_settings: InlayHintSettings) -> Self {
241 Self {
242 allowed_hint_kinds: inlay_hint_settings.enabled_inlay_hint_kinds(),
243 enabled: inlay_hint_settings.enabled,
244 hints: HashMap::default(),
245 update_tasks: HashMap::default(),
246 version: 0,
247 lsp_request_limiter: Arc::new(Semaphore::new(MAX_CONCURRENT_LSP_REQUESTS)),
248 }
249 }
250
251 pub fn update_settings(
252 &mut self,
253 multi_buffer: &Model<MultiBuffer>,
254 new_hint_settings: InlayHintSettings,
255 visible_hints: Vec<Inlay>,
256 cx: &mut ViewContext<Editor>,
257 ) -> ControlFlow<Option<InlaySplice>> {
258 let new_allowed_hint_kinds = new_hint_settings.enabled_inlay_hint_kinds();
259 match (self.enabled, new_hint_settings.enabled) {
260 (false, false) => {
261 self.allowed_hint_kinds = new_allowed_hint_kinds;
262 ControlFlow::Break(None)
263 }
264 (true, true) => {
265 if new_allowed_hint_kinds == self.allowed_hint_kinds {
266 ControlFlow::Break(None)
267 } else {
268 let new_splice = self.new_allowed_hint_kinds_splice(
269 multi_buffer,
270 &visible_hints,
271 &new_allowed_hint_kinds,
272 cx,
273 );
274 if new_splice.is_some() {
275 self.version += 1;
276 self.allowed_hint_kinds = new_allowed_hint_kinds;
277 }
278 ControlFlow::Break(new_splice)
279 }
280 }
281 (true, false) => {
282 self.enabled = new_hint_settings.enabled;
283 self.allowed_hint_kinds = new_allowed_hint_kinds;
284 if self.hints.is_empty() {
285 ControlFlow::Break(None)
286 } else {
287 self.clear();
288 ControlFlow::Break(Some(InlaySplice {
289 to_remove: visible_hints.iter().map(|inlay| inlay.id).collect(),
290 to_insert: Vec::new(),
291 }))
292 }
293 }
294 (false, true) => {
295 self.enabled = new_hint_settings.enabled;
296 self.allowed_hint_kinds = new_allowed_hint_kinds;
297 ControlFlow::Continue(())
298 }
299 }
300 }
301
302 pub fn spawn_hint_refresh(
303 &mut self,
304 reason: &'static str,
305 excerpts_to_query: HashMap<ExcerptId, (Model<Buffer>, Global, Range<usize>)>,
306 invalidate: InvalidationStrategy,
307 cx: &mut ViewContext<Editor>,
308 ) -> Option<InlaySplice> {
309 if !self.enabled {
310 return None;
311 }
312
313 let mut invalidated_hints = Vec::new();
314 if invalidate.should_invalidate() {
315 self.update_tasks
316 .retain(|task_excerpt_id, _| excerpts_to_query.contains_key(task_excerpt_id));
317 self.hints.retain(|cached_excerpt, cached_hints| {
318 let retain = excerpts_to_query.contains_key(cached_excerpt);
319 if !retain {
320 invalidated_hints.extend(cached_hints.read().ordered_hints.iter().copied());
321 }
322 retain
323 });
324 }
325 if excerpts_to_query.is_empty() && invalidated_hints.is_empty() {
326 return None;
327 }
328
329 let cache_version = self.version + 1;
330 cx.spawn(|editor, mut cx| async move {
331 editor
332 .update(&mut cx, |editor, cx| {
333 spawn_new_update_tasks(
334 editor,
335 reason,
336 excerpts_to_query,
337 invalidate,
338 cache_version,
339 cx,
340 )
341 })
342 .ok();
343 })
344 .detach();
345
346 if invalidated_hints.is_empty() {
347 None
348 } else {
349 Some(InlaySplice {
350 to_remove: invalidated_hints,
351 to_insert: Vec::new(),
352 })
353 }
354 }
355
356 fn new_allowed_hint_kinds_splice(
357 &self,
358 multi_buffer: &Model<MultiBuffer>,
359 visible_hints: &[Inlay],
360 new_kinds: &HashSet<Option<InlayHintKind>>,
361 cx: &mut ViewContext<Editor>,
362 ) -> Option<InlaySplice> {
363 let old_kinds = &self.allowed_hint_kinds;
364 if new_kinds == old_kinds {
365 return None;
366 }
367
368 let mut to_remove = Vec::new();
369 let mut to_insert = Vec::new();
370 let mut shown_hints_to_remove = visible_hints.iter().fold(
371 HashMap::<ExcerptId, Vec<(Anchor, InlayId)>>::default(),
372 |mut current_hints, inlay| {
373 current_hints
374 .entry(inlay.position.excerpt_id)
375 .or_default()
376 .push((inlay.position, inlay.id));
377 current_hints
378 },
379 );
380
381 let multi_buffer = multi_buffer.read(cx);
382 let multi_buffer_snapshot = multi_buffer.snapshot(cx);
383
384 for (excerpt_id, excerpt_cached_hints) in &self.hints {
385 let shown_excerpt_hints_to_remove =
386 shown_hints_to_remove.entry(*excerpt_id).or_default();
387 let excerpt_cached_hints = excerpt_cached_hints.read();
388 let mut excerpt_cache = excerpt_cached_hints.ordered_hints.iter().fuse().peekable();
389 shown_excerpt_hints_to_remove.retain(|(shown_anchor, shown_hint_id)| {
390 let Some(buffer) = shown_anchor
391 .buffer_id
392 .and_then(|buffer_id| multi_buffer.buffer(buffer_id))
393 else {
394 return false;
395 };
396 let buffer_snapshot = buffer.read(cx).snapshot();
397 loop {
398 match excerpt_cache.peek() {
399 Some(&cached_hint_id) => {
400 let cached_hint = &excerpt_cached_hints.hints_by_id[cached_hint_id];
401 if cached_hint_id == shown_hint_id {
402 excerpt_cache.next();
403 return !new_kinds.contains(&cached_hint.kind);
404 }
405
406 match cached_hint
407 .position
408 .cmp(&shown_anchor.text_anchor, &buffer_snapshot)
409 {
410 cmp::Ordering::Less | cmp::Ordering::Equal => {
411 if !old_kinds.contains(&cached_hint.kind)
412 && new_kinds.contains(&cached_hint.kind)
413 {
414 to_insert.push(Inlay::hint(
415 cached_hint_id.id(),
416 multi_buffer_snapshot.anchor_in_excerpt(
417 *excerpt_id,
418 cached_hint.position,
419 ),
420 &cached_hint,
421 ));
422 }
423 excerpt_cache.next();
424 }
425 cmp::Ordering::Greater => return true,
426 }
427 }
428 None => return true,
429 }
430 }
431 });
432
433 for cached_hint_id in excerpt_cache {
434 let maybe_missed_cached_hint = &excerpt_cached_hints.hints_by_id[cached_hint_id];
435 let cached_hint_kind = maybe_missed_cached_hint.kind;
436 if !old_kinds.contains(&cached_hint_kind) && new_kinds.contains(&cached_hint_kind) {
437 to_insert.push(Inlay::hint(
438 cached_hint_id.id(),
439 multi_buffer_snapshot
440 .anchor_in_excerpt(*excerpt_id, maybe_missed_cached_hint.position),
441 &maybe_missed_cached_hint,
442 ));
443 }
444 }
445 }
446
447 to_remove.extend(
448 shown_hints_to_remove
449 .into_values()
450 .flatten()
451 .map(|(_, hint_id)| hint_id),
452 );
453 if to_remove.is_empty() && to_insert.is_empty() {
454 None
455 } else {
456 Some(InlaySplice {
457 to_remove,
458 to_insert,
459 })
460 }
461 }
462
463 pub fn remove_excerpts(&mut self, excerpts_removed: Vec<ExcerptId>) -> Option<InlaySplice> {
464 let mut to_remove = Vec::new();
465 for excerpt_to_remove in excerpts_removed {
466 self.update_tasks.remove(&excerpt_to_remove);
467 if let Some(cached_hints) = self.hints.remove(&excerpt_to_remove) {
468 let cached_hints = cached_hints.read();
469 to_remove.extend(cached_hints.ordered_hints.iter().copied());
470 }
471 }
472 if to_remove.is_empty() {
473 None
474 } else {
475 self.version += 1;
476 Some(InlaySplice {
477 to_remove,
478 to_insert: Vec::new(),
479 })
480 }
481 }
482
483 pub fn clear(&mut self) {
484 if !self.update_tasks.is_empty() || !self.hints.is_empty() {
485 self.version += 1;
486 }
487 self.update_tasks.clear();
488 self.hints.clear();
489 }
490
491 pub fn hint_by_id(&self, excerpt_id: ExcerptId, hint_id: InlayId) -> Option<InlayHint> {
492 self.hints
493 .get(&excerpt_id)?
494 .read()
495 .hints_by_id
496 .get(&hint_id)
497 .cloned()
498 }
499
500 pub fn hints(&self) -> Vec<InlayHint> {
501 let mut hints = Vec::new();
502 for excerpt_hints in self.hints.values() {
503 let excerpt_hints = excerpt_hints.read();
504 hints.extend(
505 excerpt_hints
506 .ordered_hints
507 .iter()
508 .map(|id| &excerpt_hints.hints_by_id[id])
509 .cloned(),
510 );
511 }
512 hints
513 }
514
515 pub fn version(&self) -> usize {
516 self.version
517 }
518
519 pub fn spawn_hint_resolve(
520 &self,
521 buffer_id: u64,
522 excerpt_id: ExcerptId,
523 id: InlayId,
524 cx: &mut ViewContext<'_, Editor>,
525 ) {
526 if let Some(excerpt_hints) = self.hints.get(&excerpt_id) {
527 let mut guard = excerpt_hints.write();
528 if let Some(cached_hint) = guard.hints_by_id.get_mut(&id) {
529 if let ResolveState::CanResolve(server_id, _) = &cached_hint.resolve_state {
530 let hint_to_resolve = cached_hint.clone();
531 let server_id = *server_id;
532 cached_hint.resolve_state = ResolveState::Resolving;
533 drop(guard);
534 cx.spawn(|editor, mut cx| async move {
535 let resolved_hint_task = editor.update(&mut cx, |editor, cx| {
536 editor
537 .buffer()
538 .read(cx)
539 .buffer(buffer_id)
540 .and_then(|buffer| {
541 let project = editor.project.as_ref()?;
542 Some(project.update(cx, |project, cx| {
543 project.resolve_inlay_hint(
544 hint_to_resolve,
545 buffer,
546 server_id,
547 cx,
548 )
549 }))
550 })
551 })?;
552 if let Some(resolved_hint_task) = resolved_hint_task {
553 let mut resolved_hint =
554 resolved_hint_task.await.context("hint resolve task")?;
555 editor.update(&mut cx, |editor, _| {
556 if let Some(excerpt_hints) =
557 editor.inlay_hint_cache.hints.get(&excerpt_id)
558 {
559 let mut guard = excerpt_hints.write();
560 if let Some(cached_hint) = guard.hints_by_id.get_mut(&id) {
561 if cached_hint.resolve_state == ResolveState::Resolving {
562 resolved_hint.resolve_state = ResolveState::Resolved;
563 *cached_hint = resolved_hint;
564 }
565 }
566 }
567 })?;
568 }
569
570 anyhow::Ok(())
571 })
572 .detach_and_log_err(cx);
573 }
574 }
575 }
576 }
577}
578
579fn spawn_new_update_tasks(
580 editor: &mut Editor,
581 reason: &'static str,
582 excerpts_to_query: HashMap<ExcerptId, (Model<Buffer>, Global, Range<usize>)>,
583 invalidate: InvalidationStrategy,
584 update_cache_version: usize,
585 cx: &mut ViewContext<'_, Editor>,
586) {
587 let visible_hints = Arc::new(editor.visible_inlay_hints(cx));
588 for (excerpt_id, (excerpt_buffer, new_task_buffer_version, excerpt_visible_range)) in
589 excerpts_to_query
590 {
591 if excerpt_visible_range.is_empty() {
592 continue;
593 }
594 let buffer = excerpt_buffer.read(cx);
595 let buffer_id = buffer.remote_id();
596 let buffer_snapshot = buffer.snapshot();
597 if buffer_snapshot
598 .version()
599 .changed_since(&new_task_buffer_version)
600 {
601 continue;
602 }
603
604 let cached_excerpt_hints = editor.inlay_hint_cache.hints.get(&excerpt_id).cloned();
605 if let Some(cached_excerpt_hints) = &cached_excerpt_hints {
606 let cached_excerpt_hints = cached_excerpt_hints.read();
607 let cached_buffer_version = &cached_excerpt_hints.buffer_version;
608 if cached_excerpt_hints.version > update_cache_version
609 || cached_buffer_version.changed_since(&new_task_buffer_version)
610 {
611 continue;
612 }
613 };
614
615 let (multi_buffer_snapshot, Some(query_ranges)) =
616 editor.buffer.update(cx, |multi_buffer, cx| {
617 (
618 multi_buffer.snapshot(cx),
619 determine_query_ranges(
620 multi_buffer,
621 excerpt_id,
622 &excerpt_buffer,
623 excerpt_visible_range,
624 cx,
625 ),
626 )
627 })
628 else {
629 return;
630 };
631 let query = ExcerptQuery {
632 buffer_id,
633 excerpt_id,
634 cache_version: update_cache_version,
635 invalidate,
636 reason,
637 };
638
639 let new_update_task = |query_ranges| {
640 new_update_task(
641 query,
642 query_ranges,
643 multi_buffer_snapshot,
644 buffer_snapshot.clone(),
645 Arc::clone(&visible_hints),
646 cached_excerpt_hints,
647 Arc::clone(&editor.inlay_hint_cache.lsp_request_limiter),
648 cx,
649 )
650 };
651
652 match editor.inlay_hint_cache.update_tasks.entry(excerpt_id) {
653 hash_map::Entry::Occupied(mut o) => {
654 o.get_mut().update_cached_tasks(
655 &buffer_snapshot,
656 query_ranges,
657 invalidate,
658 new_update_task,
659 );
660 }
661 hash_map::Entry::Vacant(v) => {
662 v.insert(TasksForRanges::new(
663 query_ranges.clone(),
664 new_update_task(query_ranges),
665 ));
666 }
667 }
668 }
669}
670
671#[derive(Debug, Clone)]
672struct QueryRanges {
673 before_visible: Vec<Range<language::Anchor>>,
674 visible: Vec<Range<language::Anchor>>,
675 after_visible: Vec<Range<language::Anchor>>,
676}
677
678impl QueryRanges {
679 fn is_empty(&self) -> bool {
680 self.before_visible.is_empty() && self.visible.is_empty() && self.after_visible.is_empty()
681 }
682}
683
684fn determine_query_ranges(
685 multi_buffer: &mut MultiBuffer,
686 excerpt_id: ExcerptId,
687 excerpt_buffer: &Model<Buffer>,
688 excerpt_visible_range: Range<usize>,
689 cx: &mut ModelContext<'_, MultiBuffer>,
690) -> Option<QueryRanges> {
691 let full_excerpt_range = multi_buffer
692 .excerpts_for_buffer(excerpt_buffer, cx)
693 .into_iter()
694 .find(|(id, _)| id == &excerpt_id)
695 .map(|(_, range)| range.context)?;
696 let buffer = excerpt_buffer.read(cx);
697 let snapshot = buffer.snapshot();
698 let excerpt_visible_len = excerpt_visible_range.end - excerpt_visible_range.start;
699
700 let visible_range = if excerpt_visible_range.start == excerpt_visible_range.end {
701 return None;
702 } else {
703 vec![
704 buffer.anchor_before(snapshot.clip_offset(excerpt_visible_range.start, Bias::Left))
705 ..buffer.anchor_after(snapshot.clip_offset(excerpt_visible_range.end, Bias::Right)),
706 ]
707 };
708
709 let full_excerpt_range_end_offset = full_excerpt_range.end.to_offset(&snapshot);
710 let after_visible_range_start = excerpt_visible_range
711 .end
712 .saturating_add(1)
713 .min(full_excerpt_range_end_offset)
714 .min(buffer.len());
715 let after_visible_range = if after_visible_range_start == full_excerpt_range_end_offset {
716 Vec::new()
717 } else {
718 let after_range_end_offset = after_visible_range_start
719 .saturating_add(excerpt_visible_len)
720 .min(full_excerpt_range_end_offset)
721 .min(buffer.len());
722 vec![
723 buffer.anchor_before(snapshot.clip_offset(after_visible_range_start, Bias::Left))
724 ..buffer.anchor_after(snapshot.clip_offset(after_range_end_offset, Bias::Right)),
725 ]
726 };
727
728 let full_excerpt_range_start_offset = full_excerpt_range.start.to_offset(&snapshot);
729 let before_visible_range_end = excerpt_visible_range
730 .start
731 .saturating_sub(1)
732 .max(full_excerpt_range_start_offset);
733 let before_visible_range = if before_visible_range_end == full_excerpt_range_start_offset {
734 Vec::new()
735 } else {
736 let before_range_start_offset = before_visible_range_end
737 .saturating_sub(excerpt_visible_len)
738 .max(full_excerpt_range_start_offset);
739 vec![
740 buffer.anchor_before(snapshot.clip_offset(before_range_start_offset, Bias::Left))
741 ..buffer.anchor_after(snapshot.clip_offset(before_visible_range_end, Bias::Right)),
742 ]
743 };
744
745 Some(QueryRanges {
746 before_visible: before_visible_range,
747 visible: visible_range,
748 after_visible: after_visible_range,
749 })
750}
751
752const MAX_CONCURRENT_LSP_REQUESTS: usize = 5;
753const INVISIBLE_RANGES_HINTS_REQUEST_DELAY_MILLIS: u64 = 400;
754
755fn new_update_task(
756 query: ExcerptQuery,
757 query_ranges: QueryRanges,
758 multi_buffer_snapshot: MultiBufferSnapshot,
759 buffer_snapshot: BufferSnapshot,
760 visible_hints: Arc<Vec<Inlay>>,
761 cached_excerpt_hints: Option<Arc<RwLock<CachedExcerptHints>>>,
762 lsp_request_limiter: Arc<Semaphore>,
763 cx: &mut ViewContext<'_, Editor>,
764) -> Task<()> {
765 cx.spawn(|editor, mut cx| async move {
766 let closure_cx = cx.clone();
767 let fetch_and_update_hints = |invalidate, range| {
768 fetch_and_update_hints(
769 editor.clone(),
770 multi_buffer_snapshot.clone(),
771 buffer_snapshot.clone(),
772 Arc::clone(&visible_hints),
773 cached_excerpt_hints.as_ref().map(Arc::clone),
774 query,
775 invalidate,
776 range,
777 Arc::clone(&lsp_request_limiter),
778 closure_cx.clone(),
779 )
780 };
781 let visible_range_update_results = future::join_all(query_ranges.visible.into_iter().map(
782 |visible_range| async move {
783 (
784 visible_range.clone(),
785 fetch_and_update_hints(query.invalidate.should_invalidate(), visible_range)
786 .await,
787 )
788 },
789 ))
790 .await;
791
792 let hint_delay = cx.background_executor().timer(Duration::from_millis(
793 INVISIBLE_RANGES_HINTS_REQUEST_DELAY_MILLIS,
794 ));
795
796 let mut query_range_failed = |range: &Range<language::Anchor>, e: anyhow::Error| {
797 log::error!("inlay hint update task for range {range:?} failed: {e:#}");
798 editor
799 .update(&mut cx, |editor, _| {
800 if let Some(task_ranges) = editor
801 .inlay_hint_cache
802 .update_tasks
803 .get_mut(&query.excerpt_id)
804 {
805 task_ranges.invalidate_range(&buffer_snapshot, &range);
806 }
807 })
808 .ok()
809 };
810
811 for (range, result) in visible_range_update_results {
812 if let Err(e) = result {
813 query_range_failed(&range, e);
814 }
815 }
816
817 hint_delay.await;
818 let invisible_range_update_results = future::join_all(
819 query_ranges
820 .before_visible
821 .into_iter()
822 .chain(query_ranges.after_visible.into_iter())
823 .map(|invisible_range| async move {
824 (
825 invisible_range.clone(),
826 fetch_and_update_hints(false, invisible_range).await,
827 )
828 }),
829 )
830 .await;
831 for (range, result) in invisible_range_update_results {
832 if let Err(e) = result {
833 query_range_failed(&range, e);
834 }
835 }
836 })
837}
838
839async fn fetch_and_update_hints(
840 editor: gpui::WeakView<Editor>,
841 multi_buffer_snapshot: MultiBufferSnapshot,
842 buffer_snapshot: BufferSnapshot,
843 visible_hints: Arc<Vec<Inlay>>,
844 cached_excerpt_hints: Option<Arc<RwLock<CachedExcerptHints>>>,
845 query: ExcerptQuery,
846 invalidate: bool,
847 fetch_range: Range<language::Anchor>,
848 lsp_request_limiter: Arc<Semaphore>,
849 mut cx: gpui::AsyncWindowContext,
850) -> anyhow::Result<()> {
851 let (lsp_request_guard, got_throttled) = if query.invalidate.should_invalidate() {
852 (None, false)
853 } else {
854 match lsp_request_limiter.try_acquire() {
855 Some(guard) => (Some(guard), false),
856 None => (Some(lsp_request_limiter.acquire().await), true),
857 }
858 };
859 let fetch_range_to_log =
860 fetch_range.start.to_point(&buffer_snapshot)..fetch_range.end.to_point(&buffer_snapshot);
861 let inlay_hints_fetch_task = editor
862 .update(&mut cx, |editor, cx| {
863 if got_throttled {
864 let query_not_around_visible_range = match editor.excerpts_for_inlay_hints_query(None, cx).remove(&query.excerpt_id) {
865 Some((_, _, current_visible_range)) => {
866 let visible_offset_length = current_visible_range.len();
867 let double_visible_range = current_visible_range
868 .start
869 .saturating_sub(visible_offset_length)
870 ..current_visible_range
871 .end
872 .saturating_add(visible_offset_length)
873 .min(buffer_snapshot.len());
874 !double_visible_range
875 .contains(&fetch_range.start.to_offset(&buffer_snapshot))
876 && !double_visible_range
877 .contains(&fetch_range.end.to_offset(&buffer_snapshot))
878 },
879 None => true,
880 };
881 if query_not_around_visible_range {
882 log::trace!("Fetching inlay hints for range {fetch_range_to_log:?} got throttled and fell off the current visible range, skipping.");
883 if let Some(task_ranges) = editor
884 .inlay_hint_cache
885 .update_tasks
886 .get_mut(&query.excerpt_id)
887 {
888 task_ranges.invalidate_range(&buffer_snapshot, &fetch_range);
889 }
890 return None;
891 }
892 }
893 editor
894 .buffer()
895 .read(cx)
896 .buffer(query.buffer_id)
897 .and_then(|buffer| {
898 let project = editor.project.as_ref()?;
899 Some(project.update(cx, |project, cx| {
900 project.inlay_hints(buffer, fetch_range.clone(), cx)
901 }))
902 })
903 })
904 .ok()
905 .flatten();
906 let new_hints = match inlay_hints_fetch_task {
907 Some(fetch_task) => {
908 log::debug!(
909 "Fetching inlay hints for range {fetch_range_to_log:?}, reason: {query_reason}, invalidate: {invalidate}",
910 query_reason = query.reason,
911 );
912 log::trace!(
913 "Currently visible hints: {visible_hints:?}, cached hints present: {}",
914 cached_excerpt_hints.is_some(),
915 );
916 fetch_task.await.context("inlay hint fetch task")?
917 }
918 None => return Ok(()),
919 };
920 drop(lsp_request_guard);
921 log::debug!(
922 "Fetched {} hints for range {fetch_range_to_log:?}",
923 new_hints.len()
924 );
925 log::trace!("Fetched hints: {new_hints:?}");
926
927 let background_task_buffer_snapshot = buffer_snapshot.clone();
928 let backround_fetch_range = fetch_range.clone();
929 let new_update = cx
930 .background_executor()
931 .spawn(async move {
932 calculate_hint_updates(
933 query.excerpt_id,
934 invalidate,
935 backround_fetch_range,
936 new_hints,
937 &background_task_buffer_snapshot,
938 cached_excerpt_hints,
939 &visible_hints,
940 )
941 })
942 .await;
943 if let Some(new_update) = new_update {
944 log::debug!(
945 "Applying update for range {fetch_range_to_log:?}: remove from editor: {}, remove from cache: {}, add to cache: {}",
946 new_update.remove_from_visible.len(),
947 new_update.remove_from_cache.len(),
948 new_update.add_to_cache.len()
949 );
950 log::trace!("New update: {new_update:?}");
951 editor
952 .update(&mut cx, |editor, cx| {
953 apply_hint_update(
954 editor,
955 new_update,
956 query,
957 invalidate,
958 buffer_snapshot,
959 multi_buffer_snapshot,
960 cx,
961 );
962 })
963 .ok();
964 }
965 Ok(())
966}
967
968fn calculate_hint_updates(
969 excerpt_id: ExcerptId,
970 invalidate: bool,
971 fetch_range: Range<language::Anchor>,
972 new_excerpt_hints: Vec<InlayHint>,
973 buffer_snapshot: &BufferSnapshot,
974 cached_excerpt_hints: Option<Arc<RwLock<CachedExcerptHints>>>,
975 visible_hints: &[Inlay],
976) -> Option<ExcerptHintsUpdate> {
977 let mut add_to_cache = Vec::<InlayHint>::new();
978 let mut excerpt_hints_to_persist = HashMap::default();
979 for new_hint in new_excerpt_hints {
980 if !contains_position(&fetch_range, new_hint.position, buffer_snapshot) {
981 continue;
982 }
983 let missing_from_cache = match &cached_excerpt_hints {
984 Some(cached_excerpt_hints) => {
985 let cached_excerpt_hints = cached_excerpt_hints.read();
986 match cached_excerpt_hints
987 .ordered_hints
988 .binary_search_by(|probe| {
989 cached_excerpt_hints.hints_by_id[probe]
990 .position
991 .cmp(&new_hint.position, buffer_snapshot)
992 }) {
993 Ok(ix) => {
994 let mut missing_from_cache = true;
995 for id in &cached_excerpt_hints.ordered_hints[ix..] {
996 let cached_hint = &cached_excerpt_hints.hints_by_id[id];
997 if new_hint
998 .position
999 .cmp(&cached_hint.position, buffer_snapshot)
1000 .is_gt()
1001 {
1002 break;
1003 }
1004 if cached_hint == &new_hint {
1005 excerpt_hints_to_persist.insert(*id, cached_hint.kind);
1006 missing_from_cache = false;
1007 }
1008 }
1009 missing_from_cache
1010 }
1011 Err(_) => true,
1012 }
1013 }
1014 None => true,
1015 };
1016 if missing_from_cache {
1017 add_to_cache.push(new_hint);
1018 }
1019 }
1020
1021 let mut remove_from_visible = Vec::new();
1022 let mut remove_from_cache = HashSet::default();
1023 if invalidate {
1024 remove_from_visible.extend(
1025 visible_hints
1026 .iter()
1027 .filter(|hint| hint.position.excerpt_id == excerpt_id)
1028 .map(|inlay_hint| inlay_hint.id)
1029 .filter(|hint_id| !excerpt_hints_to_persist.contains_key(hint_id)),
1030 );
1031
1032 if let Some(cached_excerpt_hints) = &cached_excerpt_hints {
1033 let cached_excerpt_hints = cached_excerpt_hints.read();
1034 remove_from_cache.extend(
1035 cached_excerpt_hints
1036 .ordered_hints
1037 .iter()
1038 .filter(|cached_inlay_id| {
1039 !excerpt_hints_to_persist.contains_key(cached_inlay_id)
1040 })
1041 .copied(),
1042 );
1043 }
1044 }
1045
1046 if remove_from_visible.is_empty() && remove_from_cache.is_empty() && add_to_cache.is_empty() {
1047 None
1048 } else {
1049 Some(ExcerptHintsUpdate {
1050 excerpt_id,
1051 remove_from_visible,
1052 remove_from_cache,
1053 add_to_cache,
1054 })
1055 }
1056}
1057
1058fn contains_position(
1059 range: &Range<language::Anchor>,
1060 position: language::Anchor,
1061 buffer_snapshot: &BufferSnapshot,
1062) -> bool {
1063 range.start.cmp(&position, buffer_snapshot).is_le()
1064 && range.end.cmp(&position, buffer_snapshot).is_ge()
1065}
1066
1067fn apply_hint_update(
1068 editor: &mut Editor,
1069 new_update: ExcerptHintsUpdate,
1070 query: ExcerptQuery,
1071 invalidate: bool,
1072 buffer_snapshot: BufferSnapshot,
1073 multi_buffer_snapshot: MultiBufferSnapshot,
1074 cx: &mut ViewContext<'_, Editor>,
1075) {
1076 let cached_excerpt_hints = editor
1077 .inlay_hint_cache
1078 .hints
1079 .entry(new_update.excerpt_id)
1080 .or_insert_with(|| {
1081 Arc::new(RwLock::new(CachedExcerptHints {
1082 version: query.cache_version,
1083 buffer_version: buffer_snapshot.version().clone(),
1084 buffer_id: query.buffer_id,
1085 ordered_hints: Vec::new(),
1086 hints_by_id: HashMap::default(),
1087 }))
1088 });
1089 let mut cached_excerpt_hints = cached_excerpt_hints.write();
1090 match query.cache_version.cmp(&cached_excerpt_hints.version) {
1091 cmp::Ordering::Less => return,
1092 cmp::Ordering::Greater | cmp::Ordering::Equal => {
1093 cached_excerpt_hints.version = query.cache_version;
1094 }
1095 }
1096
1097 let mut cached_inlays_changed = !new_update.remove_from_cache.is_empty();
1098 cached_excerpt_hints
1099 .ordered_hints
1100 .retain(|hint_id| !new_update.remove_from_cache.contains(hint_id));
1101 cached_excerpt_hints
1102 .hints_by_id
1103 .retain(|hint_id, _| !new_update.remove_from_cache.contains(hint_id));
1104 let mut splice = InlaySplice {
1105 to_remove: new_update.remove_from_visible,
1106 to_insert: Vec::new(),
1107 };
1108 for new_hint in new_update.add_to_cache {
1109 let insert_position = match cached_excerpt_hints
1110 .ordered_hints
1111 .binary_search_by(|probe| {
1112 cached_excerpt_hints.hints_by_id[probe]
1113 .position
1114 .cmp(&new_hint.position, &buffer_snapshot)
1115 }) {
1116 Ok(i) => {
1117 let mut insert_position = Some(i);
1118 for id in &cached_excerpt_hints.ordered_hints[i..] {
1119 let cached_hint = &cached_excerpt_hints.hints_by_id[id];
1120 if new_hint
1121 .position
1122 .cmp(&cached_hint.position, &buffer_snapshot)
1123 .is_gt()
1124 {
1125 break;
1126 }
1127 if cached_hint.text() == new_hint.text() {
1128 insert_position = None;
1129 break;
1130 }
1131 }
1132 insert_position
1133 }
1134 Err(i) => Some(i),
1135 };
1136
1137 if let Some(insert_position) = insert_position {
1138 let new_inlay_id = post_inc(&mut editor.next_inlay_id);
1139 if editor
1140 .inlay_hint_cache
1141 .allowed_hint_kinds
1142 .contains(&new_hint.kind)
1143 {
1144 let new_hint_position =
1145 multi_buffer_snapshot.anchor_in_excerpt(query.excerpt_id, new_hint.position);
1146 splice
1147 .to_insert
1148 .push(Inlay::hint(new_inlay_id, new_hint_position, &new_hint));
1149 }
1150 let new_id = InlayId::Hint(new_inlay_id);
1151 cached_excerpt_hints.hints_by_id.insert(new_id, new_hint);
1152 cached_excerpt_hints
1153 .ordered_hints
1154 .insert(insert_position, new_id);
1155 cached_inlays_changed = true;
1156 }
1157 }
1158 cached_excerpt_hints.buffer_version = buffer_snapshot.version().clone();
1159 drop(cached_excerpt_hints);
1160
1161 if invalidate {
1162 let mut outdated_excerpt_caches = HashSet::default();
1163 for (excerpt_id, excerpt_hints) in &editor.inlay_hint_cache().hints {
1164 let excerpt_hints = excerpt_hints.read();
1165 if excerpt_hints.buffer_id == query.buffer_id
1166 && excerpt_id != &query.excerpt_id
1167 && buffer_snapshot
1168 .version()
1169 .changed_since(&excerpt_hints.buffer_version)
1170 {
1171 outdated_excerpt_caches.insert(*excerpt_id);
1172 splice
1173 .to_remove
1174 .extend(excerpt_hints.ordered_hints.iter().copied());
1175 }
1176 }
1177 cached_inlays_changed |= !outdated_excerpt_caches.is_empty();
1178 editor
1179 .inlay_hint_cache
1180 .hints
1181 .retain(|excerpt_id, _| !outdated_excerpt_caches.contains(excerpt_id));
1182 }
1183
1184 let InlaySplice {
1185 to_remove,
1186 to_insert,
1187 } = splice;
1188 let displayed_inlays_changed = !to_remove.is_empty() || !to_insert.is_empty();
1189 if cached_inlays_changed || displayed_inlays_changed {
1190 editor.inlay_hint_cache.version += 1;
1191 }
1192 if displayed_inlays_changed {
1193 editor.splice_inlay_hints(to_remove, to_insert, cx)
1194 }
1195}
1196
1197#[cfg(test)]
1198pub mod tests {
1199 use std::sync::atomic::{AtomicBool, AtomicU32, AtomicUsize, Ordering};
1200
1201 use crate::{
1202 scroll::{autoscroll::Autoscroll, scroll_amount::ScrollAmount},
1203 ExcerptRange,
1204 };
1205 use client::Client;
1206 use futures::StreamExt;
1207 use gpui::{Context, TestAppContext, View, WindowHandle};
1208 use itertools::Itertools;
1209 use language::{
1210 language_settings::AllLanguageSettingsContent, FakeLspAdapter, Language, LanguageConfig,
1211 };
1212 use lsp::FakeLanguageServer;
1213 use parking_lot::Mutex;
1214 use project::{FakeFs, Project};
1215 use serde_json::json;
1216 use settings::SettingsStore;
1217 use text::{Point, ToPoint};
1218 use util::http::FakeHttpClient;
1219 use workspace::Workspace;
1220
1221 use crate::editor_tests::update_test_language_settings;
1222
1223 use super::*;
1224
1225 #[gpui::test]
1226 async fn test_basic_cache_update_with_duplicate_hints(cx: &mut gpui::TestAppContext) {
1227 let allowed_hint_kinds = HashSet::from_iter([None, Some(InlayHintKind::Type)]);
1228 init_test(cx, |settings| {
1229 settings.defaults.inlay_hints = Some(InlayHintSettings {
1230 enabled: true,
1231 show_type_hints: allowed_hint_kinds.contains(&Some(InlayHintKind::Type)),
1232 show_parameter_hints: allowed_hint_kinds.contains(&Some(InlayHintKind::Parameter)),
1233 show_other_hints: allowed_hint_kinds.contains(&None),
1234 })
1235 });
1236
1237 let (file_with_hints, editor, fake_server) = prepare_test_objects(cx).await;
1238 let lsp_request_count = Arc::new(AtomicU32::new(0));
1239 fake_server
1240 .handle_request::<lsp::request::InlayHintRequest, _, _>(move |params, _| {
1241 let task_lsp_request_count = Arc::clone(&lsp_request_count);
1242 async move {
1243 assert_eq!(
1244 params.text_document.uri,
1245 lsp::Url::from_file_path(file_with_hints).unwrap(),
1246 );
1247 let current_call_id =
1248 Arc::clone(&task_lsp_request_count).fetch_add(1, Ordering::SeqCst);
1249 let mut new_hints = Vec::with_capacity(2 * current_call_id as usize);
1250 for _ in 0..2 {
1251 let mut i = current_call_id;
1252 loop {
1253 new_hints.push(lsp::InlayHint {
1254 position: lsp::Position::new(0, i),
1255 label: lsp::InlayHintLabel::String(i.to_string()),
1256 kind: None,
1257 text_edits: None,
1258 tooltip: None,
1259 padding_left: None,
1260 padding_right: None,
1261 data: None,
1262 });
1263 if i == 0 {
1264 break;
1265 }
1266 i -= 1;
1267 }
1268 }
1269
1270 Ok(Some(new_hints))
1271 }
1272 })
1273 .next()
1274 .await;
1275 cx.executor().run_until_parked();
1276
1277 let mut edits_made = 1;
1278 editor.update(cx, |editor, cx| {
1279 let expected_hints = vec!["0".to_string()];
1280 assert_eq!(
1281 expected_hints,
1282 cached_hint_labels(editor),
1283 "Should get its first hints when opening the editor"
1284 );
1285 assert_eq!(expected_hints, visible_hint_labels(editor, cx));
1286 let inlay_cache = editor.inlay_hint_cache();
1287 assert_eq!(
1288 inlay_cache.allowed_hint_kinds, allowed_hint_kinds,
1289 "Cache should use editor settings to get the allowed hint kinds"
1290 );
1291 assert_eq!(
1292 inlay_cache.version, edits_made,
1293 "The editor update the cache version after every cache/view change"
1294 );
1295 });
1296
1297 editor.update(cx, |editor, cx| {
1298 editor.change_selections(None, cx, |s| s.select_ranges([13..13]));
1299 editor.handle_input("some change", cx);
1300 edits_made += 1;
1301 });
1302 cx.executor().run_until_parked();
1303 editor.update(cx, |editor, cx| {
1304 let expected_hints = vec!["0".to_string(), "1".to_string()];
1305 assert_eq!(
1306 expected_hints,
1307 cached_hint_labels(editor),
1308 "Should get new hints after an edit"
1309 );
1310 assert_eq!(expected_hints, visible_hint_labels(editor, cx));
1311 let inlay_cache = editor.inlay_hint_cache();
1312 assert_eq!(
1313 inlay_cache.allowed_hint_kinds, allowed_hint_kinds,
1314 "Cache should use editor settings to get the allowed hint kinds"
1315 );
1316 assert_eq!(
1317 inlay_cache.version, edits_made,
1318 "The editor update the cache version after every cache/view change"
1319 );
1320 });
1321
1322 fake_server
1323 .request::<lsp::request::InlayHintRefreshRequest>(())
1324 .await
1325 .expect("inlay refresh request failed");
1326 edits_made += 1;
1327 cx.executor().run_until_parked();
1328 editor.update(cx, |editor, cx| {
1329 let expected_hints = vec!["0".to_string(), "1".to_string(), "2".to_string()];
1330 assert_eq!(
1331 expected_hints,
1332 cached_hint_labels(editor),
1333 "Should get new hints after hint refresh/ request"
1334 );
1335 assert_eq!(expected_hints, visible_hint_labels(editor, cx));
1336 let inlay_cache = editor.inlay_hint_cache();
1337 assert_eq!(
1338 inlay_cache.allowed_hint_kinds, allowed_hint_kinds,
1339 "Cache should use editor settings to get the allowed hint kinds"
1340 );
1341 assert_eq!(
1342 inlay_cache.version, edits_made,
1343 "The editor update the cache version after every cache/view change"
1344 );
1345 });
1346 }
1347
1348 #[gpui::test]
1349 async fn test_cache_update_on_lsp_completion_tasks(cx: &mut gpui::TestAppContext) {
1350 init_test(cx, |settings| {
1351 settings.defaults.inlay_hints = Some(InlayHintSettings {
1352 enabled: true,
1353 show_type_hints: true,
1354 show_parameter_hints: true,
1355 show_other_hints: true,
1356 })
1357 });
1358
1359 let (file_with_hints, editor, fake_server) = prepare_test_objects(cx).await;
1360 let lsp_request_count = Arc::new(AtomicU32::new(0));
1361 fake_server
1362 .handle_request::<lsp::request::InlayHintRequest, _, _>(move |params, _| {
1363 let task_lsp_request_count = Arc::clone(&lsp_request_count);
1364 async move {
1365 assert_eq!(
1366 params.text_document.uri,
1367 lsp::Url::from_file_path(file_with_hints).unwrap(),
1368 );
1369 let current_call_id =
1370 Arc::clone(&task_lsp_request_count).fetch_add(1, Ordering::SeqCst);
1371 Ok(Some(vec![lsp::InlayHint {
1372 position: lsp::Position::new(0, current_call_id),
1373 label: lsp::InlayHintLabel::String(current_call_id.to_string()),
1374 kind: None,
1375 text_edits: None,
1376 tooltip: None,
1377 padding_left: None,
1378 padding_right: None,
1379 data: None,
1380 }]))
1381 }
1382 })
1383 .next()
1384 .await;
1385 cx.executor().run_until_parked();
1386
1387 let mut edits_made = 1;
1388 editor.update(cx, |editor, cx| {
1389 let expected_hints = vec!["0".to_string()];
1390 assert_eq!(
1391 expected_hints,
1392 cached_hint_labels(editor),
1393 "Should get its first hints when opening the editor"
1394 );
1395 assert_eq!(expected_hints, visible_hint_labels(editor, cx));
1396 assert_eq!(
1397 editor.inlay_hint_cache().version,
1398 edits_made,
1399 "The editor update the cache version after every cache/view change"
1400 );
1401 });
1402
1403 let progress_token = "test_progress_token";
1404 fake_server
1405 .request::<lsp::request::WorkDoneProgressCreate>(lsp::WorkDoneProgressCreateParams {
1406 token: lsp::ProgressToken::String(progress_token.to_string()),
1407 })
1408 .await
1409 .expect("work done progress create request failed");
1410 cx.executor().run_until_parked();
1411 fake_server.notify::<lsp::notification::Progress>(lsp::ProgressParams {
1412 token: lsp::ProgressToken::String(progress_token.to_string()),
1413 value: lsp::ProgressParamsValue::WorkDone(lsp::WorkDoneProgress::Begin(
1414 lsp::WorkDoneProgressBegin::default(),
1415 )),
1416 });
1417 cx.executor().run_until_parked();
1418
1419 editor.update(cx, |editor, cx| {
1420 let expected_hints = vec!["0".to_string()];
1421 assert_eq!(
1422 expected_hints,
1423 cached_hint_labels(editor),
1424 "Should not update hints while the work task is running"
1425 );
1426 assert_eq!(expected_hints, visible_hint_labels(editor, cx));
1427 assert_eq!(
1428 editor.inlay_hint_cache().version,
1429 edits_made,
1430 "Should not update the cache while the work task is running"
1431 );
1432 });
1433
1434 fake_server.notify::<lsp::notification::Progress>(lsp::ProgressParams {
1435 token: lsp::ProgressToken::String(progress_token.to_string()),
1436 value: lsp::ProgressParamsValue::WorkDone(lsp::WorkDoneProgress::End(
1437 lsp::WorkDoneProgressEnd::default(),
1438 )),
1439 });
1440 cx.executor().run_until_parked();
1441
1442 edits_made += 1;
1443 editor.update(cx, |editor, cx| {
1444 let expected_hints = vec!["1".to_string()];
1445 assert_eq!(
1446 expected_hints,
1447 cached_hint_labels(editor),
1448 "New hints should be queried after the work task is done"
1449 );
1450 assert_eq!(expected_hints, visible_hint_labels(editor, cx));
1451 assert_eq!(
1452 editor.inlay_hint_cache().version,
1453 edits_made,
1454 "Cache version should udpate once after the work task is done"
1455 );
1456 });
1457 }
1458
1459 #[gpui::test]
1460 async fn test_no_hint_updates_for_unrelated_language_files(cx: &mut gpui::TestAppContext) {
1461 init_test(cx, |settings| {
1462 settings.defaults.inlay_hints = Some(InlayHintSettings {
1463 enabled: true,
1464 show_type_hints: true,
1465 show_parameter_hints: true,
1466 show_other_hints: true,
1467 })
1468 });
1469
1470 let fs = FakeFs::new(cx.background_executor.clone());
1471 fs.insert_tree(
1472 "/a",
1473 json!({
1474 "main.rs": "fn main() { a } // and some long comment to ensure inlays are not trimmed out",
1475 "other.md": "Test md file with some text",
1476 }),
1477 )
1478 .await;
1479 let project = Project::test(fs, ["/a".as_ref()], cx).await;
1480
1481 let mut rs_fake_servers = None;
1482 let mut md_fake_servers = None;
1483 for (name, path_suffix) in [("Rust", "rs"), ("Markdown", "md")] {
1484 let mut language = Language::new(
1485 LanguageConfig {
1486 name: name.into(),
1487 path_suffixes: vec![path_suffix.to_string()],
1488 ..Default::default()
1489 },
1490 Some(tree_sitter_rust::language()),
1491 );
1492 let fake_servers = language
1493 .set_fake_lsp_adapter(Arc::new(FakeLspAdapter {
1494 name,
1495 capabilities: lsp::ServerCapabilities {
1496 inlay_hint_provider: Some(lsp::OneOf::Left(true)),
1497 ..Default::default()
1498 },
1499 ..Default::default()
1500 }))
1501 .await;
1502 match name {
1503 "Rust" => rs_fake_servers = Some(fake_servers),
1504 "Markdown" => md_fake_servers = Some(fake_servers),
1505 _ => unreachable!(),
1506 }
1507 project.update(cx, |project, _| {
1508 project.languages().add(Arc::new(language));
1509 });
1510 }
1511
1512 let rs_buffer = project
1513 .update(cx, |project, cx| {
1514 project.open_local_buffer("/a/main.rs", cx)
1515 })
1516 .await
1517 .unwrap();
1518 cx.executor().run_until_parked();
1519 cx.executor().start_waiting();
1520 let rs_fake_server = rs_fake_servers.unwrap().next().await.unwrap();
1521 let rs_editor =
1522 cx.add_window(|cx| Editor::for_buffer(rs_buffer, Some(project.clone()), cx));
1523 let rs_lsp_request_count = Arc::new(AtomicU32::new(0));
1524 rs_fake_server
1525 .handle_request::<lsp::request::InlayHintRequest, _, _>(move |params, _| {
1526 let task_lsp_request_count = Arc::clone(&rs_lsp_request_count);
1527 async move {
1528 assert_eq!(
1529 params.text_document.uri,
1530 lsp::Url::from_file_path("/a/main.rs").unwrap(),
1531 );
1532 let i = Arc::clone(&task_lsp_request_count).fetch_add(1, Ordering::SeqCst);
1533 Ok(Some(vec![lsp::InlayHint {
1534 position: lsp::Position::new(0, i),
1535 label: lsp::InlayHintLabel::String(i.to_string()),
1536 kind: None,
1537 text_edits: None,
1538 tooltip: None,
1539 padding_left: None,
1540 padding_right: None,
1541 data: None,
1542 }]))
1543 }
1544 })
1545 .next()
1546 .await;
1547 cx.executor().run_until_parked();
1548 rs_editor.update(cx, |editor, cx| {
1549 let expected_hints = vec!["0".to_string()];
1550 assert_eq!(
1551 expected_hints,
1552 cached_hint_labels(editor),
1553 "Should get its first hints when opening the editor"
1554 );
1555 assert_eq!(expected_hints, visible_hint_labels(editor, cx));
1556 assert_eq!(
1557 editor.inlay_hint_cache().version,
1558 1,
1559 "Rust editor update the cache version after every cache/view change"
1560 );
1561 });
1562
1563 cx.executor().run_until_parked();
1564 let md_buffer = project
1565 .update(cx, |project, cx| {
1566 project.open_local_buffer("/a/other.md", cx)
1567 })
1568 .await
1569 .unwrap();
1570 cx.executor().run_until_parked();
1571 cx.executor().start_waiting();
1572 let md_fake_server = md_fake_servers.unwrap().next().await.unwrap();
1573 let md_editor = cx.add_window(|cx| Editor::for_buffer(md_buffer, Some(project), cx));
1574 let md_lsp_request_count = Arc::new(AtomicU32::new(0));
1575 md_fake_server
1576 .handle_request::<lsp::request::InlayHintRequest, _, _>(move |params, _| {
1577 let task_lsp_request_count = Arc::clone(&md_lsp_request_count);
1578 async move {
1579 assert_eq!(
1580 params.text_document.uri,
1581 lsp::Url::from_file_path("/a/other.md").unwrap(),
1582 );
1583 let i = Arc::clone(&task_lsp_request_count).fetch_add(1, Ordering::SeqCst);
1584 Ok(Some(vec![lsp::InlayHint {
1585 position: lsp::Position::new(0, i),
1586 label: lsp::InlayHintLabel::String(i.to_string()),
1587 kind: None,
1588 text_edits: None,
1589 tooltip: None,
1590 padding_left: None,
1591 padding_right: None,
1592 data: None,
1593 }]))
1594 }
1595 })
1596 .next()
1597 .await;
1598 cx.executor().run_until_parked();
1599 md_editor.update(cx, |editor, cx| {
1600 let expected_hints = vec!["0".to_string()];
1601 assert_eq!(
1602 expected_hints,
1603 cached_hint_labels(editor),
1604 "Markdown editor should have a separate verison, repeating Rust editor rules"
1605 );
1606 assert_eq!(expected_hints, visible_hint_labels(editor, cx));
1607 assert_eq!(editor.inlay_hint_cache().version, 1);
1608 });
1609
1610 rs_editor.update(cx, |editor, cx| {
1611 editor.change_selections(None, cx, |s| s.select_ranges([13..13]));
1612 editor.handle_input("some rs change", cx);
1613 });
1614 cx.executor().run_until_parked();
1615 rs_editor.update(cx, |editor, cx| {
1616 let expected_hints = vec!["1".to_string()];
1617 assert_eq!(
1618 expected_hints,
1619 cached_hint_labels(editor),
1620 "Rust inlay cache should change after the edit"
1621 );
1622 assert_eq!(expected_hints, visible_hint_labels(editor, cx));
1623 assert_eq!(
1624 editor.inlay_hint_cache().version,
1625 2,
1626 "Every time hint cache changes, cache version should be incremented"
1627 );
1628 });
1629 md_editor.update(cx, |editor, cx| {
1630 let expected_hints = vec!["0".to_string()];
1631 assert_eq!(
1632 expected_hints,
1633 cached_hint_labels(editor),
1634 "Markdown editor should not be affected by Rust editor changes"
1635 );
1636 assert_eq!(expected_hints, visible_hint_labels(editor, cx));
1637 assert_eq!(editor.inlay_hint_cache().version, 1);
1638 });
1639
1640 md_editor.update(cx, |editor, cx| {
1641 editor.change_selections(None, cx, |s| s.select_ranges([13..13]));
1642 editor.handle_input("some md change", cx);
1643 });
1644 cx.executor().run_until_parked();
1645 md_editor.update(cx, |editor, cx| {
1646 let expected_hints = vec!["1".to_string()];
1647 assert_eq!(
1648 expected_hints,
1649 cached_hint_labels(editor),
1650 "Rust editor should not be affected by Markdown editor changes"
1651 );
1652 assert_eq!(expected_hints, visible_hint_labels(editor, cx));
1653 assert_eq!(editor.inlay_hint_cache().version, 2);
1654 });
1655 rs_editor.update(cx, |editor, cx| {
1656 let expected_hints = vec!["1".to_string()];
1657 assert_eq!(
1658 expected_hints,
1659 cached_hint_labels(editor),
1660 "Markdown editor should also change independently"
1661 );
1662 assert_eq!(expected_hints, visible_hint_labels(editor, cx));
1663 assert_eq!(editor.inlay_hint_cache().version, 2);
1664 });
1665 }
1666
1667 #[gpui::test]
1668 async fn test_hint_setting_changes(cx: &mut gpui::TestAppContext) {
1669 let allowed_hint_kinds = HashSet::from_iter([None, Some(InlayHintKind::Type)]);
1670 init_test(cx, |settings| {
1671 settings.defaults.inlay_hints = Some(InlayHintSettings {
1672 enabled: true,
1673 show_type_hints: allowed_hint_kinds.contains(&Some(InlayHintKind::Type)),
1674 show_parameter_hints: allowed_hint_kinds.contains(&Some(InlayHintKind::Parameter)),
1675 show_other_hints: allowed_hint_kinds.contains(&None),
1676 })
1677 });
1678
1679 let (file_with_hints, editor, fake_server) = prepare_test_objects(cx).await;
1680 let lsp_request_count = Arc::new(AtomicU32::new(0));
1681 let another_lsp_request_count = Arc::clone(&lsp_request_count);
1682 fake_server
1683 .handle_request::<lsp::request::InlayHintRequest, _, _>(move |params, _| {
1684 let task_lsp_request_count = Arc::clone(&another_lsp_request_count);
1685 async move {
1686 Arc::clone(&task_lsp_request_count).fetch_add(1, Ordering::SeqCst);
1687 assert_eq!(
1688 params.text_document.uri,
1689 lsp::Url::from_file_path(file_with_hints).unwrap(),
1690 );
1691 Ok(Some(vec![
1692 lsp::InlayHint {
1693 position: lsp::Position::new(0, 1),
1694 label: lsp::InlayHintLabel::String("type hint".to_string()),
1695 kind: Some(lsp::InlayHintKind::TYPE),
1696 text_edits: None,
1697 tooltip: None,
1698 padding_left: None,
1699 padding_right: None,
1700 data: None,
1701 },
1702 lsp::InlayHint {
1703 position: lsp::Position::new(0, 2),
1704 label: lsp::InlayHintLabel::String("parameter hint".to_string()),
1705 kind: Some(lsp::InlayHintKind::PARAMETER),
1706 text_edits: None,
1707 tooltip: None,
1708 padding_left: None,
1709 padding_right: None,
1710 data: None,
1711 },
1712 lsp::InlayHint {
1713 position: lsp::Position::new(0, 3),
1714 label: lsp::InlayHintLabel::String("other hint".to_string()),
1715 kind: None,
1716 text_edits: None,
1717 tooltip: None,
1718 padding_left: None,
1719 padding_right: None,
1720 data: None,
1721 },
1722 ]))
1723 }
1724 })
1725 .next()
1726 .await;
1727 cx.executor().run_until_parked();
1728
1729 let mut edits_made = 1;
1730 editor.update(cx, |editor, cx| {
1731 assert_eq!(
1732 lsp_request_count.load(Ordering::Relaxed),
1733 1,
1734 "Should query new hints once"
1735 );
1736 assert_eq!(
1737 vec![
1738 "other hint".to_string(),
1739 "parameter hint".to_string(),
1740 "type hint".to_string(),
1741 ],
1742 cached_hint_labels(editor),
1743 "Should get its first hints when opening the editor"
1744 );
1745 assert_eq!(
1746 vec!["other hint".to_string(), "type hint".to_string()],
1747 visible_hint_labels(editor, cx)
1748 );
1749 let inlay_cache = editor.inlay_hint_cache();
1750 assert_eq!(
1751 inlay_cache.allowed_hint_kinds, allowed_hint_kinds,
1752 "Cache should use editor settings to get the allowed hint kinds"
1753 );
1754 assert_eq!(
1755 inlay_cache.version, edits_made,
1756 "The editor update the cache version after every cache/view change"
1757 );
1758 });
1759
1760 fake_server
1761 .request::<lsp::request::InlayHintRefreshRequest>(())
1762 .await
1763 .expect("inlay refresh request failed");
1764 cx.executor().run_until_parked();
1765 editor.update(cx, |editor, cx| {
1766 assert_eq!(
1767 lsp_request_count.load(Ordering::Relaxed),
1768 2,
1769 "Should load new hints twice"
1770 );
1771 assert_eq!(
1772 vec![
1773 "other hint".to_string(),
1774 "parameter hint".to_string(),
1775 "type hint".to_string(),
1776 ],
1777 cached_hint_labels(editor),
1778 "Cached hints should not change due to allowed hint kinds settings update"
1779 );
1780 assert_eq!(
1781 vec!["other hint".to_string(), "type hint".to_string()],
1782 visible_hint_labels(editor, cx)
1783 );
1784 assert_eq!(
1785 editor.inlay_hint_cache().version,
1786 edits_made,
1787 "Should not update cache version due to new loaded hints being the same"
1788 );
1789 });
1790
1791 for (new_allowed_hint_kinds, expected_visible_hints) in [
1792 (HashSet::from_iter([None]), vec!["other hint".to_string()]),
1793 (
1794 HashSet::from_iter([Some(InlayHintKind::Type)]),
1795 vec!["type hint".to_string()],
1796 ),
1797 (
1798 HashSet::from_iter([Some(InlayHintKind::Parameter)]),
1799 vec!["parameter hint".to_string()],
1800 ),
1801 (
1802 HashSet::from_iter([None, Some(InlayHintKind::Type)]),
1803 vec!["other hint".to_string(), "type hint".to_string()],
1804 ),
1805 (
1806 HashSet::from_iter([None, Some(InlayHintKind::Parameter)]),
1807 vec!["other hint".to_string(), "parameter hint".to_string()],
1808 ),
1809 (
1810 HashSet::from_iter([Some(InlayHintKind::Type), Some(InlayHintKind::Parameter)]),
1811 vec!["parameter hint".to_string(), "type hint".to_string()],
1812 ),
1813 (
1814 HashSet::from_iter([
1815 None,
1816 Some(InlayHintKind::Type),
1817 Some(InlayHintKind::Parameter),
1818 ]),
1819 vec![
1820 "other hint".to_string(),
1821 "parameter hint".to_string(),
1822 "type hint".to_string(),
1823 ],
1824 ),
1825 ] {
1826 edits_made += 1;
1827 update_test_language_settings(cx, |settings| {
1828 settings.defaults.inlay_hints = Some(InlayHintSettings {
1829 enabled: true,
1830 show_type_hints: new_allowed_hint_kinds.contains(&Some(InlayHintKind::Type)),
1831 show_parameter_hints: new_allowed_hint_kinds
1832 .contains(&Some(InlayHintKind::Parameter)),
1833 show_other_hints: new_allowed_hint_kinds.contains(&None),
1834 })
1835 });
1836 cx.executor().run_until_parked();
1837 editor.update(cx, |editor, cx| {
1838 assert_eq!(
1839 lsp_request_count.load(Ordering::Relaxed),
1840 2,
1841 "Should not load new hints on allowed hint kinds change for hint kinds {new_allowed_hint_kinds:?}"
1842 );
1843 assert_eq!(
1844 vec![
1845 "other hint".to_string(),
1846 "parameter hint".to_string(),
1847 "type hint".to_string(),
1848 ],
1849 cached_hint_labels(editor),
1850 "Should get its cached hints unchanged after the settings change for hint kinds {new_allowed_hint_kinds:?}"
1851 );
1852 assert_eq!(
1853 expected_visible_hints,
1854 visible_hint_labels(editor, cx),
1855 "Should get its visible hints filtered after the settings change for hint kinds {new_allowed_hint_kinds:?}"
1856 );
1857 let inlay_cache = editor.inlay_hint_cache();
1858 assert_eq!(
1859 inlay_cache.allowed_hint_kinds, new_allowed_hint_kinds,
1860 "Cache should use editor settings to get the allowed hint kinds for hint kinds {new_allowed_hint_kinds:?}"
1861 );
1862 assert_eq!(
1863 inlay_cache.version, edits_made,
1864 "The editor should update the cache version after every cache/view change for hint kinds {new_allowed_hint_kinds:?} due to visible hints change"
1865 );
1866 });
1867 }
1868
1869 edits_made += 1;
1870 let another_allowed_hint_kinds = HashSet::from_iter([Some(InlayHintKind::Type)]);
1871 update_test_language_settings(cx, |settings| {
1872 settings.defaults.inlay_hints = Some(InlayHintSettings {
1873 enabled: false,
1874 show_type_hints: another_allowed_hint_kinds.contains(&Some(InlayHintKind::Type)),
1875 show_parameter_hints: another_allowed_hint_kinds
1876 .contains(&Some(InlayHintKind::Parameter)),
1877 show_other_hints: another_allowed_hint_kinds.contains(&None),
1878 })
1879 });
1880 cx.executor().run_until_parked();
1881 editor.update(cx, |editor, cx| {
1882 assert_eq!(
1883 lsp_request_count.load(Ordering::Relaxed),
1884 2,
1885 "Should not load new hints when hints got disabled"
1886 );
1887 assert!(
1888 cached_hint_labels(editor).is_empty(),
1889 "Should clear the cache when hints got disabled"
1890 );
1891 assert!(
1892 visible_hint_labels(editor, cx).is_empty(),
1893 "Should clear visible hints when hints got disabled"
1894 );
1895 let inlay_cache = editor.inlay_hint_cache();
1896 assert_eq!(
1897 inlay_cache.allowed_hint_kinds, another_allowed_hint_kinds,
1898 "Should update its allowed hint kinds even when hints got disabled"
1899 );
1900 assert_eq!(
1901 inlay_cache.version, edits_made,
1902 "The editor should update the cache version after hints got disabled"
1903 );
1904 });
1905
1906 fake_server
1907 .request::<lsp::request::InlayHintRefreshRequest>(())
1908 .await
1909 .expect("inlay refresh request failed");
1910 cx.executor().run_until_parked();
1911 editor.update(cx, |editor, cx| {
1912 assert_eq!(
1913 lsp_request_count.load(Ordering::Relaxed),
1914 2,
1915 "Should not load new hints when they got disabled"
1916 );
1917 assert!(cached_hint_labels(editor).is_empty());
1918 assert!(visible_hint_labels(editor, cx).is_empty());
1919 assert_eq!(
1920 editor.inlay_hint_cache().version, edits_made,
1921 "The editor should not update the cache version after /refresh query without updates"
1922 );
1923 });
1924
1925 let final_allowed_hint_kinds = HashSet::from_iter([Some(InlayHintKind::Parameter)]);
1926 edits_made += 1;
1927 update_test_language_settings(cx, |settings| {
1928 settings.defaults.inlay_hints = Some(InlayHintSettings {
1929 enabled: true,
1930 show_type_hints: final_allowed_hint_kinds.contains(&Some(InlayHintKind::Type)),
1931 show_parameter_hints: final_allowed_hint_kinds
1932 .contains(&Some(InlayHintKind::Parameter)),
1933 show_other_hints: final_allowed_hint_kinds.contains(&None),
1934 })
1935 });
1936 cx.executor().run_until_parked();
1937 editor.update(cx, |editor, cx| {
1938 assert_eq!(
1939 lsp_request_count.load(Ordering::Relaxed),
1940 3,
1941 "Should query for new hints when they got reenabled"
1942 );
1943 assert_eq!(
1944 vec![
1945 "other hint".to_string(),
1946 "parameter hint".to_string(),
1947 "type hint".to_string(),
1948 ],
1949 cached_hint_labels(editor),
1950 "Should get its cached hints fully repopulated after the hints got reenabled"
1951 );
1952 assert_eq!(
1953 vec!["parameter hint".to_string()],
1954 visible_hint_labels(editor, cx),
1955 "Should get its visible hints repopulated and filtered after the h"
1956 );
1957 let inlay_cache = editor.inlay_hint_cache();
1958 assert_eq!(
1959 inlay_cache.allowed_hint_kinds, final_allowed_hint_kinds,
1960 "Cache should update editor settings when hints got reenabled"
1961 );
1962 assert_eq!(
1963 inlay_cache.version, edits_made,
1964 "Cache should update its version after hints got reenabled"
1965 );
1966 });
1967
1968 fake_server
1969 .request::<lsp::request::InlayHintRefreshRequest>(())
1970 .await
1971 .expect("inlay refresh request failed");
1972 cx.executor().run_until_parked();
1973 editor.update(cx, |editor, cx| {
1974 assert_eq!(
1975 lsp_request_count.load(Ordering::Relaxed),
1976 4,
1977 "Should query for new hints again"
1978 );
1979 assert_eq!(
1980 vec![
1981 "other hint".to_string(),
1982 "parameter hint".to_string(),
1983 "type hint".to_string(),
1984 ],
1985 cached_hint_labels(editor),
1986 );
1987 assert_eq!(
1988 vec!["parameter hint".to_string()],
1989 visible_hint_labels(editor, cx),
1990 );
1991 assert_eq!(editor.inlay_hint_cache().version, edits_made);
1992 });
1993 }
1994
1995 #[gpui::test]
1996 async fn test_hint_request_cancellation(cx: &mut gpui::TestAppContext) {
1997 init_test(cx, |settings| {
1998 settings.defaults.inlay_hints = Some(InlayHintSettings {
1999 enabled: true,
2000 show_type_hints: true,
2001 show_parameter_hints: true,
2002 show_other_hints: true,
2003 })
2004 });
2005
2006 let (file_with_hints, editor, fake_server) = prepare_test_objects(cx).await;
2007 let fake_server = Arc::new(fake_server);
2008 let lsp_request_count = Arc::new(AtomicU32::new(0));
2009 let another_lsp_request_count = Arc::clone(&lsp_request_count);
2010 fake_server
2011 .handle_request::<lsp::request::InlayHintRequest, _, _>(move |params, _| {
2012 let task_lsp_request_count = Arc::clone(&another_lsp_request_count);
2013 async move {
2014 let i = Arc::clone(&task_lsp_request_count).fetch_add(1, Ordering::SeqCst) + 1;
2015 assert_eq!(
2016 params.text_document.uri,
2017 lsp::Url::from_file_path(file_with_hints).unwrap(),
2018 );
2019 Ok(Some(vec![lsp::InlayHint {
2020 position: lsp::Position::new(0, i),
2021 label: lsp::InlayHintLabel::String(i.to_string()),
2022 kind: None,
2023 text_edits: None,
2024 tooltip: None,
2025 padding_left: None,
2026 padding_right: None,
2027 data: None,
2028 }]))
2029 }
2030 })
2031 .next()
2032 .await;
2033
2034 let mut expected_changes = Vec::new();
2035 for change_after_opening in [
2036 "initial change #1",
2037 "initial change #2",
2038 "initial change #3",
2039 ] {
2040 editor.update(cx, |editor, cx| {
2041 editor.change_selections(None, cx, |s| s.select_ranges([13..13]));
2042 editor.handle_input(change_after_opening, cx);
2043 });
2044 expected_changes.push(change_after_opening);
2045 }
2046
2047 cx.executor().run_until_parked();
2048
2049 editor.update(cx, |editor, cx| {
2050 let current_text = editor.text(cx);
2051 for change in &expected_changes {
2052 assert!(
2053 current_text.contains(change),
2054 "Should apply all changes made"
2055 );
2056 }
2057 assert_eq!(
2058 lsp_request_count.load(Ordering::Relaxed),
2059 2,
2060 "Should query new hints twice: for editor init and for the last edit that interrupted all others"
2061 );
2062 let expected_hints = vec!["2".to_string()];
2063 assert_eq!(
2064 expected_hints,
2065 cached_hint_labels(editor),
2066 "Should get hints from the last edit landed only"
2067 );
2068 assert_eq!(expected_hints, visible_hint_labels(editor, cx));
2069 assert_eq!(
2070 editor.inlay_hint_cache().version, 1,
2071 "Only one update should be registered in the cache after all cancellations"
2072 );
2073 });
2074
2075 let mut edits = Vec::new();
2076 for async_later_change in [
2077 "another change #1",
2078 "another change #2",
2079 "another change #3",
2080 ] {
2081 expected_changes.push(async_later_change);
2082 let task_editor = editor.clone();
2083 edits.push(cx.spawn(|mut cx| async move {
2084 task_editor.update(&mut cx, |editor, cx| {
2085 editor.change_selections(None, cx, |s| s.select_ranges([13..13]));
2086 editor.handle_input(async_later_change, cx);
2087 });
2088 }));
2089 }
2090 let _ = future::join_all(edits).await;
2091 cx.executor().run_until_parked();
2092
2093 editor.update(cx, |editor, cx| {
2094 let current_text = editor.text(cx);
2095 for change in &expected_changes {
2096 assert!(
2097 current_text.contains(change),
2098 "Should apply all changes made"
2099 );
2100 }
2101 assert_eq!(
2102 lsp_request_count.load(Ordering::SeqCst),
2103 3,
2104 "Should query new hints one more time, for the last edit only"
2105 );
2106 let expected_hints = vec!["3".to_string()];
2107 assert_eq!(
2108 expected_hints,
2109 cached_hint_labels(editor),
2110 "Should get hints from the last edit landed only"
2111 );
2112 assert_eq!(expected_hints, visible_hint_labels(editor, cx));
2113 assert_eq!(
2114 editor.inlay_hint_cache().version,
2115 2,
2116 "Should update the cache version once more, for the new change"
2117 );
2118 });
2119 }
2120
2121 #[gpui::test(iterations = 10)]
2122 async fn test_large_buffer_inlay_requests_split(cx: &mut gpui::TestAppContext) {
2123 init_test(cx, |settings| {
2124 settings.defaults.inlay_hints = Some(InlayHintSettings {
2125 enabled: true,
2126 show_type_hints: true,
2127 show_parameter_hints: true,
2128 show_other_hints: true,
2129 })
2130 });
2131
2132 let mut language = Language::new(
2133 LanguageConfig {
2134 name: "Rust".into(),
2135 path_suffixes: vec!["rs".to_string()],
2136 ..Default::default()
2137 },
2138 Some(tree_sitter_rust::language()),
2139 );
2140 let mut fake_servers = language
2141 .set_fake_lsp_adapter(Arc::new(FakeLspAdapter {
2142 capabilities: lsp::ServerCapabilities {
2143 inlay_hint_provider: Some(lsp::OneOf::Left(true)),
2144 ..Default::default()
2145 },
2146 ..Default::default()
2147 }))
2148 .await;
2149 let fs = FakeFs::new(cx.background_executor.clone());
2150 fs.insert_tree(
2151 "/a",
2152 json!({
2153 "main.rs": format!("fn main() {{\n{}\n}}", "let i = 5;\n".repeat(500)),
2154 "other.rs": "// Test file",
2155 }),
2156 )
2157 .await;
2158 let project = Project::test(fs, ["/a".as_ref()], cx).await;
2159 project.update(cx, |project, _| project.languages().add(Arc::new(language)));
2160 let buffer = project
2161 .update(cx, |project, cx| {
2162 project.open_local_buffer("/a/main.rs", cx)
2163 })
2164 .await
2165 .unwrap();
2166 cx.executor().run_until_parked();
2167 cx.executor().start_waiting();
2168 let fake_server = fake_servers.next().await.unwrap();
2169 let editor = cx.add_window(|cx| Editor::for_buffer(buffer, Some(project), cx));
2170 let lsp_request_ranges = Arc::new(Mutex::new(Vec::new()));
2171 let lsp_request_count = Arc::new(AtomicUsize::new(0));
2172 let closure_lsp_request_ranges = Arc::clone(&lsp_request_ranges);
2173 let closure_lsp_request_count = Arc::clone(&lsp_request_count);
2174 fake_server
2175 .handle_request::<lsp::request::InlayHintRequest, _, _>(move |params, _| {
2176 let task_lsp_request_ranges = Arc::clone(&closure_lsp_request_ranges);
2177 let task_lsp_request_count = Arc::clone(&closure_lsp_request_count);
2178 async move {
2179 assert_eq!(
2180 params.text_document.uri,
2181 lsp::Url::from_file_path("/a/main.rs").unwrap(),
2182 );
2183
2184 task_lsp_request_ranges.lock().push(params.range);
2185 let i = Arc::clone(&task_lsp_request_count).fetch_add(1, Ordering::Release) + 1;
2186 Ok(Some(vec![lsp::InlayHint {
2187 position: params.range.end,
2188 label: lsp::InlayHintLabel::String(i.to_string()),
2189 kind: None,
2190 text_edits: None,
2191 tooltip: None,
2192 padding_left: None,
2193 padding_right: None,
2194 data: None,
2195 }]))
2196 }
2197 })
2198 .next()
2199 .await;
2200
2201 fn editor_visible_range(
2202 editor: &WindowHandle<Editor>,
2203 cx: &mut gpui::TestAppContext,
2204 ) -> Range<Point> {
2205 let ranges = editor
2206 .update(cx, |editor, cx| {
2207 editor.excerpts_for_inlay_hints_query(None, cx)
2208 })
2209 .unwrap();
2210 assert_eq!(
2211 ranges.len(),
2212 1,
2213 "Single buffer should produce a single excerpt with visible range"
2214 );
2215 let (_, (excerpt_buffer, _, excerpt_visible_range)) =
2216 ranges.into_iter().next().unwrap();
2217 excerpt_buffer.update(cx, |buffer, _| {
2218 let snapshot = buffer.snapshot();
2219 let start = buffer
2220 .anchor_before(excerpt_visible_range.start)
2221 .to_point(&snapshot);
2222 let end = buffer
2223 .anchor_after(excerpt_visible_range.end)
2224 .to_point(&snapshot);
2225 start..end
2226 })
2227 }
2228
2229 // in large buffers, requests are made for more than visible range of a buffer.
2230 // invisible parts are queried later, to avoid excessive requests on quick typing.
2231 // wait the timeout needed to get all requests.
2232 cx.executor().advance_clock(Duration::from_millis(
2233 INVISIBLE_RANGES_HINTS_REQUEST_DELAY_MILLIS + 100,
2234 ));
2235 cx.executor().run_until_parked();
2236 let initial_visible_range = editor_visible_range(&editor, cx);
2237 let lsp_initial_visible_range = lsp::Range::new(
2238 lsp::Position::new(
2239 initial_visible_range.start.row,
2240 initial_visible_range.start.column,
2241 ),
2242 lsp::Position::new(
2243 initial_visible_range.end.row,
2244 initial_visible_range.end.column,
2245 ),
2246 );
2247 let expected_initial_query_range_end =
2248 lsp::Position::new(initial_visible_range.end.row * 2, 2);
2249 let mut expected_invisible_query_start = lsp_initial_visible_range.end;
2250 expected_invisible_query_start.character += 1;
2251 editor.update(cx, |editor, cx| {
2252 let ranges = lsp_request_ranges.lock().drain(..).collect::<Vec<_>>();
2253 assert_eq!(ranges.len(), 2,
2254 "When scroll is at the edge of a big document, its visible part and the same range further should be queried in order, but got: {ranges:?}");
2255 let visible_query_range = &ranges[0];
2256 assert_eq!(visible_query_range.start, lsp_initial_visible_range.start);
2257 assert_eq!(visible_query_range.end, lsp_initial_visible_range.end);
2258 let invisible_query_range = &ranges[1];
2259
2260 assert_eq!(invisible_query_range.start, expected_invisible_query_start, "Should initially query visible edge of the document");
2261 assert_eq!(invisible_query_range.end, expected_initial_query_range_end, "Should initially query visible edge of the document");
2262
2263 let requests_count = lsp_request_count.load(Ordering::Acquire);
2264 assert_eq!(requests_count, 2, "Visible + invisible request");
2265 let expected_hints = vec!["1".to_string(), "2".to_string()];
2266 assert_eq!(
2267 expected_hints,
2268 cached_hint_labels(editor),
2269 "Should have hints from both LSP requests made for a big file"
2270 );
2271 assert_eq!(expected_hints, visible_hint_labels(editor, cx), "Should display only hints from the visible range");
2272 assert_eq!(
2273 editor.inlay_hint_cache().version, requests_count,
2274 "LSP queries should've bumped the cache version"
2275 );
2276 });
2277
2278 editor.update(cx, |editor, cx| {
2279 editor.scroll_screen(&ScrollAmount::Page(1.0), cx);
2280 editor.scroll_screen(&ScrollAmount::Page(1.0), cx);
2281 });
2282 cx.executor().advance_clock(Duration::from_millis(
2283 INVISIBLE_RANGES_HINTS_REQUEST_DELAY_MILLIS + 100,
2284 ));
2285 cx.executor().run_until_parked();
2286 let visible_range_after_scrolls = editor_visible_range(&editor, cx);
2287 let visible_line_count = editor
2288 .update(cx, |editor, _| editor.visible_line_count().unwrap())
2289 .unwrap();
2290 let selection_in_cached_range = editor
2291 .update(cx, |editor, cx| {
2292 let ranges = lsp_request_ranges
2293 .lock()
2294 .drain(..)
2295 .sorted_by_key(|r| r.start)
2296 .collect::<Vec<_>>();
2297 assert_eq!(
2298 ranges.len(),
2299 2,
2300 "Should query 2 ranges after both scrolls, but got: {ranges:?}"
2301 );
2302 let first_scroll = &ranges[0];
2303 let second_scroll = &ranges[1];
2304 assert_eq!(
2305 first_scroll.end, second_scroll.start,
2306 "Should query 2 adjacent ranges after the scrolls, but got: {ranges:?}"
2307 );
2308 assert_eq!(
2309 first_scroll.start, expected_initial_query_range_end,
2310 "First scroll should start the query right after the end of the original scroll",
2311 );
2312 assert_eq!(
2313 second_scroll.end,
2314 lsp::Position::new(
2315 visible_range_after_scrolls.end.row
2316 + visible_line_count.ceil() as u32,
2317 1,
2318 ),
2319 "Second scroll should query one more screen down after the end of the visible range"
2320 );
2321
2322 let lsp_requests = lsp_request_count.load(Ordering::Acquire);
2323 assert_eq!(lsp_requests, 4, "Should query for hints after every scroll");
2324 let expected_hints = vec![
2325 "1".to_string(),
2326 "2".to_string(),
2327 "3".to_string(),
2328 "4".to_string(),
2329 ];
2330 assert_eq!(
2331 expected_hints,
2332 cached_hint_labels(editor),
2333 "Should have hints from the new LSP response after the edit"
2334 );
2335 assert_eq!(expected_hints, visible_hint_labels(editor, cx));
2336 assert_eq!(
2337 editor.inlay_hint_cache().version,
2338 lsp_requests,
2339 "Should update the cache for every LSP response with hints added"
2340 );
2341
2342 let mut selection_in_cached_range = visible_range_after_scrolls.end;
2343 selection_in_cached_range.row -= visible_line_count.ceil() as u32;
2344 selection_in_cached_range
2345 })
2346 .unwrap();
2347
2348 editor.update(cx, |editor, cx| {
2349 editor.change_selections(Some(Autoscroll::center()), cx, |s| {
2350 s.select_ranges([selection_in_cached_range..selection_in_cached_range])
2351 });
2352 });
2353 cx.executor().advance_clock(Duration::from_millis(
2354 INVISIBLE_RANGES_HINTS_REQUEST_DELAY_MILLIS + 100,
2355 ));
2356 cx.executor().run_until_parked();
2357 editor.update(cx, |_, _| {
2358 let ranges = lsp_request_ranges
2359 .lock()
2360 .drain(..)
2361 .sorted_by_key(|r| r.start)
2362 .collect::<Vec<_>>();
2363 assert!(ranges.is_empty(), "No new ranges or LSP queries should be made after returning to the selection with cached hints");
2364 assert_eq!(lsp_request_count.load(Ordering::Acquire), 4);
2365 });
2366
2367 editor.update(cx, |editor, cx| {
2368 editor.handle_input("++++more text++++", cx);
2369 });
2370 cx.executor().advance_clock(Duration::from_millis(
2371 INVISIBLE_RANGES_HINTS_REQUEST_DELAY_MILLIS + 100,
2372 ));
2373 cx.executor().run_until_parked();
2374 editor.update(cx, |editor, cx| {
2375 let mut ranges = lsp_request_ranges.lock().drain(..).collect::<Vec<_>>();
2376 ranges.sort_by_key(|r| r.start);
2377
2378 assert_eq!(ranges.len(), 3,
2379 "On edit, should scroll to selection and query a range around it: visible + same range above and below. Instead, got query ranges {ranges:?}");
2380 let above_query_range = &ranges[0];
2381 let visible_query_range = &ranges[1];
2382 let below_query_range = &ranges[2];
2383 assert!(above_query_range.end.character < visible_query_range.start.character || above_query_range.end.line + 1 == visible_query_range.start.line,
2384 "Above range {above_query_range:?} should be before visible range {visible_query_range:?}");
2385 assert!(visible_query_range.end.character < below_query_range.start.character || visible_query_range.end.line + 1 == below_query_range.start.line,
2386 "Visible range {visible_query_range:?} should be before below range {below_query_range:?}");
2387 assert!(above_query_range.start.line < selection_in_cached_range.row,
2388 "Hints should be queried with the selected range after the query range start");
2389 assert!(below_query_range.end.line > selection_in_cached_range.row,
2390 "Hints should be queried with the selected range before the query range end");
2391 assert!(above_query_range.start.line <= selection_in_cached_range.row - (visible_line_count * 3.0 / 2.0) as u32,
2392 "Hints query range should contain one more screen before");
2393 assert!(below_query_range.end.line >= selection_in_cached_range.row + (visible_line_count * 3.0 / 2.0) as u32,
2394 "Hints query range should contain one more screen after");
2395
2396 let lsp_requests = lsp_request_count.load(Ordering::Acquire);
2397 assert_eq!(lsp_requests, 7, "There should be a visible range and two ranges above and below it queried");
2398 let expected_hints = vec!["5".to_string(), "6".to_string(), "7".to_string()];
2399 assert_eq!(expected_hints, cached_hint_labels(editor),
2400 "Should have hints from the new LSP response after the edit");
2401 assert_eq!(expected_hints, visible_hint_labels(editor, cx));
2402 assert_eq!(editor.inlay_hint_cache().version, lsp_requests, "Should update the cache for every LSP response with hints added");
2403 });
2404 }
2405
2406 #[gpui::test(iterations = 10)]
2407 async fn test_multiple_excerpts_large_multibuffer(cx: &mut gpui::TestAppContext) {
2408 init_test(cx, |settings| {
2409 settings.defaults.inlay_hints = Some(InlayHintSettings {
2410 enabled: true,
2411 show_type_hints: true,
2412 show_parameter_hints: true,
2413 show_other_hints: true,
2414 })
2415 });
2416
2417 let mut language = Language::new(
2418 LanguageConfig {
2419 name: "Rust".into(),
2420 path_suffixes: vec!["rs".to_string()],
2421 ..Default::default()
2422 },
2423 Some(tree_sitter_rust::language()),
2424 );
2425 let mut fake_servers = language
2426 .set_fake_lsp_adapter(Arc::new(FakeLspAdapter {
2427 capabilities: lsp::ServerCapabilities {
2428 inlay_hint_provider: Some(lsp::OneOf::Left(true)),
2429 ..Default::default()
2430 },
2431 ..Default::default()
2432 }))
2433 .await;
2434 let language = Arc::new(language);
2435 let fs = FakeFs::new(cx.background_executor.clone());
2436 fs.insert_tree(
2437 "/a",
2438 json!({
2439 "main.rs": format!("fn main() {{\n{}\n}}", (0..501).map(|i| format!("let i = {i};\n")).collect::<Vec<_>>().join("")),
2440 "other.rs": format!("fn main() {{\n{}\n}}", (0..501).map(|j| format!("let j = {j};\n")).collect::<Vec<_>>().join("")),
2441 }),
2442 )
2443 .await;
2444 let project = Project::test(fs, ["/a".as_ref()], cx).await;
2445 project.update(cx, |project, _| {
2446 project.languages().add(Arc::clone(&language))
2447 });
2448 let worktree_id = project.update(cx, |project, cx| {
2449 project.worktrees().next().unwrap().read(cx).id()
2450 });
2451
2452 let buffer_1 = project
2453 .update(cx, |project, cx| {
2454 project.open_buffer((worktree_id, "main.rs"), cx)
2455 })
2456 .await
2457 .unwrap();
2458 let buffer_2 = project
2459 .update(cx, |project, cx| {
2460 project.open_buffer((worktree_id, "other.rs"), cx)
2461 })
2462 .await
2463 .unwrap();
2464 let multibuffer = cx.build_model(|cx| {
2465 let mut multibuffer = MultiBuffer::new(0);
2466 multibuffer.push_excerpts(
2467 buffer_1.clone(),
2468 [
2469 ExcerptRange {
2470 context: Point::new(0, 0)..Point::new(2, 0),
2471 primary: None,
2472 },
2473 ExcerptRange {
2474 context: Point::new(4, 0)..Point::new(11, 0),
2475 primary: None,
2476 },
2477 ExcerptRange {
2478 context: Point::new(22, 0)..Point::new(33, 0),
2479 primary: None,
2480 },
2481 ExcerptRange {
2482 context: Point::new(44, 0)..Point::new(55, 0),
2483 primary: None,
2484 },
2485 ExcerptRange {
2486 context: Point::new(56, 0)..Point::new(66, 0),
2487 primary: None,
2488 },
2489 ExcerptRange {
2490 context: Point::new(67, 0)..Point::new(77, 0),
2491 primary: None,
2492 },
2493 ],
2494 cx,
2495 );
2496 multibuffer.push_excerpts(
2497 buffer_2.clone(),
2498 [
2499 ExcerptRange {
2500 context: Point::new(0, 1)..Point::new(2, 1),
2501 primary: None,
2502 },
2503 ExcerptRange {
2504 context: Point::new(4, 1)..Point::new(11, 1),
2505 primary: None,
2506 },
2507 ExcerptRange {
2508 context: Point::new(22, 1)..Point::new(33, 1),
2509 primary: None,
2510 },
2511 ExcerptRange {
2512 context: Point::new(44, 1)..Point::new(55, 1),
2513 primary: None,
2514 },
2515 ExcerptRange {
2516 context: Point::new(56, 1)..Point::new(66, 1),
2517 primary: None,
2518 },
2519 ExcerptRange {
2520 context: Point::new(67, 1)..Point::new(77, 1),
2521 primary: None,
2522 },
2523 ],
2524 cx,
2525 );
2526 multibuffer
2527 });
2528
2529 cx.executor().run_until_parked();
2530 let editor =
2531 cx.add_window(|cx| Editor::for_multibuffer(multibuffer, Some(project.clone()), cx));
2532 let editor_edited = Arc::new(AtomicBool::new(false));
2533 let fake_server = fake_servers.next().await.unwrap();
2534 let closure_editor_edited = Arc::clone(&editor_edited);
2535 fake_server
2536 .handle_request::<lsp::request::InlayHintRequest, _, _>(move |params, _| {
2537 let task_editor_edited = Arc::clone(&closure_editor_edited);
2538 async move {
2539 let hint_text = if params.text_document.uri
2540 == lsp::Url::from_file_path("/a/main.rs").unwrap()
2541 {
2542 "main hint"
2543 } else if params.text_document.uri
2544 == lsp::Url::from_file_path("/a/other.rs").unwrap()
2545 {
2546 "other hint"
2547 } else {
2548 panic!("unexpected uri: {:?}", params.text_document.uri);
2549 };
2550
2551 // one hint per excerpt
2552 let positions = [
2553 lsp::Position::new(0, 2),
2554 lsp::Position::new(4, 2),
2555 lsp::Position::new(22, 2),
2556 lsp::Position::new(44, 2),
2557 lsp::Position::new(56, 2),
2558 lsp::Position::new(67, 2),
2559 ];
2560 let out_of_range_hint = lsp::InlayHint {
2561 position: lsp::Position::new(
2562 params.range.start.line + 99,
2563 params.range.start.character + 99,
2564 ),
2565 label: lsp::InlayHintLabel::String(
2566 "out of excerpt range, should be ignored".to_string(),
2567 ),
2568 kind: None,
2569 text_edits: None,
2570 tooltip: None,
2571 padding_left: None,
2572 padding_right: None,
2573 data: None,
2574 };
2575
2576 let edited = task_editor_edited.load(Ordering::Acquire);
2577 Ok(Some(
2578 std::iter::once(out_of_range_hint)
2579 .chain(positions.into_iter().enumerate().map(|(i, position)| {
2580 lsp::InlayHint {
2581 position,
2582 label: lsp::InlayHintLabel::String(format!(
2583 "{hint_text}{} #{i}",
2584 if edited { "(edited)" } else { "" },
2585 )),
2586 kind: None,
2587 text_edits: None,
2588 tooltip: None,
2589 padding_left: None,
2590 padding_right: None,
2591 data: None,
2592 }
2593 }))
2594 .collect(),
2595 ))
2596 }
2597 })
2598 .next()
2599 .await;
2600 cx.executor().run_until_parked();
2601
2602 editor.update(cx, |editor, cx| {
2603 let expected_hints = vec![
2604 "main hint #0".to_string(),
2605 "main hint #1".to_string(),
2606 "main hint #2".to_string(),
2607 "main hint #3".to_string(),
2608 "main hint #4".to_string(),
2609 "main hint #5".to_string(),
2610 ];
2611 assert_eq!(
2612 expected_hints,
2613 cached_hint_labels(editor),
2614 "When scroll is at the edge of a multibuffer, its visible excerpts only should be queried for inlay hints"
2615 );
2616 assert_eq!(expected_hints, visible_hint_labels(editor, cx));
2617 assert_eq!(editor.inlay_hint_cache().version, expected_hints.len(), "Every visible excerpt hints should bump the verison");
2618 });
2619
2620 editor.update(cx, |editor, cx| {
2621 editor.change_selections(Some(Autoscroll::Next), cx, |s| {
2622 s.select_ranges([Point::new(4, 0)..Point::new(4, 0)])
2623 });
2624 editor.change_selections(Some(Autoscroll::Next), cx, |s| {
2625 s.select_ranges([Point::new(22, 0)..Point::new(22, 0)])
2626 });
2627 editor.change_selections(Some(Autoscroll::Next), cx, |s| {
2628 s.select_ranges([Point::new(50, 0)..Point::new(50, 0)])
2629 });
2630 });
2631 cx.executor().run_until_parked();
2632 editor.update(cx, |editor, cx| {
2633 let expected_hints = vec![
2634 "main hint #0".to_string(),
2635 "main hint #1".to_string(),
2636 "main hint #2".to_string(),
2637 "main hint #3".to_string(),
2638 "main hint #4".to_string(),
2639 "main hint #5".to_string(),
2640 "other hint #0".to_string(),
2641 "other hint #1".to_string(),
2642 "other hint #2".to_string(),
2643 ];
2644 assert_eq!(expected_hints, cached_hint_labels(editor),
2645 "With more scrolls of the multibuffer, more hints should be added into the cache and nothing invalidated without edits");
2646 assert_eq!(expected_hints, visible_hint_labels(editor, cx));
2647 assert_eq!(editor.inlay_hint_cache().version, expected_hints.len(),
2648 "Due to every excerpt having one hint, we update cache per new excerpt scrolled");
2649 });
2650
2651 editor.update(cx, |editor, cx| {
2652 editor.change_selections(Some(Autoscroll::Next), cx, |s| {
2653 s.select_ranges([Point::new(100, 0)..Point::new(100, 0)])
2654 });
2655 });
2656 cx.executor().advance_clock(Duration::from_millis(
2657 INVISIBLE_RANGES_HINTS_REQUEST_DELAY_MILLIS + 100,
2658 ));
2659 cx.executor().run_until_parked();
2660 let last_scroll_update_version = editor.update(cx, |editor, cx| {
2661 let expected_hints = vec![
2662 "main hint #0".to_string(),
2663 "main hint #1".to_string(),
2664 "main hint #2".to_string(),
2665 "main hint #3".to_string(),
2666 "main hint #4".to_string(),
2667 "main hint #5".to_string(),
2668 "other hint #0".to_string(),
2669 "other hint #1".to_string(),
2670 "other hint #2".to_string(),
2671 "other hint #3".to_string(),
2672 "other hint #4".to_string(),
2673 "other hint #5".to_string(),
2674 ];
2675 assert_eq!(expected_hints, cached_hint_labels(editor),
2676 "After multibuffer was scrolled to the end, all hints for all excerpts should be fetched");
2677 assert_eq!(expected_hints, visible_hint_labels(editor, cx));
2678 assert_eq!(editor.inlay_hint_cache().version, expected_hints.len());
2679 expected_hints.len()
2680 }).unwrap();
2681
2682 editor.update(cx, |editor, cx| {
2683 editor.change_selections(Some(Autoscroll::Next), cx, |s| {
2684 s.select_ranges([Point::new(4, 0)..Point::new(4, 0)])
2685 });
2686 });
2687 cx.executor().run_until_parked();
2688 editor.update(cx, |editor, cx| {
2689 let expected_hints = vec![
2690 "main hint #0".to_string(),
2691 "main hint #1".to_string(),
2692 "main hint #2".to_string(),
2693 "main hint #3".to_string(),
2694 "main hint #4".to_string(),
2695 "main hint #5".to_string(),
2696 "other hint #0".to_string(),
2697 "other hint #1".to_string(),
2698 "other hint #2".to_string(),
2699 "other hint #3".to_string(),
2700 "other hint #4".to_string(),
2701 "other hint #5".to_string(),
2702 ];
2703 assert_eq!(expected_hints, cached_hint_labels(editor),
2704 "After multibuffer was scrolled to the end, further scrolls up should not bring more hints");
2705 assert_eq!(expected_hints, visible_hint_labels(editor, cx));
2706 assert_eq!(editor.inlay_hint_cache().version, last_scroll_update_version, "No updates should happen during scrolling already scolled buffer");
2707 });
2708
2709 editor_edited.store(true, Ordering::Release);
2710 editor.update(cx, |editor, cx| {
2711 editor.change_selections(None, cx, |s| {
2712 // TODO if this gets set to hint boundary (e.g. 56) we sometimes get an extra cache version bump, why?
2713 s.select_ranges([Point::new(57, 0)..Point::new(57, 0)])
2714 });
2715 editor.handle_input("++++more text++++", cx);
2716 });
2717 cx.executor().run_until_parked();
2718 editor.update(cx, |editor, cx| {
2719 let expected_hints = vec![
2720 "main hint(edited) #0".to_string(),
2721 "main hint(edited) #1".to_string(),
2722 "main hint(edited) #2".to_string(),
2723 "main hint(edited) #3".to_string(),
2724 "main hint(edited) #4".to_string(),
2725 "main hint(edited) #5".to_string(),
2726 "other hint(edited) #0".to_string(),
2727 "other hint(edited) #1".to_string(),
2728 ];
2729 assert_eq!(
2730 expected_hints,
2731 cached_hint_labels(editor),
2732 "After multibuffer edit, editor gets scolled back to the last selection; \
2733 all hints should be invalidated and requeried for all of its visible excerpts"
2734 );
2735 assert_eq!(expected_hints, visible_hint_labels(editor, cx));
2736
2737 let current_cache_version = editor.inlay_hint_cache().version;
2738 assert_eq!(
2739 current_cache_version,
2740 last_scroll_update_version + expected_hints.len(),
2741 "We should have updated cache N times == N of new hints arrived (separately from each excerpt)"
2742 );
2743 });
2744 }
2745
2746 #[gpui::test]
2747 async fn test_excerpts_removed(cx: &mut gpui::TestAppContext) {
2748 init_test(cx, |settings| {
2749 settings.defaults.inlay_hints = Some(InlayHintSettings {
2750 enabled: true,
2751 show_type_hints: false,
2752 show_parameter_hints: false,
2753 show_other_hints: false,
2754 })
2755 });
2756
2757 let mut language = Language::new(
2758 LanguageConfig {
2759 name: "Rust".into(),
2760 path_suffixes: vec!["rs".to_string()],
2761 ..Default::default()
2762 },
2763 Some(tree_sitter_rust::language()),
2764 );
2765 let mut fake_servers = language
2766 .set_fake_lsp_adapter(Arc::new(FakeLspAdapter {
2767 capabilities: lsp::ServerCapabilities {
2768 inlay_hint_provider: Some(lsp::OneOf::Left(true)),
2769 ..Default::default()
2770 },
2771 ..Default::default()
2772 }))
2773 .await;
2774 let language = Arc::new(language);
2775 let fs = FakeFs::new(cx.background_executor.clone());
2776 fs.insert_tree(
2777 "/a",
2778 json!({
2779 "main.rs": format!("fn main() {{\n{}\n}}", (0..501).map(|i| format!("let i = {i};\n")).collect::<Vec<_>>().join("")),
2780 "other.rs": format!("fn main() {{\n{}\n}}", (0..501).map(|j| format!("let j = {j};\n")).collect::<Vec<_>>().join("")),
2781 }),
2782 )
2783 .await;
2784 let project = Project::test(fs, ["/a".as_ref()], cx).await;
2785 project.update(cx, |project, _| {
2786 project.languages().add(Arc::clone(&language))
2787 });
2788 let worktree_id = project.update(cx, |project, cx| {
2789 project.worktrees().next().unwrap().read(cx).id()
2790 });
2791
2792 let buffer_1 = project
2793 .update(cx, |project, cx| {
2794 project.open_buffer((worktree_id, "main.rs"), cx)
2795 })
2796 .await
2797 .unwrap();
2798 let buffer_2 = project
2799 .update(cx, |project, cx| {
2800 project.open_buffer((worktree_id, "other.rs"), cx)
2801 })
2802 .await
2803 .unwrap();
2804 let multibuffer = cx.build_model(|_| MultiBuffer::new(0));
2805 let (buffer_1_excerpts, buffer_2_excerpts) = multibuffer.update(cx, |multibuffer, cx| {
2806 let buffer_1_excerpts = multibuffer.push_excerpts(
2807 buffer_1.clone(),
2808 [ExcerptRange {
2809 context: Point::new(0, 0)..Point::new(2, 0),
2810 primary: None,
2811 }],
2812 cx,
2813 );
2814 let buffer_2_excerpts = multibuffer.push_excerpts(
2815 buffer_2.clone(),
2816 [ExcerptRange {
2817 context: Point::new(0, 1)..Point::new(2, 1),
2818 primary: None,
2819 }],
2820 cx,
2821 );
2822 (buffer_1_excerpts, buffer_2_excerpts)
2823 });
2824
2825 assert!(!buffer_1_excerpts.is_empty());
2826 assert!(!buffer_2_excerpts.is_empty());
2827
2828 cx.executor().run_until_parked();
2829 let editor =
2830 cx.add_window(|cx| Editor::for_multibuffer(multibuffer, Some(project.clone()), cx));
2831 let editor_edited = Arc::new(AtomicBool::new(false));
2832 let fake_server = fake_servers.next().await.unwrap();
2833 let closure_editor_edited = Arc::clone(&editor_edited);
2834 fake_server
2835 .handle_request::<lsp::request::InlayHintRequest, _, _>(move |params, _| {
2836 let task_editor_edited = Arc::clone(&closure_editor_edited);
2837 async move {
2838 let hint_text = if params.text_document.uri
2839 == lsp::Url::from_file_path("/a/main.rs").unwrap()
2840 {
2841 "main hint"
2842 } else if params.text_document.uri
2843 == lsp::Url::from_file_path("/a/other.rs").unwrap()
2844 {
2845 "other hint"
2846 } else {
2847 panic!("unexpected uri: {:?}", params.text_document.uri);
2848 };
2849
2850 let positions = [
2851 lsp::Position::new(0, 2),
2852 lsp::Position::new(4, 2),
2853 lsp::Position::new(22, 2),
2854 lsp::Position::new(44, 2),
2855 lsp::Position::new(56, 2),
2856 lsp::Position::new(67, 2),
2857 ];
2858 let out_of_range_hint = lsp::InlayHint {
2859 position: lsp::Position::new(
2860 params.range.start.line + 99,
2861 params.range.start.character + 99,
2862 ),
2863 label: lsp::InlayHintLabel::String(
2864 "out of excerpt range, should be ignored".to_string(),
2865 ),
2866 kind: None,
2867 text_edits: None,
2868 tooltip: None,
2869 padding_left: None,
2870 padding_right: None,
2871 data: None,
2872 };
2873
2874 let edited = task_editor_edited.load(Ordering::Acquire);
2875 Ok(Some(
2876 std::iter::once(out_of_range_hint)
2877 .chain(positions.into_iter().enumerate().map(|(i, position)| {
2878 lsp::InlayHint {
2879 position,
2880 label: lsp::InlayHintLabel::String(format!(
2881 "{hint_text}{} #{i}",
2882 if edited { "(edited)" } else { "" },
2883 )),
2884 kind: None,
2885 text_edits: None,
2886 tooltip: None,
2887 padding_left: None,
2888 padding_right: None,
2889 data: None,
2890 }
2891 }))
2892 .collect(),
2893 ))
2894 }
2895 })
2896 .next()
2897 .await;
2898 cx.executor().run_until_parked();
2899
2900 editor.update(cx, |editor, cx| {
2901 assert_eq!(
2902 vec!["main hint #0".to_string(), "other hint #0".to_string()],
2903 cached_hint_labels(editor),
2904 "Cache should update for both excerpts despite hints display was disabled"
2905 );
2906 assert!(
2907 visible_hint_labels(editor, cx).is_empty(),
2908 "All hints are disabled and should not be shown despite being present in the cache"
2909 );
2910 assert_eq!(
2911 editor.inlay_hint_cache().version,
2912 2,
2913 "Cache should update once per excerpt query"
2914 );
2915 });
2916
2917 editor.update(cx, |editor, cx| {
2918 editor.buffer().update(cx, |multibuffer, cx| {
2919 multibuffer.remove_excerpts(buffer_2_excerpts, cx)
2920 })
2921 });
2922 cx.executor().run_until_parked();
2923 editor.update(cx, |editor, cx| {
2924 assert_eq!(
2925 vec!["main hint #0".to_string()],
2926 cached_hint_labels(editor),
2927 "For the removed excerpt, should clean corresponding cached hints"
2928 );
2929 assert!(
2930 visible_hint_labels(editor, cx).is_empty(),
2931 "All hints are disabled and should not be shown despite being present in the cache"
2932 );
2933 assert_eq!(
2934 editor.inlay_hint_cache().version,
2935 3,
2936 "Excerpt removal should trigger a cache update"
2937 );
2938 });
2939
2940 update_test_language_settings(cx, |settings| {
2941 settings.defaults.inlay_hints = Some(InlayHintSettings {
2942 enabled: true,
2943 show_type_hints: true,
2944 show_parameter_hints: true,
2945 show_other_hints: true,
2946 })
2947 });
2948 cx.executor().run_until_parked();
2949 editor.update(cx, |editor, cx| {
2950 let expected_hints = vec!["main hint #0".to_string()];
2951 assert_eq!(
2952 expected_hints,
2953 cached_hint_labels(editor),
2954 "Hint display settings change should not change the cache"
2955 );
2956 assert_eq!(
2957 expected_hints,
2958 visible_hint_labels(editor, cx),
2959 "Settings change should make cached hints visible"
2960 );
2961 assert_eq!(
2962 editor.inlay_hint_cache().version,
2963 4,
2964 "Settings change should trigger a cache update"
2965 );
2966 });
2967 }
2968
2969 #[gpui::test]
2970 async fn test_inside_char_boundary_range_hints(cx: &mut gpui::TestAppContext) {
2971 init_test(cx, |settings| {
2972 settings.defaults.inlay_hints = Some(InlayHintSettings {
2973 enabled: true,
2974 show_type_hints: true,
2975 show_parameter_hints: true,
2976 show_other_hints: true,
2977 })
2978 });
2979
2980 let mut language = Language::new(
2981 LanguageConfig {
2982 name: "Rust".into(),
2983 path_suffixes: vec!["rs".to_string()],
2984 ..Default::default()
2985 },
2986 Some(tree_sitter_rust::language()),
2987 );
2988 let mut fake_servers = language
2989 .set_fake_lsp_adapter(Arc::new(FakeLspAdapter {
2990 capabilities: lsp::ServerCapabilities {
2991 inlay_hint_provider: Some(lsp::OneOf::Left(true)),
2992 ..Default::default()
2993 },
2994 ..Default::default()
2995 }))
2996 .await;
2997 let fs = FakeFs::new(cx.background_executor.clone());
2998 fs.insert_tree(
2999 "/a",
3000 json!({
3001 "main.rs": format!(r#"fn main() {{\n{}\n}}"#, format!("let i = {};\n", "√".repeat(10)).repeat(500)),
3002 "other.rs": "// Test file",
3003 }),
3004 )
3005 .await;
3006 let project = Project::test(fs, ["/a".as_ref()], cx).await;
3007 project.update(cx, |project, _| project.languages().add(Arc::new(language)));
3008 let buffer = project
3009 .update(cx, |project, cx| {
3010 project.open_local_buffer("/a/main.rs", cx)
3011 })
3012 .await
3013 .unwrap();
3014 cx.executor().run_until_parked();
3015 cx.executor().start_waiting();
3016 let fake_server = fake_servers.next().await.unwrap();
3017 let editor = cx.add_window(|cx| Editor::for_buffer(buffer, Some(project), cx));
3018 let lsp_request_count = Arc::new(AtomicU32::new(0));
3019 let closure_lsp_request_count = Arc::clone(&lsp_request_count);
3020 fake_server
3021 .handle_request::<lsp::request::InlayHintRequest, _, _>(move |params, _| {
3022 let task_lsp_request_count = Arc::clone(&closure_lsp_request_count);
3023 async move {
3024 assert_eq!(
3025 params.text_document.uri,
3026 lsp::Url::from_file_path("/a/main.rs").unwrap(),
3027 );
3028 let query_start = params.range.start;
3029 let i = Arc::clone(&task_lsp_request_count).fetch_add(1, Ordering::Release) + 1;
3030 Ok(Some(vec![lsp::InlayHint {
3031 position: query_start,
3032 label: lsp::InlayHintLabel::String(i.to_string()),
3033 kind: None,
3034 text_edits: None,
3035 tooltip: None,
3036 padding_left: None,
3037 padding_right: None,
3038 data: None,
3039 }]))
3040 }
3041 })
3042 .next()
3043 .await;
3044
3045 cx.executor().run_until_parked();
3046 editor.update(cx, |editor, cx| {
3047 editor.change_selections(None, cx, |s| {
3048 s.select_ranges([Point::new(10, 0)..Point::new(10, 0)])
3049 })
3050 });
3051 cx.executor().run_until_parked();
3052 editor.update(cx, |editor, cx| {
3053 let expected_hints = vec!["1".to_string()];
3054 assert_eq!(expected_hints, cached_hint_labels(editor));
3055 assert_eq!(expected_hints, visible_hint_labels(editor, cx));
3056 assert_eq!(editor.inlay_hint_cache().version, 1);
3057 });
3058 }
3059
3060 #[gpui::test]
3061 async fn test_toggle_inlay_hints(cx: &mut gpui::TestAppContext) {
3062 init_test(cx, |settings| {
3063 settings.defaults.inlay_hints = Some(InlayHintSettings {
3064 enabled: false,
3065 show_type_hints: true,
3066 show_parameter_hints: true,
3067 show_other_hints: true,
3068 })
3069 });
3070
3071 let (file_with_hints, editor, fake_server) = prepare_test_objects(cx).await;
3072
3073 editor.update(cx, |editor, cx| {
3074 editor.toggle_inlay_hints(&crate::ToggleInlayHints, cx)
3075 });
3076 cx.executor().start_waiting();
3077 let lsp_request_count = Arc::new(AtomicU32::new(0));
3078 let closure_lsp_request_count = Arc::clone(&lsp_request_count);
3079 fake_server
3080 .handle_request::<lsp::request::InlayHintRequest, _, _>(move |params, _| {
3081 let task_lsp_request_count = Arc::clone(&closure_lsp_request_count);
3082 async move {
3083 assert_eq!(
3084 params.text_document.uri,
3085 lsp::Url::from_file_path(file_with_hints).unwrap(),
3086 );
3087
3088 let i = Arc::clone(&task_lsp_request_count).fetch_add(1, Ordering::SeqCst) + 1;
3089 Ok(Some(vec![lsp::InlayHint {
3090 position: lsp::Position::new(0, i),
3091 label: lsp::InlayHintLabel::String(i.to_string()),
3092 kind: None,
3093 text_edits: None,
3094 tooltip: None,
3095 padding_left: None,
3096 padding_right: None,
3097 data: None,
3098 }]))
3099 }
3100 })
3101 .next()
3102 .await;
3103 cx.executor().run_until_parked();
3104 editor.update(cx, |editor, cx| {
3105 let expected_hints = vec!["1".to_string()];
3106 assert_eq!(
3107 expected_hints,
3108 cached_hint_labels(editor),
3109 "Should display inlays after toggle despite them disabled in settings"
3110 );
3111 assert_eq!(expected_hints, visible_hint_labels(editor, cx));
3112 assert_eq!(
3113 editor.inlay_hint_cache().version,
3114 1,
3115 "First toggle should be cache's first update"
3116 );
3117 });
3118
3119 editor.update(cx, |editor, cx| {
3120 editor.toggle_inlay_hints(&crate::ToggleInlayHints, cx)
3121 });
3122 cx.executor().run_until_parked();
3123 editor.update(cx, |editor, cx| {
3124 assert!(
3125 cached_hint_labels(editor).is_empty(),
3126 "Should clear hints after 2nd toggle"
3127 );
3128 assert!(visible_hint_labels(editor, cx).is_empty());
3129 assert_eq!(editor.inlay_hint_cache().version, 2);
3130 });
3131
3132 update_test_language_settings(cx, |settings| {
3133 settings.defaults.inlay_hints = Some(InlayHintSettings {
3134 enabled: true,
3135 show_type_hints: true,
3136 show_parameter_hints: true,
3137 show_other_hints: true,
3138 })
3139 });
3140 cx.executor().run_until_parked();
3141 editor.update(cx, |editor, cx| {
3142 let expected_hints = vec!["2".to_string()];
3143 assert_eq!(
3144 expected_hints,
3145 cached_hint_labels(editor),
3146 "Should query LSP hints for the 2nd time after enabling hints in settings"
3147 );
3148 assert_eq!(expected_hints, visible_hint_labels(editor, cx));
3149 assert_eq!(editor.inlay_hint_cache().version, 3);
3150 });
3151
3152 editor.update(cx, |editor, cx| {
3153 editor.toggle_inlay_hints(&crate::ToggleInlayHints, cx)
3154 });
3155 cx.executor().run_until_parked();
3156 editor.update(cx, |editor, cx| {
3157 assert!(
3158 cached_hint_labels(editor).is_empty(),
3159 "Should clear hints after enabling in settings and a 3rd toggle"
3160 );
3161 assert!(visible_hint_labels(editor, cx).is_empty());
3162 assert_eq!(editor.inlay_hint_cache().version, 4);
3163 });
3164
3165 editor.update(cx, |editor, cx| {
3166 editor.toggle_inlay_hints(&crate::ToggleInlayHints, cx)
3167 });
3168 cx.executor().run_until_parked();
3169 editor.update(cx, |editor, cx| {
3170 let expected_hints = vec!["3".to_string()];
3171 assert_eq!(
3172 expected_hints,
3173 cached_hint_labels(editor),
3174 "Should query LSP hints for the 3rd time after enabling hints in settings and toggling them back on"
3175 );
3176 assert_eq!(expected_hints, visible_hint_labels(editor, cx));
3177 assert_eq!(editor.inlay_hint_cache().version, 5);
3178 });
3179 }
3180
3181 pub(crate) fn init_test(cx: &mut TestAppContext, f: impl Fn(&mut AllLanguageSettingsContent)) {
3182 cx.update(|cx| {
3183 let settings_store = SettingsStore::test(cx);
3184 cx.set_global(settings_store);
3185 theme::init(theme::LoadThemes::JustBase, cx);
3186 client::init_settings(cx);
3187 language::init(cx);
3188 Project::init_settings(cx);
3189 workspace::init_settings(cx);
3190 crate::init(cx);
3191 });
3192
3193 update_test_language_settings(cx, f);
3194 }
3195
3196 async fn prepare_test_objects(
3197 cx: &mut TestAppContext,
3198 ) -> (&'static str, WindowHandle<Editor>, FakeLanguageServer) {
3199 let mut language = Language::new(
3200 LanguageConfig {
3201 name: "Rust".into(),
3202 path_suffixes: vec!["rs".to_string()],
3203 ..Default::default()
3204 },
3205 Some(tree_sitter_rust::language()),
3206 );
3207 let mut fake_servers = language
3208 .set_fake_lsp_adapter(Arc::new(FakeLspAdapter {
3209 capabilities: lsp::ServerCapabilities {
3210 inlay_hint_provider: Some(lsp::OneOf::Left(true)),
3211 ..Default::default()
3212 },
3213 ..Default::default()
3214 }))
3215 .await;
3216
3217 let fs = FakeFs::new(cx.background_executor.clone());
3218 fs.insert_tree(
3219 "/a",
3220 json!({
3221 "main.rs": "fn main() { a } // and some long comment to ensure inlays are not trimmed out",
3222 "other.rs": "// Test file",
3223 }),
3224 )
3225 .await;
3226
3227 let project = Project::test(fs, ["/a".as_ref()], cx).await;
3228 project.update(cx, |project, _| project.languages().add(Arc::new(language)));
3229 let buffer = project
3230 .update(cx, |project, cx| {
3231 project.open_local_buffer("/a/main.rs", cx)
3232 })
3233 .await
3234 .unwrap();
3235 cx.executor().run_until_parked();
3236 cx.executor().start_waiting();
3237 let fake_server = fake_servers.next().await.unwrap();
3238 let editor = cx.add_window(|cx| Editor::for_buffer(buffer, Some(project), cx));
3239
3240 editor.update(cx, |editor, cx| {
3241 assert!(cached_hint_labels(editor).is_empty());
3242 assert!(visible_hint_labels(editor, cx).is_empty());
3243 assert_eq!(editor.inlay_hint_cache().version, 0);
3244 });
3245
3246 ("/a/main.rs", editor, fake_server)
3247 }
3248
3249 pub fn cached_hint_labels(editor: &Editor) -> Vec<String> {
3250 let mut labels = Vec::new();
3251 for (_, excerpt_hints) in &editor.inlay_hint_cache().hints {
3252 let excerpt_hints = excerpt_hints.read();
3253 for id in &excerpt_hints.ordered_hints {
3254 labels.push(excerpt_hints.hints_by_id[id].text());
3255 }
3256 }
3257
3258 labels.sort();
3259 labels
3260 }
3261
3262 pub fn visible_hint_labels(editor: &Editor, cx: &ViewContext<'_, Editor>) -> Vec<String> {
3263 let mut hints = editor
3264 .visible_inlay_hints(cx)
3265 .into_iter()
3266 .map(|hint| hint.text.to_string())
3267 .collect::<Vec<_>>();
3268 hints.sort();
3269 hints
3270 }
3271}