Provide codelenses for endpoints of the running app

[angelozerr]

Provide codelenses for endpoints of the running app

Fixes #114

Signed-off-by: azerr azerr@redhat.com

[angelozerr]

This draft PR requires the draft PR redhat-developer/vscode-quarkus#146 (from vscode-quarkus):

First please don't review the code, I must clean it, but you can start play with the codelens but there are several limitation:

• codelens should be displayed according the settings quarkus.tools.java.codelens.urlCodeLensEnabled.
• click on URL codelens open a web browser with a Command, but we should check that client capability can manage this open URL
• when Java text changed, the ICompilationUnit get from JDTUtils is not synchronized with the text editor. How to fix that? Not sure with that but Spring LS seems creating their own ICompilationUnit, I would like to avoid doing that to avoird parsing twice the Java content.
• Codelens URL is displayed even if Quarkus application is not started, How to do that?
• the base URL is hard coded, we should compute it by using port of application.properties and gives the capability to customize this base URL (in an array string)) when base URL cannot be computed (ex : base URL coming from a pom.xml)

[fbricon]

Before displaying the code lens, you might want to see if the url is accessible (check for connection refused)

[angelozerr]

Before displaying the code lens, you might want to see if the url is accessible (check for connection refused)

Indeed it's a limitation that I wrote: "Codelens URL is displayed even if Quarkus application is not started, How to do that?"

check for connection refused could work but when you start the Quarkus application, it should be nice to refresh Codelens and show the URL. That's why how to do that?

For local URL, an idea is to track the start / end of DevModeMain application:

[fbricon]

try https://stackoverflow.com/a/3584332/753170 before sending codelenses

[fbricon]

Slashes should be de-duplicated.

Using

package foo.bar;

import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;

@Path("/salut")
public class HelloResource {
    
    @GET
    @Produces(MediaType.TEXT_PLAIN)
    @Path("/tadaa")
    //should generate http://localhost:8080/salut/tadaa instead of http://localhost:8080/salut//tadaa
    public String hello() {
        return "Salut";
    }
}

[angelozerr]

I must write tests but you can play with PR. Please note this PR requires redhat-developer/vscode-quarkus#146

[xorye]

works quite well on my end

[fbricon]

adding static methods, they get codelenses. I don't think this is allowed, certainly not for private methods:

[fbricon]

After adding quarkus.http.port=9090 to application.properties and reopening a JAX-RS resource, the codelenses still point toward 8080

[fbricon]

check for server available should happen here, only once

[angelozerr]

If I do that I check the server for any Java file. In my case I check the server only once for Java class bound with JAX-RS Path (just for the class not for the method), that's to say, the server check is done once.

[fbricon]

there's no need to iterate on all members if the server is not even started

[angelozerr]

there's no need to iterate on all members if the server is not even started

I would like to avoid checking the server state of Java class which is not a JAX-RS resource (class which is not annotated with @path).

Given this java file:

@Path
public class A {

  public void f()

  public void g()
}

One check is done (only on A java element IType not for the methods)

Given this java file

class B {

}

None check on server state is done since B is no bound to @path.

[angelozerr]

After adding quarkus.http.port=9090 to application.properties and reopening a JAX-RS resource, the codelenses still point toward 8080

It should work now, but please check that URL is available because sometimes when I change the value of port, the server is not restarted and keep the old port?

[angelozerr]

adding static methods, they get codelenses. I don't think this is allowed, certainly not for private methods:

You are right, after playing with JAX-RS, the rule is:

• method must be public (static seems working)
• and method must be annotated with @GET

[angelozerr]

After adding quarkus.http.port=9090 to application.properties and reopening a JAX-RS resource, the codelenses still point toward 8080

It's an issue for Quarkus I think quarkusio/quarkus#5864