CHANGELOG.md update

Author: bnasslahsen

CHANGELOG.md

@@ -11,7 +11,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - #1020 - Change handler methods scanning strategy
 - #1026 - Support for @Operation in @RepositoryRestResource Spring Data Repositories.
 - #1027 - Detect automatically @Controller with @Operation. 
-
 ### Changed
 - Upgrade versions: spring-boot to 2.4.2 and swagger-ui to 3.40
 ### Fixed
@@ -20,6 +19,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - #1015 - Default value for List/Array RequestParameter has wrong type.
 - #1010 - Wrong Parameter Name with Default Sort.
 - #1014 - HATOEAS Links produces a circular reference.
+- #1035 - oauth2 redirect url calculated incorrectly when springdoc.swagger-ui.path=/ 
 
 ## [1.5.2] - 2020-12-16 
 ### Added

springdoc-openapi-webflux-ui/src/main/java/org/springdoc/webflux/ui/SwaggerConfig.java

@@ -33,11 +33,13 @@
 import org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties;
 import org.springframework.boot.actuate.autoconfigure.web.server.ConditionalOnManagementPort;
 import org.springframework.boot.actuate.autoconfigure.web.server.ManagementPortType;
+import org.springframework.boot.actuate.autoconfigure.web.server.ManagementServerProperties;
 import org.springframework.boot.actuate.endpoint.web.reactive.WebFluxEndpointHandlerMapping;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.boot.autoconfigure.web.reactive.WebFluxProperties;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Lazy;
