[Feature] Browsing jar dependencies contents

[asmodeus812]

Similarly to Eclipse or intellij, it would be great if jdt uris supported directories or jars. The application of this being the aplity for a user to be browsing the contents of a jar dependency as if it were a filetree. There is probably more to this, but this ticket can serve as a starter / idea.

[rgrunber]

JDT-LS is simply a language server, so we'd have no control over how this would look visually. We just send the data, and it's up to clients to render it. However, it seems to me like textDocument/documentSymbol, which takes a URI, should be able to provide this. This method is what clients call when rendering the "structure" of a source/class file, often referred to as an "Outline" view :

eg. VS Code's behaviour

Maybe this could nicely display the contents of a JAR file as well.

[asmodeus812]

Yeah, indeed, i am not looking for the view. Rather, the data model, which will be used to construct the view, and it will be handled by client specific implementation. A jar can contain either other sub dirs or some resources which are not only class files. However, I am not sure if jdtls supports uris to such resources.

In addition to that, it would be nice to have a complimentary way to fetch the jar dependencies for the current project, coming from either the user config or build systems like maven, gradle, etc.

[fbricon]

The Project Manager for Java in VS Code supports it:

I don't know whether this involves special requests to a Microsoft extension or if jdt.ls provides those OOTB. @testforstephen @jdneo ?

[rgrunber]

I think it's coming from https://github.com/microsoft/vscode-java-dependency/blob/6aaf68428f0abac4e224d698ab98c83897c52285/jdtls.ext/com.microsoft.jdtls.ext.core/src/com/microsoft/jdtls/ext/core/CommandHandler.java#L30-L31 , which appears to be based on the Java model. So if we wanted to do this through document symbols, we could possibly move the code into JDT-LS and then just call it for https://github.com/microsoft/vscode-java-dependency/blob/main/jdtls.ext/com.microsoft.jdtls.ext.core/src/com/microsoft/jdtls/ext/core/PackageCommand.java#L366-L382

It appears to be computed on-demand. So you expand an entry and it sends the request for elements.

[Trace - 12:48:47] Sending request 'workspace/executeCommand - (7)'.
Params: {
    "command": "java.getPackageData",
    "arguments": [
        {
            "kind": 2,
            "projectUri": "file:/home/rgrunber/sample-projects/maven-my-app/"
        }
    ]
}


