GH-230 Cache processed types in properties to avoid infinite recursion when going through createEmbeddedTypeDescription (Fix #230)

dzikoysk · dzikoysk · commit 7e1ec6d0ddcd · 2024-09-04T22:33:28.000+02:00
diff --git a/examples/javalin-gradle-kotlin/src/main/java/io/javalin/openapi/plugin/test/JavalinTest.java b/examples/javalin-gradle-kotlin/src/main/java/io/javalin/openapi/plugin/test/JavalinTest.java
@@ -396,9 +396,9 @@ public static String getStatic() {
         }
 
         // by default nullable fields are not required, but we can force it
-        @OpenApiRequired
-        public String getNullableIsRequired() {
-            return "required";
+        //@OpenApiRequired
+        public JsonSchemaEntity getNullableIsRequired() {
+            return null;
         }
 
     }
diff --git a/openapi-specification/src/main/kotlin/io/javalin/openapi/experimental/processor/generators/TypeSchemaGenerator.kt b/openapi-specification/src/main/kotlin/io/javalin/openapi/experimental/processor/generators/TypeSchemaGenerator.kt
@@ -51,6 +51,10 @@ data class ResultScheme(
 
 class TypeSchemaGenerator(val context: AnnotationProcessorContext) {
 
+    // The cache helps to avoid processing the same property multiple times & prevent infinite recursion
+    // ~ https://github.com/javalin/javalin-openapi/issues/230
+    private val processedProperties = mutableMapOf<Property, ResultScheme>()
+
     fun createTypeSchema(
         type: ClassDefinition,
         inlineRefs: Boolean = false,
@@ -102,15 +106,23 @@ class TypeSchemaGenerator(val context: AnnotationProcessorContext) {
                 val properties = type.findAllProperties(requireNonNulls)
 
                 properties.forEach { property ->
-                    val (propertySchema, refs) = createEmbeddedTypeDescription(
-                        type = property.type,
-                        inlineRefs = inlineRefs,
-                        requiresNonNulls = requireNonNulls,
-                        composition = property.composition,
-                        extra = property.extra
-                    )
-                    propertiesObject.add(property.name, propertySchema)
-                    references.addAll(refs)
+                    val result =
+                        when {
+                            processedProperties.contains(property) ->
+                                processedProperties[property]!!
+                            else ->
+                                createEmbeddedTypeDescription(
+                                    type = property.type,
+                                    inlineRefs = inlineRefs,
+                                    requiresNonNulls = requireNonNulls,
+                                    composition = property.composition,
+                                    extra = property.extra
+                                ).also {
+                                    processedProperties[property] = it
+                                }
+                        }
+                    propertiesObject.add(property.name, result.json)
+                    references.addAll(result.references)
                 }
 
                 if (properties.any { it.required }) {

Original file line number	Diff line number	Diff line change
`@@ -396,9 +396,9 @@ public static String getStatic() {`
`396`	`396`	`}`
`397`	`397`
`398`	`398`	`// by default nullable fields are not required, but we can force it`
`399`		`- @OpenApiRequired`
`400`		`- public String getNullableIsRequired() {`
`401`		`- return "required";`
	`399`	`+ //@OpenApiRequired`
	`400`	`+ public JsonSchemaEntity getNullableIsRequired() {`
	`401`	`+ return null;`
`402`	`402`	`}`
`403`	`403`
`404`	`404`	`}`