@@ -68,8 +70,8 @@ public class SwaggerConfig implements WebFluxConfigurer {
 	@Bean
 	@ConditionalOnMissingBean
 	@ConditionalOnProperty(name = SPRINGDOC_USE_MANAGEMENT_PORT, havingValue = "false", matchIfMissing = true)
-	SwaggerWelcomeWebFlux swaggerWelcome(SwaggerUiConfigProperties swaggerUiConfig, SpringDocConfigProperties springDocConfigProperties,SwaggerUiConfigParameters swaggerUiConfigParameters) {
-		return new SwaggerWelcomeWebFlux(swaggerUiConfig,springDocConfigProperties,swaggerUiConfigParameters);
+	SwaggerWelcomeWebFlux swaggerWelcome(SwaggerUiConfigProperties swaggerUiConfig, SpringDocConfigProperties springDocConfigProperties,SwaggerUiConfigParameters swaggerUiConfigParameters, WebFluxProperties webFluxProperties) {
+		return new SwaggerWelcomeWebFlux(swaggerUiConfig,springDocConfigProperties,swaggerUiConfigParameters,webFluxProperties);
 	}
 
 	/**
@@ -129,12 +131,14 @@ static class SwaggerActuatorWelcomeConfiguration {
 		 * @param springDocConfigProperties the spring doc config properties
 		 * @param swaggerUiConfigParameters the swagger ui config parameters
 		 * @param webEndpointProperties the web endpoint properties
+		 * @param managementServerProperties the management server properties
 		 * @return the swagger welcome actuator
 		 */
 		@Bean
 		@ConditionalOnMissingBean
-		SwaggerWelcomeActuator swaggerActuatorWelcome(SwaggerUiConfigProperties swaggerUiConfig, SpringDocConfigProperties springDocConfigProperties, SwaggerUiConfigParameters swaggerUiConfigParameters, WebEndpointProperties webEndpointProperties) {
-			return new SwaggerWelcomeActuator(swaggerUiConfig, springDocConfigProperties, swaggerUiConfigParameters, webEndpointProperties);
+		SwaggerWelcomeActuator swaggerActuatorWelcome(SwaggerUiConfigProperties swaggerUiConfig, SpringDocConfigProperties springDocConfigProperties,
+				SwaggerUiConfigParameters swaggerUiConfigParameters, WebEndpointProperties webEndpointProperties, ManagementServerProperties managementServerProperties) {
+			return new SwaggerWelcomeActuator(swaggerUiConfig, springDocConfigProperties, swaggerUiConfigParameters, webEndpointProperties,managementServerProperties);
 		}
 	}
 }

springdoc-openapi-webflux-ui/src/main/java/org/springdoc/webflux/ui/SwaggerWelcomeActuator.java

@@ -30,6 +30,7 @@
 import reactor.core.publisher.Mono;
 
 import org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties;
+import org.springframework.boot.actuate.autoconfigure.web.server.ManagementServerProperties;
 import org.springframework.boot.actuate.endpoint.web.annotation.ControllerEndpoint;
 import org.springframework.http.MediaType;
 import org.springframework.http.server.reactive.ServerHttpRequest;
@@ -56,6 +57,11 @@ public class SwaggerWelcomeActuator extends SwaggerWelcomeCommon {
 	 */
 	private WebEndpointProperties webEndpointProperties;
 
+	/**
+	 * The Management server properties.
+	 */
+	private ManagementServerProperties managementServerProperties;
+
 	/**
 	 * The constant SWAGGER_CONFIG_ACTUATOR_URL.
 	 */
@@ -72,9 +78,11 @@ public class SwaggerWelcomeActuator extends SwaggerWelcomeCommon {
 	public SwaggerWelcomeActuator(SwaggerUiConfigProperties swaggerUiConfig
 			, SpringDocConfigProperties springDocConfigProperties,
 			SwaggerUiConfigParameters swaggerUiConfigParameters,
-			WebEndpointProperties webEndpointProperties) {
+			WebEndpointProperties webEndpointProperties,
+			ManagementServerProperties managementServerProperties) {
 		super(swaggerUiConfig, springDocConfigProperties,swaggerUiConfigParameters);
 		this.webEndpointProperties = webEndpointProperties;
+		this.managementServerProperties=managementServerProperties;
 	}
 
 	/**
@@ -114,9 +122,8 @@ public Map<String, Object> getSwaggerUiConfig(ServerHttpRequest request) {
 	 */
 	@Override
 	protected void buildConfigUrl(String contextPath, UriComponentsBuilder uriComponentsBuilder) {
-		String apiDocsUrl = DEFAULT_API_DOCS_ACTUATOR_URL;
 		if (StringUtils.isEmpty(swaggerUiConfig.getConfigUrl())) {
-			String url = buildUrl(contextPath + webEndpointProperties.getBasePath(), apiDocsUrl);
+			String url = buildUrl(contextPath + webEndpointProperties.getBasePath(), DEFAULT_API_DOCS_ACTUATOR_URL);
 			String swaggerConfigUrl = contextPath + webEndpointProperties.getBasePath()
 					+ DEFAULT_PATH_SEPARATOR + DEFAULT_SWAGGER_UI_ACTUATOR_PATH
 					+ DEFAULT_PATH_SEPARATOR + SWAGGGER_CONFIG_FILE;
@@ -142,4 +149,11 @@ protected void calculateUiRootPath(StringBuilder... sbUrls) {
 		calculateUiRootCommon(sbUrl, sbUrls);
 	}
 
+	@Override
+	protected void calculateOauth2RedirectUrl(UriComponentsBuilder uriComponentsBuilder) {
+		if (oauthPrefix == null && !swaggerUiConfigParameters.isValidUrl(swaggerUiConfigParameters.getOauth2RedirectUrl())) {
+			this.oauthPrefix = uriComponentsBuilder.path(managementServerProperties.getBasePath()+swaggerUiConfigParameters.getUiRootPath()).path(webJarsPrefixUrl);
+			swaggerUiConfigParameters.setOauth2RedirectUrl(this.oauthPrefix.path(swaggerUiConfigParameters.getOauth2RedirectUrl()).build().toString());
+		}
+	}
 }

springdoc-openapi-webflux-ui/src/main/java/org/springdoc/webflux/ui/SwaggerWelcomeCommon.java

@@ -32,6 +32,7 @@
 import org.springframework.http.HttpStatus;
 import org.springframework.http.server.reactive.ServerHttpRequest;
 import org.springframework.http.server.reactive.ServerHttpResponse;
+import org.springframework.util.AntPathMatcher;
 import org.springframework.web.util.UriComponentsBuilder;
 
 import static org.springdoc.core.Constants.SWAGGER_UI_URL;
@@ -90,15 +91,6 @@ protected Map<String, Object> getSwaggerUiConfig(ServerHttpRequest request) {
 		return swaggerUiConfigParameters.getConfigParameters();
 	}
 
-
-	@Override
-	protected void calculateOauth2RedirectUrl(UriComponentsBuilder uriComponentsBuilder) {
-		if (oauthPrefix == null && !swaggerUiConfigParameters.isValidUrl(swaggerUiConfigParameters.getOauth2RedirectUrl())) {
-			this.oauthPrefix = uriComponentsBuilder.path(swaggerUiConfigParameters.getUiRootPath()).path(webJarsPrefixUrl);
-			swaggerUiConfigParameters.setOauth2RedirectUrl(this.oauthPrefix.path(swaggerUiConfigParameters.getOauth2RedirectUrl()).build().toString());
-		}
-	}
-
 	/**
 	 * From current context path string.
 	 *
@@ -108,7 +100,8 @@ protected void calculateOauth2RedirectUrl(UriComponentsBuilder uriComponentsBuil
 	private String fromCurrentContextPath(ServerHttpRequest request) {
 		String contextPath = request.getPath().contextPath().value();
 		String url = UriComponentsBuilder.fromHttpRequest(request).toUriString();
-		url = url.replace(request.getPath().toString(), "/");
+		if (!AntPathMatcher.DEFAULT_PATH_SEPARATOR.equals(request.getPath().toString()))
+			url = url.replace(request.getPath().toString(), "");
 		buildConfigUrl(contextPath, UriComponentsBuilder.fromUriString(url));
 		return contextPath;
 	}

springdoc-openapi-webflux-ui/src/main/java/org/springdoc/webflux/ui/SwaggerWelcomeWebFlux.java

@@ -28,12 +28,14 @@
 import org.springdoc.core.SwaggerUiConfigProperties;
 import reactor.core.publisher.Mono;
 
+import org.springframework.boot.autoconfigure.web.reactive.WebFluxProperties;
 import org.springframework.http.MediaType;
 import org.springframework.http.server.reactive.ServerHttpRequest;
 import org.springframework.http.server.reactive.ServerHttpResponse;
 import org.springframework.stereotype.Controller;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.ResponseBody;
+import org.springframework.web.util.UriComponentsBuilder;
 
 import static org.springdoc.core.Constants.SWAGGER_CONFIG_URL;
 import static org.springdoc.core.Constants.SWAGGER_UI_PATH;
@@ -45,15 +47,22 @@
 @Controller
 public class SwaggerWelcomeWebFlux extends SwaggerWelcomeCommon {
 
+	/**
+	 * The Webflux base path.
+	 */
+	private String webfluxBasePath;
+
 	/**
 	 * Instantiates a new Swagger welcome.
 	 *
 	 * @param swaggerUiConfig the swagger ui config
 	 * @param springDocConfigProperties the spring doc config properties
 	 * @param swaggerUiConfigParameters the swagger ui config parameters
+	 * @param webFluxProperties the web flux properties
 	 */
-	public SwaggerWelcomeWebFlux(SwaggerUiConfigProperties swaggerUiConfig, SpringDocConfigProperties springDocConfigProperties, SwaggerUiConfigParameters swaggerUiConfigParameters) {
+	public SwaggerWelcomeWebFlux(SwaggerUiConfigProperties swaggerUiConfig, SpringDocConfigProperties springDocConfigProperties, SwaggerUiConfigParameters swaggerUiConfigParameters, WebFluxProperties webFluxProperties) {
 		super(swaggerUiConfig, springDocConfigProperties, swaggerUiConfigParameters);
+		webfluxBasePath = webFluxProperties.getBasePath();
 	}
 
 	/**
@@ -90,4 +99,11 @@ protected void calculateUiRootPath(StringBuilder... sbUrls) {
 		calculateUiRootCommon(sbUrl, sbUrls);
 	}
 
+	@Override
+	protected void calculateOauth2RedirectUrl(UriComponentsBuilder uriComponentsBuilder) {
+		if (oauthPrefix == null && !swaggerUiConfigParameters.isValidUrl(swaggerUiConfigParameters.getOauth2RedirectUrl())) {
+			this.oauthPrefix = uriComponentsBuilder.path(webfluxBasePath).path(swaggerUiConfigParameters.getUiRootPath()).path(webJarsPrefixUrl);
+			swaggerUiConfigParameters.setOauth2RedirectUrl(this.oauthPrefix.path(swaggerUiConfigParameters.getOauth2RedirectUrl()).build().toString());
+		}
+	}
 }

springdoc-openapi-webflux-ui/src/test/java/test/org/springdoc/ui/app18/HelloController.java

@@ -0,0 +1,46 @@
+/*
+ *
+ *  * 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.ui.app18;
+
+import javax.validation.Valid;
+import javax.validation.constraints.Size;
+
+import org.springdoc.core.GroupedOpenApi;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestParam;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+public class HelloController {
+
+	@GetMapping(value = "/persons")
+	public void persons(@Valid @RequestParam @Size(min = 4, max = 6) String name) {
+
+	}
+
+	@Bean
+	public GroupedOpenApi userOpenApi() {
+		return GroupedOpenApi.builder()
+				.group("users")
+				.packagesToScan("test.org.springdoc.api.app145")
+				.build();
+	}
+}

springdoc-openapi-webflux-ui/src/test/java/test/org/springdoc/ui/app18/SpringDocApp18Test.java

@@ -0,0 +1,79 @@
+/*
+ *
+ *  * 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.ui.app18;
+
+import javax.annotation.PostConstruct;
+
+import org.junit.jupiter.api.Test;
+import reactor.core.publisher.Mono;
+import test.org.springdoc.ui.AbstractCommonTest;
+
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
+import org.springframework.boot.web.server.LocalServerPort;
+import org.springframework.http.HttpStatus;
+import org.springframework.web.reactive.function.client.WebClient;
+
+import static org.junit.jupiter.api.Assertions.assertTrue;
+import static org.skyscreamer.jsonassert.JSONAssert.assertEquals;
+
+
+@SpringBootTest(webEnvironment = WebEnvironment.DEFINED_PORT,
+		properties = { "spring.webflux.base-path=/test",
+				"server.port=9018",
+				"springdoc.swagger-ui.path=/documentation/swagger-ui.html",
+				"springdoc.api-docs.path=/documentation/v3/api-docs",
+				"spring.webflux.base-path=/test",
+				"springdoc.webjars.prefix= /webjars-pref" })
+class SpringDocApp18Test extends AbstractCommonTest {
+
+	@LocalServerPort
+	private int port;
+
+	private WebClient webClient;
+
+	@SpringBootApplication
+	static class SpringDocTestApp {}
+
+	@PostConstruct
+	void init(){
+		webClient =	WebClient.builder().baseUrl("http://localhost:"+port)
+				.build();
+	}
+
+	@Test
+	public void testIndexActuator() throws Exception {
+		HttpStatus httpStatusMono = webClient.get().uri("/test/documentation/swagger-ui.html")
+				.exchangeToMono(clientResponse -> Mono.just(clientResponse.statusCode())).block();
+		assertTrue(httpStatusMono.equals(HttpStatus.TEMPORARY_REDIRECT));
+
+		httpStatusMono = webClient.get().uri("/test/documentation/webjars-pref/swagger-ui/index.html")
+				.exchangeToMono(clientResponse -> Mono.just(clientResponse.statusCode())).block();
+		assertTrue(httpStatusMono.equals(HttpStatus.OK));
+
+		String contentAsString  = webClient.get().uri("/test/documentation/v3/api-docs/swagger-config").retrieve()
+				.bodyToMono(String.class).block();
+		String expected = getContent("results/app18-1.json");
+		assertEquals(expected, contentAsString, true);
+	}
+
+
+
+}

springdoc-openapi-webflux-ui/src/test/java/test/org/springdoc/ui/app19/HelloController.java

@@ -0,0 +1,46 @@
+/*
+ *
+ *  * 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.ui.app19;
+
+import javax.validation.Valid;
+import javax.validation.constraints.Size;
+
+import org.springdoc.core.GroupedOpenApi;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestParam;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+public class HelloController {
+
+	@GetMapping(value = "/persons")
+	public void persons(@Valid @RequestParam @Size(min = 4, max = 6) String name) {
+
+	}
+
+	@Bean
+	public GroupedOpenApi userOpenApi() {
+		return GroupedOpenApi.builder()
+				.group("users")
+				.packagesToScan("test.org.springdoc.api.app145")
+				.build();
+	}
+}