Skip to content

fix: Send a single hover request every time the user hovers #1544

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rubenporras merged 1 commit into from
Jun 9, 2026
Merged

fix: Send a single hover request every time the user hovers #1544

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion org.eclipse.lsp4e.test/META-INF/MANIFEST.MF
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Manifest-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: Tests for language server bundle (Incubation)
Bundle-SymbolicName: org.eclipse.lsp4e.test;singleton:=true
Bundle-Version: 0.16.11.qualifier
Bundle-Version: 0.16.12.qualifier
Fragment-Host: org.eclipse.lsp4e
Bundle-Vendor: Eclipse LSP4E
Bundle-RequiredExecutionEnvironment: JavaSE-21
Expand Down
2 changes: 1 addition & 1 deletion org.eclipse.lsp4e.test/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
</parent>
<artifactId>org.eclipse.lsp4e.test</artifactId>
<packaging>eclipse-test-plugin</packaging>
<version>0.16.11-SNAPSHOT</version>
<version>0.16.12-SNAPSHOT</version>

<properties>
<os-jvm-flags /> <!-- for the default case -->
Expand Down
77 changes: 68 additions & 9 deletions org.eclipse.lsp4e.test/src/org/eclipse/lsp4e/test/hover/HoverTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*******************************************************************************
* Copyright (c) 2016 Rogue Wave Software Inc. and others.
* Copyright (c) 2016, 2026 Rogue Wave Software Inc. and others.
* This program and the accompanying materials are made
* available under the terms of the Eclipse Public License 2.0
* which is available at https://www.eclipse.org/legal/epl-2.0/
Expand Down Expand Up @@ -28,7 +28,9 @@
import org.eclipse.core.filesystem.EFS;
import org.eclipse.core.resources.IFile;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.jdt.annotation.Nullable;
import org.eclipse.jface.internal.text.html.BrowserInformationControl;
import org.eclipse.jface.text.IRegion;
import org.eclipse.jface.text.ITextViewer;
import org.eclipse.jface.text.Region;
import org.eclipse.lsp4e.LSPEclipseUtils;
Expand Down Expand Up @@ -98,7 +100,8 @@ public void testHoverInfo() throws Exception {
IFile file = TestUtils.createUniqueTestFile(project, "HoverRange Other Text");
ITextViewer viewer = TestUtils.openTextViewer(file);

String html = hover.getHoverInfoFuture(viewer, new Region(0, 10)).get(2, TimeUnit.SECONDS);
@Nullable IRegion hoverRegion = hover.getHoverRegion(viewer, 0);
String html = hover.getHoverInfoFuture(viewer, hoverRegion).get(2, TimeUnit.SECONDS);
assertNotNull(html);
assertTrue(html.contains("HoverContent"));
}
Expand All @@ -111,8 +114,8 @@ public void testHoverInfoEmptyContentList() throws CoreException {

IFile file = TestUtils.createUniqueTestFile(project, "HoverRange Other Text");
ITextViewer viewer = TestUtils.openTextViewer(file);

assertEquals(null, hover.getHoverInfo(viewer, new Region(0, 10)));
@Nullable IRegion hoverRegion = hover.getHoverRegion(viewer, 0);
assertEquals(null, hover.getHoverInfo(viewer, hoverRegion));
}

@Test
Expand All @@ -122,7 +125,8 @@ public void testHoverInfoInvalidOffset() throws CoreException {
IFile file = TestUtils.createUniqueTestFile(project, "HoverRange Other Text");
ITextViewer viewer = TestUtils.openTextViewer(file);

assertEquals(null, hover.getHoverInfo(viewer, new Region(0, 10)));
@Nullable IRegion hoverRegion = hover.getHoverRegion(viewer, 0);
assertEquals(null, hover.getHoverInfo(viewer, hoverRegion));
}

@Test
Expand All @@ -134,7 +138,8 @@ public void testHoverEmptyContentItem() throws CoreException {
IFile file = TestUtils.createUniqueTestFile(project, "HoverRange Other Text");
ITextViewer viewer = TestUtils.openTextViewer(file);

assertEquals(null, hover.getHoverInfo(viewer, new Region(0, 10)));
@Nullable IRegion hoverRegion = hover.getHoverRegion(viewer, 0);
assertEquals(null, hover.getHoverInfo(viewer, hoverRegion));
}

@Test
Expand All @@ -146,7 +151,8 @@ public void testHoverOnExternalFile(@TempDir Path tempDir) throws Exception {
Path file = Files.createFile(tempDir.resolve("testHoverOnExternalfile.lspt"));
ITextViewer viewer = LSPEclipseUtils
.getTextViewer(IDE.openInternalEditorOnFileStore(UI.getActivePage(), EFS.getStore(file.toUri())));
String html = hover.getHoverInfoFuture(viewer, new Region(0, 0)).get(2, TimeUnit.SECONDS);
@Nullable IRegion hoverRegion = hover.getHoverRegion(viewer, 0);
String html = hover.getHoverInfoFuture(viewer, hoverRegion).get(2, TimeUnit.SECONDS);
assertTrue(html != null && html.contains("blah"));
}