[Trace - 12:48:47] Received response 'workspace/executeCommand - (7)' in 25ms.
Result: [
    {
        "entryKind": 1,
        "name": "src/main/java",
        "path": "/my-app/src/main/java",
        "handlerIdentifier": "=my-app/src\\/main\\/java=/optional=/true=/=/maven.pomderived=/true=/",
        "uri": "file:/home/rgrunber/sample-projects/maven-my-app/src/main/java",
        "kind": 3,
        "metaData": {
            "maven.pomderived": "true",
            "optional": "true"
        }
    },
    {
        "entryKind": 1,
        "name": "src/main/resources",
        "path": "/my-app/src/main/resources",
        "handlerIdentifier": "=my-app/src\\/main\\/resources=/maven.pomderived=/true=/=/optional=/true=/",
        "uri": "file:/home/rgrunber/sample-projects/maven-my-app/src/main/resources",
        "kind": 3,
        "metaData": {
            "maven.pomderived": "true",
            "optional": "true"
        }
    },
    {
        "entryKind": 1,
        "name": "src/test/java",
        "path": "/my-app/src/test/java",
        "handlerIdentifier": "=my-app/src\\/test\\/java=/optional=/true=/=/maven.pomderived=/true=/=/test=/true=/",
        "uri": "file:/home/rgrunber/sample-projects/maven-my-app/src/test/java",
        "kind": 3,
        "metaData": {
            "maven.pomderived": "true",
            "test": "true",
            "optional": "true"
        }
    },
    {
        "entryKind": 5,
        "name": "JRE System Library [JavaSE-1.8]",
        "path": "org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.8",
        "uri": "file:/usr/lib/jvm/java-1.8.0-openjdk-1.8.0.412.b06-1.fc39.x86_64/",
        "kind": 8
    },
    {
        "entryKind": 5,
        "name": "Maven Dependencies",
        "path": "org.eclipse.m2e.MAVEN2_CLASSPATH_CONTAINER",
        "kind": 8
    },
    {
        "name": ".classpath",
        "path": "/my-app/.classpath",
        "uri": "file:///home/rgrunber/sample-projects/maven-my-app/.classpath",
        "kind": 10
    },
    {
        "name": ".gitignore",
        "path": "/my-app/.gitignore",
        "uri": "file:///home/rgrunber/sample-projects/maven-my-app/.gitignore",
        "kind": 10
    },
    {
        "name": ".project",
        "path": "/my-app/.project",
        "uri": "file:///home/rgrunber/sample-projects/maven-my-app/.project",
        "kind": 10
    },
    {
        "name": ".settings",
        "path": "/my-app/.settings",
        "uri": "file:///home/rgrunber/sample-projects/maven-my-app/.settings",
        "kind": 9
    },
    {
        "name": ".vscode",
        "path": "/my-app/.vscode",
        "uri": "file:///home/rgrunber/sample-projects/maven-my-app/.vscode",
        "kind": 9
    },
    {
        "name": "bin",
        "path": "/my-app/bin",
        "uri": "file:///home/rgrunber/sample-projects/maven-my-app/bin",
        "kind": 9
    },
    {
        "name": "pom.xml",
        "path": "/my-app/pom.xml",
        "uri": "file:///home/rgrunber/sample-projects/maven-my-app/pom.xml",
        "kind": 10
    },
    {
        "name": "src",
        "path": "/my-app/src",
        "uri": "file:///home/rgrunber/sample-projects/maven-my-app/src",
        "kind": 9
    },
    {
        "name": "target",
        "path": "/my-app/target",
        "uri": "file:///home/rgrunber/sample-projects/maven-my-app/target",
        "kind": 9
    }
]

Trace - 12:57:07] Sending request 'workspace/executeCommand - (9)'.
Params: {
    "command": "java.getPackageData",
    "arguments": [
        {
            "kind": 3,
            "projectUri": "file:/home/rgrunber/sample-projects/maven-my-app/",
            "rootPath": "/home/rgrunber/.m2/repository/com/google/guava/guava/30.1.1-jre/guava-30.1.1-jre.jar",
            "handlerIdentifier": "=my-app/\\/home\\/rgrunber\\/.m2\\/repository\\/com\\/google\\/guava\\/guava\\/30.1.1-jre\\/guava-30.1.1-jre.jar=/maven.pomderived=/true=/=/maven.groupId=/com.google.guava=/=/maven.artifactId=/guava=/=/maven.version=/30.1.1-jre=/=/maven.scope=/compile=/=/maven.pomderived=/true=/",
            "isHierarchicalView": false
        }
    ]
}


