Spring/spring-boot
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Support server.error.whitelabel.enabled in WebFlux

Browse Source 
This commit disables the default HTML view in the WebFlux error handling
support when `server.error.whitelabel.enabled=false`.
In this case, the original exception will be forwarded down the stream
and handled by the default `WebExceptionHandler` provided by Spring
WebFlux (likely to respond a blank page and an error HTTP response
status).

Closes gh-12520
This commit is contained in:
Brian Clozel
2018-03-16 16:54:34 +01:00
parent 161ecc0575
commit 0162978c78
2 changed files with 50 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/reactive/error/DefaultErrorWebExceptionHandler.java
View File

@@ -121,12 +121,18 @@ public class DefaultErrorWebExceptionHandler extends AbstractErrorWebExceptionHa
HttpStatus errorStatus = getHttpStatus(error);
ServerResponse.BodyBuilder response = ServerResponse.status(errorStatus)
.contentType(MediaType.TEXT_HTML);
return Flux
Flux<ServerResponse> result = Flux
.just("error/" + errorStatus.toString(),
"error/" + SERIES_VIEWS.get(errorStatus.series()), "error/error")
.flatMap((viewName) -> renderErrorView(viewName, response, error))
.switchIfEmpty(renderDefaultErrorView(response, error)).next()
.doOnNext((resp) -> logError(request, errorStatus));
.flatMap((viewName) -> renderErrorView(viewName, response, error));
if (this.errorProperties.getWhitelabel().isEnabled()) {
result = result.switchIfEmpty(renderDefaultErrorView(response, error));
}
else {
Throwable ex = getError(request);
result = result.switchIfEmpty(Mono.error(ex));
}
return result.next().doOnNext((resp) -> logError(request, errorStatus));
}
/**

62
spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/web/reactive/error/DefaultErrorWebExceptionHandlerIntegrationTests.java
View File

@@ -74,7 +74,7 @@ public class DefaultErrorWebExceptionHandlerIntegrationTests {
public OutputCapture output = new OutputCapture();
@Test
public void jsonError() throws Exception {
public void jsonError() {
this.contextRunner.run((context) -> {
WebTestClient client = WebTestClient.bindToApplicationContext(context)
.build();
@@ -91,12 +91,13 @@ public class DefaultErrorWebExceptionHandlerIntegrationTests {
}
@Test
public void notFound() throws Exception {
public void notFound() {
this.contextRunner.run((context) -> {
WebTestClient client = WebTestClient.bindToApplicationContext(context)
.build();
client.get().uri("/notFound").exchange().expectStatus()
.isEqualTo(HttpStatus.NOT_FOUND).expectBody().jsonPath("status")
client.get().uri("/notFound").exchange()
.expectStatus().isNotFound()
.expectBody().jsonPath("status")
.isEqualTo("404").jsonPath("error")
.isEqualTo(HttpStatus.NOT_FOUND.getReasonPhrase()).jsonPath("path")
.isEqualTo(("/notFound")).jsonPath("exception").doesNotExist();
@@ -104,7 +105,7 @@ public class DefaultErrorWebExceptionHandlerIntegrationTests {
}
@Test
public void htmlError() throws Exception {
public void htmlError() {
this.contextRunner.run((context) -> {
WebTestClient client = WebTestClient.bindToApplicationContext(context)
.build();
@@ -119,13 +120,14 @@ public class DefaultErrorWebExceptionHandlerIntegrationTests {
}
@Test
public void bindingResultError() throws Exception {
public void bindingResultError() {
this.contextRunner.run((context) -> {
WebTestClient client = WebTestClient.bindToApplicationContext(context)
.build();
client.post().uri("/bind").contentType(MediaType.APPLICATION_JSON)
.syncBody("{}").exchange().expectStatus()
.isEqualTo(HttpStatus.BAD_REQUEST).expectBody().jsonPath("status")
.syncBody("{}").exchange()
.expectStatus().isBadRequest()
.expectBody().jsonPath("status")
.isEqualTo("400").jsonPath("error")
.isEqualTo(HttpStatus.BAD_REQUEST.getReasonPhrase()).jsonPath("path")
.isEqualTo(("/bind")).jsonPath("exception").doesNotExist()
@@ -137,7 +139,7 @@ public class DefaultErrorWebExceptionHandlerIntegrationTests {
}
@Test
public void includeStackTraceOnParam() throws Exception {
public void includeStackTraceOnParam() {
this.contextRunner
.withPropertyValues("server.error.include-exception=true",
"server.error.include-stacktrace=on-trace-param")
@@ -171,7 +173,7 @@ public class DefaultErrorWebExceptionHandlerIntegrationTests {
}
@Test
public void neverIncludeStackTrace() throws Exception {
public void neverIncludeStackTrace() {
this.contextRunner.withPropertyValues("server.error.include-exception=true",
"server.error.include-stacktrace=never").run((context) -> {
WebTestClient client = WebTestClient.bindToApplicationContext(context)
@@ -188,14 +190,15 @@ public class DefaultErrorWebExceptionHandlerIntegrationTests {
}
@Test
public void statusException() throws Exception {
public void statusException() {
this.contextRunner.withPropertyValues("server.error.include-exception=true")
.run((context) -> {
WebTestClient client = WebTestClient.bindToApplicationContext(context)
.build();
client.get().uri("/badRequest").exchange().expectStatus()
.isEqualTo(HttpStatus.BAD_REQUEST).expectBody()
.jsonPath("status").isEqualTo("400").jsonPath("error")
client.get().uri("/badRequest").exchange()
.expectStatus().isBadRequest()
.expectBody().jsonPath("status").isEqualTo("400")
.jsonPath("error")
.isEqualTo(HttpStatus.BAD_REQUEST.getReasonPhrase())
.jsonPath("exception")
.isEqualTo(ResponseStatusException.class.getName());
@@ -204,7 +207,7 @@ public class DefaultErrorWebExceptionHandlerIntegrationTests {
}
@Test
public void defaultErrorView() throws Exception {
public void defaultErrorView() {
this.contextRunner
.withPropertyValues("spring.mustache.prefix=classpath:/unknown/")
.run((context) -> {
@@ -224,7 +227,7 @@ public class DefaultErrorWebExceptionHandlerIntegrationTests {
}
@Test
public void escapeHtmlInDefaultErrorView() throws Exception {
public void escapeHtmlInDefaultErrorView() {
this.contextRunner
.withPropertyValues("spring.mustache.prefix=classpath:/unknown/")
.run((context) -> {
@@ -244,24 +247,24 @@ public class DefaultErrorWebExceptionHandlerIntegrationTests {
}
@Test
public void testExceptionWithNullMessage() throws Exception {
public void testExceptionWithNullMessage() {
this.contextRunner
.withPropertyValues("spring.mustache.prefix=classpath:/unknown/")
.run((context) -> {
WebTestClient client = WebTestClient.bindToApplicationContext(context)
.build();
String body = client.get().uri("/notfound")
.accept(MediaType.TEXT_HTML).exchange().expectStatus()
.isEqualTo(HttpStatus.NOT_FOUND).expectHeader()
.contentType(MediaType.TEXT_HTML).expectBody(String.class)
.returnResult().getResponseBody();
.accept(MediaType.TEXT_HTML).exchange()
.expectStatus().isNotFound()
.expectHeader().contentType(MediaType.TEXT_HTML)
.expectBody(String.class).returnResult().getResponseBody();
assertThat(body).contains("Whitelabel Error Page")
.contains("type=Not Found, status=404");
});
}
@Test
public void responseCommitted() throws Exception {
public void responseCommitted() {
this.contextRunner.run((context) -> {
WebTestClient client = WebTestClient.bindToApplicationContext(context)
.build();
@@ -271,6 +274,21 @@ public class DefaultErrorWebExceptionHandlerIntegrationTests {
});
}
@Test
public void whilelabelDisabled() {
this.contextRunner
.withPropertyValues("server.error.whitelabel.enabled=false",
"spring.mustache.prefix=classpath:/unknown/")
.run((context) -> {
WebTestClient client = WebTestClient.bindToApplicationContext(context)
.build();
client.get().uri("/notfound")
.accept(MediaType.TEXT_HTML).exchange()
.expectStatus().isNotFound()
.expectBody().isEmpty();
});
}
@Configuration
public static class Application {