GH-1630: fallback to standard Spring stereotype definitions for projects that do not use jmolecules or Spring Modulith

Author: martinlippert

headless-services/spring-boot-language-server/pom.xml

@@ -170,6 +170,12 @@
 			<version>0.29.0-STEREOTYPE-SNAPSHOT</version>
 		</dependency>
 
+		<dependency>
+			<groupId>org.jmolecules.integrations</groupId>
+			<artifactId>jmolecules-spring</artifactId>
+			<version>0.29.0-STEREOTYPE-SNAPSHOT</version>
+		</dependency>
+
 
 		<dependency>
 			<groupId>org.eclipse.lemminx</groupId>

headless-services/spring-boot-language-server/src/main/java/org/springframework/ide/vscode/boot/java/commands/SpringIndexCommands.java

@@ -55,7 +55,10 @@ public SpringIndexCommands(SimpleLanguageServer server, SpringMetamodelIndex spr
 					&& params.getArguments().get(0) instanceof JsonPrimitive
 					? ((JsonPrimitive) params.getArguments().get(0)).getAsBoolean() : false;
 
-			return projectFinder.all().stream().map(project -> nodeFrom(stereotypeCatalogRegistry, springIndex, project, updateMetadata)).filter(Objects::nonNull).collect(Collectors.toList());
+			return projectFinder.all().stream()
+					.map(project -> nodeFrom(stereotypeCatalogRegistry, springIndex, project, updateMetadata))
+					.filter(Objects::nonNull)
+					.collect(Collectors.toList());
 		}));
 	}
 

headless-services/spring-boot-language-server/src/main/java/org/springframework/ide/vscode/boot/java/stereotypes/ProjectBasedCatalogSource.java

@@ -21,13 +21,17 @@
 import java.util.zip.ZipEntry;
 
 import org.jmolecules.stereotype.catalog.support.CatalogSource;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 import org.springframework.ide.vscode.commons.java.IClasspath;
 import org.springframework.ide.vscode.commons.java.IJavaProject;
 import org.springframework.ide.vscode.commons.protocol.java.Classpath;
 import org.springframework.ide.vscode.commons.protocol.java.Classpath.CPE;
 
 public class ProjectBasedCatalogSource implements CatalogSource {
 
+	private static final Logger log = LoggerFactory.getLogger(ProjectBasedCatalogSource.class);
+
 	private final IJavaProject project;
 
 	public ProjectBasedCatalogSource(IJavaProject project) {
@@ -75,9 +79,24 @@ public Stream<URL> getSources() {
 					}
 				}
 			}
+
+			if (result.size() == 0) {
+				URL defaultSpringStereotypes = this.getClass().getResource("/stereotype-defaults/jmolecules-stereotypes.json");
+
+				if (defaultSpringStereotypes != null) {
+					log.info("using default stereotypes for project: " + this.project.getElementName());
+					result.add(defaultSpringStereotypes);
+				}
+				else {
+					log.error("error looking up default stereotypes for project: " + this.project.getElementName());
+				}
+			}
+
 		} catch (Exception e) {
+			log.error("error looking up stereotype metadata for project: " + this.project.getElementName(), e);
 		}
 
+		
 		return result.stream();
 	}
 

headless-services/spring-boot-language-server/src/main/resources/stereotype-defaults/jmolecules-stereotypes.json

@@ -0,0 +1,71 @@
+{
+	"stereotypes" : [
+		{
+			"id" : "org.springframework.boot.jackson.JsonMixin",
+			"assignments" : [ "@org.springframework.boot.jackson.JsonMixin" ],
+			"displayName" : "JSON Mixin",
+			"groups" : [ "spring.web.rest" ]
+		},
+		{
+			"id" : "org.springframework.context.annotation.Configuration",
+			"assignments" : [ "@org.springframework.context.annotation.Configuration" ],
+			"groups" : [ "spring" ]
+		},
+		{
+			"id" : "org.springframework.context.event.EventListener",
+			"assignments" : [ "@org.springframework.context.event.EventListener" ],
+			"groups" : [ "spring" ]
+		},
+		{
+			"id" : "org.springframework.data.rest.core.config.Projection",
+			"assignments" : [ "@org.springframework.data.rest.core.config.Projection" ],
+			"groups" : [ "spring.data" ]
+		},
+		{
+			"id" : "org.springframework.hateoas.server.RepresentationModelProcessor",
+			"assignments" : [ "org.springframework.hateoas.server.RepresentationModelProcessor" ],
+			"groups" : [ "spring.web.rest.hypermedia" ]
+		},
+		{
+			"id" : "org.springframework.stereotype.Controller",
+			"assignments" : [
+				"@org.springframework.stereotype.Controller",
+				"@org.springframework.data.rest.webmvc.BasePathAwareController"
+			],
+			"groups" : [ "spring.web" ]
+		},
+		{
+			"id" : "org.springframework.stereotype.Service",
+			"assignments" : [ "@org.springframework.stereotype.Service" ],
+			"groups" : [ "spring", "org.jmolecules.ddd" ]
+		},
+		{
+			"id" : "org.springframework.web.bind.annotation.RequestMapping",
+			"assignments" : [ "@org.springframework.web.bind.annotation.RequestMapping" ],
+			"displayName" : "Request mappings",
+			"groups" : [ "spring.web" ]
+		}
+	],
+	"groups" : [
+		{
+			"ids" : [ "spring"],
+			"displayName" : "Spring"
+		},
+		{
+			"ids" : [ "spring.data" ],
+			"displayName" : "Spring Data"
+		},
+		{
+			"ids" : [ "spring.web" ],
+			"displayName" : "Web"
+		},
+		{
+			"ids" : [ "spring.web.rest" ],
+			"displayName" : "REST"
+		},
+		{
+			"ids" : [ "spring.web.rest.hypermedia" ],
+			"displayName" : "Hypermedia"
+		}
+	]
+}

