From 4972d18dd690ecae5bec86913d5b5fbe85c34fa8 Mon Sep 17 00:00:00 2001 From: jerzykrlk Date: Mon, 20 Aug 2018 21:15:02 +0200 Subject: [PATCH] Include URL and HTTP method in DefaultResponseErrorHandler See gh-28958 --- .../client/DefaultResponseErrorHandler.java | 59 +++++++++++++++++-- .../ExtractingResponseErrorHandler.java | 9 ++- .../DefaultResponseErrorHandlerTests.java | 18 ++++++ .../client/RestTemplateIntegrationTests.java | 4 +- 4 files changed, 82 insertions(+), 8 deletions(-) diff --git a/spring-web/src/main/java/org/springframework/web/client/DefaultResponseErrorHandler.java b/spring-web/src/main/java/org/springframework/web/client/DefaultResponseErrorHandler.java index bd1fc19e4f1..90ca31b3c90 100644 --- a/spring-web/src/main/java/org/springframework/web/client/DefaultResponseErrorHandler.java +++ b/spring-web/src/main/java/org/springframework/web/client/DefaultResponseErrorHandler.java @@ -19,6 +19,7 @@ package org.springframework.web.client; import java.io.ByteArrayInputStream; import java.io.IOException; import java.io.InputStream; +import java.net.URI; import java.nio.charset.Charset; import java.nio.charset.StandardCharsets; import java.util.Collections; @@ -28,6 +29,7 @@ import java.util.function.Function; import org.springframework.core.ResolvableType; import org.springframework.core.log.LogFormatUtils; import org.springframework.http.HttpHeaders; +import org.springframework.http.HttpMethod; import org.springframework.http.HttpStatus; import org.springframework.http.HttpStatusCode; import org.springframework.http.MediaType; @@ -129,12 +131,33 @@ public class DefaultResponseErrorHandler implements ResponseErrorHandler { * {@link HttpStatus} enum range. * * @throws UnknownHttpStatusCodeException in case of an unresolvable status code - * @see #handleError(ClientHttpResponse, HttpStatusCode) + * @see #handleError(URI, HttpMethod, ClientHttpResponse, HttpStatusCode) */ @Override public void handleError(ClientHttpResponse response) throws IOException { + handleError(null, null, response); + } + + /** + * Handle the error in the given response with the given resolved status code. + *

The default implementation throws: + *

+ * @throws UnknownHttpStatusCodeException in case of an unresolvable status code + * @see #handleError(URI, HttpMethod, ClientHttpResponse, HttpStatusCode) + */ + @Override + public void handleError(URI url, HttpMethod method, ClientHttpResponse response) throws IOException { HttpStatusCode statusCode = response.getStatusCode(); - handleError(response, statusCode); + handleError(url, method, response, statusCode); } /** @@ -144,10 +167,9 @@ public class DefaultResponseErrorHandler implements ResponseErrorHandler { * */ private String getErrorMessage( - int rawStatusCode, String statusText, @Nullable byte[] responseBody, @Nullable Charset charset) { - - String preface = rawStatusCode + " " + statusText + ": "; + int rawStatusCode, String statusText, @Nullable byte[] responseBody, @Nullable Charset charset, @Nullable URI url, @Nullable HttpMethod method) { + String preface = getPreface(rawStatusCode, statusText, url, method); if (ObjectUtils.isEmpty(responseBody)) { return preface + "[no body]"; } @@ -160,6 +182,15 @@ public class DefaultResponseErrorHandler implements ResponseErrorHandler { return preface + bodyText; } + private String getPreface(int rawStatusCode, String statusText, @Nullable URI url, @Nullable HttpMethod method) { + StringBuilder preface = new StringBuilder(rawStatusCode + " " + statusText); + if (!ObjectUtils.isEmpty(method) && !ObjectUtils.isEmpty(url)) { + preface.append(" after ").append(method).append(" ").append(url).append(" "); + } + preface.append(": "); + return preface.toString(); + } + /** * Handle the error based on the resolved status code. * @@ -172,11 +203,27 @@ public class DefaultResponseErrorHandler implements ResponseErrorHandler { * @see HttpServerErrorException#create */ protected void handleError(ClientHttpResponse response, HttpStatusCode statusCode) throws IOException { + handleError(null, null, response, statusCode); + } + + /** + * Handle the error based on the resolved status code. + * + *

The default implementation delegates to + * {@link HttpClientErrorException#create} for errors in the 4xx range, to + * {@link HttpServerErrorException#create} for errors in the 5xx range, + * or otherwise raises {@link UnknownHttpStatusCodeException}. + * @since 5.0 + * @see HttpClientErrorException#create + * @see HttpServerErrorException#create + */ + protected void handleError(@Nullable URI url, @Nullable HttpMethod method, ClientHttpResponse response, + HttpStatusCode statusCode) throws IOException { String statusText = response.getStatusText(); HttpHeaders headers = response.getHeaders(); byte[] body = getResponseBody(response); Charset charset = getCharset(response); - String message = getErrorMessage(statusCode.value(), statusText, body, charset); + String message = getErrorMessage(statusCode.value(), statusText, body, charset, url, method); RestClientResponseException ex; if (statusCode.is4xxClientError()) { diff --git a/spring-web/src/main/java/org/springframework/web/client/ExtractingResponseErrorHandler.java b/spring-web/src/main/java/org/springframework/web/client/ExtractingResponseErrorHandler.java index 4357be4d272..533a20fc5f7 100644 --- a/spring-web/src/main/java/org/springframework/web/client/ExtractingResponseErrorHandler.java +++ b/spring-web/src/main/java/org/springframework/web/client/ExtractingResponseErrorHandler.java @@ -17,11 +17,13 @@ package org.springframework.web.client; import java.io.IOException; +import java.net.URI; import java.util.Collections; import java.util.LinkedHashMap; import java.util.List; import java.util.Map; +import org.springframework.http.HttpMethod; import org.springframework.http.HttpStatus; import org.springframework.http.HttpStatusCode; import org.springframework.http.client.ClientHttpResponse; @@ -149,8 +151,13 @@ public class ExtractingResponseErrorHandler extends DefaultResponseErrorHandler } } + @Override + public void handleError(URI url, HttpMethod method, ClientHttpResponse response) throws IOException { + handleError(response, response.getStatusCode()); + } + private void extract(@Nullable Class exceptionClass, - ClientHttpResponse response) throws IOException { + ClientHttpResponse response) throws IOException { if (exceptionClass == null) { return; diff --git a/spring-web/src/test/java/org/springframework/web/client/DefaultResponseErrorHandlerTests.java b/spring-web/src/test/java/org/springframework/web/client/DefaultResponseErrorHandlerTests.java index 640abf0b877..8c2622576f3 100644 --- a/spring-web/src/test/java/org/springframework/web/client/DefaultResponseErrorHandlerTests.java +++ b/spring-web/src/test/java/org/springframework/web/client/DefaultResponseErrorHandlerTests.java @@ -18,11 +18,13 @@ package org.springframework.web.client; import java.io.ByteArrayInputStream; import java.io.IOException; +import java.net.URI; import java.nio.charset.StandardCharsets; import org.junit.jupiter.api.Test; import org.springframework.http.HttpHeaders; +import org.springframework.http.HttpMethod; import org.springframework.http.HttpStatus; import org.springframework.http.HttpStatusCode; import org.springframework.http.MediaType; @@ -77,6 +79,22 @@ class DefaultResponseErrorHandlerTests { .satisfies(ex -> assertThat(ex.getResponseHeaders()).isEqualTo(headers)); } + @Test + public void handleErrorWithUrlAndMethod() throws Exception { + HttpHeaders headers = new HttpHeaders(); + headers.setContentType(MediaType.TEXT_PLAIN); + + given(response.getStatusCode()).willReturn(HttpStatus.NOT_FOUND); + given(response.getStatusText()).willReturn("Not Found"); + given(response.getHeaders()).willReturn(headers); + given(response.getBody()).willReturn(new ByteArrayInputStream("Hello World".getBytes(StandardCharsets.UTF_8))); + + assertThatExceptionOfType(HttpClientErrorException.class) + .isThrownBy(() -> handler.handleError(URI.create("https://example.com"), HttpMethod.GET, response)) + .withMessage("404 Not Found after GET https://example.com : \"Hello World\"") + .satisfies(ex -> assertThat(ex.getResponseHeaders()).isSameAs(headers)); + } + @Test void handleErrorIOException() throws Exception { HttpHeaders headers = new HttpHeaders(); diff --git a/spring-web/src/test/java/org/springframework/web/client/RestTemplateIntegrationTests.java b/spring-web/src/test/java/org/springframework/web/client/RestTemplateIntegrationTests.java index 6f20c7ff110..30c5b237308 100644 --- a/spring-web/src/test/java/org/springframework/web/client/RestTemplateIntegrationTests.java +++ b/spring-web/src/test/java/org/springframework/web/client/RestTemplateIntegrationTests.java @@ -247,6 +247,7 @@ class RestTemplateIntegrationTests extends AbstractMockWebServerTests { assertThat(ex.getStatusCode()).isEqualTo(HttpStatus.NOT_FOUND); assertThat(ex.getStatusText()).isNotNull(); assertThat(ex.getResponseBodyAsString()).isNotNull(); + assertThat(ex.getMessage()).isEqualTo("404 Client Error after GET http://localhost:" + port + "/status/notfound : [no body]"); }); } @@ -259,7 +260,7 @@ class RestTemplateIntegrationTests extends AbstractMockWebServerTests { .satisfies(ex -> { assertThat(ex.getStatusCode()).isEqualTo(HttpStatus.BAD_REQUEST); assumeFalse(clientHttpRequestFactory instanceof JdkClientHttpRequestFactory, "JDK HttpClient does not expose status text"); - assertThat(ex.getMessage()).isEqualTo("400 Client Error: [no body]"); + assertThat(ex.getMessage()).isEqualTo("400 Client Error after GET http://localhost:" + port + "/status/badrequest : [no body]"); }); } @@ -273,6 +274,7 @@ class RestTemplateIntegrationTests extends AbstractMockWebServerTests { assertThat(ex.getStatusCode()).isEqualTo(HttpStatus.INTERNAL_SERVER_ERROR); assertThat(ex.getStatusText()).isNotNull(); assertThat(ex.getResponseBodyAsString()).isNotNull(); + assertThat(ex.getMessage()).isEqualTo("500 Server Error after GET http://localhost:" + port + "/status/server : [no body]"); }); }