perf: LSP cancellation support #1093

angelozerr · 2023-08-09T16:24:30Z

perf: LSP cancellation support

Fixes #791

src/main/java/com/redhat/devtools/intellij/lsp4ij/LanguageServerExcecutionContext.java

angelozerr · 2023-08-10T07:45:57Z

The PR is ready and all operations completion, inlayhint, etc managed cancellation support. The cancel support is interesting when language server takes some times to give a response and a new request is called.

You should see now in the trace Sending notification '$/cancelRequest'

[Trace - 09:35:35 AM] Received notification 'textDocument/publishDiagnostics'
[Trace - 09:35:35 AM] Sending notification '$/cancelRequest'
[Trace - 09:35:35 AM] Received response 'textDocument/inlayHint - (2)' in 392ms.
[Trace - 09:35:36 AM] Sending request 'textDocument/inlayHint - (3)'.
[Trace - 09:35:36 AM] Sending notification '$/cancelRequest'
[Trace - 09:35:36 AM] Received response 'textDocument/inlayHint - (3)' in 856ms.
[Trace - 09:35:36 AM] Sending notification 'textDocument/didSave'
[Trace - 09:35:36 AM] Sending notification 'textDocument/didChange'
[Trace - 09:35:37 AM] Sending notification 'textDocument/didSave'
[Trace - 09:35:37 AM] Sending notification 'textDocument/didChange'
[Trace - 09:35:37 AM] Sending request 'textDocument/inlayHint - (4)'.
[Trace - 09:35:37 AM] Sending notification '$/cancelRequest'

As our language server are fast, it can be difficult to produce a cancel.

To reproduce this cancel, I created an application.properties with 1500 lines and I type fast to open / close the completion and you should see $/cancelRequest. I notice too that inlay hint can be slow and sometimes it is canceled with $/cancelRequest.

angelozerr · 2023-08-10T07:53:06Z

Please note that when a cancelRequest occurs it will not cancel the future which is created on IJ side (IndexAwareLanguageClient). We need to do some improvement on our language server

src/main/java/com/redhat/devtools/intellij/lsp4ij/internal/CancellationSupport.java

src/main/java/com/redhat/devtools/intellij/lsp4ij/LanguageServerItem.java

fbricon · 2023-08-10T11:35:46Z

src/main/java/com/redhat/devtools/intellij/lsp4ij/LanguageServerItem.java

