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

Author: bnasslahsen

springdoc-openapi-common/src/main/java/org/springdoc/api/AbstractOpenApiResource.java

@@ -308,16 +308,14 @@ protected synchronized OpenAPI getOpenApi(Locale locale) {
 		final Locale finalLocale = locale == null ? Locale.getDefault() : locale;
 		if (openAPIService.getCachedOpenAPI(finalLocale) == null || springDocConfigProperties.isCacheDisabled()) {
 			Instant start = Instant.now();
-			openAPIService.build(finalLocale);
+			openAPI = openAPIService.build(finalLocale);
 			Map<String, Object> mappingsMap = openAPIService.getMappingsMap().entrySet().stream()
 					.filter(controller -> (AnnotationUtils.findAnnotation(controller.getValue().getClass(),
 							Hidden.class) == null))
 					.filter(controller -> !AbstractOpenApiResource.isHiddenRestControllers(controller.getValue().getClass()))
 					.collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue, (a1, a2) -> a1));
 
 			Map<String, Object> findControllerAdvice = openAPIService.getControllerAdviceMap();
-			// calculate generic responses
-			openAPI = openAPIService.getCalculatedOpenAPI();
 			if (OpenApiVersion.OPENAPI_3_1 == springDocConfigProperties.getApiDocs().getVersion())
 				openAPI.openapi(OpenApiVersion.OPENAPI_3_1.getVersion());
 			if (springDocConfigProperties.isDefaultOverrideWithGenericResponse()) {
@@ -359,7 +357,6 @@ protected synchronized OpenAPI getOpenApi(Locale locale) {
 				openAPIService.setServersPresent(true);
 
 			openAPIService.setCachedOpenAPI(openAPI, finalLocale);
-			openAPIService.resetCalculatedOpenAPI();
 
 			LOGGER.info("Init duration for springdoc-openapi is: {} ms",
 					Duration.between(start, Instant.now()).toMillis());
@@ -552,10 +549,10 @@ protected void calculatePath(List<RouterOperation> routerOperationList, Locale l
 					}
 				}
 				else if (routerOperation.getOperation() != null && StringUtils.isNotBlank(routerOperation.getOperation().operationId()) && isFilterCondition(routerOperation.getPath(), routerOperation.getProduces(), routerOperation.getConsumes(), routerOperation.getHeaders())) {
-					calculatePath(routerOperation, locale);
+					calculatePath(routerOperation, locale, openAPI);
 				}
 				else if (routerOperation.getOperationModel() != null && StringUtils.isNotBlank(routerOperation.getOperationModel().getOperationId()) && isFilterCondition(routerOperation.getPath(), routerOperation.getProduces(), routerOperation.getConsumes(), routerOperation.getHeaders())) {
-					calculatePath(routerOperation, locale);
+					calculatePath(routerOperation, locale, openAPI);
 				}
 			}
 		}