Expand All @@ -159,7 +165,8 @@ public void testMultipleHovers() throws Exception {
IFile file = TestUtils.createUniqueTestFileMultiLS(project, "HoverRange Other Text");
ITextViewer viewer = TestUtils.openTextViewer(file);

String hoverInfo = hover.getHoverInfoFuture(viewer, new Region(0, 10)).get(2, TimeUnit.SECONDS);
@Nullable IRegion hoverRegion = hover.getHoverRegion(viewer, 0);
String hoverInfo = hover.getHoverInfoFuture(viewer, hoverRegion).get(2, TimeUnit.SECONDS);
int index = hoverInfo.indexOf("HoverContent");
assertNotEquals(-1, index, "Hover content not found");
index += "HoverContent".length();
Expand All @@ -182,7 +189,8 @@ public void testIntroUrlLink() throws Exception {
ITextViewer viewer = LSPEclipseUtils.getTextViewer(editorPart);
assertEquals(UI.getActivePart(), editorPart);

String hoverContent = hover.getHoverInfoFuture(viewer, new Region(0, 10)).get(2, TimeUnit.SECONDS);
@Nullable IRegion hoverRegion = hover.getHoverRegion(viewer, 0);
String hoverContent = hover.getHoverInfoFuture(viewer, hoverRegion).get(2, TimeUnit.SECONDS);

final var hoverManager = new LSPTextHover();

Expand Down Expand Up @@ -235,4 +243,55 @@ public void completed(ProgressEvent event) {
shell.dispose();
}
}

@Test
public void testHoverRegionRefreshesForSameOffsetAfterCompletedRequest() throws Exception {
// Test for https://github.com/eclipse-lsp4e/lsp4e/issues/1514
// Verifies that getHoverRegion refreshes for the same offset after a completed
// request, instead of reusing the previous completed hover range indefinitely.
final var firstHover = new Hover(List.of(Either.forLeft("FirstValue")),
new Range(new Position(0, 0), new Position(0, 5)));
final var secondHover = new Hover(List.of(Either.forLeft("SecondValue")),
new Range(new Position(0, 6), new Position(0, 10)));

IFile file = TestUtils.createUniqueTestFile(project, "HoverRange Other Text");
ITextViewer viewer = TestUtils.openTextViewer(file);

MockLanguageServer.INSTANCE.setHover(firstHover);
assertEquals(new Region(0, 5), hover.getHoverRegion(viewer, 2));

MockLanguageServer.INSTANCE.setHover(secondHover);
assertEquals(new Region(6, 4), hover.getHoverRegion(viewer, 2));
}

@Test
public void testHoverInfoRefreshesForSameOffsetAfterCompletedRequest() throws Exception {
// Test for https://github.com/eclipse-lsp4e/lsp4e/issues/1514
// Verifies that a second hover at the same offset recomputes the hover region
// and refreshes the hover content after the previous request completed.
final var firstHover = new Hover(List.of(Either.forLeft("FirstValue")),
new Range(new Position(0, 0), new Position(0, 5)));
final var secondHover = new Hover(List.of(Either.forLeft("SecondValue")),
new Range(new Position(0, 6), new Position(0, 10)));

IFile file = TestUtils.createUniqueTestFile(project, "HoverRange Other Text");
ITextViewer viewer = TestUtils.openTextViewer(file);

MockLanguageServer.INSTANCE.setHover(firstHover);
Region firstRegion = (Region) hover.getHoverRegion(viewer, 2);
assertEquals(new Region(0, 5), firstRegion);

String firstHtml = hover.getHoverInfoFuture(viewer, firstRegion).get(2, TimeUnit.SECONDS);
assertNotNull(firstHtml);
assertTrue(firstHtml.contains("FirstValue"));

MockLanguageServer.INSTANCE.setHover(secondHover);
Region secondRegion = (Region) hover.getHoverRegion(viewer, 2);
assertEquals(new Region(6, 4), secondRegion);

String secondHtml = hover.getHoverInfoFuture(viewer, secondRegion).get(2, TimeUnit.SECONDS);
assertNotNull(secondHtml);
assertTrue(secondHtml.contains("SecondValue"));
assertTrue(!secondHtml.contains("FirstValue"));
}
}
37 changes: 37 additions & 0 deletions org.eclipse.lsp4e/src/org/eclipse/lsp4e/operations/hover/LSPHoverRegion.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
/*******************************************************************************
* Copyright (c) 2026 Contributors to the Eclipse Foundation.
* This program and the accompanying materials are made
* available under the terms of the Eclipse Public License 2.0
* which is available at https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* See git history
*******************************************************************************/
package org.eclipse.lsp4e.operations.hover;

import java.util.List;
import java.util.concurrent.CompletableFuture;

import org.eclipse.jface.text.Region;
import org.eclipse.lsp4j.Hover;

/**
* A {@link Region} which contains the hover request which was sent when
* creating this region.
*/
public class LSPHoverRegion extends Region {

private final CompletableFuture<List<Hover>> request;

public LSPHoverRegion(int offset, int length, CompletableFuture<List<Hover>> request) {
super(offset, length);
this.request = request;
}

public CompletableFuture<List<Hover>> getRequest() {
return request;
}

}
Loading
Loading