refactor: Extract util for finding all classes used in openapi.json (#1172)

Removes the Aot processor that finds endpoint classes as they are also detected from openapi.json

Author: Artur-

packages/java/endpoint/src/main/java/dev/hilla/OpenAPIUtil.java

@@ -0,0 +1,58 @@
+package dev.hilla;
+
+import java.io.IOException;
+import java.util.Collections;
+import java.util.HashSet;
+import java.util.Set;
+
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.node.ArrayNode;
+import com.fasterxml.jackson.databind.node.ObjectNode;
+
+/**
+ * Utilities for interacting with the generated openapi.json.
+ */
+public class OpenAPIUtil {
+
+    /**
+     * Parses the given open api and finds all used classes (endpoints,
+     * parameter and return types).
+     *
+     * @param openApiAsText
+     *            the open api JSON as text
+     * @return a set of classes used
+     * @throws IOException
+     *             if parsing fails
+     */
+    public static Set<String> findOpenApiClasses(String openApiAsText)
+            throws IOException {
+        JsonNode openApi = new ObjectMapper().readTree(openApiAsText);
+        if (!openApi.has("components")) {
+            return Collections.emptySet();
+        }
+
+        Set<String> types = new HashSet<>();
+
+        // Endpoints
+        ArrayNode tags = (ArrayNode) openApi.get("tags");
+
+        if (tags != null) {
+            tags.forEach(nameAndClass -> {
+                types.add(nameAndClass.get("x-class-name").asText());
+            });
+        }
+
+        // Parameters and return types
+        ObjectNode schemas = (ObjectNode) openApi.get("components")
+                .get("schemas");
+        if (schemas != null) {
+            schemas.fieldNames().forEachRemaining(type -> {
+                types.add(type);
+            });
+        }
+
+        return types;
+
+    }
+}

packages/java/endpoint/src/main/java/dev/hilla/springnative/HillaHintsRegistrar.java

@@ -22,7 +22,8 @@
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.node.ObjectNode;
-
+import dev.hilla.EndpointCodeGenerator;
+import dev.hilla.OpenAPIUtil;
 import dev.hilla.engine.EngineConfiguration;
 import dev.hilla.push.PushEndpoint;
 import dev.hilla.push.messages.fromclient.AbstractServerMessage;
@@ -65,7 +66,7 @@ private void registerEndpointTypes(RuntimeHints hints) {
                     new InputStreamReader(resource.openStream()));
             String openApiAsText = reader.lines()
                     .collect(Collectors.joining("\n"));
-            Set<String> types = parseOpenApi(openApiAsText);
+            Set<String> types = OpenAPIUtil.findOpenApiClasses(openApiAsText);
             for (String type : types) {
                 hints.reflection().registerType(TypeReference.of(type),
                         MemberCategory.values());
@@ -77,36 +78,6 @@ private void registerEndpointTypes(RuntimeHints hints) {
         hints.resources().registerPattern(EngineConfiguration.OPEN_API_PATH);
     }
 
-    /**
-     * Parses the given open api and finds the used custom types.
-     *
-     * @param openApiAsText
-     *            the open api JSON as text
-     * @return a set of custom types used
-     * @throws IOException
-     *             if parsing fails
-     */
-    public static Set<String> parseOpenApi(String openApiAsText)
-            throws IOException {
-        JsonNode openApi = new ObjectMapper().readTree(openApiAsText);
-        if (!openApi.has("components")) {
-            return Collections.emptySet();
-        }
-        ObjectNode schemas = (ObjectNode) openApi.get("components")
-                .get("schemas");
-
-        Set<String> types = new HashSet<>();
-        if (schemas != null) {
-
-            schemas.fieldNames().forEachRemaining(type -> {
-                types.add(type);
-            });
-        }
-
-        return types;
-
-    }
-
     private Collection<Class<?>> getMessageTypes(Class<?> cls) {
         List<Class<?>> classes = new ArrayList<>();
         classes.add(cls);

packages/java/endpoint/src/main/resources/META-INF/spring/aot.factories

@@ -1,2 +1 @@
-org.springframework.beans.factory.aot.BeanFactoryInitializationAotProcessor=dev.hilla.EndpointInitializationAotProcessor
 org.springframework.aot.hint.RuntimeHintsRegistrar=dev.hilla.springnative.HillaHintsRegistrar

packages/java/endpoint/src/test/java/dev/hilla/springnative/HillaHintsRegistrarTest.java packages/java/endpoint/src/test/java/dev/hilla/OpenAPIUtilTest.java

@@ -1,4 +1,4 @@
-package dev.hilla.springnative;
+package dev.hilla;
 
 import java.io.IOException;
 import java.nio.charset.StandardCharsets;
@@ -9,7 +9,7 @@
 import org.junit.Assert;
 import org.junit.Test;
 
-public class HillaHintsRegistrarTest {
+public class OpenAPIUtilTest {
 
     @Test
     public void emptySchemaReturnsNoComponents() throws IOException {
@@ -19,14 +19,16 @@ public void emptySchemaReturnsNoComponents() throws IOException {
 
     @Test
     public void singleType() throws IOException {
-        Assert.assertEquals(Set
-                .of("com.example.application.endpoints.helloreact.MyOtherType"),
+        Assert.assertEquals(Set.of(
+                "com.example.application.endpoints.helloreact.HelloReactEndpoint",
+                "com.example.application.endpoints.helloreact.MyOtherType"),
                 parse("openapi-customtype.json"));
     }
 
     @Test
     public void referringTypes() throws IOException {
         Assert.assertEquals(Set.of(
+                "com.example.application.endpoints.helloreact.HelloReactEndpoint",
                 "com.example.application.endpoints.helloreact.MyType",
                 "com.example.application.endpoints.helloreact.MyOtherType"),
                 parse("openapi-referring-customtypes.json"));
@@ -35,6 +37,7 @@ public void referringTypes() throws IOException {
     @Test
     public void nestedType() throws IOException {
         Assert.assertEquals(Set.of(
+                "com.example.application.endpoints.helloreact.HelloReactEndpoint",
                 "com.example.application.endpoints.helloreact.HelloReactEndpoint$MyInnerType"),
                 parse("openapi-innertype.json"));
     }
@@ -43,7 +46,7 @@ private Set<String> parse(String openapiFilename) throws IOException {
         String openApi = IOUtils.toString(
                 getClass().getResourceAsStream(openapiFilename),
                 StandardCharsets.UTF_8);
-        return HillaHintsRegistrar.parseOpenApi(openApi);
+        return OpenAPIUtil.findOpenApiClasses(openApi);
     }
 
 }

packages/java/endpoint/src/test/resources/dev/hilla/springnative/openapi-customtype.json packages/java/endpoint/src/test/resources/dev/hilla/openapi-customtype.json

@@ -10,6 +10,7 @@
 import java.util.stream.Collectors;
 
 import com.fasterxml.jackson.annotation.JsonAutoDetect;
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.PropertyAccessor;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
@@ -135,7 +136,8 @@ public void store(File file) throws IOException {
         MAPPER.writeValue(file, this);
     }
 
-    Path getOpenAPIFile() {
+    @JsonIgnore
+    public Path getOpenAPIFile() {
         return classesDir.resolve(OPEN_API_PATH);
     }