Spring/spring-boot
Spring/spring-boot
1
0
Fork 0
mirror of https://github.com/spring-projects/spring-boot.git synced 2024-08-29 03:06:45 +08:00
Code Issues Packages Projects Releases Wiki Activity

Avoid adding Jetty's upgrade filter to non-Jetty servers

Browse Source 
Fixes gh-38181
This commit is contained in:
Andy Wilkinson 2023-11-08 17:52:39 +00:00
parent 445d0a22db
commit b6a9c67719
2 changed files with 21 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/websocket/servlet/WebSocketServletAutoConfiguration.java
View File

@ -34,7 +34,8 @@ import org.springframework.boot.autoconfigure.condition.ConditionalOnNotWarDeplo
import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication; import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication.Type; import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication.Type;
import org.springframework.boot.autoconfigure.web.servlet.ServletWebServerFactoryAutoConfiguration; import org.springframework.boot.autoconfigure.web.servlet.ServletWebServerFactoryAutoConfiguration;
import org.springframework.boot.web.servlet.ServletContextInitializer; import org.springframework.boot.web.embedded.jetty.JettyServletWebServerFactory;
import org.springframework.boot.web.server.WebServerFactoryCustomizer;
import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Configuration;
import org.springframework.core.Ordered; import org.springframework.core.Ordered;
@ -91,13 +92,15 @@ public class WebSocketServletAutoConfiguration {
@Bean @Bean
@ConditionalOnNotWarDeployment @ConditionalOnNotWarDeployment
@Order(Ordered.LOWEST_PRECEDENCE) @Order(Ordered.LOWEST_PRECEDENCE)
@ConditionalOnMissingBean(name = "websocketUpgradeFilterServletContextInitializer") @ConditionalOnMissingBean(name = "websocketUpgradeFilterWebServerCustomizer")
ServletContextInitializer websocketUpgradeFilterServletContextInitializer() { WebServerFactoryCustomizer<JettyServletWebServerFactory> websocketUpgradeFilterWebServerCustomizer() {
return (servletContext) -> { return (factory) -> {
Dynamic registration = servletContext.addFilter(WebSocketUpgradeFilter.class.getName(), factory.addInitializers((servletContext) -> {
new WebSocketUpgradeFilter()); Dynamic registration = servletContext.addFilter(WebSocketUpgradeFilter.class.getName(),
registration.setAsyncSupported(true); new WebSocketUpgradeFilter());
registration.addMappingForUrlPatterns(EnumSet.of(DispatcherType.REQUEST), false, "/*"); registration.setAsyncSupported(true);
registration.addMappingForUrlPatterns(EnumSet.of(DispatcherType.REQUEST), false, "/*");
});
}; };
} }

11
spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/websocket/servlet/WebSocketServletAutoConfigurationTests.java
View File

@ -108,7 +108,7 @@ class WebSocketServletAutoConfigurationTests {
@Test @Test
@Servlet5ClassPathOverrides @Servlet5ClassPathOverrides
void jettyWebSocketUpgradeFilterIsAddedToServletContext() { void jettyWebSocketUpgradeFilterIsAddedToServletContextOfJettyServer() {
try (AnnotationConfigServletWebServerApplicationContext context = new AnnotationConfigServletWebServerApplicationContext( try (AnnotationConfigServletWebServerApplicationContext context = new AnnotationConfigServletWebServerApplicationContext(
JettyConfiguration.class, WebSocketServletAutoConfiguration.JettyWebSocketConfiguration.class)) { JettyConfiguration.class, WebSocketServletAutoConfiguration.JettyWebSocketConfiguration.class)) {
assertThat(context.getServletContext().getFilterRegistration(WebSocketUpgradeFilter.class.getName())) assertThat(context.getServletContext().getFilterRegistration(WebSocketUpgradeFilter.class.getName()))
@ -116,6 +116,15 @@ class WebSocketServletAutoConfigurationTests {
} }
} }
@Test
void jettyWebSocketUpgradeFilterIsNotAddedToServletContextOfTomcatServer() {
try (AnnotationConfigServletWebServerApplicationContext context = new AnnotationConfigServletWebServerApplicationContext(
TomcatConfiguration.class, WebSocketServletAutoConfiguration.JettyWebSocketConfiguration.class)) {
assertThat(context.getServletContext().getFilterRegistration(WebSocketUpgradeFilter.class.getName()))
.isNull();
}
}
@Test @Test
@SuppressWarnings("rawtypes") @SuppressWarnings("rawtypes")
void jettyWebSocketUpgradeFilterIsNotExposedAsABean() { void jettyWebSocketUpgradeFilterIsNotExposedAsABean() {