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 1e3e46f2d491f4594e09a1915d09064f95b3865e 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). Introduce DebugMessageSupplier and make all relevant exceptions implement it to carry information to the response body extract. This closes #1844 --- .../org/eclipse/aether/DebugMessageSupplier.java | 28 +++--- .../resolution/ArtifactResolutionException.java | 11 ++- .../aether/transfer/ArtifactTransferException.java | 12 ++- .../connector/transport/http/HttpConstants.java | 2 + .../transport/http/HttpTransporterException.java | 44 ++++++++- .../http/RFC9457/HttpRFC9457Exception.java | 22 +---- .../transport/http/RFC9457/RFC9457Reporter.java | 102 +++++++++++++++++---- .../http/RFC9457/RFC9457ReporterTest.java | 101 ++++++++------------ .../transport/apache/ApacheRFC9457Reporter.java | 12 +-- .../aether/transport/apache/ApacheTransporter.java | 19 ++-- .../aether/transport/jdk/JdkRFC9457Reporter.java | 16 +--- .../aether/transport/jdk/JdkTransporter.java | 8 +- .../transport/jetty/JettyRFC9457Reporter.java | 13 +-- .../aether/transport/jetty/JettyTransporter.java | 8 +- 14 files changed, 229 insertions(+), 169 deletions(-) diff --git a/maven-resolver-spi/src/main/java/org/eclipse/aether/spi/connector/transport/http/HttpTransporterException.java b/maven-resolver-api/src/main/java/org/eclipse/aether/DebugMessageSupplier.java similarity index 55% copy from maven-resolver-spi/src/main/java/org/eclipse/aether/spi/connector/transport/http/HttpTransporterException.java copy to maven-resolver-api/src/main/java/org/eclipse/aether/DebugMessageSupplier.java index 06a440493..67eaf758c 100644 --- a/maven-resolver-spi/src/main/java/org/eclipse/aether/spi/connector/transport/http/HttpTransporterException.java +++ b/maven-resolver-api/src/main/java/org/eclipse/aether/DebugMessageSupplier.java @@ -16,22 +16,22 @@ * specific language governing permissions and limitations * under the License. */ -package org.eclipse.aether.spi.connector.transport.http; +package org.eclipse.aether; /** - * Exception thrown by {@link HttpTransporter} in case of errors. + * Supplies a debug message. + * Usually used together with a {@link Throwable} to provide additional information about the error. * - * @since 2.0.0 + * @since 2.0.27 */ -public class HttpTransporterException extends Exception { - private final int statusCode; - - public HttpTransporterException(int statusCode) { - super("HTTP Status: " + statusCode); - this.statusCode = statusCode; - } - - public int getStatusCode() { - return statusCode; - } +@FunctionalInterface +public interface DebugMessageSupplier { + /** + * Returns a debug message. + * If implemented by a {@link Throwable}, this message should be used in addition to {@link Throwable#getMessage()} to provide more context. + * However, this should only be logged in debug mode, as it may contain otherwise too verbose information. + * + * @return The debug message, may be empty, but never {@code null}. + */ + String getDebugMessage(); } diff --git a/maven-resolver-api/src/main/java/org/eclipse/aether/resolution/ArtifactResolutionException.java b/maven-resolver-api/src/main/java/org/eclipse/aether/resolution/ArtifactResolutionException.java index a2477384e..617b03318 100644 --- a/maven-resolver-api/src/main/java/org/eclipse/aether/resolution/ArtifactResolutionException.java +++ b/maven-resolver-api/src/main/java/org/eclipse/aether/resolution/ArtifactResolutionException.java @@ -23,6 +23,7 @@ import java.util.Collections; import java.util.List; import java.util.Map; +import org.eclipse.aether.DebugMessageSupplier; import org.eclipse.aether.RepositoryException; import org.eclipse.aether.repository.ArtifactRepository; import org.eclipse.aether.repository.LocalArtifactResult; @@ -33,7 +34,7 @@ import org.eclipse.aether.transfer.RepositoryOfflineException; /** * Thrown in case of a unresolvable artifacts. */ -public class ArtifactResolutionException extends RepositoryException { +public class ArtifactResolutionException extends RepositoryException implements DebugMessageSupplier { private final transient List<ArtifactResult> results; /** @@ -222,4 +223,12 @@ public class ArtifactResolutionException extends RepositoryException { } return result; } + + @Override + public String getDebugMessage() { + if (getCause() instanceof DebugMessageSupplier) { + return ((DebugMessageSupplier) getCause()).getDebugMessage(); + } + return ""; + } } diff --git a/maven-resolver-api/src/main/java/org/eclipse/aether/transfer/ArtifactTransferException.java b/maven-resolver-api/src/main/java/org/eclipse/aether/transfer/ArtifactTransferException.java index 753e3b982..560e846d0 100644 --- a/maven-resolver-api/src/main/java/org/eclipse/aether/transfer/ArtifactTransferException.java +++ b/maven-resolver-api/src/main/java/org/eclipse/aether/transfer/ArtifactTransferException.java @@ -18,6 +18,7 @@ */ package org.eclipse.aether.transfer; +import org.eclipse.aether.DebugMessageSupplier; import org.eclipse.aether.RepositoryException; import org.eclipse.aether.artifact.Artifact; import org.eclipse.aether.repository.RemoteRepository; @@ -25,7 +26,7 @@ import org.eclipse.aether.repository.RemoteRepository; /** * Thrown when an artifact could not be uploaded/downloaded to/from a particular remote repository. */ -public class ArtifactTransferException extends RepositoryException { +public class ArtifactTransferException extends RepositoryException implements DebugMessageSupplier { private final transient Artifact artifact; @@ -128,4 +129,13 @@ public class ArtifactTransferException extends RepositoryException { public boolean isFromCache() { return fromCache; } + + @Override + public String getDebugMessage() { + if (getCause() instanceof DebugMessageSupplier) { + return ((DebugMessageSupplier) getCause()).getDebugMessage(); + } else { + return ""; + } + } } diff --git a/maven-resolver-spi/src/main/java/org/eclipse/aether/spi/connector/transport/http/HttpConstants.java b/maven-resolver-spi/src/main/java/org/eclipse/aether/spi/connector/transport/http/HttpConstants.java index 0f06ee5fe..bc931a914 100644 --- a/maven-resolver-spi/src/main/java/org/eclipse/aether/spi/connector/transport/http/HttpConstants.java +++ b/maven-resolver-spi/src/main/java/org/eclipse/aether/spi/connector/transport/http/HttpConstants.java @@ -46,6 +46,8 @@ public final class HttpConstants { public static final String CONTENT_RANGE = "Content-Range"; + public static final String CONTENT_TYPE = "Content-Type"; + public static final String ETAG = "ETag"; public static final String IF_UNMODIFIED_SINCE = "If-Unmodified-Since"; 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..0ab053a19 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 @@ -18,20 +18,58 @@ */ package org.eclipse.aether.spi.connector.transport.http; +import org.eclipse.aether.DebugMessageSupplier; + /** - * 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 { +public class HttpTransporterException extends Exception implements DebugMessageSupplier { 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; + } + + @Override + public String getDebugMessage() { + return bodyExtract != null ? "Response body: " + 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..dcb73fe74 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 @@ -21,23 +21,26 @@ package org.eclipse.aether.spi.connector.transport.http.RFC9457; import java.io.ByteArrayOutputStream; import java.io.IOException; import java.io.InputStream; +import java.nio.charset.Charset; import java.nio.charset.StandardCharsets; +import org.eclipse.aether.spi.connector.transport.http.HttpTransporterException; + /** - * A reporter for RFC 9457 messages. + * A reporter for RFC 9457 messages with falling back to just reporting the status code, reason phrase and a body extract if the response is not a RFC 9457 message. + * It relies on exception {@link HttpRFC9457Exception} to report RFC 9457 messages and {@link HttpTransporterException} to report non RFC 9457 messages * RFC 9457 is a standard for reporting problems in HTTP responses as a JSON object. * There are members specified in the RFC but none of those appear to be required, - * see <a href=https://www.rfc-editor.org/rfc/rfc9457#section-3-7>rfc9457 section 3.7</a> + * see <a href=https://www.rfc-editor.org/rfc/rfc9457#section-3-7>rfc9457 section 3.7</a>. * Given the JSON fields are not mandatory, this reporter simply extracts the body of the * response without validation. * A RFC 9457 message is detected by the content type {@value #CONTENT_TYPE_PROBLEM_DETAILS_JSON} in the response header. * * @param <T> The type of the response. - * @param <E> The base exception type to throw if the response is not a RFC9457 message. * @param <R> The type of the request or request builder (which allows to modify headers) * @see <a href=https://www.rfc-editor.org/rfc/rfc9457#section-3-7>RFC 9457</a> */ -public abstract class RFC9457Reporter<T, E extends Exception, R> { +public abstract class RFC9457Reporter<T, R> { public static final String CONTENT_TYPE_PROBLEM_DETAILS_JSON = "application/problem+json"; public static final String CONTENT_TYPE_PROBLEM_DETAILS_JSON_AND_ANY = "application/problem+json,*/*"; @@ -49,12 +52,25 @@ public abstract class RFC9457Reporter<T, E extends Exception, R> { */ public static final int MAX_BODY_BYTES = 64 * 1024; - protected abstract boolean isRFC9457Message(T response); + /** + * Returns the content type of the response, or {@code null} if not available. + * @param response The response to get the content type from. + * @return The content type of the response, or {@code null} if not available, this should include optional parameters like charset. + */ + protected abstract String getContentType(T response); protected abstract int getStatusCode(T response); protected abstract String getReasonPhrase(T response); + /** + * Returns the body of the response as a string, or {@code null} if not available. + * The returned string should be truncated to {@link #MAX_BODY_BYTES} bytes, and may be incomplete or malformed. + * @param response The response to get the body from. + * @return The body of the response as a string, or {@code null} if not available. + * @throws IOException If an I/O error occurs while reading the body. + * @see #readBody(InputStream) + */ protected abstract String getBody(T response) throws IOException; /** @@ -66,15 +82,21 @@ public abstract class RFC9457Reporter<T, E extends Exception, R> { public abstract void prepareRequest(R request); /** - * Reads the given stream into a UTF-8 string, consuming at most {@link #MAX_BODY_BYTES} bytes. + * Reads the given stream into a string, consuming at most {@link #MAX_BODY_BYTES} bytes. * Any remaining bytes are left unread, so an oversized (or decompression amplified) body is * truncated instead of exhausting memory. The caller remains responsible for closing the stream. * * @param is The stream to read the body from, must not be {@code null}. + * @param contentType The content type of the body, may be {@code null} if unknown. * @return The body as UTF-8 string, truncated to {@link #MAX_BODY_BYTES} bytes, never {@code null}. * @throws IOException If reading the stream fails. */ - protected static String readBody(InputStream is) throws IOException { + protected static String readBody(InputStream is, String contentType) throws IOException { + // The RFC 9457 content type is always UTF-8, but the server may lie and send a different charset. + // We ignore the charset and always read as UTF-8, because the RFC 9457 payload is always UTF-8. + // If the server sends a different charset, we may get garbage, but we don't want to risk + // misinterpreting the payload and failing to report a valid RFC 9457 message. + final Charset charset = extractCharsetFromContentType(contentType, StandardCharsets.UTF_8); ByteArrayOutputStream body = new ByteArrayOutputStream(); byte[] chunk = new byte[8 * 1024]; int remaining = MAX_BODY_BYTES; @@ -86,10 +108,23 @@ public abstract class RFC9457Reporter<T, E extends Exception, R> { body.write(chunk, 0, read); remaining -= read; } - return body.toString(StandardCharsets.UTF_8.name()); + return new String(body.toByteArray(), charset); } - protected boolean hasRFC9457ContentType(String contentType) { + protected static Charset extractCharsetFromContentType(String contentType, Charset defaultCharset) { + if (contentType != null && contentType.contains("charset=")) { + try { + return Charset.forName(contentType + .substring(contentType.indexOf("charset=") + 8) + .trim()); + } catch (Exception e) { + // ignore and use default charset + } + } + return defaultCharset; + } + + static boolean hasRFC9457ContentType(String contentType) { if (contentType == null) { return false; } @@ -103,18 +138,17 @@ 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); - if (isRFC9457Message(response)) { - String body; + final String body; + final String contentType = getContentType(response); + if (hasRFC9457ContentType(contentType)) { try { body = getBody(response); } catch (IOException ignore) { @@ -133,12 +167,42 @@ 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, contentType)); } - 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, contentType)); + } catch (IOException e) { + throw new HttpTransporterException(statusCode, reasonPhrase); } - throw new HttpRFC9457Exception(statusCode, reasonPhrase, RFC9457Payload.INSTANCE); } - baseException.accept(statusCode, reasonPhrase); + } + + /** + * Generates a body extract from the given body string (usually HTML) + * This method can be overridden to provide custom logic for generating a body extract. + * + * @param body The body string to generate the extract from (already truncated to {@link #MAX_BODY_BYTES} bytes). + * @param contentType The content type of the body, may be {@code null} if unknown. + * @return The generated body extract. + */ + public static String generateBodyExtract(String body, String contentType) { + if (contentType != null && contentType.startsWith("text/html")) { + // convert from HTML to plain text + + return body.replaceAll("<[^>]*>", ""); + } else if (contentType != null && contentType.startsWith("application/octet-stream")) { + // convert from JSON to plain text + return "Binary data (application/octet-stream)"; + } else { + 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..18c36106e 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,24 +24,27 @@ 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 static final class TestReporter extends RFC9457Reporter<String, Object> { private final boolean rfc9457; - private boolean bodyRead; - private TestReporter(boolean rfc9457) { this.rfc9457 = rfc9457; } @Override - protected boolean isRFC9457Message(String response) { - return rfc9457; + protected String getContentType(String response) { + return rfc9457 ? "application/problem+json" : "text/plain"; } @Override @@ -56,9 +59,8 @@ 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); + return readBody(is, getContentType(response)); } } @@ -66,38 +68,10 @@ 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>() { - @Override - protected boolean isRFC9457Message(Object response) { - return false; - } - - @Override - protected int getStatusCode(Object response) { - return 0; - } - - @Override - protected String getReasonPhrase(Object response) { - return null; - } - - @Override - protected String getBody(Object response) { - return null; - } - - @Override - public void prepareRequest(Object request) {} - }; - assertTrue(reporter.hasRFC9457ContentType("application/problem+json")); - assertTrue(reporter.hasRFC9457ContentType("application/problem+json; charset=utf-8")); + assertTrue(RFC9457Reporter.hasRFC9457ContentType("application/problem+json")); + assertTrue(RFC9457Reporter.hasRFC9457ContentType("application/problem+json; charset=utf-8")); } @Test @@ -105,7 +79,7 @@ class RFC9457ReporterTest { byte[] oversized = new byte[RFC9457Reporter.MAX_BODY_BYTES + 4096]; Arrays.fill(oversized, (byte) 'a'); ByteArrayInputStream is = new ByteArrayInputStream(oversized); - String body = RFC9457Reporter.readBody(is); + String body = RFC9457Reporter.readBody(is, null); assertEquals(RFC9457Reporter.MAX_BODY_BYTES, body.length()); assertEquals(4096, is.available()); } @@ -113,7 +87,17 @@ class RFC9457ReporterTest { @Test void readBodyReadsSmallStreamCompletely() throws IOException { String payload = "{\"title\":\"gone\"}"; - String body = RFC9457Reporter.readBody(new ByteArrayInputStream(payload.getBytes(StandardCharsets.UTF_8))); + String body = + RFC9457Reporter.readBody(new ByteArrayInputStream(payload.getBytes(StandardCharsets.UTF_8)), null); + assertEquals(payload, body); + } + + @Test + void readBodyWithISO_8859_1Charset() throws IOException { + String payload = "{\"title\":\"&*üÖ\"}"; + String body = RFC9457Reporter.readBody( + new ByteArrayInputStream(payload.getBytes(StandardCharsets.ISO_8859_1)), + "application/problem+json; charset=ISO-8859-1"); assertEquals(payload, body); } @@ -122,8 +106,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 +114,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("Response body: { this is not json", exception.getDebugMessage()); } @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("Response body: {\"title\":\"ignored\"}", exception.getDebugMessage()); } } diff --git a/maven-resolver-transport-apache/src/main/java/org/eclipse/aether/transport/apache/ApacheRFC9457Reporter.java b/maven-resolver-transport-apache/src/main/java/org/eclipse/aether/transport/apache/ApacheRFC9457Reporter.java index 6f5453319..c71b69e9b 100644 --- a/maven-resolver-transport-apache/src/main/java/org/eclipse/aether/transport/apache/ApacheRFC9457Reporter.java +++ b/maven-resolver-transport-apache/src/main/java/org/eclipse/aether/transport/apache/ApacheRFC9457Reporter.java @@ -25,12 +25,11 @@ import org.apache.http.Header; import org.apache.http.HttpEntity; import org.apache.http.HttpHeaders; import org.apache.http.HttpRequest; -import org.apache.http.client.HttpResponseException; import org.apache.http.client.methods.CloseableHttpResponse; import org.eclipse.aether.spi.connector.transport.http.HttpConstants; import org.eclipse.aether.spi.connector.transport.http.RFC9457.RFC9457Reporter; -public class ApacheRFC9457Reporter extends RFC9457Reporter<CloseableHttpResponse, HttpResponseException, HttpRequest> { +public class ApacheRFC9457Reporter extends RFC9457Reporter<CloseableHttpResponse, HttpRequest> { public static final ApacheRFC9457Reporter INSTANCE = new ApacheRFC9457Reporter(); private ApacheRFC9457Reporter() {} @@ -41,13 +40,12 @@ public class ApacheRFC9457Reporter extends RFC9457Reporter<CloseableHttpResponse } @Override - protected boolean isRFC9457Message(final CloseableHttpResponse response) { + protected String getContentType(final CloseableHttpResponse response) { Header[] headers = response.getHeaders(HttpHeaders.CONTENT_TYPE); if (headers.length > 0) { - String contentType = headers[0].getValue(); - return hasRFC9457ContentType(contentType); + return headers[0].getValue(); } - return false; + return null; } @Override @@ -76,7 +74,7 @@ public class ApacheRFC9457Reporter extends RFC9457Reporter<CloseableHttpResponse return ""; } try (InputStream stream = is) { - return readBody(stream); + return readBody(stream, getContentType(response)); } } } 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/JdkRFC9457Reporter.java b/maven-resolver-transport-jdk-parent/maven-resolver-transport-jdk11/src/main/java/org/eclipse/aether/transport/jdk/JdkRFC9457Reporter.java index 6340e57e4..798f3544a 100644 --- a/maven-resolver-transport-jdk-parent/maven-resolver-transport-jdk11/src/main/java/org/eclipse/aether/transport/jdk/JdkRFC9457Reporter.java +++ b/maven-resolver-transport-jdk-parent/maven-resolver-transport-jdk11/src/main/java/org/eclipse/aether/transport/jdk/JdkRFC9457Reporter.java @@ -26,11 +26,9 @@ import java.net.http.HttpResponse; import java.util.Optional; import org.eclipse.aether.spi.connector.transport.http.HttpConstants; -import org.eclipse.aether.spi.connector.transport.http.HttpTransporterException; import org.eclipse.aether.spi.connector.transport.http.RFC9457.RFC9457Reporter; -public class JdkRFC9457Reporter - extends RFC9457Reporter<HttpResponse<InputStream>, HttpTransporterException, HttpRequest.Builder> { +public class JdkRFC9457Reporter extends RFC9457Reporter<HttpResponse<InputStream>, HttpRequest.Builder> { public static final JdkRFC9457Reporter INSTANCE = new JdkRFC9457Reporter(); private JdkRFC9457Reporter() {} @@ -41,13 +39,9 @@ public class JdkRFC9457Reporter } @Override - protected boolean isRFC9457Message(final HttpResponse<InputStream> response) { - Optional<String> optionalContentType = response.headers().firstValue("Content-Type"); - if (optionalContentType.isPresent()) { - String contentType = optionalContentType.get(); - return hasRFC9457ContentType(contentType); - } - return false; + protected String getContentType(final HttpResponse<InputStream> response) { + Optional<String> optionalContentType = response.headers().firstValue(HttpConstants.CONTENT_TYPE); + return optionalContentType.orElse(null); } @Override @@ -63,7 +57,7 @@ public class JdkRFC9457Reporter @Override protected String getBody(final HttpResponse<InputStream> response) throws IOException { try (InputStream is = response.body()) { - return readBody(is); + return readBody(is, getContentType(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/JettyRFC9457Reporter.java b/maven-resolver-transport-jetty/src/main/java/org/eclipse/aether/transport/jetty/JettyRFC9457Reporter.java index 127d46c83..53609d48d 100644 --- a/maven-resolver-transport-jetty/src/main/java/org/eclipse/aether/transport/jetty/JettyRFC9457Reporter.java +++ b/maven-resolver-transport-jetty/src/main/java/org/eclipse/aether/transport/jetty/JettyRFC9457Reporter.java @@ -24,15 +24,13 @@ import java.util.concurrent.ExecutionException; import java.util.concurrent.TimeUnit; import java.util.concurrent.TimeoutException; -import org.eclipse.aether.spi.connector.transport.http.HttpTransporterException; import org.eclipse.aether.spi.connector.transport.http.RFC9457.RFC9457Reporter; import org.eclipse.jetty.client.InputStreamResponseListener; import org.eclipse.jetty.client.Request; import org.eclipse.jetty.client.Response; import org.eclipse.jetty.http.HttpHeader; -public class JettyRFC9457Reporter - extends RFC9457Reporter<InputStreamResponseListener, HttpTransporterException, Request> { +public class JettyRFC9457Reporter extends RFC9457Reporter<InputStreamResponseListener, Request> { public static final JettyRFC9457Reporter INSTANCE = new JettyRFC9457Reporter(); private JettyRFC9457Reporter() {} @@ -43,13 +41,12 @@ public class JettyRFC9457Reporter } @Override - protected boolean isRFC9457Message(final InputStreamResponseListener listener) { + protected String getContentType(final InputStreamResponseListener listener) { try { Response response = listener.get(1, TimeUnit.SECONDS); - String contentType = response.getHeaders().get(HttpHeader.CONTENT_TYPE); - return hasRFC9457ContentType(contentType); + return response.getHeaders().get(HttpHeader.CONTENT_TYPE); } catch (InterruptedException | TimeoutException | ExecutionException e) { - return false; + return null; } } @@ -76,7 +73,7 @@ public class JettyRFC9457Reporter @Override protected String getBody(final InputStreamResponseListener listener) throws IOException { try (InputStream is = listener.getInputStream()) { - return readBody(is); + return readBody(is, getContentType(listener)); } } } 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; }
