Move server.error properties to spring.web.error

Closes gh-48201

Author: wilkinsona

core/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/WebProperties.java

@@ -24,6 +24,7 @@
 import org.jspecify.annotations.Nullable;
 
 import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.boot.context.properties.NestedConfigurationProperty;
 import org.springframework.boot.context.properties.PropertyMapper;
 import org.springframework.boot.convert.DurationUnit;
 import org.springframework.http.CacheControl;
@@ -50,6 +51,9 @@ public class WebProperties {
 
 	private final Resources resources = new Resources();
 
+	@NestedConfigurationProperty
+	private final ErrorProperties error = new ErrorProperties();
+
 	public @Nullable Locale getLocale() {
 		return this.locale;
 	}
@@ -66,6 +70,10 @@ public void setLocaleResolver(LocaleResolver localeResolver) {
 		this.localeResolver = localeResolver;
 	}
 
+	public ErrorProperties getError() {
+		return this.error;
+	}
+
 	public Resources getResources() {
 		return this.resources;
 	}

core/spring-boot-autoconfigure/src/main/resources/META-INF/spring-devtools.properties

@@ -1,3 +1,6 @@
 defaults.spring.template.provider.cache=false
+defaults.spring.web.error.include-binding-errors=always
+defaults.spring.web.error.include-message=always
+defaults.spring.web.error.include-stacktrace=always
 defaults.spring.web.resources.cache.period=0
 defaults.spring.web.resources.chain.cache=false

documentation/spring-boot-docs/src/docs/antora/modules/how-to/pages/spring-mvc.adoc

@@ -247,7 +247,7 @@ For more detail, see the following sections:
 
 Spring Boot installs a '`whitelabel`' error page that you see in a browser client if you encounter a server error (machine clients consuming JSON and other media types should see a sensible response with the right error code).
 
-NOTE: Set `server.error.whitelabel.enabled=false` to switch the default error page off.
+NOTE: Set configprop:spring.web.error.whitelabel.enabled[] to `false` to switch the default error page off.
 Doing so restores the default of the servlet container that you are using.
 Note that Spring Boot still tries to resolve the error view, so you should probably add your own error page rather than disabling it completely.
 

documentation/spring-boot-docs/src/docs/antora/modules/reference/pages/web/reactive.adoc

@@ -325,7 +325,7 @@ Usually, you would define the properties in your `application.properties` or `ap
 Common server settings include:
 
 * Network settings: Listen port for incoming HTTP requests (`server.port`), interface address to bind to (`server.address`), and so on.
-* Error management: Location of the error page (`server.error.path`) and so on.
+* Error management: Location of the error page (configprop:spring.web.error.path[]) and so on.
 * xref:how-to:webserver.adoc#howto.webserver.configure-ssl[SSL]
 * xref:how-to:webserver.adoc#howto.webserver.enable-response-compression[HTTP compression]
 

documentation/spring-boot-docs/src/docs/antora/modules/reference/pages/web/servlet.adoc

@@ -636,7 +636,7 @@ Common server settings include:
 
 * Network settings: Listen port for incoming HTTP requests (`server.port`), interface address to bind to (`server.address`), and so on.
 * Session settings: Whether the session is persistent (`server.servlet.session.persistent`), session timeout (`server.servlet.session.timeout`), location of session data (`server.servlet.session.store-dir`), and session-cookie configuration (`server.servlet.session.cookie.*`).
-* Error management: Location of the error page (`server.error.path`) and so on.
+* Error management: Location of the error page (configprop:spring.web.error.path[]) and so on.
 * xref:how-to:webserver.adoc#howto.webserver.configure-ssl[SSL]
 * xref:how-to:webserver.adoc#howto.webserver.enable-response-compression[HTTP compression]
 

integration-test/spring-boot-actuator-integration-tests/src/test/java/org/springframework/boot/actuate/endpoint/web/annotation/AbstractWebEndpointIntegrationTests.java

@@ -706,7 +706,7 @@ private void load(Consumer<T> contextCustomizer, String endpointPath,
 		contextCustomizer.accept(applicationContext);
 		Map<String, Object> properties = new HashMap<>();
 		properties.put("endpointPath", endpointPath);
-		properties.put("server.error.include-message", "always");
+		properties.put("spring.web.error.include-message", "always");
 		applicationContext.getEnvironment().getPropertySources().addLast(new MapPropertySource("test", properties));
 		applicationContext.refresh();
 		try {

module/spring-boot-devtools/src/test/java/org/springframework/boot/devtools/autoconfigure/LocalDevToolsAutoConfigurationTests.java

@@ -286,8 +286,7 @@ LiveReloadServer liveReloadServer() {
 	}
 
 	@Configuration(proxyBeanMethods = false)
-	@Import({ TomcatServletWebServerAutoConfiguration.class, LocalDevToolsAutoConfiguration.class,
-			WebProperties.class })
+	@Import({ TomcatServletWebServerAutoConfiguration.class, LocalDevToolsAutoConfiguration.class })
 	static class WebResourcesConfig {
 
 	}

module/spring-boot-tomcat/src/main/java/org/springframework/boot/tomcat/autoconfigure/TomcatWebServerConfiguration.java

@@ -21,6 +21,8 @@
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnNotWarDeployment;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnThreading;
+import org.springframework.boot.autoconfigure.web.WebProperties;
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.boot.thread.Threading;
 import org.springframework.boot.tomcat.autoconfigure.reactive.TomcatReactiveWebServerAutoConfiguration;
 import org.springframework.boot.tomcat.autoconfigure.servlet.TomcatServletWebServerAutoConfiguration;
@@ -39,12 +41,13 @@
  */
 @ConditionalOnNotWarDeployment
 @Configuration(proxyBeanMethods = false)
+@EnableConfigurationProperties(WebProperties.class)
 public class TomcatWebServerConfiguration {
 
 	@Bean
 	TomcatWebServerFactoryCustomizer tomcatWebServerFactoryCustomizer(Environment environment,
-			ServerProperties serverProperties, TomcatServerProperties tomcatProperties) {
-		return new TomcatWebServerFactoryCustomizer(environment, serverProperties, tomcatProperties);
+			ServerProperties serverProperties, TomcatServerProperties tomcatProperties, WebProperties webProperties) {
+		return new TomcatWebServerFactoryCustomizer(environment, serverProperties, tomcatProperties, webProperties);
 	}
 
 	@Bean

module/spring-boot-tomcat/src/main/java/org/springframework/boot/tomcat/autoconfigure/TomcatWebServerFactoryCustomizer.java

@@ -34,6 +34,7 @@
 
 import org.springframework.boot.autoconfigure.web.ErrorProperties;
 import org.springframework.boot.autoconfigure.web.ErrorProperties.IncludeAttribute;
+import org.springframework.boot.autoconfigure.web.WebProperties;
 import org.springframework.boot.cloud.CloudPlatform;
 import org.springframework.boot.context.properties.PropertyMapper;
 import org.springframework.boot.tomcat.ConfigurableTomcatWebServerFactory;
@@ -77,11 +78,14 @@ public class TomcatWebServerFactoryCustomizer
 
 	private final TomcatServerProperties tomcatProperties;
 
+	private final WebProperties webProperties;
+
 	public TomcatWebServerFactoryCustomizer(Environment environment, ServerProperties serverProperties,
-			TomcatServerProperties tomcatProperties) {
+			TomcatServerProperties tomcatProperties, WebProperties webProperties) {
 		this.environment = environment;
 		this.serverProperties = serverProperties;
 		this.tomcatProperties = tomcatProperties;
+		this.webProperties = webProperties;
 	}
 
 	@Override
@@ -161,7 +165,7 @@ public void customize(ConfigurableTomcatWebServerFactory factory) {
 			.as((enable) -> !enable)
 			.to(factory::setDisableMBeanRegistry);
 		customizeStaticResources(factory);
-		customizeErrorReportValve(this.serverProperties.getError(), factory);
+		customizeErrorReportValve(this.webProperties.getError(), factory);
 		factory.setUseApr(getUseApr(this.tomcatProperties.getUseApr()));
 	}
 

module/spring-boot-tomcat/src/test/java/org/springframework/boot/tomcat/autoconfigure/TomcatWebServerFactoryCustomizerTests.java

@@ -34,6 +34,7 @@
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 
+import org.springframework.boot.autoconfigure.web.WebProperties;
 import org.springframework.boot.context.properties.bind.Bindable;
 import org.springframework.boot.context.properties.bind.Binder;
 import org.springframework.boot.context.properties.source.ConfigurationPropertySources;
@@ -74,13 +75,15 @@ class TomcatWebServerFactoryCustomizerTests {
 
 	private final TomcatServerProperties tomcatProperties = new TomcatServerProperties();
 
+	private final WebProperties webProperties = new WebProperties();
+
 	private TomcatWebServerFactoryCustomizer customizer;
 
 	@BeforeEach
 	void setup() {
 		ConfigurationPropertySources.attach(this.environment);
 		this.customizer = new TomcatWebServerFactoryCustomizer(this.environment, this.serverProperties,
-				this.tomcatProperties);
+				this.tomcatProperties, this.webProperties);
 	}
 
 	@Test