Skip to content

Commit c32a017

Browse files
bnasslahsenbnasslahsen
committed
OpenAPIService serverBaseUrl is not thread safe. Fixes #2931 
1 parent 65ae8ba commit c32a017

File tree

13 files changed

+58
-59
lines changed

13 files changed

+58
-59
lines changed

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

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -256,7 +256,7 @@ protected AbstractOpenApiResource(String groupName, ObjectFactory<OpenAPIService
256256
}
257257
else {
258258
for (String locale : springDocConfigProperties.getPreLoadingLocales()) {
259-
Executors.newSingleThreadExecutor().execute(() -> this.getOpenApi(Locale.forLanguageTag(locale)));
259+
Executors.newSingleThreadExecutor().execute(() -> this.getOpenApi(null, Locale.forLanguageTag(locale)));
260260
}
261261
}
262262
}
@@ -334,7 +334,7 @@ public static void setModelAndViewClass(Class<?> modelAndViewClass) {
334334
* Gets open api.
335335
*/
336336
private void getOpenApi() {
337-
this.getOpenApi(Locale.getDefault());
337+
this.getOpenApi(null, Locale.getDefault());
338338
}
339339

340340
/**
@@ -343,7 +343,7 @@ private void getOpenApi() {
343343
* @param locale the locale
344344
* @return the open api
345345
*/
346-
protected OpenAPI getOpenApi(Locale locale) {
346+
protected OpenAPI getOpenApi(String serverBaseUrl, Locale locale) {
347347
this.reentrantLock.lock();
348348
try {
349349
final OpenAPI openAPI;
@@ -384,7 +384,7 @@ protected OpenAPI getOpenApi(Locale locale) {
384384
openAPIService.setServersPresent(true);
385385
else
386386
openAPIService.setServersPresent(false);
387-
openAPIService.updateServers(openAPI);
387+
openAPIService.updateServers(serverBaseUrl, openAPI);
388388

389389
if (springDocConfigProperties.isRemoveBrokenReferenceDefinitions())
390390
this.removeBrokenReferenceDefinitions(openAPI);
@@ -413,9 +413,8 @@ protected OpenAPI getOpenApi(Locale locale) {
413413
else {
414414
LOGGER.debug("Fetching openApi document from cache");
415415
openAPI = openAPIService.getCachedOpenAPI(finalLocale);
416-
openAPIService.updateServers(openAPI);
416+
openAPIService.updateServers(serverBaseUrl, openAPI);
417417
}
418-
openAPIService.updateServers(openAPI);
419418
return openAPI;
420419
}
421420
finally {

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

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -174,11 +174,6 @@ public class OpenAPIService implements ApplicationContextAware {
174174
*/
175175
private boolean isServersPresent;
176176

177-
/**
178-
* The Server base url.
179-
*/
180-
private String serverBaseUrl;
181-
182177
/**
183178
* Instantiates a new Open api builder.
184179
*
@@ -296,9 +291,10 @@ private void initializeHiddenRestController() {
296291
/**
297292
* Update servers open api.
298293
*
299-
* @param openAPI the open api
294+
* @param serverBaseUrl the server base url
295+
* @param openAPI the open api
300296
*/
301-
public void updateServers(OpenAPI openAPI) {
297+
public void updateServers(String serverBaseUrl, OpenAPI openAPI) {
302298
if (!isServersPresent && serverBaseUrl != null) // default server value
303299
{
304300
Server server = new Server().url(serverBaseUrl).description(DEFAULT_SERVER_DESCRIPTION);
@@ -493,18 +489,17 @@ public Schema resolveProperties(Schema schema, Locale locale) {
493489
*
494490
* @param serverBaseUrl the server base url
495491
* @param httpRequest the http request
492+
* @return the string
496493
*/
497-
public void setServerBaseUrl(String serverBaseUrl, HttpRequest httpRequest) {
494+
public String calculateServerBaseUrl(String serverBaseUrl, HttpRequest httpRequest) {
498495
String customServerBaseUrl = serverBaseUrl;
499-
500496
if (serverBaseUrlCustomizers.isPresent()) {
501497
for (ServerBaseUrlCustomizer customizer : serverBaseUrlCustomizers.get()) {
502498
customServerBaseUrl = customizer.customize(customServerBaseUrl, httpRequest);
503499
}
504500
}
505501

506-
this.serverBaseUrl = customServerBaseUrl;
507-
502+
return customServerBaseUrl;
508503
}
509504

510505
/**

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,9 @@
3030
import java.util.HashMap;
3131
import java.util.Locale;
3232
import java.util.Map;
33-
34-
import io.swagger.v3.oas.models.SpecVersion;
3533
import java.util.stream.Collectors;
3634

35+
import io.swagger.v3.oas.models.SpecVersion;
3736
import org.slf4j.Logger;
3837
import org.slf4j.LoggerFactory;
3938
import org.springdoc.core.properties.SpringDocConfigProperties;

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

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ springDocProviders,new SpringDocCustomizers(Optional.empty(),Optional.empty(),Op
167167

168168
resource.calculatePath(routerOperation, Locale.getDefault(), this.openAPI);
169169

170-
final List<Parameter> parameters = resource.getOpenApi(Locale.getDefault()).getPaths().get(PATH+"/{"+PARAMETER_WITH_NUMBER_SCHEMA_NAME+"}").getGet().getParameters();
170+
final List<Parameter> parameters = resource.getOpenApi(null, Locale.getDefault()).getPaths().get(PATH+"/{"+PARAMETER_WITH_NUMBER_SCHEMA_NAME+"}").getGet().getParameters();
171171
assertThat(parameters.size(), is(3));
172172
assertThat(parameters, containsInAnyOrder(refParameter, numberParameterInPath, parameterWithoutSchema));
173173

@@ -189,10 +189,10 @@ springDocProviders,new SpringDocCustomizers(Optional.empty(),Optional.empty(),Op
189189

190190
@Test
191191
void preLoadingModeShouldNotOverwriteServers() throws InterruptedException {
192-
doCallRealMethod().when(openAPIService).updateServers(any());
192+
doCallRealMethod().when(openAPIService).updateServers(any(), any());
193193
when(openAPIService.getCachedOpenAPI(any())).thenCallRealMethod();
194194
doAnswer(new CallsRealMethods()).when(openAPIService).setServersPresent(true);
195-
doAnswer(new CallsRealMethods()).when(openAPIService).setServerBaseUrl(any(), any());
195+
doAnswer(new CallsRealMethods()).when(openAPIService).calculateServerBaseUrl(any(), any());
196196
doAnswer(new CallsRealMethods()).when(openAPIService).setCachedOpenAPI(any(), any());
197197

198198
String customUrl = "https://custom.com";
@@ -214,19 +214,19 @@ properties, springDocProviders, new SpringDocCustomizers(Optional.of(singleton(o
214214
Thread.sleep(1_000);
215215

216216
// emulate generating base url
217-
openAPIService.setServerBaseUrl(generatedUrl, new MockClientHttpRequest());
218-
openAPIService.updateServers(openAPI);
217+
String serverBaseUrl = openAPIService.calculateServerBaseUrl(generatedUrl, new MockClientHttpRequest());
218+
openAPIService.updateServers(serverBaseUrl, openAPI);
219219
Locale locale = Locale.US;
220-
OpenAPI after = resource.getOpenApi(locale);
220+
OpenAPI after = resource.getOpenApi(serverBaseUrl,locale);
221221

222222
assertThat(after.getServers().get(0).getUrl(), is(customUrl));
223223
}
224224

225225
@Test
226226
void serverBaseUrlCustomisersTest() throws InterruptedException {
227-
doCallRealMethod().when(openAPIService).updateServers(any());
227+
doCallRealMethod().when(openAPIService).updateServers(any(), any());
228228
when(openAPIService.getCachedOpenAPI(any())).thenCallRealMethod();
229-
doAnswer(new CallsRealMethods()).when(openAPIService).setServerBaseUrl(any(), any());
229+
doAnswer(new CallsRealMethods()).when(openAPIService).calculateServerBaseUrl(any(), any());
230230
doAnswer(new CallsRealMethods()).when(openAPIService).setCachedOpenAPI(any(), any());
231231

232232
SpringDocConfigProperties properties = new SpringDocConfigProperties();
@@ -249,9 +249,9 @@ springDocProviders, new SpringDocCustomizers(Optional.empty(),Optional.empty(),O
249249

250250
// Test that setting generated URL works fine with no customizers present
251251
String generatedUrl = "https://generated-url.com/context-path";
252-
openAPIService.setServerBaseUrl(generatedUrl, new MockClientHttpRequest());
253-
openAPIService.updateServers(openAPI);
254-
OpenAPI after = resource.getOpenApi(locale);
252+
String serverUrl = openAPIService.calculateServerBaseUrl(generatedUrl, new MockClientHttpRequest());
253+
openAPIService.updateServers(serverUrl, openAPI);
254+
OpenAPI after = resource.getOpenApi(serverUrl, locale);
255255
assertThat(after.getServers().get(0).getUrl(), is(generatedUrl));
256256

257257
// Test that adding a serverBaseUrlCustomizer has the desired effect
@@ -260,28 +260,28 @@ springDocProviders, new SpringDocCustomizers(Optional.empty(),Optional.empty(),O
260260
serverBaseUrlCustomizerList.add(serverBaseUrlCustomizer);
261261

262262
ReflectionTestUtils.setField(openAPIService, "serverBaseUrlCustomizers", Optional.of(serverBaseUrlCustomizerList));
263-
openAPIService.setServerBaseUrl(generatedUrl, new MockClientHttpRequest());
264-
openAPIService.updateServers(openAPI);
265-
after = resource.getOpenApi(locale);
263+
serverUrl = openAPIService.calculateServerBaseUrl(generatedUrl, new MockClientHttpRequest());
264+
openAPIService.updateServers(serverUrl, openAPI);
265+
after = resource.getOpenApi(serverUrl, locale);
266266
assertThat(after.getServers().get(0).getUrl(), is("https://generated-url.com"));
267267

268268
// Test that serverBaseUrlCustomisers are performed in order
269269
generatedUrl = "https://generated-url.com/context-path/second-path";
270270
ServerBaseUrlCustomizer serverBaseUrlCustomiser2 = (serverBaseUrl, request) -> serverBaseUrl.replace("/context-path/second-path", "");
271271
serverBaseUrlCustomizerList.add(serverBaseUrlCustomiser2);
272272

273-
openAPIService.setServerBaseUrl(generatedUrl, new MockClientHttpRequest());
274-
openAPIService.updateServers(openAPI);
275-
after = resource.getOpenApi(locale);
273+
serverUrl = openAPIService.calculateServerBaseUrl(generatedUrl, new MockClientHttpRequest());
274+
openAPIService.updateServers(serverUrl, openAPI);
275+
after = resource.getOpenApi(serverUrl, locale);
276276
assertThat(after.getServers().get(0).getUrl(), is("https://generated-url.com/second-path"));
277277

278278
// Test that all serverBaseUrlCustomisers in the List are performed
279279
ServerBaseUrlCustomizer serverBaseUrlCustomiser3 = (serverBaseUrl, request) -> serverBaseUrl.replace("/second-path", "");
280280
serverBaseUrlCustomizerList.add(serverBaseUrlCustomiser3);
281281

282-
openAPIService.setServerBaseUrl(generatedUrl, new MockClientHttpRequest());
283-
openAPIService.updateServers(openAPI);
284-
after = resource.getOpenApi(locale);
282+
serverUrl = openAPIService.calculateServerBaseUrl(generatedUrl, new MockClientHttpRequest());
283+
openAPIService.updateServers(serverUrl, openAPI);
284+
after = resource.getOpenApi(serverUrl, locale);
285285
assertThat(after.getServers().get(0).getUrl(), is("https://generated-url.com"));
286286
}
287287

‎springdoc-openapi-starter-webflux-api/src/main/java/org/springdoc/webflux/api/OpenApiActuatorResource.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -131,10 +131,10 @@ public Mono<byte[]> openapiYaml(ServerHttpRequest serverHttpRequest, Locale loca
131131
}
132132

133133
@Override
134-
protected void calculateServerUrl(ServerHttpRequest serverHttpRequest, String apiDocsUrl, Locale locale) {
134+
protected String calculateServerUrl(ServerHttpRequest serverHttpRequest, String apiDocsUrl, Locale locale) {
135135
super.initOpenAPIBuilder(locale);
136136
URI uri = getActuatorURI(serverHttpRequest.getURI().getScheme(), serverHttpRequest.getURI().getHost());
137-
openAPIService.setServerBaseUrl(uri.toString(), serverHttpRequest);
137+
return openAPIService.calculateServerBaseUrl(uri.toString(), serverHttpRequest);
138138
}
139139

140140
@Override

‎springdoc-openapi-starter-webflux-api/src/main/java/org/springdoc/webflux/api/OpenApiResource.java‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -119,8 +119,8 @@ protected OpenApiResource(ObjectFactory<OpenAPIService> openAPIBuilderObjectFact
119119
*/
120120
protected Mono<byte[]> openapiJson(ServerHttpRequest serverHttpRequest, String apiDocsUrl, Locale locale)
121121
throws JsonProcessingException {
122-
calculateServerUrl(serverHttpRequest, apiDocsUrl, locale);
123-
OpenAPI openAPI = this.getOpenApi(locale);
122+
String serverBaseUrl= calculateServerUrl(serverHttpRequest, apiDocsUrl, locale);
123+
OpenAPI openAPI = this.getOpenApi(serverBaseUrl, locale);
124124
return Mono.just(writeJsonValue(openAPI));
125125
}
126126

@@ -135,8 +135,8 @@ protected Mono<byte[]> openapiJson(ServerHttpRequest serverHttpRequest, String a
135135
*/
136136
protected Mono<byte[]> openapiYaml(ServerHttpRequest serverHttpRequest, String apiDocsUrl, Locale locale)
137137
throws JsonProcessingException {
138-
calculateServerUrl(serverHttpRequest, apiDocsUrl, locale);
139-
OpenAPI openAPI = this.getOpenApi(locale);
138+
String serverBaseUrl = calculateServerUrl(serverHttpRequest, apiDocsUrl, locale);
139+
OpenAPI openAPI = this.getOpenApi(serverBaseUrl, locale);
140140
return Mono.just(writeYamlValue(openAPI));
141141
}
142142

@@ -233,10 +233,10 @@ protected void getWebFluxRouterFunctionPaths(Locale locale, OpenAPI openAPI) {
233233
* @param apiDocsUrl the api docs url
234234
* @param locale the locale
235235
*/
236-
protected void calculateServerUrl(ServerHttpRequest serverHttpRequest, String apiDocsUrl, Locale locale) {
236+
protected String calculateServerUrl(ServerHttpRequest serverHttpRequest, String apiDocsUrl, Locale locale) {
237237
initOpenAPIBuilder(locale);
238238
String serverUrl = getServerUrl(serverHttpRequest, apiDocsUrl);
239-
openAPIService.setServerBaseUrl(serverUrl, serverHttpRequest);
239+
return openAPIService.calculateServerBaseUrl(serverUrl, serverHttpRequest);
240240
}
241241

242242
/**

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

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -123,8 +123,8 @@ protected OpenApiResource(ObjectFactory<OpenAPIService> openAPIBuilderObjectFact
123123
public byte[] openapiJson(HttpServletRequest request,
124124
String apiDocsUrl, Locale locale)
125125
throws JsonProcessingException {
126-
calculateServerUrl(request, apiDocsUrl, locale);
127-
OpenAPI openAPI = this.getOpenApi(locale);
126+
String serverBaseUrl=calculateServerUrl(request, apiDocsUrl, locale);
127+
OpenAPI openAPI = this.getOpenApi(serverBaseUrl,locale);
128128
return writeJsonValue(openAPI);
129129
}
130130

@@ -140,8 +140,8 @@ public byte[] openapiJson(HttpServletRequest request,
140140
public byte[] openapiYaml(HttpServletRequest request,
141141
String apiDocsUrl, Locale locale)
142142
throws JsonProcessingException {
143-
calculateServerUrl(request, apiDocsUrl, locale);
144-
OpenAPI openAPI = this.getOpenApi(locale);
143+
String serverBaseUrl=calculateServerUrl(request, apiDocsUrl, locale);
144+
OpenAPI openAPI = this.getOpenApi(serverBaseUrl, locale);
145145
return writeYamlValue(openAPI);
146146
}
147147

@@ -248,12 +248,13 @@ private Comparator<RequestMappingInfo> byReversedRequestMappingInfos() {
248248
* @param request the request
249249
* @param apiDocsUrl the api docs url
250250
* @param locale the locale
251+
* @return the string
251252
*/
252-
protected void calculateServerUrl(HttpServletRequest request, String apiDocsUrl, Locale locale) {
253+
protected String calculateServerUrl(HttpServletRequest request, String apiDocsUrl, Locale locale) {
253254
super.initOpenAPIBuilder(locale);
254255
String calculatedUrl = getServerUrl(request, apiDocsUrl);
255256
ServletServerHttpRequest serverRequest = request != null ? new ServletServerHttpRequest(request) : null;
256-
openAPIService.setServerBaseUrl(calculatedUrl, serverRequest);
257+
return openAPIService.calculateServerBaseUrl(calculatedUrl, serverRequest);
257258
}
258259

259260
/**

‎springdoc-openapi-starter-webmvc-api/src/test/java/test/org/springdoc/api/v30/app239/SpringDocApp239Test.java‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,10 @@
2424

2525
package test.org.springdoc.api.v30.app239;
2626

27-
import org.springframework.boot.autoconfigure.SpringBootApplication;
2827
import test.org.springdoc.api.v30.AbstractSpringDocV30Test;
2928

29+
import org.springframework.boot.autoconfigure.SpringBootApplication;
30+
3031
public class SpringDocApp239Test extends AbstractSpringDocV30Test {
3132

3233
@SpringBootApplication

‎springdoc-openapi-starter-webmvc-api/src/test/java/test/org/springdoc/api/v30/app242/SpringDocApp242Test.java‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,10 @@
2424

2525
package test.org.springdoc.api.v30.app242;
2626

27-
import org.springframework.boot.autoconfigure.SpringBootApplication;
2827
import test.org.springdoc.api.v30.AbstractSpringDocV30Test;
2928

29+
import org.springframework.boot.autoconfigure.SpringBootApplication;
30+
3031
public class SpringDocApp242Test extends AbstractSpringDocV30Test {
3132

3233
@SpringBootApplication

‎springdoc-openapi-starter-webmvc-api/src/test/java/test/org/springdoc/api/v30/app243/HelloController.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@
2626

2727
package test.org.springdoc.api.v30.app243;
2828

29-
import com.fasterxml.jackson.annotation.JsonSubTypes;
3029
import io.swagger.v3.oas.annotations.media.DiscriminatorMapping;
3130
import io.swagger.v3.oas.annotations.media.Schema;
31+
3232
import org.springframework.web.bind.annotation.PostMapping;
3333
import org.springframework.web.bind.annotation.RequestBody;
3434
import org.springframework.web.bind.annotation.RestController;

0 commit comments

Comments
 (0)