|
| 1 | +/******************************************************************************* |
| 2 | + * Copyright (c) 2025 Broadcom, Inc. |
| 3 | + * All rights reserved. This program and the accompanying materials |
| 4 | + * are made available under the terms of the Eclipse Public License v1.0 |
| 5 | + * which accompanies this distribution, and is available at |
| 6 | + * https://www.eclipse.org/legal/epl-v10.html |
| 7 | + * |
| 8 | + * Contributors: |
| 9 | + * Broadcom, Inc. - initial API and implementation |
| 10 | + *******************************************************************************/ |
1 | 11 | package org.springframework.ide.vscode.boot.java.commands; |
2 | 12 |
|
| 13 | +import java.util.List; |
| 14 | +import java.util.Objects; |
| 15 | +import java.util.Optional; |
| 16 | +import java.util.function.BiConsumer; |
| 17 | +import java.util.stream.Collectors; |
| 18 | + |
| 19 | +import org.jmolecules.stereotype.tooling.HierarchicalNodeHandler; |
| 20 | +import org.jmolecules.stereotype.tooling.LabelUtils; |
| 21 | +import org.jmolecules.stereotype.tooling.ProjectTree; |
| 22 | +import org.jmolecules.stereotype.tooling.SimpleLabelProvider; |
3 | 23 | import org.springframework.ide.vscode.boot.index.SpringMetamodelIndex; |
| 24 | +import org.springframework.ide.vscode.boot.java.Annotations; |
| 25 | +import org.springframework.ide.vscode.boot.java.commands.ToolsJsonNodeHandler.Node; |
| 26 | +import org.springframework.ide.vscode.boot.java.requestmapping.RequestMappingIndexElement; |
| 27 | +import org.springframework.ide.vscode.boot.java.stereotypes.IndexBasedStereotypeFactory; |
| 28 | +import org.springframework.ide.vscode.boot.java.stereotypes.StereotypeCatalogRegistry; |
| 29 | +import org.springframework.ide.vscode.boot.java.stereotypes.StereotypeClassElement; |
| 30 | +import org.springframework.ide.vscode.boot.java.stereotypes.StereotypeMethodElement; |
| 31 | +import org.springframework.ide.vscode.boot.java.stereotypes.StereotypePackageElement; |
| 32 | +import org.springframework.ide.vscode.boot.modulith.ModulithService; |
| 33 | +import org.springframework.ide.vscode.commons.java.IJavaProject; |
4 | 34 | import org.springframework.ide.vscode.commons.languageserver.java.JavaProjectFinder; |
5 | 35 | import org.springframework.ide.vscode.commons.languageserver.util.SimpleLanguageServer; |
6 | 36 |
|
7 | 37 | public class SpringIndexCommands { |
8 | 38 |
|
9 | 39 | private static final String SPRING_STRUCTURE_CMD = "sts/spring-boot/structure"; |
10 | 40 |
|
11 | | - public SpringIndexCommands(SimpleLanguageServer server, SpringMetamodelIndex metamodelIndex, JavaProjectFinder projectFinder) { |
12 | | - server.onCommand(SPRING_STRUCTURE_CMD, params -> server.getAsync().invoke(() -> metamodelIndex.getProjects())); |
| 41 | + private final SpringMetamodelIndex springIndex; |
| 42 | + |
| 43 | + public SpringIndexCommands(SimpleLanguageServer server, SpringMetamodelIndex springIndex, JavaProjectFinder projectFinder, StereotypeCatalogRegistry stereotypeCatalogRegistry) { |
| 44 | + this.springIndex = springIndex; |
| 45 | + |
| 46 | + server.onCommand(SPRING_STRUCTURE_CMD, params -> server.getAsync().invoke(() -> { |
| 47 | + return projectFinder.all().stream().map(project -> nodeFrom(stereotypeCatalogRegistry, springIndex, project)).filter(Objects::nonNull).collect(Collectors.toList()); |
| 48 | + })); |
| 49 | + } |
| 50 | + |
| 51 | + private Node nodeFrom(StereotypeCatalogRegistry stereotypeCatalogRegistry, SpringMetamodelIndex springIndex, IJavaProject project) { |
| 52 | + var catalog = stereotypeCatalogRegistry.getCatalogOf(project); |
| 53 | + var factory = new IndexBasedStereotypeFactory(catalog, springIndex); |
| 54 | + factory.registerStereotypeDefinitions(); |
| 55 | + |
| 56 | + StereotypePackageElement mainApplicationPackage = identifyMainApplicationPackage(project, springIndex); |
| 57 | + |
| 58 | + var labelProvider = new SimpleLabelProvider<>(StereotypePackageElement::getPackageName, StereotypePackageElement::getPackageName, StereotypeClassElement::getType, |
| 59 | + (StereotypeMethodElement m, StereotypeClassElement __) -> m.getMethodName(), Object::toString) |
| 60 | + .withTypeLabel(it -> abbreviate(mainApplicationPackage, it)) |
| 61 | + .withMethodLabel((m, c) -> getMethodLabel(project, m, c)); |
| 62 | + |
| 63 | + var structureProvider = new ToolsStructureProvider(springIndex, project); |
| 64 | + |
| 65 | + // json output |
| 66 | + BiConsumer<Node, Object> consumer = (node, c) -> { |
| 67 | + node.withAttribute(HierarchicalNodeHandler.TEXT, labelProvider.getCustomLabel(c)) |
| 68 | + .withAttribute(ToolsJsonNodeHandler.ICON, "fa-named-interface"); |
| 69 | + }; |
| 70 | + |
| 71 | + var jsonHandler = new ToolsJsonNodeHandler(labelProvider, consumer); |
| 72 | + |
| 73 | + var jsonTree = new ProjectTree<>(factory, catalog, jsonHandler) |
| 74 | + .withStructureProvider(structureProvider) |
| 75 | + .withGrouper("org.jmolecules.architecture") |
| 76 | + .withGrouper("org.jmolecules.ddd", "org.jmolecules.event", "spring", "jpa", "java"); |
| 77 | + |
| 78 | + jsonTree.process(mainApplicationPackage); |
| 79 | + |
| 80 | + return jsonHandler.getRoot(); |
13 | 81 | } |
14 | 82 |
|
| 83 | + private String abbreviate(StereotypePackageElement mainApplicationPackage, StereotypeClassElement it) { |
| 84 | + if (mainApplicationPackage == null || mainApplicationPackage.getPackageName() == null || mainApplicationPackage.getPackageName().isBlank()) { |
| 85 | + return it.getType(); |
| 86 | + } |
| 87 | + else { |
| 88 | + return LabelUtils.abbreviate(it.getType(), mainApplicationPackage.getPackageName()); |
| 89 | + } |
| 90 | + } |
| 91 | + |
| 92 | + private String getMethodLabel(IJavaProject project, StereotypeMethodElement method, StereotypeClassElement clazz) { |
| 93 | + // TODO: special treatment for methods that have specific index elements with specific labels (e.g. mapping methods) |
| 94 | + |
| 95 | + Optional<RequestMappingIndexElement> mapping = springIndex.getNodesOfType(project.getElementName(), RequestMappingIndexElement.class).stream() |
| 96 | + .filter(mappingElement -> mappingElement.getMethodSignature() != null && mappingElement.getMethodSignature().equals(method.getMethodSignature())) |
| 97 | + .findAny(); |
| 98 | + |
| 99 | + if (mapping.isPresent()) { |
| 100 | + return mapping.get().getDocumentSymbol().getName(); |
| 101 | + } |
| 102 | + else { |
| 103 | + return method.getMethodLabel(); |
| 104 | + } |
| 105 | + |
| 106 | + } |
| 107 | + |
| 108 | + public StereotypePackageElement identifyMainApplicationPackage(IJavaProject project, SpringMetamodelIndex springIndex) { |
| 109 | + List<StereotypeClassElement> classNodes = springIndex.getNodesOfType(project.getElementName(), StereotypeClassElement.class); |
| 110 | + |
| 111 | + Optional<StereotypePackageElement> packageElement = classNodes.stream() |
| 112 | + .filter(node -> node.getAnnotationTypes().contains(Annotations.BOOT_APP)) |
| 113 | + .map(node -> getPackage(node.getType())) |
| 114 | + .map(packageName -> findPackageNode(packageName, project, springIndex)) |
| 115 | + .findFirst(); |
| 116 | + |
| 117 | + if (packageElement.isPresent()) { |
| 118 | + return packageElement.get(); |
| 119 | + } |
| 120 | + else { |
| 121 | + return new StereotypePackageElement("", null); |
| 122 | + } |
| 123 | + } |
| 124 | + |
| 125 | + private String getPackage(String fullyQualifiedClassName) { |
| 126 | + return ModulithService.getPackageNameFromTypeFQName(fullyQualifiedClassName); |
| 127 | + } |
| 128 | + |
| 129 | + private StereotypePackageElement findPackageNode(String packageName, IJavaProject project, SpringMetamodelIndex springIndex) { |
| 130 | + List<StereotypePackageElement> packageNodes = springIndex.getNodesOfType(project.getElementName(), StereotypePackageElement.class); |
| 131 | + |
| 132 | + Optional<StereotypePackageElement> found = packageNodes.stream() |
| 133 | + .filter(packageNode -> packageNode.getPackageName().equals(packageName)) |
| 134 | + .findAny(); |
| 135 | + |
| 136 | + if (found.isPresent()) { |
| 137 | + return found.get(); |
| 138 | + } |
| 139 | + else { |
| 140 | + return new StereotypePackageElement(packageName, null); |
| 141 | + } |
| 142 | + } |
| 143 | + |
15 | 144 | } |
0 commit comments