[Trace - 12:57:07] Received response 'workspace/executeCommand - (9)' in 55ms.
Result: [
    {
        "name": "com.google.common.escape",
        "path": "/home/rgrunber/.m2/repository/com/google/guava/guava/30.1.1-jre/guava-30.1.1-jre.jar",
        "handlerIdentifier": "=my-app/\\/home\\/rgrunber\\/.m2\\/repository\\/com\\/google\\/guava\\/guava\\/30.1.1-jre\\/guava-30.1.1-jre.jar=/maven.pomderived=/true=/=/maven.groupId=/com.google.guava=/=/maven.artifactId=/guava=/=/maven.version=/30.1.1-jre=/=/maven.scope=/compile=/=/maven.pomderived=/true=/<com.google.common.escape",
        "uri": "file:/home/rgrunber/.m2/repository/com/google/guava/guava/30.1.1-jre/guava-30.1.1-jre.jar",
        "kind": 4
    },
    {
        "name": "com.google.common.hash",
        "path": "/home/rgrunber/.m2/repository/com/google/guava/guava/30.1.1-jre/guava-30.1.1-jre.jar",
        "handlerIdentifier": "=my-app/\\/home\\/rgrunber\\/.m2\\/repository\\/com\\/google\\/guava\\/guava\\/30.1.1-jre\\/guava-30.1.1-jre.jar=/maven.pomderived=/true=/=/maven.groupId=/com.google.guava=/=/maven.artifactId=/guava=/=/maven.version=/30.1.1-jre=/=/maven.scope=/compile=/=/maven.pomderived=/true=/<com.google.common.hash",
        "uri": "file:/home/rgrunber/.m2/repository/com/google/guava/guava/30.1.1-jre/guava-30.1.1-jre.jar",
        "kind": 4
    },
   ...
   ...

[jdneo]

It appears to be computed on-demand. So you expand an entry and it sends the request for elements.

Yes, it is. I'm ok to put the logic handling into JDT.LS and let the project manager act as a UI presenter. I'm not quite sure is if we want to make it kind of public API in JDT.LS, can we put it as it is now, or we need to redesign the request and response properly.

[oclay1st]

I'm working on a Neovim plugin for Java and I really appreciate this idea. Is there any update around this?. Thanks

[asmodeus812]

I am just using the built in zip plugin to browse the *-source.jar files that works pretty neatly.

[oclay1st]

@asmodeus812 sorry but the zip plugin on neovim is a limited solution compare to the alternatives in others editors or IDEs for this use case.

[asmodeus812]

Are you joking, i very much realize that i am the one who openened this issue, i am telling you what i am using until an atlernative is found.

[oclay1st]

I managed to navigate through the JAR file but rendering the class files is still an issue because I don't have the jdt uri.

@jdneo @rgrunber is there a way to get the full jdt uri of a class via commands or something else?. Open to suggestions

[rgrunber]

Are you using code form https://github.com/microsoft/vscode-java-dependency to do this ? All you need to do is get the IClassFile object of a given class and call toUri(IClassFile) :

eclipse.jdt.ls/org.eclipse.jdt.ls.core/src/org/eclipse/jdt/ls/core/internal/JDTUtils.java

Lines 879 to 893 in 9eb63b1

	public static String toUri(IClassFile classFile) {
	if (JavaLanguageServerPlugin.getPreferencesManager() != null && !JavaLanguageServerPlugin.getPreferencesManager().isClientSupportsClassFileContent()) {
	return null;
	}
	String packageName = classFile.getParent().getElementName();
	String jarName = classFile.getParent().getParent().getElementName();
	String uriString = null;
	try {
	uriString = new URI(JDT_SCHEME, "contents", PATH_SEPARATOR + jarName + PATH_SEPARATOR + packageName + PATH_SEPARATOR + classFile.getElementName(), classFile.getHandleIdentifier(), null).toASCIIString();
	} catch (URISyntaxException e) {
	JavaLanguageServerPlugin.logException("Error generating URI for class ", e);
	}
	return uriString;
	}

FWIW, IJavaProject ==getPackageFragmentRoots()=> IPackageFragmentRoot ==getPackageFragment(..)=> IPackageFragment ==getAllClassFiles()=> IClassFile is probably the right approach to get what you need.

[oclay1st]

@rgrunber Thanks for your replay.

Are you using code form https://github.com/microsoft/vscode-java-dependency to do this ?

This is a neovim plugin, so no, I'm not using any Java code for this. I got the dependencies from another neovim plugins (maven.nvim and gradle.nvim) unrelated to eclipse.ls.

Would it be feasible to expose the JDT URI of a class using its package and name through commands in the language server or are there any plans to integrate the vscode-java-dependency code into eclipse.ls?.