Skip to content

fix: Prevent whole-file PSI caching in highlight handler #1659

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
angelozerr merged 2 commits into from
Sep 1, 2026
Merged

fix: Prevent whole-file PSI caching in highlight handler #1659

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
758e25e
Fix whole-file PSI caching issue in highlight handler by adding fallb…
ethanhann Aug 31, 2026
20833d6
Use SimpleLanguageUtils.isSupported() and remove isWholeFileElementAt…
ethanhann Aug 31, 2026
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
9 changes: 8 additions & 1 deletion .../java/com/redhat/devtools/lsp4ij/features/highlight/LSPHighlightUsagesHandlerFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
import com.redhat.devtools.lsp4ij.LSPIJUtils;
import com.redhat.devtools.lsp4ij.LanguageServersRegistry;
import com.redhat.devtools.lsp4ij.client.indexing.ProjectIndexingManager;
import com.redhat.devtools.lsp4ij.internal.SimpleLanguageUtils;
import org.eclipse.lsp4j.DocumentHighlight;
import org.eclipse.lsp4j.DocumentHighlightKind;
import org.eclipse.lsp4j.TextDocumentIdentifier;
Expand Down Expand Up @@ -58,7 +59,13 @@ public class LSPHighlightUsagesHandlerFactory implements HighlightUsagesHandlerF
return null;
}
List<LSPHighlightPsiElement> targets = getTargets(editor, file);
return targets.isEmpty() ? null : new LSPHighlightUsagesHandler(editor, file, targets);
if (targets.isEmpty()) {
// For a TEXT or textmate file, returning null here would make the IDE cache the empty result
// for the whole file, and it would stop sending 'textDocument/documentHighlight' until the document changes.
// See https://github.com/redhat-developer/lsp4ij/issues/1300
return SimpleLanguageUtils.isSupported(file.getLanguage()) ? new LSPHighlightUsagesHandler(editor, file, targets) : null;
}
return new LSPHighlightUsagesHandler(editor, file, targets);
}

private List<LSPHighlightPsiElement> getTargets(Editor editor, PsiFile psiFile) {
Expand Down
Loading