refactor: set display name on java server side

Author: mamilic

jdtls.ext/com.microsoft.jdtls.ext.core/src/com/microsoft/jdtls/ext/core/model/PackageNode.java

@@ -19,6 +19,7 @@
 import java.util.Map;
 import java.util.Objects;
 
+import org.apache.commons.lang3.StringUtils;
 import org.eclipse.core.resources.IFile;
 import org.eclipse.core.resources.IFolder;
 import org.eclipse.core.resources.IProject;
@@ -273,11 +274,32 @@ public static PackageRootNode createNodeForPackageFragmentRoot(IPackageFragmentR
             for (IClasspathAttribute attribute : resolvedClasspathEntry.getExtraAttributes()) {
                 node.setMetaDataValue(attribute.getName(), attribute.getValue());
             }
+
+            String computedDisplayName = computeDisplayName(node);
+            if (StringUtils.isNotBlank(computedDisplayName)) {
+                node.setDisplayName(computedDisplayName);
+            }
         }
 
         return node;
     }
 
+    private static String computeDisplayName(PackageRootNode node) {
+        if (node.getMetaData() == null || node.getMetaData().isEmpty()) {
+            return node.getName();
+        }
+
+        String version = (String) node.getMetaData().get("maven.version");
+        String groupId = (String) node.getMetaData().get("maven.groupId");
+        String artifactId = (String) node.getMetaData().get("maven.artifactId");
+
+        if (StringUtils.isBlank(version) || StringUtils.isBlank(groupId) || StringUtils.isBlank(artifactId)) {
+            return node.getName();
+        }
+
+        return groupId + ":" + artifactId + ":" + version;
+    }
+
     /**
      * Get the correspond node of classpath, it may be container or a package root.
      *

src/views/containerNode.ts

@@ -43,8 +43,8 @@ export class ContainerNode extends DataNode {
         return this._containerType;
     }
 
-    public getLabel(): string {
-        return this._nodeData.displayName ?? this._nodeData.name;
+    public isMavenType(): boolean {
+        return this._containerType == ContainerType.Maven;
     }
 
     protected async loadData(): Promise<INodeData[]> {

src/views/dataNode.ts

@@ -17,7 +17,7 @@ export abstract class DataNode extends ExplorerNode {
 
     public getTreeItem(): TreeItem | Promise<TreeItem> {
         const item = new TreeItem(
-            this.getLabel(),
+            this._nodeData.displayName || this._nodeData.name,
             this.hasChildren() ? TreeItemCollapsibleState.Collapsed : TreeItemCollapsibleState.None,
         );
         item.description = this.description;
@@ -42,6 +42,10 @@ export abstract class DataNode extends ExplorerNode {
         return item;
     }
 
+    public getDisplayName(): string {
+        return this._nodeData.displayName || this._nodeData.name;
+    }
+
     public get nodeData(): INodeData {
         return this._nodeData;
     }

src/views/dependencyDataProvider.ts

@@ -7,7 +7,7 @@ import {
     RelativePattern, TreeDataProvider, TreeItem, Uri, window, workspace,
 } from "vscode";
 import { instrumentOperationAsVsCodeCommand, sendError } from "vscode-extension-telemetry-wrapper";
-import { contextManager } from "../../extension.bundle";
+import { ContainerNode, contextManager } from "../../extension.bundle";
 import { Commands } from "../commands";
 import { Context } from "../constants";
 import { appendOutput, executeExportJarTask } from "../tasks/buildArtifact/BuildArtifactTaskProvider";
@@ -124,10 +124,12 @@ export class DependencyDataProvider implements TreeDataProvider<ExplorerNode> {
         const children = (!this._rootItems || !element) ?
             await this.getRootNodes() : await element.getChildren();
 
-        if (children) {
-            children.sort((a, b) => {
-                return a.getLabel().localeCompare(b.getLabel());
-            });
+            if (children && element instanceof ContainerNode) {
+                if (element.isMavenType()) {
+                    children.sort((a, b) => {
+                        return a.getDisplayName().localeCompare(b.getDisplayName());
+                    });
+            }
         }
 
         explorerNodeCache.saveNodes(children || []);

src/views/documentSymbolNode.ts

@@ -28,7 +28,7 @@ export class DocumentSymbolNode extends ExplorerNode {
         super(parent);
     }
 
-    public getLabel(): string {
+    public getDisplayName(): string {
         return this.symbolInfo.name;
     }
 
@@ -43,7 +43,7 @@ export class DocumentSymbolNode extends ExplorerNode {
     }
 
     public getTreeItem(): TreeItem | Promise<TreeItem> {
-        const item = new TreeItem(this.getLabel(),
+        const item = new TreeItem(this.getDisplayName(),
             this.symbolInfo?.children?.length ? TreeItemCollapsibleState.Collapsed
                 : TreeItemCollapsibleState.None);
         item.iconPath = this.iconPath;

src/views/explorerNode.ts

@@ -34,5 +34,5 @@ export abstract class ExplorerNode {
 
     public abstract computeContextValue(): string | undefined;
 
-    public abstract getLabel(): string;
+    public abstract getDisplayName(): string;
 }

src/views/fileNode.ts

@@ -13,10 +13,6 @@ export class FileNode extends DataNode {
         super(nodeData, parent);
     }
 
-    public getLabel(): string {
-        return this._nodeData.displayName ?? this._nodeData.name;
-    }
-
     protected hasChildren(): boolean {
         return false;
     }

src/views/folderNode.ts

@@ -15,10 +15,6 @@ export class FolderNode extends DataNode {
         super(nodeData, parent);
     }
 
-    public getLabel(): string {
-        return this._nodeData.displayName ?? this._nodeData.name;
-    }
-
     protected async loadData(): Promise<INodeData[]> {
         return Jdtls.getPackageData({
             kind: NodeKind.Folder,

src/views/packageNode.ts

@@ -22,10 +22,6 @@ export class PackageNode extends DataNode {
         return parentData.entryKind === PackageRootKind.K_SOURCE || parentData.kind === NodeKind.Project;
     }
 
-    public getLabel(): string {
-        return this._nodeData.displayName ?? this._nodeData.name;
-    }
-
     protected async loadData(): Promise<INodeData[]> {
         return Jdtls.getPackageData({
             kind: NodeKind.Package,

src/views/packageRootNode.ts

@@ -8,7 +8,7 @@ import { INodeData, NodeKind } from "../java/nodeData";
 import { IPackageRootNodeData, PackageRootKind } from "../java/packageRootNodeData";
 import { Settings } from "../settings";
 import { isTest } from "../utility";
-import { ContainerNode, ContainerType } from "./containerNode";
+import { ContainerNode } from "./containerNode";
 import { DataNode } from "./dataNode";
 import { ExplorerNode } from "./explorerNode";
 import { ProjectNode } from "./projectNode";
@@ -20,13 +20,6 @@ export class PackageRootNode extends DataNode {
         super(nodeData, parent);
     }
 
-    public getLabel(): string {
-        if (this._nodeData.metaData?.['maven.groupId']) {
-            return `${this._nodeData.metaData?.['maven.groupId']}:${this._nodeData.metaData?.['maven.artifactId']}:${this._nodeData.metaData?.['maven.version']}`;
-        }
-        return this._nodeData.displayName ?? this._nodeData.name;
-    }
-
     public isSourceRoot(): boolean {
         return (<IPackageRootNodeData>this.nodeData).entryKind === PackageRootKind.K_SOURCE;
     }