+/**
+ * Itemwhich stores the initialized LSP4j language server and the language server wrapper.
+ */
+public class LanguageServerItem {


we'll have to turn this into a record, once Java 17 is required

...java/com/redhat/devtools/intellij/lsp4ij/operations/completion/LSPCompletionContributor.java

fbricon · 2023-08-10T11:40:16Z

src/main/java/com/redhat/devtools/intellij/lsp4ij/operations/hover/LSPTextHover.java

-                                        }
-                                    }).filter(Objects::nonNull).collect(Collectors.toList()));
+                                    .map(languageServer ->
+                                            cancellationSupport.execute(


if it runs in async, there's a small risk that at this point cancellationSupport could be null-ed by other methods

fbricon · 2023-08-10T14:50:24Z

I opened https://github.com/ia3andy/quarkus-blast/blob/main/src/main/resources/templates/GameController/partials/grid.html, clicked on an inlay hint and got that exception:

java.lang.ClassCastException: class com.redhat.devtools.intellij.lsp4ij.LanguageServerWrapper cannot be cast to class org.eclipse.lsp4j.services.LanguageServer (com.redhat.devtools.intellij.lsp4ij.LanguageServerWrapper and org.eclipse.lsp4j.services.LanguageServer are in unnamed module of loader com.intellij.ide.plugins.cl.PluginClassLoader @72128910)
	at com.redhat.devtools.intellij.lsp4ij.operations.inlayhint.LSPInlayHintInlayProvider.lambda$createInlayPresentation$1(LSPInlayHintInlayProvider.java:182)
	at com.intellij.codeInsight.hints.presentation.PresentationFactory$referenceOnHover$hovered$1.invoke(PresentationFactory.kt:278)
	at com.intellij.codeInsight.hints.presentation.PresentationFactory$referenceOnHover$hovered$1.invoke(PresentationFactory.kt:42)
	at com.intellij.codeInsight.hints.presentation.PresentationFactory$onClick$2.invoke(PresentationFactory.kt:251)
	at com.intellij.codeInsight.hints.presentation.PresentationFactory$onClick$2.invoke(PresentationFactory.kt:42)
	at com.intellij.codeInsight.hints.presentation.OnClickPresentation$1.onClick(OnClickPresentation.kt:17)
	at com.intellij.codeInsight.hints.presentation.OnClickPresentation.mouseClicked(OnClickPresentation.kt:21)
	at com.intellij.codeInsight.hints.presentation.DynamicDelegatePresentation.mouseClicked(DynamicDelegatePresentation.kt:53)
	at com.intellij.codeInsight.hints.presentation.StaticDelegatePresentation.mouseClicked(StaticDelegatePresentation.kt:51)
	at com.intellij.codeInsight.hints.presentation.StaticDelegatePresentation.mouseClicked(StaticDelegatePresentation.kt:51)
	at com.intellij.codeInsight.hints.presentation.SequencePresentation$mouseClicked$1.invoke(SequencePresentation.kt:71)
	at com.intellij.codeInsight.hints.presentation.SequencePresentation$mouseClicked$1.invoke(SequencePresentation.kt:16)
	at com.intellij.codeInsight.hints.presentation.SequencePresentation.handleMouse(SequencePresentation.kt:62)
	at com.intellij.codeInsight.hints.presentation.SequencePresentation.mouseClicked(SequencePresentation.kt:70)
	at com.intellij.codeInsight.hints.presentation.InsetPresentation$mouseClicked$1.invoke(InsetPresentation.kt:53)
	at com.intellij.codeInsight.hints.presentation.InsetPresentation$mouseClicked$1.invoke(InsetPresentation.kt:13)
	at com.intellij.codeInsight.hints.presentation.InsetPresentation.handleMouse(InsetPresentation.kt:48)
	at com.intellij.codeInsight.hints.presentation.InsetPresentation.mouseClicked(InsetPresentation.kt:52)
	at com.intellij.codeInsight.hints.presentation.StaticDelegatePresentation.mouseClicked(StaticDelegatePresentation.kt:51)
	at com.intellij.codeInsight.hints.presentation.StaticDelegatePresentation.mouseClicked(StaticDelegatePresentation.kt:51)
	at com.intellij.codeInsight.hints.presentation.DynamicInsetPresentation$mouseClicked$1.invoke(DynamicInsetPresentation.kt:57)
	at com.intellij.codeInsight.hints.presentation.DynamicInsetPresentation$mouseClicked$1.invoke(DynamicInsetPresentation.kt:11)
	at com.intellij.codeInsight.hints.presentation.DynamicInsetPresentation.handleMouse(DynamicInsetPresentation.kt:52)
	at com.intellij.codeInsight.hints.presentation.DynamicInsetPresentation.mouseClicked(DynamicInsetPresentation.kt:56)
	at com.intellij.codeInsight.hints.presentation.RecursivelyUpdatingRootPresentation.mouseClicked(RecursivelyUpdatingRootPresentation.kt:69)
	at com.intellij.codeInsight.hints.LinearOrderInlayRenderer.mouseClicked(LinearOrderInlayRenderer.kt:113)
	at com.intellij.codeInsight.hints.presentation.listeners.InlayEditorMouseListener$mouseClicked$1.run(InlayEditorMouseListener.kt:26)
	at com.intellij.util.SlowOperations.allowSlowOperations(SlowOperations.java:149)
	at com.intellij.codeInsight.hints.presentation.listeners.InlayEditorMouseListener.mouseClicked(InlayEditorMouseListener.kt:25)
	at com.intellij.openapi.editor.impl.event.EditorEventMulticasterImpl$2.lambda$mouseClicked$1(EditorEventMulticasterImpl.java:73)
	at com.intellij.openapi.extensions.impl.ExtensionProcessingHelper.forEachExtensionSafe(ExtensionProcessingHelper.java:34)
	at com.intellij.openapi.extensions.ExtensionPointName.forEachExtensionSafe(ExtensionPointName.java:46)
	at com.intellij.openapi.editor.impl.event.EditorEventMulticasterImpl$2.mouseClicked(EditorEventMulticasterImpl.java:73)
	at com.intellij.openapi.editor.impl.EditorImpl$MyMouseAdapter.runMouseClickedCommand(EditorImpl.java:3954)
	at com.intellij.openapi.editor.impl.EditorImpl$MyMouseAdapter.mouseReleased(EditorImpl.java:3873)
	at java.desktop/java.awt.Component.processMouseEvent(Component.java:6648)
	at java.desktop/javax.swing.JComponent.processMouseEvent(JComponent.java:3392)
	at java.desktop/java.awt.Component.processEvent(Component.java:6413)
	at java.desktop/java.awt.Container.processEvent(Container.java:2266)
	at java.desktop/java.awt.Component.dispatchEventImpl(Component.java:5022)
	at java.desktop/java.awt.Container.dispatchEventImpl(Container.java:2324)
	at java.desktop/java.awt.Component.dispatchEvent(Component.java:4854)
	at java.desktop/java.awt.LightweightDispatcher.retargetMouseEvent(Container.java:4948)
	at java.desktop/java.awt.LightweightDispatcher.processMouseEvent(Container.java:4575)
	at java.desktop/java.awt.LightweightDispatcher.dispatchEvent(Container.java:4516)
	at java.desktop/java.awt.Container.dispatchEventImpl(Container.java:2310)
	at java.desktop/java.awt.Window.dispatchEventImpl(Window.java:2802)
	at java.desktop/java.awt.Component.dispatchEvent(Component.java:4854)
	at java.desktop/java.awt.EventQueue.dispatchEventImpl(EventQueue.java:781)
	at java.desktop/java.awt.EventQueue$4.run(EventQueue.java:730)
	at java.desktop/java.awt.EventQueue$4.run(EventQueue.java:724)
	at java.base/java.security.AccessController.doPrivileged(AccessController.java:399)
	at java.base/java.security.ProtectionDomain$JavaSecurityAccessImpl.doIntersectionPrivilege(ProtectionDomain.java:86)
	at java.base/java.security.ProtectionDomain$JavaSecurityAccessImpl.doIntersectionPrivilege(ProtectionDomain.java:97)
	at java.desktop/java.awt.EventQueue$5.run(EventQueue.java:754)
	at java.desktop/java.awt.EventQueue$5.run(EventQueue.java:752)
	at java.base/java.security.AccessController.doPrivileged(AccessController.java:399)
	at java.base/java.security.ProtectionDomain$JavaSecurityAccessImpl.doIntersectionPrivilege(ProtectionDomain.java:86)
	at java.desktop/java.awt.EventQueue.dispatchEvent(EventQueue.java:751)
	at com.intellij.ide.IdeEventQueue.defaultDispatchEvent(IdeEventQueue.java:898)
	at com.intellij.ide.IdeEventQueue.dispatchMouseEvent(IdeEventQueue.java:820)
	at com.intellij.ide.IdeEventQueue._dispatchEvent(IdeEventQueue.java:743)
	at com.intellij.ide.IdeEventQueue.lambda$dispatchEvent$6(IdeEventQueue.java:439)
	at com.intellij.openapi.progress.impl.CoreProgressManager.computePrioritized(CoreProgressManager.java:791)
	at com.intellij.ide.IdeEventQueue.lambda$dispatchEvent$7(IdeEventQueue.java:438)
	at com.intellij.openapi.application.TransactionGuardImpl.performActivity(TransactionGuardImpl.java:113)
	at com.intellij.ide.IdeEventQueue.performActivity(IdeEventQueue.java:604)
	at com.intellij.ide.IdeEventQueue.lambda$dispatchEvent$8(IdeEventQueue.java:436)
	at com.intellij.openapi.application.impl.ApplicationImpl.runIntendedWriteActionOnCurrentThread(ApplicationImpl.java:881)
	at com.intellij.ide.IdeEventQueue.dispatchEvent(IdeEventQueue.java:484)
	at java.desktop/java.awt.EventDispatchThread.pumpOneEventForFilters(EventDispatchThread.java:207)
	at java.desktop/java.awt.EventDispatchThread.pumpEventsForFilter(EventDispatchThread.java:128)
	at java.desktop/java.awt.EventDispatchThread.pumpEventsForHierarchy(EventDispatchThread.java:117)
	at java.desktop/java.awt.EventDispatchThread.pumpEvents(EventDispatchThread.java:113)
	at java.desktop/java.awt.EventDispatchThread.pumpEvents(EventDispatchThread.java:105)
	at java.desktop/java.awt.EventDispatchThread.run(EventDispatchThread.java:92)

fbricon · 2023-08-10T14:53:42Z

Also saw this in my logs:

SEVERE: Internal error: java.lang.NullPointerException: Cannot invoke "java.util.concurrent.CompletionStage.toCompletableFuture()" because the return value of "java.util.function.Function.apply(Object)" is null
java.util.concurrent.CompletionException: java.lang.NullPointerException: Cannot invoke "java.util.concurrent.CompletionStage.toCompletableFuture()" because the return value of "java.util.function.Function.apply(Object)" is null
	at java.base/java.util.concurrent.CompletableFuture.encodeThrowable(CompletableFuture.java:315)
	at java.base/java.util.concurrent.CompletableFuture.completeThrowable(CompletableFuture.java:320)
	at java.base/java.util.concurrent.CompletableFuture$UniCompose.tryFire(CompletableFuture.java:1159)
	at java.base/java.util.concurrent.CompletableFuture$Completion.exec(CompletableFuture.java:483)
	at java.base/java.util.concurrent.ForkJoinTask.doExec(ForkJoinTask.java:373)
	at java.base/java.util.concurrent.ForkJoinPool$WorkQueue.topLevelExec(ForkJoinPool.java:1182)
	at java.base/java.util.concurrent.ForkJoinPool.scan(ForkJoinPool.java:1655)
	at java.base/java.util.concurrent.ForkJoinPool.runWorker(ForkJoinPool.java:1622)
	at java.base/java.util.concurrent.ForkJoinWorkerThread.run(ForkJoinWorkerThread.java:165)
Caused by: java.lang.NullPointerException: Cannot invoke "java.util.concurrent.CompletionStage.toCompletableFuture()" because the return value of "java.util.function.Function.apply(Object)" is null
	at java.base/java.util.concurrent.CompletableFuture$UniCompose.tryFire(CompletableFuture.java:1150)
	... 6 more

No idea what caused it.

Fixes redhat-developer#791 Signed-off-by: azerr <[email protected]>

sonarcloud · 2023-08-10T15:12:47Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

angelozerr · 2023-08-10T15:13:51Z

Also saw this in my logs:

I don't know -(

angelozerr · 2023-08-10T15:14:16Z

I opened https://github.com/ia3andy/quarkus-blast/blob/main/src/main/resources/templates/GameController/partials/grid.html, clicked on an inlay hint and got that exception:

Should be fixed

fbricon · 2023-08-10T17:12:04Z

Thanks @angelozerr

openshift-ci bot added the do-not-merge/work-in-progress label Aug 9, 2023

fbricon reviewed Aug 9, 2023

View reviewed changes

src/main/java/com/redhat/devtools/intellij/lsp4ij/LanguageServerExcecutionContext.java Outdated Show resolved Hide resolved

angelozerr force-pushed the cancel_support branch from a895bf3 to cbe5dc6 Compare August 9, 2023 16:40

fbricon reviewed Aug 9, 2023

View reviewed changes

src/main/java/com/redhat/devtools/intellij/lsp4ij/LanguageServerExcecutionContext.java Outdated Show resolved Hide resolved

angelozerr force-pushed the cancel_support branch 5 times, most recently from bf8402a to 57ce183 Compare August 10, 2023 07:34

angelozerr marked this pull request as ready for review August 10, 2023 07:38

openshift-ci bot removed the do-not-merge/work-in-progress label Aug 10, 2023

angelozerr force-pushed the cancel_support branch 2 times, most recently from 92082ba to 80183a2 Compare August 10, 2023 10:49

fbricon requested changes Aug 10, 2023

View reviewed changes

angelozerr force-pushed the cancel_support branch from 80183a2 to 05e338f Compare August 10, 2023 13:46

angelozerr force-pushed the cancel_support branch from 05e338f to 95baa2b Compare August 10, 2023 15:05

perf: LSP cancellation support

8853b08

Fixes redhat-developer#791 Signed-off-by: azerr <[email protected]>

angelozerr force-pushed the cancel_support branch from 95baa2b to 8853b08 Compare August 10, 2023 15:12

fbricon merged commit afe404b into redhat-developer:main Aug 10, 2023
11 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

perf: LSP cancellation support #1093

perf: LSP cancellation support #1093

angelozerr commented Aug 9, 2023

angelozerr commented Aug 10, 2023

angelozerr commented Aug 10, 2023

fbricon Aug 10, 2023

fbricon Aug 10, 2023

fbricon commented Aug 10, 2023 •

edited

Loading

fbricon commented Aug 10, 2023

sonarcloud bot commented Aug 10, 2023

angelozerr commented Aug 10, 2023

angelozerr commented Aug 10, 2023

fbricon commented Aug 10, 2023

perf: LSP cancellation support #1093

perf: LSP cancellation support #1093

Conversation

angelozerr commented Aug 9, 2023

angelozerr commented Aug 10, 2023

angelozerr commented Aug 10, 2023

fbricon Aug 10, 2023

Choose a reason for hiding this comment

fbricon Aug 10, 2023

Choose a reason for hiding this comment

fbricon commented Aug 10, 2023 • edited Loading

fbricon commented Aug 10, 2023

sonarcloud bot commented Aug 10, 2023

angelozerr commented Aug 10, 2023

angelozerr commented Aug 10, 2023

fbricon commented Aug 10, 2023

fbricon commented Aug 10, 2023 •

edited

Loading