ConcurrentModificationException when querying /v3/api-docs/{group} concurrently for different groups. Fixes #1641.

bnasslahsen · bnasslahsen · commit 9ebd61cf23b7 · 2022-05-02T16:09:47.000+02:00
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/api/AbstractOpenApiResource.java b/springdoc-openapi-common/src/main/java/org/springdoc/api/AbstractOpenApiResource.java
@@ -136,12 +136,12 @@ public abstract class AbstractOpenApiResource extends SpecFilter {
 	/**
 	 * The constant ADDITIONAL_REST_CONTROLLERS.
 	 */
-	private static final List<Class<?>> ADDITIONAL_REST_CONTROLLERS = new ArrayList<>();
+	private static final List<Class<?>> ADDITIONAL_REST_CONTROLLERS = Collections.synchronizedList(new ArrayList<>());
 
 	/**
 	 * The constant HIDDEN_REST_CONTROLLERS.
 	 */
-	private static final List<Class<?>> HIDDEN_REST_CONTROLLERS = new ArrayList<>();
+	private static final List<Class<?>> HIDDEN_REST_CONTROLLERS = Collections.synchronizedList(new ArrayList<>());
 
 	/**
 	 * The Open api builder.
@@ -304,7 +304,7 @@ public static void addHiddenRestControllers(String... classes) {
 	 * @return the open api
 	 */
 	protected synchronized OpenAPI getOpenApi(Locale locale) {
-		OpenAPI openApi;
+		OpenAPI openAPI;
 		final Locale finalLocale = locale == null ? Locale.getDefault() : locale;
 		if (openAPIService.getCachedOpenAPI(finalLocale) == null || springDocConfigProperties.isCacheDisabled()) {
 			Instant start = Instant.now();
@@ -317,33 +317,33 @@ protected synchronized OpenAPI getOpenApi(Locale locale) {
 
 			Map<String, Object> findControllerAdvice = openAPIService.getControllerAdviceMap();
 			// calculate generic responses
-			openApi = openAPIService.getCalculatedOpenAPI();
+			openAPI = openAPIService.getCalculatedOpenAPI();
 			if (OpenApiVersion.OPENAPI_3_1 == springDocConfigProperties.getApiDocs().getVersion())
-				openApi.openapi(OpenApiVersion.OPENAPI_3_1.getVersion());
+				openAPI.openapi(OpenApiVersion.OPENAPI_3_1.getVersion());
 			if (springDocConfigProperties.isDefaultOverrideWithGenericResponse()) {
 				if (!CollectionUtils.isEmpty(mappingsMap))
 					findControllerAdvice.putAll(mappingsMap);
-				responseBuilder.buildGenericResponse(openApi.getComponents(), findControllerAdvice, finalLocale);
+				responseBuilder.buildGenericResponse(openAPI.getComponents(), findControllerAdvice, finalLocale);
 			}
-			getPaths(mappingsMap, finalLocale);
+			getPaths(mappingsMap, finalLocale, openAPI);
 
 			Optional<CloudFunctionProvider> cloudFunctionProviderOptional = springDocProviders.getSpringCloudFunctionProvider();
 			cloudFunctionProviderOptional.ifPresent(cloudFunctionProvider -> {
-						List<RouterOperation> routerOperationList = cloudFunctionProvider.getRouterOperations(openApi);
+						List<RouterOperation> routerOperationList = cloudFunctionProvider.getRouterOperations(openAPI);
 						if (!CollectionUtils.isEmpty(routerOperationList))
-							this.calculatePath(routerOperationList, locale);
+							this.calculatePath(routerOperationList, locale, openAPI);
 					}
 			);
 
-			if (!CollectionUtils.isEmpty(openApi.getServers()))
+			if (!CollectionUtils.isEmpty(openAPI.getServers()))
 				openAPIService.setServersPresent(true);
-			openAPIService.updateServers(openApi);
+			openAPIService.updateServers(openAPI);
 
 			if (springDocConfigProperties.isRemoveBrokenReferenceDefinitions())
-				this.removeBrokenReferenceDefinitions(openApi);
+				this.removeBrokenReferenceDefinitions(openAPI);
 
 			// run the optional customisers
-			List<Server> servers = openApi.getServers();
+			List<Server> servers = openAPI.getServers();
 			List<Server> serversCopy = null;
 			try {
 				serversCopy = springDocProviders.jsonMapper()
@@ -353,40 +353,43 @@ protected synchronized OpenAPI getOpenApi(Locale locale) {
 				LOGGER.warn("Json Processing Exception occurred: {}", e.getMessage());
 			}
 
-			openApiLocaleCustomizers.values().forEach(openApiLocaleCustomizer -> openApiLocaleCustomizer.customise(openApi, finalLocale));
-			openApiCustomisers.ifPresent(apiCustomisers -> apiCustomisers.forEach(openApiCustomiser -> openApiCustomiser.customise(openApi)));
-			if (!CollectionUtils.isEmpty(openApi.getServers()) && !openApi.getServers().equals(serversCopy))
+			openApiLocaleCustomizers.values().forEach(openApiLocaleCustomizer -> openApiLocaleCustomizer.customise(openAPI, finalLocale));
+			openApiCustomisers.ifPresent(apiCustomisers -> apiCustomisers.forEach(openApiCustomiser -> openApiCustomiser.customise(openAPI)));
+			if (!CollectionUtils.isEmpty(openAPI.getServers()) && !openAPI.getServers().equals(serversCopy))
 				openAPIService.setServersPresent(true);
 
-			openAPIService.setCachedOpenAPI(openApi, finalLocale);
+			openAPIService.setCachedOpenAPI(openAPI, finalLocale);
 			openAPIService.resetCalculatedOpenAPI();
 
 			LOGGER.info("Init duration for springdoc-openapi is: {} ms",
 					Duration.between(start, Instant.now()).toMillis());
 		}
 		else {
 			LOGGER.debug("Fetching openApi document from cache");
-			openApi = openAPIService.updateServers(openAPIService.getCachedOpenAPI(finalLocale));
+			openAPI = openAPIService.updateServers(openAPIService.getCachedOpenAPI(finalLocale));
 		}
-		return openApi;
+		return openAPI;
 	}
 
 	/**
 	 * Gets paths.
 	 *
 	 * @param findRestControllers the find rest controllers
 	 * @param locale the locale
+	 * @param openAPI the open api
 	 */
-	protected abstract void getPaths(Map<String, Object> findRestControllers, Locale locale);
+	protected abstract void getPaths(Map<String, Object> findRestControllers, Locale locale, OpenAPI openAPI);
 
 	/**
 	 * Calculate path.
 	 *
 	 * @param handlerMethod the handler method
 	 * @param routerOperation the router operation
 	 * @param locale the locale
+	 * @param openAPI the open api
 	 */
-	protected void calculatePath(HandlerMethod handlerMethod, RouterOperation routerOperation, Locale locale) {
+	protected void calculatePath(HandlerMethod handlerMethod,
+			RouterOperation routerOperation, Locale locale, OpenAPI openAPI) {
 		String operationPath = routerOperation.getPath();
 		Set<RequestMethod> requestMethods = new HashSet<>(Arrays.asList(routerOperation.getMethods()));
 		io.swagger.v3.oas.annotations.Operation apiOperation = routerOperation.getOperation();
@@ -395,7 +398,6 @@ protected void calculatePath(HandlerMethod handlerMethod, RouterOperation router
 		String[] headers = routerOperation.getHeaders();
 		Map<String, String> queryParams = routerOperation.getQueryParams();
 
-		OpenAPI openAPI = openAPIService.getCalculatedOpenAPI();
 		Components components = openAPI.getComponents();
 		Paths paths = openAPI.getPaths();
 
@@ -514,8 +516,9 @@ private void buildCallbacks(OpenAPI openAPI, MethodAttributes methodAttributes,
 	 *
 	 * @param routerOperationList the router operation list
 	 * @param locale the locale
+	 * @param openAPI the open api
 	 */
-	protected void calculatePath(List<RouterOperation> routerOperationList, Locale locale) {
+	protected void calculatePath(List<RouterOperation> routerOperationList, Locale locale, OpenAPI openAPI) {
 		ApplicationContext applicationContext = openAPIService.getContext();
 		if (!CollectionUtils.isEmpty(routerOperationList)) {
 			Collections.sort(routerOperationList);
@@ -545,7 +548,7 @@ protected void calculatePath(List<RouterOperation> routerOperationList, Locale l
 							LOGGER.error(e.getMessage());
 						}
 						if (handlerMethod != null && isFilterCondition(handlerMethod, routerOperation.getPath(), routerOperation.getProduces(), routerOperation.getConsumes(), routerOperation.getHeaders()))
-							calculatePath(handlerMethod, routerOperation, locale);
+							calculatePath(handlerMethod, routerOperation, locale, openAPI);
 					}
 				}
 				else if (routerOperation.getOperation() != null && StringUtils.isNotBlank(routerOperation.getOperation().operationId()) && isFilterCondition(routerOperation.getPath(), routerOperation.getProduces(), routerOperation.getConsumes(), routerOperation.getHeaders())) {
@@ -616,10 +619,11 @@ protected void calculatePath(RouterOperation routerOperation, Locale locale) {
 	 * @param produces the produces
 	 * @param headers the headers
 	 * @param locale the locale
+	 * @param openAPI the open api
 	 */
 	protected void calculatePath(HandlerMethod handlerMethod, String operationPath,
-			Set<RequestMethod> requestMethods, String[] consumes, String[] produces, String[] headers, Locale locale) {
-		this.calculatePath(handlerMethod, new RouterOperation(operationPath, requestMethods.toArray(new RequestMethod[requestMethods.size()]), consumes, produces, headers), locale);
+			Set<RequestMethod> requestMethods, String[] consumes, String[] produces, String[] headers, Locale locale, OpenAPI openAPI) {
+		this.calculatePath(handlerMethod, new RouterOperation(operationPath, requestMethods.toArray(new RequestMethod[requestMethods.size()]), consumes, produces, headers), locale, openAPI);
 	}
 
 	/**
@@ -628,13 +632,15 @@ protected void calculatePath(HandlerMethod handlerMethod, String operationPath,
 	 * @param beanName the bean name
 	 * @param routerFunctionVisitor the router function visitor
 	 * @param locale the locale
+	 * @param openAPI the open api
 	 */
-	protected void getRouterFunctionPaths(String beanName, AbstractRouterFunctionVisitor routerFunctionVisitor, Locale locale) {
+	protected void getRouterFunctionPaths(String beanName, AbstractRouterFunctionVisitor routerFunctionVisitor,
+			Locale locale, OpenAPI openAPI) {
 		boolean withRouterOperation = routerFunctionVisitor.getRouterFunctionDatas().stream()
 				.anyMatch(routerFunctionData -> routerFunctionData.getAttributes().containsKey(OPERATION_ATTRIBUTE));
 		if (withRouterOperation) {
 			List<RouterOperation> operationList = routerFunctionVisitor.getRouterFunctionDatas().stream().map(RouterOperation::new).collect(Collectors.toList());
-			calculatePath(operationList, locale);
+			calculatePath(operationList, locale, openAPI);
 		}
 		else {
 			List<org.springdoc.core.annotations.RouterOperation> routerOperationList = new ArrayList<>();
@@ -648,11 +654,11 @@ protected void getRouterFunctionPaths(String beanName, AbstractRouterFunctionVis
 			else
 				routerOperationList.addAll(Arrays.asList(routerOperations.value()));
 			if (routerOperationList.size() == 1)
-				calculatePath(routerOperationList.stream().map(routerOperation -> new RouterOperation(routerOperation, routerFunctionVisitor.getRouterFunctionDatas().get(0))).collect(Collectors.toList()), locale);
+				calculatePath(routerOperationList.stream().map(routerOperation -> new RouterOperation(routerOperation, routerFunctionVisitor.getRouterFunctionDatas().get(0))).collect(Collectors.toList()), locale, openAPI);
 			else {
 				List<RouterOperation> operationList = routerOperationList.stream().map(RouterOperation::new).collect(Collectors.toList());
 				mergeRouters(routerFunctionVisitor.getRouterFunctionDatas(), operationList);
-				calculatePath(operationList, locale);
+				calculatePath(operationList, locale, openAPI);
 			}
 		}
 	}
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/AbstractRequestService.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/AbstractRequestService.java
@@ -29,6 +29,7 @@
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collection;
+import java.util.Collections;
 import java.util.HashMap;
 import java.util.LinkedHashMap;
 import java.util.List;
@@ -98,7 +99,7 @@ public abstract class AbstractRequestService {
 	/**
 	 * The constant PARAM_TYPES_TO_IGNORE.
 	 */
-	private static final List<Class<?>> PARAM_TYPES_TO_IGNORE = new ArrayList<>();
+	private static final List<Class<?>> PARAM_TYPES_TO_IGNORE = Collections.synchronizedList(new ArrayList<>());
 
 	/**
 	 * The constant ANNOTATIONS_FOR_REQUIRED.
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/GenericParameterService.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/GenericParameterService.java
@@ -28,6 +28,7 @@
 import java.lang.reflect.WildcardType;
 import java.util.ArrayList;
 import java.util.Arrays;
+import java.util.Collections;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Locale;
@@ -74,7 +75,7 @@ public class GenericParameterService {
 	/**
 	 * The constant FILE_TYPES.
 	 */
-	private static final List<Class<?>> FILE_TYPES = new ArrayList<>();
+	private static final List<Class<?>> FILE_TYPES = Collections.synchronizedList(new ArrayList<>());
 
 	/**
 	 * The Optional delegating method parameter customizer.
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/GenericResponseService.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/GenericResponseService.java
@@ -239,7 +239,9 @@ public void buildGenericResponse(Components components, Map<String, Object> find
 					apiResponses.forEach(controllerAdviceInfoApiResponseMap::put);
 				}
 			}
-			controllerAdviceInfos.add(controllerAdviceInfo);
+			synchronized (this){
+				controllerAdviceInfos.add(controllerAdviceInfo);
+			}
 		}
 	}
 
@@ -631,7 +633,7 @@ else if (returnType instanceof ParameterizedType) {
 	 * @param beanType the bean type
 	 * @return the generic map response
 	 */
-	private Map<String, ApiResponse> getGenericMapResponse(Class<?> beanType) {
+	private synchronized Map<String, ApiResponse> getGenericMapResponse(Class<?> beanType) {
 		return controllerAdviceInfos.stream()
 				.filter(controllerAdviceInfo ->  new ControllerAdviceBean(controllerAdviceInfo.getControllerAdvice()).isApplicableToBeanType(beanType))
 				.map(ControllerAdviceInfo::getApiResponseMap)
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/SpringDocAnnotationsUtils.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/SpringDocAnnotationsUtils.java
@@ -27,6 +27,7 @@
 import java.lang.reflect.Type;
 import java.util.ArrayList;
 import java.util.Arrays;
+import java.util.Collections;
 import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
@@ -73,7 +74,7 @@ public class SpringDocAnnotationsUtils extends AnnotationsUtils {
 	/**
 	 * The constant ANNOTATIOSN_TO_IGNORE.
 	 */
-	private static final List<Class> ANNOTATIONS_TO_IGNORE = new ArrayList<>();
+	private static final List<Class> ANNOTATIONS_TO_IGNORE = Collections.synchronizedList(new ArrayList<>());
 
 	static {
 		ANNOTATIONS_TO_IGNORE.add(Hidden.class);
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/converters/ConverterUtils.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/converters/ConverterUtils.java
@@ -24,6 +24,7 @@
 
 import java.util.ArrayList;
 import java.util.Arrays;
+import java.util.Collections;
 import java.util.List;
 import java.util.concurrent.Callable;
 import java.util.concurrent.CompletionStage;
@@ -40,17 +41,17 @@ public class ConverterUtils {
 	/**
 	 * The constant RESULT_WRAPPERS_TO_IGNORE.
 	 */
-	private static final List<Class<?>> RESULT_WRAPPERS_TO_IGNORE = new ArrayList<>();
+	private static final List<Class<?>> RESULT_WRAPPERS_TO_IGNORE = Collections.synchronizedList(new ArrayList<>());
 
 	/**
 	 * The constant RESPONSE_TYPES_TO_IGNORE.
 	 */
-	private static final List<Class<?>> RESPONSE_TYPES_TO_IGNORE = new ArrayList<>();
+	private static final List<Class<?>> RESPONSE_TYPES_TO_IGNORE = Collections.synchronizedList(new ArrayList<>());
 
 	/**
 	 * The constant FLUX_WRAPPERS_TO_IGNORE.
 	 */
-	private static final List<Class<?>> FLUX_WRAPPERS_TO_IGNORE = new ArrayList<>();
+	private static final List<Class<?>> FLUX_WRAPPERS_TO_IGNORE = Collections.synchronizedList(new ArrayList<>());
 
 	static {
 		RESULT_WRAPPERS_TO_IGNORE.add(Callable.class);
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/converters/SchemaPropertyDeprecatingConverter.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/converters/SchemaPropertyDeprecatingConverter.java
@@ -25,6 +25,7 @@
 import java.lang.annotation.Annotation;
 import java.lang.reflect.Method;
 import java.util.ArrayList;
+import java.util.Collections;
 import java.util.Iterator;
 import java.util.List;
 import java.util.stream.Stream;
@@ -45,7 +46,7 @@ public class SchemaPropertyDeprecatingConverter implements ModelConverter {
 	/**
 	 * The constant DEPRECATED_ANNOTATIONS.
 	 */
-	private static final List<Class<? extends Annotation>> DEPRECATED_ANNOTATIONS = new ArrayList<>();
+	private static final List<Class<? extends Annotation>> DEPRECATED_ANNOTATIONS = Collections.synchronizedList(new ArrayList<>());
 
 	static {
 		DEPRECATED_ANNOTATIONS.add(Deprecated.class);
diff --git a/springdoc-openapi-common/src/test/java/org/springdoc/api/AbstractOpenApiResourceTest.java b/springdoc-openapi-common/src/test/java/org/springdoc/api/AbstractOpenApiResourceTest.java
@@ -1,19 +1,21 @@
 /*
  *
  *  *
- *  *  * Copyright 2019-2021 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
+ *  *  *  * Copyright 2019-2022 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.
  *  *  *
- *  *  *	  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.
  *  *
  *
  */
@@ -293,7 +295,7 @@ private static class EmptyPathsOpenApiResource extends AbstractOpenApiResource {
 		}
 
 		@Override
-		public void getPaths(Map<String, Object> findRestControllers, Locale locale) {
+		public void getPaths(Map<String, Object> findRestControllers, Locale locale, OpenAPI openAPI) {
 		}
 	}
 }
diff --git a/springdoc-openapi-webflux-core/src/main/java/org/springdoc/webflux/api/OpenApiResource.java b/springdoc-openapi-webflux-core/src/main/java/org/springdoc/webflux/api/OpenApiResource.java
diff --git a/springdoc-openapi-webmvc-core/src/main/java/org/springdoc/webmvc/api/OpenApiResource.java b/springdoc-openapi-webmvc-core/src/main/java/org/springdoc/webmvc/api/OpenApiResource.java

Original file line number	Diff line number	Diff line change
`@@ -239,7 +239,9 @@ public void buildGenericResponse(Components components, Map<String, Object> find`
`239`	`239`	`apiResponses.forEach(controllerAdviceInfoApiResponseMap::put);`
`240`	`240`	`}`
`241`	`241`	`}`
`242`		`- controllerAdviceInfos.add(controllerAdviceInfo);`
	`242`	`+ synchronized (this){`
	`243`	`+ controllerAdviceInfos.add(controllerAdviceInfo);`
	`244`	`+ }`
`243`	`245`	`}`
`244`	`246`	`}`
`245`	`247`
`@@ -631,7 +633,7 @@ else if (returnType instanceof ParameterizedType) {`
`631`	`633`	`* @param beanType the bean type`
`632`	`634`	`* @return the generic map response`
`633`	`635`	`*/`
`634`		`- private Map<String, ApiResponse> getGenericMapResponse(Class<?> beanType) {`
	`636`	`+ private synchronized Map<String, ApiResponse> getGenericMapResponse(Class<?> beanType) {`
`635`	`637`	`return controllerAdviceInfos.stream()`
`636`	`638`	`.filter(controllerAdviceInfo -> new ControllerAdviceBean(controllerAdviceInfo.getControllerAdvice()).isApplicableToBeanType(beanType))`
`637`	`639`	`.map(ControllerAdviceInfo::getApiResponseMap)`