This is an automated email from the ASF dual-hosted git repository. kwin pushed a commit to branch feature/log-error-body in repository https://gitbox.apache.org/repos/asf/maven-resolver.git
commit e1eeeffa80cca826e56c048291131268120146c5 Author: Konrad Windszus <[email protected]> AuthorDate: Sun Nov 8 18:46:17 2026 +0100 Wrap truncated response body in HttpTransporterException Make HttpRFC9457Exception extend HttpTransporterException (to correct classification) This closes #1844 --- .../transport/http/HttpTransporterException.java | 45 ++++++++++++++++++- .../http/RFC9457/HttpRFC9457Exception.java | 22 ++-------- .../transport/http/RFC9457/RFC9457Reporter.java | 31 +++++++++---- .../http/RFC9457/RFC9457ReporterTest.java | 51 +++++++++------------- .../aether/transport/apache/ApacheTransporter.java | 19 +++----- .../aether/transport/jdk/JdkTransporter.java | 8 +--- .../aether/transport/jetty/JettyTransporter.java | 8 +--- 7 files changed, 100 insertions(+), 84 deletions(-) diff --git a/maven-resolver-spi/src/main/java/org/eclipse/aether/spi/connector/transport/http/HttpTransporterException.java b/maven-resolver-spi/src/main/java/org/eclipse/aether/spi/connector/transport/http/HttpTransporterException.java index 06a440493..286dfc9f2 100644 --- a/maven-resolver-spi/src/main/java/org/eclipse/aether/spi/connector/transport/http/HttpTransporterException.java +++ b/maven-resolver-spi/src/main/java/org/eclipse/aether/spi/connector/transport/http/HttpTransporterException.java @@ -19,19 +19,60 @@ package org.eclipse.aether.spi.connector.transport.http; /** - * Exception thrown by {@link HttpTransporter} in case of errors. + * Exception thrown by {@link HttpTransporter} in case of non 2xx responses. * * @since 2.0.0 */ public class HttpTransporterException extends Exception { private final int statusCode; + private final String reasonPhrase; + private final String bodyExtract; public HttpTransporterException(int statusCode) { - super("HTTP Status: " + statusCode); + super(buildMessage(statusCode, null)); this.statusCode = statusCode; + this.reasonPhrase = null; + this.bodyExtract = null; + } + + public HttpTransporterException(int statusCode, String reasonPhrase) { + super(buildMessage(statusCode, reasonPhrase)); + this.statusCode = statusCode; + this.reasonPhrase = reasonPhrase; + this.bodyExtract = null; + } + + public HttpTransporterException(int statusCode, String reasonPhrase, String bodyExtract) { + super(buildMessage(statusCode, reasonPhrase)); + this.statusCode = statusCode; + this.reasonPhrase = reasonPhrase; + this.bodyExtract = bodyExtract; + } + + private static String buildMessage(int statusCode, String reasonPhrase) { + return "HTTP Status: " + statusCode + (reasonPhrase != null ? " (" + reasonPhrase + ")" : ""); } public int getStatusCode() { return statusCode; } + + /** + * Returns the reason phrase of the response, if available. + * @return The reason phrase of the response, or {@code null} if not available. + * @since 2.0.26 + */ + public String getReasonPhrase() { + return reasonPhrase; + } + + /** + * Returns the body extract of the response, if available. + * + * @return The body extract of the response, or {@code null} if not available. + * @since 2.0.26 + */ + public String getBodyExtract() { + return bodyExtract; + } } diff --git a/maven-resolver-spi/src/main/java/org/eclipse/aether/spi/connector/transport/http/RFC9457/HttpRFC9457Exception.java b/maven-resolver-spi/src/main/java/org/eclipse/aether/spi/connector/transport/http/RFC9457/HttpRFC9457Exception.java index 7009c922b..c8958cab0 100644 --- a/maven-resolver-spi/src/main/java/org/eclipse/aether/spi/connector/transport/http/RFC9457/HttpRFC9457Exception.java +++ b/maven-resolver-spi/src/main/java/org/eclipse/aether/spi/connector/transport/http/RFC9457/HttpRFC9457Exception.java @@ -18,35 +18,21 @@ */ package org.eclipse.aether.spi.connector.transport.http.RFC9457; -import java.io.IOException; - import org.eclipse.aether.spi.connector.transport.http.HttpTransporter; +import org.eclipse.aether.spi.connector.transport.http.HttpTransporterException; /** - * Exception thrown by {@link HttpTransporter} in case of errors. + * Exception thrown by {@link HttpTransporter} in case of non 2xx responses carrying a RFC 9457 payload. */ -public class HttpRFC9457Exception extends IOException { - private final int statusCode; - - private final String reasonPhrase; +public class HttpRFC9457Exception extends HttpTransporterException { private final RFC9457Payload payload; public HttpRFC9457Exception(int statusCode, String reasonPhrase, RFC9457Payload payload) { - super(payload.toString()); - this.statusCode = statusCode; - this.reasonPhrase = reasonPhrase; + super(statusCode, reasonPhrase); this.payload = payload; } - public int getStatusCode() { - return statusCode; - } - - public String getReasonPhrase() { - return reasonPhrase; - } - public RFC9457Payload getPayload() { return payload; } diff --git a/maven-resolver-spi/src/main/java/org/eclipse/aether/spi/connector/transport/http/RFC9457/RFC9457Reporter.java b/maven-resolver-spi/src/main/java/org/eclipse/aether/spi/connector/transport/http/RFC9457/RFC9457Reporter.java index a250ffebf..1a41707eb 100644 --- a/maven-resolver-spi/src/main/java/org/eclipse/aether/spi/connector/transport/http/RFC9457/RFC9457Reporter.java +++ b/maven-resolver-spi/src/main/java/org/eclipse/aether/spi/connector/transport/http/RFC9457/RFC9457Reporter.java @@ -23,6 +23,8 @@ import java.io.IOException; import java.io.InputStream; import java.nio.charset.StandardCharsets; +import org.eclipse.aether.spi.connector.transport.http.HttpTransporterException; + /** * A reporter for RFC 9457 messages. * RFC 9457 is a standard for reporting problems in HTTP responses as a JSON object. @@ -103,18 +105,16 @@ public abstract class RFC9457Reporter<T, E extends Exception, R> { /** * Generates a {@link HttpRFC9457Exception} if the response type is a RFC 9457 message. - * Otherwise, it throws the base exception + * Otherwise, it throws an {@link HttpTransporterException} with the status code and reason phrase. * * @param response The response to check for RFC 9457 messages. - * @param baseException The base exception to throw if the response is not a RFC 9457 message. */ - public void generateException(T response, BiConsumerChecked<Integer, String, E> baseException) - throws E, HttpRFC9457Exception { + public void generateException(T response) throws HttpTransporterException { int statusCode = getStatusCode(response); String reasonPhrase = getReasonPhrase(response); + final String body; if (isRFC9457Message(response)) { - String body; try { body = getBody(response); } catch (IOException ignore) { @@ -133,12 +133,25 @@ public abstract class RFC9457Reporter<T, E extends Exception, R> { } if (rfc9457Payload != null) { throw new HttpRFC9457Exception(statusCode, reasonPhrase, rfc9457Payload); + } else { + throw new HttpTransporterException(statusCode, reasonPhrase, generateBodyExtract(body)); } - baseException.accept(statusCode, reasonPhrase); - return; + } else { + // No body found but it is representing a RFC 9457 message due to the content type. + throw new HttpRFC9457Exception(statusCode, reasonPhrase, RFC9457Payload.INSTANCE); + } + } else { + try { + body = getBody(response); + throw new HttpTransporterException(statusCode, reasonPhrase, generateBodyExtract(body)); + } catch (IOException e) { + throw new HttpTransporterException(statusCode, reasonPhrase); } - throw new HttpRFC9457Exception(statusCode, reasonPhrase, RFC9457Payload.INSTANCE); } - baseException.accept(statusCode, reasonPhrase); + } + + public static String generateBodyExtract(String body) { + // convert from HTML to plain text + return body; } } diff --git a/maven-resolver-spi/src/test/java/org/eclipse/aether/spi/connector/transport/http/RFC9457/RFC9457ReporterTest.java b/maven-resolver-spi/src/test/java/org/eclipse/aether/spi/connector/transport/http/RFC9457/RFC9457ReporterTest.java index 6e1cad9f6..80b064a9f 100644 --- a/maven-resolver-spi/src/test/java/org/eclipse/aether/spi/connector/transport/http/RFC9457/RFC9457ReporterTest.java +++ b/maven-resolver-spi/src/test/java/org/eclipse/aether/spi/connector/transport/http/RFC9457/RFC9457ReporterTest.java @@ -24,17 +24,20 @@ import java.io.InputStream; import java.nio.charset.StandardCharsets; import java.util.Arrays; +import org.eclipse.aether.spi.connector.transport.http.HttpTransporterException; import org.junit.jupiter.api.Test; -import static org.junit.jupiter.api.Assertions.*; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertSame; +import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.junit.jupiter.api.Assertions.assertTrue; class RFC9457ReporterTest { private static final class TestReporter extends RFC9457Reporter<String, IOException, Object> { private final boolean rfc9457; - private boolean bodyRead; - private TestReporter(boolean rfc9457) { this.rfc9457 = rfc9457; } @@ -56,7 +59,6 @@ class RFC9457ReporterTest { @Override protected String getBody(String response) throws IOException { - bodyRead = true; try (InputStream is = new ByteArrayInputStream(response.getBytes(StandardCharsets.UTF_8))) { return readBody(is); } @@ -66,10 +68,6 @@ class RFC9457ReporterTest { public void prepareRequest(Object request) {} } - private static void throwBaseException(Integer statusCode, String reasonPhrase) throws IOException { - throw new IOException("base:" + statusCode); - } - @Test void hasRFC9457ContentType() { RFC9457Reporter<Object, Exception, Object> reporter = new RFC9457Reporter<Object, Exception, Object>() { @@ -122,8 +120,7 @@ class RFC9457ReporterTest { TestReporter reporter = new TestReporter(true); HttpRFC9457Exception exception = assertThrows( HttpRFC9457Exception.class, - () -> reporter.generateException( - "{\"status\":404,\"title\":\"not found\"}", RFC9457ReporterTest::throwBaseException)); + () -> reporter.generateException("{\"status\":404,\"title\":\"not found\"}")); assertEquals(404, exception.getStatusCode()); assertEquals("not found", exception.getPayload().getTitle()); } @@ -131,44 +128,38 @@ class RFC9457ReporterTest { @Test void malformedProblemDetailsFallsBackToBaseException() { TestReporter reporter = new TestReporter(true); - IOException exception = assertThrows( - IOException.class, - () -> reporter.generateException("{ this is not json", RFC9457ReporterTest::throwBaseException)); - assertFalse(exception instanceof HttpRFC9457Exception); - assertEquals("base:404", exception.getMessage()); + HttpTransporterException exception = + assertThrows(HttpTransporterException.class, () -> reporter.generateException("{ this is not json")); + assertEquals("HTTP Status: 404 (Not Found)", exception.getMessage()); + assertEquals("{ this is not json", exception.getBodyExtract()); } @Test - void oversizedProblemDetailsIsTruncatedAndFallsBackToBaseException() { + void oversizedProblemDetailsFallsBackToBaseException() { char[] padding = new char[RFC9457Reporter.MAX_BODY_BYTES]; Arrays.fill(padding, 'a'); // valid problem details if read completely, malformed once truncated at the cap String oversized = "{\"title\":\"" + new String(padding) + "\"}"; TestReporter reporter = new TestReporter(true); - IOException exception = assertThrows( - IOException.class, - () -> reporter.generateException(oversized, RFC9457ReporterTest::throwBaseException)); - assertFalse(exception instanceof HttpRFC9457Exception); - assertEquals("base:404", exception.getMessage()); + HttpTransporterException exception = + assertThrows(HttpTransporterException.class, () -> reporter.generateException(oversized)); + assertEquals("HTTP Status: 404 (Not Found)", exception.getMessage()); } @Test void emptyBodyThrowsExceptionWithEmptyPayload() { TestReporter reporter = new TestReporter(true); - HttpRFC9457Exception exception = assertThrows( - HttpRFC9457Exception.class, - () -> reporter.generateException("", RFC9457ReporterTest::throwBaseException)); + HttpRFC9457Exception exception = assertThrows(HttpRFC9457Exception.class, () -> reporter.generateException("")); assertSame(RFC9457Payload.INSTANCE, exception.getPayload()); } @Test - void nonProblemDetailsResponseDoesNotReadBody() { + void nonRFC9457Response() { TestReporter reporter = new TestReporter(false); - IOException exception = assertThrows( - IOException.class, - () -> reporter.generateException("{\"title\":\"ignored\"}", RFC9457ReporterTest::throwBaseException)); + HttpTransporterException exception = assertThrows( + HttpTransporterException.class, () -> reporter.generateException("{\"title\":\"ignored\"}")); assertFalse(exception instanceof HttpRFC9457Exception); - assertEquals("base:404", exception.getMessage()); - assertFalse(reporter.bodyRead); + assertEquals("HTTP Status: 404 (Not Found)", exception.getMessage()); + assertEquals("{\"title\":\"ignored\"}", exception.getBodyExtract()); } } diff --git a/maven-resolver-transport-apache/src/main/java/org/eclipse/aether/transport/apache/ApacheTransporter.java b/maven-resolver-transport-apache/src/main/java/org/eclipse/aether/transport/apache/ApacheTransporter.java index c3f9c033f..d6394abba 100644 --- a/maven-resolver-transport-apache/src/main/java/org/eclipse/aether/transport/apache/ApacheTransporter.java +++ b/maven-resolver-transport-apache/src/main/java/org/eclipse/aether/transport/apache/ApacheTransporter.java @@ -56,7 +56,6 @@ import org.apache.http.auth.AuthScope; import org.apache.http.client.AuthCache; import org.apache.http.client.CredentialsProvider; import org.apache.http.client.HttpRequestRetryHandler; -import org.apache.http.client.HttpResponseException; import org.apache.http.client.ServiceUnavailableRetryStrategy; import org.apache.http.client.config.AuthSchemes; import org.apache.http.client.config.CookieSpecs; @@ -409,11 +408,7 @@ final class ApacheTransporter extends AbstractTransporter implements HttpTranspo @Override protected void implPeek(PeekTask task) throws Exception { HttpHead request = commonHeaders(new HttpHead(resolve(task))); - try { - execute(request, null, task.getListener()); - } catch (HttpResponseException e) { - throw new HttpTransporterException(e.getStatusCode()); - } + execute(request, null, task.getListener()); } @Override @@ -432,7 +427,7 @@ final class ApacheTransporter extends AbstractTransporter implements HttpTranspo } execute(request, getter, task.getListener()); break; - } catch (HttpResponseException e) { + } catch (HttpTransporterException e) { if (resume && e.getStatusCode() == HttpStatus.SC_PRECONDITION_FAILED && request.containsHeader(HttpHeaders.RANGE)) { @@ -440,7 +435,7 @@ final class ApacheTransporter extends AbstractTransporter implements HttpTranspo resume = false; continue; } - throw new HttpTransporterException(e.getStatusCode()); + throw e; } } } @@ -454,7 +449,7 @@ final class ApacheTransporter extends AbstractTransporter implements HttpTranspo } try { execute(request, null, task.getListener()); - } catch (HttpResponseException e) { + } catch (HttpTransporterException e) { if (e.getStatusCode() == HttpStatus.SC_EXPECTATION_FAILED && request.containsHeader(HttpHeaders.EXPECT)) { state.setExpectContinue(false); request = commonHeaders(entity(new HttpPut(request.getURI()), entity)); @@ -598,12 +593,10 @@ final class ApacheTransporter extends AbstractTransporter implements HttpTranspo } } - private void handleStatus(CloseableHttpResponse response) throws Exception { + private void handleStatus(CloseableHttpResponse response) throws HttpTransporterException { int status = response.getStatusLine().getStatusCode(); if (status >= 300) { - ApacheRFC9457Reporter.INSTANCE.generateException(response, (statusCode, reasonPhrase) -> { - throw new HttpResponseException(statusCode, reasonPhrase + " (" + statusCode + ")"); - }); + ApacheRFC9457Reporter.INSTANCE.generateException(response); } } diff --git a/maven-resolver-transport-jdk-parent/maven-resolver-transport-jdk11/src/main/java/org/eclipse/aether/transport/jdk/JdkTransporter.java b/maven-resolver-transport-jdk-parent/maven-resolver-transport-jdk11/src/main/java/org/eclipse/aether/transport/jdk/JdkTransporter.java index e63a698cc..94dbbfba1 100644 --- a/maven-resolver-transport-jdk-parent/maven-resolver-transport-jdk11/src/main/java/org/eclipse/aether/transport/jdk/JdkTransporter.java +++ b/maven-resolver-transport-jdk-parent/maven-resolver-transport-jdk11/src/main/java/org/eclipse/aether/transport/jdk/JdkTransporter.java @@ -345,9 +345,7 @@ final class JdkTransporter extends AbstractTransporter implements HttpTransporte resume = false; continue; } - JdkRFC9457Reporter.INSTANCE.generateException(response, (statusCode, reasonPhrase) -> { - throw new HttpTransporterException(statusCode); - }); + JdkRFC9457Reporter.INSTANCE.generateException(response); } } catch (ConnectException e) { throw enhance(e); @@ -492,9 +490,7 @@ final class JdkTransporter extends AbstractTransporter implements HttpTransporte response = send(request.build(), HttpResponse.BodyHandlers.ofInputStream()); task.getListener().transportPropertiesAvailable(createTransportProperties(response)); if (response.statusCode() >= MULTIPLE_CHOICES) { - JdkRFC9457Reporter.INSTANCE.generateException(response, (statusCode, reasonPhrase) -> { - throw new HttpTransporterException(statusCode); - }); + JdkRFC9457Reporter.INSTANCE.generateException(response); } } catch (ConnectException e) { throw enhance(e); diff --git a/maven-resolver-transport-jetty/src/main/java/org/eclipse/aether/transport/jetty/JettyTransporter.java b/maven-resolver-transport-jetty/src/main/java/org/eclipse/aether/transport/jetty/JettyTransporter.java index b51e85a2d..c6a194418 100644 --- a/maven-resolver-transport-jetty/src/main/java/org/eclipse/aether/transport/jetty/JettyTransporter.java +++ b/maven-resolver-transport-jetty/src/main/java/org/eclipse/aether/transport/jetty/JettyTransporter.java @@ -334,9 +334,7 @@ final class JettyTransporter extends AbstractTransporter implements HttpTranspor resume = false; continue; } - JettyRFC9457Reporter.INSTANCE.generateException(listener, (statusCode, reasonPhrase) -> { - throw new HttpTransporterException(statusCode); - }); + JettyRFC9457Reporter.INSTANCE.generateException(listener); } break; } @@ -522,9 +520,7 @@ final class JettyTransporter extends AbstractTransporter implements HttpTranspor // reachable on both success (2xx) and error (3xx/4xx/5xx) responses. task.getListener().transportPropertiesAvailable(createTransportProperties(request, rawResponseHeaders)); if (response.getStatus() >= MULTIPLE_CHOICES) { - JettyRFC9457Reporter.INSTANCE.generateException(listener, (statusCode, reasonPhrase) -> { - throw new HttpTransporterException(statusCode); - }); + JettyRFC9457Reporter.INSTANCE.generateException(listener); } return true; }
