Support CodeAction resolve for Java code actions #299

datho7561 · 2022-10-06T20:32:17Z

Resolve workspace edits only when the code action is applied for all code actions for Java files that modify source files. This should increase the performance of editing Java files with lsp4mp active, since the edits of all the code actions don't need to be computed.

I also adjusted the title of the "Add @operation annotation" code action to include the class that the code action will apply to.

Closes #171

...c/main/java/org/eclipse/lsp4mp/jdt/core/java/codeaction/InsertAnnotationMissingQuickFix.java

angelozerr · 2022-10-11T08:08:31Z

.../org.eclipse.lsp4mp.jdt.core/src/main/java/org/eclipse/lsp4mp/commons/utils/JSONUtility.java

@@ -0,0 +1,78 @@
+/*******************************************************************************
+* Copyright (c) 2019 Red Hat Inc. and others.


This isn't new, I just copied it over from microprofile.ls

...ipse.lsp4mp.jdt.core/src/main/java/org/eclipse/lsp4mp/jdt/core/PropertiesManagerForJava.java

.../src/main/java/org/eclipse/lsp4mp/jdt/core/java/codeaction/JavaCodeActionResolveContext.java

...main/java/org/eclipse/lsp4mp/jdt/internal/config/java/NoValueAssignedToPropertyQuickFix.java

...re/src/main/java/org/eclipse/lsp4mp/jdt/internal/core/java/codeaction/CodeActionHandler.java

angelozerr · 2022-10-11T08:12:01Z

...ile.ls/org.eclipse.lsp4mp.ls/src/main/java/org/eclipse/lsp4mp/commons/utils/JSONUtility.java

@@ -0,0 +1,78 @@
+/*******************************************************************************
+* Copyright (c) 2019 Red Hat Inc. and others.


...mp.ls/src/main/java/org/eclipse/lsp4mp/ls/api/MicroProfileJavaCodeActionResolveProvider.java

...eclipse.lsp4mp.ls/src/main/java/org/eclipse/lsp4mp/services/java/JavaCodeActionResolver.java

....lsp4mp.ls/src/main/java/org/eclipse/lsp4mp/settings/MicroProfileCodeActionCapabilities.java

angelozerr · 2022-10-11T08:13:51Z

The code looks promising, I need to play with your PR.

datho7561 · 2022-10-13T20:25:09Z

The tests should pass now, but I would like to clean up the code (Eclipse has been formatting strange ever since I installed and uninstalled the editorconfig extension)

@operation

Resolve workspace edits only when the code action is applied for all code actions for Java files that modify source files. This should increase the performance of editing Java files with lsp4mp active, since the edits of all the code actions don't need to be computed. I also adjusted the title of the "Add @operation annotation" code action to include the class that the code action will apply to. Closes eclipse#171 Signed-off-by: David Thompson <davthomp@redhat.com>

angelozerr · 2022-10-17T13:41:21Z

@datho7561 when I see the codeAction trace:

[Trace - 15:37:54] Received response 'textDocument/codeAction - (21)' in 18ms.
Result: [
    {
        "title": "Let 'DontImplementHealthCheck' implement '@HealthCheck'",
        "kind": "quickfix",
        "diagnostics": [
            {
                "range": {
                    "start": {
                        "line": 9,
                        "character": 13
                    },
                    "end": {
                        "line": 9,
                        "character": 37
                    }
                },
                "code": "ImplementHealthCheck",
                "source": "microprofile-health",
                "message": "The class org.acme.health.DontImplementHealthCheck using the @Liveness, @Readiness, or @Health annotation should implement the HealthCheck interface."
            }
        ],
        "data": {
            "participantId": "org.eclipse.lsp4mp.jdt.internal.health.java.ImplementHealthCheckQuickFix",
            "documentUri": "file:///c%3A/Users/azerr/git/lsp4mp/microprofile.jdt/org.eclipse.lsp4mp.jdt.test/projects/maven/microprofile-health-quickstart/src/main/java/org/acme/health/DontImplementHealthCheck.java",
            "range": {
                "start": {
                    "line": 9,
                    "character": 13
                },
                "end": {
                    "line": 9,
                    "character": 37
                }
            },
            "resourceOperationSupported": true,
            "commandConfigurationUpdateSupported": true
        }
    }
]

the diagnostic range and the code action range are the same. I wonder if spec allows to returns a coe action without range and in this usecase you could use the diagnostic range, what do you think?

angelozerr · 2022-10-17T14:24:10Z

...c/main/java/org/eclipse/lsp4mp/jdt/core/java/codeaction/InsertAnnotationMissingQuickFix.java

+		Map<String, Object> extendedData = new HashMap<>();
+		extendedData.put(ANNOTATION_KEY, annotations);
+		codeAction.setData(new CodeActionResolveData(context.getUri(), getParticipantId(),
+				context.getParams().getRange(), extendedData,


I think you dont need this range since you can use the diagnostic range, no? I think this range can be usefull when your code action have several diagnostic, so perhaps you can keep this range in the data, but when there is just one diagnostic you could use the diagnostic range and not fill the code action range.

datho7561 · 2022-10-17T14:29:07Z

I wonder if spec allows to returns a code action without range and in this usecase you could use the diagnostic range, what do you think?

I put the CodeAction range into the CodeAction data, because one of our codeactions doesn't have an associated diagnostic (OpenAPI @Operator). I am using (a child type of) CodeActionContext as the parameters for resolving, since it means less changes to implement code action resolve, since I have all the same data as the original codeaction

angelozerr · 2022-10-19T08:49:06Z

It works like a charm @datho7561, great job!