headless-services/spring-boot-language-server/src/test/java/org/springframework/ide/vscode/boot/java/stereotypes/ProjectBasedCatalogSourceTest.java

@@ -52,39 +52,47 @@ public class ProjectBasedCatalogSourceTest {
 	@Autowired private SpringSymbolIndex indexer;
 	@Autowired private SpringMetamodelIndex springIndex;
 
-	private File directory;
-	private IJavaProject project;
+	private File regularProjectDirectory;
+	private File fallbackProjectDirectory;
+
+	private IJavaProject regularProject;
+	private IJavaProject fallbackProject;
 
 	@BeforeEach
 	public void setup() throws Exception {
 		harness.intialize(null);
 
-		directory = new File(ProjectsHarness.class.getResource("/test-projects/test-stereotypes-support/").toURI());
-		String projectDir = directory.toURI().toString();
+		regularProjectDirectory = new File(ProjectsHarness.class.getResource("/test-projects/test-stereotypes-support/").toURI());
+		String regularProjectDir = regularProjectDirectory.toURI().toString();
+
+		regularProject = projectFinder.find(new TextDocumentIdentifier(regularProjectDir)).get();
+
+		fallbackProjectDirectory = new File(ProjectsHarness.class.getResource("/test-projects/test-stereotypes-support-fallback/").toURI());
+		String fallbackProjectDir = fallbackProjectDirectory.toURI().toString();
 
-		project = projectFinder.find(new TextDocumentIdentifier(projectDir)).get();
+		fallbackProject = projectFinder.find(new TextDocumentIdentifier(fallbackProjectDir)).get();
 
 		CompletableFuture<Void> initProject = indexer.waitOperation();
 		initProject.get(5, TimeUnit.SECONDS);
 	}
 
     @Test
     void testCatalogLookupFromSource() throws Exception {
-    	var source = new ProjectBasedCatalogSource(project);
+    	var source = new ProjectBasedCatalogSource(regularProject);
 
 		Stream<URL> sources = source.getSources();
 		List<URL> list = sources.toList();
 
-		URL url1 = new File(directory, "src/main/resources/META-INF/jmolecules-stereotypes.json").toURI().toURL();
-		URL url2 = new File(directory, "src/main/resources/META-INF/jmolecules-stereotype-groups.json").toURI().toURL();
+		URL url1 = new File(regularProjectDirectory, "src/main/resources/META-INF/jmolecules-stereotypes.json").toURI().toURL();
+		URL url2 = new File(regularProjectDirectory, "src/main/resources/META-INF/jmolecules-stereotype-groups.json").toURI().toURL();
 
 		assertTrue(list.contains(url1));
 		assertTrue(list.contains(url2));
     }
 
     @Test
     void testCatalogLookupFromLibraries() throws Exception {
-    	var source = new ProjectBasedCatalogSource(project);
+    	var source = new ProjectBasedCatalogSource(regularProject);
 		var catalog = new JsonPathStereotypeCatalog(source);
 
 		StereotypeGroups groups = catalog.getGroups("org.jmolecules.ddd");
@@ -93,4 +101,15 @@ void testCatalogLookupFromLibraries() throws Exception {
 		assertEquals("Domain-Driven Design", primary.getDisplayName());
     }
 
+    @Test
+    void testCatalogDefaultLookupFromLanguageServer() throws Exception {
+    	var source = new ProjectBasedCatalogSource(fallbackProject);
+		
+		Stream<URL> sources = source.getSources();
+		List<URL> list = sources.toList();
+		
+		assertEquals(1, list.size());
+		assertTrue(list.get(0).toString().endsWith("jmolecules-stereotypes.json"));
+    }
+    
 }

headless-services/spring-boot-language-server/src/test/resources/test-projects/test-stereotypes-support-fallback/.mvn/wrapper/maven-wrapper.properties

@@ -0,0 +1,19 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+wrapperVersion=3.3.2
+distributionType=only-script
+distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.9/apache-maven-3.9.9-bin.zip