1849: fix forwarding filter for webflux base-paths (codecentric#1853)

* 1849: fix forwarding filter for webflux base-paths * 1849: fix include-filters when webflux base-paths is configured * 1849: simplify include-filters when webflux base-paths is configured

Author: ulischulte

spring-boot-admin-server-ui/pom.xml

@@ -132,6 +132,7 @@
  <includeEmptyDirs>true</includeEmptyDirs>
  </configuration>
  </plugin>
+
  </plugins>
  <resources>
  <resource>
@@ -144,4 +145,20 @@
  </resource>
  </resources>
  </build>
+ <profiles>
+ <profile>
+ <id>noNpm</id>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>com.github.eirslett</groupId>
+ <artifactId>frontend-maven-plugin</artifactId>
+ <configuration>
+ <skip>true</skip>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+ </profile>
+ </profiles>
 </project>

spring-boot-admin-server-ui/src/main/java/de/codecentric/boot/admin/server/ui/config/AdminServerUiAutoConfiguration.java

@@ -28,6 +28,7 @@
 import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
+import org.springframework.boot.autoconfigure.web.reactive.WebFluxProperties;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.context.ApplicationContext;
 import org.springframework.context.annotation.Bean;
@@ -124,20 +125,6 @@ public SpringResourceTemplateResolver adminTemplateResolver() {
 return resolver;
 }
 
-@Bean
-public HomepageForwardingFilterConfig homepageForwardingFilterConfig() throws IOException {
-String homepage = this.adminServer.path("/");
-
-List<String> extensionRoutes = new UiRoutesScanner(this.applicationContext)
-.scan(this.adminUi.getExtensionResourceLocations());
-List<String> routesIncludes = Stream.concat(DEFAULT_UI_ROUTES.stream(), extensionRoutes.stream())
-.map(this.adminServer::path).collect(Collectors.toList());
-List<String> routesExcludes = DEFAULT_UI_ROUTE_EXCLUDES.stream().map(this.adminServer::path)
-.collect(Collectors.toList());
-
-return new HomepageForwardingFilterConfig(homepage, routesIncludes, routesExcludes);
-}
-
 @Configuration(proxyBeanMethods = false)
 @ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.REACTIVE)
 public static class ReactiveUiConfiguration {
@@ -149,15 +136,36 @@ public static class AdminUiWebfluxConfig implements WebFluxConfigurer {
 
 private final AdminServerProperties adminServer;
 
+private final WebFluxProperties webFluxProperties;
+
 private final ApplicationContext applicationContext;
 
 public AdminUiWebfluxConfig(AdminServerUiProperties adminUi, AdminServerProperties adminServer,
-ApplicationContext applicationContext) {
+WebFluxProperties webFluxProperties, ApplicationContext applicationContext) {
 this.adminUi = adminUi;
 this.adminServer = adminServer;
+this.webFluxProperties = webFluxProperties;
 this.applicationContext = applicationContext;
 }
 
+@Bean
+public HomepageForwardingFilterConfig homepageForwardingFilterConfig() throws IOException {
+String webFluxBasePath = webFluxProperties.getBasePath();
+boolean webfluxBasePathSet = webFluxBasePath != null;
+String homepage = webfluxBasePathSet ? webFluxBasePath + "/" : this.adminServer.path("/");
+
+List<String> extensionRoutes = new UiRoutesScanner(this.applicationContext)
+.scan(this.adminUi.getExtensionResourceLocations());
+List<String> routesIncludes = Stream.concat(DEFAULT_UI_ROUTES.stream(), extensionRoutes.stream())
+.map(this.adminServer::path).collect(Collectors.toList());
+routesIncludes.add("");
+
+List<String> routesExcludes = DEFAULT_UI_ROUTE_EXCLUDES.stream().map(this.adminServer::path)
+.collect(Collectors.toList());
+
+return new HomepageForwardingFilterConfig(homepage, routesIncludes, routesExcludes);
+}
+
 @Override
 public void addResourceHandlers(org.springframework.web.reactive.config.ResourceHandlerRegistry registry) {
 registry.addResourceHandler(this.adminServer.path("/**"))
@@ -200,6 +208,20 @@ public AdminUiWebMvcConfig(AdminServerUiProperties adminUi, AdminServerPropertie
 this.applicationContext = applicationContext;
 }
 
+@Bean
+public HomepageForwardingFilterConfig homepageForwardingFilterConfig() throws IOException {
+String homepage = this.adminServer.path("/");
+
+List<String> extensionRoutes = new UiRoutesScanner(this.applicationContext)
+.scan(this.adminUi.getExtensionResourceLocations());
+List<String> routesIncludes = Stream.concat(DEFAULT_UI_ROUTES.stream(), extensionRoutes.stream())
+.map(this.adminServer::path).collect(Collectors.toList());
+List<String> routesExcludes = DEFAULT_UI_ROUTE_EXCLUDES.stream().map(this.adminServer::path)
+.collect(Collectors.toList());
+
+return new HomepageForwardingFilterConfig(homepage, routesIncludes, routesExcludes);
+}
+
 @Override
 public void addResourceHandlers(
 org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry registry) {

spring-boot-admin-server-ui/src/main/java/de/codecentric/boot/admin/server/ui/web/HomepageForwardingFilterConfig.java

@@ -23,10 +23,13 @@
 @Value
 public class HomepageForwardingFilterConfig {
 
-private final String homepage;
+String homepage;
 
-private final List<String> routesIncludes;
+List<String> routesIncludes;
 
-private final List<String> routesExcludes;
+/**
+ * routes which are excluded intentionally (for instance downloads)
+ */
+List<String> routesExcludes;
 
 }

spring-boot-admin-server-ui/src/test/java/de/codecentric/boot/admin/server/ui/config/AdminServerUiAutoConfigurationTest.java

@@ -27,6 +27,7 @@
 import org.mockito.Mock;
 import org.mockito.junit.jupiter.MockitoExtension;
 import org.springframework.boot.autoconfigure.AutoConfigurations;
+import org.springframework.boot.autoconfigure.web.reactive.WebFluxProperties;
 import org.springframework.boot.test.context.runner.ReactiveWebApplicationContextRunner;
 import org.springframework.boot.test.context.runner.WebApplicationContextRunner;
 import org.springframework.http.HttpHeaders;
@@ -57,9 +58,8 @@ public class AdminServerUiAutoConfigurationTest implements WithAssertions {
 public class ReactiveUiConfigurationTest {
 
 private final ReactiveWebApplicationContextRunner contextRunner = new ReactiveWebApplicationContextRunner()
-.withPropertyValues("--spring.boot.admin.ui.available-languages=de",
-"--spring.boot.admin.contextPath=test")
-.withBean(AdminServerProperties.class)
+.withPropertyValues("--spring.boot.admin.ui.available-languages=de", "--spring.webflux.base-path=test")
+.withBean(AdminServerProperties.class).withBean(WebFluxProperties.class)
 .withConfiguration(AutoConfigurations.of(AdminServerUiAutoConfiguration.class));
 
 @Mock