Map Fields Disappear with Groovy on Classpath. Fixes #2046

Author: bnasslahsen

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/configuration/SpringDocGroovyConfiguration.java

@@ -26,7 +26,7 @@
 
 
 import groovy.lang.MetaClass;
-import org.springdoc.core.converters.RequestTypeToIgnoreConverter;
+import org.springdoc.core.converters.JavaTypeToIgnoreConverter;
 import org.springdoc.core.providers.ObjectMapperProvider;
 import org.springdoc.core.utils.SpringDocUtils;
 
@@ -58,7 +58,7 @@ public class SpringDocGroovyConfiguration {
 	@Bean
 	@Lazy(false)
 	Object ignoreGroovyMetaClass() {
-		SpringDocUtils.getConfig().addRequestWrapperToIgnore(MetaClass.class);
+		SpringDocUtils.getConfig().addJavaTypeToIgnore(MetaClass.class);
 		return null;
 	}
 
@@ -70,7 +70,7 @@ Object ignoreGroovyMetaClass() {
 	 */
 	@Bean
 	@Lazy(false)
-	RequestTypeToIgnoreConverter requestTypeToIgnoreConverter(ObjectMapperProvider springDocObjectMapper) {
-		return new RequestTypeToIgnoreConverter(springDocObjectMapper);
+	JavaTypeToIgnoreConverter requestTypeToIgnoreConverter(ObjectMapperProvider springDocObjectMapper) {
+		return new JavaTypeToIgnoreConverter(springDocObjectMapper);
 	}
 }

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/converters/ConverterUtils.java

@@ -36,6 +36,7 @@
 
 /**
  * The type Converter utils.
+ *
  * @author bnasslahsen
  */
 public class ConverterUtils {
@@ -55,6 +56,11 @@ public class ConverterUtils {
 	 */
 	private static final List<Class<?>> FLUX_WRAPPERS_TO_IGNORE = Collections.synchronizedList(new ArrayList<>());
 
+	/**
+	 * The constant JAVA_TYPE_TO_IGNORE.
+	 */
+	private static final List<Class<?>> JAVA_TYPE_TO_IGNORE = Collections.synchronizedList(new ArrayList<>());
+
 	static {
 		RESULT_WRAPPERS_TO_IGNORE.add(Callable.class);
 		RESULT_WRAPPERS_TO_IGNORE.add(ResponseEntity.class);
@@ -157,4 +163,35 @@ public static void removeFluxWrapperToIgnore(Class<?> classes) {
 	public static void addFluxWrapperToIgnore(Class<?> cls) {
 		FLUX_WRAPPERS_TO_IGNORE.add(cls);
 	}
+
+	/**
+	 * Add java type to ignore.
+	 *
+	 * @param cls the cls
+	 */
+	public static void addJavaTypeToIgnore(Class<?> cls) {
+		JAVA_TYPE_TO_IGNORE.add(cls);
+	}
+
+	/**
+	 * Remove java type to ignore.
+	 *
+	 * @param classes the classes
+	 */
+	public static void removeJavaTypeToIgnore(Class<?> classes) {
+		List classesToIgnore = Arrays.asList(classes);
+		if (JAVA_TYPE_TO_IGNORE.containsAll(classesToIgnore))
+			JAVA_TYPE_TO_IGNORE.removeAll(Arrays.asList(classes));
+	}
+
+	/**
+	 * Is java type to ignore boolean.
+	 *
+	 * @param rawClass the raw class
+	 * @return the boolean
+	 */
+	public static boolean isJavaTypeToIgnore(Class<?> rawClass) {
+		return JAVA_TYPE_TO_IGNORE.stream().anyMatch(clazz -> clazz.isAssignableFrom(rawClass));
+	}
+
 }

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/converters/RequestTypeToIgnoreConverter.java renamed to springdoc-openapi-starter-common/src/main/java/org/springdoc/core/converters/JavaTypeToIgnoreConverter.java

@@ -32,13 +32,12 @@
 import io.swagger.v3.core.converter.ModelConverterContext;
 import io.swagger.v3.oas.models.media.Schema;
 import org.springdoc.core.providers.ObjectMapperProvider;
-import org.springdoc.core.service.AbstractRequestService;
 
 /**
  * The type Request type to ignore converter.
  * @author bnasslahsen
  */
-public class RequestTypeToIgnoreConverter implements ModelConverter {
+public class JavaTypeToIgnoreConverter implements ModelConverter {
 
 	/**
 	 * The Spring doc object mapper.
@@ -50,7 +49,7 @@ public class RequestTypeToIgnoreConverter implements ModelConverter {
 	 *
 	 * @param springDocObjectMapper the spring doc object mapper
 	 */
-	public RequestTypeToIgnoreConverter(ObjectMapperProvider springDocObjectMapper) {
+	public JavaTypeToIgnoreConverter(ObjectMapperProvider springDocObjectMapper) {
 		this.springDocObjectMapper = springDocObjectMapper;
 	}
 
@@ -59,7 +58,7 @@ public Schema resolve(AnnotatedType type, ModelConverterContext context, Iterato
 		if (type.isSchemaProperty()) {
 			JavaType javaType = springDocObjectMapper.jsonMapper().constructType(type.getType());
 			Class<?> cls = javaType.getRawClass();
-			if (AbstractRequestService.isRequestTypeToIgnore(cls))
+			if (ConverterUtils.isJavaTypeToIgnore(cls))
 				return null;
 		}
 		return (chain.hasNext()) ? chain.next().resolve(type, context, chain) : null;

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/utils/SpringDocUtils.java

@@ -39,6 +39,7 @@
 
 /**
  * The type Spring doc utils.
+ *
  * @author bnasslahsen
  */
 public class SpringDocUtils {
@@ -334,22 +335,44 @@ public SpringDocUtils setModelAndViewClass(Class<?> clazz) {
 	/**
 	 * Remove from schema map spring doc utils.
 	 *
-	 * @param clazzs the clazzs
+	 * @param clazz the clazz
 	 * @return the spring doc utils
 	 */
-	public SpringDocUtils removeFromSchemaMap(Class<?> clazzs) {
-		AdditionalModelsConverter.removeFromSchemaMap(clazzs);
+	public SpringDocUtils removeFromSchemaMap(Class<?> clazz) {
+		AdditionalModelsConverter.removeFromSchemaMap(clazz);
 		return this;
 	}
 
 	/**
 	 * Remove from schema class spring doc utils.
 	 *
-	 * @param clazzs the clazzs
+	 * @param clazz the clazz
+	 * @return the spring doc utils
+	 */
+	public SpringDocUtils removeFromSchemaClass(Class<?> clazz) {
+		AdditionalModelsConverter.removeFromClassMap(clazz);
+		return this;
+	}
+
+	/**
+	 * Add java type to ignore spring doc utils.
+	 *
+	 * @param clazz the clazz
+	 * @return the spring doc utils
+	 */
+	public SpringDocUtils addJavaTypeToIgnore(Class<?> clazz) {
+		ConverterUtils.addJavaTypeToIgnore(clazz);
+		return this;
+	}
+
+	/**
+	 * Remove java type to ignore spring doc utils.
+	 *
+	 * @param clazz the clazz
 	 * @return the spring doc utils
 	 */
-	public SpringDocUtils removeFromSchemaClass(Class<?> clazzs) {
-		AdditionalModelsConverter.removeFromClassMap(clazzs);
+	public SpringDocUtils removeJavaTypeToIgnore(Class<?> clazz) {
+		ConverterUtils.removeJavaTypeToIgnore(clazz);
 		return this;
 	}
 }

springdoc-openapi-tests/springdoc-openapi-groovy-tests/src/test/groovy/test/org/springdoc/api/app11/SpringDocApp11Test.java

@@ -0,0 +1,35 @@
+/*
+ *
+ *  *
+ *  *  *
+ *  *  *  * Copyright 2019-2020 the original author or authors.
+ *  *  *  *
+ *  *  *  * Licensed 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.
+ *  *  *
+ *  *
+ *
+ *
+ */
+
+package test.org.springdoc.api.app11;
+
+import test.org.springdoc.api.AbstractSpringDocTest;
+
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+public class SpringDocApp11Test extends AbstractSpringDocTest {
+
+	@SpringBootApplication
+	static class SpringDocTestApp {}
+
+}

springdoc-openapi-tests/springdoc-openapi-groovy-tests/src/test/groovy/test/org/springdoc/api/app11/TestController.java

@@ -0,0 +1,25 @@
+package test.org.springdoc.api.app11;
+
+/**
+ * @author bnasslahsen
+ */
+
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
+
+import org.springframework.http.HttpStatus;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.ResponseStatus;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+@RequestMapping("/test")
+public class TestController {
+	@PostMapping
+	@ApiResponse(responseCode = "200", description = "Random endpoint.")
+	@ResponseStatus(HttpStatus.OK)
+	public void testingMethod(@RequestBody TestRequest testRequest) {
+		System.out.println("Method was run!");
+	}
+}

springdoc-openapi-tests/springdoc-openapi-groovy-tests/src/test/groovy/test/org/springdoc/api/app11/TestRequest.java

@@ -0,0 +1,22 @@
+package test.org.springdoc.api.app11;
+
+/**
+ * @author bnasslahsen
+ */
+
+import java.util.Map;
+
+import io.swagger.v3.oas.annotations.media.Schema;
+
+public class TestRequest {
+	@Schema(description = "Joe was here with a tuna melt!")
+	private String joeWasHere;
+
+	@Schema(description = "This is an example of a map that does not work.!")
+	private Map<String, String> testingTheMap;
+
+	public String getJoeWasHere() { return joeWasHere; }
+	public void setJoeWasHere(String joeWasHere) { this.joeWasHere = joeWasHere; }
+	public Map<String, String> getTestingTheMap() { return testingTheMap; }
+	public void setTestingTheMap(Map<String, String> testingTheMap) { this.testingTheMap = testingTheMap; }
+}

springdoc-openapi-tests/springdoc-openapi-groovy-tests/src/test/resources/results/app11.json

@@ -0,0 +1,59 @@
+{
+  "openapi": "3.0.1",
+  "info": {
+    "title": "OpenAPI definition",
+    "version": "v0"
+  },
+  "servers": [
+    {
+      "url": "http://localhost",
+      "description": "Generated server url"
+    }
+  ],
+  "paths": {
+    "/test": {
+      "post": {
+        "tags": [
+          "test-controller"
+        ],
+        "operationId": "testingMethod",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/TestRequest"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "Random endpoint."
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "TestRequest": {
+        "type": "object",
+        "properties": {
+          "joeWasHere": {
+            "type": "string",
+            "description": "Joe was here with a tuna melt!"
+          },
+          "testingTheMap": {
+            "type": "object",
+            "additionalProperties": {
+              "type": "string",
+              "description": "This is an example of a map that does not work.!"
+            },
+            "description": "This is an example of a map that does not work.!"
+          }
+        }
+      }
+    }
+  }
+}