Add support for caching based on Locale

ianwallen · ianwallen · commit e92172f3ba38 · 2021-12-01T15:35:54.000-04: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
@@ -294,7 +294,7 @@ public static void addHiddenRestControllers(String... classes) {
 	 */
 	protected synchronized OpenAPI getOpenApi(Locale locale) {
 		OpenAPI openApi;
-		if (openAPIService.getCachedOpenAPI() == null || springDocConfigProperties.isCacheDisabled()) {
+		if (openAPIService.getCachedOpenAPI(locale) == null || springDocConfigProperties.isCacheDisabled()) {
 			Instant start = Instant.now();
 			openAPIService.build(locale);
 			Map<String, Object> mappingsMap = openAPIService.getMappingsMap().entrySet().stream()
@@ -325,15 +325,15 @@ protected synchronized OpenAPI getOpenApi(Locale locale) {
 			if ((!CollectionUtils.isEmpty(openApi.getServers()) && !Objects.equals(servers, openApi.getServers())))
 				openAPIService.setServersPresent(true);
 
-			openAPIService.setCachedOpenAPI(openApi);
+			openAPIService.setCachedOpenAPI(openApi, locale);
 			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());
+			openApi = openAPIService.updateServers(openAPIService.getCachedOpenAPI(locale));
 		}
 		return openApi;
 	}
@@ -1099,8 +1099,8 @@ else if (existingOperation != null) {
 	/**
 	 * Init open api builder.
 	 */
-	protected void initOpenAPIBuilder() {
-		if (openAPIService.getCachedOpenAPI() != null && springDocConfigProperties.isCacheDisabled()) {
+	protected void initOpenAPIBuilder(Locale locale) {
+		if (openAPIService.getCachedOpenAPI(locale) != null && springDocConfigProperties.isCacheDisabled()) {
 			openAPIService = openAPIBuilderObjectFactory.getObject();
 		}
 	}
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/OpenAPIService.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/OpenAPIService.java
@@ -129,7 +129,10 @@ public class OpenAPIService {
 	/**
 	 * The Cached open api.
 	 */
-	private OpenAPI cachedOpenAPI;
+	/**
+	 * The Mappings map.
+	 */
+	private final Map<String, OpenAPI> cachedOpenAPI = new HashMap<>();
 
 	/**
 	 * The Calculated open api.
@@ -722,19 +725,26 @@ public Map<String, Object> getControllerAdviceMap() {
 	/**
 	 * Gets cached open api.
 	 *
+	 * @param locale associated the the cache entry
 	 * @return the cached open api
 	 */
-	public OpenAPI getCachedOpenAPI() {
-		return cachedOpenAPI;
+	public OpenAPI getCachedOpenAPI(Locale locale) {
+		if (cachedOpenAPI != null && cachedOpenAPI.containsKey(locale.getLanguage())) {
+			return cachedOpenAPI.get(locale.getLanguage());
+		}
+		return null;
 	}
 
 	/**
 	 * Sets cached open api.
 	 *
+	 * @param locale associated the the cache entry
 	 * @param cachedOpenAPI the cached open api
 	 */
-	public void setCachedOpenAPI(OpenAPI cachedOpenAPI) {
-		this.cachedOpenAPI = cachedOpenAPI;
+	public void setCachedOpenAPI(OpenAPI cachedOpenAPI, Locale locale) {
+		if (this.cachedOpenAPI != null) {
+			this.cachedOpenAPI.put(locale.getLanguage(), cachedOpenAPI);
+		}
 	}
 
 	/**
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
@@ -168,10 +168,10 @@ void calculatePathFromRouterOperation() {
 	@Test
 	void preLoadingModeShouldNotOverwriteServers() throws InterruptedException {
 		when(openAPIService.updateServers(any())).thenCallRealMethod();
-		when(openAPIService.getCachedOpenAPI()).thenCallRealMethod();
+		when(openAPIService.getCachedOpenAPI(any())).thenCallRealMethod();
 		doAnswer(new CallsRealMethods()).when(openAPIService).setServersPresent(true);
 		doAnswer(new CallsRealMethods()).when(openAPIService).setServerBaseUrl(any());
-		doAnswer(new CallsRealMethods()).when(openAPIService).setCachedOpenAPI(any());
+		doAnswer(new CallsRealMethods()).when(openAPIService).setCachedOpenAPI(any(), any());
 
 		String customUrl = "https://custom.com";
 		String generatedUrl = "https://generated.com";
@@ -197,8 +197,8 @@ void preLoadingModeShouldNotOverwriteServers() throws InterruptedException {
 		// emulate generating base url
 		openAPIService.setServerBaseUrl(generatedUrl);
 		openAPIService.updateServers(openAPI);
-
-		OpenAPI after = resource.getOpenApi(Locale.getDefault());
+		Locale locale = Locale.US;
+		OpenAPI after = resource.getOpenApi(locale);
 
 		assertThat(after.getServers().get(0).getUrl(), is(customUrl));
 	}
diff --git a/springdoc-openapi-webflux-core/src/main/java/org/springdoc/webflux/api/OpenApiActuatorResource.java b/springdoc-openapi-webflux-core/src/main/java/org/springdoc/webflux/api/OpenApiActuatorResource.java
@@ -122,8 +122,8 @@ public Mono<String> openapiYaml(ServerHttpRequest serverHttpRequest, Locale loca
 	}
 
 	@Override
-	protected void calculateServerUrl(ServerHttpRequest serverHttpRequest, String apiDocsUrl) {
-		super.initOpenAPIBuilder();
+	protected void calculateServerUrl(ServerHttpRequest serverHttpRequest, String apiDocsUrl, Locale locale) {
+		super.initOpenAPIBuilder(locale);
 		URI uri = getActuatorURI(serverHttpRequest.getURI().getScheme(), serverHttpRequest.getURI().getHost());
 		openAPIService.setServerBaseUrl(uri.toString());
 	}
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
@@ -122,7 +122,7 @@ public OpenApiResource(ObjectFactory<OpenAPIService> openAPIBuilderObjectFactory
 	 */
 	protected Mono<String> openapiJson(ServerHttpRequest serverHttpRequest, String apiDocsUrl, Locale locale)
 			throws JsonProcessingException {
-		calculateServerUrl(serverHttpRequest, apiDocsUrl);
+		calculateServerUrl(serverHttpRequest, apiDocsUrl, locale);
 		OpenAPI openAPI = this.getOpenApi(locale);
 		return Mono.just(writeJsonValue(openAPI));
 	}
@@ -138,7 +138,7 @@ protected Mono<String> openapiJson(ServerHttpRequest serverHttpRequest, String a
 	 */
 	protected Mono<String> openapiYaml(ServerHttpRequest serverHttpRequest, String apiDocsUrl, Locale locale)
 			throws JsonProcessingException {
-		calculateServerUrl(serverHttpRequest, apiDocsUrl);
+		calculateServerUrl(serverHttpRequest, apiDocsUrl, locale);
 		OpenAPI openAPI = this.getOpenApi(locale);
 		return Mono.just(writeYamlValue(openAPI));
 	}
@@ -232,8 +232,8 @@ protected void getWebFluxRouterFunctionPaths(Locale locale) {
 	 * @param serverHttpRequest the server http request
 	 * @param apiDocsUrl the api docs url
 	 */
-	protected void calculateServerUrl(ServerHttpRequest serverHttpRequest, String apiDocsUrl) {
-		initOpenAPIBuilder();
+	protected void calculateServerUrl(ServerHttpRequest serverHttpRequest, String apiDocsUrl, Locale locale) {
+		initOpenAPIBuilder(locale);
 		String serverUrl = getServerUrl(serverHttpRequest,apiDocsUrl);
 		openAPIService.setServerBaseUrl(serverUrl);
 	}
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
@@ -157,7 +157,7 @@ public OpenApiResource(ObjectFactory<OpenAPIService> openAPIBuilderObjectFactory
 	public String openapiJson(HttpServletRequest request,
 			String apiDocsUrl, Locale locale)
 			throws JsonProcessingException {
-		calculateServerUrl(request, apiDocsUrl);
+		calculateServerUrl(request, apiDocsUrl, locale);
 		OpenAPI openAPI = this.getOpenApi(locale);
 		return writeJsonValue(openAPI);
 	}
@@ -174,7 +174,7 @@ public String openapiJson(HttpServletRequest request,
 	public String openapiYaml(HttpServletRequest request,
 			String apiDocsUrl, Locale locale)
 			throws JsonProcessingException {
-		calculateServerUrl(request, apiDocsUrl);
+		calculateServerUrl(request, apiDocsUrl, locale);
 		OpenAPI openAPI = this.getOpenApi(locale);
 		return writeYamlValue(openAPI);
 	}
@@ -290,8 +290,8 @@ private Comparator<Map.Entry<RequestMappingInfo, HandlerMethod>> byReversedReque
 	 * @param request the request
 	 * @param apiDocsUrl the api docs url
 	 */
-	protected void calculateServerUrl(HttpServletRequest request, String apiDocsUrl) {
-		super.initOpenAPIBuilder();
+	protected void calculateServerUrl(HttpServletRequest request, String apiDocsUrl, Locale locale) {
+		super.initOpenAPIBuilder(locale);
 		String calculatedUrl = getServerUrl(request, apiDocsUrl);
 		openAPIService.setServerBaseUrl(calculatedUrl);
 	}

Original file line number	Diff line number	Diff line change
`@@ -122,8 +122,8 @@ public Mono<String> openapiYaml(ServerHttpRequest serverHttpRequest, Locale loca`
`122`	`122`	`}`
`123`	`123`
`124`	`124`	`@Override`
`125`		`- protected void calculateServerUrl(ServerHttpRequest serverHttpRequest, String apiDocsUrl) {`
`126`		`- super.initOpenAPIBuilder();`
	`125`	`+ protected void calculateServerUrl(ServerHttpRequest serverHttpRequest, String apiDocsUrl, Locale locale) {`
	`126`	`+ super.initOpenAPIBuilder(locale);`
`127`	`127`	`URI uri = getActuatorURI(serverHttpRequest.getURI().getScheme(), serverHttpRequest.getURI().getHost());`
`128`	`128`	`openAPIService.setServerBaseUrl(uri.toString());`
`129`	`129`	`}`