Return 406 status code if welcome page is not accepted
Add `WelcomePageNotAcceptableHandlerMapping` which will return an HTTP 406 status if a suitable welcome page is found but cannot be accepted for the request. An additional mapper is used so that we don't need to change the order of the `WelcomePageHandlerMapping`. It's possible that users may have additional root handler mappings registered to run after the `WelcomePageHandlerMapping` and we still need to respect those. Fixes gh-35552pull/35702/head
Phillip Webb
2 years ago
committed by
Andy Wilkinson
parent
cc2bb7cade
commit
418dd1ba5b
@ -0,0 +1,79 @@
|
||||
/*
|
||||
* Copyright 2012-2023 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 org.springframework.boot.autoconfigure.web.servlet;
|
||||
|
||||
import org.springframework.boot.autoconfigure.template.TemplateAvailabilityProviders;
|
||||
import org.springframework.context.ApplicationContext;
|
||||
import org.springframework.core.io.Resource;
|
||||
|
||||
/**
|
||||
* Details for a welcome page resolved from a resource or a template.
|
||||
*
|
||||
* @author Phillip Webb
|
||||
*/
|
||||
final class WelcomePage {
|
||||
|
||||
/**
|
||||
* Value used for an unresolved welcome page.
|
||||
*/
|
||||
static final WelcomePage UNRESOLVED = new WelcomePage(null, false);
|
||||
|
||||
private final String viewName;
|
||||
|
||||
private final boolean templated;
|
||||
|
||||
private WelcomePage(String viewName, boolean templated) {
|
||||
this.viewName = viewName;
|
||||
this.templated = templated;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the view name of the welcome page.
|
||||
* @return the view name
|
||||
*/
|
||||
String getViewName() {
|
||||
return this.viewName;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return if the welcome page is from a template.
|
||||
* @return if the welcome page is templated
|
||||
*/
|
||||
boolean isTemplated() {
|
||||
return this.templated;
|
||||
}
|
||||
|
||||
/**
|
||||
* Resolve the {@link WelcomePage} to use.
|
||||
* @param templateAvailabilityProviders the template availability providers
|
||||
* @param applicationContext the application context
|
||||
* @param indexHtmlResource the index HTML resource to use or {@code null}
|
||||
* @param staticPathPattern the static path pattern being used
|
||||
* @return a resolved {@link WelcomePage} instance or {@link #UNRESOLVED}
|
||||
*/
|
||||
static WelcomePage resolve(TemplateAvailabilityProviders templateAvailabilityProviders,
|
||||
ApplicationContext applicationContext, Resource indexHtmlResource, String staticPathPattern) {
|
||||
if (indexHtmlResource != null && "/**".equals(staticPathPattern)) {
|
||||
return new WelcomePage("forward:index.html", false);
|
||||
}
|
||||
if (templateAvailabilityProviders.getProvider("index", applicationContext) != null) {
|
||||
return new WelcomePage("index", true);
|
||||
}
|
||||
return UNRESOLVED;
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,58 @@
|
||||
/*
|
||||
* Copyright 2012-2023 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 org.springframework.boot.autoconfigure.web.servlet;
|
||||
|
||||
import javax.servlet.http.HttpServletRequest;
|
||||
import javax.servlet.http.HttpServletResponse;
|
||||
|
||||
import org.springframework.boot.autoconfigure.template.TemplateAvailabilityProviders;
|
||||
import org.springframework.context.ApplicationContext;
|
||||
import org.springframework.core.io.Resource;
|
||||
import org.springframework.http.HttpStatus;
|
||||
import org.springframework.web.servlet.ModelAndView;
|
||||
import org.springframework.web.servlet.handler.AbstractUrlHandlerMapping;
|
||||
import org.springframework.web.servlet.mvc.Controller;
|
||||
|
||||
/**
|
||||
* An {@link AbstractUrlHandlerMapping} for an application's welcome page that was
|
||||
* ultimately not accepted.
|
||||
*
|
||||
* @author Phillip Webb
|
||||
*/
|
||||
class WelcomePageNotAcceptableHandlerMapping extends AbstractUrlHandlerMapping {
|
||||
|
||||
WelcomePageNotAcceptableHandlerMapping(TemplateAvailabilityProviders templateAvailabilityProviders,
|
||||
ApplicationContext applicationContext, Resource indexHtmlResource, String staticPathPattern) {
|
||||
setOrder(LOWEST_PRECEDENCE - 10); // Before ResourceHandlerRegistry
|
||||
WelcomePage welcomePage = WelcomePage.resolve(templateAvailabilityProviders, applicationContext,
|
||||
indexHtmlResource, staticPathPattern);
|
||||
if (welcomePage != WelcomePage.UNRESOLVED) {
|
||||
setRootHandler((Controller) this::handleRequest);
|
||||
}
|
||||
}
|
||||
|
||||
private ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response) {
|
||||
response.setStatus(HttpStatus.NOT_ACCEPTABLE.value());
|
||||
return null;
|
||||
}
|
||||
|
||||
@Override
|
||||
protected Object getHandlerInternal(HttpServletRequest request) throws Exception {
|
||||
return super.getHandlerInternal(request);
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,144 @@
|
||||
/*
|
||||
* Copyright 2012-2023 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 org.springframework.boot.autoconfigure.web.servlet;
|
||||
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
import org.springframework.beans.factory.ObjectProvider;
|
||||
import org.springframework.beans.factory.annotation.Value;
|
||||
import org.springframework.boot.autoconfigure.AutoConfigurations;
|
||||
import org.springframework.boot.autoconfigure.context.PropertyPlaceholderAutoConfiguration;
|
||||
import org.springframework.boot.autoconfigure.template.TemplateAvailabilityProviders;
|
||||
import org.springframework.boot.test.context.runner.WebApplicationContextRunner;
|
||||
import org.springframework.context.ApplicationContext;
|
||||
import org.springframework.context.annotation.Bean;
|
||||
import org.springframework.context.annotation.Configuration;
|
||||
import org.springframework.core.Ordered;
|
||||
import org.springframework.core.io.FileSystemResource;
|
||||
import org.springframework.core.io.Resource;
|
||||
import org.springframework.http.HttpHeaders;
|
||||
import org.springframework.http.MediaType;
|
||||
import org.springframework.test.util.ReflectionTestUtils;
|
||||
import org.springframework.test.web.servlet.setup.MockMvcBuilders;
|
||||
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
|
||||
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
|
||||
|
||||
/**
|
||||
* Tests for {@link WelcomePageNotAcceptableHandlerMapping}.
|
||||
*
|
||||
* @author Phillip Webb
|
||||
*/
|
||||
class WelcomePageNotAcceptableHandlerMappingTests {
|
||||
|
||||
private final WebApplicationContextRunner contextRunner = new WebApplicationContextRunner()
|
||||
.withUserConfiguration(HandlerMappingConfiguration.class)
|
||||
.withConfiguration(AutoConfigurations.of(PropertyPlaceholderAutoConfiguration.class));
|
||||
|
||||
@Test
|
||||
void isOrderedAtLowPriorityButAboveResourceHandlerRegistry() {
|
||||
this.contextRunner.withUserConfiguration(StaticResourceConfiguration.class).run((context) -> {
|
||||
WelcomePageNotAcceptableHandlerMapping handler = context
|
||||
.getBean(WelcomePageNotAcceptableHandlerMapping.class);
|
||||
ResourceHandlerRegistry registry = new ResourceHandlerRegistry(context, null);
|
||||
Integer resourceOrder = (Integer) ReflectionTestUtils.getField(registry, "order");
|
||||
assertThat(handler.getOrder()).isEqualTo(Ordered.LOWEST_PRECEDENCE - 10);
|
||||
assertThat(handler.getOrder()).isLessThan(resourceOrder);
|
||||
});
|
||||
}
|
||||
|
||||
@Test
|
||||
void handlesRequestForStaticPageThatAcceptsTextHtml() {
|
||||
this.contextRunner.withUserConfiguration(StaticResourceConfiguration.class)
|
||||
.run((context) -> MockMvcBuilders.webAppContextSetup(context)
|
||||
.build()
|
||||
.perform(get("/").accept(MediaType.TEXT_HTML))
|
||||
.andExpect(status().isNotAcceptable()));
|
||||
}
|
||||
|
||||
@Test
|
||||
void handlesRequestForStaticPagetThatDoesNotAcceptTextHtml() {
|
||||
this.contextRunner.withUserConfiguration(StaticResourceConfiguration.class)
|
||||
.run((context) -> MockMvcBuilders.webAppContextSetup(context)
|
||||
.build()
|
||||
.perform(get("/").accept(MediaType.APPLICATION_JSON))
|
||||
.andExpect(status().isNotAcceptable()));
|
||||
}
|
||||
|
||||
@Test
|
||||
void handlesRequestWithNoAcceptHeader() {
|
||||
this.contextRunner.withUserConfiguration(StaticResourceConfiguration.class)
|
||||
.run((context) -> MockMvcBuilders.webAppContextSetup(context)
|
||||
.build()
|
||||
.perform(get("/"))
|
||||
.andExpect(status().isNotAcceptable()));
|
||||
}
|
||||
|
||||
@Test
|
||||
void handlesRequestWithEmptyAcceptHeader() {
|
||||
this.contextRunner.withUserConfiguration(StaticResourceConfiguration.class)
|
||||
.run((context) -> MockMvcBuilders.webAppContextSetup(context)
|
||||
.build()
|
||||
.perform(get("/").header(HttpHeaders.ACCEPT, ""))
|
||||
.andExpect(status().isNotAcceptable()));
|
||||
}
|
||||
|
||||
@Test
|
||||
void rootHandlerIsNotRegisteredWhenStaticPathPatternIsNotSlashStarStar() {
|
||||
this.contextRunner.withUserConfiguration(StaticResourceConfiguration.class)
|
||||
.withPropertyValues("static-path-pattern=/foo/**")
|
||||
.run((context) -> assertThat(context.getBean(WelcomePageNotAcceptableHandlerMapping.class).getRootHandler())
|
||||
.isNull());
|
||||
}
|
||||
|
||||
@Test
|
||||
void producesNotFoundResponseWhenThereIsNoWelcomePage() {
|
||||
this.contextRunner.run((context) -> MockMvcBuilders.webAppContextSetup(context)
|
||||
.build()
|
||||
.perform(get("/").accept(MediaType.TEXT_HTML))
|
||||
.andExpect(status().isNotFound()));
|
||||
}
|
||||
|
||||
@Configuration(proxyBeanMethods = false)
|
||||
static class HandlerMappingConfiguration {
|
||||
|
||||
@Bean
|
||||
WelcomePageNotAcceptableHandlerMapping handlerMapping(ApplicationContext applicationContext,
|
||||
ObjectProvider<TemplateAvailabilityProviders> templateAvailabilityProviders,
|
||||
ObjectProvider<Resource> staticIndexPage,
|
||||
@Value("${static-path-pattern:/**}") String staticPathPattern) {
|
||||
return new WelcomePageNotAcceptableHandlerMapping(
|
||||
templateAvailabilityProviders
|
||||
.getIfAvailable(() -> new TemplateAvailabilityProviders(applicationContext)),
|
||||
applicationContext, staticIndexPage.getIfAvailable(), staticPathPattern);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@Configuration(proxyBeanMethods = false)
|
||||
static class StaticResourceConfiguration {
|
||||
|
||||
@Bean
|
||||
Resource staticIndexPage() {
|
||||
return new FileSystemResource("src/test/resources/welcome-page/index.html");
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
Loading…
Reference in New Issue