@@ -567,15 +564,14 @@ else if (routerOperation.getOperationModel() != null && StringUtils.isNotBlank(r
 	 * @param routerOperation the router operation
 	 * @param locale the locale
 	 */
-	protected void calculatePath(RouterOperation routerOperation, Locale locale) {
+	protected void calculatePath(RouterOperation routerOperation, Locale locale, OpenAPI openAPI) {
 		String operationPath = routerOperation.getPath();
 		io.swagger.v3.oas.annotations.Operation apiOperation = routerOperation.getOperation();
 		String[] methodConsumes = routerOperation.getConsumes();
 		String[] methodProduces = routerOperation.getProduces();
 		String[] headers = routerOperation.getHeaders();
 		Map<String, String> queryParams = routerOperation.getQueryParams();
 
-		OpenAPI openAPI = openAPIService.getCalculatedOpenAPI();
 		Paths paths = openAPI.getPaths();
 		Map<HttpMethod, Operation> operationMap = null;
 		if (paths.containsKey(operationPath)) {

springdoc-openapi-common/src/main/java/org/springdoc/core/OpenAPIService.java

@@ -138,11 +138,6 @@ public class OpenAPIService implements ApplicationContextAware {
 	 */
 	private final Map<String, OpenAPI> cachedOpenAPI = new HashMap<>();
 
-	/**
-	 * The Calculated open api.
-	 */
-	private OpenAPI calculatedOpenAPI;
-
 	/**
 	 * The Is servers present.
 	 */
@@ -241,18 +236,18 @@ public static String splitCamelCase(String str) {
 	 * Build.
 	 * @param locale the locale
 	 */
-	public void build(Locale locale) {
+	public OpenAPI build(Locale locale) {
 		Optional<OpenAPIDefinition> apiDef = getOpenAPIDefinition();
-
+		OpenAPI calculatedOpenAPI = null;
 		if (openAPI == null) {
-			this.calculatedOpenAPI = new OpenAPI();
-			this.calculatedOpenAPI.setComponents(new Components());
-			this.calculatedOpenAPI.setPaths(new Paths());
+			calculatedOpenAPI = new OpenAPI();
+			calculatedOpenAPI.setComponents(new Components());
+			calculatedOpenAPI.setPaths(new Paths());
 		}
 		else {
 			try {
 				ObjectMapper objectMapper = new ObjectMapper();
-				this.calculatedOpenAPI = objectMapper.readValue(objectMapper.writeValueAsString(openAPI), OpenAPI.class );
+				calculatedOpenAPI = objectMapper.readValue(objectMapper.writeValueAsString(openAPI), OpenAPI.class );
 			}
 			catch (JsonProcessingException e) {
 				LOGGER.warn("Json Processing Exception occurred: {}", e.getMessage());
@@ -277,6 +272,8 @@ else if (calculatedOpenAPI.getInfo() == null) {
 		// add security schemes
 		this.calculateSecuritySchemes(calculatedOpenAPI.getComponents(), locale);
 		openApiBuilderCustomisers.ifPresent(customisers -> customisers.forEach(customiser -> customiser.customise(this)));
+
+		return calculatedOpenAPI;
 	}
 
 	/**
@@ -722,22 +719,6 @@ public void setCachedOpenAPI(OpenAPI cachedOpenAPI, Locale locale) {
 		this.cachedOpenAPI.put(locale.toLanguageTag(), cachedOpenAPI);
 	}
 
-	/**
-	 * Gets calculated open api.
-	 *
-	 * @return the calculated open api
-	 */
-	public OpenAPI getCalculatedOpenAPI() {
-		return calculatedOpenAPI;
-	}
-
-	/**
-	 * Reset calculated open api.
-	 */
-	public void resetCalculatedOpenAPI() {
-		this.calculatedOpenAPI = null;
-	}
-
 	/**
 	 * Gets context.
 	 *

springdoc-openapi-common/src/test/java/org/springdoc/api/AbstractOpenApiResourceTest.java

@@ -118,7 +118,6 @@ public void setUp() {
 		ReflectionTestUtils.setField(openAPIService, "cachedOpenAPI", new HashMap<>());
 		ReflectionTestUtils.setField(openAPIService, "serverBaseUrlCustomizers", Optional.empty());
 
-		when(openAPIService.getCalculatedOpenAPI()).thenReturn(openAPI);
 		when(openAPIService.getContext()).thenReturn(context);
 
 		when(openAPIBuilderObjectFactory.getObject()).thenReturn(openAPIService);
@@ -162,7 +161,7 @@ void calculatePathFromRouterOperation() {
 		routerOperation.setOperationModel(operation);
 		routerOperation.setPath(PATH);
 
-		resource.calculatePath(routerOperation, Locale.getDefault());
+		resource.calculatePath(routerOperation, Locale.getDefault(), this.openAPI);
 
 		final List<Parameter> parameters = resource.getOpenApi(Locale.getDefault()).getPaths().get(PATH).getGet().getParameters();
 		assertThat(parameters.size(), is(3));

springdoc-openapi-webmvc-core/src/main/java/org/springdoc/webmvc/api/OpenApiResource.java

@@ -161,9 +161,9 @@ protected void getPaths(Map<String, Object> restControllers, Locale locale, Open
 
 			Optional<RepositoryRestResourceProvider> repositoryRestResourceProviderOptional = springDocProviders.getRepositoryRestResourceProvider();
 			repositoryRestResourceProviderOptional.ifPresent(restResourceProvider -> {
-				List<RouterOperation> operationList = restResourceProvider.getRouterOperations(openAPIService.getCalculatedOpenAPI(), locale);
+				List<RouterOperation> operationList = restResourceProvider.getRouterOperations(openAPI, locale);
 				calculatePath(operationList, locale, openAPI);
-				restResourceProvider.customize(openAPIService.getCalculatedOpenAPI());
+				restResourceProvider.customize(openAPI);
 				Map<RequestMappingInfo, HandlerMethod> mapDataRest = restResourceProvider.getHandlerMethods();
 				Map<String, Object> requestMappingMap = restResourceProvider.getBasePathAwareControllerEndpoints();
 				Class[] additionalRestClasses = requestMappingMap.values().stream().map(AopUtils::getTargetClass).toArray(Class[]::new);